unreal.RigUnit_TwoBoneIKFK

class unreal.RigUnit_TwoBoneIKFK(execute_context: ControlRigExecuteContext = [], start_joint: Name = 'None', end_joint: Name = 'None', pole_target: Vector = Ellipsis, spin: float = 0.0, end_effector: Transform = Ellipsis, ik_blend: float = 0.0)

Bases: RigUnitMutable

Rig Unit Two Bone IKFK

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigUnit_TwoBoneIKFK.h

Editor Properties: (see get_editor_property/set_editor_property)

  • end_effector (Transform): [Read-Write] End Effector: # Transform to use as the end effector of the IK system

  • end_joint (Name): [Read-Write] End Joint

  • end_joint_fk_transform (Transform): [Read-Write] End Joint FKTransform

  • execute_context (ControlRigExecuteContext): [Read-Write] Execute Context: * This property is used to chain multiple mutable units together

  • ik_blend (float): [Read-Write] IKBlend: Float : IKBlend(Default : 0.0) # Blend between 0.0 (FK) and 1.0 (IK)solutions

  • mid_joint_fk_transform (Transform): [Read-Write] Mid Joint FKTransform

  • pole_target (Vector): [Read-Write] Pole Target: # Transform to use as the pole target(specifies the plane of solution)

  • spin (float): [Read-Write] Spin: Float: Spin(Default : 0.0) # Amount of twist to apply to the solution plane(Additive after application of Pole Target motion)

  • start_joint (Name): [Read-Write] Start Joint

  • start_joint_fk_transform (Transform): [Read-Write] Start Joint FKTransform: Transform : Start Joint FK Transform # Transform for the Start Joint when in FK mode Transform: Mid Joint FK Transform # Transform for the Mid Joint when in FK mode Transform : End Joint FK Transform # Transform for the End Joint when in FK mode

property end_effector: Transform

[Read-Write] End Effector: # Transform to use as the end effector of the IK system

Type:

(Transform)

property end_joint: Name

[Read-Write] End Joint

Type:

(Name)

property ik_blend: float

[Read-Write] IKBlend: Float : IKBlend(Default : 0.0) # Blend between 0.0 (FK) and 1.0 (IK)solutions

Type:

(float)

property pole_target: Vector

[Read-Write] Pole Target: # Transform to use as the pole target(specifies the plane of solution)

Type:

(Vector)

property spin: float

[Read-Write] Spin: Float: Spin(Default : 0.0) # Amount of twist to apply to the solution plane(Additive after application of Pole Target motion)

Type:

(float)

property start_joint: Name

[Read-Write] Start Joint

Type:

(Name)