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
	BVH_BoxSet ()
	Empty constructor for use the default 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
virtual void	SetSize (const Standard_Size theSize)
	Sets the expected size of BVH tree.

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

BVH construction
void	Build ()
	BVH construction.

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

Necessary overrides for BVH construction
virtual BVH_Box< NumType, Dimension >	Box (const Standard_Integer theIndex) const override
	Returns the bounding box with the given index.

virtual Standard_Real	Center (const Standard_Integer theIndex, const Standard_Integer theAxis) const override
	Returns centroid position along specified axis.

virtual Standard_Integer	Size () const override
	Returns the number of boxes.

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

virtual DataType	Element (const Standard_Integer 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.

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

virtual 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< NumType, N >
	BVH_Object ()
	Creates new abstract geometric object.

virtual	~BVH_Object ()
	Releases resources of geometric object.

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

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

virtual Standard_Boolean	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 ()
	Destructor must be virtual.

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

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

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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

Standard_Boolean	IsKind (const Standard_CString 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.

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

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

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

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

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

Protected Attributes
Fields
std::vector< DataType >	myElements
	Elements.

std::vector< 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
Standard_Boolean	myIsDirty
	Marks internal object state as outdated.

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< NumType, N >
typedef BVH_Box< NumType, 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 Standard_Integer	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 = Standard_Integer>
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 = Standard_Integer>

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

inline

Empty constructor for use the default BVH_Builder.

◆ BVH_BoxSet() [2/2]

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

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 = Standard_Integer>

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

inlinevirtual

Adds the element into BVH.

◆ Box()

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

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

inlineoverridevirtual

Returns the bounding box with the given index.

Implements BVH_Set< NumType, N >.

Reimplemented in BVH_IndexedBoxSet< NumType, Dimension, DataType >.

◆ Build()

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

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

inline

BVH construction.

◆ Center()

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

virtual Standard_Real BVH_BoxSet< NumType, Dimension, DataType >::Center	(	const Standard_Integer	theIndex,
		const Standard_Integer	theAxis ) const

inlineoverridevirtual

Returns centroid position along specified axis.

Implements BVH_Set< NumType, N >.

◆ Clear()

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

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

inlinevirtual

Clears the vectors of elements and boxes.

Reimplemented in BVH_IndexedBoxSet< NumType, Dimension, DataType >.

◆ Element()

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

virtual DataType BVH_BoxSet< NumType, Dimension, DataType >::Element ( const Standard_Integer 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 = Standard_Integer>

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

inlinevirtual

Sets the expected size of BVH tree.

Reimplemented in BVH_IndexedBoxSet< NumType, Dimension, DataType >.

◆ Size()

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

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

inlineoverridevirtual

Returns the number of boxes.

Implements BVH_Set< NumType, N >.

◆ Swap()

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

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

inlineoverridevirtual

Swaps indices of two specified boxes.

Implements BVH_Set< NumType, N >.

Reimplemented in BVH_IndexedBoxSet< NumType, Dimension, DataType >.

Field Documentation

◆ myBoxes

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

std::vector<BVH_Box <NumType, Dimension> > BVH_BoxSet< NumType, Dimension, DataType >::myBoxes

protected

Boxes for the elements.

◆ myElements

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

std::vector<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