A framework to define selection by a sensitive box. More...

#include <Select3D_SensitiveBox.hxx>

Inheritance diagram for Select3D_SensitiveBox:

[legend]

Public Member Functions
	Select3D_SensitiveBox (const occ::handle< SelectMgr_EntityOwner > &theOwnerId, const Bnd_Box &theBox)
	Constructs a sensitive box object defined by the owner theOwnerId, and the box theBox.

	Select3D_SensitiveBox (const occ::handle< SelectMgr_EntityOwner > &theOwnerId, const double theXMin, const double theYMin, const double theZMin, const double theXMax, const double theYMax, const double theZMax)
	Constructs a sensitive box object defined by the owner theOwnerId, and the coordinates theXmin, theYMin, theZMin, theXMax, theYMax, theZMax. theXmin, theYMin and theZMin define the minimum point in the front lower left hand corner of the box, and theXMax, theYMax and theZMax define the maximum point in the back upper right hand corner of the box.

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

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.

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

Bnd_Box	Box () const

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

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

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

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.

virtual void	Set (const occ::handle< SelectMgr_EntityOwner > &theOwnerId)
	Sets 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 void	BVH ()
	Builds BVH tree for a sensitive if needed.

virtual void	Clear ()
	Clears up all resources and memory.

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.

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 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 Member Functions inherited from Select3D_SensitiveEntity
	Select3D_SensitiveEntity (const occ::handle< SelectMgr_EntityOwner > &theOwnerId)

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 by a sensitive box.

Constructor & Destructor Documentation

◆ Select3D_SensitiveBox() [1/2]

Select3D_SensitiveBox::Select3D_SensitiveBox	(	const occ::handle< SelectMgr_EntityOwner > &	theOwnerId,
		const Bnd_Box &	theBox )

Constructs a sensitive box object defined by the owner theOwnerId, and the box theBox.

◆ Select3D_SensitiveBox() [2/2]

Select3D_SensitiveBox::Select3D_SensitiveBox	(	const occ::handle< SelectMgr_EntityOwner > &	theOwnerId,
		const double	theXMin,
		const double	theYMin,
		const double	theZMin,
		const double	theXMax,
		const double	theYMax,
		const double	theZMax )

Constructs a sensitive box object defined by the owner theOwnerId, and the coordinates theXmin, theYMin, theZMin, theXMax, theYMax, theZMax. theXmin, theYMin and theZMin define the minimum point in the front lower left hand corner of the box, and theXMax, theYMax and theZMax define the maximum point in the back upper right hand corner of the box.

Member Function Documentation

◆ BoundingBox()

Select3D_BndBox3d Select3D_SensitiveBox::BoundingBox ( )

overridevirtual

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

Implements Select3D_SensitiveEntity.

◆ Box()

Bnd_Box Select3D_SensitiveBox::Box ( ) const

inline

◆ CenterOfGeometry()

gp_Pnt Select3D_SensitiveBox::CenterOfGeometry ( ) const

overridevirtual

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

Implements Select3D_SensitiveEntity.

◆ DumpJson()

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

overridevirtual

Dumps the content of me into the stream.

Reimplemented from Select3D_SensitiveEntity.

◆ GetConnected()

occ::handle< Select3D_SensitiveEntity > Select3D_SensitiveBox::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.