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

Public Member Functions

synchronized void delete ()
 
 GTorus ()
 
 GTorus (GAx3 A3, double MajorRadius, double MinorRadius)
 
void SetAxis (GAx1 A1)
 
void SetLocation (GPnt Loc)
 
void SetMajorRadius (double MajorRadius)
 
void SetMinorRadius (double MinorRadius)
 
void SetPosition (GAx3 A3)
 
double Area ()
 
void UReverse ()
 
void VReverse ()
 
boolean Direct ()
 
GAx1 Axis ()
 
GPnt Location ()
 
GAx3 Position ()
 
double MajorRadius ()
 
double MinorRadius ()
 
double Volume ()
 
GAx1 XAxis ()
 
GAx1 YAxis ()
 
void Mirror (GPnt P)
 
GTorus Mirrored (GPnt P)
 
void Mirror (GAx1 A1)
 
GTorus Mirrored (GAx1 A1)
 
void Mirror (GAx2 A2)
 
GTorus Mirrored (GAx2 A2)
 
void Rotate (GAx1 A1, double Ang)
 
GTorus Rotated (GAx1 A1, double Ang)
 
void Scale (GPnt P, double S)
 
GTorus Scaled (GPnt P, double S)
 
void Transform (GTrsf T)
 
GTorus Transformed (GTrsf T)
 
void Translate (GVec V)
 
GTorus Translated (GVec V)
 
void Translate (GPnt P1, GPnt P2)
 
GTorus Translated (GPnt P1, GPnt P2)
 

Protected Member Functions

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

Static Protected Member Functions

static long getCPtr (GTorus obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

Describes a torus. A torus is defined by its major and minor radii and positioned in space with a coordinate system (a gp_Ax3 object) as follows: - The origin of the coordinate system is the center of the torus; - The surface is obtained by rotating a circle of radius equal to the minor radius of the torus about the "main Direction" of the coordinate system. This circle is located in the plane defined by the origin, the "X Direction" and the "main Direction" of the coordinate system. It is centered on the "X Axis" of this coordinate system, and located at a distance, from the origin of this coordinate system, equal to the major radius of the torus; - The "X Direction" and "Y Direction" define the reference plane of the torus. The coordinate system described above is the "local coordinate system" of the torus. Note: when a gp_Torus torus is converted into a Geom_ToroidalSurface torus, some implicit properties of its local coordinate system are used explicitly: - its origin, "X Direction", "Y Direction" and "main Direction" are used directly to define the parametric directions on the torus and the origin of the parameters, - its implicit orientation (right-handed or left-handed) gives the orientation (direct, indirect) to the Geom_ToroidalSurface torus. See Also gce_MakeTorus which provides functions for more complex torus constructions Geom_ToroidalSurface which provides additional functions for constructing tori and works, in particular, with the parametric equations of tori.

Constructor & Destructor Documentation

GTorus.GTorus ( )

creates an indefinite Torus.

GTorus.GTorus ( GAx3  A3,
double  MajorRadius,
double  MinorRadius 
)

a torus centered on the origin of coordinate system A3, with major radius MajorRadius and minor radius MinorRadius, and with the reference plane defined by the origin, the "X Direction" and the "Y Direction" of A3. Warnings : It is not forbidden to create a torus with MajorRadius = MinorRadius = 0.0 Raises ConstructionError if MinorRadius < 0.0 or if MajorRadius < 0.0

Member Function Documentation

double GTorus.Area ( )

Computes the area of the torus.

GAx1 GTorus.Axis ( )

returns the symmetry axis of the torus.

boolean GTorus.Direct ( )

returns true if the Ax3, the local coordinate system of this torus, is right handed.

GPnt GTorus.Location ( )

Returns the Torus's location.

double GTorus.MajorRadius ( )

returns the major radius of the torus.

double GTorus.MinorRadius ( )

returns the minor radius of the torus.

GTorus GTorus.Mirrored ( GPnt  P)

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

GTorus GTorus.Mirrored ( GAx1  A1)

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

GTorus GTorus.Mirrored ( GAx2  A2)

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

GAx3 GTorus.Position ( )

Returns the local coordinates system of the torus.

GTorus GTorus.Rotated ( GAx1  A1,
double  Ang 
)

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

GTorus GTorus.Scaled ( GPnt  P,
double  S 
)

Scales a torus. S is the scaling value. The absolute value of S is used to scale the torus

void GTorus.SetAxis ( GAx1  A1)

Modifies this torus, by redefining its local coordinate system so that: - its origin and "main Direction" become those of the axis A1 (the "X Direction" and "Y Direction" are then recomputed). Raises ConstructionError if the direction of A1 is parallel to the "XDirection" of the coordinate system of the toroidal surface.

void GTorus.SetLocation ( GPnt  Loc)

Changes the location of the torus.

void GTorus.SetMajorRadius ( double  MajorRadius)

Assigns value to the major radius of this torus. Raises ConstructionError if MajorRadius - MinorRadius <= Resolution()

void GTorus.SetMinorRadius ( double  MinorRadius)

Assigns value to the minor radius of this torus. Raises ConstructionError if MinorRadius < 0.0 or if MajorRadius - MinorRadius <= Resolution from gp.

void GTorus.SetPosition ( GAx3  A3)

Changes the local coordinate system of the surface.

GTorus GTorus.Transformed ( GTrsf  T)

Transforms a torus with the transformation T from class Trsf.

GTorus GTorus.Translated ( GVec  V)

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

GTorus GTorus.Translated ( GPnt  P1,
GPnt  P2 
)

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

void GTorus.UReverse ( )

Reverses the U parametrization of the torus reversing the YAxis.

double GTorus.Volume ( )

Computes the volume of the torus.

void GTorus.VReverse ( )

Reverses the V parametrization of the torus reversing the ZAxis.

GAx1 GTorus.XAxis ( )

returns the axis X of the torus.

GAx1 GTorus.YAxis ( )

returns the axis Y of the torus.