1 | // |
---|
2 | // ******************************************************************** |
---|
3 | // * License and Disclaimer * |
---|
4 | // * * |
---|
5 | // * The Geant4 software is copyright of the Copyright Holders of * |
---|
6 | // * the Geant4 Collaboration. It is provided under the terms and * |
---|
7 | // * conditions of the Geant4 Software License, included in the file * |
---|
8 | // * LICENSE and available at http://cern.ch/geant4/license . These * |
---|
9 | // * include a list of copyright holders. * |
---|
10 | // * * |
---|
11 | // * Neither the authors of this software system, nor their employing * |
---|
12 | // * institutes,nor the agencies providing financial support for this * |
---|
13 | // * work make any representation or warranty, express or implied, * |
---|
14 | // * regarding this software system or assume any liability for its * |
---|
15 | // * use. Please see the license in the file LICENSE and URL above * |
---|
16 | // * for the full disclaimer and the limitation of liability. * |
---|
17 | // * * |
---|
18 | // * This code implementation is the result of the scientific and * |
---|
19 | // * technical work of the GEANT4 collaboration. * |
---|
20 | // * By using, copying, modifying or distributing the software (or * |
---|
21 | // * any work based on the software) you agree to acknowledge its * |
---|
22 | // * use in resulting scientific publications, and indicate your * |
---|
23 | // * acceptance of all terms of the Geant4 Software license. * |
---|
24 | // ******************************************************************** |
---|
25 | // |
---|
26 | // |
---|
27 | // $Id: G4VModel.hh,v 1.19 2006/07/10 16:09:30 allison Exp $ |
---|
28 | // GEANT4 tag $Name: geant4-09-04-beta-01 $ |
---|
29 | // |
---|
30 | // |
---|
31 | // John Allison 31st December 1997. |
---|
32 | // |
---|
33 | // Class Description: |
---|
34 | // |
---|
35 | // G4VModel is a base class for visualization models. A model is a |
---|
36 | // graphics-system-indepedent description of a Geant4 component. |
---|
37 | // The key fuctionality of a model is to know how to describe itself |
---|
38 | // to a scene handler. A scene is a collection of models. |
---|
39 | // A special case is made for G4PhysicalVolumeModel - a non-null pointer |
---|
40 | // is to be returned by G4PhysicalVolumeModel::GetG4PhysicalVolumeModel(). |
---|
41 | |
---|
42 | #ifndef G4VMODEL_HH |
---|
43 | #define G4VMODEL_HH |
---|
44 | |
---|
45 | #include "globals.hh" |
---|
46 | #include "G4VisExtent.hh" |
---|
47 | #include "G4Transform3D.hh" |
---|
48 | |
---|
49 | class G4VGraphicsScene; |
---|
50 | class G4ModelingParameters; |
---|
51 | |
---|
52 | class G4PhysicalVolumeModel; // Special case - see above. |
---|
53 | |
---|
54 | class G4VModel { |
---|
55 | |
---|
56 | public: // With description |
---|
57 | |
---|
58 | friend std::ostream& operator << (std::ostream& os, const G4VModel&); |
---|
59 | |
---|
60 | G4VModel |
---|
61 | (const G4Transform3D& modelTransformation = G4Transform3D(), |
---|
62 | const G4ModelingParameters* = 0); |
---|
63 | |
---|
64 | virtual ~G4VModel (); |
---|
65 | |
---|
66 | virtual void DescribeYourselfTo (G4VGraphicsScene&) = 0; |
---|
67 | // The main task of a model is to describe itself to the graphics scene. |
---|
68 | |
---|
69 | const G4ModelingParameters* GetModelingParameters () const; |
---|
70 | |
---|
71 | virtual G4String GetCurrentDescription () const; |
---|
72 | // A description which depends on the current state of the model. |
---|
73 | |
---|
74 | virtual G4String GetCurrentTag () const; |
---|
75 | // A tag which depends on the current state of the model. |
---|
76 | |
---|
77 | const G4VisExtent& GetExtent () const; |
---|
78 | // Extent of visible objects in local coordinate system. |
---|
79 | |
---|
80 | const G4String& GetGlobalDescription () const; |
---|
81 | // A description which does not change and lasts the life of the model. |
---|
82 | |
---|
83 | const G4String& GetGlobalTag () const; |
---|
84 | // A tag which does not change and lasts the life of the model. |
---|
85 | |
---|
86 | const G4Transform3D& GetTransformation () const; |
---|
87 | // Model transformation, i.e., position and orientation of model in |
---|
88 | // world. It is the responsibility of the model to apply this |
---|
89 | // transformation before passing items to the graphics scene. |
---|
90 | |
---|
91 | // Set methods for above... |
---|
92 | void SetModelingParameters (const G4ModelingParameters*); |
---|
93 | void SetExtent (const G4VisExtent&); |
---|
94 | void SetGlobalDescription (const G4String&); |
---|
95 | void SetGlobalTag (const G4String&); |
---|
96 | void SetTransformation (const G4Transform3D&); |
---|
97 | |
---|
98 | virtual G4bool Validate (G4bool warn = true); |
---|
99 | // Validate, but allow internal changes (hence non-const function). |
---|
100 | |
---|
101 | protected: |
---|
102 | |
---|
103 | G4String fGlobalTag; |
---|
104 | G4String fGlobalDescription; |
---|
105 | G4VisExtent fExtent; |
---|
106 | G4Transform3D fTransform; |
---|
107 | const G4ModelingParameters* fpMP; |
---|
108 | |
---|
109 | private: |
---|
110 | |
---|
111 | // Private copy constructor and assigment operator - copying and |
---|
112 | // assignment not allowed. Keeps CodeWizard happy. |
---|
113 | G4VModel (const G4VModel&); |
---|
114 | G4VModel& operator = (const G4VModel&); |
---|
115 | }; |
---|
116 | |
---|
117 | #include "G4VModel.icc" |
---|
118 | |
---|
119 | #endif |
---|