Open CASCADE Technology  6.9.0
Public Member Functions | Protected Attributes

Select3D_SensitivePoly Class Reference

Sensitive Entity to make a face selectable. In some cases this class can raise Standard_ConstructionError and Standard_OutOfRange exceptions from its member Select3D_PointData myPolyg. More...

#include <Select3D_SensitivePoly.hxx>

Inheritance diagram for Select3D_SensitivePoly:
Inheritance graph
[legend]

Public Member Functions

 Select3D_SensitivePoly (const Handle< SelectBasics_EntityOwner > &theOwnerId, const TColgp_Array1OfPnt &thePoints, const Standard_Boolean theIsBVHEnabled)
 Constructs a sensitive face object defined by the owner OwnerId, the array of points ThePoints, and the sensitivity type Sensitivity. The array of points is the outer polygon of the geometric face. More...
 
 Select3D_SensitivePoly (const Handle< SelectBasics_EntityOwner > &theOwnerId, const Handle< TColgp_HArray1OfPnt > &thePoints, const Standard_Boolean theIsBVHEnabled)
 Constructs a sensitive face object defined by the owner OwnerId, the array of points ThePoints, and the sensitivity type Sensitivity. The array of points is the outer polygon of the geometric face. More...
 
 Select3D_SensitivePoly (const Handle< SelectBasics_EntityOwner > &theOwnerId, const Standard_Boolean theIsBVHEnabled, const Standard_Integer theNbPnts=6)
 Constructs the sensitive circle object defined by the owner OwnerId, the circle Circle, the Boolean FilledCircle and the number of points NbOfPoints. More...
 
virtual Standard_Integer NbSubElements () Standard_OVERRIDE
 Returns the amount of segments in poly. More...
 
void Points3D (Handle< TColgp_HArray1OfPnt > &theHArrayOfPnt)
 Returns the 3D points of the array used at construction time. More...
 
virtual Select3D_BndBox3d BoundingBox () Standard_OVERRIDE
 Returns bounding box of a polygon. If location transformation is set, it will be applied. More...
 
virtual gp_Pnt CenterOfGeometry () const Standard_OVERRIDE
 Returns center of the point set. If location transformation is set, it will be applied. More...
 
virtual Standard_Integer Size () const Standard_OVERRIDE
 Returns the amount of segments of the poly. More...
 
virtual Select3D_BndBox3d Box (const Standard_Integer theIdx) const Standard_OVERRIDE
 Returns bounding box of segment with index theIdx. More...
 
virtual Standard_Real Center (const Standard_Integer theIdx, const Standard_Integer theAxis) const Standard_OVERRIDE
 Returns geometry center of sensitive entity index theIdx in the vector along the given axis theAxis. More...
 
virtual void Swap (const Standard_Integer theIdx1, const Standard_Integer theIdx2) Standard_OVERRIDE
 Swaps items with indexes theIdx1 and theIdx2 in the vector. More...
 
- Public Member Functions inherited from Select3D_SensitiveSet
 Select3D_SensitiveSet (const Handle< SelectBasics_EntityOwner > &theOwnerId)
 Creates new empty sensitive set and its content. More...
 
 ~Select3D_SensitiveSet ()
 
virtual Standard_Boolean Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) Standard_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...
 
void BVH ()
 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 MarkDirty ()
 Marks BVH tree of the set as outdated. It will be rebuild at the next call of BVH() More...
 
virtual void Clear () Standard_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
virtual Handle
< Select3D_SensitiveEntity
GetConnected ()
 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.//can be connected to another sensitive entity. More...
 
- Public Member Functions inherited from SelectBasics_SensitiveEntity
virtual void Set (const Handle< SelectBasics_EntityOwner > &theOwnerId)
 Sets owner of the entity. More...
 
const Handle
< SelectBasics_EntityOwner > & 
OwnerId () const
 Returns pointer to owner of the entity. More...
 
Standard_Real SensitivityFactor () const
 allows a better sensitivity for a specific entity in selection algorithms useful for small sized entities. More...
 
- Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
 Memory deallocator for transient classes. 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 const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object. More...
 
Standard_Boolean IsInstance (const 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 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...
 
virtual Handle_Standard_Transient This () const
 Returns a Handle which references this object. Must never be called to objects created in stack. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 

Protected Attributes

Select3D_PointData myPolyg
 Points of the poly. More...
 
gp_Pnt myCOG
 Center of the poly. More...
 
Handle_TColStd_HArray1OfInteger mySegmentIndexes
 Segment indexes for BVH tree build. More...
 
Select3D_BndBox3d myBndBox
 Bounding box of the poly. More...
 
Standard_Boolean myIsComputed
 Is true if all the points and data structures of polygon are initialized. More...
 
- Protected Attributes inherited from Select3D_SensitiveSet
Standard_Integer myDetectedIdx
 Index of detected primitive in BVH sorted primitive array, for debug purposes. More...
 
- Protected Attributes inherited from SelectBasics_SensitiveEntity
Handle< SelectBasics_EntityOwnermyOwnerId
 

Additional Inherited Members

- Protected Member Functions inherited from Select3D_SensitiveEntity
 Select3D_SensitiveEntity (const Handle< SelectBasics_EntityOwner > &theOwnerId)
 
- Protected Member Functions inherited from SelectBasics_SensitiveEntity
 SelectBasics_SensitiveEntity (const Handle< SelectBasics_EntityOwner > &theOwnerId, const Standard_Real theSensFactor=2.0)
 
void SetSensitivityFactor (const Standard_Real theSensFactor)
 Allows to manage the sensitivity of the entity. More...
 

Detailed Description

Sensitive Entity to make a face selectable. In some cases this class can raise Standard_ConstructionError and Standard_OutOfRange exceptions from its member Select3D_PointData myPolyg.

Constructor & Destructor Documentation

Select3D_SensitivePoly::Select3D_SensitivePoly ( const Handle< SelectBasics_EntityOwner > &  theOwnerId,
const TColgp_Array1OfPnt thePoints,
const Standard_Boolean  theIsBVHEnabled 
)

Constructs a sensitive face object defined by the owner OwnerId, the array of points ThePoints, and the sensitivity type Sensitivity. The array of points is the outer polygon of the geometric face.

Select3D_SensitivePoly::Select3D_SensitivePoly ( const Handle< SelectBasics_EntityOwner > &  theOwnerId,
const Handle< TColgp_HArray1OfPnt > &  thePoints,
const Standard_Boolean  theIsBVHEnabled 
)

Constructs a sensitive face object defined by the owner OwnerId, the array of points ThePoints, and the sensitivity type Sensitivity. The array of points is the outer polygon of the geometric face.

Select3D_SensitivePoly::Select3D_SensitivePoly ( const Handle< SelectBasics_EntityOwner > &  theOwnerId,
const Standard_Boolean  theIsBVHEnabled,
const Standard_Integer  theNbPnts = 6 
)

Constructs the sensitive circle object defined by the owner OwnerId, the circle Circle, the Boolean FilledCircle and the number of points NbOfPoints.

Member Function Documentation

virtual Select3D_BndBox3d Select3D_SensitivePoly::BoundingBox ( )
virtual

Returns bounding box of a polygon. If location transformation is set, it will be applied.

Reimplemented from Select3D_SensitiveSet.

virtual Select3D_BndBox3d Select3D_SensitivePoly::Box ( const Standard_Integer  theIdx) const
virtual

Returns bounding box of segment with index theIdx.

Implements Select3D_SensitiveSet.

virtual Standard_Real Select3D_SensitivePoly::Center ( const Standard_Integer  theIdx,
const Standard_Integer  theAxis 
) const
virtual

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

Implements Select3D_SensitiveSet.

virtual gp_Pnt Select3D_SensitivePoly::CenterOfGeometry ( ) const
virtual

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

Reimplemented from Select3D_SensitiveSet.

Reimplemented in Select3D_SensitiveCircle.

virtual Standard_Integer Select3D_SensitivePoly::NbSubElements ( )
virtual

Returns the amount of segments in poly.

Implements Select3D_SensitiveEntity.

void Select3D_SensitivePoly::Points3D ( Handle< TColgp_HArray1OfPnt > &  theHArrayOfPnt)

Returns the 3D points of the array used at construction time.

virtual Standard_Integer Select3D_SensitivePoly::Size ( ) const
virtual

Returns the amount of segments of the poly.

Implements Select3D_SensitiveSet.

virtual void Select3D_SensitivePoly::Swap ( const Standard_Integer  theIdx1,
const Standard_Integer  theIdx2 
)
virtual

Swaps items with indexes theIdx1 and theIdx2 in the vector.

Implements Select3D_SensitiveSet.

Field Documentation

Select3D_BndBox3d Select3D_SensitivePoly::myBndBox
protected

Bounding box of the poly.

gp_Pnt Select3D_SensitivePoly::myCOG
mutableprotected

Center of the poly.

Standard_Boolean Select3D_SensitivePoly::myIsComputed
mutableprotected

Is true if all the points and data structures of polygon are initialized.

Select3D_PointData Select3D_SensitivePoly::myPolyg
protected

Points of the poly.

Handle_TColStd_HArray1OfInteger Select3D_SensitivePoly::mySegmentIndexes
protected

Segment indexes for BVH tree build.


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