Implements easy to use interfaces for adding the elements into BVH tree and its following construction. To make it more effective it is better to set the number of elements that are going to be added into BVH tree. For better efficiency on heavy data types it is recommended to use either BHV_IndexedBoxSet which uses indirect indexing for accessing the elements and their boxes or set the element to be an index of the real element in the application's internal data structures. More...

#include <BVH_BoxSet.hxx>

Inheritance diagram for BVH_BoxSet< NumType, Dimension, DataType >:

[legend]

Public Member Functions
Constructors
Empty constructor for use the default BVH_Builder
	BVH_BoxSet ()
	Constructor for usage the custom BVH builder.

	BVH_BoxSet (const opencascade::handle< BVH_Builder< NumType, Dimension > > &theBuilder)
	Constructor for usage the custom BVH builder.

Setting expected size of the BVH
Sets the expected size of BVH tree
virtual void	SetSize (const size_t theSize)

Adding elements in BVH
Adds the element into BVH
virtual void	Add (const DataType &theElement, const BVH_Box< NumType, Dimension > &theBox)

BVH construction
BVH construction
void	Build ()

Clearing the elements and boxes
Clears the vectors of elements and boxes
virtual void	Clear ()

Necessary overrides for BVH construction
Make inherited method Box() visible to avoid CLang warning
BVH_Box< NumType, Dimension >	Box (const int theIndex) const override
	Returns the bounding box with the given index.

double	Center (const int theIndex, const int theAxis) const override
	Returns centroid position along specified axis.

int	Size () const override
	Returns the number of boxes.

void	Swap (const int theIndex1, const int theIndex2) override
	Swaps indices of two specified boxes.

virtual DataType	Element (const int theIndex) const
	Returns the Element with the index theIndex.

Public Member Functions inherited from BVH_PrimitiveSet< NumType, Dimension >
	BVH_PrimitiveSet ()
	Creates set of abstract primitives.

	BVH_PrimitiveSet (const opencascade::handle< BVH_Builder< NumType, N > > &theBuilder)
	Creates set of abstract primitives.

	~BVH_PrimitiveSet () override
	Releases resources of set of abstract primitives.

BVH_Box< NumType, N >	Box () const override
	Returns AABB of primitive set.

virtual const opencascade::handle< BVH_Tree< NumType, N > > &	BVH ()
	Returns BVH tree (and builds it if necessary).

virtual const opencascade::handle< BVH_Builder< NumType, N > > &	Builder () const
	Returns the method (builder) used to construct BVH.

virtual void	SetBuilder (const opencascade::handle< BVH_Builder< NumType, N > > &theBuilder)
	Sets the method (builder) used to construct BVH.

Public Member Functions inherited from BVH_Object< T, N >
	BVH_Object ()=default
	Creates new abstract geometric object.

	~BVH_Object () override=default
	Releases resources of geometric object.

Public Member Functions inherited from BVH_ObjectTransient
virtual const occ::handle< BVH_Properties > &	Properties () const
	Returns properties of the geometric object.

virtual void	SetProperties (const occ::handle< BVH_Properties > &theProperties)
	Sets properties of the geometric object.

virtual bool	IsDirty () const
	Returns TRUE if object state should be updated.

virtual void	MarkDirty ()
	Marks object state as outdated (needs BVH rebuilding).

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

bool	IsKind (const char *const theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

Public Member Functions inherited from BVH_Set< T, N >
	BVH_Set ()=default
	Creates new abstract set of objects.

virtual	~BVH_Set ()=default
	Releases resources of set of objects.

Protected Attributes
Fields
NCollection_LinearVector< DataType >	myElements
	Elements.

NCollection_LinearVector< BVH_Box< NumType, Dimension > >	myBoxes
	Boxes for the elements.

Protected Attributes inherited from BVH_PrimitiveSet< NumType, Dimension >
opencascade::handle< BVH_Tree< NumType, N > >	myBVH
	Constructed bottom-level BVH.

opencascade::handle< BVH_Builder< NumType, N > >	myBuilder
	Builder for bottom-level BVH.

BVH_Box< NumType, N >	myBox
	Cached bounding box of geometric primitives.

Protected Attributes inherited from BVH_ObjectTransient
bool	myIsDirty
	Marks internal object state as outdated.

occ::handle< BVH_Properties >	myProperties
	Generic properties assigned to the object.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Public Types inherited from BVH_Set< T, N >
typedef BVH_Box< T, N >	BVH_BoxNt

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Static Public Attributes inherited from BVH_PrimitiveSet< NumType, Dimension >
static const int	MaxTreeDepth

Protected Member Functions inherited from BVH_PrimitiveSet< NumType, Dimension >
virtual void	Update ()
	Updates BVH of primitive set.

Protected Member Functions inherited from BVH_ObjectTransient
	BVH_ObjectTransient ()
	Creates new abstract geometric object.

Detailed Description

template<class NumType, int Dimension, class DataType = int>
class BVH_BoxSet< NumType, Dimension, DataType >

Implements easy to use interfaces for adding the elements into BVH tree and its following construction. To make it more effective it is better to set the number of elements that are going to be added into BVH tree. For better efficiency on heavy data types it is recommended to use either BHV_IndexedBoxSet which uses indirect indexing for accessing the elements and their boxes or set the element to be an index of the real element in the application's internal data structures.

Template Parameters

NumType	Numeric data type
Dimension	Vector dimension
DataType	Type of elements on which the boxes are built

Constructor & Destructor Documentation

◆ BVH_BoxSet() [1/2]

template<class NumType , int Dimension, class DataType = int>

BVH_BoxSet< NumType, Dimension, DataType >::BVH_BoxSet ( )

inline

Constructor for usage the custom BVH builder.

◆ BVH_BoxSet() [2/2]

template<class NumType , int Dimension, class DataType = int>

BVH_BoxSet< NumType, Dimension, DataType >::BVH_BoxSet ( const opencascade::handle< BVH_Builder< NumType, Dimension > > & theBuilder )

inline

Constructor for usage the custom BVH builder.

Member Function Documentation

◆ Add()

template<class NumType , int Dimension, class DataType = int>

virtual void BVH_BoxSet< NumType, Dimension, DataType >::Add	(	const DataType &	theElement,
		const BVH_Box< NumType, Dimension > &	theBox )

inlinevirtual

Reimplemented in BVH_IndexedBoxSet< NumType, Dimension, DataType >.

◆ Box()

template<class NumType , int Dimension, class DataType = int>

BVH_Box< NumType, Dimension > BVH_BoxSet< NumType, Dimension, DataType >::Box ( const int theIndex ) const

inlineoverridevirtual

Returns the bounding box with the given index.

Implements BVH_Set< T, N >.

Reimplemented in BVH_IndexedBoxSet< NumType, Dimension, DataType >.

◆ Build()

template<class NumType , int Dimension, class DataType = int>

void BVH_BoxSet< NumType, Dimension, DataType >::Build ( )

inline

◆ Center()

template<class NumType , int Dimension, class DataType = int>

double BVH_BoxSet< NumType, Dimension, DataType >::Center	(	const int	theIndex,
		const int	theAxis ) const

inlineoverridevirtual

Returns centroid position along specified axis.

Implements BVH_Set< T, N >.

◆ Clear()

template<class NumType , int Dimension, class DataType = int>

virtual void BVH_BoxSet< NumType, Dimension, DataType >::Clear ( )

inlinevirtual

Reimplemented in BVH_IndexedBoxSet< NumType, Dimension, DataType >.

◆ Element()

template<class NumType , int Dimension, class DataType = int>

virtual DataType BVH_BoxSet< NumType, Dimension, DataType >::Element ( const int theIndex ) const

inlinevirtual

Returns the Element with the index theIndex.

Reimplemented in BVH_IndexedBoxSet< NumType, Dimension, DataType >.

◆ SetSize()

template<class NumType , int Dimension, class DataType = int>

virtual void BVH_BoxSet< NumType, Dimension, DataType >::SetSize ( const size_t theSize )

inlinevirtual

Reimplemented in BVH_IndexedBoxSet< NumType, Dimension, DataType >.

◆ Size()

template<class NumType , int Dimension, class DataType = int>

int BVH_BoxSet< NumType, Dimension, DataType >::Size ( ) const

inlineoverridevirtual

Returns the number of boxes.

Implements BVH_Set< T, N >.

◆ Swap()

template<class NumType , int Dimension, class DataType = int>

void BVH_BoxSet< NumType, Dimension, DataType >::Swap	(	const int	theIndex1,
		const int	theIndex2 )

inlineoverridevirtual

Swaps indices of two specified boxes.

Implements BVH_Set< T, N >.

Reimplemented in BVH_IndexedBoxSet< NumType, Dimension, DataType >.

Field Documentation

◆ myBoxes

template<class NumType , int Dimension, class DataType = int>

NCollection_LinearVector<BVH_Box<NumType, Dimension> > BVH_BoxSet< NumType, Dimension, DataType >::myBoxes

protected

Boxes for the elements.

◆ myElements

template<class NumType , int Dimension, class DataType = int>

NCollection_LinearVector<DataType> BVH_BoxSet< NumType, Dimension, DataType >::myElements

protected

Elements.

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

BVH_BoxSet.hxx

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BVH_BoxSet() [1/2]

◆ BVH_BoxSet() [2/2]

Member Function Documentation

◆ Add()

◆ Box()

◆ Build()

◆ Center()

◆ Clear()

◆ Element()

◆ SetSize()

◆ Size()

◆ Swap()

Field Documentation

◆ myBoxes

◆ myElements