GeometricObjects Interface CATPHyperbola
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATPHyperbola
Interface representing an hyperbola in the space of a surface.
The CATPHyperbola is created by the CreatePHyperbola
method of the CATGeoFactory interface and deleted with the Remove method.
It is defined with:
CATMathAxis2D | iAxis |
The axis of the hyperbola in the space of the surface |
CATSurface | iSupport |
The surface on which the hyperbola is defined |
double | iA |
The length between the center and the vertex. |
double | iB |
The distance between focus and center c = sqrt(iA^2+iB^2) |
The eccentricity is defined by e = c/iA > 1.
With this definition, the hyperbola is the branch
along the positive X corresponding to the implicit equation
X^2/(iA^2) - Y^2/(iB^2) = 1
To define the limits of the hyperbola, consider the parameter t such that:
X(t) = a*cosh(t), Y(t) = b*sinh(t) , where X and Y are relative to iAxis.
Notice that this parameterization is not the internal parameterization.
Method Index
- o
GetCanonicalParams(double&,double&)
- Returns the canonical lengths of this CATPHyperbola.
- o
GetExtremities(double&,double&)
- Returns the low and high limitations of this CATPHyperbola.
- o
GetReferenceAxis(CATMathAxis2D&)
- Returns the reference axis of this CATPHyperbola.
- o
Set(CATMathAxis2D&,double&,double&,double*,CATSurface*)
- Modifies the characteristics of this CATPHyperbola.
- o
SetCanonicalParams(double&,double&)
- Modifies the canonical lengths of this CATPHyperbola.
- o
SetExtremities(double&,double&)
- Modifies the low and high Limimitations of this CATPHyperbola.
- o
SetReferenceAxis(CATMathAxis2D&)
- Modifies the reference axis of this CATPHyperbola.
Methods
o GetCanonicalParams
public virtual GetCanonicalParams( | | ioA, |
| | ioB) |
-
Returns the canonical lengths of this CATPHyperbola.
- Parameters:
-
- ioA
- The length between the center and the vertex.
- ioB
- The distance between focus and center c = sqrt(iA^2+iB^2).
- iLimits
o GetExtremities
public virtual GetExtremities( | | ioLowLimitation, |
| | ioHighLimitation) |
-
Returns the low and high limitations of this CATPHyperbola.
- Parameters:
-
- ioLowLimitation
- The parameter value of the first limitation of this CATPHyperbola.
- ioHighLimitation
- The parameter value of the second limitation of this CATPHyperbola.
o GetReferenceAxis
public virtual GetReferenceAxis( | | ioAxis2D) |
-
Returns the reference axis of this CATPHyperbola.
- Parameters:
-
- ioAxis
- The axis of the hyperbola in the surface space.
o Set
public virtual Set( | const | iAxis2D, |
| const | iA, |
| const | iB, |
| const | iLimits, |
| | iSupport) |
-
Modifies the characteristics of this CATPHyperbola.
- Parameters:
-
- iAxis
- The axis of the hyperbola in the surface space.
- iA
- The length between the center and the vertex.
- iB
- The distance between focus and center c = sqrt(iA^2+iB^2).
- iLimits
- An array [2] of the parameter values definining the limitations. If NULL, the hyperbola is unlimited.
- iSupport
- A pointer to the surface on which the hyperbola is defined.
o SetCanonicalParams
public virtual SetCanonicalParams( | const | iA, |
| const | iB) |
-
Modifies the canonical lengths of this CATPHyperbola.
- Parameters:
-
- iA
- The length between the center and the vertex.
- iB
- The distance between focus and center c = sqrt(iA^2+iB^2).
o SetExtremities
public virtual SetExtremities( | const | iLowParam, |
| const | iHighParam) |
-
Modifies the low and high Limimitations of this CATPHyperbola.
- Parameters:
-
- iLowParam
- The parameter value of the first limitation of this CATPHyperbola.
- iHighParam
- The parameter value of the second limitation of this CATPHyperbola.
o SetReferenceAxis
public virtual SetReferenceAxis( | const | iAxis2D) |
-
Modifies the reference axis of this CATPHyperbola.
- Parameters:
-
- iAxis
- The axis of the hyperbola in the surface space.
This object is included in the file: CATPHyperbola.h
If needed, your Imakefile.mk should include the module: CATGMGeometricInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.