root class; the inheriting classes will be able to give sensitive Areas for the dynamic selection algorithms More...

#include <SelectBasics_SensitiveEntity.hxx>

Inheritance diagram for SelectBasics_SensitiveEntity:

[legend]

Public Member Functions
virtual void	Set (const Handle< SelectBasics_EntityOwner > &theOwnerId)
	Sets owner of the entity. More...

const Handle< SelectBasics_EntityOwner > &	OwnerId () const
	Returns pointer to owner of the entity. More...

virtual Standard_Boolean	Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult)=0
	Checks whether the sensitive entity is overlapped by current selecting volume. More...

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

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

virtual Standard_Integer	NbSubElements ()=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. More...

virtual Select3D_BndBox3d	BoundingBox ()=0
	Returns bounding box of sensitive entity. More...

virtual void	BVH ()=0
	Builds BVH tree for sensitive if it is needed. More...

virtual void	Clear ()=0
	Clears up all the resources and memory allocated. More...

virtual Standard_Boolean	HasInitLocation () const =0
	Returns true if the shape corresponding to the entity has init location. More...

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

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter. More...

virtual	~Standard_Transient ()
	Destructor must be virtual. More...

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

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

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

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

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

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

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

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

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

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

Protected Member Functions
	SelectBasics_SensitiveEntity (const Handle< SelectBasics_EntityOwner > &theOwnerId)

Protected Attributes
Handle< SelectBasics_EntityOwner >	myOwnerId

Standard_Integer	mySFactor

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

Static Public Member Functions inherited from Standard_Transient
static const char *	get_type_name ()
	Returns a type descriptor about this object. More...

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class. More...

Detailed Description

root class; the inheriting classes will be able to give sensitive Areas for the dynamic selection algorithms

Constructor & Destructor Documentation

◆ SelectBasics_SensitiveEntity()

SelectBasics_SensitiveEntity::SelectBasics_SensitiveEntity ( const Handle< SelectBasics_EntityOwner > & theOwnerId )

protected

Member Function Documentation

◆ BoundingBox()

virtual Select3D_BndBox3d SelectBasics_SensitiveEntity::BoundingBox ( )

pure virtual

Returns bounding box of sensitive entity.

◆ BVH()

virtual void SelectBasics_SensitiveEntity::BVH ( )

pure virtual

Builds BVH tree for sensitive if it is needed.

Implemented in Select3D_SensitivePrimitiveArray, Select3D_SensitiveCircle, Select3D_SensitiveSet, Select3D_SensitiveFace, Select3D_SensitiveEntity, and MeshVS_DummySensitiveEntity.

◆ Clear()

virtual void SelectBasics_SensitiveEntity::Clear ( )

pure virtual

Clears up all the resources and memory allocated.

Implemented in Select3D_SensitiveSet, Select3D_SensitiveGroup, Select3D_SensitiveEntity, and MeshVS_DummySensitiveEntity.

◆ HasInitLocation()

virtual Standard_Boolean SelectBasics_SensitiveEntity::HasInitLocation ( ) const

pure virtual

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

Implemented in Select3D_SensitivePrimitiveArray, Select3D_SensitiveTriangulation, Select3D_SensitiveEntity, and MeshVS_DummySensitiveEntity.

◆ InvInitLocation()

virtual gp_GTrsf SelectBasics_SensitiveEntity::InvInitLocation ( ) const

pure virtual

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

Implemented in Select3D_SensitivePrimitiveArray, Select3D_SensitiveTriangulation, Select3D_SensitiveEntity, and MeshVS_DummySensitiveEntity.

◆ Matches()

virtual Standard_Boolean SelectBasics_SensitiveEntity::Matches	(	SelectBasics_SelectingVolumeManager &	theMgr,
		SelectBasics_PickResult &	thePickResult
	)

pure virtual

Checks whether the sensitive entity is overlapped by current selecting volume.

Implemented in Select3D_SensitivePrimitiveArray, Select3D_SensitiveGroup, Select3D_SensitiveCircle, Select3D_SensitiveSet, Select3D_SensitiveFace, MeshVS_SensitivePolyhedron, Select3D_SensitiveSegment, Select3D_SensitiveBox, Select3D_SensitiveEntity, MeshVS_SensitiveQuad, Select3D_SensitiveTriangle, Select3D_SensitivePoint, and MeshVS_DummySensitiveEntity.

◆ NbSubElements()

virtual Standard_Integer SelectBasics_SensitiveEntity::NbSubElements ( )

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 Select3D_SensitivePrimitiveArray, Select3D_SensitiveGroup, Select3D_SensitiveFace, Select3D_InteriorSensitivePointSet, Select3D_SensitiveTriangle, Select3D_SensitivePoly, MeshVS_SensitivePolyhedron, Select3D_SensitiveEntity, Select3D_SensitiveTriangulation, Select3D_SensitiveSegment, Select3D_SensitiveBox, MeshVS_SensitiveMesh, MeshVS_DummySensitiveEntity, MeshVS_SensitiveQuad, MeshVS_CommonSensitiveEntity, Select3D_SensitiveWire, and Select3D_SensitivePoint.

◆ OwnerId()

const Handle< SelectBasics_EntityOwner >& SelectBasics_SensitiveEntity::OwnerId ( ) const

inline

Returns pointer to owner of the entity.

◆ SensitivityFactor()

Standard_Integer SelectBasics_SensitiveEntity::SensitivityFactor ( ) const

inline

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

◆ Set()

virtual void SelectBasics_SensitiveEntity::Set ( const Handle< SelectBasics_EntityOwner > & theOwnerId )

virtual

Sets owner of the entity.

Reimplemented in Select3D_SensitivePrimitiveArray, Select3D_SensitiveGroup, and Select3D_SensitiveWire.

◆ SetSensitivityFactor()

void SelectBasics_SensitiveEntity::SetSensitivityFactor ( const Standard_Integer theNewSens )

inline

Allows to manage sensitivity of a particular sensitive entity.

Field Documentation

◆ myOwnerId

Handle< SelectBasics_EntityOwner > SelectBasics_SensitiveEntity::myOwnerId

protected

◆ mySFactor

Standard_Integer SelectBasics_SensitiveEntity::mySFactor

protected

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

SelectBasics_SensitiveEntity.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SelectBasics_SensitiveEntity()

Member Function Documentation

◆ BoundingBox()

◆ BVH()

◆ Clear()

◆ HasInitLocation()

◆ InvInitLocation()

◆ Matches()

◆ NbSubElements()

◆ OwnerId()

◆ SensitivityFactor()

◆ Set()

◆ SetSensitivityFactor()

Field Documentation

◆ myOwnerId

◆ mySFactor