Select3D_SensitiveEntity Class Reference

Abstract framework to define 3D sensitive entities. More...

#include <Select3D_SensitiveEntity.hxx>

Inheritance diagram for Select3D_SensitiveEntity:

Public Member Functions
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 bool	Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult)=0
	Checks whether sensitive overlaps current selecting volume. Stores minimum depth, distance to center of geometry and closest point detected into thePickResult.
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 Select3D_BndBox3d	BoundingBox ()=0
	Returns bounding box of a sensitive with transformation applied.
virtual gp_Pnt	CenterOfGeometry () const =0
	Returns center of a sensitive with transformation applied.
virtual void	BVH ()
	Builds BVH tree for a sensitive if needed.
virtual bool	ToBuildBVH () const
	Returns TRUE if BVH tree is in invalidated state.
virtual void	Clear ()
	Clears up all resources and memory.
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.
virtual void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const
	Dumps the content of me into the stream.
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.

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

Protected Attributes
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.
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.

Detailed Description

Abstract framework to define 3D sensitive entities.

Constructor & Destructor Documentation

Select3D_SensitiveEntity()

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

protected

Member Function Documentation

BoundingBox()

virtual Select3D_BndBox3d Select3D_SensitiveEntity::BoundingBox ( )

pure virtual

Returns bounding box of a sensitive with transformation applied.

Implemented in MeshVS_CommonSensitiveEntity, MeshVS_DummySensitiveEntity, MeshVS_SensitiveMesh, MeshVS_SensitivePolyhedron, MeshVS_SensitiveQuad, Select3D_InteriorSensitivePointSet, Select3D_SensitiveBox, Select3D_SensitiveCircle, Select3D_SensitiveCylinder, Select3D_SensitiveFace, Select3D_SensitiveGroup, Select3D_SensitivePoint, Select3D_SensitivePoly, Select3D_SensitivePrimitiveArray, Select3D_SensitiveSegment, Select3D_SensitiveSet, Select3D_SensitiveSphere, Select3D_SensitiveTriangle, Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

BVH()

virtual void Select3D_SensitiveEntity::BVH ( )

inlinevirtual

Builds BVH tree for a sensitive if needed.

Reimplemented in MeshVS_DummySensitiveEntity, Select3D_SensitiveFace, Select3D_SensitivePrimitiveArray, and Select3D_SensitiveSet.

CenterOfGeometry()

virtual gp_Pnt Select3D_SensitiveEntity::CenterOfGeometry ( ) const

pure virtual

Returns center of a sensitive with transformation applied.

Implemented in MeshVS_CommonSensitiveEntity, MeshVS_DummySensitiveEntity, MeshVS_SensitiveMesh, MeshVS_SensitivePolyhedron, MeshVS_SensitiveQuad, Select3D_InteriorSensitivePointSet, Select3D_SensitiveBox, Select3D_SensitiveCircle, Select3D_SensitiveCylinder, Select3D_SensitiveFace, Select3D_SensitiveGroup, Select3D_SensitivePoint, Select3D_SensitivePoly, Select3D_SensitivePrimitiveArray, Select3D_SensitiveSegment, Select3D_SensitiveSet, Select3D_SensitiveSphere, Select3D_SensitiveTriangle, Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

Clear()

virtual void Select3D_SensitiveEntity::Clear ( )

inlinevirtual

Clears up all resources and memory.

Reimplemented in MeshVS_DummySensitiveEntity, Select3D_SensitiveGroup, and Select3D_SensitiveSet.

DumpJson()

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

virtual

Dumps the content of me into the stream.

Reimplemented in Select3D_InteriorSensitivePointSet, Select3D_SensitiveBox, Select3D_SensitiveFace, Select3D_SensitiveGroup, Select3D_SensitivePoint, Select3D_SensitivePoly, Select3D_SensitivePrimitiveArray, Select3D_SensitiveSegment, Select3D_SensitiveSet, Select3D_SensitiveTriangle, Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

Flipper()

const occ::handle< Graphic3d_Flipper > & Select3D_SensitiveEntity::Flipper ( ) const

inline

Return flipper metadata describing the runtime flip of the owning group, or null.

GetConnected()

virtual occ::handle< Select3D_SensitiveEntity > Select3D_SensitiveEntity::GetConnected ( )

inlinevirtual

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.

Reimplemented in MeshVS_CommonSensitiveEntity, MeshVS_SensitiveMesh, MeshVS_SensitivePolyhedron, MeshVS_SensitiveQuad, Select3D_SensitiveBox, Select3D_SensitiveCircle, Select3D_SensitiveCurve, Select3D_SensitiveCylinder, Select3D_SensitiveFace, Select3D_SensitiveGroup, Select3D_SensitivePoint, Select3D_SensitivePrimitiveArray, Select3D_SensitiveSegment, Select3D_SensitiveSphere, Select3D_SensitiveTriangle, Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

HasInitLocation()

virtual bool Select3D_SensitiveEntity::HasInitLocation ( ) const

inlinevirtual

Returns true if the shape corresponding to the entity has init location.

Reimplemented in MeshVS_DummySensitiveEntity, Select3D_SensitivePrimitiveArray, and Select3D_SensitiveTriangulation.

InvInitLocation()

virtual gp_GTrsf Select3D_SensitiveEntity::InvInitLocation ( ) const

inlinevirtual

Returns inversed location transformation matrix if the shape corresponding to this entity has init location set. Otherwise, returns identity matrix.

Reimplemented in MeshVS_DummySensitiveEntity, Select3D_SensitivePrimitiveArray, and Select3D_SensitiveTriangulation.

Matches()

virtual bool Select3D_SensitiveEntity::Matches ( SelectBasics_SelectingVolumeManager & theMgr, SelectBasics_PickResult & thePickResult )

pure virtual

Checks whether sensitive overlaps current selecting volume. Stores minimum depth, distance to center of geometry and closest point detected into thePickResult.

Implemented in MeshVS_DummySensitiveEntity, MeshVS_SensitiveMesh, MeshVS_SensitivePolyhedron, MeshVS_SensitiveQuad, AIS_ViewCubeSensitive, Select3D_SensitiveBox, Select3D_SensitiveCircle, Select3D_SensitiveCylinder, Select3D_SensitiveFace, Select3D_SensitiveGroup, Select3D_SensitivePoint, Select3D_SensitivePoly, Select3D_SensitivePrimitiveArray, Select3D_SensitiveSegment, Select3D_SensitiveSet, Select3D_SensitiveSphere, Select3D_SensitiveTriangle, and Select3D_SensitiveTriangulation.

NbSubElements()

virtual int Select3D_SensitiveEntity::NbSubElements ( ) const

pure virtual

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.

Implemented in MeshVS_CommonSensitiveEntity, MeshVS_DummySensitiveEntity, MeshVS_SensitiveMesh, MeshVS_SensitivePolyhedron, MeshVS_SensitiveQuad, Select3D_InteriorSensitivePointSet, Select3D_SensitiveBox, Select3D_SensitiveCircle, Select3D_SensitiveCylinder, Select3D_SensitiveFace, Select3D_SensitiveGroup, Select3D_SensitivePoint, Select3D_SensitivePoly, Select3D_SensitivePrimitiveArray, Select3D_SensitiveSegment, Select3D_SensitiveSphere, Select3D_SensitiveTriangle, Select3D_SensitiveTriangulation, and Select3D_SensitiveWire.

OwnerId()

const occ::handle< SelectMgr_EntityOwner > & Select3D_SensitiveEntity::OwnerId ( ) const

inline

Returns pointer to owner of the entity.

SensitivityFactor()

int Select3D_SensitiveEntity::SensitivityFactor ( ) const

inline

allows a better sensitivity for a specific entity in selection algorithms useful for small sized entities.

Set()

virtual void Select3D_SensitiveEntity::Set ( const occ::handle< SelectMgr_EntityOwner > & theOwnerId )

inlinevirtual

Sets owner of the entity.

Reimplemented in Select3D_SensitiveGroup, Select3D_SensitivePrimitiveArray, and Select3D_SensitiveWire.

SetFlippingOptions()

virtual void Select3D_SensitiveEntity::SetFlippingOptions ( const bool theIsEnabled, const gp_Ax2 & theRefPlane )

virtual

Set flipping options. When enabled, creates a Graphic3d_Flipper for theRefPlane; otherwise clears the flipper.

SetSensitivityFactor()

void Select3D_SensitiveEntity::SetSensitivityFactor ( const int theNewSens )

inline

Allows to manage sensitivity of a particular sensitive entity.

SetTransformPersistence()

virtual void Select3D_SensitiveEntity::SetTransformPersistence ( const occ::handle< Graphic3d_TransformPers > & theTrsfPers )

inlinevirtual

Set transformation persistence.

ToBuildBVH()

virtual bool Select3D_SensitiveEntity::ToBuildBVH ( ) const

inlinevirtual

Returns TRUE if BVH tree is in invalidated state.

Reimplemented in MeshVS_DummySensitiveEntity, Select3D_SensitiveBox, Select3D_SensitiveCircle, Select3D_SensitiveCylinder, Select3D_SensitiveFace, Select3D_SensitivePoint, Select3D_SensitiveSegment, Select3D_SensitiveSet, Select3D_SensitiveSphere, and Select3D_SensitiveTriangle.

TransformPersistence()

const occ::handle< Graphic3d_TransformPers > & Select3D_SensitiveEntity::TransformPersistence ( ) const

inline

Return transformation persistence.

Field Documentation

myFlipper

occ::handle<Graphic3d_Flipper> Select3D_SensitiveEntity::myFlipper

protected

myOwnerId

occ::handle<SelectMgr_EntityOwner> Select3D_SensitiveEntity::myOwnerId

protected

mySFactor

int Select3D_SensitiveEntity::mySFactor

protected

myTrsfPers

occ::handle<Graphic3d_TransformPers> Select3D_SensitiveEntity::myTrsfPers

protected

---

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

• Select3D_SensitiveEntity.hxx