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

Public Member Functions

synchronized void delete ()
 
 GElips ()
 
 GElips (GAx2 A2, double MajorRadius, double MinorRadius)
 
void SetAxis (GAx1 A1)
 
void SetLocation (GPnt P)
 
void SetMajorRadius (double MajorRadius)
 
void SetMinorRadius (double MinorRadius)
 
void SetPosition (GAx2 A2)
 
double Area ()
 
GAx1 Axis ()
 
GAx1 Directrix1 ()
 
GAx1 Directrix2 ()
 
double Eccentricity ()
 
double Focal ()
 
GPnt Focus1 ()
 
GPnt Focus2 ()
 
GPnt Location ()
 
double MajorRadius ()
 
double MinorRadius ()
 
double Parameter ()
 
GAx2 Position ()
 
GAx1 XAxis ()
 
GAx1 YAxis ()
 
void Mirror (GPnt P)
 
GElips Mirrored (GPnt P)
 
void Mirror (GAx1 A1)
 
GElips Mirrored (GAx1 A1)
 
void Mirror (GAx2 A2)
 
GElips Mirrored (GAx2 A2)
 
void Rotate (GAx1 A1, double Ang)
 
GElips Rotated (GAx1 A1, double Ang)
 
void Scale (GPnt P, double S)
 
GElips Scaled (GPnt P, double S)
 
void Transform (GTrsf T)
 
GElips Transformed (GTrsf T)
 
void Translate (GVec V)
 
GElips Translated (GVec V)
 
void Translate (GPnt P1, GPnt P2)
 
GElips Translated (GPnt P1, GPnt P2)
 

Protected Member Functions

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

Static Protected Member Functions

static long getCPtr (GElips obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

Describes an ellipse in 3D space. An ellipse is defined by its major and minor radii 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 ellipse, - its "X Direction" defines the major axis of the ellipse, and - its "Y Direction" defines the minor axis of the ellipse. Together, the origin, "X Direction" and "Y Direction" of this coordinate system define the plane of the ellipse. This coordinate system is the "local coordinate system" of the ellipse. In this coordinate system, the equation of the ellipse is: X*X / (MajorRadius**2) + Y*Y / (MinorRadius**2) = 1.0 The "main Direction" of the local coordinate system gives the normal vector to the plane of the ellipse. This vector gives an implicit orientation to the ellipse (definition of the trigonometric sense). We refer to the "main Axis" of the local coordinate system as the "Axis" of the ellipse. See Also gce_MakeElips which provides functions for more complex ellipse constructions Geom_Ellipse which provides additional functions for constructing ellipses and works, in particular, with the parametric equations of ellipses

Constructor & Destructor Documentation

GElips.GElips ( )

Creates an indefinite ellipse.

GElips.GElips ( GAx2  A2,
double  MajorRadius,
double  MinorRadius 
)

The major radius of the ellipse is on the "XAxis" and the minor radius is on the "YAxis" of the ellipse. The "XAxis" is defined with the "XDirection" of A2 and the "YAxis" is defined with the "YDirection" of A2. Warnings : It is not forbidden to create an ellipse with MajorRadius = MinorRadius. Raises ConstructionError if MajorRadius < MinorRadius or MinorRadius < 0.

Member Function Documentation

double GElips.Area ( )

Computes the area of the Ellipse.

GAx1 GElips.Axis ( )

Computes the axis normal to the plane of the ellipse.

GAx1 GElips.Directrix1 ( )

Computes the first or second directrix of this ellipse. These are the lines, in the plane of the ellipse, normal to the major axis, at a distance equal to MajorRadius/e from the center of the ellipse, where e is the eccentricity of the ellipse. The first directrix (Directrix1) is on the positive side of the major axis. The second directrix (Directrix2) is on the negative side. The directrix is returned as an axis (gp_Ax1 object), the origin of which is situated on the "X Axis" of the local coordinate system of this ellipse. Exceptions Standard_ConstructionError if the eccentricity is null (the ellipse has degenerated into a circle).

GAx1 GElips.Directrix2 ( )

This line is obtained by the symmetrical transformation of "Directrix1" with respect to the "YAxis" of the ellipse. Exceptions Standard_ConstructionError if the eccentricity is null (the ellipse has degenerated into a circle).

double GElips.Eccentricity ( )

Returns the eccentricity of the ellipse between 0.0 and 1.0 If f is the distance between the center of the ellipse and the Focus1 then the eccentricity e = f / MajorRadius. Raises ConstructionError if MajorRadius = 0.0

double GElips.Focal ( )

Computes the focal distance. It is the distance between the two focus focus1 and focus2 of the ellipse.

GPnt GElips.Focus1 ( )

Returns the first focus of the ellipse. This focus is on the positive side of the "XAxis" of the ellipse.

GPnt GElips.Focus2 ( )

Returns the second focus of the ellipse. This focus is on the negative side of the "XAxis" of the ellipse.

GPnt GElips.Location ( )

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

double GElips.MajorRadius ( )

Returns the major radius of the ellipse.

double GElips.MinorRadius ( )

Returns the minor radius of the ellipse.

GElips GElips.Mirrored ( GPnt  P)

Performs the symmetrical transformation of an ellipse with respect to the point P which is the center of the symmetry.

GElips GElips.Mirrored ( GAx1  A1)

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

GElips GElips.Mirrored ( GAx2  A2)

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

double GElips.Parameter ( )

Returns p = (1 - e * e) * MajorRadius where e is the eccentricity of the ellipse. Returns 0 if MajorRadius = 0

GAx2 GElips.Position ( )

Returns the coordinate system of the ellipse.

GElips GElips.Rotated ( GAx1  A1,
double  Ang 
)

Rotates an ellipse. A1 is the axis of the rotation. Ang is the angular value of the rotation in radians.

GElips GElips.Scaled ( GPnt  P,
double  S 
)

Scales an ellipse. S is the scaling value.

void GElips.SetAxis ( GAx1  A1)

Changes the axis normal to the plane of the ellipse. It modifies the definition of this plane. The "XAxis" and the "YAxis" are recomputed. The local coordinate system is redefined so that: - its origin and "main Direction" become those of the axis A1 (the "X Direction" and "Y Direction" are then recomputed in the same way as for any gp_Ax2), or Raises ConstructionError if the direction of A1 is parallel to the direction of the "XAxis" of the ellipse.

void GElips.SetLocation ( GPnt  P)

Modifies this ellipse, by redefining its local coordinate so that its origin becomes P.

void GElips.SetMajorRadius ( double  MajorRadius)

The major radius of the ellipse is on the "XAxis" (major axis) of the ellipse. Raises ConstructionError if MajorRadius < MinorRadius.

void GElips.SetMinorRadius ( double  MinorRadius)

The minor radius of the ellipse is on the "YAxis" (minor axis) of the ellipse. Raises ConstructionError if MinorRadius > MajorRadius or MinorRadius < 0.

void GElips.SetPosition ( GAx2  A2)

Modifies this ellipse, by redefining its local coordinate so that it becomes A2e.

GElips GElips.Transformed ( GTrsf  T)

Transforms an ellipse with the transformation T from class Trsf.

GElips GElips.Translated ( GVec  V)

Translates an ellipse in the direction of the vector V. The magnitude of the translation is the vector's magnitude.

GElips GElips.Translated ( GPnt  P1,
GPnt  P2 
)

Translates an ellipse from the point P1 to the point P2.

GAx1 GElips.XAxis ( )

Returns the "XAxis" of the ellipse whose origin is the center of this ellipse. It is the major axis of the ellipse.

GAx1 GElips.YAxis ( )

Returns the "YAxis" of the ellipse whose unit vector is the "X Direction" or the "Y Direction" of the local coordinate system of this ellipse. This is the minor axis of the ellipse.