Navigation
API > API/Plugins > API/Plugins/ControlRig
Given a pose, execute iteratively across all items in the pose
| Name | FRigUnit_PoseLoop |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Execution/RigUnit_Hierarchy.h |
| Include Path | #include "Units/Execution/RigUnit_Hierarchy.h" |
Syntax
USTRUCT (
Meta=(DisplayName="For Each Pose Cache Element", Keywords="Collection,Loop,Iterate", Icon="EditorStyle|GraphEditor.Macro.ForEach_16x", Category="Pose Cache"))
struct FRigUnit_PoseLoop : public FRigUnit_HierarchyBaseMutable
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnitMutable → FRigUnit_HierarchyBaseMutable → FRigUnit_PoseLoop
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_PoseLoop() |
Units/Execution/RigUnit_Hierarchy.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BlockToRun | FName | Units/Execution/RigUnit_Hierarchy.h |
|
|
| Completed | FControlRigExecuteContext | Units/Execution/RigUnit_Hierarchy.h |
|
|
| Count | int32 | Units/Execution/RigUnit_Hierarchy.h |
|
|
| CurveValue | float | Units/Execution/RigUnit_Hierarchy.h |
|
|
| GlobalTransform | FTransform | Units/Execution/RigUnit_Hierarchy.h |
|
|
| Index | int32 | Units/Execution/RigUnit_Hierarchy.h |
|
|
| Item | FRigElementKey | Units/Execution/RigUnit_Hierarchy.h |
|
|
| LocalTransform | FTransform | Units/Execution/RigUnit_Hierarchy.h |
|
|
| Pose | FRigPose | Units/Execution/RigUnit_Hierarchy.h |
|
|
| Ratio | float | 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. | Units/Execution/RigUnit_Hierarchy.h |
|
Functions
Public
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Units/Execution/RigUnit_Hierarchy.h | ||
| Units/Execution/RigUnit_Hierarchy.h | |||
virtual int32 GetNumSlices() |
Units/Execution/RigUnit_Hierarchy.h | ||
virtual const bool IsControlFlowBlockSliced
(
const FName& InBlockName |
Units/Execution/RigUnit_Hierarchy.h |