Open CASCADE Technology  7.7.0
Public Member Functions | Protected Member Functions | Protected Attributes
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:
Inheritance graph
[legend]

Public Member Functions

 Select3D_SensitiveTriangulation (const Handle< SelectMgr_EntityOwner > &theOwnerId, const Handle< Poly_Triangulation > &theTrg, const TopLoc_Location &theInitLoc, const Standard_Boolean theIsInterior=Standard_True)
 Constructs a sensitive triangulation object defined by the owner theOwnerId, the triangulation theTrg, the location theInitLoc, and the flag theIsInterior. More...
 
 Select3D_SensitiveTriangulation (const Handle< SelectMgr_EntityOwner > &theOwnerId, const Handle< Poly_Triangulation > &theTrg, const TopLoc_Location &theInitLoc, const Handle< TColStd_HArray1OfInteger > &theFreeEdges, const gp_Pnt &theCOG, const Standard_Boolean 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. More...
 
bool LastDetectedTriangle (Poly_Triangle &theTriangle) const
 Get last detected triangle. More...
 
bool LastDetectedTriangle (Poly_Triangle &theTriangle, gp_Pnt theTriNodes[3]) const
 Get last detected triangle. More...
 
Standard_Integer LastDetectedTriangleIndex () const
 Return index of last detected triangle within [1..NbTris] range, or -1 if undefined. More...
 
virtual Standard_Integer NbSubElements () const override
 Returns the amount of nodes in triangulation. More...
 
Handle< Select3D_SensitiveEntityGetConnected () 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. More...
 
const Handle< Poly_Triangulation > & Triangulation () const
 
virtual Standard_Integer Size () const override
 Returns the length of array of triangles or edges. More...
 
virtual Select3D_BndBox3d Box (const Standard_Integer theIdx) const override
 Returns bounding box of triangle/edge with index theIdx. More...
 
virtual Standard_Real Center (const Standard_Integer theIdx, const Standard_Integer theAxis) const override
 Returns geometry center of triangle/edge with index theIdx in array along the given axis theAxis. More...
 
virtual void Swap (const Standard_Integer theIdx1, const Standard_Integer theIdx2) override
 Swaps items with indexes theIdx1 and theIdx2 in array. More...
 
virtual Select3D_BndBox3d BoundingBox () override
 Returns bounding box of the triangulation. If location transformation is set, it will be applied. More...
 
virtual gp_Pnt CenterOfGeometry () const override
 Returns center of triangulation. If location transformation is set, it will be applied. More...
 
virtual Standard_Boolean HasInitLocation () const override
 Returns true if the shape corresponding to the entity has init location. More...
 
virtual 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. More...
 
const TopLoc_LocationGetInitLocation () const
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. More...
 
virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override
 Checks whether one or more entities of the set overlap current selecting volume. More...
 
- Public Member Functions inherited from Select3D_SensitiveSet
 Select3D_SensitiveSet (const Handle< SelectMgr_EntityOwner > &theOwnerId)
 Creates new empty sensitive set and its content. More...
 
virtual 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. More...
 
virtual Standard_Boolean ToBuildBVH () const override
 Returns TRUE if BVH tree is in invalidated state. More...
 
void SetBuilder (const Handle< Select3D_BVHBuilder3d > &theBuilder)
 Sets the method (builder) used to construct BVH. More...
 
void MarkDirty ()
 Marks BVH tree of the set as outdated. It will be rebuild at the next call of BVH() More...
 
virtual void Clear () override
 Destroys cross-reference to avoid memory leak. More...
 
Standard_Integer GetLeafNodeSize () const
 Returns a number of nodes in 1 BVH leaf. More...
 
- Public Member Functions inherited from Select3D_SensitiveEntity
const Handle< SelectMgr_EntityOwner > & OwnerId () const
 Returns pointer to owner of the entity. More...
 
virtual void Set (const Handle< SelectMgr_EntityOwner > &theOwnerId)
 Sets owner of the entity. More...
 
Standard_Integer SensitivityFactor () const
 allows a better sensitivity for a specific entity in selection algorithms useful for small sized entities. More...
 
void SetSensitivityFactor (const Standard_Integer theNewSens)
 Allows to manage sensitivity of a particular sensitive entity. More...
 
const Handle< Graphic3d_TransformPers > & TransformPersistence () const
 Return transformation persistence. More...
 
virtual void SetTransformPersistence (const Handle< Graphic3d_TransformPers > &theTrsfPers)
 Set transformation persistence. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Member Functions

void computeBoundingBox ()
 Compute bounding box. More...
 
Select3D_BndBox3d applyTransformation ()
 Inner function for transformation application to bounding box of the triangulation. More...
 
- Protected Member Functions inherited from Select3D_SensitiveSet
Standard_Boolean matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult, Standard_Boolean theToCheckAllInside)
 Checks whether one or more entities of the set overlap current selecting volume. Implements the traverse of BVH tree built for the set. More...
 
Standard_Boolean processElements (SelectBasics_SelectingVolumeManager &theMgr, Standard_Integer theFirstElem, Standard_Integer theLastElem, Standard_Boolean theIsFullInside, Standard_Boolean theToCheckAllInside, SelectBasics_PickResult &thePickResult, Standard_Integer &theMatchesNb)
 Process elements overlapped by the selection volume. More...
 
- Protected Member Functions inherited from Select3D_SensitiveEntity
 Select3D_SensitiveEntity (const Handle< SelectMgr_EntityOwner > &theOwnerId)
 

Protected Attributes

Handle< Poly_TriangulationmyTriangul
 
TopLoc_Location myInitLocation
 
gp_Pnt myCDG3D
 Center of the whole triangulation. More...
 
Handle< TColStd_HArray1OfInteger > myFreeEdges
 
Standard_Boolean mySensType
 Type of sensitivity: boundary or interior. More...
 
Standard_Integer myPrimitivesNb
 Amount of free edges or triangles depending on sensitivity type. More...
 
Handle< TColStd_HArray1OfInteger > myBVHPrimIndexes
 Indexes of edges or triangles for BVH build. More...
 
Select3D_BndBox3d myBndBox
 Bounding box of the whole triangulation. More...
 
gp_GTrsf myInvInitLocation
 
- Protected Attributes inherited from Select3D_SensitiveSet
BvhPrimitiveSet myContent
 A link between sensitive entity and BVH_PrimitiveSet. More...
 
Standard_Integer myDetectedIdx
 Index of detected primitive in BVH sorted primitive array. More...
 
- Protected Attributes inherited from Select3D_SensitiveEntity
Handle< SelectMgr_EntityOwnermyOwnerId
 
Handle< Graphic3d_TransformPersmyTrsfPers
 
Standard_Integer mySFactor
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Select3D_SensitiveSet
static const Handle< Select3D_BVHBuilder3d > & DefaultBVHBuilder ()
 Return global instance to default BVH builder. More...
 
static void SetDefaultBVHBuilder (const Handle< Select3D_BVHBuilder3d > &theBuilder)
 Assign new BVH builder to be used by default for new sensitive sets (assigning is NOT thread-safe!). More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

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 Handle< SelectMgr_EntityOwner > &  theOwnerId,
const Handle< Poly_Triangulation > &  theTrg,
const TopLoc_Location theInitLoc,
const Standard_Boolean  theIsInterior = Standard_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 Handle< SelectMgr_EntityOwner > &  theOwnerId,
const Handle< Poly_Triangulation > &  theTrg,
const TopLoc_Location theInitLoc,
const Handle< TColStd_HArray1OfInteger > &  theFreeEdges,
const gp_Pnt theCOG,
const Standard_Boolean  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()

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

virtual Select3D_BndBox3d Select3D_SensitiveTriangulation::Box ( const Standard_Integer  theIdx) const
overridevirtual

Returns bounding box of triangle/edge with index theIdx.

Implements Select3D_SensitiveSet.

◆ Center()

virtual Standard_Real Select3D_SensitiveTriangulation::Center ( const Standard_Integer  theIdx,
const Standard_Integer  theAxis 
) const
overridevirtual

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

Implements Select3D_SensitiveSet.

◆ CenterOfGeometry()

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

virtual void Select3D_SensitiveTriangulation::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const
overridevirtual

Dumps the content of me into the stream.

Reimplemented from Select3D_SensitiveSet.

◆ GetConnected()

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

virtual Standard_Boolean Select3D_SensitiveTriangulation::HasInitLocation ( ) const
overridevirtual

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

Reimplemented from Select3D_SensitiveEntity.

◆ InvInitLocation()

virtual 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
theTriangle[out] 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
theTriangle[out] triangle node indexes
theTriNodes[out] triangle nodes (with pre-applied transformation)
Returns
TRUE if defined

◆ LastDetectedTriangleIndex()

Standard_Integer Select3D_SensitiveTriangulation::LastDetectedTriangleIndex ( ) const
inline

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

◆ Matches()

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

virtual Standard_Integer Select3D_SensitiveTriangulation::NbSubElements ( ) const
overridevirtual

Returns the amount of nodes in triangulation.

Implements Select3D_SensitiveEntity.

◆ Size()

virtual Standard_Integer Select3D_SensitiveTriangulation::Size ( ) const
overridevirtual

Returns the length of array of triangles or edges.

Implements Select3D_SensitiveSet.

◆ Swap()

virtual void Select3D_SensitiveTriangulation::Swap ( const Standard_Integer  theIdx1,
const Standard_Integer  theIdx2 
)
overridevirtual

Swaps items with indexes theIdx1 and theIdx2 in array.

Implements Select3D_SensitiveSet.

◆ Triangulation()

const Handle< Poly_Triangulation >& Select3D_SensitiveTriangulation::Triangulation ( ) const
inline

Field Documentation

◆ myBndBox

Select3D_BndBox3d Select3D_SensitiveTriangulation::myBndBox
mutableprotected

Bounding box of the whole triangulation.

◆ myBVHPrimIndexes

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

Handle< TColStd_HArray1OfInteger > Select3D_SensitiveTriangulation::myFreeEdges
protected

◆ myInitLocation

TopLoc_Location Select3D_SensitiveTriangulation::myInitLocation
protected

◆ myInvInitLocation

gp_GTrsf Select3D_SensitiveTriangulation::myInvInitLocation
protected

◆ myPrimitivesNb

Standard_Integer Select3D_SensitiveTriangulation::myPrimitivesNb
protected

Amount of free edges or triangles depending on sensitivity type.

◆ mySensType

Standard_Boolean Select3D_SensitiveTriangulation::mySensType
protected

Type of sensitivity: boundary or interior.

◆ myTriangul

Handle< Poly_Triangulation > Select3D_SensitiveTriangulation::myTriangul
protected

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