Geant4 Cross Reference |
1 // 1 // 2 // ******************************************* 2 // ******************************************************************** 3 // * License and Disclaimer 3 // * License and Disclaimer * 4 // * 4 // * * 5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of * 6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and * 7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file * 8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These * 9 // * include a list of copyright holders. 9 // * include a list of copyright holders. * 10 // * 10 // * * 11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing * 12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this * 13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, * 14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its * 15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above * 16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. * 17 // * 17 // * * 18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and * 19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. * 20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or * 21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its * 22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your * 23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. * 24 // ******************************************* 24 // ******************************************************************** 25 // 25 // 26 // 26 // >> 27 // $Id: G4VViewer.hh,v 1.18 2006/06/29 21:28:14 gunter Exp $ >> 28 // GEANT4 tag $Name: geant4-08-02 $ 27 // 29 // 28 // 30 // 29 // John Allison 27th March 1996 31 // John Allison 27th March 1996 30 // 32 // 31 // Class description 33 // Class description 32 // 34 // 33 // Abstract interface class for graphics viewe 35 // Abstract interface class for graphics viewers. 34 36 35 #ifndef G4VVIEWER_HH 37 #ifndef G4VVIEWER_HH 36 #define G4VVIEWER_HH 38 #define G4VVIEWER_HH 37 39 38 #include "globals.hh" 40 #include "globals.hh" 39 41 40 #include "G4SceneTreeItem.hh" << 41 << 42 #include "G4ViewParameters.hh" 42 #include "G4ViewParameters.hh" 43 #include "G4PhysicalVolumeModel.hh" << 44 #include "G4PseudoScene.hh" << 45 << 46 #include <vector> << 47 #include <list> << 48 43 49 class G4VSceneHandler; 44 class G4VSceneHandler; 50 45 51 // clang-format off << 52 class G4VViewer { 46 class G4VViewer { 53 47 54 public: // With description 48 public: // With description 55 49 56 friend std::ostream& operator << (std::ostre 50 friend std::ostream& operator << (std::ostream& os, const G4VViewer& v); 57 51 58 G4VViewer (G4VSceneHandler&, G4int id, const 52 G4VViewer (G4VSceneHandler&, G4int id, const G4String& name = ""); 59 virtual ~G4VViewer (); 53 virtual ~G4VViewer (); 60 54 61 virtual void Initialise (); 55 virtual void Initialise (); 62 // Called immediately after construction for 56 // Called immediately after construction for those operations that 63 // must await complete contruction of viewer 57 // must await complete contruction of viewer and all its bases. For 64 // example, if this class (G4VViewer) is inh 58 // example, if this class (G4VViewer) is inherited virtually, as in 65 // the OpenGL sub-category, it will not be f 59 // the OpenGL sub-category, it will not be fully constructed until 66 // *after* the the derived viewer (this is t 60 // *after* the the derived viewer (this is the rule about order of 67 // construction for virtual inheritance), so 61 // construction for virtual inheritance), so the derived viewer may 68 // not use information in G4VViewer in its c 62 // not use information in G4VViewer in its contructor. Hence such 69 // code must be in Initialise(). 63 // code must be in Initialise(). 70 64 71 //////////////////////////////////////////// 65 ////////////////////////////////////////////////////////////// 72 // View manipulation functions. 66 // View manipulation functions. 73 67 74 virtual void ResetView (); << 75 // Reset view parameters to default, includi << 76 // The sub-class should always invoke the ba << 77 // virtual void SubClass::ResetView () { << 78 // G4VViewer::ResetView(); << 79 // // Then reset sub-class parameters << 80 // ... << 81 << 82 virtual void SetView () = 0; 68 virtual void SetView () = 0; 83 // Take view parameters and work out model/v 69 // Take view parameters and work out model/view transformation, 84 // projection transformation, lighting, etc. 70 // projection transformation, lighting, etc. 85 71 86 virtual void ClearView () = 0; 72 virtual void ClearView () = 0; 87 // Clear screen/viewing buffers. 73 // Clear screen/viewing buffers. 88 74 89 virtual void DrawView () = 0; 75 virtual void DrawView () = 0; 90 // Draw view of the scene currently attached 76 // Draw view of the scene currently attached to the scene handler - 91 // see example of a minimal function at end 77 // see example of a minimal function at end of this file. 92 << 93 void RefreshView (); << 94 // Simply invokes SetView, ClearView, DrawVi << 95 78 96 virtual void ShowView (); 79 virtual void ShowView (); 97 // Show view (for graphics systems which req 80 // Show view (for graphics systems which require to process 98 // all drawn objects before finalising the v 81 // all drawn objects before finalising the view). 99 82 100 virtual void FinishView (); 83 virtual void FinishView (); 101 // Called at the end of drawing scene. Used 84 // Called at the end of drawing scene. Used to flush streams, or 102 // swap buffers. (Perhaps it is inappropria 85 // swap buffers. (Perhaps it is inappropriately named, perhaps its 103 // function could be incorporated into EndMo 86 // function could be incorporated into EndModeling (). It marks the 104 // end of scene drawing; be aware hits and d 87 // end of scene drawing; be aware hits and digi drawing may Follow. 105 // It is not yet the end of all drawing; tha 88 // It is not yet the end of all drawing; that is signalled by 106 // ShowView ().) 89 // ShowView ().) 107 90 108 virtual G4bool ReadyToDraw() {return true;} << 109 << 110 std::vector<G4ThreeVector> ComputeFlyThrough << 111 << 112 // Note: the order of calling of MovingToVis << 113 // is undefined, so you may need to implemen << 114 // order - see, e.g., G4OpenGLQtViewer. To s << 115 // as follows - see G4VisManager.cc. << 116 // DoneWithMasterThread << 117 // MovingToVisSubThread ) or ( SwitchToVisSu << 118 // SwitchToVisSubThread ) ( MovingToVisSu << 119 // DoneWithVisSubThread << 120 // MovingToMasterThread << 121 // SwitchToMasterThread << 122 << 123 // Called on the master thread before starti << 124 virtual void DoneWithMasterThread () {} << 125 << 126 // Called on the master thread after startin << 127 virtual void MovingToVisSubThread () {} << 128 << 129 // Called on the vis sub-thread at start of << 130 virtual void SwitchToVisSubThread () {} << 131 << 132 // Called on the vis sub-thread when all eve << 133 virtual void DoneWithVisSubThread () {} << 134 << 135 // Called on the vis sub-thread when all eve << 136 virtual void MovingToMasterThread () {} << 137 << 138 // Called on the master thread after the vis << 139 virtual void SwitchToMasterThread () {} << 140 << 141 //////////////////////////////////////////// << 142 // Stuff for scene tree. << 143 /** << 144 - The scene tree is a tree of G4SceneTreeIt << 145 - Its root is a data member fSceneTree of a << 146 G4VViewer inheritance, << 147 - G4SceneTreeItem is an aggregate of data m << 148 properties of objects in the scene (G4Scene << 149 low-level types - G4String, G4VisAttributes << 150 that it can be used across categories, avoi << 151 - The root item has children that represent << 152 sub-classes) in the scene. << 153 - For a G4PhysicalVolumeModel (detector com << 154 children's children, etc., imitate the geom << 155 model. These descendants are called "toucha << 156 - There may be more than one G4PhysicalVolu << 157 the user creates his/her scene. << 158 - The scene tree is reviewed, and updated i << 159 of G4VSceneHandler::ProcessScene. This is << 160 - A kernel visit is triggered by some vis c << 161 /vis/viewer/rebuild) and by a viewer if it << 162 example, a kernel visit may not be required << 163 but required for a change from surface to w << 164 - The idea is that the scene tree can be pa << 165 create a tree widget, and interactions with << 166 /vis/scene/activateModel, /vis/set/touchabl << 167 The viewer decides if this requires a kerne << 168 must update fSceneTree itself (utilities ar << 169 G4VViewer::TouchableSetVisibility/Colour). << 170 */ << 171 class SceneTreeScene: public G4PseudoScene { << 172 // G4PhysicalVolumeModel sends touchables << 173 public: << 174 SceneTreeScene(G4VViewer*, G4PhysicalVolum << 175 ~SceneTreeScene() = default; << 176 private: << 177 void ProcessVolume(const G4VSolid& solid) << 178 std::list<G4SceneTreeItem>::iterator FindO << 179 (const G4String& modelID, G4SceneTreeItem& << 180 G4int depth, const G4String& partialPathS << 181 G4VViewer* fpViewer = nullptr; << 182 G4PhysicalVolumeModel* fpPVModel = nullptr << 183 std::list<G4SceneTreeItem>::iterator fMod << 184 G4int fMaximumExpandedDepth = 0; // To << 185 const G4int fMaximumExpanded = 30; // So << 186 }; << 187 void InsertModelInSceneTree(G4VModel*); << 188 const G4SceneTreeItem& GetSceneTree() {retur << 189 G4SceneTreeItem& AccessSceneTree() {return f << 190 void UpdateGUISceneTree(); // A utility << 191 const G4int fMaxNTouchables = 10000; // Lim << 192 G4bool fCurtailDescent = false; // Flag to << 193 << 194 //////////////////////////////////////////// 91 ////////////////////////////////////////////////////////////// 195 // Access functions. 92 // Access functions. 196 const G4String& GetName () 93 const G4String& GetName () const; 197 const G4String& GetShortName () 94 const G4String& GetShortName () const; 198 void SetName (c 95 void SetName (const G4String&); 199 G4int GetViewId () 96 G4int GetViewId () const; 200 G4VSceneHandler* GetSceneHandler () 97 G4VSceneHandler* GetSceneHandler () const; 201 const G4ViewParameters& GetViewParameters 98 const G4ViewParameters& GetViewParameters () const; 202 const G4ViewParameters& GetDefaultViewParame 99 const G4ViewParameters& GetDefaultViewParameters () const; 203 G4double GetKernelVisitElapse << 204 << 205 virtual const std::vector<G4ModelingParamete << 206 GetPrivateVisAttributesModifiers() const; << 207 // So that privately accumulated vis attribu << 208 // concatenated with the standard vis attrib << 209 // such as /vis/viewer/set/all and /vis/view << 210 << 211 void SetViewParameters (const G4View 100 void SetViewParameters (const G4ViewParameters& vp); 212 void SetDefaultViewParameters (const G4View 101 void SetDefaultViewParameters (const G4ViewParameters& vp); 213 102 214 //////////////////////////////////////////// 103 ////////////////////////////////////////////////////////////// 215 // Public utility functions. 104 // Public utility functions. 216 105 217 const G4VisAttributes* GetApplicableVisAttr 106 const G4VisAttributes* GetApplicableVisAttributes 218 (c 107 (const G4VisAttributes*) const; 219 108 220 void SetNeedKernelVisit (G4bool need); 109 void SetNeedKernelVisit (G4bool need); 221 // Sets individual need-visit flag. 110 // Sets individual need-visit flag. 222 111 223 void NeedKernelVisit (); 112 void NeedKernelVisit (); 224 // Flags all views the need to re-visit the 113 // Flags all views the need to re-visit the GEANT4 kernel to refresh 225 // the scene. 114 // the scene. 226 115 227 void ProcessView (); 116 void ProcessView (); 228 // Used by DrawView (). Invokes SetView (). 117 // Used by DrawView (). Invokes SetView (). The basic logic is here. 229 118 230 protected: 119 protected: 231 120 232 //////////////////////////////////////////// 121 ////////////////////////////////////////////////////////////// 233 // Protected utility functions. << 234 << 235 void SetTouchable << 236 (const std::vector<G4PhysicalVolumeModel::G4 << 237 // Set the touchable for /vis/touchable/set/ << 238 << 239 void TouchableSetVisibility << 240 (const std::vector<G4PhysicalVolumeModel::G4 << 241 G4bool visibility); << 242 // Set the touchable visibility attribute. << 243 // Changes the Vis Attribute Modifiers WITHO << 244 << 245 void TouchableSetColour << 246 (const std::vector<G4PhysicalVolumeModel::G4 << 247 const G4Colour&); << 248 // Set the touchable colour attribute. << 249 // Changes the Vis Attribute Modifiers WITHO << 250 << 251 //////////////////////////////////////////// << 252 // Data members 122 // Data members 253 G4VSceneHandler& fSceneHandler; / 123 G4VSceneHandler& fSceneHandler; // Abstract scene for this view. 254 G4int fViewId; // Id of this i 124 G4int fViewId; // Id of this instance. 255 G4String fName; 125 G4String fName; 256 G4String fShortName; // Up to first 126 G4String fShortName; // Up to first ' ' character, if any. 257 G4ViewParameters fVP; // View paramet 127 G4ViewParameters fVP; // View parameters. 258 G4ViewParameters fDefaultVP; // Default view 128 G4ViewParameters fDefaultVP; // Default view parameters. 259 G4double fKernelVisitElapsedTimeSeco << 260 // Note: fKernelVisitElapsedTimeSeconds is m << 261 G4SceneTreeItem fSceneTree; << 262 129 263 //////////////////////////////////////////// 130 ////////////////////////////////////////////////////////////// 264 // Other parameters. 131 // Other parameters. 265 G4bool fNeedKernelVisit; // See D 132 G4bool fNeedKernelVisit; // See DrawView() for comments. 266 }; 133 }; 267 134 268 #include "G4VViewer.icc" 135 #include "G4VViewer.icc" 269 136 270 /********************************************* 137 /********************************************* 271 138 272 Here is a minimal DrawView () as it might be i 139 Here is a minimal DrawView () as it might be implemented in the 273 concrete viewer. 140 concrete viewer. 274 141 275 void G4VViewer::DrawView () { // Default - co 142 void G4VViewer::DrawView () { // Default - concrete view usually overrides. 276 143 277 // First, a view should decide when to re-vi 144 // First, a view should decide when to re-visit the G4 kernel. 278 // Sometimes it might not be necessary, e.g. 145 // Sometimes it might not be necessary, e.g., if the scene is stored 279 // in a graphical database (e.g., OpenGL's d 146 // in a graphical database (e.g., OpenGL's display lists) and only 280 // the viewing angle has changed. But graph 147 // the viewing angle has changed. But graphics systems without a 281 // graphical database will always need to vi 148 // graphical database will always need to visit the G4 kernel. 282 149 283 NeedKernelVisit (); // Default is - always 150 NeedKernelVisit (); // Default is - always visit G4 kernel. 284 // Note: this routine sets the fNeedKernelVi 151 // Note: this routine sets the fNeedKernelVisit flag of *all* the views of 285 // the scene. 152 // the scene. 286 153 287 ProcessView (); // The basic log 154 ProcessView (); // The basic logic is here. 288 155 289 // Then a view may have more to do, e.g., di 156 // Then a view may have more to do, e.g., display the graphical 290 // database. That code should come here bef 157 // database. That code should come here before finally... 291 158 292 FinishView (); // Flush streams 159 FinishView (); // Flush streams and/or swap buffers. 293 } 160 } 294 161 295 *********************************************/ 162 *********************************************/ 296 163 297 #endif 164 #endif 298 165