pycatia.cat_sch_platform_interfaces.sch_grr_comp

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_sch_platform_interfaces.sch_grr_comp.SchGRRComp(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

SchGRRComp

Manage the graphical representation of a schematic component.

get_position(o_db2_position: SchListOfDoubles) → None

Note

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

o Sub GetPosition(SchListOfDoubles oDb2Position)

Get the current position of the component.

Parameters:

oDb2Position

The current position of the component.

Example:

Dim objThisIntf As SchGRRComp

Dim objArg1 As SchListOfDoubles

…

objThisIntf.GetPositionobjArg1

Parameters:

o_db2_position (SchListOfDoubles) –

Return type:

None

get_rotation_angle(o_db1_rotation_angle_in_rad: float) → None

Note

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

o Sub GetRotationAngle(double oDb1RotationAngleInRad)

Get the current rotation angle (from x-axis in radian) of the

component.

Parameters:

oDb1RotationAngleInRad

The current angle of the component in radian.

Example:

Dim objThisIntf As SchGRRComp

Dim dbVar As Double;

…

objThisIntf.GetRotationAngledbVar

Parameters:

o_db1_rotation_angle_in_rad (float) –

Return type:

None

get_scale(o_db1_scale_factor: float) → None

Note

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

o Sub GetScale(double oDb1ScaleFactor)

Get the current scale factor of the component.

Parameters:

oDb1ScaleFactor

The current scale factor of the component.

Example:

Dim objThisIntf As SchGRRComp

Dim dbVar As Double;

…

objThisIntf.GetScaledbVar

Parameters:

o_db1_scale_factor (float) –

Return type:

None

get_transformation2_d(o_db6_trans_matrix: SchListOfDoubles) → None

Note

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

o Sub GetTransformation2D(SchListOfDoubles oDb6TransMatrix)

Get the local coordinate reference frame (with respect to absolute

coordinate system) of the component.

Parameters:

oDb6TransMatrix

An double array of 6 members. Transformation matrix that defines

the local coordinate reference frame of the component member 1, 2 - defines the

x-axis of the local coordinate reference frame. member 3, 4 - defines the

y-axis of the local coordinate reference frame. member 5, 6 - defines the

origin of the local coordinate reference frame One can also interpret this as

the transformation matrix that would move the component from the absolute

coordinate frame to the current position and orientation. As such, the member

5,6 define the translational vector Furthemore, rotation angle and scale factor

can be calculated from member 1 to 4.

Example:

Dim objThisIntf As SchGRRComp

Dim objArg1 As SchListOfDoubles

…

objThisIntf.GetTransformation2DobjArg1

Parameters:

o_db6_trans_matrix (SchListOfDoubles) –

Return type:

None

set_position(o_db2_position: tuple) → tuple

Note

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

o Sub SetPosition(CATSafeArrayVariant oDb2Position)

Set the current position of the component.

Parameters:

iDb2Position

The position of the component to be set.

Example:

Dim objThisIntf As SchGRRComp

Dim dbVar1(x) As CATSafeArrayVariant

…

objThisIntf.SetPositiondbVar1

Parameters:

o_db2_position (tuple) –

Return type:

tuple

set_rotation_angle(i_db1_rotation_angle_in_rad: float) → None

Note

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

o Sub SetRotationAngle(double iDb1RotationAngleInRad)

Set the current rotation angle (from x-axis in radian) of the

component.

Parameters:

iDb1RotationAngleInRad

The rotation angle of the component in radian to be set.

Example:

Dim objThisIntf As SchGRRComp

Dim dbVar As Double;

…

objThisIntf.SetRotationAngledbVar

Parameters:

i_db1_rotation_angle_in_rad (float) –

Return type:

None

set_scale(i_db1_scale_factor: float) → None

Note

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

o Sub SetScale(double iDb1ScaleFactor)

Set the current scale factor of the component.

Parameters:

iDb1ScaleFactor

The scale factor of the component to be set.

Example:

Dim objThisIntf As SchGRRComp

Dim dbVar As Double;

…

objThisIntf.SetScaledbVar

Parameters:

i_db1_scale_factor (float) –

Return type:

None

set_transformation2_d(i_db6_trans_matrix: tuple) → tuple

Note

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

o Sub SetTransformation2D(CATSafeArrayVariant

iDb6TransMatrix)

Set the local coordinate reference frame (with respect to absolute

coordinate system) of the component.

Parameters:

iDb6TransMatrix

Transformation matrix to be set. See

GetTransformation2D for explanation of this argument.

Example:

Dim objThisIntf As SchGRRComp

Dim dbVar1(6) As CATSafeArrayVariant

…

objThisIntf.SetTransformation2DdbVar1

Parameters:

i_db6_trans_matrix (tuple) –

Return type:

tuple