Logo ROOT   master
Reference Guide
TGeoShape.h
Go to the documentation of this file.
1 // @(#)root/geom:$Id$
2 // Author: Andrei Gheata 31/01/02
3 
4 /*************************************************************************
5  * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6  * All rights reserved. *
7  * *
8  * For the licensing terms see $ROOTSYS/LICENSE. *
9  * For the list of contributors see $ROOTSYS/README/CREDITS. *
10  *************************************************************************/
11 
12 #ifndef ROOT_TGeoShape
13 #define ROOT_TGeoShape
14 
15 #include "TNamed.h"
16 
17 // forward declarations
18 class TGeoBoolCombinator;
19 class TGeoBBox;
20 class TGeoMatrix;
21 class TGeoHMatrix;
22 class TGeoVolume;
23 class TBuffer3D;
24 
25 class TGeoShape : public TNamed
26 {
27 private:
28  static TGeoMatrix *fgTransform; // current transformation matrix that applies to shape
29  static Double_t fgEpsMch; // Machine round-off error
30 public:
31 enum EShapeType {
32  kBitMask32 = 0xffffffff,
34  kGeoBad = BIT(0),
35  kGeoRSeg = BIT(1),
38  kGeoVisX = BIT(4),
39  kGeoVisY = BIT(5),
40  kGeoVisZ = BIT(6),
43  kGeoTorus = BIT(9),
44  kGeoBox = BIT(10),
45  kGeoPara = BIT(11),
46  kGeoSph = BIT(12),
47  kGeoTube = BIT(13),
49  kGeoCone = BIT(15),
51  kGeoPcon = BIT(17),
52  kGeoPgon = BIT(18),
53  kGeoArb8 = BIT(19),
54  kGeoEltu = BIT(20),
55  kGeoTrap = BIT(21),
56  kGeoCtub = BIT(22),
57  kGeoTrd1 = BIT(23),
58  kGeoTrd2 = BIT(24),
59  kGeoComb = BIT(25),
61  kGeoXtru = BIT(27),
64  kGeoHype = BIT(30),
66 };
67  virtual void ClearThreadData() const {}
68  virtual void CreateThreadData(Int_t) {}
69 
70 protected :
71 // data members
72  Int_t fShapeId; // shape id
73  UInt_t fShapeBits; // shape bits
74 // methods
75  virtual void FillBuffer3D(TBuffer3D & buffer, Int_t reqSections, Bool_t localFrame) const;
76  Int_t GetBasicColor() const;
77  void SetOnBoundary(Bool_t /*flag=kTRUE*/) {;}
78  void TransformPoints(Double_t *points, UInt_t NbPoints) const;
79 
80 public:
81  // constructors
82  TGeoShape();
83  TGeoShape(const char *name);
84  // destructor
85  virtual ~TGeoShape();
86  // methods
87 
88  static Double_t Big() {return 1.E30;}
89  static TGeoMatrix *GetTransform();
90  static void SetTransform(TGeoMatrix *matrix);
91  static Double_t Tolerance() {return 1.E-10;}
92  static Double_t ComputeEpsMch();
93  static Double_t EpsMch();
94  virtual void AfterStreamer() {};
95  virtual Double_t Capacity() const = 0;
96  void CheckShape(Int_t testNo, Int_t nsamples=10000, Option_t *option="");
97  virtual void ComputeBBox() = 0;
98  virtual void ComputeNormal(const Double_t *point, const Double_t *dir, Double_t *norm) = 0;
99  virtual void ComputeNormal_v(const Double_t *, const Double_t *, Double_t *, Int_t) {}
100  virtual Bool_t Contains(const Double_t *point) const = 0;
101  virtual void Contains_v(const Double_t *, Bool_t *, Int_t) const {}
102  virtual Bool_t CouldBeCrossed(const Double_t *point, const Double_t *dir) const = 0;
103  virtual Int_t DistancetoPrimitive(Int_t px, Int_t py) = 0;
104  virtual Double_t DistFromInside(const Double_t *point, const Double_t *dir, Int_t iact=1,
105  Double_t step=TGeoShape::Big(), Double_t *safe=0) const = 0;
106  virtual void DistFromInside_v(const Double_t *, const Double_t *, Double_t *, Int_t, Double_t *) const {}
107  virtual Double_t DistFromOutside(const Double_t *point, const Double_t *dir, Int_t iact=1,
108  Double_t step=TGeoShape::Big(), Double_t *safe=0) const = 0;
109  virtual void DistFromOutside_v(const Double_t *, const Double_t *, Double_t *, Int_t, Double_t *) const {}
110  static Double_t DistToPhiMin(const Double_t *point, const Double_t *dir, Double_t s1, Double_t c1, Double_t s2, Double_t c2,
111  Double_t sm, Double_t cm, Bool_t in=kTRUE);
112  virtual TGeoVolume *Divide(TGeoVolume *voldiv, const char *divname, Int_t iaxis, Int_t ndiv,
113  Double_t start, Double_t step) = 0;
114  virtual void Draw(Option_t *option=""); // *MENU*
115  virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py);
116  virtual const char *GetAxisName(Int_t iaxis) const = 0;
117  virtual Double_t GetAxisRange(Int_t iaxis, Double_t &xlo, Double_t &xhi) const = 0;
118  virtual void GetBoundingCylinder(Double_t *param) const = 0;
119  virtual const TBuffer3D &GetBuffer3D(Int_t reqSections, Bool_t localFrame) const;
120  virtual Int_t GetByteCount() const = 0;
121  virtual Bool_t GetPointsOnSegments(Int_t npoints, Double_t *array) const = 0;
122  virtual Int_t GetFittingBox(const TGeoBBox *parambox, TGeoMatrix *mat, Double_t &dx, Double_t &dy, Double_t &dz) const = 0;
123  Int_t GetId() const {return fShapeId;}
124  virtual TGeoShape *GetMakeRuntimeShape(TGeoShape *mother, TGeoMatrix *mat) const = 0;
125  virtual void GetMeshNumbers(Int_t &/*nvert*/, Int_t &/*nsegs*/, Int_t &/*npols*/) const {;}
126  virtual const char *GetName() const;
127  virtual Int_t GetNmeshVertices() const {return 0;}
128  const char *GetPointerName() const;
129  virtual Bool_t IsAssembly() const {return kFALSE;}
130  virtual Bool_t IsComposite() const {return kFALSE;}
131  virtual Bool_t IsCylType() const = 0;
132  static Bool_t IsCloseToPhi(Double_t epsil, const Double_t *point, Double_t c1, Double_t s1, Double_t c2, Double_t s2);
133  static Bool_t IsCrossingSemiplane(const Double_t *point, const Double_t *dir, Double_t cphi, Double_t sphi, Double_t &snext, Double_t &rxy);
136  static Bool_t IsInPhiRange(const Double_t *point, Double_t phi1, Double_t phi2);
137  virtual Bool_t IsReflected() const {return kFALSE;}
138  virtual Bool_t IsVecGeom() const {return kFALSE;}
141  virtual Bool_t IsValidBox() const = 0;
142  virtual void InspectShape() const = 0;
143  virtual TBuffer3D *MakeBuffer3D() const {return 0;}
144  static void NormalPhi(const Double_t *point, const Double_t *dir, Double_t *norm, Double_t c1, Double_t s1, Double_t c2, Double_t s2);
145  virtual void Paint(Option_t *option="");
146  virtual Double_t Safety(const Double_t *point, Bool_t in=kTRUE) const = 0;
147  virtual void Safety_v(const Double_t *, const Bool_t *, Double_t *, Int_t) const {}
148  static Double_t SafetyPhi(const Double_t *point, Bool_t in, Double_t phi1, Double_t phi2);
149  static Double_t SafetySeg(Double_t r, Double_t z, Double_t r1, Double_t z1, Double_t r2, Double_t z2, Bool_t outer);
150  virtual void SetDimensions(Double_t *param) = 0;
151  void SetId(Int_t id) {fShapeId = id;}
152  virtual void SetPoints(Double_t *points) const = 0;
153  virtual void SetPoints(Float_t *points) const = 0;
154  virtual void SetSegsAndPols(TBuffer3D &buff) const = 0;
156  Int_t ShapeDistancetoPrimitive(Int_t numpoints, Int_t px, Int_t py) const;
157  virtual void Sizeof3D() const = 0;
158 
159  //----- bit manipulation
160  void SetShapeBit(UInt_t f, Bool_t set);
163  Bool_t TestShapeBit(UInt_t f) const { return (Bool_t) ((fShapeBits & f) != 0); }
164  Int_t TestShapeBits(UInt_t f) const { return (Int_t) (fShapeBits & f); }
166 
167  ClassDef(TGeoShape, 2) // base class for shapes
168 };
169 
170 #endif
171 
void CheckShape(Int_t testNo, Int_t nsamples=10000, Option_t *option="")
Test for shape navigation methods.
Definition: TGeoShape.cxx:209
virtual void Sizeof3D() const =0
virtual Bool_t IsVecGeom() const
Definition: TGeoShape.h:138
static constexpr double cm
virtual ~TGeoShape()
Destructor.
Definition: TGeoShape.cxx:196
virtual void SetDimensions(Double_t *param)=0
#define snext(osub1, osub2)
Definition: triangle.c:1167
Box class.
Definition: TGeoBBox.h:17
static Double_t ComputeEpsMch()
Compute machine round-off double precision error as the smallest number that if added to 1...
Definition: TGeoShape.cxx:223
virtual Bool_t IsReflected() const
Definition: TGeoShape.h:137
virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py)
Execute mouse actions on this shape.
Definition: TGeoShape.cxx:711
Bool_t IsValid() const
Definition: TGeoShape.h:140
void SetOnBoundary(Bool_t)
Definition: TGeoShape.h:77
static Double_t EpsMch()
static function returning the machine round-off error
Definition: TGeoShape.cxx:240
virtual void ComputeNormal(const Double_t *point, const Double_t *dir, Double_t *norm)=0
float Float_t
Definition: RtypesCore.h:53
virtual Int_t DistancetoPrimitive(Int_t px, Int_t py)=0
Computes distance from point (px,py) to the object.
const char Option_t
Definition: RtypesCore.h:62
Geometrical transformation package.
Definition: TGeoMatrix.h:40
virtual Int_t GetByteCount() const =0
return c1
Definition: legend1.C:41
virtual void CreateThreadData(Int_t)
Definition: TGeoShape.h:68
#define BIT(n)
Definition: Rtypes.h:83
virtual void ComputeNormal_v(const Double_t *, const Double_t *, Double_t *, Int_t)
Definition: TGeoShape.h:99
TGeoVolume, TGeoVolumeMulti, TGeoVolumeAssembly are the volume classes.
Definition: TGeoVolume.h:42
virtual Bool_t GetPointsOnSegments(Int_t npoints, Double_t *array) const =0
Matrix class used for computing global transformations Should NOT be used for node definition...
Definition: TGeoMatrix.h:420
virtual TGeoShape * GetMakeRuntimeShape(TGeoShape *mother, TGeoMatrix *mat) const =0
#define f(i)
Definition: RSha256.hxx:104
int Int_t
Definition: RtypesCore.h:41
bool Bool_t
Definition: RtypesCore.h:59
static Double_t SafetyPhi(const Double_t *point, Bool_t in, Double_t phi1, Double_t phi2)
Static method to compute safety w.r.t a phi corner defined by cosines/sines of the angles phi1...
Definition: TGeoShape.cxx:464
virtual void GetBoundingCylinder(Double_t *param) const =0
static Bool_t IsSameWithinTolerance(Double_t a, Double_t b)
Check if two numbers differ with less than a tolerance.
Definition: TGeoShape.cxx:326
virtual void DistFromOutside_v(const Double_t *, const Double_t *, Double_t *, Int_t, Double_t *) const
Definition: TGeoShape.h:109
virtual Bool_t IsAssembly() const
Definition: TGeoShape.h:129
static Double_t Tolerance()
Definition: TGeoShape.h:91
virtual void FillBuffer3D(TBuffer3D &buffer, Int_t reqSections, Bool_t localFrame) const
Fill the supplied buffer, with sections in desired frame See TBuffer3D.h for explanation of sections...
Definition: TGeoShape.cxx:589
virtual Bool_t Contains(const Double_t *point) const =0
static const double x2[5]
#define ClassDef(name, id)
Definition: Rtypes.h:326
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
static Double_t fgEpsMch
Definition: TGeoShape.h:29
static Bool_t IsCrossingSemiplane(const Double_t *point, const Double_t *dir, Double_t cphi, Double_t sphi, Double_t &snext, Double_t &rxy)
Compute distance from POINT to semiplane defined by PHI angle along DIR.
Definition: TGeoShape.cxx:297
static const double x4[22]
static TGeoMatrix * fgTransform
Definition: TGeoShape.h:28
Int_t GetId() const
Definition: TGeoShape.h:123
void SetId(Int_t id)
Definition: TGeoShape.h:151
XFontStruct * id
Definition: TGX11.cxx:108
virtual void SetSegsAndPols(TBuffer3D &buff) const =0
static void SetTransform(TGeoMatrix *matrix)
Set current transformation matrix that applies to shape.
Definition: TGeoShape.cxx:544
virtual Bool_t IsValidBox() const =0
virtual void SetPoints(Double_t *points) const =0
const char * GetPointerName() const
Provide a pointer name containing uid.
Definition: TGeoShape.cxx:699
virtual TBuffer3D * MakeBuffer3D() const
Definition: TGeoShape.h:143
static Double_t SafetySeg(Double_t r, Double_t z, Double_t r1, Double_t z1, Double_t r2, Double_t z2, Bool_t outer)
Compute distance from point of coordinates (r,z) to segment (r1,z1):(r2,z2)
Definition: TGeoShape.cxx:494
point * points
Definition: X3DBuffer.c:22
static Bool_t IsSegCrossing(Double_t x1, Double_t y1, Double_t x2, Double_t y2, Double_t x3, Double_t y3, Double_t x4, Double_t y4)
Check if segments (A,B) and (C,D) are crossing, where: A(x1,y1), B(x2,y2), C(x3,y3), D(x4,y4)
Definition: TGeoShape.cxx:336
virtual const char * GetName() const
Get the shape name.
Definition: TGeoShape.cxx:248
TGeoShape()
Default constructor.
Definition: TGeoShape.cxx:165
virtual Bool_t CouldBeCrossed(const Double_t *point, const Double_t *dir) const =0
Int_t ShapeDistancetoPrimitive(Int_t numpoints, Int_t px, Int_t py) const
Returns distance to shape primitive mesh.
Definition: TGeoShape.cxx:259
virtual void AfterStreamer()
Definition: TGeoShape.h:94
Base abstract class for all shapes.
Definition: TGeoShape.h:25
ROOT::R::TRInterface & r
Definition: Object.C:4
auto * a
Definition: textangle.C:12
virtual Double_t Safety(const Double_t *point, Bool_t in=kTRUE) const =0
virtual Bool_t IsComposite() const
Definition: TGeoShape.h:130
virtual const TBuffer3D & GetBuffer3D(Int_t reqSections, Bool_t localFrame) const
Stub implementation to avoid forcing implementation at this stage.
Definition: TGeoShape.cxx:689
void ResetShapeBit(UInt_t f)
Definition: TGeoShape.h:162
virtual Int_t GetNmeshVertices() const
Definition: TGeoShape.h:127
static Double_t DistToPhiMin(const Double_t *point, const Double_t *dir, Double_t s1, Double_t c1, Double_t s2, Double_t c2, Double_t sm, Double_t cm, Bool_t in=kTRUE)
compute distance from point (inside phi) to both phi planes. Return minimum.
Definition: TGeoShape.cxx:405
unsigned int UInt_t
Definition: RtypesCore.h:42
void TransformPoints(Double_t *points, UInt_t NbPoints) const
Tranform a set of points (LocalToMaster)
Definition: TGeoShape.cxx:552
virtual void Contains_v(const Double_t *, Bool_t *, Int_t) const
Definition: TGeoShape.h:101
static Bool_t IsInPhiRange(const Double_t *point, Double_t phi1, Double_t phi2)
Static method to check if a point is in the phi range (phi1, phi2) [degrees].
Definition: TGeoShape.cxx:283
Generic 3D primitive description class.
Definition: TBuffer3D.h:17
#define s1(x)
Definition: RSha256.hxx:91
virtual Double_t DistFromOutside(const Double_t *point, const Double_t *dir, Int_t iact=1, Double_t step=TGeoShape::Big(), Double_t *safe=0) const =0
virtual const char * GetAxisName(Int_t iaxis) const =0
virtual void ClearThreadData() const
Definition: TGeoShape.h:67
const Bool_t kFALSE
Definition: RtypesCore.h:88
virtual Double_t DistFromInside(const Double_t *point, const Double_t *dir, Int_t iact=1, Double_t step=TGeoShape::Big(), Double_t *safe=0) const =0
static Bool_t IsCloseToPhi(Double_t epsil, const Double_t *point, Double_t c1, Double_t s1, Double_t c2, Double_t s2)
True if point is closer than epsil to one of the phi planes defined by c1,s1 or c2,s2.
Definition: TGeoShape.cxx:269
return c2
Definition: legend2.C:14
static const double x1[5]
Int_t fShapeId
Definition: TGeoShape.h:72
double Double_t
Definition: RtypesCore.h:55
virtual void GetMeshNumbers(Int_t &, Int_t &, Int_t &) const
Definition: TGeoShape.h:125
Bool_t TestShapeBit(UInt_t f) const
Definition: TGeoShape.h:163
virtual void DistFromInside_v(const Double_t *, const Double_t *, Double_t *, Int_t, Double_t *) const
Definition: TGeoShape.h:106
Int_t TestShapeBits(UInt_t f) const
Definition: TGeoShape.h:164
virtual TGeoVolume * Divide(TGeoVolume *voldiv, const char *divname, Int_t iaxis, Int_t ndiv, Double_t start, Double_t step)=0
virtual void ComputeBBox()=0
static Double_t Big()
Definition: TGeoShape.h:88
void SetRuntime(Bool_t flag=kTRUE)
Definition: TGeoShape.h:155
virtual Double_t Capacity() const =0
static TGeoMatrix * GetTransform()
Returns current transformation matrix that applies to shape.
Definition: TGeoShape.cxx:536
void SetShapeBit(UInt_t f, Bool_t set)
Equivalent of TObject::SetBit.
Definition: TGeoShape.cxx:524
you should not use this method at all Int_t Int_t z
Definition: TRolke.cxx:630
virtual void InspectShape() const =0
you should not use this method at all Int_t Int_t Double_t Double_t Double_t Int_t Double_t Double_t Double_t Double_t b
Definition: TRolke.cxx:630
virtual Double_t GetAxisRange(Int_t iaxis, Double_t &xlo, Double_t &xhi) const =0
static void NormalPhi(const Double_t *point, const Double_t *dir, Double_t *norm, Double_t c1, Double_t s1, Double_t c2, Double_t s2)
Static method to compute normal to phi planes.
Definition: TGeoShape.cxx:437
void SetShapeBit(UInt_t f)
Definition: TGeoShape.h:161
virtual void Paint(Option_t *option="")
Paint this shape.
Definition: TGeoShape.cxx:734
virtual Int_t GetFittingBox(const TGeoBBox *parambox, TGeoMatrix *mat, Double_t &dx, Double_t &dy, Double_t &dz) const =0
void InvertShapeBit(UInt_t f)
Definition: TGeoShape.h:165
virtual void Draw(Option_t *option="")
Draw this shape.
Definition: TGeoShape.cxx:721
const Bool_t kTRUE
Definition: RtypesCore.h:87
virtual Bool_t IsCylType() const =0
Int_t GetBasicColor() const
Get the basic color (0-7).
Definition: TGeoShape.cxx:673
virtual void Safety_v(const Double_t *, const Bool_t *, Double_t *, Int_t) const
Definition: TGeoShape.h:147
char name[80]
Definition: TGX11.cxx:109
UInt_t fShapeBits
Definition: TGeoShape.h:73
Bool_t IsRunTimeShape() const
Definition: TGeoShape.h:139
static const double x3[11]