Geant4  10.03
G4VViewer.hh
Go to the documentation of this file.
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 //
27 // $Id: G4VViewer.hh 99668 2016-09-30 08:02:13Z gcosmo $
28 //
29 //
30 // John Allison 27th March 1996
31 //
32 // Class description
33 //
34 // Abstract interface class for graphics viewers.
35 
36 #ifndef G4VVIEWER_HH
37 #define G4VVIEWER_HH
38 
39 #include "globals.hh"
40 
41 #include "G4ViewParameters.hh"
42 #include "G4PhysicalVolumeModel.hh"
43 
44 class G4VSceneHandler;
45 
46 class G4VViewer {
47 
48 public: // With description
49 
50  friend std::ostream& operator << (std::ostream& os, const G4VViewer& v);
51 
52  G4VViewer (G4VSceneHandler&, G4int id, const G4String& name = "");
53  virtual ~G4VViewer ();
54 
55  virtual void Initialise ();
56  // Called immediately after construction for those operations that
57  // must await complete contruction of viewer and all its bases. For
58  // example, if this class (G4VViewer) is inherited virtually, as in
59  // the OpenGL sub-category, it will not be fully constructed until
60  // *after* the the derived viewer (this is the rule about order of
61  // construction for virtual inheritance), so the derived viewer may
62  // not use information in G4VViewer in its contructor. Hence such
63  // code must be in Initialise().
64 
66  // View manipulation functions.
67 
68  virtual void ResetView ();
69  // Reset view parameters to default, including sub-class parameters, if any.
70  // The sub-class should always invoke the base class implementation, i.e:
71  // virtual void SubClass::ResetView () {
72  // G4VViewer::ResetView();
73  // // Then reset sub-class parameters
74  // ...
75 
76  virtual void SetView () = 0;
77  // Take view parameters and work out model/view transformation,
78  // projection transformation, lighting, etc.
79 
80  virtual void ClearView () = 0;
81  // Clear screen/viewing buffers.
82 
83  virtual void DrawView () = 0;
84  // Draw view of the scene currently attached to the scene handler -
85  // see example of a minimal function at end of this file.
86 
87  void RefreshView ();
88  // Simply invokes SetView, ClearView, DrawView.
89 
90  virtual void ShowView ();
91  // Show view (for graphics systems which require to process
92  // all drawn objects before finalising the view).
93 
94  virtual void FinishView ();
95  // Called at the end of drawing scene. Used to flush streams, or
96  // swap buffers. (Perhaps it is inappropriately named, perhaps its
97  // function could be incorporated into EndModeling (). It marks the
98  // end of scene drawing; be aware hits and digi drawing may Follow.
99  // It is not yet the end of all drawing; that is signalled by
100  // ShowView ().)
101 
102  std::vector<G4ThreeVector> ComputeFlyThrough(G4Vector3D*);
103 
104 #ifdef G4MULTITHREADED
105  // In MT mode these functions are called in the following order for each run:
106  // Called on the master thread before starting the vis sub-thread.
107  virtual void DoneWithMasterThread ();
108  // Called on the master thread after starting the vis sub-thread.
109  virtual void MovingToVisSubThread ();
110  // Called on the vis sub-thread when waiting for events.
111  virtual void SwitchToVisSubThread ();
112  // Called on the vis sub-thread when all events have been processed.
113  virtual void DoneWithVisSubThread ();
114  // Called on the vis sub-thread when all events have been processed.
115  virtual void MovingToMasterThread ();
116  // Called on the master thread after the vis sub-thread has terminated.
117  virtual void SwitchToMasterThread ();
118 #endif
119 
121  // Access functions.
122  const G4String& GetName () const;
123  const G4String& GetShortName () const;
124  void SetName (const G4String&);
125  G4int GetViewId () const;
127  const G4ViewParameters& GetViewParameters () const;
129 
130  virtual const std::vector<G4ModelingParameters::VisAttributesModifier>*
132  // So that privately accumulated vis attributes modifiers may be
133  // concatenated with the standard vis attributes modifiers for commands
134  // such as /vis/viewer/set/all and /vis/viewer/save.
135 
136  void SetViewParameters (const G4ViewParameters& vp);
138 
140  // Public utility functions.
141 
143  (const G4VisAttributes*) const;
144 
145  void SetNeedKernelVisit (G4bool need);
146  // Sets individual need-visit flag.
147 
148  void NeedKernelVisit ();
149  // Flags all views the need to re-visit the GEANT4 kernel to refresh
150  // the scene.
151 
152  void ProcessView ();
153  // Used by DrawView (). Invokes SetView (). The basic logic is here.
154 
155 protected:
156 
158  // Protected utility functions.
159 
160  void SetTouchable
161  (const std::vector<G4PhysicalVolumeModel::G4PhysicalVolumeNodeID>& fullPath);
162  // Set the touchable for /vis/touchable/set/... commands.
163 
165  (const std::vector<G4PhysicalVolumeModel::G4PhysicalVolumeNodeID>& fullPath,
166  G4bool visibility);
167  // Set the touchable visibility attribute.
168  // Changes the Vis Attribute Modifiers WITHOUT triggering a rebuild.
169 
170  void TouchableSetColour
171  (const std::vector<G4PhysicalVolumeModel::G4PhysicalVolumeNodeID>& fullPath,
172  const G4Colour&);
173  // Set the touchable colour attribute.
174  // Changes the Vis Attribute Modifiers WITHOUT triggering a rebuild.
175 
176  class G4Spline
177  {
178  public:
179 
180  // Constructors and destructor
181  G4Spline();
182  ~G4Spline();
183 
184  // Operations
185  void AddSplinePoint(const G4Vector3D& v);
186  G4Vector3D GetInterpolatedSplinePoint(float t); // t = 0...1; 0=vp[0] ... 1=vp[max]
187  int GetNumPoints();
188  G4Vector3D GetPoint(int);
189  // method for computing the Catmull-Rom parametric equation
190  // given a time (t) and a vector quadruple (p1,p2,p3,p4).
191  G4Vector3D CatmullRom_Eq(float t, const G4Vector3D& p1, const G4Vector3D& p2,
192  const G4Vector3D& p3, const G4Vector3D& p4);
193 
194  private:
195  std::vector<G4Vector3D> vp;
196  float delta_t;
197  };
198 
200  // Data members
201  G4VSceneHandler& fSceneHandler; // Abstract scene for this view.
202  G4int fViewId; // Id of this instance.
204  G4String fShortName; // Up to first ' ' character, if any.
205  G4ViewParameters fVP; // View parameters.
206  G4ViewParameters fDefaultVP; // Default view parameters.
207 
209  // Other parameters.
210  G4bool fNeedKernelVisit; // See DrawView() for comments.
211 };
212 
213 #include "G4VViewer.icc"
214 
215 /*********************************************
216 
217 Here is a minimal DrawView () as it might be implemented in the
218 concrete viewer.
219 
220 void G4VViewer::DrawView () { // Default - concrete view usually overrides.
221 
222  // First, a view should decide when to re-visit the G4 kernel.
223  // Sometimes it might not be necessary, e.g., if the scene is stored
224  // in a graphical database (e.g., OpenGL's display lists) and only
225  // the viewing angle has changed. But graphics systems without a
226  // graphical database will always need to visit the G4 kernel.
227 
228  NeedKernelVisit (); // Default is - always visit G4 kernel.
229  // Note: this routine sets the fNeedKernelVisit flag of *all* the views of
230  // the scene.
231 
232  ProcessView (); // The basic logic is here.
233 
234  // Then a view may have more to do, e.g., display the graphical
235  // database. That code should come here before finally...
236 
237  FinishView (); // Flush streams and/or swap buffers.
238 }
239 
240 *********************************************/
241 
242 #endif
void SetName(const G4String &)
Definition: G4VViewer.cc:72
const G4String & GetName() const
G4int fViewId
Definition: G4VViewer.hh:202
virtual void SetView()=0
G4int GetViewId() const
virtual void ClearView()=0
virtual void ShowView()
Definition: G4VViewer.cc:103
const G4ViewParameters & GetViewParameters() const
void SetViewParameters(const G4ViewParameters &vp)
Definition: G4VViewer.cc:120
HepGeom::Vector3D< G4double > G4Vector3D
Definition: G4Vector3D.hh:35
const char * name(G4int ptype)
int G4int
Definition: G4Types.hh:78
void TouchableSetVisibility(const std::vector< G4PhysicalVolumeModel::G4PhysicalVolumeNodeID > &fullPath, G4bool visibility)
Definition: G4VViewer.cc:138
G4ViewParameters fDefaultVP
Definition: G4VViewer.hh:206
G4VViewer(G4VSceneHandler &, G4int id, const G4String &name="")
Definition: G4VViewer.cc:46
const G4String & GetShortName() const
void TouchableSetColour(const std::vector< G4PhysicalVolumeModel::G4PhysicalVolumeNodeID > &fullPath, const G4Colour &)
Definition: G4VViewer.cc:172
const G4ViewParameters & GetDefaultViewParameters() const
virtual void ResetView()
void SetNeedKernelVisit(G4bool need)
bool G4bool
Definition: G4Types.hh:79
void SetDefaultViewParameters(const G4ViewParameters &vp)
const G4VisAttributes * GetApplicableVisAttributes(const G4VisAttributes *) const
G4ViewParameters fVP
Definition: G4VViewer.hh:205
virtual void Initialise()
G4Vector3D GetPoint(int)
Definition: G4VViewer.cc:423
void SetTouchable(const std::vector< G4PhysicalVolumeModel::G4PhysicalVolumeNodeID > &fullPath)
Definition: G4VViewer.cc:125
G4bool fNeedKernelVisit
Definition: G4VViewer.hh:210
G4Vector3D GetInterpolatedSplinePoint(float t)
Definition: G4VViewer.cc:433
G4String fName
Definition: G4VViewer.hh:203
virtual ~G4VViewer()
Definition: G4VViewer.cc:68
G4VSceneHandler * GetSceneHandler() const
virtual const std::vector< G4ModelingParameters::VisAttributesModifier > * GetPrivateVisAttributesModifiers() const
void NeedKernelVisit()
Definition: G4VViewer.cc:78
void RefreshView()
G4Vector3D CatmullRom_Eq(float t, const G4Vector3D &p1, const G4Vector3D &p2, const G4Vector3D &p3, const G4Vector3D &p4)
Definition: G4VViewer.cc:403
void ProcessView()
Definition: G4VViewer.cc:105
std::vector< G4ThreeVector > ComputeFlyThrough(G4Vector3D *)
Definition: G4VViewer.cc:206
std::vector< G4Vector3D > vp
Definition: G4VViewer.hh:195
G4String fShortName
Definition: G4VViewer.hh:204
G4VSceneHandler & fSceneHandler
Definition: G4VViewer.hh:201
void AddSplinePoint(const G4Vector3D &v)
Definition: G4VViewer.cc:416
virtual void FinishView()
Definition: G4VViewer.cc:101
virtual void DrawView()=0
friend std::ostream & operator<<(std::ostream &os, const G4VViewer &v)
Definition: G4VViewer.cc:384