pycatia.structure_interfaces.str_member_extremity

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

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.structure_interfaces.str_member_extremity.StrMemberExtremity(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
StrMemberExtremity

Represents an extremity of a member object.
One is called the start extremity and the other the end
extremity.
add_offset(i_offset: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddOffset(double iOffset)

Adds an offset on the extremity. This method has to be used when the
extremity has no offset already defined, else you will get an error.
Parameters:

i_offset (float) –

Return type:

None

property angle_cut: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AngleCut() As double (Read Only)

Returns the angle cut for a member extremity.
Return type:

float

property cutback: StrCutback

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Cutback() As StrCutback (Read Only)

Returns the cutback object.
Return type:

StrCutback

get_coordinates() → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetCoordinates(CATSafeArrayVariant oCoordinates)

Retrieves the coordinates of the extremity.

Parameters:

oCoordinates
The coordinates of the the extremity
Parameters:

o_coordinates (tuple) –

Return type:

None

property input: Reference

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Input() As Reference

Returns or sets the input object defining the extremity. The input object
may not belong to the support object.
Return type:

Reference

property offset: Parameter

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Offset() As Parameter (Read Only)

Returns the offset parameter defined on this extremity. This parameter can
be null.
Return type:

Parameter

property point: Point

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Point() As Point (Read Only)

Returns the point defining the extremity. This point belongs to the support
object.
Return type:

Point

reset_cutback() → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ResetCutback()

Resets the defined cutback object.
Return type:

None

set_extremity_from_coordinates(i_coordinates: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetExtremityFromCoordinates(CATSafeArrayVariant
iCoordinates)

Modifies the coordinates of the extremity defined by a
point.

Parameters:

iCoordinates
The coordinates to modify the extremity
Parameters:

i_coordinates (tuple) –

Return type:

None