| Geant4 Cross Reference |
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 //
28 //
29 // John Allison 31st December 1997.
30 //
31 // Class Description:
32 //
33 // G4VModel is a base class for visualization models. A model is a
34 // graphics-system-indepedent description of a Geant4 component.
35 // The key fuctionality of a model is to know how to describe itself
36 // to a scene handler. A scene is a collection of models.
37
38 #ifndef G4VMODEL_HH
39 #define G4VMODEL_HH
40
41 #include "globals.hh"
42 #include "G4VisExtent.hh"
43
44 class G4VGraphicsScene;
45 class G4ModelingParameters;
46
47 class G4VModel {
48
49 public: // With description
50
51 friend std::ostream& operator << (std::ostream& os, const G4VModel&);
52
53 G4VModel(const G4ModelingParameters* = 0);
54
55 virtual ~G4VModel ();
56
57 virtual void DescribeYourselfTo (G4VGraphicsScene&) = 0;
58 // The main task of a model is to describe itself to the graphics scene.
59
60 const G4ModelingParameters* GetModelingParameters () const;
61
62 const G4String& GetType() const;
63 // The sub-class should set its type, which could be the class
64 // name, or, in the case of G4CallBackModel, it could be the type of
65 // object it is coding.
66
67 virtual G4String GetCurrentDescription () const;
68 // A description which depends on the current state of the model.
69
70 virtual G4String GetCurrentTag () const;
71 // A tag which depends on the current state of the model.
72
73 const G4VisExtent& GetExtent () const;
74 // Extent of visible objects in local coordinate system.
75
76 const G4String& GetGlobalDescription () const;
77 // A description which does not change and lasts the life of the model.
78
79 const G4String& GetGlobalTag () const;
80 // A tag which does not change and lasts the life of the model.
81
82 // Set methods for above...
83 void SetModelingParameters (const G4ModelingParameters*);
84 void SetExtent (const G4VisExtent&);
85 void SetType (const G4String&);
86 void SetGlobalDescription (const G4String&);
87 void SetGlobalTag (const G4String&);
88
89 virtual G4bool Validate (G4bool warn = true);
90 // Validate, but allow internal changes (hence non-const function).
91
92 protected:
93
94 G4String fType;
95 G4String fGlobalTag;
96 G4String fGlobalDescription;
97 G4VisExtent fExtent;
98 const G4ModelingParameters* fpMP;
99
100 private:
101
102 // Private copy constructor and assigment operator - copying and
103 // assignment not allowed. Keeps CodeWizard happy.
104 G4VModel (const G4VModel&);
105 G4VModel& operator = (const G4VModel&);
106 };
107
108 #include "G4VModel.icc"
109
110 #endif
111