| 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 // 27 //
28 // 28 //
29 // John Allison 31st December 1997. 29 // John Allison 31st December 1997.
30 // 30 //
31 // Class Description: 31 // Class Description:
32 // 32 //
33 // Parameters associated with the modeling of 33 // Parameters associated with the modeling of GEANT4 objects.
34 34
35 #ifndef G4MODELINGPARAMETERS_HH 35 #ifndef G4MODELINGPARAMETERS_HH
36 #define G4MODELINGPARAMETERS_HH 36 #define G4MODELINGPARAMETERS_HH
37 37
38 #include "globals.hh" 38 #include "globals.hh"
39 #include "G4VisExtent.hh" 39 #include "G4VisExtent.hh"
40 #include "G4VisAttributes.hh" 40 #include "G4VisAttributes.hh"
41 #include "G4VPhysicalVolume.hh" 41 #include "G4VPhysicalVolume.hh"
42 42
43 #include <vector> 43 #include <vector>
44 #include <utility> 44 #include <utility>
45 45
46 class G4LogicalVolume; 46 class G4LogicalVolume;
47 class G4VisAttributes; 47 class G4VisAttributes;
48 class G4VSolid; 48 class G4VSolid;
49 class G4DisplacedSolid; <<
50 class G4Event; 49 class G4Event;
51 50
52 class G4ModelingParameters { 51 class G4ModelingParameters {
53 52
54 public: // With description 53 public: // With description
55 54
56 // Currently requested drawing style. 55 // Currently requested drawing style.
57 enum DrawingStyle { 56 enum DrawingStyle {
58 wf, // Draw edges - no hidden l 57 wf, // Draw edges - no hidden line removal (wireframe).
59 hlr, // Draw edges - hidden line 58 hlr, // Draw edges - hidden lines removed.
60 hsr, // Draw surfaces - hidden surf 59 hsr, // Draw surfaces - hidden surfaces removed.
61 hlhsr, // Draw surfaces and edges - h << 60 hlhsr // Draw surfaces and edges - hidden removed.
62 cloud // Draw as a cloud of points <<
63 }; <<
64 <<
65 enum CutawayMode { <<
66 cutawayUnion, // Union (addition) of <<
67 cutawayIntersection // Intersection (multi <<
68 }; 61 };
69 62
70 // enums and nested class for communicating 63 // enums and nested class for communicating a modification to the vis
71 // attributes for a specfic touchable define 64 // attributes for a specfic touchable defined by PVNameCopyNoPath.
72 enum VisAttributesSignifier { 65 enum VisAttributesSignifier {
73 VASVisibility, 66 VASVisibility,
74 VASDaughtersInvisible, 67 VASDaughtersInvisible,
75 VASColour, 68 VASColour,
76 VASLineStyle, 69 VASLineStyle,
77 VASLineWidth, 70 VASLineWidth,
78 VASForceWireframe, 71 VASForceWireframe,
79 VASForceSolid, 72 VASForceSolid,
80 VASForceCloud, <<
81 VASForceNumberOfCloudPoints, <<
82 VASForceAuxEdgeVisible, 73 VASForceAuxEdgeVisible,
83 VASForceLineSegmentsPerCircle 74 VASForceLineSegmentsPerCircle
84 }; 75 };
85 76
86 class PVNameCopyNo { 77 class PVNameCopyNo {
87 public: 78 public:
88 // Normal constructor 79 // Normal constructor
89 PVNameCopyNo(const G4String& name, G4int c << 80 PVNameCopyNo(G4String name, G4int copyNo)
90 : fName(name), fCopyNo(copyNo) {} 81 : fName(name), fCopyNo(copyNo) {}
91 const G4String& GetName() const {return fN 82 const G4String& GetName() const {return fName;}
92 G4int GetCopyNo() const {return fCopyNo;} 83 G4int GetCopyNo() const {return fCopyNo;}
93 G4bool operator!=(const PVNameCopyNo&) con 84 G4bool operator!=(const PVNameCopyNo&) const;
94 G4bool operator==(const PVNameCopyNo& rhs) 85 G4bool operator==(const PVNameCopyNo& rhs) const {return !operator!=(rhs);}
95 private: 86 private:
96 G4String fName; 87 G4String fName;
97 G4int fCopyNo; 88 G4int fCopyNo;
98 }; 89 };
99 typedef std::vector<PVNameCopyNo> PVNameCopy 90 typedef std::vector<PVNameCopyNo> PVNameCopyNoPath;
100 typedef PVNameCopyNoPath::const_iterator PVN 91 typedef PVNameCopyNoPath::const_iterator PVNameCopyNoPathConstIterator;
101 92
102 class PVPointerCopyNo { 93 class PVPointerCopyNo {
103 public: 94 public:
104 // Normal constructor 95 // Normal constructor
105 PVPointerCopyNo(G4VPhysicalVolume* pPV, G4 96 PVPointerCopyNo(G4VPhysicalVolume* pPV, G4int copyNo)
106 : fpPV(pPV), fCopyNo(copyNo) {} 97 : fpPV(pPV), fCopyNo(copyNo) {}
107 const G4String& GetName() const; 98 const G4String& GetName() const;
108 const G4VPhysicalVolume* GetPVPointer() co 99 const G4VPhysicalVolume* GetPVPointer() const {return fpPV;}
109 G4int GetCopyNo() const {return fCopyNo;} 100 G4int GetCopyNo() const {return fCopyNo;}
110 G4bool operator!=(const PVPointerCopyNo&) 101 G4bool operator!=(const PVPointerCopyNo&) const;
111 G4bool operator==(const PVPointerCopyNo& r 102 G4bool operator==(const PVPointerCopyNo& rhs) const {return !operator!=(rhs);}
112 private: 103 private:
113 G4VPhysicalVolume* fpPV; 104 G4VPhysicalVolume* fpPV;
114 G4int fCopyNo; 105 G4int fCopyNo;
115 }; 106 };
116 typedef std::vector<PVPointerCopyNo> PVPoint 107 typedef std::vector<PVPointerCopyNo> PVPointerCopyNoPath;
117 typedef PVPointerCopyNoPath::const_iterator 108 typedef PVPointerCopyNoPath::const_iterator PVPointerCopyNoPathConstIterator;
118 109
119 class VisAttributesModifier { 110 class VisAttributesModifier {
120 public: 111 public:
121 VisAttributesModifier 112 VisAttributesModifier
122 (const G4VisAttributes& visAtts, 113 (const G4VisAttributes& visAtts,
123 VisAttributesSignifier signifier, 114 VisAttributesSignifier signifier,
124 const PVNameCopyNoPath& path): 115 const PVNameCopyNoPath& path):
125 fVisAtts(visAtts), fSignifier(signifier), 116 fVisAtts(visAtts), fSignifier(signifier), fPVNameCopyNoPath(path) {}
126 const G4VisAttributes& GetVisAttributes() 117 const G4VisAttributes& GetVisAttributes() const
127 {return fVisAtts;} 118 {return fVisAtts;}
128 VisAttributesSignifier GetVisAttributesSig 119 VisAttributesSignifier GetVisAttributesSignifier() const
129 {return fSignifier;} 120 {return fSignifier;}
130 const PVNameCopyNoPath& GetPVNameCopyNoPat 121 const PVNameCopyNoPath& GetPVNameCopyNoPath() const
131 {return fPVNameCopyNoPath;} 122 {return fPVNameCopyNoPath;}
132 void SetVisAttributes(const G4VisAttribute 123 void SetVisAttributes(const G4VisAttributes& visAtts)
133 {fVisAtts = visAtts;} 124 {fVisAtts = visAtts;}
134 void SetVisAttributesSignifier(VisAttribut 125 void SetVisAttributesSignifier(VisAttributesSignifier signifier)
135 {fSignifier = signifier;} 126 {fSignifier = signifier;}
136 void SetPVNameCopyNoPath(const PVNameCopyN 127 void SetPVNameCopyNoPath(const PVNameCopyNoPath& PVNameCopyNoPath)
137 {fPVNameCopyNoPath = PVNameCopyNoPath;} 128 {fPVNameCopyNoPath = PVNameCopyNoPath;}
138 G4bool operator!=(const VisAttributesModif 129 G4bool operator!=(const VisAttributesModifier&) const;
139 G4bool operator==(const VisAttributesModif 130 G4bool operator==(const VisAttributesModifier& rhs) const
140 {return !operator!=(rhs);} 131 {return !operator!=(rhs);}
141 private: 132 private:
142 G4VisAttributes fVisAtts; 133 G4VisAttributes fVisAtts;
143 VisAttributesSignifier fSignifier; 134 VisAttributesSignifier fSignifier;
144 PVNameCopyNoPath fPVNameCopyNoPath; 135 PVNameCopyNoPath fPVNameCopyNoPath;
145 }; 136 };
146 137
147 G4ModelingParameters (); 138 G4ModelingParameters ();
148 139
149 G4ModelingParameters (const G4VisAttributes* 140 G4ModelingParameters (const G4VisAttributes* pDefaultVisAttributes,
150 DrawingStyle drawingSt 141 DrawingStyle drawingStyle,
151 G4bool isCulling, 142 G4bool isCulling,
152 G4bool isCullingInvisible, 143 G4bool isCullingInvisible,
153 G4bool isDensityCulling, 144 G4bool isDensityCulling,
154 G4double visibleDensity, 145 G4double visibleDensity,
155 G4bool isCullingCovered, 146 G4bool isCullingCovered,
156 G4int noOfSides); 147 G4int noOfSides);
157 // Culling and clipping policy for G4Physica 148 // Culling and clipping policy for G4PhysicalVolumeModel.
158 149
159 ~G4ModelingParameters (); 150 ~G4ModelingParameters ();
160 151
161 // Note: uses default assignment operator an 152 // Note: uses default assignment operator and copy constructor.
162 153
163 G4bool operator != (const G4ModelingParamete 154 G4bool operator != (const G4ModelingParameters&) const;
164 155
165 // Get and Is functions... 156 // Get and Is functions...
166 G4bool IsWarning 157 G4bool IsWarning () const;
167 const G4VisAttributes* GetDefaultVisAttribut 158 const G4VisAttributes* GetDefaultVisAttributes () const;
168 DrawingStyle GetDrawingStyle 159 DrawingStyle GetDrawingStyle () const;
169 G4int GetNumberOfCloudPoints <<
170 G4bool IsCulling 160 G4bool IsCulling () const;
171 G4bool IsCullingInvisible 161 G4bool IsCullingInvisible () const;
172 G4bool IsDensityCulling 162 G4bool IsDensityCulling () const;
173 G4double GetVisibleDensity 163 G4double GetVisibleDensity () const;
174 G4bool IsCullingCovered 164 G4bool IsCullingCovered () const;
175 G4int GetCBDAlgorithmNumber 165 G4int GetCBDAlgorithmNumber () const;
176 const std::vector<G4double>& GetCBDParameter 166 const std::vector<G4double>& GetCBDParameters () const;
177 G4bool IsExplode 167 G4bool IsExplode () const;
178 G4double GetExplodeFactor 168 G4double GetExplodeFactor () const;
179 const G4Point3D& GetExplodeCentre 169 const G4Point3D& GetExplodeCentre () const;
180 G4int GetNoOfSides 170 G4int GetNoOfSides () const;
181 G4DisplacedSolid* GetSectionSolid << 171 G4VSolid* GetSectionSolid () const;
182 CutawayMode GetCutawayMode << 172 G4VSolid* GetCutawaySolid () const;
183 G4DisplacedSolid* GetCutawaySolid <<
184 const G4Event* GetEvent 173 const G4Event* GetEvent () const;
185 const std::vector<VisAttributesModifier>& Ge 174 const std::vector<VisAttributesModifier>& GetVisAttributesModifiers() const;
186 G4bool IsSpecialMeshRendering <<
187 const std::vector<PVNameCopyNo>& GetSpecialM <<
188 175
189 // Set functions... 176 // Set functions...
190 void SetWarning (G4bool); 177 void SetWarning (G4bool);
191 void SetDefaultVisAttributes (const G4VisAtt 178 void SetDefaultVisAttributes (const G4VisAttributes* pDefaultVisAttributes);
192 void SetDrawingStyle (DrawingStyle); 179 void SetDrawingStyle (DrawingStyle);
193 void SetNumberOfCloudPoints (G4int); <<
194 void SetCulling (G4bool); 180 void SetCulling (G4bool);
195 void SetCullingInvisible (G4bool); 181 void SetCullingInvisible (G4bool);
196 void SetDensityCulling (G4bool); 182 void SetDensityCulling (G4bool);
197 void SetVisibleDensity (G4double); 183 void SetVisibleDensity (G4double);
198 void SetCullingCovered (G4bool); 184 void SetCullingCovered (G4bool);
199 void SetCBDAlgorithmNumber (G4int); 185 void SetCBDAlgorithmNumber (G4int);
200 void SetCBDParameters (const std::vec 186 void SetCBDParameters (const std::vector<G4double>&);
201 void SetExplodeFactor (G4double explo 187 void SetExplodeFactor (G4double explodeFactor);
202 void SetExplodeCentre (const G4Point3 188 void SetExplodeCentre (const G4Point3D& explodeCentre);
203 G4int SetNoOfSides (G4int); // Re 189 G4int SetNoOfSides (G4int); // Returns actual number set.
204 void SetSectionSolid (G4DisplacedSol << 190 void SetSectionSolid (G4VSolid* pSectionSolid);
205 void SetCutawayMode (CutawayMode); << 191 void SetCutawaySolid (G4VSolid* pCutawaySolid);
206 void SetCutawaySolid (G4DisplacedSol <<
207 void SetEvent (const G4Event* 192 void SetEvent (const G4Event* pEvent);
208 void SetVisAttributesModifiers(const std::ve 193 void SetVisAttributesModifiers(const std::vector<VisAttributesModifier>&);
209 void SetSpecialMeshRendering (G4bool); <<
210 void SetSpecialMeshVolumes (const std::vec <<
211 194
212 friend std::ostream& operator << 195 friend std::ostream& operator <<
213 (std::ostream& os, const G4ModelingParameter 196 (std::ostream& os, const G4ModelingParameters&);
214 197
215 friend std::ostream& operator << 198 friend std::ostream& operator <<
216 (std::ostream& os, const PVNameCopyNoPath&); 199 (std::ostream& os, const PVNameCopyNoPath&);
217 200
218 friend std::ostream& operator << 201 friend std::ostream& operator <<
219 (std::ostream& os, const PVPointerCopyNoPath 202 (std::ostream& os, const PVPointerCopyNoPath&);
220 203
221 friend std::ostream& operator << 204 friend std::ostream& operator <<
222 (std::ostream& os, 205 (std::ostream& os,
223 const std::vector<VisAttributesModifier>&); 206 const std::vector<VisAttributesModifier>&);
224 207
225 private: 208 private:
226 209
227 // Data members... 210 // Data members...
228 G4bool fWarning; // Print warn 211 G4bool fWarning; // Print warnings if true.
229 const G4VisAttributes* fpDefaultVisAttribute 212 const G4VisAttributes* fpDefaultVisAttributes;
230 DrawingStyle fDrawingStyle; // Drawing st 213 DrawingStyle fDrawingStyle; // Drawing style.
231 G4int fNumberOfCloudPoints; // For d <<
232 // <= 0 <<
233 G4bool fCulling; // Culling re 214 G4bool fCulling; // Culling requested.
234 G4bool fCullInvisible; // Cull (don' 215 G4bool fCullInvisible; // Cull (don't Draw) invisible objects.
235 G4bool fDensityCulling; // Density cu 216 G4bool fDensityCulling; // Density culling requested. If so...
236 G4double fVisibleDensity; // ...density 217 G4double fVisibleDensity; // ...density lower than this not drawn.
237 G4bool fCullCovered; // Cull daugh 218 G4bool fCullCovered; // Cull daughters covered by opaque mothers.
238 G4int fCBDAlgorithmNumber; // Colour 219 G4int fCBDAlgorithmNumber; // Colour by density algorithm number.
239 std::vector<G4double> fCBDParameters; // Col 220 std::vector<G4double> fCBDParameters; // Colour by density parameters.
240 G4double fExplodeFactor; // Explode al 221 G4double fExplodeFactor; // Explode along radius by this factor...
241 G4Point3D fExplodeCentre; // ...about t 222 G4Point3D fExplodeCentre; // ...about this centre.
242 G4int fNoOfSides; // ...if poly 223 G4int fNoOfSides; // ...if polygon approximates circle.
243 G4DisplacedSolid* fpSectionSolid; // For ge << 224 G4VSolid* fpSectionSolid; // For generic section (DCUT).
244 CutawayMode fCutawayMode; // Cutaway mo << 225 G4VSolid* fpCutawaySolid; // For generic cutaways.
245 G4DisplacedSolid* fpCutawaySolid; // For ge <<
246 const G4Event* fpEvent; // Event bein 226 const G4Event* fpEvent; // Event being processed.
247 std::vector<VisAttributesModifier> fVisAttri 227 std::vector<VisAttributesModifier> fVisAttributesModifiers;
248 G4bool fSpecialMeshRendering; // Requ <<
249 std::vector<PVNameCopyNo> fSpecialMeshVolume <<
250 }; 228 };
251 229
252 std::ostream& operator << 230 std::ostream& operator <<
253 (std::ostream& os, const G4ModelingParameters& 231 (std::ostream& os, const G4ModelingParameters&);
254 232
255 std::ostream& operator << 233 std::ostream& operator <<
256 (std::ostream& os, const G4ModelingParameters: 234 (std::ostream& os, const G4ModelingParameters::PVNameCopyNoPath&);
257 235
258 std::ostream& operator << 236 std::ostream& operator <<
259 (std::ostream& os, const G4ModelingParameters: 237 (std::ostream& os, const G4ModelingParameters::PVPointerCopyNoPath&);
260 238
261 std::ostream& operator << 239 std::ostream& operator <<
262 (std::ostream& os, 240 (std::ostream& os,
263 const std::vector<G4ModelingParameters::VisAt 241 const std::vector<G4ModelingParameters::VisAttributesModifier>&);
264 242
265 #include "G4ModelingParameters.icc" 243 #include "G4ModelingParameters.icc"
266 244
267 #endif 245 #endif
268 246