ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
G4Box.hh
Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file G4Box.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 // G4Box
27 //
28 // Class description:
29 //
30 // A Box is a cuboid of given half lengths dx,dy,dz. The Box is
31 // centred on the origin with sides parallel to the x/y/z axes.
32 
33 // 30.06.95 P.Kent: Converted from source code developed end 94
34 // 27.03.96 J.Allison: Added virtual functions DescribeYourselfTo() and
35 // SendWireframeTo(G4VGraphicsModel&)
36 // 27.03.98 J.Apostolakis: Inherit from G4CSGSolid (not G4VSolid)
37 // --------------------------------------------------------------------
38 #ifndef G4BOX_HH
39 #define G4BOX_HH
40 
41 #include "G4GeomTypes.hh"
42 
43 #if defined(G4GEOM_USE_USOLIDS)
44 #define G4GEOM_USE_UBOX 1
45 #endif
46 
47 #if defined(G4GEOM_USE_UBOX)
48  #define G4UBox G4Box
49  #include "G4UBox.hh"
50 #else
51 
52 #include "G4CSGSolid.hh"
53 #include "G4Polyhedron.hh"
54 
55 class G4Box : public G4CSGSolid
56 {
57  public: // with description
58 
59  G4Box(const G4String& pName, G4double pX, G4double pY, G4double pZ);
60  // Construct a box with name, and half lengths pX,pY,pZ
61 
62  virtual ~G4Box();
63 
65  const G4int n,
66  const G4VPhysicalVolume* pRep);
67 
69 
70  G4bool CalculateExtent(const EAxis pAxis,
71  const G4VoxelLimits& pVoxelLimit,
72  const G4AffineTransform& pTransform,
73  G4double& pMin, G4double& pMax) const;
74 
75  // Accessors and modifiers
76 
77  inline G4double GetXHalfLength() const;
78  inline G4double GetYHalfLength() const;
79  inline G4double GetZHalfLength() const;
80 
81  void SetXHalfLength(G4double dx) ;
82  void SetYHalfLength(G4double dy) ;
83  void SetZHalfLength(G4double dz) ;
84 
85  // Methods for solid
86 
87  inline G4double GetCubicVolume();
88  inline G4double GetSurfaceArea();
89 
90  EInside Inside(const G4ThreeVector& p) const;
91  G4ThreeVector SurfaceNormal( const G4ThreeVector& p) const;
92  G4double DistanceToIn(const G4ThreeVector& p, const G4ThreeVector& v) const;
93  G4double DistanceToIn(const G4ThreeVector& p) const;
95  const G4bool calcNorm = false,
96  G4bool* validNorm = nullptr,
97  G4ThreeVector* n = nullptr) const;
98  G4double DistanceToOut(const G4ThreeVector& p) const;
99 
102 
103  G4VSolid* Clone() const;
104 
105  std::ostream& StreamInfo(std::ostream& os) const;
106 
107  // Utilities for visualization
108 
109  void DescribeYourselfTo (G4VGraphicsScene& scene) const;
110  G4VisExtent GetExtent () const;
111  G4Polyhedron* CreatePolyhedron () const;
112 
113  public: // without description
114 
115  G4Box(__void__&);
116  // Fake default constructor for usage restricted to direct object
117  // persistency for clients requiring preallocation of memory for
118  // persistifiable objects.
119 
120  G4Box(const G4Box& rhs);
121  G4Box& operator=(const G4Box& rhs);
122  // Copy constructor and assignment operator.
123 
124  private:
125 
127  // Algorithm for SurfaceNormal() following the original
128  // specification for points not on the surface
129 
130  private:
131 
132  G4double fDx = 0.0, fDy = 0.0, fDz = 0.0;
133  G4double delta; // Cached half Cartesian tolerance
134 };
135 
136 #include "G4Box.icc"
137 
138 #endif
139 
140 #endif