Open CASCADE Technology  7.4.1.dev
Public Member Functions | Protected Member Functions | Protected Attributes
Select3D_SensitiveEntity Class Referenceabstract

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

#include <Select3D_SensitiveEntity.hxx>

Inheritance diagram for Select3D_SensitiveEntity:
Inheritance graph
[legend]

Public Member Functions

const Handle< SelectMgr_EntityOwner > & OwnerId () const
 Returns pointer to owner of the entity. More...
 
virtual void Set (const Handle< SelectMgr_EntityOwner > &theOwnerId)
 Sets owner of the entity. 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 Handle< Select3D_SensitiveEntityGetConnected ()
 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. More...
 
virtual Standard_Boolean 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. More...
 
virtual Standard_Integer 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. More...
 
virtual Select3D_BndBox3d BoundingBox ()=0
 Returns bounding box of a sensitive with transformation applied. More...
 
virtual gp_Pnt CenterOfGeometry () const =0
 Returns center of a sensitive with transformation applied. More...
 
virtual void BVH ()
 Builds BVH tree for a sensitive if needed. More...
 
virtual void Clear ()
 Clears up all resources and memory. More...
 
virtual Standard_Boolean HasInitLocation () const
 Returns true if the shape corresponding to the entity has init location. More...
 
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. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (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_TransientThis () 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

 Select3D_SensitiveEntity (const Handle< SelectMgr_EntityOwner > &theOwnerId)
 

Protected Attributes

Handle< SelectMgr_EntityOwnermyOwnerId
 
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

Abstract framework to define 3D sensitive entities.

Constructor & Destructor Documentation

◆ Select3D_SensitiveEntity()

Select3D_SensitiveEntity::Select3D_SensitiveEntity ( const Handle< SelectMgr_EntityOwner > &  theOwnerId)
protected

Member Function Documentation

◆ BoundingBox()

virtual Select3D_BndBox3d Select3D_SensitiveEntity::BoundingBox ( )
pure virtual

◆ BVH()

virtual void Select3D_SensitiveEntity::BVH ( )
inlinevirtual

◆ CenterOfGeometry()

virtual gp_Pnt Select3D_SensitiveEntity::CenterOfGeometry ( ) const
pure virtual

◆ Clear()

virtual void Select3D_SensitiveEntity::Clear ( )
inlinevirtual

Clears up all resources and memory.

Reimplemented in Select3D_SensitiveSet, Select3D_SensitiveGroup, and MeshVS_DummySensitiveEntity.

◆ DumpJson()

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

◆ GetConnected()

virtual 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 Select3D_SensitivePrimitiveArray, Select3D_SensitiveGroup, Select3D_SensitiveCircle, MeshVS_CommonSensitiveEntity, Select3D_SensitiveFace, Select3D_SensitiveTriangulation, Select3D_SensitiveCurve, Select3D_SensitiveTriangle, MeshVS_SensitivePolyhedron, Select3D_SensitiveSegment, Select3D_SensitiveBox, MeshVS_SensitiveQuad, MeshVS_SensitiveMesh, Select3D_SensitiveWire, and Select3D_SensitivePoint.

◆ HasInitLocation()

virtual Standard_Boolean Select3D_SensitiveEntity::HasInitLocation ( ) const
inlinevirtual

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

Reimplemented in Select3D_SensitivePrimitiveArray, Select3D_SensitiveTriangulation, and MeshVS_DummySensitiveEntity.

◆ 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 Select3D_SensitivePrimitiveArray, Select3D_SensitiveTriangulation, and MeshVS_DummySensitiveEntity.

◆ Matches()

virtual Standard_Boolean Select3D_SensitiveEntity::Matches ( SelectBasics_SelectingVolumeManager theMgr,
SelectBasics_PickResult thePickResult 
)
pure virtual

◆ NbSubElements()

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

◆ OwnerId()

const Handle< SelectMgr_EntityOwner >& Select3D_SensitiveEntity::OwnerId ( ) const
inline

Returns pointer to owner of the entity.

◆ SensitivityFactor()

Standard_Integer 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 Handle< SelectMgr_EntityOwner > &  theOwnerId)
inlinevirtual

Sets owner of the entity.

Reimplemented in Select3D_SensitivePrimitiveArray, Select3D_SensitiveGroup, and Select3D_SensitiveWire.

◆ SetSensitivityFactor()

void Select3D_SensitiveEntity::SetSensitivityFactor ( const Standard_Integer  theNewSens)
inline

Allows to manage sensitivity of a particular sensitive entity.

Field Documentation

◆ myOwnerId

Handle< SelectMgr_EntityOwner > Select3D_SensitiveEntity::myOwnerId
protected

◆ mySFactor

Standard_Integer Select3D_SensitiveEntity::mySFactor
protected

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