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:

[legend]

Public Member Functions
	Select3D_SensitiveGroup (const occ::handle< SelectMgr_EntityOwner > &theOwnerId, const bool theIsMustMatchAll=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 (const occ::handle< SelectMgr_EntityOwner > &theOwnerId, NCollection_Sequence< occ::handle< Select3D_SensitiveEntity > > &theEntities, const bool theIsMustMatchAll=true)
	Constructs a sensitive group object defined by the list TheList and the entity owner OwnerId. If MatchAll is false, nothing is done.

const NCollection_IndexedMap< occ::handle< Select3D_SensitiveEntity > > &	Entities () const
	Gets group content.

const occ::handle< Select3D_SensitiveEntity > &	SubEntity (const int theIndex) const
	Access entity by index [1, NbSubElements()].

occ::handle< Select3D_SensitiveEntity >	LastDetectedEntity () const
	Return last detected entity.

int	LastDetectedEntityIndex () const
	Return index of last detected entity.

void	Add (NCollection_Sequence< occ::handle< Select3D_SensitiveEntity > > &theEntities)
	Adds the list of sensitive entities LL to the empty sensitive group object created at construction time.

void	Add (const occ::handle< Select3D_SensitiveEntity > &theSensitive)
	Adds the sensitive entity aSensitive to the non-empty sensitive group object created at construction time.

void	Remove (const occ::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.

bool	IsIn (const occ::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.

void	SetMatchType (const bool 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.

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

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

void	SetCheckOverlapAll (bool 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.

bool	Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override
	Checks whether the group overlaps current selecting volume.

int	NbSubElements () const override
	Returns the amount of sub-entities.

occ::handle< Select3D_SensitiveEntity >	GetConnected () 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.

void	Set (const occ::handle< SelectMgr_EntityOwner > &theOwnerId) override
	Sets the owner for all entities in group.

Select3D_BndBox3d	BoundingBox () override
	Returns bounding box of the group. If location transformation is set, it will be applied.

gp_Pnt	CenterOfGeometry () const override
	Returns center of entity set. If location transformation is set, it will be applied.

Select3D_BndBox3d	Box (const int theIdx) const override
	Returns bounding box of sensitive entity with index theIdx.

double	Center (const int theIdx, const int theAxis) const override
	Returns geometry center of sensitive entity index theIdx in the vector along the given axis theAxis.

void	Swap (const int theIdx1, const int theIdx2) override
	Swaps items with indexes theIdx1 and theIdx2 in the vector.

int	Size () const override
	Returns the length of vector of sensitive entities.

void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
	Dumps the content of me into the stream.

Public Member Functions inherited from Select3D_SensitiveSet
	Select3D_SensitiveSet (const occ::handle< SelectMgr_EntityOwner > &theOwnerId)
	Creates new empty sensitive set and its content.

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

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.

bool	ToBuildBVH () const override
	Returns TRUE if BVH tree is in invalidated state.

void	SetBuilder (const occ::handle< Select3D_BVHBuilder3d > &theBuilder)
	Sets the method (builder) used to construct BVH.

void	MarkDirty ()
	Marks BVH tree of the set as outdated. It will be rebuild at the next call of BVH()

Select3D_BndBox3d	BoundingBox () override
	Returns bounding box of the whole set. This method should be redefined in Select3D_SensitiveSet descendants.

gp_Pnt	CenterOfGeometry () const override
	Returns center of the whole set. This method should be redefined in Select3D_SensitiveSet descendants.

void	Clear () override
	Destroys cross-reference to avoid memory leak.

int	GetLeafNodeSize () const
	Returns a number of nodes in 1 BVH leaf.

void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
	Dumps the content of me into the stream.

Public Member Functions inherited from Select3D_SensitiveEntity
const occ::handle< SelectMgr_EntityOwner > &	OwnerId () const
	Returns pointer to owner of the entity.

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

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

virtual bool	HasInitLocation () const
	Returns true if the shape corresponding to the entity has init location.

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.

const occ::handle< Graphic3d_TransformPers > &	TransformPersistence () const
	Return transformation persistence.

virtual void	SetTransformPersistence (const occ::handle< Graphic3d_TransformPers > &theTrsfPers)
	Set transformation persistence.

const occ::handle< Graphic3d_Flipper > &	Flipper () const
	Return flipper metadata describing the runtime flip of the owning group, or null.

virtual void	SetFlippingOptions (const bool theIsEnabled, const gp_Ax2 &theRefPlane)
	Set flipping options. When enabled, creates a Graphic3d_Flipper for theRefPlane; otherwise clears the flipper.

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

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

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

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

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

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

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

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

bool	IsKind (const char *const 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.

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.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

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

Protected Member Functions
bool	overlapsElement (SelectBasics_PickResult &thePickResult, SelectBasics_SelectingVolumeManager &theMgr, int theElemIdx, bool theIsFullInside) override
	Checks whether the entity with index theIdx overlaps the current selecting volume.

bool	elementIsInside (SelectBasics_SelectingVolumeManager &theMgr, int theElemIdx, bool theIsFullInside) override
	Checks whether the entity with index theIdx is inside the current selecting volume.

double	distanceToCOG (SelectBasics_SelectingVolumeManager &theMgr) override
	Calculates distance from the 3d projection of used-picked screen point to center of the geometry.

Protected Member Functions inherited from Select3D_SensitiveSet
bool	matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult, bool theToCheckAllInside)
	Checks whether one or more entities of the set overlap current selecting volume. Implements the traverse of BVH tree built for the set.

bool	processElements (SelectBasics_SelectingVolumeManager &theMgr, int theFirstElem, int theLastElem, bool theIsFullInside, bool theToCheckAllInside, SelectBasics_PickResult &thePickResult, int &theMatchesNb)
	Process elements overlapped by the selection volume.

Protected Member Functions inherited from Select3D_SensitiveEntity
	Select3D_SensitiveEntity (const occ::handle< SelectMgr_EntityOwner > &theOwnerId)

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

Static Public Member Functions inherited from Select3D_SensitiveSet
static const occ::handle< Select3D_BVHBuilder3d > &	DefaultBVHBuilder ()
	Return global instance to default BVH builder.

static void	SetDefaultBVHBuilder (const occ::handle< Select3D_BVHBuilder3d > &theBuilder)
	Assign new BVH builder to be used by default for new sensitive sets (assigning is NOT thread-safe!).

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

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

Protected Attributes inherited from Select3D_SensitiveSet
BvhPrimitiveSet	myContent
	A link between sensitive entity and BVH_PrimitiveSet.

int	myDetectedIdx
	Index of detected primitive in BVH sorted primitive array.

Protected Attributes inherited from Select3D_SensitiveEntity
occ::handle< SelectMgr_EntityOwner >	myOwnerId

occ::handle< Graphic3d_TransformPers >	myTrsfPers

occ::handle< Graphic3d_Flipper >	myFlipper

int	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 occ::handle< SelectMgr_EntityOwner > &	theOwnerId,
		const bool	theIsMustMatchAll = 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 occ::handle< SelectMgr_EntityOwner > &	theOwnerId,
		NCollection_Sequence< occ::handle< Select3D_SensitiveEntity > > &	theEntities,
		const bool	theIsMustMatchAll = 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 ( const occ::handle< Select3D_SensitiveEntity > & theSensitive )

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

◆ Add() [2/2]

void Select3D_SensitiveGroup::Add ( NCollection_Sequence< occ::handle< Select3D_SensitiveEntity > > & theEntities )

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

◆ BoundingBox()

Select3D_BndBox3d Select3D_SensitiveGroup::BoundingBox ( )

overridevirtual

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

Implements Select3D_SensitiveEntity.

◆ Box()

Select3D_BndBox3d Select3D_SensitiveGroup::Box ( const int theIdx ) const

overridevirtual

Returns bounding box of sensitive entity with index theIdx.

Implements Select3D_SensitiveSet.

◆ Center()

double Select3D_SensitiveGroup::Center	(	const int	theIdx,
		const int	theAxis ) const

overridevirtual

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

Implements Select3D_SensitiveSet.

◆ CenterOfGeometry()

gp_Pnt Select3D_SensitiveGroup::CenterOfGeometry ( ) const

overridevirtual

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

Implements Select3D_SensitiveEntity.

◆ 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_SensitiveEntity.

◆ distanceToCOG()

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

void Select3D_SensitiveGroup::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from Select3D_SensitiveEntity.

◆ elementIsInside()

bool Select3D_SensitiveGroup::elementIsInside	(	SelectBasics_SelectingVolumeManager &	theMgr,
		int	theElemIdx,
		bool	theIsFullInside )

overrideprotectedvirtual

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

Implements Select3D_SensitiveSet.

◆ Entities()

const NCollection_IndexedMap< occ::handle< Select3D_SensitiveEntity > > & Select3D_SensitiveGroup::Entities ( ) const

inline

Gets group content.

◆ GetConnected()

occ::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()

bool Select3D_SensitiveGroup::IsIn ( const occ::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()

occ::handle< Select3D_SensitiveEntity > Select3D_SensitiveGroup::LastDetectedEntity ( ) const

inline

Return last detected entity.

◆ LastDetectedEntityIndex()

int Select3D_SensitiveGroup::LastDetectedEntityIndex ( ) const

inline

Return index of last detected entity.

◆ Matches()

bool Select3D_SensitiveGroup::Matches	(	SelectBasics_SelectingVolumeManager &	theMgr,
		SelectBasics_PickResult &	thePickResult )

overridevirtual

Checks whether the group overlaps current selecting volume.

Implements Select3D_SensitiveEntity.

◆ MustMatchAll()

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

int Select3D_SensitiveGroup::NbSubElements ( ) const

overridevirtual

Returns the amount of sub-entities.

Implements Select3D_SensitiveEntity.

◆ overlapsElement()

bool Select3D_SensitiveGroup::overlapsElement	(	SelectBasics_PickResult &	thePickResult,
		SelectBasics_SelectingVolumeManager &	theMgr,
		int	theElemIdx,
		bool	theIsFullInside )

overrideprotectedvirtual

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

Implements Select3D_SensitiveSet.

◆ Remove()

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

◆ Set()

void Select3D_SensitiveGroup::Set ( const occ::handle< SelectMgr_EntityOwner > & theOwnerId )

overridevirtual

Sets the owner for all entities in group.

Reimplemented from Select3D_SensitiveEntity.

◆ SetCheckOverlapAll()

void Select3D_SensitiveGroup::SetCheckOverlapAll ( bool 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 bool 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()

int Select3D_SensitiveGroup::Size ( ) const

overridevirtual

Returns the length of vector of sensitive entities.

Implements Select3D_SensitiveSet.

◆ SubEntity()

const occ::handle< Select3D_SensitiveEntity > & Select3D_SensitiveGroup::SubEntity ( const int theIndex ) const

inline

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

◆ Swap()

void Select3D_SensitiveGroup::Swap	(	const int	theIdx1,
		const int	theIdx2 )

overridevirtual

Swaps items with indexes theIdx1 and theIdx2 in the vector.

Implements Select3D_SensitiveSet.

◆ ToCheckOverlapAll()

bool 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:

Select3D_SensitiveGroup.hxx

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Select3D_SensitiveGroup() [1/2]

◆ Select3D_SensitiveGroup() [2/2]

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ BoundingBox()

◆ Box()

◆ Center()

◆ CenterOfGeometry()

◆ Clear()

◆ distanceToCOG()

◆ DumpJson()

◆ elementIsInside()

◆ Entities()

◆ GetConnected()

◆ IsIn()

◆ LastDetectedEntity()

◆ LastDetectedEntityIndex()

◆ Matches()

◆ MustMatchAll()

◆ NbSubElements()

◆ overlapsElement()

◆ Remove()

◆ Set()

◆ SetCheckOverlapAll()

◆ SetMatchType()

◆ Size()

◆ SubEntity()

◆ Swap()

◆ ToCheckOverlapAll()