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