Logo ROOT  
Reference Guide
TGeoBoolNode Class Referenceabstract

Base class for Boolean operations between two shapes.

A Boolean node describes a Boolean operation between 'left' and 'right' shapes positioned with respect to an ARBITRARY reference frame. The boolean node is referenced by a mother composite shape and its shape components may be primitive but also composite shapes. The later situation leads to a binary tree hierarchy. When the parent composite shape is used to create a volume, the reference frame of the volume is chosen to match the frame in which node shape components were defined.

The positioned shape components may or may not be disjoint. The specific implementations for Boolean nodes are:

  • TGeoUnion - representing the Boolean union of two positioned shapes
  • TGeoSubtraction - representing the Boolean subtraction of two positioned shapes
  • TGeoIntersection - representing the Boolean intersection of two positioned shapes

Definition at line 25 of file TGeoBoolNode.h.

Classes

struct  ThreadData_t
 

Public Types

enum  EGeoBoolType { kGeoUnion, kGeoIntersection, kGeoSubtraction }
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 

Public Member Functions

 TGeoBoolNode ()
 Default constructor. More...
 
 TGeoBoolNode (const char *expr1, const char *expr2)
 Constructor called by TGeoCompositeShape providing 2 subexpressions for the 2 branches. More...
 
 TGeoBoolNode (TGeoShape *left, TGeoShape *right, TGeoMatrix *lmat=nullptr, TGeoMatrix *rmat=nullptr)
 Constructor providing left and right shapes and matrices (in the Boolean operation). More...
 
virtual ~TGeoBoolNode ()
 Destructor. More...
 
void ClearThreadData () const
 
virtual void ComputeBBox (Double_t &dx, Double_t &dy, Double_t &dz, Double_t *origin)=0
 
virtual void ComputeNormal (const Double_t *point, const Double_t *dir, Double_t *norm)=0
 
virtual Bool_t Contains (const Double_t *point) const =0
 
void CreateThreadData (Int_t nthreads)
 Create thread data for n threads max. More...
 
virtual Int_t DistanceToPrimitive (Int_t px, Int_t py)=0
 
virtual Double_t DistFromInside (const Double_t *point, const Double_t *dir, Int_t iact=1, Double_t step=0, Double_t *safe=nullptr) const =0
 
virtual Double_t DistFromOutside (const Double_t *point, const Double_t *dir, Int_t iact=1, Double_t step=0, Double_t *safe=nullptr) const =0
 
virtual EGeoBoolType GetBooleanOperator () const =0
 
TGeoMatrixGetLeftMatrix () const
 
TGeoShapeGetLeftShape () const
 
virtual Int_t GetNpoints ()=0
 
TGeoMatrixGetRightMatrix () const
 
TGeoShapeGetRightShape () const
 
ThreadData_tGetThreadData () const
 
virtual TGeoBoolNodeMakeClone () const =0
 
void Paint (Option_t *option) override
 Special schema for feeding the 3D buffers to the painter client. More...
 
void RegisterMatrices ()
 Register all matrices of the boolean node and descendents. More...
 
Bool_t ReplaceMatrix (TGeoMatrix *mat, TGeoMatrix *newmat)
 Replace one of the matrices. More...
 
virtual Double_t Safety (const Double_t *point, Bool_t in=kTRUE) const =0
 
void SavePrimitive (std::ostream &out, Option_t *option="") override
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
virtual void SetPoints (Double_t *points) const
 Fill buffer with shape vertices. More...
 
virtual void SetPoints (Float_t *points) const
 Fill buffer with shape vertices. More...
 
void SetSelected (Int_t sel)
 Set the selected branch. More...
 
virtual void Sizeof3D () const
 Register size of this 3D object. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Protected Member Functions

void AssignPoints (Int_t npoints, Double_t *points)
 Set fPoints array. More...
 
Bool_t MakeBranch (const char *expr, Bool_t left)
 Mutex for thread data access. More...
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

Protected Attributes

TGeoShapefLeft {nullptr}
 
TGeoMatrixfLeftMat {nullptr}
 
std::mutex fMutex
 Size for the navigation data array. More...
 
Int_t fNpoints {0}
 
Double_tfPoints {nullptr}
 number of points on the mesh More...
 
TGeoShapefRight {nullptr}
 
TGeoMatrixfRightMat {nullptr}
 
std::vector< ThreadData_t * > fThreadData
 array of mesh points More...
 
Int_t fThreadSize {0}
 Navigation data per thread. More...
 

Private Member Functions

 TGeoBoolNode (const TGeoBoolNode &)=delete
 
TGeoBoolNodeoperator= (const TGeoBoolNode &)=delete
 

Additional Inherited Members

- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <TGeoBoolNode.h>

Inheritance diagram for TGeoBoolNode:
[legend]

Member Enumeration Documentation

◆ EGeoBoolType

Enumerator
kGeoUnion 
kGeoIntersection 
kGeoSubtraction 

Definition at line 28 of file TGeoBoolNode.h.

Constructor & Destructor Documentation

◆ TGeoBoolNode() [1/4]

TGeoBoolNode::TGeoBoolNode ( const TGeoBoolNode )
privatedelete

◆ TGeoBoolNode() [2/4]

TGeoBoolNode::TGeoBoolNode ( )

Default constructor.

Definition at line 133 of file TGeoBoolNode.cxx.

◆ TGeoBoolNode() [3/4]

TGeoBoolNode::TGeoBoolNode ( const char *  expr1,
const char *  expr2 
)

Constructor called by TGeoCompositeShape providing 2 subexpressions for the 2 branches.

Definition at line 148 of file TGeoBoolNode.cxx.

◆ TGeoBoolNode() [4/4]

TGeoBoolNode::TGeoBoolNode ( TGeoShape left,
TGeoShape right,
TGeoMatrix lmat = nullptr,
TGeoMatrix rmat = nullptr 
)

Constructor providing left and right shapes and matrices (in the Boolean operation).

Definition at line 169 of file TGeoBoolNode.cxx.

◆ ~TGeoBoolNode()

TGeoBoolNode::~TGeoBoolNode ( )
virtual

Destructor.

— deletion of components handled by TGeoManager class.

Definition at line 197 of file TGeoBoolNode.cxx.

Member Function Documentation

◆ AssignPoints()

void TGeoBoolNode::AssignPoints ( Int_t  npoints,
Double_t points 
)
protected

Set fPoints array.

Definition at line 206 of file TGeoBoolNode.cxx.

◆ ClearThreadData()

void TGeoBoolNode::ClearThreadData ( ) const

Definition at line 91 of file TGeoBoolNode.cxx.

◆ ComputeBBox()

virtual void TGeoBoolNode::ComputeBBox ( Double_t dx,
Double_t dy,
Double_t dz,
Double_t origin 
)
pure virtual

◆ ComputeNormal()

virtual void TGeoBoolNode::ComputeNormal ( const Double_t point,
const Double_t dir,
Double_t norm 
)
pure virtual

◆ Contains()

virtual Bool_t TGeoBoolNode::Contains ( const Double_t point) const
pure virtual

◆ CreateThreadData()

void TGeoBoolNode::CreateThreadData ( Int_t  nthreads)

Create thread data for n threads max.

Definition at line 107 of file TGeoBoolNode.cxx.

◆ DistanceToPrimitive()

virtual Int_t TGeoBoolNode::DistanceToPrimitive ( Int_t  px,
Int_t  py 
)
pure virtual

◆ DistFromInside()

virtual Double_t TGeoBoolNode::DistFromInside ( const Double_t point,
const Double_t dir,
Int_t  iact = 1,
Double_t  step = 0,
Double_t safe = nullptr 
) const
pure virtual

◆ DistFromOutside()

virtual Double_t TGeoBoolNode::DistFromOutside ( const Double_t point,
const Double_t dir,
Int_t  iact = 1,
Double_t  step = 0,
Double_t safe = nullptr 
) const
pure virtual

◆ GetBooleanOperator()

virtual EGeoBoolType TGeoBoolNode::GetBooleanOperator ( ) const
pure virtual

◆ GetLeftMatrix()

TGeoMatrix* TGeoBoolNode::GetLeftMatrix ( ) const
inline

Definition at line 81 of file TGeoBoolNode.h.

◆ GetLeftShape()

TGeoShape* TGeoBoolNode::GetLeftShape ( ) const
inline

Definition at line 83 of file TGeoBoolNode.h.

◆ GetNpoints()

virtual Int_t TGeoBoolNode::GetNpoints ( )
pure virtual

◆ GetRightMatrix()

TGeoMatrix* TGeoBoolNode::GetRightMatrix ( ) const
inline

Definition at line 82 of file TGeoBoolNode.h.

◆ GetRightShape()

TGeoShape* TGeoBoolNode::GetRightShape ( ) const
inline

Definition at line 84 of file TGeoBoolNode.h.

◆ GetThreadData()

TGeoBoolNode::ThreadData_t & TGeoBoolNode::GetThreadData ( ) const

Definition at line 66 of file TGeoBoolNode.cxx.

◆ MakeBranch()

Bool_t TGeoBoolNode::MakeBranch ( const char *  expr,
Bool_t  left 
)
protected

Mutex for thread data access.

Expands the boolean expression either on left or right branch, creating component elements (composite shapes and boolean nodes).

Returns true on success.

Definition at line 224 of file TGeoBoolNode.cxx.

◆ MakeClone()

virtual TGeoBoolNode* TGeoBoolNode::MakeClone ( ) const
pure virtual

◆ operator=()

TGeoBoolNode& TGeoBoolNode::operator= ( const TGeoBoolNode )
privatedelete

◆ Paint()

void TGeoBoolNode::Paint ( Option_t option)
overridevirtual

Special schema for feeding the 3D buffers to the painter client.

Reimplemented from TObject.

Reimplemented in TGeoSubtraction, TGeoIntersection, and TGeoUnion.

Definition at line 294 of file TGeoBoolNode.cxx.

◆ RegisterMatrices()

void TGeoBoolNode::RegisterMatrices ( )

Register all matrices of the boolean node and descendents.

Definition at line 337 of file TGeoBoolNode.cxx.

◆ ReplaceMatrix()

Bool_t TGeoBoolNode::ReplaceMatrix ( TGeoMatrix mat,
TGeoMatrix newmat 
)

Replace one of the matrices.

Does not work with TGeoIdentity. Returns true if replacement was successful.

Definition at line 349 of file TGeoBoolNode.cxx.

◆ Safety()

virtual Double_t TGeoBoolNode::Safety ( const Double_t point,
Bool_t  in = kTRUE 
) const
pure virtual

◆ SavePrimitive()

void TGeoBoolNode::SavePrimitive ( std::ostream &  out,
Option_t option = "" 
)
overridevirtual

Save a primitive as a C++ statement(s) on output stream "out".

Reimplemented from TObject.

Reimplemented in TGeoSubtraction, TGeoIntersection, and TGeoUnion.

Definition at line 374 of file TGeoBoolNode.cxx.

◆ SetPoints() [1/2]

void TGeoBoolNode::SetPoints ( Double_t points) const
virtual

Fill buffer with shape vertices.

Definition at line 391 of file TGeoBoolNode.cxx.

◆ SetPoints() [2/2]

void TGeoBoolNode::SetPoints ( Float_t points) const
virtual

Fill buffer with shape vertices.

Definition at line 401 of file TGeoBoolNode.cxx.

◆ SetSelected()

void TGeoBoolNode::SetSelected ( Int_t  sel)

Set the selected branch.

Definition at line 125 of file TGeoBoolNode.cxx.

◆ Sizeof3D()

void TGeoBoolNode::Sizeof3D ( ) const
virtual

Register size of this 3D object.

Reimplemented in TGeoSubtraction, TGeoIntersection, and TGeoUnion.

Definition at line 411 of file TGeoBoolNode.cxx.

Member Data Documentation

◆ fLeft

TGeoShape* TGeoBoolNode::fLeft {nullptr}
protected

Definition at line 48 of file TGeoBoolNode.h.

◆ fLeftMat

TGeoMatrix* TGeoBoolNode::fLeftMat {nullptr}
protected

Definition at line 50 of file TGeoBoolNode.h.

◆ fMutex

std::mutex TGeoBoolNode::fMutex
mutableprotected

Size for the navigation data array.

Definition at line 57 of file TGeoBoolNode.h.

◆ fNpoints

Int_t TGeoBoolNode::fNpoints {0}
protected

Definition at line 52 of file TGeoBoolNode.h.

◆ fPoints

Double_t* TGeoBoolNode::fPoints {nullptr}
protected

number of points on the mesh

Definition at line 53 of file TGeoBoolNode.h.

◆ fRight

TGeoShape* TGeoBoolNode::fRight {nullptr}
protected

Definition at line 49 of file TGeoBoolNode.h.

◆ fRightMat

TGeoMatrix* TGeoBoolNode::fRightMat {nullptr}
protected

Definition at line 51 of file TGeoBoolNode.h.

◆ fThreadData

std::vector<ThreadData_t*> TGeoBoolNode::fThreadData
mutableprotected

array of mesh points

Definition at line 55 of file TGeoBoolNode.h.

◆ fThreadSize

Int_t TGeoBoolNode::fThreadSize {0}
mutableprotected

Navigation data per thread.

Definition at line 56 of file TGeoBoolNode.h.

Libraries for TGeoBoolNode:
[legend]

The documentation for this class was generated from the following files: