Open CASCADE Technology  6.9.0
Public Member Functions | Protected Member Functions | Protected Attributes
SelectBasics_SensitiveEntity Class Referenceabstract

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:
Inheritance graph
[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_Real SensitivityFactor () const
 allows a better sensitivity for a specific entity in selection algorithms useful for small sized entities. 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...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. 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 const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const 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 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...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Protected Member Functions

 SelectBasics_SensitiveEntity (const Handle< SelectBasics_EntityOwner > &theOwnerId, const Standard_Real theSensFactor=2.0)
 
void SetSensitivityFactor (const Standard_Real theSensFactor)
 Allows to manage the sensitivity of the entity. More...
 

Protected Attributes

Handle< SelectBasics_EntityOwnermyOwnerId
 

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 ( const Handle< SelectBasics_EntityOwner > &  theOwnerId,
const Standard_Real  theSensFactor = 2.0 
)
protected

Member Function Documentation

virtual Select3D_BndBox3d SelectBasics_SensitiveEntity::BoundingBox ( )
pure virtual
virtual void SelectBasics_SensitiveEntity::BVH ( )
pure virtual
virtual void SelectBasics_SensitiveEntity::Clear ( )
pure virtual

Clears up all the resources and memory allocated.

Implemented in Select3D_SensitiveSet, Select3D_SensitiveEntity, Select3D_SensitiveGroup, and MeshVS_DummySensitiveEntity.

virtual Standard_Boolean SelectBasics_SensitiveEntity::Matches ( SelectBasics_SelectingVolumeManager theMgr,
SelectBasics_PickResult thePickResult 
)
pure virtual
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_SensitiveGroup, Select3D_SensitiveFace, Select3D_SensitiveTriangulation, Select3D_InteriorSensitivePointSet, Select3D_SensitiveTriangle, Select3D_SensitivePoly, Select3D_SensitiveEntity, MeshVS_SensitivePolyhedron, Select3D_SensitiveSegment, Select3D_SensitiveBox, Select3D_SensitiveWire, Select3D_SensitivePoint, MeshVS_SensitiveMesh, and MeshVS_DummySensitiveEntity.

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

Returns pointer to owner of the entity.

Standard_Real SelectBasics_SensitiveEntity::SensitivityFactor ( ) const

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

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

Sets owner of the entity.

Reimplemented in Select3D_SensitiveGroup, and Select3D_SensitiveWire.

void SelectBasics_SensitiveEntity::SetSensitivityFactor ( const Standard_Real  theSensFactor)
protected

Allows to manage the sensitivity of the entity.

Field Documentation

Handle< SelectBasics_EntityOwner > SelectBasics_SensitiveEntity::myOwnerId
protected

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