pycatia.sketcher_interfaces.curve_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.curve_2D.Curve2D(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

Curve2D

Class defining a curve in 2D Space.

property continuity: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Continuity() As short (Read Only)

Returns the highest level of geometric continuity the curve

possesses.

Parameters:

oLevel

The maximum geometric continuity level

Return type:

int

property end_point: Point2D

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property EndPoint() As Point2D

Returns the end point of the curve. The end point is decided with respect

to the logical flow imposed on the curve by the object.

Parameters:

oEndPoint

The end point of the curve

Return type:

Point2D

get_curvature(i_param: float) → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetCurvature(double iParam,

CATSafeArrayVariant oCurvature)

Returns the curvature and curvature direction at the parameter

specified.

Parameters:

iParam

The parameter of the chosen point on the curve.

oCurvature[0]

The curvature at the specified parameter.

oCurvature[1;2]

The unit-vector of curvature direction at the specified

parameter.

Parameters:

i_param (float) –

Return type:

tuple

get_derivatives(i_param: float) → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetDerivatives(double iParam,

CATSafeArrayVariant oDerivative)

Returns the first, second and third derivatives at the parameter

specified.

Parameters:

iParam

The parameter of the chosen point on the curve.

oDerivative[0]

First degree derivative.

oDerivative[1]

Second degree derivative.

oDerivative[2]

Third degree derivative.

Parameters:

i_param (float) –

Return type:

tuple

get_end_points() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetEndPoints(CATSafeArrayVariant oEndPoints)

Returns the end-points of the curve. The start point and the end point are

decided with respect to the logical flow imposed on the curve by the

object.

Parameters:

oEndPoints[0]

The x coordinate of the start point

oEndPoints[1]

The y coordinate of the start point

oEndPoints[2]

The x coordinate of the end point

oEndPoints[3]

The y coordinate of the end point

Return type:

tuple

get_length_at_param(i_from_param: float, i_to_param: float) → float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetLengthAtParam(double iFromParam,

double iToParam) As double

Returns the length, measured along the curve, from a given parameter to a

given parameter.

Parameters:

iFromParam

The parameter from which the length is to be measured.

iToParam

The parameter to which the length is to be measured.

oLength

The length between the parameters

Parameters:

• i_from_param (float) –

• i_to_param (float) –

Return type:

float

get_param_at_length(i_from_param: float, i_length: float) → float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetParamAtLength(double iFromParam,

double iLength) As double

Returns the parameter at a given length, measured along the curve, starting

from a given parameter. The direction of measurement is always in the direction

of the logical flow of the curve. If no inherent logical flow can be assigned

the direction is the direction of increasing

parameterization.

Parameters:

iFromParam

The parameter from which the length needs to be measured.

iLength

The length of the curve to be measured from iFromParam in the

logical flow direction of the curve.

oParam

The computed parameter.

Parameters:

• i_from_param (float) –

• i_length (float) –

Return type:

float

get_param_extents() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetParamExtents(CATSafeArrayVariant oParams)

Returns the parametric extents of the curve. This is the parametric

equivalent of the end-points.

Parameters:

oParams[0]

The parameter associated with the start point of the curve

oParams[1]

The parameter associated with the end point of the

curve

Return type:

tuple

get_point_at_param(i_param: float) → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetPointAtParam(double iParam,

CATSafeArrayVariant oPoint)

Returns a point on the curve computed from an input

parameter.

Parameters:

iParam

The parameter

oPoint

The X and Y coordinates of the computed 2D space

point.

Parameters:

i_param (float) –

Return type:

tuple

get_range_box() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetRangeBox(CATSafeArrayVariant oBoundPoint)

Returns the range box (or bounding box) of the object

The box is axially aligned within the local coordinate system of the

server.

Parameters:

oBoundPoint[0]

The minimum x point of the box

oBoundPoint[1]

The minimum y point of the box

oBoundPoint[2]

The maximum x point of the box

oBoundPoint[3]

The maximum y point of the box

Return type:

tuple

get_tangent(i_param: float) → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetTangent(double iParam,

CATSafeArrayVariant oTangency)

Returns the unit-vector tangent at the parameter

specified.

Parameters:

iParam

The parameter of the chosen point on the curve.

oTangency

The X and Y coordinates of the unit-vector tangent at the specified

parameter.

I_param:

float

Return type:

None

is_periodic() → bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func IsPeriodic() As boolean

Specifies whether a curve is periodic or not.

Parameters:

oPeriodic

Returns true if the curve is periodic.

Return type:

bool

property period: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Period() As double (Read Only)

Returns the period of a periodic curve.

Parameters:

oPeriod

The period of the curve.

Return type:

float

property start_point: Point2D

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property StartPoint() As Point2D

Returns the start point of the curve. The start point is decided with

respect to the logical flow imposed on the curve by the

object.

Parameters:

oStartPoint

The start point of the curve

Return type:

Point2D