pycatia.dnb_human_modeling_interfaces.swkik_manager

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.swkik_manager.SWKIKManager(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
SWKIKManager

This interface represents the IK manager of the manikin.
The methods on this interface allow to move the manikin in inverse
kinematics.
add_constraint(pi_end_effector: str) → SWKIKConstraint

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddConstraint(CATBSTR piEndEffector) As
SWKIKConstraint

Add a constraint with the given end effector.

Parameters:

piEndEffector
The short name of the last segment (the end of the chain, i.e. the
end effector).
poConstraint
The constraint created.
Parameters:

pi_end_effector (str) –

Return type:

SWKIKConstraint

add_constraint_from(pi_constraint_from: SWKIKConstraint, po_created_constraint: SWKIKConstraint) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub AddConstraintFrom(SWKIKConstraint piConstraintFrom,
SWKIKConstraint poCreatedConstraint)

Add a new constraint identical to the one given.

Parameters:

piConstraintFrom
The constraint to copy.
poCreatedConstraint
The new constraint
Parameters:
Return type:

None

property behavior: str

Note

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

Returns or sets the IK behaviors for this manikin. The string in this
property is the concatenation of the current IK behaviors, like
“Thoracic/Lumbar/Balance”.
Return type:

str

get_constraint(pi_index: int) → SWKIKConstraint

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetConstraint(long piIndex) As SWKIKConstraint

Returns the constraint at index piIndex. First element is at index 0.
Parameters:

pi_index (int) –

Return type:

SWKIKConstraint

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 IK manager.
Return type:

SWKManikin

property number_of_constraints: int

Note

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

Returns the total number of constraints on the manikin.
Return type:

int

remove_all_constraints() → None

Note

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

Remove all existing constraints on the manikin.
Return type:

None

remove_constraint(pi_constraint_to_remove: SWKIKConstraint) → None

Note

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

Remove the given constraint.

Parameters:

piConstraintToRemove
The constraint to remove.
Parameters:

pi_constraint_to_remove (SWKIKConstraint) –

Return type:

None

resolve() → None

Note

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

Launch the IK solver to minimize the potential functions
of
the constraints (i.e. reach all defined targets).
Will resolve the constraints for this manikin only.
Return type:

None