unreal.RigUnit_FABRIKPerItem

class unreal.RigUnit_FABRIKPerItem(execute_pin: RigVMExecutePin = [], items: RigElementKeyCollection = Ellipsis, effector_transform: Transform = Ellipsis, precision: float = 0.0, weight: float = 0.0, propagate_to_children: bool = False, max_iterations: int = 0, set_effector_transform: bool = False)

Bases: RigUnit_HighlevelBaseMutable

The FABRIK solver can solve N-Bone chains using the Forward and Backward Reaching Inverse Kinematics algorithm. For now this node supports single effector chains only.

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigUnit_FABRIK.h

Editor Properties: (see get_editor_property/set_editor_property)

  • effector_transform (Transform): [Read-Write] The transform of the effector in global space

  • execute_pin (RigVMExecutePin): [Read-Write] * This property is used to chain multiple mutable units together

  • items (RigElementKeyCollection): [Read-Write] The chain to use

  • max_iterations (int32): [Read-Write] The maximum number of iterations. Values between 4 and 16 are common.

  • precision (float): [Read-Only] The precision to use for the fabrik solver

  • propagate_to_children (bool): [Read-Only] If set to true all of the global transforms of the children of this bone will be recalculated based on their local transforms. Note: This is computationally more expensive than turning it off.

  • set_effector_transform (bool): [Read-Write] The option to set the effector transform

  • weight (float): [Read-Write] The weight of the solver - how much the IK should be applied.

property effector_transform: Transform

[Read-Write] The transform of the effector in global space

Type:

(Transform)

property items: RigElementKeyCollection

[Read-Write] The chain to use

Type:

(RigElementKeyCollection)

property max_iterations: int

[Read-Write] The maximum number of iterations. Values between 4 and 16 are common.

Type:

(int32)

property precision: float

[Read-Only] The precision to use for the fabrik solver

Type:

(float)

property propagate_to_children: bool

[Read-Only] If set to true all of the global transforms of the children of this bone will be recalculated based on their local transforms. Note: This is computationally more expensive than turning it off.

Type:

(bool)

property set_effector_transform: bool

[Read-Write] The option to set the effector transform

Type:

(bool)

property weight: float

[Read-Write] The weight of the solver - how much the IK should be applied.

Type:

(float)