# Visualization
TKV3d
Select3D

# Select3D_SensitiveCircle Class Reference

A framework to define sensitive 3D arcs and circles.
.

`#include <Select3D_SensitiveCircle.hxx>`

Inheritance diagram for Select3D_SensitiveCircle:

[legend]

## Public Member Functions

Standard_EXPORT | 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. .
Standard_EXPORT | 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. .
Standard_EXPORT | 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. .
Standard_EXPORT | 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. .
Standard_EXPORT 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_EXPORT 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_EXPORT Standard_Boolean | Matches (const TColgp_Array1OfPnt2d &Polyline, const Bnd_Box2d &aBox, const Standard_Real aTol)
| prevents from hiding virtual methods...
Standard_EXPORT 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. .
Standard_EXPORT void | ArrayBounds (Standard_Integer &Low, Standard_Integer &Up) const
Standard_EXPORT gp_Pnt | GetPoint3d (const Standard_Integer rank) const
virtual Standard_EXPORT void | Dump (Standard_OStream &S, const Standard_Boolean FullDump=Standard_True) const
| 2 options : <fulldump> = False -> general information <fulldump> = True -> whole informtion 3D +2d ...
Standard_EXPORT const | Handle (Standard_Type)&DynamicType() const

## Private Attributes

Standard_Boolean | myFillStatus
Standard_Integer | myDetectedIndex

## Constructor & Destructor Documentation

Standard_EXPORT 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`
| ) |

Standard_EXPORT 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`
| ) |

Standard_EXPORT Select3D_SensitiveCircle::Select3D_SensitiveCircle | ( | const Handle(SelectBasics_EntityOwner)& | OwnerId,
|  | const Handle(TColgp_HArray1OfPnt)& | apolyg3d,
|  | const Standard_Boolean | FilledCircle = `Standard_False`
| ) |

Standard_EXPORT Select3D_SensitiveCircle::Select3D_SensitiveCircle | ( | const Handle(SelectBasics_EntityOwner)& | OwnerId,
|  | const TColgp_Array1OfPnt & | apolyg3d,
|  | const Standard_Boolean | FilledCircle = `Standard_False`
| ) |

## Member Function Documentation

Standard_EXPORT void Select3D_SensitiveCircle::ArrayBounds | ( | Standard_Integer & | Low,
|  | Standard_Integer & | Up
| ) | const

Standard_EXPORT Standard_Real Select3D_SensitiveCircle::ComputeDepth | ( | const gp_Lin & | EyeLine | ) | const`[virtual]`

| Implements Select3D_SensitiveEntity.

virtual Standard_EXPORT void Select3D_SensitiveCircle::Dump | ( | Standard_OStream & | S,
|  | const Standard_Boolean | FullDump = `Standard_True`
| ) | const`[virtual]`

| Reimplemented from Select3D_SensitiveEntity.

Standard_EXPORT gp_Pnt Select3D_SensitiveCircle::GetPoint3d | ( | const Standard_Integer | rank | ) | const

Standard_EXPORT const Select3D_SensitiveCircle::Handle | ( | Standard_Type |  | ) | const

| Reimplemented from Select3D_SensitivePoly.

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

| Reimplemented from Select3D_SensitiveEntity.

Standard_EXPORT 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.

Standard_EXPORT 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.

## Field Documentation

Standard_Integer Select3D_SensitiveCircle::myDetectedIndex `[private]`

Standard_Boolean Select3D_SensitiveCircle::myFillStatus `[private]`

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

- Select3D_SensitiveCircle.hxx