Open CASCADE Technology  6.8.0
Public Member Functions | Protected Member Functions
Select3D_SensitiveCurve Class Reference

A framework to define a sensitive 3D curve. In some cases this class can raise Standard_ConstructionError and Standard_OutOfRange exceptions. For more details see Select3D_SensitivePoly. More...

#include <Select3D_SensitiveCurve.hxx>

Inheritance diagram for Select3D_SensitiveCurve:
Inheritance graph
[legend]

Public Member Functions

 Select3D_SensitiveCurve (const Handle< SelectBasics_EntityOwner > &OwnerId, const Handle< Geom_Curve > &TheCurve, const Standard_Integer MaxPoints=17)
 Constructs a sensitive curve object defined by the owner OwnerId, the curve TheCurve, and the maximum number of points on the curve: MaxPoints. More...
 
 Select3D_SensitiveCurve (const Handle< SelectBasics_EntityOwner > &OwnerId, const Handle< TColgp_HArray1OfPnt > &ThePoints)
 Constructs a sensitive curve object defined by the owner OwnerId and the set of points ThePoints. More...
 
 Select3D_SensitiveCurve (const Handle< SelectBasics_EntityOwner > &OwnerId, const TColgp_Array1OfPnt &ThePoints)
 Creation of Sensitive Curve from Points. Warning : This Method should disappear in the next version... More...
 
Standard_Boolean Matches (const SelectBasics_PickArgs &thePickArgs, Standard_Real &theMatchDMin, Standard_Real &theMatchDepth)
 Checks whether the sensitive entity matches the picking detection area (close to the picking line). For details please refer to base class declaration. More...
 
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...
 
Standard_Real ComputeDepth (const gp_Lin &thePickLine, const Standard_Integer theDetectedIndex) const
 Compute depth of sensitive circle for the detected sub-part. More...
 
Standard_Integer GetLastDetected () const
 Gets index of last detected segment. More...
 
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...
 
virtual Handle
< Select3D_SensitiveEntity
GetConnected (const TopLoc_Location &theLocation)
 Returns the copy of this. More...
 
- Public Member Functions inherited from Select3D_SensitivePoly
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 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)
 
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
 
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

Standard_Boolean ComputeDepth (const gp_Lin &thePickLine, const gp_XYZ &theP1, const gp_XYZ &theP2, Standard_Real &theDepth) const
 Computes the depth by means of intersection of a segment of the curve defined by <theP1, theP2> and the eye-line <thePickLine>. More...
 
- Protected Member Functions inherited from Select3D_SensitivePoly
 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)
 

Additional Inherited Members

- Static Public Member Functions inherited from Select3D_SensitiveEntity
static void DumpBox (Standard_OStream &S, const Bnd_Box2d &abox)
 
- Protected Attributes inherited from Select3D_SensitivePoly
Select3D_Box2d mybox2d
 
Select3D_PointData mypolyg
 
- Protected Attributes inherited from SelectBasics_SensitiveEntity
Handle< SelectBasics_EntityOwnermyOwnerId
 

Detailed Description

A framework to define a sensitive 3D curve. In some cases this class can raise Standard_ConstructionError and Standard_OutOfRange exceptions. For more details see Select3D_SensitivePoly.

Constructor & Destructor Documentation

Select3D_SensitiveCurve::Select3D_SensitiveCurve ( const Handle< SelectBasics_EntityOwner > &  OwnerId,
const Handle< Geom_Curve > &  TheCurve,
const Standard_Integer  MaxPoints = 17 
)

Constructs a sensitive curve object defined by the owner OwnerId, the curve TheCurve, and the maximum number of points on the curve: MaxPoints.

Select3D_SensitiveCurve::Select3D_SensitiveCurve ( const Handle< SelectBasics_EntityOwner > &  OwnerId,
const Handle< TColgp_HArray1OfPnt > &  ThePoints 
)

Constructs a sensitive curve object defined by the owner OwnerId and the set of points ThePoints.

Select3D_SensitiveCurve::Select3D_SensitiveCurve ( const Handle< SelectBasics_EntityOwner > &  OwnerId,
const TColgp_Array1OfPnt ThePoints 
)

Creation of Sensitive Curve from Points. Warning : This Method should disappear in the next version...

Member Function Documentation

Standard_Real Select3D_SensitiveCurve::ComputeDepth ( const gp_Lin thePickLine,
const Standard_Integer  theDetectedIndex 
) const

Compute depth of sensitive circle for the detected sub-part.

Parameters
thePickLine[in] the picking line.
theDetectedIndex[in] index of the detected sub-part.
Returns
depth on the picking line.
Standard_Boolean Select3D_SensitiveCurve::ComputeDepth ( const gp_Lin thePickLine,
const gp_XYZ theP1,
const gp_XYZ theP2,
Standard_Real theDepth 
) const
protected

Computes the depth by means of intersection of a segment of the curve defined by <theP1, theP2> and the eye-line <thePickLine>.

virtual void Select3D_SensitiveCurve::Dump ( Standard_OStream S,
const Standard_Boolean  FullDump = Standard_True 
) const
virtual

2 options : <FullDump> = False -> general information <FullDump> = True -> whole informtion 3D +2d ...

Reimplemented from Select3D_SensitiveEntity.

virtual Handle< Select3D_SensitiveEntity > Select3D_SensitiveCurve::GetConnected ( const TopLoc_Location theLocation)
virtual

Returns the copy of this.

Reimplemented from Select3D_SensitiveEntity.

Standard_Integer Select3D_SensitiveCurve::GetLastDetected ( ) const

Gets index of last detected segment.

Standard_Boolean Select3D_SensitiveCurve::Matches ( const SelectBasics_PickArgs thePickArgs,
Standard_Real theMatchDMin,
Standard_Real theMatchDepth 
)
virtual

Checks whether the sensitive entity matches the picking detection area (close to the picking line). For details please refer to base class declaration.

Implements SelectBasics_SensitiveEntity.

Standard_Boolean Select3D_SensitiveCurve::Matches ( const Standard_Real  XMin,
const Standard_Real  YMin,
const Standard_Real  XMax,
const Standard_Real  YMax,
const Standard_Real  aTol 
)
virtual

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.

Reimplemented from Select3D_SensitiveEntity.

virtual Standard_Boolean Select3D_SensitiveCurve::Matches ( const TColgp_Array1OfPnt2d Polyline,
const Bnd_Box2d aBox,
const Standard_Real  aTol 
)
virtual

prevents from hiding virtual methods...

Reimplemented from Select3D_SensitiveEntity.


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