All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

GeometricObjects Interface CATTorus

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---GeometricObjects.CATICGMUnknown
        |
        +---GeometricObjects.CATICGMObject
          |
          +---GeometricObjects.CATGeometry
            |
            +---GeometricObjects.CATSurface
              |
              +---GeometricObjects.CATElementarySurface
                |
                +---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.

The CATTorus is created by the CreateTorus method of the CATGeoFactory interface and deleted with the Remove method. The torus is defined by an axes system (Axis) and two radii. The major ring sweeps a full circle in the (O,X,Y) plane, of radius MajorRadius and centered at the origin of the Axis. The minor ring sweeps a full circle of radius MinorRadius, centered at some point on the major ring and lying in the plane containing this center point, the origin O, and the vector Z. A piece of the full torus is given by limiting the angles through which the major ring sweeps and those through which every minor ring sweeps.
A CATTorus is defined with:
CATMathAxis Axis The (O,X,Y,Z) axes system, whose third direction Z is the torus direction
double MajorAxis The major ring radius on the plane (O,X,Y)
double MinorAxis The minor ring radius on the plane (O,X,Z)
CATAngle MajorStartAngle The low limitation of the major ring, measured from the axis first direction.
CATAngle MajorEndAngle The high limitation of the major ring, measured from the axis first direction.
CATAngle MinorStartAngle The low limitation of the minor ring, measured from the direction of the ray given by the MajorAngle.
CATAngle MinorEndAngle The high limitation of the minor ring, measured from the direction of the ray given by the MajorAngle.
Notice that -2*Pi <= MajorStartAngle < 2*Pi, MajorStartAngle < MajorEndAngle <= 2*Pi, -2*Pi <= MinorStartAngle < 2*Pi, MinorStartAngle < MinorEndAngle <= 2*Pi. The first direction of the CATTorus is around the major ring, while the second one is along the minor ring. The "seams" are given by the ranges for MajorAngle [A-PI, A+PI] in which A is the mean angle at creation, and for MinorAngle [B-PI, B+PI] in which B is the mean minor angle at the time of creation (unless the torus is self-intersecting, for which case MinorAngle is in [-B,B] in which B is the critical angle B=acos(-MajorAxis/MinorAxis)).


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: CATGeometricObjects

Copyright © 2003, Dassault Systèmes. All rights reserved.