This class is base class for handling overlap detection of complex sensitive entities. It provides an interface for building BVH tree for some set of entities. Thereby, each iteration of overlap detection is a traverse of BVH tree in fact. To use speed-up hierarchical structure in a custom complex sensitive entity, it is necessary to make that custom entity a descendant of this class and organize sub-entities in some container which allows referencing to elements by index. Note that methods taking index as a parameter are used for BVH build and the range of given index is [0; Size() - 1]. For example of usage see Select3D_SensitiveTriangulation. More...

#include <Select3D_SensitiveSet.hxx>

Inheritance diagram for Select3D_SensitiveSet:

[legend]

Data Structures
class	BvhPrimitiveSet
	The purpose of this class is to provide a link between BVH_PrimitiveSet and Select3D_SensitiveSet instance to build BVH tree for set of sensitives. More...

Public Member Functions
	Select3D_SensitiveSet (const occ::handle< SelectMgr_EntityOwner > &theOwnerId)
	Creates new empty sensitive set and its content.

virtual int	Size () const =0
	Returns the amount of sub-entities of the complex entity.

virtual Select3D_BndBox3d	Box (const int theIdx) const =0
	Returns bounding box of sub-entity with index theIdx in sub-entity list.

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

virtual void	Swap (const int theIdx1, const int theIdx2)=0
	Swaps items with indexes theIdx1 and theIdx2.

bool	Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override
	Checks whether one or more entities of the set overlap current selecting volume. Implements the traverse of BVH tree built for the set.

void	BVH () override
	Builds BVH tree for sensitive set. Must be called manually to build BVH tree for any sensitive set in case if its content was initialized not in a constructor, but element by element.

bool	ToBuildBVH () const override
	Returns TRUE if BVH tree is in invalidated state.

void	SetBuilder (const occ::handle< Select3D_BVHBuilder3d > &theBuilder)
	Sets the method (builder) used to construct BVH.

void	MarkDirty ()
	Marks BVH tree of the set as outdated. It will be rebuild at the next call of BVH()

Select3D_BndBox3d	BoundingBox () override
	Returns bounding box of the whole set. This method should be redefined in Select3D_SensitiveSet descendants.

gp_Pnt	CenterOfGeometry () const override
	Returns center of the whole set. This method should be redefined in Select3D_SensitiveSet descendants.

void	Clear () override
	Destroys cross-reference to avoid memory leak.

int	GetLeafNodeSize () const
	Returns a number of nodes in 1 BVH leaf.

void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
	Dumps the content of me into the stream.

Public Member Functions inherited from Select3D_SensitiveEntity
const occ::handle< SelectMgr_EntityOwner > &	OwnerId () const
	Returns pointer to owner of the entity.

virtual void	Set (const occ::handle< SelectMgr_EntityOwner > &theOwnerId)
	Sets owner of the entity.

int	SensitivityFactor () const
	allows a better sensitivity for a specific entity in selection algorithms useful for small sized entities.

void	SetSensitivityFactor (const int theNewSens)
	Allows to manage sensitivity of a particular sensitive entity.

virtual occ::handle< Select3D_SensitiveEntity >	GetConnected ()
	Originally this method intended to return sensitive entity with new location aLocation, but currently sensitive entities do not hold a location, instead HasLocation() and Location() methods call corresponding entity owner's methods. Thus all entities returned by GetConnected() share the same location propagated from corresponding selectable object. You must redefine this function for any type of sensitive entity which can accept another connected sensitive entity.

virtual int	NbSubElements () const =0
	Returns the number of sub-entities or elements in sensitive entity. Is used to determine if entity is complex and needs to pre-build BVH at the creation of sensitive entity step or is light-weighted so the tree can be build on demand with unnoticeable delay.

virtual bool	HasInitLocation () const
	Returns true if the shape corresponding to the entity has init location.

virtual gp_GTrsf	InvInitLocation () const
	Returns inversed location transformation matrix if the shape corresponding to this entity has init location set. Otherwise, returns identity matrix.

const occ::handle< Graphic3d_TransformPers > &	TransformPersistence () const
	Return transformation persistence.

virtual void	SetTransformPersistence (const occ::handle< Graphic3d_TransformPers > &theTrsfPers)
	Set transformation persistence.

const occ::handle< Graphic3d_Flipper > &	Flipper () const
	Return flipper metadata describing the runtime flip of the owning group, or null.

virtual void	SetFlippingOptions (const bool theIsEnabled, const gp_Ax2 &theRefPlane)
	Set flipping options. When enabled, creates a Graphic3d_Flipper for theRefPlane; otherwise clears the flipper.

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.

Static Public Member Functions
static const occ::handle< Select3D_BVHBuilder3d > &	DefaultBVHBuilder ()
	Return global instance to default BVH builder.

static void	SetDefaultBVHBuilder (const occ::handle< Select3D_BVHBuilder3d > &theBuilder)
	Assign new BVH builder to be used by default for new sensitive sets (assigning is NOT thread-safe!).

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.

Protected Member Functions
bool	matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult, bool theToCheckAllInside)
	Checks whether one or more entities of the set overlap current selecting volume. Implements the traverse of BVH tree built for the set.

virtual bool	overlapsElement (SelectBasics_PickResult &thePickResult, SelectBasics_SelectingVolumeManager &theMgr, int theElemIdx, bool theIsFullInside)=0
	Checks whether the entity with index theIdx (partially) overlaps the current selecting volume.

virtual bool	elementIsInside (SelectBasics_SelectingVolumeManager &theMgr, int theElemIdx, bool theIsFullInside)=0
	Checks whether the entity with index theIdx is (fully) inside the current selecting volume.

virtual double	distanceToCOG (SelectBasics_SelectingVolumeManager &theMgr)=0
	Calculates distance from the 3d projection of used-picked screen point to center of the geometry.

bool	processElements (SelectBasics_SelectingVolumeManager &theMgr, int theFirstElem, int theLastElem, bool theIsFullInside, bool theToCheckAllInside, SelectBasics_PickResult &thePickResult, int &theMatchesNb)
	Process elements overlapped by the selection volume.

Protected Member Functions inherited from Select3D_SensitiveEntity
	Select3D_SensitiveEntity (const occ::handle< SelectMgr_EntityOwner > &theOwnerId)

Protected Attributes
BvhPrimitiveSet	myContent
	A link between sensitive entity and BVH_PrimitiveSet.

int	myDetectedIdx
	Index of detected primitive in BVH sorted primitive array.

Protected Attributes inherited from Select3D_SensitiveEntity
occ::handle< SelectMgr_EntityOwner >	myOwnerId

occ::handle< Graphic3d_TransformPers >	myTrsfPers

occ::handle< Graphic3d_Flipper >	myFlipper

int	mySFactor

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

Detailed Description

This class is base class for handling overlap detection of complex sensitive entities. It provides an interface for building BVH tree for some set of entities. Thereby, each iteration of overlap detection is a traverse of BVH tree in fact. To use speed-up hierarchical structure in a custom complex sensitive entity, it is necessary to make that custom entity a descendant of this class and organize sub-entities in some container which allows referencing to elements by index. Note that methods taking index as a parameter are used for BVH build and the range of given index is [0; Size() - 1]. For example of usage see Select3D_SensitiveTriangulation.

Constructor & Destructor Documentation

◆ Select3D_SensitiveSet()

Select3D_SensitiveSet::Select3D_SensitiveSet ( const occ::handle< SelectMgr_EntityOwner > & theOwnerId )

Creates new empty sensitive set and its content.

Member Function Documentation

◆ BoundingBox()

Select3D_BndBox3d Select3D_SensitiveSet::BoundingBox ( )

overridevirtual

Returns bounding box of the whole set. This method should be redefined in Select3D_SensitiveSet descendants.

Implements Select3D_SensitiveEntity.

Reimplemented in Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

◆ Box()

virtual Select3D_BndBox3d Select3D_SensitiveSet::Box ( const int theIdx ) const

pure virtual

Returns bounding box of sub-entity with index theIdx in sub-entity list.

Implemented in MeshVS_CommonSensitiveEntity, Select3D_InteriorSensitivePointSet, Select3D_SensitiveGroup, Select3D_SensitivePoly, Select3D_SensitivePrimitiveArray, Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

◆ BVH()

void Select3D_SensitiveSet::BVH ( )

overridevirtual

Builds BVH tree for sensitive set. Must be called manually to build BVH tree for any sensitive set in case if its content was initialized not in a constructor, but element by element.

Reimplemented from Select3D_SensitiveEntity.

◆ Center()

virtual double Select3D_SensitiveSet::Center	(	const int	theIdx,
		const int	theAxis ) const

pure virtual

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

Implemented in MeshVS_CommonSensitiveEntity, Select3D_InteriorSensitivePointSet, Select3D_SensitiveGroup, Select3D_SensitivePoly, Select3D_SensitivePrimitiveArray, Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

◆ CenterOfGeometry()

gp_Pnt Select3D_SensitiveSet::CenterOfGeometry ( ) const

overridevirtual

Returns center of the whole set. This method should be redefined in Select3D_SensitiveSet descendants.

Implements Select3D_SensitiveEntity.

Reimplemented in Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

◆ Clear()

void Select3D_SensitiveSet::Clear ( )

overridevirtual

Destroys cross-reference to avoid memory leak.

Reimplemented from Select3D_SensitiveEntity.

◆ DefaultBVHBuilder()

static const occ::handle< Select3D_BVHBuilder3d > & Select3D_SensitiveSet::DefaultBVHBuilder ( )

static

Return global instance to default BVH builder.

◆ distanceToCOG()

virtual double Select3D_SensitiveSet::distanceToCOG ( SelectBasics_SelectingVolumeManager & theMgr )

protectedpure virtual

Calculates distance from the 3d projection of used-picked screen point to center of the geometry.

Implemented in MeshVS_CommonSensitiveEntity, Select3D_InteriorSensitivePointSet, Select3D_SensitiveGroup, Select3D_SensitivePoly, Select3D_SensitivePrimitiveArray, and Select3D_SensitiveWire.

◆ DumpJson()

void Select3D_SensitiveSet::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from Select3D_SensitiveEntity.

Reimplemented in Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

◆ elementIsInside()

virtual bool Select3D_SensitiveSet::elementIsInside	(	SelectBasics_SelectingVolumeManager &	theMgr,
		int	theElemIdx,
		bool	theIsFullInside )

protectedpure virtual

Checks whether the entity with index theIdx is (fully) inside the current selecting volume.

Parameters

[in]	theMgr	selection manager
[in]	theElemIdx	element index within BVH tree to check
[in]	theIsFullInside	when TRUE indicates that entire BVH node is already inside selection volume (in case of rectangle selection); in this case algorithm might skip checking the element and just register it as detected

Implemented in MeshVS_CommonSensitiveEntity, Select3D_InteriorSensitivePointSet, Select3D_SensitiveGroup, Select3D_SensitivePoly, Select3D_SensitivePrimitiveArray, and Select3D_SensitiveWire.

◆ GetLeafNodeSize()

int Select3D_SensitiveSet::GetLeafNodeSize ( ) const

inline

Returns a number of nodes in 1 BVH leaf.

◆ MarkDirty()

void Select3D_SensitiveSet::MarkDirty ( )

inline

Marks BVH tree of the set as outdated. It will be rebuild at the next call of BVH()

◆ Matches()

bool Select3D_SensitiveSet::Matches	(	SelectBasics_SelectingVolumeManager &	theMgr,
		SelectBasics_PickResult &	thePickResult )

inlineoverridevirtual

Checks whether one or more entities of the set overlap current selecting volume. Implements the traverse of BVH tree built for the set.

Implements Select3D_SensitiveEntity.

Reimplemented in Select3D_SensitiveTriangulation.

◆ matches()

bool Select3D_SensitiveSet::matches	(	SelectBasics_SelectingVolumeManager &	theMgr,
		SelectBasics_PickResult &	thePickResult,
		bool	theToCheckAllInside )

protected

Checks whether one or more entities of the set overlap current selecting volume. Implements the traverse of BVH tree built for the set.

Parameters

theMgr	selection manager
thePickResult	picking result (for picking by ray)
theToCheckAllInside	flag indicating that even with SelectMgr_SelectingVolumeManager::IsOverlapAllowed() returning FALSE the method will return TRUE if at least one sub-element is fully inside selection volume elementIsInside(); this is useful for entities allowing local selection of sub-elements using single Owner object.

◆ overlapsElement()

virtual bool Select3D_SensitiveSet::overlapsElement	(	SelectBasics_PickResult &	thePickResult,
		SelectBasics_SelectingVolumeManager &	theMgr,
		int	theElemIdx,
		bool	theIsFullInside )

protectedpure virtual

Checks whether the entity with index theIdx (partially) overlaps the current selecting volume.

Parameters

[out]	thePickResult	picking result, should update minimum depth
[in]	theMgr	selection manager
[in]	theElemIdx	element index within BVH tree to check
[in]	theIsFullInside	when TRUE indicates that entire BVH node is already inside selection volume (in case of rectangle selection); in this case algorithm might skip checking the element and just register it as detected

Implemented in MeshVS_CommonSensitiveEntity, Select3D_InteriorSensitivePointSet, Select3D_SensitiveGroup, Select3D_SensitivePoly, Select3D_SensitivePrimitiveArray, and Select3D_SensitiveWire.

◆ processElements()

bool Select3D_SensitiveSet::processElements	(	SelectBasics_SelectingVolumeManager &	theMgr,
		int	theFirstElem,
		int	theLastElem,
		bool	theIsFullInside,
		bool	theToCheckAllInside,
		SelectBasics_PickResult &	thePickResult,
		int &	theMatchesNb )

protected

Process elements overlapped by the selection volume.

Parameters

	theMgr	selection manager
	theFirstElem	index of the first element
	theLastElem	index of the last element
	theIsFullInside	when TRUE indicates that entire BVH node is already inside selection volume
[out]	thePickResult	picking result (for picking by ray)
[out]	theMatchesNb	number of processed elements

Returns: FALSE if some element is outside the selection volume (if IsOverlapAllowed is FALSE); TRUE otherwise

◆ SetBuilder()

void Select3D_SensitiveSet::SetBuilder ( const occ::handle< Select3D_BVHBuilder3d > & theBuilder )

inline

Sets the method (builder) used to construct BVH.

◆ SetDefaultBVHBuilder()

static void Select3D_SensitiveSet::SetDefaultBVHBuilder ( const occ::handle< Select3D_BVHBuilder3d > & theBuilder )

static

Assign new BVH builder to be used by default for new sensitive sets (assigning is NOT thread-safe!).

◆ Size()

virtual int Select3D_SensitiveSet::Size ( ) const

pure virtual

Returns the amount of sub-entities of the complex entity.

Implemented in MeshVS_CommonSensitiveEntity, Select3D_InteriorSensitivePointSet, Select3D_SensitiveGroup, Select3D_SensitivePoly, Select3D_SensitivePrimitiveArray, Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

◆ Swap()

virtual void Select3D_SensitiveSet::Swap	(	const int	theIdx1,
		const int	theIdx2 )

pure virtual

Swaps items with indexes theIdx1 and theIdx2.

Implemented in MeshVS_CommonSensitiveEntity, Select3D_InteriorSensitivePointSet, Select3D_SensitiveGroup, Select3D_SensitivePoly, Select3D_SensitivePrimitiveArray, Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

◆ ToBuildBVH()

bool Select3D_SensitiveSet::ToBuildBVH ( ) const

inlineoverridevirtual

Returns TRUE if BVH tree is in invalidated state.

Reimplemented from Select3D_SensitiveEntity.

Field Documentation

◆ myContent

BvhPrimitiveSet Select3D_SensitiveSet::myContent

protected

A link between sensitive entity and BVH_PrimitiveSet.

◆ myDetectedIdx

int Select3D_SensitiveSet::myDetectedIdx

protected

Index of detected primitive in BVH sorted primitive array.

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

Select3D_SensitiveSet.hxx

Data Structures

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Select3D_SensitiveSet()

Member Function Documentation

◆ BoundingBox()

◆ Box()

◆ BVH()

◆ Center()

◆ CenterOfGeometry()

◆ Clear()

◆ DefaultBVHBuilder()

◆ distanceToCOG()

◆ DumpJson()

◆ elementIsInside()

◆ GetLeafNodeSize()

◆ MarkDirty()

◆ Matches()

◆ matches()

◆ overlapsElement()

◆ processElements()

◆ SetBuilder()

◆ SetDefaultBVHBuilder()

◆ Size()

◆ Swap()

◆ ToBuildBVH()

Field Documentation

◆ myContent

◆ myDetectedIdx