unreal.RigUnit_PoseLoop

class unreal.RigUnit_PoseLoop(execute_pin: RigVMExecutePin = [], pose: RigPose = [], item: RigElementKey = Ellipsis, global_transform: Transform = Ellipsis, local_transform: Transform = Ellipsis, curve_value: float = 0.0, index: int = 0, count: int = 0, ratio: float = 0.0, completed: ControlRigExecuteContext = [])

Bases: RigUnit_HierarchyBaseMutable

Given a pose, execute iteratively across all items in the pose

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: RigUnit_Hierarchy.h

Editor Properties: (see get_editor_property/set_editor_property)

  • completed (ControlRigExecuteContext): [Read-Write] The branch to run when the loop has completed

  • count (int32): [Read-Write] The overall count of entries in the pose

  • curve_value (float): [Read-Write] The curve value for the current pose entry

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

  • global_transform (Transform): [Read-Write] The global transform for the current pose entry

  • index (int32): [Read-Write] The index of the current pose entry

  • item (RigElementKey): [Read-Write] The item for the current pose entry

  • local_transform (Transform): [Read-Write] The local transform for the current pose entry

  • pose (RigPose): [Read-Write] The pose to loop over

  • ratio (float): [Read-Write] Ranging from 0.0 (first item) and 1.0 (last item) This is useful to drive a consecutive node with a curve or an ease to distribute a value.

property completed: ControlRigExecuteContext

[Read-Only] The branch to run when the loop has completed

Type:

(ControlRigExecuteContext)

property count: int

[Read-Only] The overall count of entries in the pose

Type:

(int32)

property curve_value: float

[Read-Only] The curve value for the current pose entry

Type:

(float)

property global_transform: Transform

[Read-Only] The global transform for the current pose entry

Type:

(Transform)

property index: int

[Read-Only] The index of the current pose entry

Type:

(int32)

property item: RigElementKey

[Read-Only] The item for the current pose entry

Type:

(RigElementKey)

property local_transform: Transform

[Read-Only] The local transform for the current pose entry

Type:

(Transform)

property pose: RigPose

[Read-Write] The pose to loop over

Type:

(RigPose)

property ratio: float

[Read-Only] Ranging from 0.0 (first item) and 1.0 (last item) This is useful to drive a consecutive node with a curve or an ease to distribute a value.

Type:

(float)