ECCE @ EIC Software
Reference for
ECCE @ EIC
simulation and reconstruction software on GitHub
Home page
Related Pages
Modules
Namespaces
Classes
Files
External Links
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Groups
Pages
G4VModel.hh
Go to the documentation of this file.
Or view
the newest version in sPHENIX GitHub for file G4VModel.hh
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
// A special case is made for G4PhysicalVolumeModel - a non-null pointer
38
// is to be returned by G4PhysicalVolumeModel::GetG4PhysicalVolumeModel().
39
40
#ifndef G4VMODEL_HH
41
#define G4VMODEL_HH
42
43
#include "
globals.hh
"
44
#include "
G4VisExtent.hh
"
45
#include "
G4Transform3D.hh
"
46
47
class
G4VGraphicsScene
;
48
class
G4ModelingParameters
;
49
50
class
G4PhysicalVolumeModel
;
// Special case - see above.
51
52
class
G4VModel
{
53
54
public
:
// With description
55
56
friend
std::ostream&
operator <<
(std::ostream& os,
const
G4VModel
&);
57
58
G4VModel
59
(
const
G4Transform3D
& modelTransformation =
G4Transform3D
(),
60
const
G4ModelingParameters
* = 0);
61
62
virtual
~G4VModel
();
63
64
virtual
void
DescribeYourselfTo
(
G4VGraphicsScene
&) = 0;
65
// The main task of a model is to describe itself to the graphics scene.
66
67
const
G4ModelingParameters
*
GetModelingParameters
()
const
;
68
69
const
G4String
&
GetType
()
const
;
70
// The sub-class should set its type, which could be the class
71
// name, or, in the case of G4CallBackModel, it could be the type of
72
// object it is coding.
73
74
virtual
G4String
GetCurrentDescription
()
const
;
75
// A description which depends on the current state of the model.
76
77
virtual
G4String
GetCurrentTag
()
const
;
78
// A tag which depends on the current state of the model.
79
80
const
G4VisExtent
&
GetExtent
()
const
;
81
// Extent of visible objects in local coordinate system.
82
83
const
G4VisExtent
&
GetTransformedExtent
()
const
;
84
// Extent of visible objects in transformed coordinate system.
85
86
const
G4String
&
GetGlobalDescription
()
const
;
87
// A description which does not change and lasts the life of the model.
88
89
const
G4String
&
GetGlobalTag
()
const
;
90
// A tag which does not change and lasts the life of the model.
91
92
const
G4Transform3D
&
GetTransformation
()
const
;
93
// Model transformation, i.e., position and orientation of model in
94
// world. It is the responsibility of the model to apply this
95
// transformation before passing items to the graphics scene.
96
97
// Set methods for above...
98
void
SetModelingParameters
(
const
G4ModelingParameters
*);
99
void
SetExtent
(
const
G4VisExtent
&);
100
void
SetType
(
const
G4String
&);
101
void
SetGlobalDescription
(
const
G4String
&);
102
void
SetGlobalTag
(
const
G4String
&);
103
void
SetTransformation
(
const
G4Transform3D
&);
104
105
virtual
G4bool
Validate
(
G4bool
warn =
true
);
106
// Validate, but allow internal changes (hence non-const function).
107
108
protected
:
109
110
G4String
fType
;
111
G4String
fGlobalTag
;
112
G4String
fGlobalDescription
;
113
G4VisExtent
fExtent
;
114
G4Transform3D
fTransform
;
115
const
G4ModelingParameters
*
fpMP
;
116
117
private
:
118
119
// Private copy constructor and assigment operator - copying and
120
// assignment not allowed. Keeps CodeWizard happy.
121
G4VModel
(
const
G4VModel
&);
122
G4VModel
&
operator =
(
const
G4VModel
&);
123
};
124
125
#include "G4VModel.icc"
126
127
#endif
geant4
tree
geant4-10.6-release
source
visualization
modeling
include
G4VModel.hh
Built by
Jin Huang
. updated:
Wed Jun 29 2022 17:25:56
using
1.8.2 with
ECCE GitHub integration