pycatia.dnb_human_modeling_interfaces.swk_body_element

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.dnb_human_modeling_interfaces.swk_body_element.SWKBodyElement(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
SWKBodyElement

This interface is used to access a body element (segment, ellipse,
…) It provides common services for all body elements of the
manikin.
property full_name: str

Note

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

Returns the full name of the body element.
This property is different from the property
Name of AnyObject,
which gives the short name or abbreviated name
of the body element.

For instance, if the body element in question is
the left leg segment, then property Name
yields “LSLeLe”, whereas
property FullName yields the character
string “Left Leg”.
Return type:

str

get_global_position(po_global_position: tuple) → None

Note

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

Returns the global position ofthe body element.
If this body element is the body, then the position returned
is the global position of the manikin. If the
body element is a segment or a line of sight, the position
returned is the global position of the beginning of that segment
or line of sight. If the body element is an ellipse, the global
position of the center of that ellipse is returned.
Parameters:

po_global_position (tuple) –

Return type:

None

property manikin: SWKManikin

Note

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

Returns the manikin which owns this body element.
Return type:

SWKManikin

property position_x: float

Note

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

Returns the x coordinate of the position of the body
element.
If this body element is the body, then the position returned is
the x-coordinate of global position of the manikin. If the
body element is a segment or a line of sight, the position
returned is the x-coordinate of the beginning of that segment
or line of sight. If the body element is an ellipse, the
x-coordinate of the center of that ellipse is returned.
Return type:

float

property position_y: float

Note

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

Returns the y coordinate of the position of the body
element.
If this body element is the body, then the position returned is
the y-coordinate of global position of the manikin. If the
body element is a segment or a line of sight, the position
returned is the y-coordinate of the beginning of that segment
or line of sight. If the body element is an ellipse, the
y-coordinate of the center is returned.
Return type:

float

property position_z: float

Note

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

Returns the z coordinate of the position of the body
element.
If this body element is the body, then the position returned is
the z-coordinate of global position of the manikin. If the
body element is a segment or a line of sight, the position
returned is the z-coordinate of the beginning of that segment
or line of sight. If the body element is an ellipse, the
z-coordinate of the center is returned.
Return type:

float

refresh_3d() → None

Note

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

Refreshes the 3D representation of the current element.
Return type:

None

property refresh_display: bool

Note

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

Enables or disables the update of the display during the
script replay.
To improve performance, this update can be temporarily
disabled by setting this property to False in the script.

The property is True if the elements display is refreshed after each
posture change (value set by default).

Example:
This example makes the update of a manikin display disabled during a
portion of the script replay.

myManikin.Body.RefreshDisplay = False
Return type:

bool