Open CASCADE Technology  7.4.1.dev
Public Member Functions | Protected Member Functions | Protected Attributes
Select3D_InteriorSensitivePointSet Class Reference

This class handles the selection of arbitrary point set with internal type of sensitivity. The main principle is to split the point set given onto planar convex polygons and search for the overlap with one or more of them through traverse of BVH tree. More...

#include <Select3D_InteriorSensitivePointSet.hxx>

Inheritance diagram for Select3D_InteriorSensitivePointSet:
Inheritance graph
[legend]

Public Member Functions

 Select3D_InteriorSensitivePointSet (const Handle< SelectMgr_EntityOwner > &theOwnerId, const TColgp_Array1OfPnt &thePoints)
 Splits the given point set thePoints onto planar convex polygons. More...
 
virtual void GetPoints (Handle< TColgp_HArray1OfPnt > &theHArrayOfPnt)
 Initializes the given array theHArrayOfPnt by 3d coordinates of vertices of the whole point set. More...
 
virtual Standard_Integer Size () const override
 Returns the length of vector of planar convex polygons. More...
 
virtual Select3D_BndBox3d Box (const Standard_Integer theIdx) const override
 Returns bounding box of planar convex polygon with index theIdx. More...
 
virtual Standard_Real Center (const Standard_Integer theIdx, const Standard_Integer theAxis) const override
 Returns geometry center of planar convex polygon with index theIdx in the vector 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 the vector. More...
 
virtual Select3D_BndBox3d BoundingBox () override
 Returns bounding box of the point set. If location transformation is set, it will be applied. More...
 
virtual gp_Pnt CenterOfGeometry () const override
 Returns center of the point set. If location transformation is set, it will be applied. More...
 
virtual Standard_Integer NbSubElements () const override
 Returns the amount of points in set. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream. 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 Standard_Boolean 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. 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...
 
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...
 
virtual Handle< Select3D_SensitiveEntityGetConnected ()
 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...
 
virtual Standard_Boolean HasInitLocation () const
 Returns true if the shape corresponding to the entity has init location. More...
 
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. 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

virtual Standard_Boolean overlapsElement (SelectBasics_PickResult &thePickResult, SelectBasics_SelectingVolumeManager &theMgr, Standard_Integer theElemIdx, Standard_Boolean theIsFullInside) override
 Checks whether the planar convex polygon with index theIdx in myPlanarPolygons overlaps the current selecting volume. More...
 
virtual Standard_Boolean elementIsInside (SelectBasics_SelectingVolumeManager &theMgr, Standard_Integer theElemIdx, Standard_Boolean theIsFullInside) override
 Checks whether the entity with index theIdx is inside the current selecting volume. More...
 
virtual Standard_Real distanceToCOG (SelectBasics_SelectingVolumeManager &theMgr) override
 Calculates distance from the 3d projection of used-picked screen point to center of the geometry. 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...
 
- Protected Member Functions inherited from Select3D_SensitiveEntity
 Select3D_SensitiveEntity (const Handle< SelectMgr_EntityOwner > &theOwnerId)
 

Protected Attributes

Select3D_VectorOfHPoly myPlanarPolygons
 Vector of planar polygons. More...
 
Handle< TColStd_HArray1OfInteger > myPolygonsIdxs
 Indexes array for BVH calculation. More...
 
gp_Pnt myCOG
 Center of the point set. More...
 
Select3D_BndBox3d myBndBox
 Bounding box of the point set. More...
 
- 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
 
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

This class handles the selection of arbitrary point set with internal type of sensitivity. The main principle is to split the point set given onto planar convex polygons and search for the overlap with one or more of them through traverse of BVH tree.

Constructor & Destructor Documentation

◆ Select3D_InteriorSensitivePointSet()

Select3D_InteriorSensitivePointSet::Select3D_InteriorSensitivePointSet ( const Handle< SelectMgr_EntityOwner > &  theOwnerId,
const TColgp_Array1OfPnt thePoints 
)

Splits the given point set thePoints onto planar convex polygons.

Member Function Documentation

◆ BoundingBox()

virtual Select3D_BndBox3d Select3D_InteriorSensitivePointSet::BoundingBox ( )
overridevirtual

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

Reimplemented from Select3D_SensitiveSet.

◆ Box()

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

Returns bounding box of planar convex polygon with index theIdx.

Implements Select3D_SensitiveSet.

◆ Center()

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

Returns geometry center of planar convex polygon with index theIdx in the vector along the given axis theAxis.

Implements Select3D_SensitiveSet.

◆ CenterOfGeometry()

virtual gp_Pnt Select3D_InteriorSensitivePointSet::CenterOfGeometry ( ) const
overridevirtual

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

Reimplemented from Select3D_SensitiveSet.

◆ distanceToCOG()

virtual Standard_Real Select3D_InteriorSensitivePointSet::distanceToCOG ( SelectBasics_SelectingVolumeManager theMgr)
overrideprotectedvirtual

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

Implements Select3D_SensitiveSet.

◆ DumpJson()

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

Dumps the content of me into the stream.

Reimplemented from Select3D_SensitiveSet.

◆ elementIsInside()

virtual Standard_Boolean Select3D_InteriorSensitivePointSet::elementIsInside ( SelectBasics_SelectingVolumeManager theMgr,
Standard_Integer  theElemIdx,
Standard_Boolean  theIsFullInside 
)
overrideprotectedvirtual

Checks whether the entity with index theIdx is inside the current selecting volume.

Implements Select3D_SensitiveSet.

◆ GetPoints()

virtual void Select3D_InteriorSensitivePointSet::GetPoints ( Handle< TColgp_HArray1OfPnt > &  theHArrayOfPnt)
virtual

Initializes the given array theHArrayOfPnt by 3d coordinates of vertices of the whole point set.

◆ NbSubElements()

virtual Standard_Integer Select3D_InteriorSensitivePointSet::NbSubElements ( ) const
overridevirtual

Returns the amount of points in set.

Implements Select3D_SensitiveEntity.

◆ overlapsElement()

virtual Standard_Boolean Select3D_InteriorSensitivePointSet::overlapsElement ( SelectBasics_PickResult thePickResult,
SelectBasics_SelectingVolumeManager theMgr,
Standard_Integer  theElemIdx,
Standard_Boolean  theIsFullInside 
)
overrideprotectedvirtual

Checks whether the planar convex polygon with index theIdx in myPlanarPolygons overlaps the current selecting volume.

Implements Select3D_SensitiveSet.

◆ Size()

virtual Standard_Integer Select3D_InteriorSensitivePointSet::Size ( ) const
overridevirtual

Returns the length of vector of planar convex polygons.

Implements Select3D_SensitiveSet.

◆ Swap()

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

Swaps items with indexes theIdx1 and theIdx2 in the vector.

Implements Select3D_SensitiveSet.

Field Documentation

◆ myBndBox

Select3D_BndBox3d Select3D_InteriorSensitivePointSet::myBndBox
protected

Bounding box of the point set.

◆ myCOG

gp_Pnt Select3D_InteriorSensitivePointSet::myCOG
protected

Center of the point set.

◆ myPlanarPolygons

Select3D_VectorOfHPoly Select3D_InteriorSensitivePointSet::myPlanarPolygons
protected

Vector of planar polygons.

◆ myPolygonsIdxs

Handle< TColStd_HArray1OfInteger > Select3D_InteriorSensitivePointSet::myPolygonsIdxs
protected

Indexes array for BVH calculation.


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