pycatia.sketcher_interfaces.factory_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.factory_2D.Factory2D(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
Factory2D

Interface to the factory for 2D objects.
create_circle(i_center_x: float, i_center_y: float, i_radius: float, i_start_param: float, i_end_param: float) → Circle2D

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func CreateCircle(double iCenterX,
double iCenterY,
double iRadius,
double iStartParam,
double iEndParam) As Circle2D

Creates and returns a 2D circle arc.

Parameters:

iCenterX
The X coordinate of the circle center
iCenterY
The Y coordinate of the circle center
iRadius
The radius of the circle
iStartParam
The beginning parameter of the circle.
This parameter is an angle value between 0 included and 2PI
excluded. Parameter values are computed from the axis horizontal direction in
the trigonometrical direction.
iEndParam
The end parameter of the circle.
This parameter may take any value between iStartParam excluded and
4PI included.
Parameters:

  • i_center_x (float) –

  • i_center_y (float) –

  • i_radius (float) –

  • i_start_param (float) –

  • i_end_param (float) –

Return type:

Circle2D

create_closed_circle(i_center_x: float, i_center_y: float, i_radius: float) → Circle2D

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func CreateClosedCircle(double iCenterX,
double iCenterY,
double iRadius) As Circle2D

Creates and returns a closed 2D circle.

Parameters:

iCenterX
The X coordinate of the circle center
iCenterY
The Y coordinate of the circle center
iRadius
The radius of the circle
Parameters:

  • i_center_x (float) –

  • i_center_y (float) –

  • i_radius (float) –

Return type:

Circle2D

create_closed_ellipse(i_center_x: float, i_center_y: float, i_major_x: float, i_major_y: float, i_major_radius: float, i_minor_radius: float) → Ellipse2D

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func CreateClosedEllipse(double iCenterX,
double iCenterY,
double iMajorX,
double iMajorY,
double iMajorRadius,
double iMinorRadius) As Ellipse2D

Creates and returns a closed 2D ellipse.

Parameters:

iCenterX
The X coordinate of the ellipse center
iCenterY
The Y coordinate of the ellipse center
iMajorX
The X component of the major axis direction
iMajorY
The Y component 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:

Ellipse2D

create_control_point(i_x: float, i_y: float) → ControlPoint2D

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func CreateControlPoint(double iX,
double iY) As ControlPoint2D

Creates and returns a 2D spline control point.

Parameters:

iX
The X coordinate of point to create
iY
The Y coordinate of point to create
Parameters:

  • i_x (float) –

  • i_y (float) –

Return type:

ControlPoint2D

create_ellipse(i_center_x: float, i_center_y: float, i_major_x: float, i_major_y: float, i_major_radius: float, i_minor_radius: float, i_start_param: float, i_end_param: float) → Ellipse2D

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func CreateEllipse(double iCenterX,
double iCenterY,
double iMajorX,
double iMajorY,
double iMajorRadius,
double iMinorRadius,
double iStartParam,
double iEndParam) As Ellipse2D

Creates and returns a 2D ellipse arc.

Parameters:

iCenterX
The X coordinate of the ellipse center
iCenterY
The Y coordinate of the ellipse center
iMajorX
The X component of the major axis direction
iMajorY
The Y component of the major axis direction
iMajorRadius
The length of the major axis
iMinorRadius
The length of the minor axis
iStartParam
The beginning parameter of the ellipse.
This parameter is an angle value between 0 included and 2PI
excluded. Parameter values are computed from the major axis direction in the
trigonometrical direction.
iEndParam
The end parameter of the ellipse.
This parameter may take any value between iStartParam excluded and
4PI included.
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) –

  • i_start_param (float) –

  • i_end_param (float) –

Return type:

Ellipse2D

create_hyperbola(i_center_x: float, i_center_y: float, i_axis_x: float, i_axis_y: float, i_major_radius: float, i_minor_radius: float) → Hyperbola2D

Note

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

Creates and returns a hyperbola.

Parameters:

iCenterX
The X coordinate of the hyperbola center
iCenterY
The Y coordinate of the hyperbola center
iAxisX
The X coordinate of the major axis direction
iAxisY
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_axis_x (float) –

  • i_axis_y (float) –

  • i_major_radius (float) –

  • i_minor_radius (float) –

Return type:

Hyperbola2D

create_intersection(i_geometry: Reference) → Geometry2D

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func CreateIntersection(Reference iGeometry) As Geometry2D

Creates and returns the intersection of an object with the
sketch.

Parameters:

iGeometry
The object to intersect with the sketch
Parameters:

i_geometry (Reference) –

Return type:

Geometry2D

create_intersections(i_geometry: Reference) → GeometricElements

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func CreateIntersections(Reference iGeometry) As
GeometricElements

Creates and returns the possible intersections of an object with the
sketch.

Parameters:

iGeometry
The object to intersect with the sketch
Parameters:

i_geometry (Reference) –

Return type:

GeometricElements

create_line(i_x1: float, i_y1: float, i_x2: float, i_y2: float) → Line2D

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func CreateLine(double iX1,
double iY1,
double iX2,
double iY2) As Line2D

Creates and returns a 2D line.

Parameters:

iX1
The X coordinate of line first extremity
iY1
The Y coordinate of line first extremity
iX2
The X coordinate of line second extremity
iY2
The Y coordinate of line second extremity
Parameters:

  • i_x1 (float) –

  • i_y1 (float) –

  • i_x2 (float) –

  • i_y2 (float) –

Return type:

Line2D

create_line_from_vector(i_x1: float, i_y1: float, i_ux: float, i_uy: float) → Line2D

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func CreateLineFromVector(double iX1,
double iY1,
double iUX,
double iUY) As Line2D

Creates and returns a 2D line.

Parameters:

iX1
The X coordinate of the line origin
iY1
The Y coordinate of the line origin
iUX
The X component of the line vector
iUY
The Y component of the line vector
Parameters:

  • i_x1 (float) –

  • i_y1 (float) –

  • i_ux (float) –

  • i_uy (float) –

Return type:

Line2D

create_parabola(i_center_x: float, i_center_y: float, i_axis_x: float, i_axis_y: float, i_focal_distance: float) → Parabola2D

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func CreateParabola(double iCenterX,
double iCenterY,
double iAxisX,
double iAxisY,
double iFocalDistance) As Parabola2D

Creates and returns a parabola.

Parameters:

iCenterX
The X coordinate of the parabola center
iCenterY
The Y coordinate of the parabola center
iAxisX
The X coordinate of the major axis direction
iAxisY
The Y coordinate of the major axis direction
iFocalDistance
The parabola focal distance
Parameters:

  • i_center_x (float) –

  • i_center_y (float) –

  • i_axis_x (float) –

  • i_axis_y (float) –

  • i_focal_distance (float) –

Return type:

Parabola2D

create_point(i_x: float, i_y: float) → Point2D

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func CreatePoint(double iX,
double iY) As Point2D

Creates and returns a 2D point.

Parameters:

iX
The X coordinate of point to create
iY
The Y coordinate of point to create
Parameters:

  • i_x (float) –

  • i_y (float) –

Return type:

Point2D

create_projection(i_geometry: Reference) → Geometry2D

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func CreateProjection(Reference iGeometry) As Geometry2D

Creates and returns the projection of an object on the
sketch.

Parameters:

iGeometry
The object to project on the sketch
Parameters:

i_geometry (Reference) –

Return type:

Geometry2D

create_projections(i_geometry: Reference) → GeometricElements

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func CreateProjections(Reference iGeometry) As
GeometricElements

Creates and returns the possible projections of an object on the
sketch.

Parameters:

iGeometry
The object to project on the sketch
Parameters:

i_geometry (Reference) –

Return type:

GeometricElements

create_spline(i_poles: tuple) → Spline2D

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func CreateSpline(CATSafeArrayVariant iPoles) As Spline2D

Creates and returns a 2D b-spline.

Parameters:

iPoles
An array of CATIAPoint2D forming the poles of the
b-spline.
Parameters:

i_poles (tuple) –

Return type:

Spline2D