Open CASCADE Technology 6.6.0
Public Member Functions
gp_Torus Class Reference

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:
More...

#include <gp_Torus.hxx>

Public Member Functions

 gp_Torus ()
 creates an indefinite Torus.

 gp_Torus (const gp_Ax3 &A3, const Standard_Real MajorRadius, const Standard_Real 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

void SetAxis (const gp_Ax1 &A1)
 Modifies this torus, by redefining its local coordinate
system so that:

void SetLocation (const gp_Pnt &Loc)
 Changes the location of the torus.

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

void SetMinorRadius (const Standard_Real MinorRadius)
 Assigns value to the minor radius of this torus.
Raises ConstructionError if MinorRadius < 0.0 or if
MajorRadius - MinorRadius <= Resolution from gp.

void SetPosition (const gp_Ax3 &A3)
 Changes the local coordinate system of the surface.

Standard_Real Area () const
 Computes the area of the torus.

void UReverse ()
 Reverses the U parametrization of the torus
reversing the YAxis.

void VReverse ()
 Reverses the V parametrization of the torus
reversing the ZAxis.

Standard_Boolean Direct () const
 returns true if the Ax3, the local coordinate system of this torus, is right handed.

const gp_Ax1Axis () const
 returns the symmetry axis of the torus.

void Coefficients (TColStd_Array1OfReal &Coef) const
 Computes the coefficients of the implicit equation of the surface
in the absolute cartesian coordinate system :
Coef(1) * X**4 + Coef(2) * Y**4 + Coef(3) * Z**4 +
Coef(4) * X**3 * Y + Coef(5) * X**3 * Z + Coef(6) * Y**3 * X +
Coef(7) * Y**3 * Z + Coef(8) * Z**3 * X + Coef(9) * Z**3 * Y +
Coef(10) * X**2 * Y**2 + Coef(11) * X**2 * Z**2 +
Coef(12) * Y**2 * Z**2 + Coef(13) * X**3 + Coef(14) * Y**3 +
Coef(15) * Z**3 + Coef(16) * X**2 * Y + Coef(17) * X**2 * Z +
Coef(18) * Y**2 * X + Coef(19) * Y**2 * Z + Coef(20) * Z**2 * X +
Coef(21) * Z**2 * Y + Coef(22) * X**2 + Coef(23) * Y**2 +
Coef(24) * Z**2 + Coef(25) * X * Y + Coef(26) * X * Z +
Coef(27) * Y * Z + Coef(28) * X + Coef(29) * Y + Coef(30) * Z +
Coef(31) = 0.0
Raises DimensionError if the length of Coef is lower than 31.

const gp_PntLocation () const
 Returns the Torus's location.

const gp_Ax3Position () const
 Returns the local coordinates system of the torus.

Standard_Real MajorRadius () const
 returns the major radius of the torus.

Standard_Real MinorRadius () const
 returns the minor radius of the torus.

Standard_Real Volume () const
 Computes the volume of the torus.

gp_Ax1 XAxis () const
 returns the axis X of the torus.

gp_Ax1 YAxis () const
 returns the axis Y of the torus.

void Mirror (const gp_Pnt &P)
gp_Torus Mirrored (const gp_Pnt &P) const
 Performs the symmetrical transformation of a torus
with respect to the point P which is the center of the
symmetry.

void Mirror (const gp_Ax1 &A1)
gp_Torus Mirrored (const gp_Ax1 &A1) const
 Performs the symmetrical transformation of a torus with
respect to an axis placement which is the axis of the
symmetry.

void Mirror (const gp_Ax2 &A2)
gp_Torus Mirrored (const gp_Ax2 &A2) const
 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).

void Rotate (const gp_Ax1 &A1, const Standard_Real Ang)
gp_Torus Rotated (const gp_Ax1 &A1, const Standard_Real Ang) const
 Rotates a torus. A1 is the axis of the rotation.
Ang is the angular value of the rotation in radians.

void Scale (const gp_Pnt &P, const Standard_Real S)
gp_Torus Scaled (const gp_Pnt &P, const Standard_Real S) const
 Scales a torus. S is the scaling value.
The absolute value of S is used to scale the torus

void Transform (const gp_Trsf &T)
gp_Torus Transformed (const gp_Trsf &T) const
 Transforms a torus with the transformation T from class Trsf.

void Translate (const gp_Vec &V)
gp_Torus Translated (const gp_Vec &V) const
 Translates a torus in the direction of the vector V.
The magnitude of the translation is the vector's magnitude.

void Translate (const gp_Pnt &P1, const gp_Pnt &P2)
gp_Torus Translated (const gp_Pnt &P1, const gp_Pnt &P2) const
 Translates a torus from the point P1 to the point P2.

const gp_Ax3_CSFDB_Getgp_Toruspos () const
Standard_Real _CSFDB_Getgp_TorusmajorRadius () const
void _CSFDB_Setgp_TorusmajorRadius (const Standard_Real p)
Standard_Real _CSFDB_Getgp_TorusminorRadius () const
void _CSFDB_Setgp_TorusminorRadius (const Standard_Real p)

Detailed Description


Constructor & Destructor Documentation

gp_Torus::gp_Torus ( )
gp_Torus::gp_Torus ( const gp_Ax3 A3,
const Standard_Real  MajorRadius,
const Standard_Real  MinorRadius 
)

Member Function Documentation

Standard_Real gp_Torus::_CSFDB_Getgp_TorusmajorRadius ( ) const [inline]
Standard_Real gp_Torus::_CSFDB_Getgp_TorusminorRadius ( ) const [inline]
const gp_Ax3& gp_Torus::_CSFDB_Getgp_Toruspos ( ) const [inline]
void gp_Torus::_CSFDB_Setgp_TorusmajorRadius ( const Standard_Real  p) [inline]
void gp_Torus::_CSFDB_Setgp_TorusminorRadius ( const Standard_Real  p) [inline]
Standard_Real gp_Torus::Area ( ) const
const gp_Ax1& gp_Torus::Axis ( ) const
void gp_Torus::Coefficients ( TColStd_Array1OfReal Coef) const
Standard_Boolean gp_Torus::Direct ( ) const
const gp_Pnt& gp_Torus::Location ( ) const
Standard_Real gp_Torus::MajorRadius ( ) const
Standard_Real gp_Torus::MinorRadius ( ) const
void gp_Torus::Mirror ( const gp_Pnt P)
void gp_Torus::Mirror ( const gp_Ax1 A1)
void gp_Torus::Mirror ( const gp_Ax2 A2)
gp_Torus gp_Torus::Mirrored ( const gp_Pnt P) const
gp_Torus gp_Torus::Mirrored ( const gp_Ax1 A1) const
gp_Torus gp_Torus::Mirrored ( const gp_Ax2 A2) const
const gp_Ax3& gp_Torus::Position ( ) const
void gp_Torus::Rotate ( const gp_Ax1 A1,
const Standard_Real  Ang 
)
gp_Torus gp_Torus::Rotated ( const gp_Ax1 A1,
const Standard_Real  Ang 
) const
void gp_Torus::Scale ( const gp_Pnt P,
const Standard_Real  S 
)
gp_Torus gp_Torus::Scaled ( const gp_Pnt P,
const Standard_Real  S 
) const
void gp_Torus::SetAxis ( const gp_Ax1 A1)
  • 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 gp_Torus::SetLocation ( const gp_Pnt Loc)
void gp_Torus::SetMajorRadius ( const Standard_Real  MajorRadius)
void gp_Torus::SetMinorRadius ( const Standard_Real  MinorRadius)
void gp_Torus::SetPosition ( const gp_Ax3 A3)
void gp_Torus::Transform ( const gp_Trsf T)
gp_Torus gp_Torus::Transformed ( const gp_Trsf T) const
void gp_Torus::Translate ( const gp_Pnt P1,
const gp_Pnt P2 
)
void gp_Torus::Translate ( const gp_Vec V)
gp_Torus gp_Torus::Translated ( const gp_Pnt P1,
const gp_Pnt P2 
) const
gp_Torus gp_Torus::Translated ( const gp_Vec V) const
void gp_Torus::UReverse ( )
Standard_Real gp_Torus::Volume ( ) const
void gp_Torus::VReverse ( )
gp_Ax1 gp_Torus::XAxis ( ) const
gp_Ax1 gp_Torus::YAxis ( ) const

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