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