Open CASCADE Technology  6.8.0
Public Member Functions | Protected 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

virtual void Project (const Handle< Select3D_Projector > &aProjector)
 projection of the sensitive primitive in order to get 2D boxes for the Sort Algorithm More...
 
void Areas (SelectBasics_ListOfBox2d &boxes)
 stores in <boxes> the 2D Boxes which represent the sensitive face in the selection algorithm. More...
 
void Points3D (Handle< TColgp_HArray1OfPnt > &theHArrayOfPnt)
 Returns the 3D points of the array used at construction time. More...
 
void Points2D (TColgp_Array1OfPnt2d &theArrayOfPnt2d)
 Returns the 2D points of the array used at construction time. More...
 
- Public Member Functions inherited from Select3D_SensitiveEntity
Standard_Boolean NeedsConversion () const
 Returns true if this framework needs conversion. More...
 
Standard_Boolean Is3D () const
 Returns true if this framework provides 3D information. More...
 
virtual Standard_Integer MaxBoxes () const
 Returns the max number of sensitive areas returned by this class is 1 by default. Else on must redefine this method. More...
 
virtual Handle
< Select3D_SensitiveEntity
GetConnected (const TopLoc_Location &aLocation)
 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...
 
virtual Standard_Boolean Matches (const Standard_Real XMin, const Standard_Real YMin, const Standard_Real XMax, const Standard_Real YMax, const Standard_Real aTol)
 Matches the box defined by the coordinates Xmin, Ymin, Xmax, Ymax with the entity found at that point within the tolerance aTol. Xmin, YMin define the minimum point in the lower left hand corner of the box, and XMax, YMax define the maximum point in the upper right hand corner of the box. You must redefine this function for every inheriting entity. You will have to call this framework inside the redefined function. More...
 
virtual Standard_Boolean Matches (const TColgp_Array1OfPnt2d &Polyline, const Bnd_Box2d &aBox, const Standard_Real aTol)
 prevents from hiding virtual methods... More...
 
virtual Standard_Boolean HasLocation () const
 Returns true if this framework has a location defined. More...
 
virtual const TopLoc_Location Location () const
 
virtual void ResetLocation ()
 sets the location to Identity More...
 
virtual void SetLocation (const TopLoc_Location &aLoc)
 
virtual void Dump (Standard_OStream &S, const Standard_Boolean FullDump=Standard_True) const
 2 options : <FullDump> = False -> general information <FullDump> = True -> whole informtion 3D +2d ... More...
 
void UpdateLocation (const TopLoc_Location &aLoc)
 
- Public Member Functions inherited from SelectBasics_SensitiveEntity
virtual void Set (const Handle< SelectBasics_EntityOwner > &TheOwnerId)
 
const Handle
< SelectBasics_EntityOwner > & 
OwnerId () const
 
virtual Standard_Boolean Matches (const SelectBasics_PickArgs &thePickArgs, Standard_Real &theMatchDMin, Standard_Real &theMatchDepth)=0
 Checks whether the sensitive entity matches the picking detection area (close to the picking line). This method takes into account depth limits produced by abstract view: far/near planes, clippings. Please port existing implementations of your picking detection, which were done at Matches (X, Y, Tol, DMin) method to this one, introducing the depth checks. Please note that the previous method is suppressed and the virtual implementations are not used by OCC selection framework. The porting procedure for simple sensitives (or if you are not interested in implementing full scale depth checks) can be simplified to writing the following code snippet: More...
 
void SetSensitivityFactor (const Standard_ShortReal aFactor)
 
Standard_ShortReal 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 Member Functions

 Select3D_SensitivePoly (const Handle< SelectBasics_EntityOwner > &OwnerId, const TColgp_Array1OfPnt &ThePoints)
 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 > &OwnerId, const Handle< TColgp_HArray1OfPnt > &ThePoints)
 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 > &OwnerId, const Standard_Integer NbOfPoints=6)
 Constructs the sensitive circle object defined by the owner OwnerId, the circle Circle, the Boolean FilledCircle and the number of points NbOfPoints. More...
 
- Protected Member Functions inherited from Select3D_SensitiveEntity
 Select3D_SensitiveEntity (const Handle< SelectBasics_EntityOwner > &OwnerId)
 
- Protected Member Functions inherited from SelectBasics_SensitiveEntity
 SelectBasics_SensitiveEntity (const Handle< SelectBasics_EntityOwner > &OwnerId, const Standard_ShortReal aSensitivityFactor=1)
 

Protected Attributes

Select3D_Box2d mybox2d
 
Select3D_PointData mypolyg
 
- Protected Attributes inherited from SelectBasics_SensitiveEntity
Handle< SelectBasics_EntityOwnermyOwnerId
 

Additional Inherited Members

- Static Public Member Functions inherited from Select3D_SensitiveEntity
static void DumpBox (Standard_OStream &S, const Bnd_Box2d &abox)
 

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 > &  OwnerId,
const TColgp_Array1OfPnt ThePoints 
)
protected

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 > &  OwnerId,
const Handle< TColgp_HArray1OfPnt > &  ThePoints 
)
protected

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 > &  OwnerId,
const Standard_Integer  NbOfPoints = 6 
)
protected

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

void Select3D_SensitivePoly::Areas ( SelectBasics_ListOfBox2d boxes)
virtual

stores in <boxes> the 2D Boxes which represent the sensitive face in the selection algorithm.

Implements SelectBasics_SensitiveEntity.

void Select3D_SensitivePoly::Points2D ( TColgp_Array1OfPnt2d theArrayOfPnt2d)

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

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

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

virtual void Select3D_SensitivePoly::Project ( const Handle< Select3D_Projector > &  aProjector)
virtual

projection of the sensitive primitive in order to get 2D boxes for the Sort Algorithm

Implements Select3D_SensitiveEntity.

Reimplemented in Select3D_SensitiveCircle, and MeshVS_SensitiveFace.

Field Documentation

Select3D_Box2d Select3D_SensitivePoly::mybox2d
protected
Select3D_PointData Select3D_SensitivePoly::mypolyg
protected

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