pycatia.hybrid_shape_interfaces.hybrid_shape_polyline

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_polyline.HybridShapePolyline(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

HybridShapePolyline

Represents the hybrid shape polyline curve object.

Role: To access or set the data of the hybrid shape polyline object. This data

includes:

Elements

Radius

Closure

Use the HybridShapeFactory object to create a HybridShapePolyline

object.

property closure: bool

Note

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

o Property Closure() As boolean

Returns or sets the flag to decide closure of the

polyline.

Parameters:

Closure

(For get_Closure) Returns or sets the closure

property

Example:

This example retrieves the closure property of the polyline of

the HybShpPolyline hybrid shape polyline.

Dim HybShpPolClosure As boolean

HybShpPolClosure = HybShpPolyline.Closure

Return type:

bool

get_element(i_position: int, o_element: Reference, o_radius: Length) → None

Note

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

o Sub GetElement(long iPosition,

Reference oElement,

Length oRadius)

Returns the element of the polyline.

Parameters:

iPosition

Position at which the element is to be retrieved.

oElement

Reference to the element.

ioRadius

Length to the radius.

Example:

This example retrieves the element and radius of the polyline

at specified position of the HybShpPolyline hybrid shape

polyline.

Dim HybShpPolylineElement As Reference

Dim HybShpPolylineRadius As Reference

HybShpPolyline.GetElement 1,

HybShpPolylineElement,HybShpPolylineRadius

Parameters:

• i_position (int) –

• o_element (Reference) –

• o_radius (Length) –

Return type:

None

insert_element(i_point: Reference, i_position: int) → None

Note

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

o Sub InsertElement(Reference iPoint,

long iPosition)

Inserts the element at a specified position in the

polyline.

Parameters:

iPoint

Reference of the point object to be inserted.

iPosition

Position at which the element should be inserted.

Example:

This example inserts the element in the polyline of the

HybShpPolyline hybrid shape polyline.

HybShpPolyline.InsertElement PointReference,1

Parameters:

• i_point (Reference) –

• i_position (int) –

Return type:

None

property number_of_elements: int

Note

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

o Property NumberOfElements() As long (Read Only)

Returns the number of elements of the polyline.

Parameters:

NumberOfElements

Number of elements in the polyline.

Example:

This example retrieves the number of elements in the polyline

of the HybShpPolyline hybrid shape polyline.

Dim HybShpPolNoOfEle As long

HybShpPolNoOfEle = HybShpPolyline.NumberOfElements

Return type:

int

remove_element(i_position: int) → None

Note

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

o Sub RemoveElement(long iPosition)

Removes the element at a specified position in the

polyline.

Parameters:

iPosition

Position from which the element should be should be

removed.

Example:

This example removes the element in the polyline of the

HybShpPolyline hybrid shape polyline.

HybShpPolyline.RemoveElement 1

Parameters:

i_position (int) –

Return type:

None

replace_element(i_point: Reference, i_position: int) → None

Note

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

o Sub ReplaceElement(Reference iPoint,

long iPosition)

Replaces the element at a specified position in the

polyline.

Parameters:

iPoint

Reference of the point object that will replace the old element.

iPosition

Position at which the element should be inserted.

Example:

This example replaces the element in the polyline of the

HybShpPolyline hybrid shape polyline.

HybShpPolyline.ReplaceElement PointReference, 1

Parameters:

• i_point (Reference) –

• i_position (int) –

Return type:

None

set_radius(i_position: int, i_radius: float) → None

Note

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

o Sub SetRadius(long iPosition,

double iRadius)

Sets the radius at specified position of the polyline.

Parameters:

iPosition

Position at which radius should be set

iRadius

Value of the radius to be set.

Example:

This example sets the radius at the specific position of the

polyline of the HybShpPolyline hybrid shape

polyline.

HybShpPolyline.SetRadius 1, 10

Parameters:

• i_position (int) –

• i_radius (float) –

Return type:

None