Sensitive entity covering entire mesh for global selection. More...

#include <MeshVS_CommonSensitiveEntity.hxx>

Inheritance diagram for MeshVS_CommonSensitiveEntity:

[legend]

Public Member Functions
	MeshVS_CommonSensitiveEntity (const occ::handle< SelectMgr_EntityOwner > &theOwner, const occ::handle< MeshVS_Mesh > &theParentMesh, const MeshVS_MeshSelectionMethod theSelMethod)
	Default constructor.

	~MeshVS_CommonSensitiveEntity () override
	Destructor.

int	NbSubElements () const override
	Number of elements.

int	Size () const override
	Returns the amount of sub-entities of the complex entity.

Select3D_BndBox3d	Box (const int theIdx) const override
	Returns bounding box of sub-entity with index theIdx in sub-entity list.

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

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

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

gp_Pnt	CenterOfGeometry () const override
	Returns center of a mesh.

occ::handle< Select3D_SensitiveEntity >	GetConnected () override
	Create a copy.

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.

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

	MeshVS_CommonSensitiveEntity (const MeshVS_CommonSensitiveEntity &theOther)
	Protected copy constructor.

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

Sensitive entity covering entire mesh for global selection.

Constructor & Destructor Documentation

◆ MeshVS_CommonSensitiveEntity() [1/2]

MeshVS_CommonSensitiveEntity::MeshVS_CommonSensitiveEntity	(	const occ::handle< SelectMgr_EntityOwner > &	theOwner,
		const occ::handle< MeshVS_Mesh > &	theParentMesh,
		const MeshVS_MeshSelectionMethod	theSelMethod )

Default constructor.

◆ ~MeshVS_CommonSensitiveEntity()

MeshVS_CommonSensitiveEntity::~MeshVS_CommonSensitiveEntity ( )

override

Destructor.

◆ MeshVS_CommonSensitiveEntity() [2/2]

MeshVS_CommonSensitiveEntity::MeshVS_CommonSensitiveEntity ( const MeshVS_CommonSensitiveEntity & theOther )

protected

Protected copy constructor.

Member Function Documentation

◆ BoundingBox()

Select3D_BndBox3d MeshVS_CommonSensitiveEntity::BoundingBox ( )

overridevirtual

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

Implements Select3D_SensitiveEntity.

◆ Box()

Select3D_BndBox3d MeshVS_CommonSensitiveEntity::Box ( const int theIdx ) const

overridevirtual

Returns bounding box of sub-entity with index theIdx in sub-entity list.

Implements Select3D_SensitiveSet.

◆ Center()

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

overridevirtual

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

Implements Select3D_SensitiveSet.

◆ CenterOfGeometry()

gp_Pnt MeshVS_CommonSensitiveEntity::CenterOfGeometry ( ) const

overridevirtual

Returns center of a mesh.

Implements Select3D_SensitiveEntity.

◆ distanceToCOG()

double MeshVS_CommonSensitiveEntity::distanceToCOG ( SelectBasics_SelectingVolumeManager & theMgr )

overrideprotectedvirtual

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

Implements Select3D_SensitiveSet.

◆ elementIsInside()

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

◆ GetConnected()

occ::handle< Select3D_SensitiveEntity > MeshVS_CommonSensitiveEntity::GetConnected ( )

inlineoverridevirtual

Create a copy.

Reimplemented from Select3D_SensitiveEntity.

◆ NbSubElements()

int MeshVS_CommonSensitiveEntity::NbSubElements ( ) const

overridevirtual

Number of elements.

Implements Select3D_SensitiveEntity.

◆ overlapsElement()

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

◆ Size()

int MeshVS_CommonSensitiveEntity::Size ( ) const

overridevirtual

Returns the amount of sub-entities of the complex entity.

Implements Select3D_SensitiveSet.

◆ Swap()

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

overridevirtual

Swaps items with indexes theIdx1 and theIdx2.

Implements Select3D_SensitiveSet.

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

MeshVS_CommonSensitiveEntity.hxx

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MeshVS_CommonSensitiveEntity() [1/2]

◆ ~MeshVS_CommonSensitiveEntity()

◆ MeshVS_CommonSensitiveEntity() [2/2]

Member Function Documentation

◆ BoundingBox()

◆ Box()

◆ Center()

◆ CenterOfGeometry()

◆ distanceToCOG()

◆ elementIsInside()

◆ GetConnected()

◆ NbSubElements()

◆ overlapsElement()

◆ Size()

◆ Swap()