All Frameworks Class Hierarchy This Framework Indexes
GeometricObjects Interface CATPEllipse
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATPEllipse
Interface representing an ellipse in the space of a surface.
The CATPEllipse is created by the CreatePEllipse
method of the CATGeoFactory interface
and deleted with the Remove method.
A CATPEllipse is defined with:
| CATSurface | Sur |
The underlying surface |
| double | A |
The half length of the major axis |
| double | B |
The half length of minor axis |
| CATAngle | iOffset |
The angle between the surface first direction and the
major axis |
| CATAngle | iStart |
The low angle limitation |
| CATAngle | iEnd |
The high angle limitation |
with 0 <= iStart < CAT2PI,
iStart < iEnd <= iStart + CAT2PI, B <= A.
The iStart and iEnd angles are measured
from the major axis.
The parametric equation of the ellipse in the surface is:
U=a*cos(theta), V=b*sin(theta).
Notice that the CATSurParam associated with (U,V)
may not correspond to theta. So, do not make any assumption on the
internal ellipse parameterization.
The ellipse equation
in its axis system is U²/A² + V²/B² = 1.
Method Index
- o
GetCenter()
- Returns the center of a CATPEllipse.
- o
GetCenter(CATSurParam&)
- Returns the center of a CATPEllipse.
- o
GetEndAngle()
- Returns the high angle limitation of this CATPEllipse.
- o
GetMajorAxis()
- Returns the half length of the major axis.
- o
GetMinorAxis()
- Returns the half length of minor axis.
- o
GetOffsetAngle()
- Returns the angle between the surface first direction and the major axis
of this CATPEllipse.
- o
GetStartAngle()
- Returns the low angle limitation of this CATPEllipse.
- o
SetCenter(CATSurParam&)
- Modifies the center of a CATPEllipse.
- o
SetMajorAxis(double)
- Modifies the half length of the major axis of this CATPEllipse.
- o
SetMinorAxis(double)
- Modifies the half length of minor axis of this CATPEllipse.
- o
SetOffsetAngle(CATAngle)
- Modifies the angle between the surface first direction and the major axis
of this CATPEllipse.
- o
Set(double,double,CATAngle,CATSurParam&,CATAngle,CATAngle,CATSurface*)
- Modifies the characteristics of this CAPEllipse.
Methods
o GetCenter
| public virtual GetCenter( | ) |
-
Returns the center of a CATPEllipse.
Use preferably the signature which returns the center in output argument.
- Returns:
- The center.
o GetCenter
| public virtual GetCenter( | | ioCenter) |
-
Returns the center of a CATPEllipse.
- Parameters:
-
- ioCenter
- The center.
o GetEndAngle
| public virtual GetEndAngle( | ) |
-
Returns the high angle limitation of this CATPEllipse.
- Returns:
- The end limitation angle.
o GetMajorAxis
| public virtual GetMajorAxis( | ) |
-
Returns the half length of the major axis.
- Returns:
- The half length of the major axis.
o GetMinorAxis
| public virtual GetMinorAxis( | ) |
-
Returns the half length of minor axis.
- Returns:
- The half length of the minor axis.
o GetOffsetAngle
| public virtual GetOffsetAngle( | ) |
-
Returns the angle between the surface first direction and the major axis
of this CATPEllipse.
- Returns:
- The angle.
o GetStartAngle
| public virtual GetStartAngle( | ) |
-
Returns the low angle limitation of this CATPEllipse.
- Returns:
- The first limitation angle.
o SetCenter
| public virtual SetCenter( | const | iNewCenter) |
-
Modifies the center of a CATPEllipse.
- Parameters:
-
- iNewCenter
- The new center.
o SetMajorAxis
| public virtual SetMajorAxis( | const | iNewMajorAxis) |
-
Modifies the half length of the major axis of this CATPEllipse.
- Parameters:
-
- iNewMajorAxis
- The new value.
o SetMinorAxis
| public virtual SetMinorAxis( | const | iNewMinorAxis) |
-
Modifies the half length of minor axis of this CATPEllipse.
- Parameters:
-
- iNewMinorAxis
- The new value.
o SetOffsetAngle
| public virtual SetOffsetAngle( | const | iNewOffsetAngle) |
-
Modifies the angle between the surface first direction and the major axis
of this CATPEllipse.
- Parameters:
-
- iNewOffsetAngle
- The new angle value.
o Set
| public virtual Set( | const | iMajorAxis, |
| const | iMinorAxis, |
| const | iOffsetAngle, |
| const | iCenter, |
| const | iStart, |
| const | iEnd, |
| | iSupport) |
-
Modifies the characteristics of this CAPEllipse.
- Parameters:
-
- iMajorAxis
- The new value.
- iMinorAxis
- The new value.
- iOffsetAngle
- The new offset angle value.
- iCenter
- The new center.
- iStart
- The first limitation angle.
- iEnd
- The end limitation angle.
This object is included in the file: CATPEllipse.h
If needed, your Imakefile.mk should include the module: CATGeometricObjects