pycatia.cat_plant_ship_interfaces.psp_light_connector

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.cat_plant_ship_interfaces.psp_light_connector.PSPLightConnector(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
PspLightConnector

Represents the light connector.
Role: To access light connector data.
get_alignment_vector(i_rel_axis: Product) → PSPListOfDoubles

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAlignmentVector(Product iRelAxis) As
PspListOfDoubles

Returns the position of the connector.

Parameters:

iRelAxis
the relative axis object (Nothing means relative to parent)

oAlignmentDirection
Three double values stand for X,Y,Z components of the alignment
vector

Example:

Dim objThisIntf As PspLightConnector
Dim objArg1 As Product
Dim objArg2 As PspListOfDoubles
…
Set objArg2 = objThisIntf.GetAlignmentVector (objArg1)
Parameters:

i_rel_axis (Product) –

Return type:

PSPListOfDoubles

get_orientation_vector(i_rel_axis: Product) → PSPListOfDoubles

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetOrientationVector(Product iRelAxis) As
PspListOfDoubles

Returns the Orientation Direction of the connector.

Parameters:

iRelAxis
the relative axis object (Nothing means relative to parent)

oAlignmentDirection
Three double values stand for X,Y,Z components of the alignment
vector

Example:

Dim objThisIntf As PspLightConnector
Dim objArg1 As Product
Dim objArg2 As PspListOfDoubles
…
Set objArg2 = objThisIntf.GetOrientationVector (objArg1)
Parameters:

i_rel_axis (Product) –

Return type:

PSPListOfDoubles

get_origin(i_rel_axis: Product) → PSPListOfDoubles

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetOrigin(Product iRelAxis) As PspListOfDoubles

Returns the position of the connector.

Parameters:

iRelAxis
the relative axis object (Nothing means relative to parent)

oOrigin
Origin point position-three double values stand for x,y,z

Example:

Dim objThisIntf As PspLightConnector
Dim objArg1 As Product
Dim objArg2 As PspListOfDoubles
…
Set objArg2 = objThisIntf.GetOrigin (objArg1)
Parameters:

i_rel_axis (Product) –

Return type:

PSPListOfDoubles

set_alignment_vector(i_rel_axis: Product, i_alignment_direction: tuple) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAlignmentVector(Product iRelAxis,
CATSafeArrayVariant iAlignmentDirection)

Sets the alignment direction of the connector.

Parameters:

iRelAxis
the relative axis object (Nothing means relative to parent)

iAlignmentDirection
Three double values stand for X,Y,Z component of the Alignment
vector

Example:

Dim objThisIntf As PspLightConnector
Dim objArg1 As Product
Dim dbVar2(2) As CATSafeArrayVariant
…
objThisIntf.SetAlignmentVector objArg1, dbVar2
Parameters:

  • i_rel_axis (Product) –

  • i_alignment_direction (tuple) –

Return type:

tuple

set_orientation_vector(i_rel_axis: Product, i_orientation_direction: tuple) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetOrientationVector(Product iRelAxis,
CATSafeArrayVariant iOrientationDirection)

Sets the Orientation Direction of the connector.

Parameters:

iRelAxis
the relative axis object (Nothing means relative to parent)

iAlignmentDirection
Three double values stand for X,Y,Z component of the Alignment
vector

Example:

Dim objThisIntf As PspLightConnector
Dim objArg1 As Product
Dim dbVar2(2) As CATSafeArrayVariant
…
objThisIntf.SetAlignmentVector objArg1, dbVar2
Parameters:

  • i_rel_axis (Product) –

  • i_orientation_direction (tuple) –

Return type:

tuple

set_origin(i_rel_axis: Product, i_db3_position: tuple) → tuple

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetOrigin(Product iRelAxis,
CATSafeArrayVariant iDb3Position)

Sets the position of the connector.

Parameters:

iRelAxis
the relative axis object (Nothing means relative to parent)

iDb3Position
absolute X-Y-Z coordinates of the current position of the connector
to be set

Example:

Dim objThisIntf As PspLightConnector
Dim objArg1 As Product
Dim dbVar2(3) As CATSafeArrayVariant
…
objThisIntf.SetOrigin objArg1, dbVar2
Parameters:

  • i_rel_axis (Product) –

  • i_db3_position (tuple) –

Return type:

tuple