GeometricObjects Interface CATTorus
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATTorus
Interface representing a geometrical torus.
A torus is a surface of revolution generated by revolving a circle or a circle arc
in the three dimensional space about an axis coplanar with the circle. The circle arc to be revolved
is not necessarily revolved around 2*Pi.
The CATTorus is created by the CreateTorus
method of the CATGeoFactory interface and deleted with the Remove method.
A CATTorus is defined by:
- a CATMathAxis in which the third direction is the revolution axis
- a major axis: its radius is counted on the plane defined by the first
and second direction of the CATMathAxis
- a minor axis: its radius is counted on the plane defined by the first
and second direction of the CATMathAxis
- The low limit of the major ring, measured from
the axis first direction.
- The high limit of the major ring, measured from
the axis first direction.
- The low limit of the minor ring, counted from
the external minor radius in the plane
defined by the first and second direction of the torus axis.
- The high limit of the minor ring, counted from
the external minor radius in the plane
defined by the first and second direction of the torus axis.
Note:
- The major end angle must be greater than the major start angle.
iMajorEndAngle - iMajorStartAngle must not be greater than 2*Pi.
- The minor end angle must be greater than the minor start angle.
iMinorEndAngle - iMinorStartAngle must not be greater than 2*Pi.
Method Index
- o
GetMajorEndAngle()
- Returns the major ring high limitation of this CATTorus.
- o
GetMajorRadius()
- Returns the major ring radius of this CATTorus.
- o
GetMajorStartAngle()
- Returns the major ring low limitation of this CATTorus.
- o
GetMinorEndAngle()
- Returns the minor ring high limitation of this CATTorus.
- o
GetMinorRadius()
- Returns the minor ring radius of this CATTorus.
- o
GetMinorStartAngle()
- Returns the minor ring low limitation of this CATTorus.
- o
GetUScale()
- Returns the scale on the major ring of this CATTorus.
- o
GetVScale()
- Returns the scale on the minor ring of this CATTorus.
- o
SetMaxMinorAngle(double)
- Defines the location of the seam in the minor angle.
- o
SetMinMinorAngle(double)
- Defines the location of the seam in the minor angle.
- o
SetUScale(double)
- Modifies the scale on the major ring of this CATTorus.
- o
SetVScale(double)
- Modifies the scale on the minor ring of this CATTorus.
Methods
o GetMajorEndAngle
| public virtual CATAngle GetMajorEndAngle( | )const = 0 |
-
Returns the major ring high limitation of this CATTorus.
- Returns:
- The major ring high limitation angle value.
o GetMajorRadius
| public virtual double GetMajorRadius( | )const = 0 |
-
Returns the major ring radius of this CATTorus.
- Returns:
- The major ring radius value.
o GetMajorStartAngle
| public virtual CATAngle GetMajorStartAngle( | )const = 0 |
-
Returns the major ring low limitation of this CATTorus.
- Returns:
- The major ring low limitation angle value.
o GetMinorEndAngle
| public virtual CATAngle GetMinorEndAngle( | )const = 0 |
-
Returns the minor ring high limitation of this CATTorus.
- Returns:
- The minor ring high limitation angle value.
o GetMinorRadius
| public virtual double GetMinorRadius( | )const = 0 |
-
Returns the minor ring radius of this CATTorus.
- Returns:
- The minor ring radius value.
o GetMinorStartAngle
| public virtual CATAngle GetMinorStartAngle( | )const = 0 |
-
Returns the minor ring low limitation of this CATTorus.
- Returns:
- The minor ring low limitation angle value.
o GetUScale
| public virtual double GetUScale( | )const = 0 |
-
Returns the scale on the major ring of this CATTorus.
- Returns:
- The coefficient such that:
Uparameter = coeff * angle.
o GetVScale
| public virtual double GetVScale( | )const = 0 |
-
Returns the scale on the minor ring of this CATTorus.
- Returns:
- The coefficient such that:
Vparameter = coeff * angle.
o SetMaxMinorAngle
| public virtual void SetMaxMinorAngle( | const double | iNewMin) = 0 |
-
Defines the location of the seam in the minor angle.
- Parameters:
-
- iNewMin
- The new value of the seam.
o SetMinMinorAngle
| public virtual void SetMinMinorAngle( | const double | iNewMin) = 0 |
-
Defines the location of the seam in the minor angle.
- Parameters:
-
- iNewMin
- The new value of the seam.
o SetUScale
| public virtual void SetUScale( | const double | iNewScale) = 0 |
-
Modifies the scale on the major ring of this CATTorus.
- Parameters:
-
- iNewScale
- The coefficient such that:
Uparameter = iNewScale * angle.
o SetVScale
| public virtual void SetVScale( | const double | iNewScale) = 0 |
-
Modifies the scale on the minor ring of this CATTorus.
- Parameters:
-
- iNewScale
- The coefficient such that:
Vparameter = iNewScale * angle.
This object is included in the file: CATTorus.h
If needed, your Imakefile.mk should include the module: CATGMGeometricInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.