Set of abstract geometric primitives organized with bounding volume hierarchy (BVH). Unlike an object set, this collection is designed for storing structural elements of a single object (such as triangles in the object triangulation). Because there may be a large number of such elements, the implementations of this interface should be sufficiently optimized. More...

#include <BVH_PrimitiveSet.hxx>

Inheritance diagram for BVH_PrimitiveSet< T, N >:

[legend]

Public Member Functions
	BVH_PrimitiveSet ()
	Creates set of abstract primitives.

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

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

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

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

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

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

Public Member Functions inherited from BVH_Object< T, 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< T, N >
	BVH_Set ()
	Creates new abstract set of objects.

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

virtual Standard_Integer	Size () const =0
	Returns total number of objects.

virtual BVH_Box< T, N >	Box (const Standard_Integer theIndex) const =0
	Returns AABB of the given object.

virtual T	Center (const Standard_Integer theIndex, const Standard_Integer theAxis) const =0
	Returns centroid position along the given axis.

virtual void	Swap (const Standard_Integer theIndex1, const Standard_Integer theIndex2)=0
	Performs transposing the two given objects in the set.

Static Public Attributes
static const Standard_Integer	MaxTreeDepth = BVH_Constants_MaxTreeDepth

Protected Member Functions
virtual void	Update ()
	Updates BVH of primitive set.

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

Protected Attributes
opencascade::handle< BVH_Tree< T, N > >	myBVH
	Constructed bottom-level BVH.

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

BVH_Box< T, 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
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 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.

Detailed Description

template<class T, int N>
class BVH_PrimitiveSet< T, N >

Set of abstract geometric primitives organized with bounding volume hierarchy (BVH). Unlike an object set, this collection is designed for storing structural elements of a single object (such as triangles in the object triangulation). Because there may be a large number of such elements, the implementations of this interface should be sufficiently optimized.

Template Parameters

T	Numeric data type
N	Vector dimension

Constructor & Destructor Documentation

◆ BVH_PrimitiveSet() [1/2]

template<class T, int N>

BVH_PrimitiveSet< T, N >::BVH_PrimitiveSet ( )

inline

Creates set of abstract primitives.

◆ BVH_PrimitiveSet() [2/2]

template<class T, int N>

BVH_PrimitiveSet< T, N >::BVH_PrimitiveSet ( const opencascade::handle< BVH_Builder< T, N > > & theBuilder )

inline

Creates set of abstract primitives.

◆ ~BVH_PrimitiveSet()

template<class T, int N>

virtual BVH_PrimitiveSet< T, N >::~BVH_PrimitiveSet ( )

inlinevirtual

Releases resources of set of abstract primitives.

Member Function Documentation

◆ Box()

template<class T, int N>

virtual BVH_Box< T, N > BVH_PrimitiveSet< T, N >::Box ( ) const

inlineoverridevirtual

Returns AABB of primitive set.

Implements BVH_Object< T, N >.

Reimplemented in BRepExtrema_TriangleSet, Graphic3d_BvhCStructureSet, OpenGl_TriangleSet, Select3D_SensitiveSet::BvhPrimitiveSet, and SelectMgr_SensitiveEntitySet.

◆ Builder()

template<class T, int N>

virtual const opencascade::handle< BVH_Builder< T, N > > & BVH_PrimitiveSet< T, N >::Builder ( ) const

inlinevirtual

Returns the method (builder) used to construct BVH.

◆ BVH()

template<class T, int N>

virtual const opencascade::handle< BVH_Tree< T, N > > & BVH_PrimitiveSet< T, N >::BVH ( )

inlinevirtual

Returns BVH tree (and builds it if necessary).

◆ SetBuilder()

template<class T, int N>

virtual void BVH_PrimitiveSet< T, N >::SetBuilder ( const opencascade::handle< BVH_Builder< T, N > > & theBuilder )

inlinevirtual

Sets the method (builder) used to construct BVH.

◆ Update()

template<class T, int N>

virtual void BVH_PrimitiveSet< T, N >::Update ( )

inlineprotectedvirtual

Updates BVH of primitive set.

Field Documentation

◆ MaxTreeDepth

template<class T, int N>

const Standard_Integer BVH_PrimitiveSet< T, N >::MaxTreeDepth = BVH_Constants_MaxTreeDepth

static

◆ myBox

template<class T, int N>

BVH_Box<T, N> BVH_PrimitiveSet< T, N >::myBox

mutableprotected

Cached bounding box of geometric primitives.

◆ myBuilder

template<class T, int N>

opencascade::handle<BVH_Builder<T, N> > BVH_PrimitiveSet< T, N >::myBuilder

protected

Builder for bottom-level BVH.

◆ myBVH

template<class T, int N>

opencascade::handle<BVH_Tree<T, N> > BVH_PrimitiveSet< T, N >::myBVH

protected

Constructed bottom-level BVH.

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

BVH_PrimitiveSet.hxx

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BVH_PrimitiveSet() [1/2]

◆ BVH_PrimitiveSet() [2/2]

◆ ~BVH_PrimitiveSet()

Member Function Documentation

◆ Box()

◆ Builder()

◆ BVH()

◆ SetBuilder()

◆ Update()

Field Documentation

◆ MaxTreeDepth

◆ myBox

◆ myBuilder

◆ myBVH