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 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 Handle< SelectMgr_EntityOwner > &theOwnerId, const Standard_Real theXMin, const Standard_Real theYMin, const Standard_Real theZMin, const Standard_Real theXMax, const Standard_Real theYMax, const Standard_Real 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.

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

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

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

Bnd_Box	Box () const

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

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

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

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

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

virtual void	Set (const Handle< SelectMgr_EntityOwner > &theOwnerId)
	Sets owner of the entity.

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

void	SetSensitivityFactor (const Standard_Integer 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 Standard_Boolean	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 Handle< Graphic3d_TransformPers > &	TransformPersistence () const
	Return transformation persistence.

virtual void	SetTransformPersistence (const Handle< Graphic3d_TransformPers > &theTrsfPers)
	Set transformation persistence.

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 ()
	Destructor must be virtual.

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

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

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

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.

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

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

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

Protected Attributes inherited from Select3D_SensitiveEntity
Handle< SelectMgr_EntityOwner >	myOwnerId

Handle< Graphic3d_TransformPers >	myTrsfPers

Standard_Integer	mySFactor

Detailed Description

A framework to define selection by a sensitive box.

Constructor & Destructor Documentation

◆ Select3D_SensitiveBox() [1/2]

Select3D_SensitiveBox::Select3D_SensitiveBox	(	const 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 Handle< SelectMgr_EntityOwner > &	theOwnerId,
		const Standard_Real	theXMin,
		const Standard_Real	theYMin,
		const Standard_Real	theZMin,
		const Standard_Real	theXMax,
		const Standard_Real	theYMax,
		const Standard_Real	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()

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

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

virtual void Select3D_SensitiveBox::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = `-1`
	)		const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from Select3D_SensitiveEntity.

◆ GetConnected()

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