pycatia.hybrid_shape_interfaces.hybrid_shape_spline

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-07-06 14:02:20.222384

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.hybrid_shape_interfaces.hybrid_shape_spline.HybridShapeSpline(com_object)

Note

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

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
MecModInterfaces.HybridShape
HybridShapeSpline

Represents the hybrid shape spline feature object.
Role: To access the data of the hybrid shape spline feature object. This data
includes:

The support surface
The control points
The tension at each control point
The curvature radius at each control point

Use the CATIAHybridShapeFactory to create a HybridShapeAffinity
object.

See also:
HybridShapeFactory
add_point(ip_ia_point: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub AddPoint(Reference ipIAPoint)

Add a new point .

Parameters:

iPoint
Point element.
Parameters:

ip_ia_point (Reference) –

Return type:

None

add_point_with_constraint_explicit(ip_ia_point: Reference, ip_ia_dir_tangency: HybridShapeDirection | VBANothing, i_tangency_norm: float, i_inverse_tangency: int, ip_ia_dir_curvature: HybridShapeDirection | VBANothing, i_curvature_radius: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub AddPointWithConstraintExplicit(Reference ipIAPoint,
HybridShapeDirection ipIADirTangency,
double iTangencyNorm,
long iInverseTangency,
HybridShapeDirection ipIADirCurvature,
double iCurvatureRadius)

Add a new point with explicit tangency and curvature.

Parameters:

ipIAPoint
Point element.
ipIADirTangency
Tangent direction.
iTangencyNorm
Tension.
iInverseTangency
Flag to reverse tangent direction (value can be 1 or -1).

ipIADirCurvature
Curvature direction.
iCurvatureRadius
Curvature radius value.
Parameters:
Return type:

None

add_point_with_constraint_from_curve(ip_ia_point: Reference, ip_ia_curve_cst: Reference, i_tangency_norm: float, i_invert_value: int, i_crv_cst_type: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub AddPointWithConstraintFromCurve(Reference ipIAPoint,
Reference ipIACurveCst,
double iTangencyNorm,
long iInvertValue,
long iCrvCstType)

Add a new point with tangency/curvature from a curve.

Parameters:

ipIAPoint
Point element.
ipIACurveCst
Curvature direction.
iTangencyNorm
tension factor for tangency.
iInvertValue
Orientation for tangent
iCrvCstType
Continuity type for Curve Constraint (1=Tangency , 2-=
Curvature).
Parameters:

  • ip_ia_point (Reference) –

  • ip_ia_curve_cst (Reference) –

  • i_tangency_norm (float) –

  • i_invert_value (int) –

  • i_crv_cst_type (int) –

Return type:

None

get_closure() → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetClosure() As long

Gets whether the curve is closed.

Parameters:

oClosed
Closing flag

1
for a closed curve
0
for an open curve
Return type:

int

get_constraint_type(i_pos: int) → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetConstraintType(long iPos) As long

Returns the ControlPoint type at the given position.

Parameters:

iPos
The position of the point to retrieve
oCstType
Type of Control point
(CstType=0 : not defined / CstType=1 : Explicit / CstType=2 : FromCurve)
Parameters:

i_pos (int) –

Return type:

int

get_curvature_radius(i_pos: int) → Length

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetCurvatureRadius(long iPos) As Length

Returns the curvature radius value for each point of the
spline.

Parameters:

iPos
The position of the point in the spline.
Legal values: first position is 1. The position cannot be 0.

oRadius
The curvature radius value at this point
Parameters:

i_pos (int) –

Return type:

Length

get_direction_inversion(i_pos: int) → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetDirectionInversion(long iPos) As long

Gets the orientation of the tangent direction .

Parameters:

oInvertFlag
invert flag = 1 No Inversion = -1 Invert
iPos
Position of point in spline First Position is 1 Position 0 return
E_FAIL
Parameters:

i_pos (int) –

Return type:

int

get_nb_control_point() → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetNbControlPoint() As long

Returns the number of control points.

Parameters:

oNbCtrPt
The number of control points.
Return type:

int

get_point(i_pos: int) → Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetPoint(long iPos) As Reference

Returns the Point at the given position.

Parameters:

iPos
The position of the point to retrieve
opIAPoint
Type of Control point (TypeCtrPoint =1 : Explicit / TypeCtrPoint =2 : FromCurve)
Parameters:

i_pos (int) –

Return type:

Reference

get_point_constraint_explicit(i_pos: int, op_ia_dir_tangency: HybridShapeDirection, o_tangency_norm: float, o_inverse_tangency: int, op_ia_dir_curvature: HybridShapeDirection, o_curvature_radius: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetPointConstraintExplicit(long iPos,
HybridShapeDirection opIADirTangency,
double oTangencyNorm,
long oInverseTangency,
HybridShapeDirection opIADirCurvature,
double oCurvatureRadius)

Returns the Constraint of the point at iPos.
Available for Explicit Point Constraint type (CstType =1 from
GetContraintType)

Parameters:

iPos
The position of the point to retrieve
opIADirTangency
Tangent direction.
oTangencyNorm
Tension.
oInverseTangency
Flag to reverse tangent direction (value can be 1 or -1).

opIADirCurvature
Curvature direction.
oCurvatureRadius
Curvature radius value.
Parameters:
Return type:

None

get_point_constraint_from_curve(i_pos: int, op_ia_curve_cst: Reference, o_tangency_norm: float, o_invert_value: int, o_crv_cst_type: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub GetPointConstraintFromCurve(long iPos,
Reference opIACurveCst,
double oTangencyNorm,
long oInvertValue,
long oCrvCstType)

Returns the Constraint of the point at iPos.
Available for FromCurve Point Constraint type (CstType =2 from
GetContraintType)

Parameters:

iPos
The position of the point to retrieve
opIACurveCst
Curvature direction.
oTangencyNorm
tension factor for tangency.
oInvertValue
Orientation for tangent
oCrvCstType
Continuity type for Curve Constraint (1=Tangency , 2-=
Curvature).
Parameters:

  • i_pos (int) –

  • op_ia_curve_cst (Reference) –

  • o_tangency_norm (float) –

  • o_invert_value (int) –

  • o_crv_cst_type (int) –

Return type:

None

get_point_position(ip_ia_point: Reference) → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetPointPosition(Reference ipIAPoint) As long

Returns the position of a given point.

Parameters:

ipIAPoint
Point
oPos
The position of the point (=0 Point Not in Spline)
Parameters:

ip_ia_point (Reference) –

Return type:

int

get_spline_type() → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetSplineType() As long

Gets the spline type.

Parameters:

oType
= 0 : Cubic Type Spline. = 1 : WilsonFowler Type Spline.
Return type:

int

get_support() → Reference

Note

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

Gets the support surface.

Parameters:

oSupport
Supporting surface for spline (if exist)
Return type:

Reference

get_tangent_norm(i_pos: int) → RealParam

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetTangentNorm(long iPos) As RealParam

Returns the tension for each point of the spline.
The tension is the tangent norm at the given point.

Parameters:

iPos
The position of the point in the spline.
Legal values: first position is 1. The position cannot be 0.

oTension
The tension at this point
Parameters:

i_pos (int) –

Return type:

RealParam

invert_direction(i_pos: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub InvertDirection(long iPos)

Inverts the orientation of the tangent direction .

Parameters:

iPos
Position of point in spline First Position is 1 Position 0 return
E_FAIL
Parameters:

i_pos (int) –

Return type:

None

remove_all() → None

Note

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

Removes all elements in the list of points.
Return type:

None

remove_control_point(i_pos: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub RemoveControlPoint(long iPos)

Removes a point at the given position.

Parameters:

iPos
The position of the point to remove
Parameters:

i_pos (int) –

Return type:

None

remove_curvature_radius_direction(i_pos: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub RemoveCurvatureRadiusDirection(long iPos)

Removes Curvature Radius Direction for the given point of the
spline.

Parameters:

iPos
Position of point in spline First Position is 1 Position 0 return
E_FAIL
Parameters:

i_pos (int) –

Return type:

None

remove_curvature_radius_value(i_pos: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub RemoveCurvatureRadiusValue(long iPos)

Removes Curvature Radius Value for the given point of the
spline.

Parameters:

iPos
Position of point in spline First Position is 1 Position 0 return
E_FAIL
Parameters:

i_pos (int) –

Return type:

None

remove_support() → None

Note

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

Removes the support surface.
Return type:

None

remove_tangent_direction(i_pos: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub RemoveTangentDirection(long iPos)

Removes tangent Direction for the given point of the
spline.

Parameters:

iPos
Position of point in spline First Position is 1 Position 0 return
E_FAIL
Parameters:

i_pos (int) –

Return type:

None

remove_tension(i_pos: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub RemoveTension(long iPos)

Removes the Tension for the given point of the spline.

Parameters:

iPos
Position of point in spline First Position is 1 Position 0 return
E_FAIL
Parameters:

i_pos (int) –

Return type:

None

replace_point_at_position(i_pos: int, i_point: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub ReplacePointAtPosition(long iPos,
Reference iPoint)

Replaces a point in the list at the given position.

Parameters:

oPoint
Point
iPos
Replace position
Parameters:
Return type:

None

set_closing(i_closing_type: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetClosing(long iClosingType)

Activates the closing option of the spline.

Parameters:

iClosingType
The spline closing option
Parameters:

i_closing_type (int) –

Return type:

None

set_point_after(i_pos: int, ip_ia_point: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetPointAfter(long iPos,
Reference ipIAPoint)

Sets the Point After a given position.

Parameters:

iPos
The position reference (0 < position < Nbpt)
ipIAPoint
Point
Parameters:

  • i_pos (int) –

  • ip_ia_point (Reference) –

Return type:

None

set_point_before(i_pos: int, ip_ia_point: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetPointBefore(long iPos,
Reference ipIAPoint)

Sets the Point Before a given position.

Parameters:

iPos
The position reference (1 < position < Nbpt+1)
ipIAPoint
Point
Parameters:

  • i_pos (int) –

  • ip_ia_point (Reference) –

Return type:

None

set_point_constraint_explicit(i_pos: int, ip_ia_dir_tangency: HybridShapeDirection, i_tangency_norm: float, i_inverse_tangency: int, ip_ia_dir_curvature: HybridShapeDirection, i_curvature_radius: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetPointConstraintExplicit(long iPos,
HybridShapeDirection ipIADirTangency,
double iTangencyNorm,
long iInverseTangency,
HybridShapeDirection ipIADirCurvature,
double iCurvatureRadius)

Sets the Constraint of the point at iPos.
Available for Explicit Point Constraint type (CstType =1 from
GetContraintType)

Parameters:

iPos
The position of the point to retrieve
ipIADirTangency
Tangent direction.
iTangencyNorm
Tension.
iInverseTangency
Flag to reverse tangent direction (value can be 1 or -1).

ipIADirCurvature
Curvature direction.
iCurvatureRadius
Curvature radius value.
Parameters:
Return type:

None

set_point_constraint_from_curve(i_pos: int, ip_ia_curve_cst: Reference, i_tangency_norm: float, i_invert_value: int, i_crv_cst_type: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetPointConstraintFromCurve(long iPos,
Reference ipIACurveCst,
double iTangencyNorm,
long iInvertValue,
long iCrvCstType)

Sets the Constraint of the point at iPos.
Available for From Curve Point Constraint type (CstType =2 from
GetContraintType)

Parameters:

iPos
The position of the point to retrieve
ipIACurveCst
Curvature direction.
iTangencyNorm
tension factor for tangency.
iInvertValue
Orientation for tangent
iCrvCstType
Continuity type for Curve Constraint (1=Tangency , 2-=
Curvature).
Parameters:

  • i_pos (int) –

  • ip_ia_curve_cst (Reference) –

  • i_tangency_norm (float) –

  • i_invert_value (int) –

  • i_crv_cst_type (int) –

Return type:

None

set_spline_type(i_spline_type: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetSplineType(long iSplineType)

Sets the spline type.

Parameters:

iSplineType
The spline type
Legal values: Cubic spline (0) or WilsonFowler (1)
Parameters:

i_spline_type (int) –

Return type:

None

set_support(i_support: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetSupport(Reference iSupport)

Sets the spline support surface.
Have your “tangent direction” tangent to this support is
recommended.

Parameters:

iSupport
The spline support surface.
Sub-element(s) supported (see

Boundary object): Face.
Parameters:

i_support (Reference) –

Return type:

None