All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

SketcherInterfaces Interface CATI2DHyperbola

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATI2DHyperbola
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATI2DHyperbola

2D Hyperbola definition.
Role: This interface describes a hyperbola in 2D space. Its methods provide access to the hyperbola's parameters, which fully describe the hyperbola.


Method Index


o GetHyperbolaData(double*,double*,double*,double*)
Returns the hyperbola's parameters.
o SetHyperbolaData(double*,double*,double,double)
Defines the hyperbola's parameters.

Methods


o GetHyperbolaData
public virtual HRESULT GetHyperbolaData(double* oPoint,
double* oAxis,
double* oRadius1,
double* oRadius2) = 0
Returns the hyperbola's parameters.
Parameters:
oPoint
[out] The 2D center point coordinates.
oAxis
[out] The 2D axis direction coordinates.
oRadius1
[out] The radius of the hyperbola.
oRadius2
[out] The imaginary radius of the hyperbola.
Returns:
HRESULT
o SetHyperbolaData
public virtual HRESULT SetHyperbolaData( const double* iPoint,
const double* iAxis,
double iRadius1,
double iRadius2) = 0
Defines the hyperbola's parameters.
Parameters:
iPoint
[in] The 2D center point coordinates.
iAxis
[in] The 2D axis direction coordinates.
iRadius1
[in] The radius of the hyperbola.
iRadius2
[in] The imaginary radius of the hyperbola.
Returns:
HRESULT

This object is included in the file: CATI2DHyperbola.h
If needed, your Imakefile.mk should include the module: CATSketcherInterfaces

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