This class is used to store all calculated sensitive entities of one selectable object. It provides an interface for building BVH tree which is used to speed-up the performance of searching for overlap among sensitives of one selectable object. More...

#include <SelectMgr_SensitiveEntitySet.hxx>

Inheritance diagram for SelectMgr_SensitiveEntitySet:

[legend]

Public Member Functions
	SelectMgr_SensitiveEntitySet (const occ::handle< Select3D_BVHBuilder3d > &theBuilder)
	Empty constructor.

	~SelectMgr_SensitiveEntitySet () override=default

void	Append (const occ::handle< SelectMgr_SensitiveEntity > &theEntity)
	Adds new entity to the set and marks BVH tree for rebuild.

void	Append (const occ::handle< SelectMgr_Selection > &theSelection)
	Adds every entity of selection theSelection to the set and marks BVH tree for rebuild.

void	Remove (const occ::handle< SelectMgr_Selection > &theSelection)
	Removes every entity of selection theSelection from the set and marks BVH tree for rebuild.

Select3D_BndBox3d	Box (const int theIndex) const override
	Returns bounding box of entity with index theIdx.

double	Center (const int theIndex, const int theAxis) const override
	Returns geometry center of sensitive entity index theIdx along the given axis theAxis.

void	Swap (const int theIndex1, const int theIndex2) override
	Swaps items with indexes theIdx1 and theIdx2.

int	Size () const override
	Returns the amount of entities.

const occ::handle< SelectMgr_SensitiveEntity > &	GetSensitiveById (const int theIndex) const
	Returns the entity with index theIndex in the set.

const NCollection_IndexedMap< occ::handle< SelectMgr_SensitiveEntity > > &	Sensitives () const
	Returns map of entities.

const NCollection_DataMap< occ::handle< SelectMgr_EntityOwner >, int > &	Owners () const
	Returns map of owners.

bool	HasEntityWithPersistence () const
	Returns map of entities.

bool	HasEntityWithFlipping () const
	Returns true if this set contains sensitive entities with flipping options.

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

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

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

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

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

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

virtual void	SetBuilder (const opencascade::handle< BVH_Builder< double, 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 Member Functions
void	addOwner (const occ::handle< SelectMgr_EntityOwner > &theOwner)
	Adds entity owner to the map of owners (or increases its counter if it is already there).

void	removeOwner (const occ::handle< SelectMgr_EntityOwner > &theOwner)
	Decreases counter of owner in the map of owners (or removes it from the map if counter == 0).

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

Protected Member Functions inherited from BVH_ObjectTransient
	BVH_ObjectTransient ()
	Creates new abstract geometric 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< double, 3 >
static const int	MaxTreeDepth

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

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

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

Detailed Description

This class is used to store all calculated sensitive entities of one selectable object. It provides an interface for building BVH tree which is used to speed-up the performance of searching for overlap among sensitives of one selectable object.

Constructor & Destructor Documentation

◆ SelectMgr_SensitiveEntitySet()

SelectMgr_SensitiveEntitySet::SelectMgr_SensitiveEntitySet ( const occ::handle< Select3D_BVHBuilder3d > & theBuilder )

Empty constructor.

◆ ~SelectMgr_SensitiveEntitySet()

SelectMgr_SensitiveEntitySet::~SelectMgr_SensitiveEntitySet ( )

overridedefault

Member Function Documentation

◆ addOwner()

void SelectMgr_SensitiveEntitySet::addOwner ( const occ::handle< SelectMgr_EntityOwner > & theOwner )

protected

Adds entity owner to the map of owners (or increases its counter if it is already there).

◆ Append() [1/2]

void SelectMgr_SensitiveEntitySet::Append ( const occ::handle< SelectMgr_Selection > & theSelection )

Adds every entity of selection theSelection to the set and marks BVH tree for rebuild.

◆ Append() [2/2]

void SelectMgr_SensitiveEntitySet::Append ( const occ::handle< SelectMgr_SensitiveEntity > & theEntity )

Adds new entity to the set and marks BVH tree for rebuild.

◆ Box()

Select3D_BndBox3d SelectMgr_SensitiveEntitySet::Box ( const int theIndex ) const

overridevirtual

Returns bounding box of entity with index theIdx.

Implements BVH_Set< T, N >.

◆ Center()

double SelectMgr_SensitiveEntitySet::Center	(	const int	theIndex,
		const int	theAxis ) const

overridevirtual

Returns geometry center of sensitive entity index theIdx along the given axis theAxis.

Implements BVH_Set< T, N >.

◆ GetSensitiveById()

const occ::handle< SelectMgr_SensitiveEntity > & SelectMgr_SensitiveEntitySet::GetSensitiveById ( const int theIndex ) const

Returns the entity with index theIndex in the set.

◆ HasEntityWithFlipping()

bool SelectMgr_SensitiveEntitySet::HasEntityWithFlipping ( ) const

inline

Returns true if this set contains sensitive entities with flipping options.

◆ HasEntityWithPersistence()

bool SelectMgr_SensitiveEntitySet::HasEntityWithPersistence ( ) const

inline

Returns map of entities.

◆ Owners()

const NCollection_DataMap< occ::handle< SelectMgr_EntityOwner >, int > & SelectMgr_SensitiveEntitySet::Owners ( ) const

inline

Returns map of owners.

◆ Remove()

void SelectMgr_SensitiveEntitySet::Remove ( const occ::handle< SelectMgr_Selection > & theSelection )

Removes every entity of selection theSelection from the set and marks BVH tree for rebuild.

◆ removeOwner()

void SelectMgr_SensitiveEntitySet::removeOwner ( const occ::handle< SelectMgr_EntityOwner > & theOwner )

protected

Decreases counter of owner in the map of owners (or removes it from the map if counter == 0).

◆ Sensitives()

const NCollection_IndexedMap< occ::handle< SelectMgr_SensitiveEntity > > & SelectMgr_SensitiveEntitySet::Sensitives ( ) const

inline

Returns map of entities.

◆ Size()

int SelectMgr_SensitiveEntitySet::Size ( ) const

overridevirtual

Returns the amount of entities.

Implements BVH_Set< T, N >.

◆ Swap()

void SelectMgr_SensitiveEntitySet::Swap	(	const int	theIndex1,
		const int	theIndex2 )

overridevirtual

Swaps items with indexes theIdx1 and theIdx2.

Implements BVH_Set< T, N >.

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

SelectMgr_SensitiveEntitySet.hxx

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SelectMgr_SensitiveEntitySet()

◆ ~SelectMgr_SensitiveEntitySet()

Member Function Documentation

◆ addOwner()

◆ Append() [1/2]

◆ Append() [2/2]

◆ Box()

◆ Center()

◆ GetSensitiveById()

◆ HasEntityWithFlipping()

◆ HasEntityWithPersistence()

◆ Owners()

◆ Remove()

◆ removeOwner()

◆ Sensitives()

◆ Size()

◆ Swap()