| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer << 3 // * DISCLAIMER *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th << 5 // * The following disclaimer summarizes all the specific disclaimers *
6 // * the Geant4 Collaboration. It is provided << 6 // * of contributors to this software. The specific disclaimers,which *
7 // * conditions of the Geant4 Software License << 7 // * govern, are listed with their locations in: *
8 // * LICENSE and available at http://cern.ch/ << 8 // * http://cern.ch/geant4/license *
9 // * include a list of copyright holders. <<
10 // * 9 // * *
11 // * Neither the authors of this software syst 10 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 11 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 12 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 13 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file << 14 // * use. *
16 // * for the full disclaimer and the limitatio <<
17 // * 15 // * *
18 // * This code implementation is the result << 16 // * This code implementation is the intellectual property of the *
19 // * technical work of the GEANT4 collaboratio << 17 // * GEANT4 collaboration. *
20 // * By using, copying, modifying or distri << 18 // * By copying, distributing or modifying the Program (or any work *
21 // * any work based on the software) you ag << 19 // * based on the Program) you indicate your acceptance of this *
22 // * use in resulting scientific publicati << 20 // * statement, and all its terms. *
23 // * acceptance of all terms of the Geant4 Sof <<
24 // ******************************************* 21 // ********************************************************************
25 // 22 //
26 // 23 //
>> 24 // $Id: G4VisAttributes.hh,v 1.11 2003/06/16 16:55:14 gunter Exp $
>> 25 // GEANT4 tag $Name: geant4-05-02-patch-01 $
27 // 26 //
28 // << 27 //
29 // John Allison 23rd October 1996 28 // John Allison 23rd October 1996
30 29
31 // Class Description: 30 // Class Description:
32 // Visualization attributes are a set of infor << 31 // Visualization attributes are a set of information associated with the
33 // visualizable objects. This information is n << 32 // visualizable objects. This information is necessary only for
34 // visualization, and is not included in geome << 33 // visualization, and is not included in geometrical information such
35 // as shapes, position, and orientation. << 34 // as shapes, position, and orientation.
36 // A typical example of a visualization attrib << 35 // A typical example of a visualization attribute is "colour".
37 // For example, in visualizing a box, the Visu << 36 // For example, in visualizing a box, the Visualization Manager must know
38 // its colour. If an object to be visualized h << 37 // its colour. If an object to be visualized has not been assigned a set of
39 // visualization attributes, then a proper def << 38 // visualization attributes, then a proper default set is used
40 // automatically. A set of visualization attri << 39 // automatically. A set of visualization attributes is held by an
41 // instance of class G4VisAttributes defined i << 40 // instance of class G4VisAttributes defined in the graphics_reps
42 // category. The followings are commonly-used 41 // category. The followings are commonly-used attributes:
43 // - visibility 42 // - visibility
44 // - visibility of daughters << 43 // - force wireframe style, force solid style
45 // - force style << 44 // - colour
46 // - force auxiliary edge visibility <<
47 // - force line segments per circle <<
48 // - colour <<
49 // Class Description - End: 45 // Class Description - End:
50 46
51 47
52 #ifndef __G4VISATTRIBUTES_HH__ 48 #ifndef __G4VISATTRIBUTES_HH__
53 #define __G4VISATTRIBUTES_HH__ 49 #define __G4VISATTRIBUTES_HH__
54 50
55 #include "globals.hh" 51 #include "globals.hh"
56 #include <vector> 52 #include <vector>
57 #include <map> <<
58 <<
59 #include "graphics_reps_defs.hh" <<
60 53
61 #include "G4Colour.hh" 54 #include "G4Colour.hh"
62 #include "G4Color.hh" 55 #include "G4Color.hh"
63 56
64 class G4AttValue; 57 class G4AttValue;
65 class G4AttDef; 58 class G4AttDef;
66 59
67 #include <CLHEP/Units/SystemOfUnits.h> <<
68 <<
69 class G4VisAttributes { 60 class G4VisAttributes {
70 61
71 friend std::ostream& operator << (std::ostre 62 friend std::ostream& operator << (std::ostream& os, const G4VisAttributes& a);
72 63
73 public: // With description 64 public: // With description
74 65
75 enum LineStyle {unbroken, dashed, dotted}; 66 enum LineStyle {unbroken, dashed, dotted};
76 enum ForcedDrawingStyle {wireframe, solid, c << 67 enum ForcedDrawingStyle {wireframe, solid};
77 68
78 G4VisAttributes (); 69 G4VisAttributes ();
79 G4VisAttributes (G4bool visibility); 70 G4VisAttributes (G4bool visibility);
80 G4VisAttributes (const G4Colour& colour); 71 G4VisAttributes (const G4Colour& colour);
81 G4VisAttributes (G4bool visibility, const G4 72 G4VisAttributes (G4bool visibility, const G4Colour& colour);
82 G4VisAttributes (const G4VisAttributes&) = d << 73
83 ~G4VisAttributes () = default; << 74 static const G4VisAttributes Invisible;
84 G4VisAttributes& operator= (const G4VisAttri <<
85 75
86 static const G4VisAttributes& GetInvisible() 76 static const G4VisAttributes& GetInvisible();
87 77
88 G4bool operator != (const G4VisAttributes& a 78 G4bool operator != (const G4VisAttributes& a) const;
89 G4bool operator == (const G4VisAttributes& a 79 G4bool operator == (const G4VisAttributes& a) const;
90 80
91 void SetVisibility (G4bool = true); <<
92 void SetDaughtersInvisible (G4bool = true); <<
93 void SetColour (const G4Colour& <<
94 void SetColor (const G4Color&) <<
95 void SetColour (G4double red, G <<
96 G4double alpha <<
97 void SetColor (G4double red, G <<
98 G4double alpha <<
99 void SetLineStyle (LineStyle); <<
100 void SetLineWidth (G4double); <<
101 void SetForceWireframe (G4bool = true); <<
102 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 SetForceLineSegmentsPerCircle (G4int nS <<
108 // Allows choice of circle approximation. A <<
109 // will be composed of nSegments line segmen <<
110 // curves of D degrees that you need to divi <<
111 // specify nSegments = N * 360 / D. <<
112 void SetStartTime (G4double); <<
113 void SetEndTime (G4double); <<
114 void SetAttValues (const std::vect <<
115 void SetAttDefs (const std::map< <<
116 <<
117 G4bool IsVisible 81 G4bool IsVisible () const;
118 G4bool IsDaughtersInvisible 82 G4bool IsDaughtersInvisible () const;
119 const G4Colour& GetColour 83 const G4Colour& GetColour () const;
120 const G4Color& GetColor 84 const G4Color& GetColor () const;
121 LineStyle GetLineStyle 85 LineStyle GetLineStyle () const;
122 G4double GetLineWidth 86 G4double GetLineWidth () const;
123 G4bool IsForceDrawingStyle 87 G4bool IsForceDrawingStyle () const;
124 ForcedDrawingStyle GetForcedDrawingStyle 88 ForcedDrawingStyle GetForcedDrawingStyle () const;
125 G4int GetForcedNumberOfCloudPoints << 89 const std::vector<G4AttValue>* GetAttValues () const;
126 G4bool IsForceAuxEdgeVisible << 90 const std::vector<G4AttDef>* GetAttDefs () const;
127 G4bool IsForcedAuxEdgeVisible <<
128 G4bool IsForceLineSegmentsPerCircle <<
129 G4int GetForcedLineSegmentsPerCirc <<
130 G4double GetStartTime <<
131 G4double GetEndTime <<
132 static G4int GetMinLineSegmentsPerCircle <<
133 // Returns an expendable copy of the G4AttVa <<
134 const std::vector<G4AttValue>* CreateAttValu <<
135 // Returns the orginal long life G4AttDefs.. <<
136 const std::map<G4String,G4AttDef>* GetAttDef <<
137 <<
138 static constexpr G4int fMinLineSegmentsPerCi <<
139 // Minumum number of sides per circle <<
140 91
141 static constexpr G4double fVeryLongTime = 1. << 92 void SetVisibility (G4bool);
142 // About 1.e75 billion years!! Used as defau << 93 void SetDaughtersInvisible (G4bool);
>> 94 void SetColour (const G4Colour&);
>> 95 void SetColor (const G4Color&);
>> 96 void SetColour (G4double red, G4double green, G4double blue,
>> 97 G4double alpha = 1.);
>> 98 void SetColor (G4double red, G4double green, G4double blue,
>> 99 G4double alpha = 1.);
>> 100 void SetLineStyle (LineStyle);
>> 101 void SetLineWidth (G4double);
>> 102 void SetForceWireframe (G4bool);
>> 103 void SetForceSolid (G4bool);
>> 104 void SetAttValues (const std::vector<G4AttValue>*);
>> 105 void SetAttDefs (const std::vector<G4AttDef>*);
143 106
144 private: 107 private:
145 108
146 G4bool fVisible; // Visibili 109 G4bool fVisible; // Visibility flag
147 G4bool fDaughtersInvisible; // Make dau 110 G4bool fDaughtersInvisible; // Make daughters invsibile.
148 G4Colour fColour; 111 G4Colour fColour;
149 LineStyle fLineStyle; 112 LineStyle fLineStyle;
150 G4double fLineWidth; // Units of 113 G4double fLineWidth; // Units of "normal" device linewidth, e.g.,
151 // pixels f 114 // pixels for screen, 0.1 mm for paper.
152 G4bool fForceDrawingStyle; // To switc 115 G4bool fForceDrawingStyle; // To switch on forced drawing style.
153 ForcedDrawingStyle fForcedStyle; // Value of 116 ForcedDrawingStyle fForcedStyle; // Value of forced drawing style.
154 G4int fForcedNumberOfCloudPoints; // << 117 const std::vector<G4AttValue>* fAttValues; // For picking, etc.
155 // << 118 const std::vector<G4AttDef>* fAttDefs; // Corresponding definitions.
156 G4bool fForceAuxEdgeVisible; // To sw <<
157 G4bool fForcedAuxEdgeVisible; // Wheth <<
158 G4int fForcedLineSegmentsPerCircle; // Forc <<
159 // circ <<
160 G4double fStartTime, fEndTime; // Time ran <<
161 const std::vector<G4AttValue>* fAttValue <<
162 const std::map<G4String,G4AttDef>* fAttDefs; <<
163 }; 119 };
164 120
165 #include "G4VisAttributes.icc" 121 #include "G4VisAttributes.icc"
166 122
167 #endif 123 #endif
168 124