| 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: G4VisAttributes.hh 98730 2016-08-09 10:47:54Z gcosmo $
27 // 28 //
28 // << 29 //
29 // John Allison 23rd October 1996 30 // John Allison 23rd October 1996
30 31
31 // Class Description: 32 // Class Description:
32 // Visualization attributes are a set of infor << 33 // Visualization attributes are a set of information associated with the
33 // visualizable objects. This information is n << 34 // visualizable objects. This information is necessary only for
34 // visualization, and is not included in geome << 35 // visualization, and is not included in geometrical information such
35 // as shapes, position, and orientation. << 36 // as shapes, position, and orientation.
36 // A typical example of a visualization attrib << 37 // A typical example of a visualization attribute is "colour".
37 // For example, in visualizing a box, the Visu << 38 // For example, in visualizing a box, the Visualization Manager must know
38 // its colour. If an object to be visualized h << 39 // its colour. If an object to be visualized has not been assigned a set of
39 // visualization attributes, then a proper def << 40 // visualization attributes, then a proper default set is used
40 // automatically. A set of visualization attri << 41 // automatically. A set of visualization attributes is held by an
41 // instance of class G4VisAttributes defined i << 42 // instance of class G4VisAttributes defined in the graphics_reps
42 // category. The followings are commonly-used 43 // category. The followings are commonly-used attributes:
43 // - visibility 44 // - visibility
44 // - visibility of daughters 45 // - visibility of daughters
45 // - force style << 46 // - force wireframe style, force solid style
46 // - force auxiliary edge visibility << 47 // - force auxiliary edge visibility, force line segments pe circle
47 // - force line segments per circle << 48 // - colour
48 // - colour <<
49 // Class Description - End: 49 // Class Description - End:
50 50
51 51
52 #ifndef __G4VISATTRIBUTES_HH__ 52 #ifndef __G4VISATTRIBUTES_HH__
53 #define __G4VISATTRIBUTES_HH__ 53 #define __G4VISATTRIBUTES_HH__
54 54
55 #include "globals.hh" 55 #include "globals.hh"
56 #include <vector> 56 #include <vector>
57 #include <map> 57 #include <map>
58 58
59 #include "graphics_reps_defs.hh" <<
60 <<
61 #include "G4Colour.hh" 59 #include "G4Colour.hh"
62 #include "G4Color.hh" 60 #include "G4Color.hh"
63 61
64 class G4AttValue; 62 class G4AttValue;
65 class G4AttDef; 63 class G4AttDef;
66 64
67 #include <CLHEP/Units/SystemOfUnits.h> <<
68 <<
69 class G4VisAttributes { 65 class G4VisAttributes {
70 66
71 friend std::ostream& operator << (std::ostre 67 friend std::ostream& operator << (std::ostream& os, const G4VisAttributes& a);
72 68
73 public: // With description 69 public: // With description
74 70
75 enum LineStyle {unbroken, dashed, dotted}; 71 enum LineStyle {unbroken, dashed, dotted};
76 enum ForcedDrawingStyle {wireframe, solid, c << 72 enum ForcedDrawingStyle {wireframe, solid};
77 << 73 enum {fMinLineSegmentsPerCircle = 3}; // number of sides per circle
>> 74
78 G4VisAttributes (); 75 G4VisAttributes ();
79 G4VisAttributes (G4bool visibility); 76 G4VisAttributes (G4bool visibility);
80 G4VisAttributes (const G4Colour& colour); 77 G4VisAttributes (const G4Colour& colour);
81 G4VisAttributes (G4bool visibility, const G4 78 G4VisAttributes (G4bool visibility, const G4Colour& colour);
82 G4VisAttributes (const G4VisAttributes&) = d << 79 G4VisAttributes (const G4VisAttributes&);
83 ~G4VisAttributes () = default; << 80 ~G4VisAttributes ();
84 G4VisAttributes& operator= (const G4VisAttri 81 G4VisAttributes& operator= (const G4VisAttributes&);
85 82
>> 83 // Deprecated 14 July 2016 JA
>> 84 // Use GetInvisible() instead. E.g.:
>> 85 // logical_volume->SetVisAttributes(G4VisAttributes::GetInvisible());
>> 86 // or use one of the above constructors or SetVisibility and
>> 87 // logical_volume->SetVisAttributes(my_vis_attributes);
>> 88 static const G4VisAttributes Invisible;
>> 89
86 static const G4VisAttributes& GetInvisible() 90 static const G4VisAttributes& GetInvisible();
87 91
88 G4bool operator != (const G4VisAttributes& a 92 G4bool operator != (const G4VisAttributes& a) const;
89 G4bool operator == (const G4VisAttributes& a 93 G4bool operator == (const G4VisAttributes& a) const;
90 94
91 void SetVisibility (G4bool = true); 95 void SetVisibility (G4bool = true);
92 void SetDaughtersInvisible (G4bool = true); 96 void SetDaughtersInvisible (G4bool = true);
93 void SetColour (const G4Colour& 97 void SetColour (const G4Colour&);
94 void SetColor (const G4Color&) 98 void SetColor (const G4Color&);
95 void SetColour (G4double red, G 99 void SetColour (G4double red, G4double green, G4double blue,
96 G4double alpha 100 G4double alpha = 1.);
97 void SetColor (G4double red, G 101 void SetColor (G4double red, G4double green, G4double blue,
98 G4double alpha 102 G4double alpha = 1.);
99 void SetLineStyle (LineStyle); 103 void SetLineStyle (LineStyle);
100 void SetLineWidth (G4double); 104 void SetLineWidth (G4double);
101 void SetForceWireframe (G4bool = true); 105 void SetForceWireframe (G4bool = true);
102 void SetForceSolid (G4bool = true); 106 void SetForceSolid (G4bool = true);
103 void SetForceCloud (G4bool = true); <<
104 void SetForceNumberOfCloudPoints (G4int nPoi <<
105 // nPoints <= 0 means under control of viewe <<
106 void SetForceAuxEdgeVisible (G4bool = true); 107 void SetForceAuxEdgeVisible (G4bool = true);
107 void SetForceLineSegmentsPerCircle (G4int nS 108 void SetForceLineSegmentsPerCircle (G4int nSegments);
108 // Allows choice of circle approximation. A 109 // Allows choice of circle approximation. A circle of 360 degrees
109 // will be composed of nSegments line segmen 110 // will be composed of nSegments line segments. If your solid has
110 // curves of D degrees that you need to divi 111 // curves of D degrees that you need to divide into N segments,
111 // specify nSegments = N * 360 / D. 112 // specify nSegments = N * 360 / D.
112 void SetStartTime (G4double); 113 void SetStartTime (G4double);
113 void SetEndTime (G4double); 114 void SetEndTime (G4double);
114 void SetAttValues (const std::vect 115 void SetAttValues (const std::vector<G4AttValue>*);
115 void SetAttDefs (const std::map< 116 void SetAttDefs (const std::map<G4String,G4AttDef>*);
116 117
117 G4bool IsVisible 118 G4bool IsVisible () const;
118 G4bool IsDaughtersInvisible 119 G4bool IsDaughtersInvisible () const;
119 const G4Colour& GetColour 120 const G4Colour& GetColour () const;
120 const G4Color& GetColor 121 const G4Color& GetColor () const;
121 LineStyle GetLineStyle 122 LineStyle GetLineStyle () const;
122 G4double GetLineWidth 123 G4double GetLineWidth () const;
123 G4bool IsForceDrawingStyle 124 G4bool IsForceDrawingStyle () const;
124 ForcedDrawingStyle GetForcedDrawingStyle 125 ForcedDrawingStyle GetForcedDrawingStyle () const;
125 G4int GetForcedNumberOfCloudPoints <<
126 G4bool IsForceAuxEdgeVisible 126 G4bool IsForceAuxEdgeVisible () const;
127 G4bool IsForcedAuxEdgeVisible 127 G4bool IsForcedAuxEdgeVisible () const;
128 G4bool IsForceLineSegmentsPerCircle 128 G4bool IsForceLineSegmentsPerCircle () const;
129 G4int GetForcedLineSegmentsPerCirc 129 G4int GetForcedLineSegmentsPerCircle () const;
130 G4double GetStartTime 130 G4double GetStartTime () const;
131 G4double GetEndTime 131 G4double GetEndTime () const;
132 static G4int GetMinLineSegmentsPerCircle 132 static G4int GetMinLineSegmentsPerCircle ();
133 // Returns an expendable copy of the G4AttVa 133 // Returns an expendable copy of the G4AttValues...
134 const std::vector<G4AttValue>* CreateAttValu 134 const std::vector<G4AttValue>* CreateAttValues () const;
135 // Returns the orginal long life G4AttDefs.. 135 // Returns the orginal long life G4AttDefs...
136 const std::map<G4String,G4AttDef>* GetAttDef 136 const std::map<G4String,G4AttDef>* GetAttDefs () const;
137 137
138 static constexpr G4int fMinLineSegmentsPerCi <<
139 // Minumum number of sides per circle <<
140 <<
141 static constexpr G4double fVeryLongTime = 1. <<
142 // About 1.e75 billion years!! Used as defau <<
143 <<
144 private: 138 private:
145 139
146 G4bool fVisible; // Visibili 140 G4bool fVisible; // Visibility flag
147 G4bool fDaughtersInvisible; // Make dau 141 G4bool fDaughtersInvisible; // Make daughters invsibile.
148 G4Colour fColour; 142 G4Colour fColour;
149 LineStyle fLineStyle; 143 LineStyle fLineStyle;
150 G4double fLineWidth; // Units of 144 G4double fLineWidth; // Units of "normal" device linewidth, e.g.,
151 // pixels f 145 // pixels for screen, 0.1 mm for paper.
152 G4bool fForceDrawingStyle; // To switc 146 G4bool fForceDrawingStyle; // To switch on forced drawing style.
153 ForcedDrawingStyle fForcedStyle; // Value of 147 ForcedDrawingStyle fForcedStyle; // Value of forced drawing style.
154 G4int fForcedNumberOfCloudPoints; // <<
155 // <<
156 G4bool fForceAuxEdgeVisible; // To sw 148 G4bool fForceAuxEdgeVisible; // To switch on a forced auxiliary edge mode.
157 G4bool fForcedAuxEdgeVisible; // Wheth 149 G4bool fForcedAuxEdgeVisible; // Whether aux edges are visible or not.
158 G4int fForcedLineSegmentsPerCircle; // Forc 150 G4int fForcedLineSegmentsPerCircle; // Forced lines segments per
159 // circ 151 // circle. <=0 means not forced.
160 G4double fStartTime, fEndTime; // Time ran 152 G4double fStartTime, fEndTime; // Time range.
161 const std::vector<G4AttValue>* fAttValue 153 const std::vector<G4AttValue>* fAttValues; // For picking, etc.
162 const std::map<G4String,G4AttDef>* fAttDefs; 154 const std::map<G4String,G4AttDef>* fAttDefs; // Corresponding definitions.
163 }; 155 };
164 156
165 #include "G4VisAttributes.icc" 157 #include "G4VisAttributes.icc"
166 158
167 #endif 159 #endif
168 160