pycatia.hybrid_shape_interfaces.line

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.line.Line(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
Line

Represents the hybrid shape Line feature object.
Role: Declare hybrid shape Line root feature object. All interfaces for
different type of Line derives HybridShapeLine.

Use the CATIAHybridShapeFactory to create a HybridShapeLine
objects.

See also:
HybridShapeFactory
property first_upto_elem: Reference

Note

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

Role: Gets the First upto element of the line.

Parameters:

oFirstUpto

Returns:
HRESULT S_OK if Ok E_FAIL else
Return type:

Reference

get_direction() → tuple

Note

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

Role: Returns the unit-vector pointing in the direction of the
line.

Parameters:

oDirection
oDirection[0]
The X Coordinate of the unit vector pointing in the direction of
the line
oDirection[1]
The Y Coordinate of the unit vector pointing in the direction of
the line
oDirection[2]
The Z Coordinate of the unit vector pointing in the direction of
the line

Returns:
HRESULT S_OK if Ok E_FAIL else return error code for C++
Implementations
See also:
HybridShapeFactory
Return type:

None

get_origin(o_origin: tuple) → None

Note

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

Role: Returns the origin of the line.

Parameters:

oOrigin
oOrigin[0]
The X Coordinate of a point lying on the line
oOrigin[1]
The Y Coordinate of a point lying on the line
oOrigin[2]
The Z Coordinate of a point lying on the line The Origin is
evaluated from the geometry of the line.

Returns:
HRESULT S_OK if Ok E_FAIL else return error code for C++
Implementations
See also:
HybridShapeFactory
Parameters:

o_origin (tuple) –

Return type:

None

put_direction(i_direction: tuple) → None

Note

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

Role: Sets the unit-vector pointing in the direction of the
line.

Parameters:

iDirection
iDirection[0]
The X Coordinate of the unit vector pointing in the direction of
the line
iDirection[1]
The Y Coordinate of the unit vector pointing in the direction of
the line
iDirection[2]
The Z Coordinate of the unit vector pointing in the direction of
the line

Returns:
HRESULT S_OK if Ok E_FAIL else return error code for C++
Implementations
See also:
HybridShapeFactory
Parameters:

i_direction (tuple) –

Return type:

None

property second_upto_elem: Reference

Note

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

Role: Gets the Second upto element of the line.

Parameters:

oSecondUpto

Returns:
HRESULT S_OK if Ok E_FAIL else
Return type:

Reference