Open CASCADE Technology  7.4.1.dev
Public Member Functions | Protected Member Functions
Select3D_SensitiveGroup Class Reference

A framework to define selection of a sensitive group by a sensitive entity which is a set of 3D sensitive entities. Remark: 2 modes are possible for rectangle selection the group is considered selected 1) when all the entities inside are selected in the rectangle 2) only one entity inside is selected by the rectangle By default the "Match All entities" mode is set. More...

#include <Select3D_SensitiveGroup.hxx>

Inheritance diagram for Select3D_SensitiveGroup:
Inheritance graph
[legend]

Public Member Functions

 Select3D_SensitiveGroup (const Handle< SelectMgr_EntityOwner > &theOwnerId, const Standard_Boolean theIsMustMatchAll=Standard_True)
 Constructs an empty sensitive group object. This is a set of sensitive 3D entities. The sensitive entities will be defined using the function Add to fill the entity owner OwnerId. If MatchAll is false, nothing can be added. More...
 
 Select3D_SensitiveGroup (const Handle< SelectMgr_EntityOwner > &theOwnerId, Select3D_EntitySequence &theEntities, const Standard_Boolean theIsMustMatchAll=Standard_True)
 Constructs a sensitive group object defined by the list TheList and the entity owner OwnerId. If MatchAll is false, nothing is done. More...
 
const Select3D_IndexedMapOfEntityEntities () const
 Gets group content. More...
 
const Handle< Select3D_SensitiveEntity > & SubEntity (const Standard_Integer theIndex) const
 Access entity by index [1, NbSubElements()]. More...
 
Handle< Select3D_SensitiveEntityLastDetectedEntity () const
 Return last detected entity. More...
 
Standard_Integer LastDetectedEntityIndex () const
 Return index of last detected entity. More...
 
void Add (Select3D_EntitySequence &theEntities)
 Adds the list of sensitive entities LL to the empty sensitive group object created at construction time. More...
 
void Add (const Handle< Select3D_SensitiveEntity > &theSensitive)
 Adds the sensitive entity aSensitive to the non-empty sensitive group object created at construction time. More...
 
void Remove (const Handle< Select3D_SensitiveEntity > &theSensitive)
 
void Clear () override
 Removes all sensitive entities from the list used at the time of construction, or added using the function Add. More...
 
Standard_Boolean IsIn (const Handle< Select3D_SensitiveEntity > &theSensitive) const
 Returns true if the sensitive entity aSensitive is in the list used at the time of construction, or added using the function Add. More...
 
void SetMatchType (const Standard_Boolean theIsMustMatchAll)
 Sets the requirement that all sensitive entities in the list used at the time of construction, or added using the function Add must be matched. More...
 
Standard_Boolean MustMatchAll () const
 Returns true if all sensitive entities in the list used at the time of construction, or added using the function Add must be matched. More...
 
Standard_Boolean ToCheckOverlapAll () const
 Returns TRUE if all sensitive entities should be checked within rectangular/polygonal selection, FALSE by default. Can be useful for sensitive entities holding detection results as class property. More...
 
void SetCheckOverlapAll (Standard_Boolean theToCheckAll)
 Returns TRUE if all sensitive entities should be checked within rectangular/polygonal selection, FALSE by default. Can be useful for sensitive entities holding detection results as class property. More...
 
virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override
 Checks whether the group overlaps current selecting volume. More...
 
virtual Standard_Integer NbSubElements () const override
 Returns the amount of sub-entities. More...
 
virtual Handle< Select3D_SensitiveEntityGetConnected () override
 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...
 
void Set (const Handle< SelectMgr_EntityOwner > &theOwnerId) override
 Sets the owner for all entities in group. More...
 
virtual Select3D_BndBox3d BoundingBox () override
 Returns bounding box of the group. If location transformation is set, it will be applied. More...
 
virtual gp_Pnt CenterOfGeometry () const override
 Returns center of entity set. If location transformation is set, it will be applied. More...
 
virtual Select3D_BndBox3d Box (const Standard_Integer theIdx) const override
 Returns bounding box of sensitive entity with index theIdx. More...
 
virtual Standard_Real Center (const Standard_Integer theIdx, const Standard_Integer theAxis) const override
 Returns geometry center of sensitive entity index theIdx in the vector along the given axis theAxis. More...
 
virtual void Swap (const Standard_Integer theIdx1, const Standard_Integer theIdx2) override
 Swaps items with indexes theIdx1 and theIdx2 in the vector. More...
 
virtual Standard_Integer Size () const override
 Returns the length of vector of sensitive entities. 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_SensitiveSet
 Select3D_SensitiveSet (const Handle< SelectMgr_EntityOwner > &theOwnerId)
 Creates new empty sensitive set and its content. 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...
 
Standard_Integer GetLeafNodeSize () const
 Returns a number of nodes in 1 BVH leaf. More...
 
- Public Member Functions inherited from Select3D_SensitiveEntity
const Handle< SelectMgr_EntityOwner > & OwnerId () const
 Returns pointer to 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 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...
 

Protected Member Functions

virtual Standard_Boolean overlapsElement (SelectBasics_PickResult &thePickResult, SelectBasics_SelectingVolumeManager &theMgr, Standard_Integer theElemIdx, Standard_Boolean theIsFullInside) override
 Checks whether the entity with index theIdx overlaps the current selecting volume. More...
 
virtual Standard_Boolean elementIsInside (SelectBasics_SelectingVolumeManager &theMgr, Standard_Integer theElemIdx, Standard_Boolean theIsFullInside) override
 Checks whether the entity with index theIdx is inside the current selecting volume. More...
 
virtual Standard_Real distanceToCOG (SelectBasics_SelectingVolumeManager &theMgr) override
 Calculates distance from the 3d projection of used-picked screen point to center of the geometry. More...
 
- Protected Member Functions inherited from Select3D_SensitiveSet
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...
 
- Protected Member Functions inherited from Select3D_SensitiveEntity
 Select3D_SensitiveEntity (const Handle< SelectMgr_EntityOwner > &theOwnerId)
 

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 Select3D_SensitiveSet
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 Attributes inherited from Select3D_SensitiveSet
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
 

Detailed Description

A framework to define selection of a sensitive group by a sensitive entity which is a set of 3D sensitive entities. Remark: 2 modes are possible for rectangle selection the group is considered selected 1) when all the entities inside are selected in the rectangle 2) only one entity inside is selected by the rectangle By default the "Match All entities" mode is set.

Constructor & Destructor Documentation

◆ Select3D_SensitiveGroup() [1/2]

Select3D_SensitiveGroup::Select3D_SensitiveGroup ( const Handle< SelectMgr_EntityOwner > &  theOwnerId,
const Standard_Boolean  theIsMustMatchAll = Standard_True 
)

Constructs an empty sensitive group object. This is a set of sensitive 3D entities. The sensitive entities will be defined using the function Add to fill the entity owner OwnerId. If MatchAll is false, nothing can be added.

◆ Select3D_SensitiveGroup() [2/2]

Select3D_SensitiveGroup::Select3D_SensitiveGroup ( const Handle< SelectMgr_EntityOwner > &  theOwnerId,
Select3D_EntitySequence theEntities,
const Standard_Boolean  theIsMustMatchAll = Standard_True 
)

Constructs a sensitive group object defined by the list TheList and the entity owner OwnerId. If MatchAll is false, nothing is done.

Member Function Documentation

◆ Add() [1/2]

void Select3D_SensitiveGroup::Add ( Select3D_EntitySequence theEntities)

Adds the list of sensitive entities LL to the empty sensitive group object created at construction time.

◆ Add() [2/2]

void Select3D_SensitiveGroup::Add ( const Handle< Select3D_SensitiveEntity > &  theSensitive)

Adds the sensitive entity aSensitive to the non-empty sensitive group object created at construction time.

◆ BoundingBox()

virtual Select3D_BndBox3d Select3D_SensitiveGroup::BoundingBox ( )
overridevirtual

Returns bounding box of the group. If location transformation is set, it will be applied.

Reimplemented from Select3D_SensitiveSet.

◆ Box()

virtual Select3D_BndBox3d Select3D_SensitiveGroup::Box ( const Standard_Integer  theIdx) const
overridevirtual

Returns bounding box of sensitive entity with index theIdx.

Implements Select3D_SensitiveSet.

◆ Center()

virtual Standard_Real Select3D_SensitiveGroup::Center ( const Standard_Integer  theIdx,
const Standard_Integer  theAxis 
) const
overridevirtual

Returns geometry center of sensitive entity index theIdx in the vector along the given axis theAxis.

Implements Select3D_SensitiveSet.

◆ CenterOfGeometry()

virtual gp_Pnt Select3D_SensitiveGroup::CenterOfGeometry ( ) const
overridevirtual

Returns center of entity set. If location transformation is set, it will be applied.

Reimplemented from Select3D_SensitiveSet.

◆ Clear()

void Select3D_SensitiveGroup::Clear ( )
overridevirtual

Removes all sensitive entities from the list used at the time of construction, or added using the function Add.

Reimplemented from Select3D_SensitiveSet.

◆ distanceToCOG()

virtual Standard_Real Select3D_SensitiveGroup::distanceToCOG ( SelectBasics_SelectingVolumeManager theMgr)
overrideprotectedvirtual

Calculates distance from the 3d projection of used-picked screen point to center of the geometry.

Implements Select3D_SensitiveSet.

◆ DumpJson()

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

Dumps the content of me into the stream.

Reimplemented from Select3D_SensitiveSet.

◆ elementIsInside()

virtual Standard_Boolean Select3D_SensitiveGroup::elementIsInside ( SelectBasics_SelectingVolumeManager theMgr,
Standard_Integer  theElemIdx,
Standard_Boolean  theIsFullInside 
)
overrideprotectedvirtual

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

Implements Select3D_SensitiveSet.

◆ Entities()

const Select3D_IndexedMapOfEntity& Select3D_SensitiveGroup::Entities ( ) const
inline

Gets group content.

◆ GetConnected()

virtual Handle< Select3D_SensitiveEntity > Select3D_SensitiveGroup::GetConnected ( )
overridevirtual

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 from Select3D_SensitiveEntity.

◆ IsIn()

Standard_Boolean Select3D_SensitiveGroup::IsIn ( const Handle< Select3D_SensitiveEntity > &  theSensitive) const

Returns true if the sensitive entity aSensitive is in the list used at the time of construction, or added using the function Add.

◆ LastDetectedEntity()

Handle< Select3D_SensitiveEntity > Select3D_SensitiveGroup::LastDetectedEntity ( ) const
inline

Return last detected entity.

◆ LastDetectedEntityIndex()

Standard_Integer Select3D_SensitiveGroup::LastDetectedEntityIndex ( ) const
inline

Return index of last detected entity.

◆ Matches()

virtual Standard_Boolean Select3D_SensitiveGroup::Matches ( SelectBasics_SelectingVolumeManager theMgr,
SelectBasics_PickResult thePickResult 
)
overridevirtual

Checks whether the group overlaps current selecting volume.

Reimplemented from Select3D_SensitiveSet.

◆ MustMatchAll()

Standard_Boolean Select3D_SensitiveGroup::MustMatchAll ( ) const
inline

Returns true if all sensitive entities in the list used at the time of construction, or added using the function Add must be matched.

◆ NbSubElements()

virtual Standard_Integer Select3D_SensitiveGroup::NbSubElements ( ) const
overridevirtual

Returns the amount of sub-entities.

Implements Select3D_SensitiveEntity.

◆ overlapsElement()

virtual Standard_Boolean Select3D_SensitiveGroup::overlapsElement ( SelectBasics_PickResult thePickResult,
SelectBasics_SelectingVolumeManager theMgr,
Standard_Integer  theElemIdx,
Standard_Boolean  theIsFullInside 
)
overrideprotectedvirtual

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

Implements Select3D_SensitiveSet.

◆ Remove()

void Select3D_SensitiveGroup::Remove ( const Handle< Select3D_SensitiveEntity > &  theSensitive)

◆ Set()

void Select3D_SensitiveGroup::Set ( const Handle< SelectMgr_EntityOwner > &  theOwnerId)
overridevirtual

Sets the owner for all entities in group.

Reimplemented from Select3D_SensitiveEntity.

◆ SetCheckOverlapAll()

void Select3D_SensitiveGroup::SetCheckOverlapAll ( Standard_Boolean  theToCheckAll)
inline

Returns TRUE if all sensitive entities should be checked within rectangular/polygonal selection, FALSE by default. Can be useful for sensitive entities holding detection results as class property.

◆ SetMatchType()

void Select3D_SensitiveGroup::SetMatchType ( const Standard_Boolean  theIsMustMatchAll)
inline

Sets the requirement that all sensitive entities in the list used at the time of construction, or added using the function Add must be matched.

◆ Size()

virtual Standard_Integer Select3D_SensitiveGroup::Size ( ) const
overridevirtual

Returns the length of vector of sensitive entities.

Implements Select3D_SensitiveSet.

◆ SubEntity()

const Handle< Select3D_SensitiveEntity >& Select3D_SensitiveGroup::SubEntity ( const Standard_Integer  theIndex) const
inline

Access entity by index [1, NbSubElements()].

◆ Swap()

virtual void Select3D_SensitiveGroup::Swap ( const Standard_Integer  theIdx1,
const Standard_Integer  theIdx2 
)
overridevirtual

Swaps items with indexes theIdx1 and theIdx2 in the vector.

Implements Select3D_SensitiveSet.

◆ ToCheckOverlapAll()

Standard_Boolean Select3D_SensitiveGroup::ToCheckOverlapAll ( ) const
inline

Returns TRUE if all sensitive entities should be checked within rectangular/polygonal selection, FALSE by default. Can be useful for sensitive entities holding detection results as class property.


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