pycatia.in_interfaces.position

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.in_interfaces.position.Position(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
InfInterfaces.Move
Position

Represents the position object.
The position object is the 3D-axis system associated with an
object.
get_components() → tuple

Note

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

Returns the components of an object’s position. This returns the 3D-axis
system associated with the object.

Parameters:

oAxisComponentsArray
The array used to store the twelve components retrieved from the
objet’s position. The first nine represent succcessively the components of the
x-axis, y-axis, and z-axis. The last three represent the coordinates of the
origin point.

Example:

This example retrieves in oAxisComponentsArray
the 3D-axis system components from
the Position object associated with MyObject:


Dim oAxisComponentsArray ( 11 )
MyObject.Position.GetComponents oAxisComponentsArray
Return type:

tuple

set_components(i_axis_components_array: tuple) → None

Note

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

Sets the components of an object’s position. This sets the 3D-axis system
associated with the object.

Parameters:

iAxisComponentsArray
The array initialized with the components to set to the object’s
position. The first nine represent succcessively the components of the x-axis,
y-axis, and z-axis. The last three represent the coordinates of the origin
point.

Example:

This example sets the 3D-axis system components stored
in
iAxisComponentsArray to
the Position object associated with MyObject:


Dim iAxisComponentsArray( 11 )
‘ x axis components
iAxisComponentsArray( 0 ) = 1.000
iAxisComponentsArray( 1 ) = 0
iAxisComponentsArray( 2 ) = 0.707
‘ y axis components
iAxisComponentsArray( 3 ) = 0
iAxisComponentsArray( 4 ) = 0
iAxisComponentsArray( 5 ) = 0.707
‘ z axis components
iAxisComponentsArray( 6 ) = 0
iAxisComponentsArray( 7 ) = -0.707
iAxisComponentsArray( 8 ) = 0.707
‘ origin point coordinates
iAxisComponentsArray( 9 ) = 1.000
iAxisComponentsArray( 10 ) = 2.000
iAxisComponentsArray( 11 ) = 3.000
MyObject.Position.SetComponents iAxisComponentsArray
Parameters:

i_axis_components_array (tuple) –

Return type:

None