Open CASCADE Technology  7.4.1.dev
Data Structures | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
Select3D_SensitiveSet Class Referenceabstract

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:
Inheritance graph
[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 Handle< SelectMgr_EntityOwner > &theOwnerId)
 Creates new empty sensitive set and its content. More...
 
virtual Standard_Integer Size () const =0
 Returns the amount of sub-entities of the complex entity. More...
 
virtual Select3D_BndBox3d Box (const Standard_Integer theIdx) const =0
 Returns bounding box of sub-entity with index theIdx in sub-entity list. More...
 
virtual Standard_Real Center (const Standard_Integer theIdx, const Standard_Integer theAxis) const =0
 Returns geometry center of sensitive entity index theIdx along the given axis theAxis. More...
 
virtual void Swap (const Standard_Integer theIdx1, const Standard_Integer theIdx2)=0
 Swaps items with indexes theIdx1 and theIdx2. More...
 
virtual Standard_Boolean 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. More...
 
virtual 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. More...
 
void SetBuilder (const Handle< Select3D_BVHBuilder3d > &theBuilder)
 Sets the method (builder) used to construct BVH. More...
 
void MarkDirty ()
 Marks BVH tree of the set as outdated. It will be rebuild at the next call of BVH() More...
 
virtual Select3D_BndBox3d BoundingBox () override
 Returns bounding box of the whole set. This method should be redefined in Select3D_SensitiveSet descendants. More...
 
virtual gp_Pnt CenterOfGeometry () const override
 Returns center of the whole set. This method should be redefined in Select3D_SensitiveSet descendants. More...
 
virtual void Clear () override
 Destroys cross-reference to avoid memory leak. More...
 
Standard_Integer GetLeafNodeSize () const
 Returns a number of nodes in 1 BVH leaf. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from Select3D_SensitiveEntity
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_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 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...
 
- 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...
 

Static Public Member Functions

static const Handle< Select3D_BVHBuilder3d > & DefaultBVHBuilder ()
 Return global instance to default BVH builder. More...
 
static void SetDefaultBVHBuilder (const Handle< Select3D_BVHBuilder3d > &theBuilder)
 Assign new BVH builder to be used by default for new sensitive sets (assigning is NOT thread-safe!). 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...
 

Protected Member Functions

Standard_Boolean matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult, Standard_Boolean theToCheckAllInside)
 Checks whether one or more entities of the set overlap current selecting volume. Implements the traverse of BVH tree built for the set. More...
 
virtual Standard_Boolean overlapsElement (SelectBasics_PickResult &thePickResult, SelectBasics_SelectingVolumeManager &theMgr, Standard_Integer theElemIdx, Standard_Boolean theIsFullInside)=0
 Checks whether the entity with index theIdx (partially) overlaps the current selecting volume. More...
 
virtual Standard_Boolean elementIsInside (SelectBasics_SelectingVolumeManager &theMgr, Standard_Integer theElemIdx, Standard_Boolean theIsFullInside)=0
 Checks whether the entity with index theIdx is (fully) inside the current selecting volume. More...
 
virtual Standard_Real distanceToCOG (SelectBasics_SelectingVolumeManager &theMgr)=0
 Calculates distance from the 3d projection of used-picked screen point to center of the geometry. More...
 
- Protected Member Functions inherited from Select3D_SensitiveEntity
 Select3D_SensitiveEntity (const Handle< SelectMgr_EntityOwner > &theOwnerId)
 

Protected Attributes

BvhPrimitiveSet myContent
 A link between sensitive entity and BVH_PrimitiveSet. More...
 
Standard_Integer myDetectedIdx
 Index of detected primitive in BVH sorted primitive array. More...
 
- Protected Attributes inherited from Select3D_SensitiveEntity
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...
 

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

Creates new empty sensitive set and its content.

Member Function Documentation

◆ BoundingBox()

virtual Select3D_BndBox3d Select3D_SensitiveSet::BoundingBox ( )
overridevirtual

◆ Box()

virtual Select3D_BndBox3d Select3D_SensitiveSet::Box ( const Standard_Integer  theIdx) const
pure virtual

◆ BVH()

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

Reimplemented in Select3D_SensitivePrimitiveArray, and Select3D_SensitiveCircle.

◆ Center()

virtual Standard_Real Select3D_SensitiveSet::Center ( const Standard_Integer  theIdx,
const Standard_Integer  theAxis 
) const
pure virtual

◆ CenterOfGeometry()

virtual gp_Pnt Select3D_SensitiveSet::CenterOfGeometry ( ) const
overridevirtual

◆ Clear()

virtual void Select3D_SensitiveSet::Clear ( )
overridevirtual

Destroys cross-reference to avoid memory leak.

Reimplemented from Select3D_SensitiveEntity.

Reimplemented in Select3D_SensitiveGroup.

◆ DefaultBVHBuilder()

static const Handle< Select3D_BVHBuilder3d >& Select3D_SensitiveSet::DefaultBVHBuilder ( )
static

Return global instance to default BVH builder.

◆ distanceToCOG()

virtual Standard_Real 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 Select3D_SensitivePrimitiveArray, Select3D_SensitiveGroup, Select3D_SensitivePoly, Select3D_InteriorSensitivePointSet, Select3D_SensitiveWire, Select3D_SensitiveCircle, and MeshVS_CommonSensitiveEntity.

◆ DumpJson()

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

◆ elementIsInside()

virtual Standard_Boolean Select3D_SensitiveSet::elementIsInside ( SelectBasics_SelectingVolumeManager theMgr,
Standard_Integer  theElemIdx,
Standard_Boolean  theIsFullInside 
)
protectedpure virtual

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

Parameters
theMgr[IN] selection manager
theElemIdx[IN] element index within BVH tree to check
theIsFullInside[IN] 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 Select3D_SensitivePrimitiveArray, Select3D_SensitiveGroup, Select3D_SensitivePoly, Select3D_InteriorSensitivePointSet, Select3D_SensitiveWire, and MeshVS_CommonSensitiveEntity.

◆ GetLeafNodeSize()

Standard_Integer 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()

virtual Standard_Boolean 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_SensitivePrimitiveArray, Select3D_SensitiveGroup, and Select3D_SensitiveCircle.

◆ matches()

Standard_Boolean Select3D_SensitiveSet::matches ( SelectBasics_SelectingVolumeManager theMgr,
SelectBasics_PickResult thePickResult,
Standard_Boolean  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
theMgrselection manager
thePickResultpicking result (for picking by ray)
theToCheckAllInsideflag 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 Standard_Boolean Select3D_SensitiveSet::overlapsElement ( SelectBasics_PickResult thePickResult,
SelectBasics_SelectingVolumeManager theMgr,
Standard_Integer  theElemIdx,
Standard_Boolean  theIsFullInside 
)
protectedpure virtual

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

Parameters
thePickResult[OUT] picking result, should update minimum depth
theMgr[IN] selection manager
theElemIdx[IN] element index within BVH tree to check
theIsFullInside[IN] 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 Select3D_SensitivePrimitiveArray, Select3D_SensitiveGroup, Select3D_SensitivePoly, Select3D_InteriorSensitivePointSet, Select3D_SensitiveWire, and MeshVS_CommonSensitiveEntity.

◆ SetBuilder()

void Select3D_SensitiveSet::SetBuilder ( const Handle< Select3D_BVHBuilder3d > &  theBuilder)
inline

Sets the method (builder) used to construct BVH.

◆ SetDefaultBVHBuilder()

static void Select3D_SensitiveSet::SetDefaultBVHBuilder ( const 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 Standard_Integer Select3D_SensitiveSet::Size ( ) const
pure virtual

◆ Swap()

virtual void Select3D_SensitiveSet::Swap ( const Standard_Integer  theIdx1,
const Standard_Integer  theIdx2 
)
pure virtual

Field Documentation

◆ myContent

BvhPrimitiveSet Select3D_SensitiveSet::myContent
protected

A link between sensitive entity and BVH_PrimitiveSet.

◆ myDetectedIdx

Standard_Integer Select3D_SensitiveSet::myDetectedIdx
protected

Index of detected primitive in BVH sorted primitive array.


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