Select3D_SensitiveTriangulation Class Reference

A framework to define selection of a sensitive entity made of a set of triangles. More...

#include <Select3D_SensitiveTriangulation.hxx>

Inheritance diagram for Select3D_SensitiveTriangulation:

Public Member Functions
	Select3D_SensitiveTriangulation (const occ::handle< SelectMgr_EntityOwner > &theOwnerId, const occ::handle< Poly_Triangulation > &theTrg, const TopLoc_Location &theInitLoc, const bool theIsInterior=true)
	Constructs a sensitive triangulation object defined by the owner theOwnerId, the triangulation theTrg, the location theInitLoc, and the flag theIsInterior.
	Select3D_SensitiveTriangulation (const occ::handle< SelectMgr_EntityOwner > &theOwnerId, const occ::handle< Poly_Triangulation > &theTrg, const TopLoc_Location &theInitLoc, const occ::handle< NCollection_HArray1< int > > &theFreeEdges, const gp_Pnt &theCOG, const bool theIsInterior)
	Constructs a sensitive triangulation object defined by the owner theOwnerId, the triangulation theTrg, the location theInitLoc, the array of free edges theFreeEdges, the center of gravity theCOG, and the flag theIsInterior. As free edges and the center of gravity do not have to be computed later, this syntax reduces computation time.
bool	LastDetectedTriangle (Poly_Triangle &theTriangle) const
	Get last detected triangle.
bool	LastDetectedTriangle (Poly_Triangle &theTriangle, gp_Pnt theTriNodes[3]) const
	Get last detected triangle.
int	LastDetectedTriangleIndex () const
	Return index of last detected triangle within [1..NbTris] range, or -1 if undefined.
int	NbSubElements () const override
	Returns the amount of nodes in triangulation.
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.
const occ::handle< Poly_Triangulation > &	Triangulation () const
int	Size () const override
	Returns the length of array of triangles or edges.
Select3D_BndBox3d	Box (const int theIdx) const override
	Returns bounding box of triangle/edge with index theIdx.
double	Center (const int theIdx, const int theAxis) const override
	Returns geometry center of triangle/edge with index theIdx in array along the given axis theAxis.
void	Swap (const int theIdx1, const int theIdx2) override
	Swaps items with indexes theIdx1 and theIdx2 in array.
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 triangulation. If location transformation is set, it will be applied.
bool	HasInitLocation () const override
	Returns true if the shape corresponding to the entity has init location.
gp_GTrsf	InvInitLocation () const override
	Returns inversed location transformation matrix if the shape corresponding to this entity has init location set. Otherwise, returns identity matrix.
const TopLoc_Location &	GetInitLocation () const
void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
	Dumps the content of me into the stream.
bool	Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override
	Checks whether one or more entities of the set overlap current selecting volume.
Public Member Functions inherited from Select3D_SensitiveSet
	Select3D_SensitiveSet (const occ::handle< SelectMgr_EntityOwner > &theOwnerId)
	Creates new empty sensitive set and its content.
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().
void	Clear () override
	Destroys cross-reference to avoid memory leak.
int	GetLeafNodeSize () const
	Returns a number of nodes in 1 BVH leaf.
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.
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
void	computeBoundingBox ()
	Compute bounding box.
Select3D_BndBox3d	applyTransformation ()
	Inner function for transformation application to bounding box of the triangulation.
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)

Protected Attributes
occ::handle< Poly_Triangulation >	myTriangul
TopLoc_Location	myInitLocation
gp_Pnt	myCDG3D
	Center of the whole triangulation.
occ::handle< NCollection_HArray1< int > >	myFreeEdges
bool	mySensType
	Type of sensitivity: boundary or interior.
int	myPrimitivesNb
	Amount of free edges or triangles depending on sensitivity type.
occ::handle< NCollection_HArray1< int > >	myBVHPrimIndexes
	Indexes of edges or triangles for BVH build.
Select3D_BndBox3d	myBndBox
	Bounding box of the whole triangulation.
gp_GTrsf	myInvInitLocation
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

Additional Inherited Members
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 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.

Detailed Description

A framework to define selection of a sensitive entity made of a set of triangles.

Constructor & Destructor Documentation

Select3D_SensitiveTriangulation() [1/2]

Select3D_SensitiveTriangulation::Select3D_SensitiveTriangulation	(	const occ::handle< SelectMgr_EntityOwner > &	theOwnerId,
		const occ::handle< Poly_Triangulation > &	theTrg,
		const TopLoc_Location &	theInitLoc,
		const bool	theIsInterior = true )

Constructs a sensitive triangulation object defined by the owner theOwnerId, the triangulation theTrg, the location theInitLoc, and the flag theIsInterior.

Select3D_SensitiveTriangulation() [2/2]

Select3D_SensitiveTriangulation::Select3D_SensitiveTriangulation	(	const occ::handle< SelectMgr_EntityOwner > &	theOwnerId,
		const occ::handle< Poly_Triangulation > &	theTrg,
		const TopLoc_Location &	theInitLoc,
		const occ::handle< NCollection_HArray1< int > > &	theFreeEdges,
		const gp_Pnt &	theCOG,
		const bool	theIsInterior )

Constructs a sensitive triangulation object defined by the owner theOwnerId, the triangulation theTrg, the location theInitLoc, the array of free edges theFreeEdges, the center of gravity theCOG, and the flag theIsInterior. As free edges and the center of gravity do not have to be computed later, this syntax reduces computation time.

Member Function Documentation

applyTransformation()

Select3D_BndBox3d Select3D_SensitiveTriangulation::applyTransformation ( )

protected

Inner function for transformation application to bounding box of the triangulation.

BoundingBox()

Select3D_BndBox3d Select3D_SensitiveTriangulation::BoundingBox ( )

overridevirtual

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

Reimplemented from Select3D_SensitiveSet.

Box()

Select3D_BndBox3d Select3D_SensitiveTriangulation::Box ( const int theIdx ) const

overridevirtual

Returns bounding box of triangle/edge with index theIdx.

Implements Select3D_SensitiveSet.

Center()

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

overridevirtual

Returns geometry center of triangle/edge with index theIdx in array along the given axis theAxis.

Implements Select3D_SensitiveSet.

CenterOfGeometry()

gp_Pnt Select3D_SensitiveTriangulation::CenterOfGeometry ( ) const

overridevirtual

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

Reimplemented from Select3D_SensitiveSet.

computeBoundingBox()

void Select3D_SensitiveTriangulation::computeBoundingBox ( )

protected

Compute bounding box.

DumpJson()

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

overridevirtual

Dumps the content of me into the stream.

Reimplemented from Select3D_SensitiveSet.

GetConnected()

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

GetInitLocation()

const TopLoc_Location & Select3D_SensitiveTriangulation::GetInitLocation ( ) const

inline

HasInitLocation()

bool Select3D_SensitiveTriangulation::HasInitLocation ( ) const

overridevirtual

Returns true if the shape corresponding to the entity has init location.

Reimplemented from Select3D_SensitiveEntity.

InvInitLocation()

gp_GTrsf Select3D_SensitiveTriangulation::InvInitLocation ( ) const

overridevirtual

Returns inversed location transformation matrix if the shape corresponding to this entity has init location set. Otherwise, returns identity matrix.

Reimplemented from Select3D_SensitiveEntity.

LastDetectedTriangle() [1/2]

bool Select3D_SensitiveTriangulation::LastDetectedTriangle

(

Poly_Triangle &

theTriangle

)

const

Get last detected triangle.

Parameters

[out]

theTriangle

triangle node indexes

Returns

TRUE if defined

LastDetectedTriangle() [2/2]

bool Select3D_SensitiveTriangulation::LastDetectedTriangle	(	Poly_Triangle &	theTriangle,
		gp_Pnt	theTriNodes[3] ) const

Get last detected triangle.

Parameters

[out]	theTriangle	triangle node indexes
[out]	theTriNodes	triangle nodes (with pre-applied transformation)

Returns

TRUE if defined

LastDetectedTriangleIndex()

int Select3D_SensitiveTriangulation::LastDetectedTriangleIndex ( ) const

inline

Return index of last detected triangle within [1..NbTris] range, or -1 if undefined.

Matches()

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

overridevirtual

Checks whether one or more entities of the set overlap current selecting volume.

Reimplemented from Select3D_SensitiveSet.

NbSubElements()

int Select3D_SensitiveTriangulation::NbSubElements ( ) const

overridevirtual

Returns the amount of nodes in triangulation.

Implements Select3D_SensitiveEntity.

Size()

int Select3D_SensitiveTriangulation::Size ( ) const

overridevirtual

Returns the length of array of triangles or edges.

Implements Select3D_SensitiveSet.

Swap()

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

overridevirtual

Swaps items with indexes theIdx1 and theIdx2 in array.

Implements Select3D_SensitiveSet.

Triangulation()

const occ::handle< Poly_Triangulation > & Select3D_SensitiveTriangulation::Triangulation ( ) const

inline

Field Documentation

myBndBox

Select3D_BndBox3d Select3D_SensitiveTriangulation::myBndBox

mutableprotected

Bounding box of the whole triangulation.

myBVHPrimIndexes

occ::handle<NCollection_HArray1<int> > Select3D_SensitiveTriangulation::myBVHPrimIndexes

protected

Indexes of edges or triangles for BVH build.

myCDG3D

gp_Pnt Select3D_SensitiveTriangulation::myCDG3D

protected

Center of the whole triangulation.

myFreeEdges

occ::handle<NCollection_HArray1<int> > Select3D_SensitiveTriangulation::myFreeEdges

protected

myInitLocation

TopLoc_Location Select3D_SensitiveTriangulation::myInitLocation

protected

myInvInitLocation

gp_GTrsf Select3D_SensitiveTriangulation::myInvInitLocation

protected

myPrimitivesNb

int Select3D_SensitiveTriangulation::myPrimitivesNb

protected

Amount of free edges or triangles depending on sensitivity type.

mySensType

bool Select3D_SensitiveTriangulation::mySensType

protected

Type of sensitivity: boundary or interior.

myTriangul

occ::handle<Poly_Triangulation> Select3D_SensitiveTriangulation::myTriangul

protected

---

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

• Select3D_SensitiveTriangulation.hxx