Sensitive Entity to make a face selectable. In some cases this class can raise Standard_ConstructionError and Standard_OutOfRange exceptions. For more details see Select3D_SensitivePoly. More...

#include <Select3D_SensitiveFace.hxx>

Inheritance diagram for Select3D_SensitiveFace:

[legend]

Public Member Functions
	Select3D_SensitiveFace (const occ::handle< SelectMgr_EntityOwner > &theOwnerId, const NCollection_Array1< gp_Pnt > &thePoints, const Select3D_TypeOfSensitivity theType)
	Constructs a sensitive face object defined by the owner theOwnerId, the array of points thePoints, and the sensitivity type theType. The array of points is the outer polygon of the geometric face.

	Select3D_SensitiveFace (const occ::handle< SelectMgr_EntityOwner > &theOwnerId, const occ::handle< NCollection_HArray1< gp_Pnt > > &thePoints, const Select3D_TypeOfSensitivity theType)
	Constructs a sensitive face object defined by the owner theOwnerId, the array of points thePoints, and the sensitivity type theType. The array of points is the outer polygon of the geometric face.

occ::handle< NCollection_HArray1< gp_Pnt > >	GetPoints () const
	Returns 3d coordinates of vertices of the face.

void	GetPoints (occ::handle< NCollection_HArray1< gp_Pnt > > &theHArrayOfPnt)
	Initializes the given array theHArrayOfPnt by 3d coordinates of vertices of the face.

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

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.

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

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

void	BVH () override
	Builds BVH tree for the face.

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

int	NbSubElements () const override
	Returns the amount of sub-entities (points or planar convex polygons)

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

Sensitive Entity to make a face selectable. In some cases this class can raise Standard_ConstructionError and Standard_OutOfRange exceptions. For more details see Select3D_SensitivePoly.

Constructor & Destructor Documentation

◆ Select3D_SensitiveFace() [1/2]

Select3D_SensitiveFace::Select3D_SensitiveFace	(	const occ::handle< SelectMgr_EntityOwner > &	theOwnerId,
		const NCollection_Array1< gp_Pnt > &	thePoints,
		const Select3D_TypeOfSensitivity	theType )

Constructs a sensitive face object defined by the owner theOwnerId, the array of points thePoints, and the sensitivity type theType. The array of points is the outer polygon of the geometric face.

◆ Select3D_SensitiveFace() [2/2]

Select3D_SensitiveFace::Select3D_SensitiveFace	(	const occ::handle< SelectMgr_EntityOwner > &	theOwnerId,
		const occ::handle< NCollection_HArray1< gp_Pnt > > &	thePoints,
		const Select3D_TypeOfSensitivity	theType )

Constructs a sensitive face object defined by the owner theOwnerId, the array of points thePoints, and the sensitivity type theType. The array of points is the outer polygon of the geometric face.

Member Function Documentation

◆ BoundingBox()

Select3D_BndBox3d Select3D_SensitiveFace::BoundingBox ( )

overridevirtual

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

Implements Select3D_SensitiveEntity.

◆ BVH()

void Select3D_SensitiveFace::BVH ( )

overridevirtual

Builds BVH tree for the face.

Reimplemented from Select3D_SensitiveEntity.

◆ CenterOfGeometry()

gp_Pnt Select3D_SensitiveFace::CenterOfGeometry ( ) const

overridevirtual

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

Implements Select3D_SensitiveEntity.

◆ DumpJson()

void Select3D_SensitiveFace::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_SensitiveFace::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.

◆ GetPoints() [1/2]

occ::handle< NCollection_HArray1< gp_Pnt > > Select3D_SensitiveFace::GetPoints ( ) const

Returns 3d coordinates of vertices of the face.

Returns: handle to array of 3D vertex coordinates

◆ GetPoints() [2/2]

void Select3D_SensitiveFace::GetPoints ( occ::handle< NCollection_HArray1< gp_Pnt > > & theHArrayOfPnt )

Initializes the given array theHArrayOfPnt by 3d coordinates of vertices of the face.

Deprecated

Use GetPoints() returning handle by value instead.

("Use GetPoints() returning handle by value instead")

◆ Matches()

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

overridevirtual

Checks whether the face overlaps current selecting volume.

Implements Select3D_SensitiveEntity.

◆ NbSubElements()

int Select3D_SensitiveFace::NbSubElements ( ) const

overridevirtual

Returns the amount of sub-entities (points or planar convex polygons)

Implements Select3D_SensitiveEntity.

◆ ToBuildBVH()

bool Select3D_SensitiveFace::ToBuildBVH ( ) const

inlineoverridevirtual

Returns TRUE if BVH tree is in invalidated state.

Reimplemented from Select3D_SensitiveEntity.

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

Select3D_SensitiveFace.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Select3D_SensitiveFace() [1/2]

◆ Select3D_SensitiveFace() [2/2]

Member Function Documentation

◆ BoundingBox()

◆ BVH()

◆ CenterOfGeometry()

◆ DumpJson()

◆ GetConnected()

◆ GetPoints() [1/2]

◆ GetPoints() [2/2]

◆ Matches()

◆ NbSubElements()

◆ ToBuildBVH()