pycatia.sketcher_interfaces.hyperbola_2D

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.sketcher_interfaces.hyperbola_2D.Hyperbola2D(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
SketcherInterfaces.GeometricElement
SketcherInterfaces.Geometry2D
SketcherInterfaces.Curve2D
Hyperbola2D

Class defining an hyperbola in 2D Space.
get_axis() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetAxis(CATSafeArrayVariant oAxis)

Returns the axis vector direction of the hyperbola in 2D
space

Parameters:

oAxis[0]
The X coordinate of the axis vector direction
oAxis[1]
The Y coordinate of the axis vector direction
Return type:

tuple

get_center() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetCenter(CATSafeArrayVariant oCenter)

Returns the center point of the hyperbola in 2D space

Parameters:

oCenter[0]
The X Coordinate of the center point of the hyperbola

oCenter[1]
The Y Coordinate of the center point of the
hyperbola
Return type:

tuple

property imaginary_radius: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property ImaginaryRadius() As double (Read Only)

Returns the minor radius of the hyperbola in 2D space

Parameters:

oMinorRadius
The minor radius of the hyperbola
Return type:

float

property radius: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Radius() As double (Read Only)

Returns the major radius of the hyperbola in 2D space

Parameters:

oMajorRadius
The major radius of the hyperbola
Return type:

float

set_data(i_center_x: float, i_center_y: float, i_axis_x: float, i_axis_y: float, i_major_radius: float, i_minor_radius: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetData(double iCenterX,
double iCenterY,
double iAxisX,
double iAxisY,
double iMajorRadius,
double iMinorRadius)

Modifies the caracteristics of the hyperbola

Parameters:

iCenterX
The X Coordinate of the hyperbola center
iCenterY
The Y Coordinate of the hyperbola center
iAxisX
The X coordinate of the axis vector direction
iAxisY
The Y coordinate of the axis vector direction
iMajorRadius
The length of the major radius
iMinorRadius
The length of the minor radius
Parameters:

  • i_center_x (float) –

  • i_center_y (float) –

  • i_axis_x (float) –

  • i_axis_y (float) –

  • i_major_radius (float) –

  • i_minor_radius (float) –

Return type:

None