Open CASCADE Technology 6.6.0
Public Member Functions
Select3D_SensitiveCircle Class Reference

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

#include <Select3D_SensitiveCircle.hxx>

Inheritance diagram for Select3D_SensitiveCircle:
Inheritance graph
[legend]

Public Member Functions

 Select3D_SensitiveCircle (const Handle< SelectBasics_EntityOwner > &OwnerId, const Handle< Geom_Circle > &TheCircle, const Standard_Boolean FilledCircle=Standard_False, 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.

 Select3D_SensitiveCircle (const Handle< SelectBasics_EntityOwner > &OwnerId, const Handle< Geom_Circle > &TheCircle, const Standard_Real u1, const Standard_Real u2, const Standard_Boolean FilledCircle=Standard_False, const Standard_Integer NbOfPoints=6)
 Constructs the sensitive arc object defined by the
owner OwnerId, the circle Circle, the parameters u1
and u2, the Boolean FilledCircle and the number of points NbOfPoints.
u1 and u2 define the first and last points of the arc on Circle.

 Select3D_SensitiveCircle (const Handle< SelectBasics_EntityOwner > &OwnerId, const Handle< TColgp_HArray1OfPnt > &apolyg3d, const Standard_Boolean FilledCircle=Standard_False)
 Constructs the sensitive circle object defined by the
owner OwnerId, the array of triangles apolyg3d, and the Boolean FilledCircle.
apolyg3d is an array of consecutive triangles on the
circle. The triangle i+1 lies on the intersection of the
tangents to the circle of i and i+2. Note, that the first point of apolyg3d
must be equal to the last point of apolyg3d.

 Select3D_SensitiveCircle (const Handle< SelectBasics_EntityOwner > &OwnerId, const TColgp_Array1OfPnt &apolyg3d, const Standard_Boolean FilledCircle=Standard_False)
 Constructs the sensitive circle object defined by the
owner OwnerId, the array of points apolyg3d, and the Boolean FilledCircle.
If the length of apolyg3d is more then 1, the first point of apolyg3d
must be equal to the last point of apolyg3d.

Standard_Boolean Matches (const Standard_Real X, const Standard_Real Y, const Standard_Real aTol, Standard_Real &DMin)
 Matches the coordinates X, Y with the entity found at
that point within the tolerance aTol and the minimum depth DMin.
You must redefine this function for every inheriting entity.
You will have to call this framework inside the redefined function.

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.

virtual Standard_Boolean Matches (const TColgp_Array1OfPnt2d &Polyline, const Bnd_Box2d &aBox, const Standard_Real aTol)
 prevents from hiding virtual methods...

Standard_Real ComputeDepth (const gp_Lin &EyeLine) const
 Returns the depth of this object on the line EyeLine.
EyeLine goes through the eye towards a point
defined by the coordinates X,Y in the function GetEyeLine.
//! gives an abcissa on <aLin> .
<aLin> represents the line going through
the eye towards an X,Y point on the screen. This Method
must return a mean Depth on this line.

void ArrayBounds (Standard_Integer &Low, Standard_Integer &Up) const
gp_Pnt GetPoint3d (const Standard_Integer rank) const
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 ...

virtual
Handle_Select3D_SensitiveEntity 
GetConnected (const TopLoc_Location &theLocation)
 Returns the copy of this.

virtual void Project (const Handle< Select3D_Projector > &aProjector)
 projection of the sensitive primitive in order to
get 2D boxes for the Sort Algorithm


Constructor & Destructor Documentation

Select3D_SensitiveCircle::Select3D_SensitiveCircle ( const Handle< SelectBasics_EntityOwner > &  OwnerId,
const Handle< Geom_Circle > &  TheCircle,
const Standard_Boolean  FilledCircle = Standard_False,
const Standard_Integer  NbOfPoints = 6 
)
Select3D_SensitiveCircle::Select3D_SensitiveCircle ( const Handle< SelectBasics_EntityOwner > &  OwnerId,
const Handle< Geom_Circle > &  TheCircle,
const Standard_Real  u1,
const Standard_Real  u2,
const Standard_Boolean  FilledCircle = Standard_False,
const Standard_Integer  NbOfPoints = 6 
)
Select3D_SensitiveCircle::Select3D_SensitiveCircle ( const Handle< SelectBasics_EntityOwner > &  OwnerId,
const Handle< TColgp_HArray1OfPnt > &  apolyg3d,
const Standard_Boolean  FilledCircle = Standard_False 
)
Select3D_SensitiveCircle::Select3D_SensitiveCircle ( const Handle< SelectBasics_EntityOwner > &  OwnerId,
const TColgp_Array1OfPnt apolyg3d,
const Standard_Boolean  FilledCircle = Standard_False 
)

Member Function Documentation

void Select3D_SensitiveCircle::ArrayBounds ( Standard_Integer Low,
Standard_Integer Up 
) const
Standard_Real Select3D_SensitiveCircle::ComputeDepth ( const gp_Lin EyeLine) const [virtual]
virtual void Select3D_SensitiveCircle::Dump ( Standard_OStream S,
const Standard_Boolean  FullDump = Standard_True 
) const [virtual]

Reimplemented from Select3D_SensitiveEntity.

virtual Handle_Select3D_SensitiveEntity Select3D_SensitiveCircle::GetConnected ( const TopLoc_Location theLocation) [virtual]

Reimplemented from Select3D_SensitiveEntity.

gp_Pnt Select3D_SensitiveCircle::GetPoint3d ( const Standard_Integer  rank) const
Standard_Boolean Select3D_SensitiveCircle::Matches ( const Standard_Real  X,
const Standard_Real  Y,
const Standard_Real  aTol,
Standard_Real DMin 
) [virtual]

Reimplemented from Select3D_SensitiveEntity.

Standard_Boolean Select3D_SensitiveCircle::Matches ( const Standard_Real  XMin,
const Standard_Real  YMin,
const Standard_Real  XMax,
const Standard_Real  YMax,
const Standard_Real  aTol 
) [virtual]

Reimplemented from Select3D_SensitiveEntity.

virtual Standard_Boolean Select3D_SensitiveCircle::Matches ( const TColgp_Array1OfPnt2d Polyline,
const Bnd_Box2d aBox,
const Standard_Real  aTol 
) [virtual]

Reimplemented from Select3D_SensitiveEntity.

virtual void Select3D_SensitiveCircle::Project ( const Handle< Select3D_Projector > &  aProjector) [virtual]

Reimplemented from Select3D_SensitivePoly.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines