| 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 #ifndef G4SceneTreeItem_hh 28 #ifndef G4SceneTreeItem_hh
29 #define G4SceneTreeItem_hh 29 #define G4SceneTreeItem_hh
30 30
31 #include "G4AttDef.hh" 31 #include "G4AttDef.hh"
32 #include "G4AttValue.hh" 32 #include "G4AttValue.hh"
33 #include "G4VisAttributes.hh" 33 #include "G4VisAttributes.hh"
34 #include "globals.hh" 34 #include "globals.hh"
35 35
36 #include <list> 36 #include <list>
37 #include <map> 37 #include <map>
38 #include <vector> 38 #include <vector>
39 39
40 class G4SceneTreeItem 40 class G4SceneTreeItem
41 { 41 {
42 public: 42 public:
43 // A ghost is a touchable we know to be th 43 // A ghost is a touchable we know to be there but know only its path
44 enum Type 44 enum Type
45 { 45 {
46 unidentified, 46 unidentified,
47 root, 47 root,
48 model, 48 model,
49 pvmodel, // Physical Volume model - spe 49 pvmodel, // Physical Volume model - special case
50 ghost, 50 ghost,
51 touchable 51 touchable
52 }; 52 };
53 53
54 explicit G4SceneTreeItem(Type type = unide 54 explicit G4SceneTreeItem(Type type = unidentified) { fType = type; }
55 ~G4SceneTreeItem() = default; 55 ~G4SceneTreeItem() = default;
56 56
57 // Copy contructor copies the whole tree, 57 // Copy contructor copies the whole tree, i.e., children and all descendants
58 G4SceneTreeItem(const G4SceneTreeItem&) = 58 G4SceneTreeItem(const G4SceneTreeItem&) = default;
59 59
60 // Assigns the whole tree, i.e., children 60 // Assigns the whole tree, i.e., children and all descendants
61 G4SceneTreeItem& operator= (const G4SceneT 61 G4SceneTreeItem& operator= (const G4SceneTreeItem&) = default;
62 62
63 // Access functions 63 // Access functions
64 64
65 Type GetType() const { return fType; } 65 Type GetType() const { return fType; }
66 const G4String& GetTypeString() const { re 66 const G4String& GetTypeString() const { return fTypeMap[fType]; }
67 void SetType(Type type) { fType = type; } 67 void SetType(Type type) { fType = type; }
68 68
69 const G4String& GetPVPath() const { return 69 const G4String& GetPVPath() const { return fPVPath; }
70 void SetPVPath(const G4String& PVPath) { f 70 void SetPVPath(const G4String& PVPath) { fPVPath = PVPath; }
71 71
72 const G4String& GetDescription() const { r 72 const G4String& GetDescription() const { return fDescription; }
73 void SetDescription(const G4String& descri 73 void SetDescription(const G4String& description) { fDescription = description; }
74 74
75 const G4String& GetModelType() const { ret 75 const G4String& GetModelType() const { return fModelType; }
76 void SetModelType(const G4String& modelTyp 76 void SetModelType(const G4String& modelType) { fModelType = modelType; }
77 77
78 const G4String& GetModelDescription() cons 78 const G4String& GetModelDescription() const { return fModelDescription; }
79 void SetModelDescription(const G4String& m 79 void SetModelDescription(const G4String& modelDescription)
80 { fModelDescription = modelDescription; } << 80 {
81 << 81 fModelDescription = modelDescription;
82 const G4String& GetFurtherInfo() const { r << 82 }
83 void SetFurtherInfo(const G4String& furthe <<
84 { fFurtherInfo = furtherInfo; } <<
85 83
86 const std::map<G4String, G4AttDef>* GetAtt 84 const std::map<G4String, G4AttDef>* GetAttDefs() const { return fpAttDefs; }
87 void SetAttDefs(const std::map<G4String, G 85 void SetAttDefs(const std::map<G4String, G4AttDef>* pAttDefs) { fpAttDefs = pAttDefs; };
88 86
89 std::vector<G4AttValue>* GetAttValues() co 87 std::vector<G4AttValue>* GetAttValues() const { return fpAttValues; }
90 void SetAttValues(std::vector<G4AttValue>* 88 void SetAttValues(std::vector<G4AttValue>* pAttValues) { fpAttValues = pAttValues; }
91 89
92 const G4VisAttributes& GetVisAttributes() 90 const G4VisAttributes& GetVisAttributes() const { return fVisAttributes; }
93 G4VisAttributes& AccessVisAttributes() { r 91 G4VisAttributes& AccessVisAttributes() { return fVisAttributes; }
94 void SetVisAttributes(const G4VisAttribute 92 void SetVisAttributes(const G4VisAttributes& visAtts) { fVisAttributes = visAtts; }
95 93
96 const std::list<G4SceneTreeItem>& GetChild 94 const std::list<G4SceneTreeItem>& GetChildren() const { return fChildren; }
97 // Insert item at - or rather, just before 95 // Insert item at - or rather, just before - pos
98 std::list<G4SceneTreeItem>::iterator Inser 96 std::list<G4SceneTreeItem>::iterator InsertChild(std::list<G4SceneTreeItem>::iterator pos,
99 97 const G4SceneTreeItem& item)
100 { 98 {
101 return fChildren.insert(pos, item); 99 return fChildren.insert(pos, item);
102 } 100 }
103 std::list<G4SceneTreeItem>& AccessChildren 101 std::list<G4SceneTreeItem>& AccessChildren() { return fChildren; }
104 102
105 G4bool IsExpanded() const { return 103 G4bool IsExpanded() const { return fExpanded; }
106 void SetExpanded(G4bool expanded) { fExpan 104 void SetExpanded(G4bool expanded) { fExpanded = expanded; }
107 105
108 // Utility functions 106 // Utility functions
109 107
110 // Reset visibility of all objects to fals 108 // Reset visibility of all objects to false - visible objects will then set to true
111 void ResetVisibility(); 109 void ResetVisibility();
112 110
113 // If found, returns "true" and places ite 111 // If found, returns "true" and places iterator in foundIter
114 G4bool FindTouchableFromRoot(const G4Strin 112 G4bool FindTouchableFromRoot(const G4String& fullPathString,
115 std::list<G4S 113 std::list<G4SceneTreeItem>::iterator& foundIter);
116 114
117 // Dump single item, i.e., ignore any chil 115 // Dump single item, i.e., ignore any children
118 void DumpSingleItem(std::ostream&, G4int v 116 void DumpSingleItem(std::ostream&, G4int verbosity = 0) const;
119 117
120 // Dump whole tree 118 // Dump whole tree
121 void DumpTree(std::ostream&, G4int verbosi 119 void DumpTree(std::ostream&, G4int verbosity = 0) const;
122 120
123 private: 121 private:
124 Type fType = unidentified; 122 Type fType = unidentified;
125 static std::map<Type, G4String> fTypeMap; 123 static std::map<Type, G4String> fTypeMap;
126 G4String fDescription; 124 G4String fDescription;
127 G4String fModelType = "none"; 125 G4String fModelType = "none";
128 G4String fModelDescription; 126 G4String fModelDescription;
129 G4String fFurtherInfo; // Intended for a <<
130 G4String fPVPath; 127 G4String fPVPath;
131 G4VisAttributes fVisAttributes; 128 G4VisAttributes fVisAttributes;
132 const std::map<G4String, G4AttDef>* fpAttD 129 const std::map<G4String, G4AttDef>* fpAttDefs = nullptr;
133 std::vector<G4AttValue>* fpAttValues = nul 130 std::vector<G4AttValue>* fpAttValues = nullptr;
134 std::list<G4SceneTreeItem> fChildren; 131 std::list<G4SceneTreeItem> fChildren;
135 G4bool fExpanded = true; 132 G4bool fExpanded = true;
136 }; 133 };
137 134
138 #endif // G4SceneTreeItem_hh 135 #endif // G4SceneTreeItem_hh
139 136