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.

	TGeoBoolNode (const char expr1, const char expr2)
	Constructor called by TGeoCompositeShape providing 2 subexpressions for the 2 branches.

	TGeoBoolNode (TGeoShape left, TGeoShape right, TGeoMatrix lmat=nullptr, TGeoMatrix rmat=nullptr)
	Constructor providing left and right shapes and matrices (in the Boolean operation).

virtual	~TGeoBoolNode ()
	Destructor.

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.

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

TGeoMatrix *	GetLeftMatrix () const

TGeoShape *	GetLeftShape () const

virtual Int_t	GetNpoints ()=0

TGeoMatrix *	GetRightMatrix () const

TGeoShape *	GetRightShape () const

ThreadData_t &	GetThreadData () const

virtual TGeoBoolNode *	MakeClone () const =0

void	Paint (Option_t *option) override
	Special schema for feeding the 3D buffers to the painter client.

void	RegisterMatrices ()
	Register all matrices of the boolean node and descendents.

Bool_t	ReplaceMatrix (TGeoMatrix mat, TGeoMatrix newmat)
	Replace one of the matrices.

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".

virtual void	SetPoints (Double_t *points) const
	Fill buffer with shape vertices.

virtual void	SetPoints (Float_t *points) const
	Fill buffer with shape vertices.

void	SetSelected (Int_t sel)
	Set the selected branch.

virtual void	Sizeof3D () const
	Register size of this 3D object.

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

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.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad for instance with: `gROOT->SetSelectedPad(gPad)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

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.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual const char *	GetName () const
	Returns name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	Return hash value for this object.

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.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

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.

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).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

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.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Protected Member Functions
void	AssignPoints (Int_t npoints, Double_t *points)
	Set fPoints array.

Bool_t	MakeBranch (const char *expr, Bool_t left)
	Mutex for thread data access.

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).

void	MakeZombie ()

Protected Attributes
TGeoShape *	fLeft {nullptr}

TGeoMatrix *	fLeftMat {nullptr}

std::mutex	fMutex
	Size for the navigation data array.

Int_t	fNpoints {0}

Double_t *	fPoints {nullptr}
	number of points on the mesh

TGeoShape *	fRight {nullptr}

TGeoMatrix *	fRightMat {nullptr}

std::vector< ThreadData_t * >	fThreadData
	array of mesh points

Int_t	fThreadSize {0}
	Navigation data per thread.

Private Member Functions
	TGeoBoolNode (const TGeoBoolNode &)=delete

TGeoBoolNode &	operator= (const TGeoBoolNode &)=delete

Additional Inherited Members
Static Public Member Functions inherited from TObject
static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

#include <TGeoBoolNode.h>

Inheritance diagram for TGeoBoolNode:

[legend]

Member Enumeration Documentation

◆ EGeoBoolType

enum TGeoBoolNode::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

Implemented in TGeoUnion, TGeoIntersection, and TGeoSubtraction.

◆ ComputeNormal()

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

pure virtual

Implemented in TGeoUnion, TGeoIntersection, and TGeoSubtraction.

◆ Contains()

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

pure virtual

Implemented in TGeoUnion, TGeoIntersection, and TGeoSubtraction.

◆ 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

Implemented in TGeoUnion, TGeoIntersection, and TGeoSubtraction.

◆ 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

Implemented in TGeoUnion, TGeoIntersection, and TGeoSubtraction.

◆ 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

Implemented in TGeoUnion, TGeoIntersection, and TGeoSubtraction.

◆ GetBooleanOperator()

virtual EGeoBoolType TGeoBoolNode::GetBooleanOperator ( ) const

pure virtual

Implemented in TGeoUnion, TGeoIntersection, and TGeoSubtraction.

◆ 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

Implemented in TGeoUnion, TGeoIntersection, and TGeoSubtraction.

◆ 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

Implemented in TGeoUnion, TGeoIntersection, and TGeoSubtraction.

◆ 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 TGeoUnion, TGeoIntersection, and TGeoSubtraction.

Definition at line 294 of file TGeoBoolNode.cxx.

◆ RegisterMatrices()

void TGeoBoolNode::RegisterMatrices ( )

Register all matrices of the boolean node and descendents.

Definition at line 339 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 351 of file TGeoBoolNode.cxx.

◆ Safety()

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

pure virtual

Implemented in TGeoUnion, TGeoIntersection, and TGeoSubtraction.

◆ 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 TGeoUnion, TGeoIntersection, and TGeoSubtraction.

Definition at line 376 of file TGeoBoolNode.cxx.

◆ SetPoints() [1/2]

void TGeoBoolNode::SetPoints ( Double_t * points ) const

virtual

Fill buffer with shape vertices.

Definition at line 393 of file TGeoBoolNode.cxx.

◆ SetPoints() [2/2]

void TGeoBoolNode::SetPoints ( Float_t * points ) const

virtual

Fill buffer with shape vertices.

Definition at line 403 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 TGeoUnion, TGeoIntersection, and TGeoSubtraction.

Definition at line 413 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:

geom/geom/inc/TGeoBoolNode.h
geom/geom/src/TGeoBoolNode.cxx

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ EGeoBoolType

Constructor & Destructor Documentation

◆ TGeoBoolNode() [1/4]

◆ TGeoBoolNode() [2/4]

◆ TGeoBoolNode() [3/4]

◆ TGeoBoolNode() [4/4]

◆ ~TGeoBoolNode()

Member Function Documentation

◆ AssignPoints()

◆ ClearThreadData()

◆ ComputeBBox()

◆ ComputeNormal()

◆ Contains()

◆ CreateThreadData()

◆ DistanceToPrimitive()

◆ DistFromInside()

◆ DistFromOutside()

◆ GetBooleanOperator()

◆ GetLeftMatrix()

◆ GetLeftShape()

◆ GetNpoints()

◆ GetRightMatrix()

◆ GetRightShape()

◆ GetThreadData()

◆ MakeBranch()

◆ MakeClone()

◆ operator=()

◆ Paint()

◆ RegisterMatrices()

◆ ReplaceMatrix()

◆ Safety()

◆ SavePrimitive()

◆ SetPoints() [1/2]

◆ SetPoints() [2/2]

◆ SetSelected()

◆ Sizeof3D()

Member Data Documentation

◆ fLeft

◆ fLeftMat

◆ fMutex

◆ fNpoints

◆ fPoints

◆ fRight

◆ fRightMat

◆ fThreadData

◆ fThreadSize