pycatia.sketcher_interfaces.ellipse_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.ellipse_2D.Ellipse2D(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
Ellipse2D

Class defining an ellipse in 2D Space.
property center_point: Point2D

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property CenterPoint() As Point2D

Returns the center point of the ellipse.

Parameters:

iCenterPoint
The center point of the ellipse
Return type:

Point2D

get_center() → tuple

Note

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

Returns the center of the ellipse in 2D space

Parameters:

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

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

tuple

get_major_axis() → tuple

Note

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

Returns the unit vector of the major axis of the ellipse in 2D
space

Parameters:

oMajorAxis[0]
The length of the major axis
oMajorAxis[1]
The length of the major axis
Return type:

tuple

get_minor_axis() → tuple

Note

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

Returns the unit vector of the minor axis of the ellipse in 2D
space

Parameters:

oMinorAxis[0]
The length of the major axis
oMinorAxis[1]
The length of the major axis
Return type:

tuple

property major_radius: float

Note

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

Returns the radius of the ellipse major axis

Parameters:

oMajorRadius
The radius of the major axis
Return type:

float

property minor_radius: float

Note

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

Returns the radius of the ellipse minor axis

Parameters:

oMinorRadius
The radius of the minor axis
Return type:

float

set_data(i_center_x: float, i_center_y: float, i_major_x: float, i_major_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 iMajorX,
double iMajorY,
double iMajorRadius,
double iMinorRadius)

Modifies the caracteristics of the ellipse

Parameters:

iCenterX
The X Coordinate of the ellipse center
iCenterY
The Y Coordinate of the ellipse center
iMajorX
The X coordinate of the Major axis direction
iMajorY
The Y coordinate of the Major axis direction
iMajorRadius
The length of the major axis
iMinorRadius
The length of the minor axis
Parameters:

  • i_center_x (float) –

  • i_center_y (float) –

  • i_major_x (float) –

  • i_major_y (float) –

  • i_major_radius (float) –

  • i_minor_radius (float) –

Return type:

None