AnyCAD Rapid SDK  2020
The Rapid CAD SDK
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
GCirc Class Reference

Public Member Functions

synchronized void delete ()
 
 GCirc ()
 
 GCirc (GAx2 A2, double Radius)
 
void SetAxis (GAx1 A1)
 
void SetLocation (GPnt P)
 
void SetPosition (GAx2 A2)
 
void SetRadius (double Radius)
 
double Area ()
 
GAx1 Axis ()
 
double Length ()
 
GPnt Location ()
 
GAx2 Position ()
 
double Radius ()
 
GAx1 XAxis ()
 
GAx1 YAxis ()
 
double Distance (GPnt P)
 
double SquareDistance (GPnt P)
 
boolean Contains (GPnt P, double LinearTolerance)
 
void Mirror (GPnt P)
 
GCirc Mirrored (GPnt P)
 
void Mirror (GAx1 A1)
 
GCirc Mirrored (GAx1 A1)
 
void Mirror (GAx2 A2)
 
GCirc Mirrored (GAx2 A2)
 
void Rotate (GAx1 A1, double Ang)
 
GCirc Rotated (GAx1 A1, double Ang)
 
void Scale (GPnt P, double S)
 
GCirc Scaled (GPnt P, double S)
 
void Transform (GTrsf T)
 
GCirc Transformed (GTrsf T)
 
void Translate (GVec V)
 
GCirc Translated (GVec V)
 
void Translate (GPnt P1, GPnt P2)
 
GCirc Translated (GPnt P1, GPnt P2)
 

Protected Member Functions

 GCirc (long cPtr, boolean cMemoryOwn)
 
void finalize ()
 

Static Protected Member Functions

static long getCPtr (GCirc obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

Describes a circle in 3D space. A circle is defined by its radius and positioned in space with a coordinate system (a gp_Ax2 object) as follows: - the origin of the coordinate system is the center of the circle, and - the origin, "X Direction" and "Y Direction" of the coordinate system define the plane of the circle. This positioning coordinate system is the "local coordinate system" of the circle. Its "main Direction" gives the normal vector to the plane of the circle. The "main Axis" of the coordinate system is referred to as the "Axis" of the circle. Note: when a gp_Circ circle is converted into a Geom_Circle circle, some implicit properties of the circle are used explicitly: - the "main Direction" of the local coordinate system gives an implicit orientation to the circle (and defines its trigonometric sense), - this orientation corresponds to the direction in which parameter values increase, - the starting point for parameterization is that of the "X Axis" of the local coordinate system (i.e. the "X Axis" of the circle). See Also gce_MakeCirc which provides functions for more complex circle constructions Geom_Circle which provides additional functions for constructing circles and works, in particular, with the parametric equations of circles

Constructor & Destructor Documentation

GCirc.GCirc ( )

Creates an indefinite circle.

GCirc.GCirc ( GAx2  A2,
double  Radius 
)

A2 locates the circle and gives its orientation in 3D space. Warnings : It is not forbidden to create a circle with Radius = 0.0 Raises ConstructionError if Radius < 0.0

Member Function Documentation

double GCirc.Area ( )

Computes the area of the circle.

GAx1 GCirc.Axis ( )

Returns the main axis of the circle. It is the axis perpendicular to the plane of the circle, passing through the "Location" point (center) of the circle.

boolean GCirc.Contains ( GPnt  P,
double  LinearTolerance 
)

Returns True if the point P is on the circumference. The distance between <me> and

must be lower or equal to LinearTolerance.

double GCirc.Distance ( GPnt  P)

Computes the minimum of distance between the point P and any point on the circumference of the circle.

double GCirc.Length ( )

Computes the circumference of the circle.

GPnt GCirc.Location ( )

Returns the center of the circle. It is the "Location" point of the local coordinate system of the circle

GCirc GCirc.Mirrored ( GPnt  P)

Performs the symmetrical transformation of a circle with respect to the point P which is the center of the symmetry.

GCirc GCirc.Mirrored ( GAx1  A1)

Performs the symmetrical transformation of a circle with respect to an axis placement which is the axis of the symmetry.

GCirc GCirc.Mirrored ( GAx2  A2)

Performs the symmetrical transformation of a circle with respect to a plane. The axis placement A2 locates the plane of the of the symmetry : (Location, XDirection, YDirection).

GAx2 GCirc.Position ( )

Returns the position of the circle. It is the local coordinate system of the circle.

double GCirc.Radius ( )

Returns the radius of this circle.

GCirc GCirc.Rotated ( GAx1  A1,
double  Ang 
)

Rotates a circle. A1 is the axis of the rotation. Ang is the angular value of the rotation in radians.

GCirc GCirc.Scaled ( GPnt  P,
double  S 
)

Scales a circle. S is the scaling value. Warnings : If S is negative the radius stay positive but the "XAxis" and the "YAxis" are reversed as for an ellipse.

void GCirc.SetAxis ( GAx1  A1)

Changes the main axis of the circle. It is the axis perpendicular to the plane of the circle. Raises ConstructionError if the direction of A1 is parallel to the "XAxis" of the circle.

void GCirc.SetLocation ( GPnt  P)

Changes the "Location" point (center) of the circle.

void GCirc.SetPosition ( GAx2  A2)

Changes the position of the circle.

void GCirc.SetRadius ( double  Radius)

Modifies the radius of this circle. Warning. This class does not prevent the creation of a circle where Radius is null. Exceptions Standard_ConstructionError if Radius is negative.

double GCirc.SquareDistance ( GPnt  P)

Computes the square distance between <me> and the point P.

GCirc GCirc.Transformed ( GTrsf  T)

Transforms a circle with the transformation T from class Trsf.

GCirc GCirc.Translated ( GVec  V)

Translates a circle in the direction of the vector V. The magnitude of the translation is the vector's magnitude.

GCirc GCirc.Translated ( GPnt  P1,
GPnt  P2 
)

Translates a circle from the point P1 to the point P2.

GAx1 GCirc.XAxis ( )

Returns the "XAxis" of the circle. This axis is perpendicular to the axis of the conic. This axis and the "Yaxis" define the plane of the conic.

GAx1 GCirc.YAxis ( )

Returns the "YAxis" of the circle. This axis and the "Xaxis" define the plane of the conic. The "YAxis" is perpendicular to the "Xaxis".