pycatia.hybrid_shape_interfaces.hybrid_shape_line_pt_dir

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_line_pt_dir.HybridShapeLinePtDir(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

CATGSMIDLItf.Line

HybridShapeLinePtDir

Line defined by a point and a direction.

Role: To access data of the line feature created by using a passing point and a

direction.

Use the CATIAHybridShapeFactory to create a HybridShapeLinePtDir

object.

See also:

Reference

See also:

Length

See also:

HybridShapeDirection

See also:

HybridShapeFactory

property begin_offset: Length

Note

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

o Property BeginOffset() As Length (Read Only)

Returns the start length of the line.

Start length : extension of the line, beginning at the starting point

Example:

This example retrieves in oStart the beginning offset length for the

LinePtDir hybrid shape feature.

Dim oStart As CATIALength

Set oStart = LinePtDir.BeginOffset

Return type:

Length

property dir: HybridShapeDirection

Note

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

o Property Dir() As HybridShapeDirection

Returns or Sets the direction of the line.

Example:

This example retrieves in oDir the direction for the LinePtDir hybrid

shape feature.

Dim oDir As CATIAHybridShapeDirection

Set oDir = LinePtDir.Dir

Return type:

HybridShapeDirection

property end_offset: Length

Note

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

o Property EndOffset() As Length (Read Only)

Returns the end length of the line.

End length : extension of the line, beginning at the ending point

Example:

This example retrieves in oEnd the starting length for the LinePtDir

hybrid shape feature.

Dim oEnd As CATIALength

Set oEnd = LinePtDir.EndOffset

Return type:

Length

get_length_type() → int

Note

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

o Func GetLengthType() As long

Gets the length type Default is 0.

Parameters:

oType

The length type = 0 : length - the line is limited by its extremities =

1 : infinite - the line is infinite = 2 : infinite start point - the line is infinite on

the side of the start point = 3 : infinite end point - the line is infinite on the side

of the end point

Return type:

int

get_symmetrical_extension() → bool

Note

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

o Func GetSymmetricalExtension() As boolean

Gets whether the symmetrical extension of the line is

active.

Parameters:

oSym

Symetry flag

Return type:

bool

property orientation: int

Note

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

o Property Orientation() As long

Returns or Sets the line orientation.

Orientation allows to reverse the line direction from the reference

point.

For a line of L length, it is the same as creating this line with -L length :

Orientation : can be 1 or -1

Example:

This example retrieves in oOrientation the starting length for the

LinePtDir hybrid shape feature.

Dim oOrientation As long

Set oOrientation = LinePtDir.Orientation

Return type:

int

property point: Reference

Note

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

o Property Point() As Reference

Returns or Sets the starting point of the line.

Sub-element(s) supported (see Boundary object): Vertex.

Example:

This example retrieves in oPoint the starting point for the LinePtDir

hybrid shape feature.

Dim oPoint As Reference

Set oPoint = LinePtDir.Point

Return type:

Reference

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

set_length_type(i_type: int) → None

Note

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

o Sub SetLengthType(long iType)

Sets the length type Default is 0.

Parameters:

iType

The length type = 0 : length - the line is limited by its extremities =

1 : infinite - the line is infinite = 2 : infinite start point - the line is infinite on

the side of the start point = 3 : infinite end point - the line is infinite on the side

of the end point

Parameters:

i_type (int) –

Return type:

None

set_symmetrical_extension(i_sym: bool) → None

Note

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

o Sub SetSymmetricalExtension(boolean iSym)

Sets the symmetrical extension of the line (start = -end).

Parameters:

iSym

Symetry flag

Parameters:

i_sym (bool) –

Return type:

None

property support: Reference

Note

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

o Property Support() As Reference

Returns or Sets the supporting surface.

Note: the support surface is not mandatory for LinePtDir

Sub-element(s) supported (see Boundary object): Face.

Example:

This example retrieves in oSurface the supporting surface (if it exist)

for the LinePtDir hybrid shape feature.

Dim oSurface As Reference

Set oSurface = LinePtDir.Surface

Return type:

Reference