Navigation
API > API/Plugins > API/Plugins/ControlRig
Returns a chain between two items
| Name | FRigUnit_HierarchyGetChainItemArray |
| 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="Get Chain", Keywords="Chain,Siblings,Hierarchy", Varying))
struct FRigUnit_HierarchyGetChainItemArray : public FRigUnit_HierarchyBase
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnit_HierarchyBase → FRigUnit_HierarchyGetChainItemArray
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_HierarchyGetChainItemArray() |
Units/Execution/RigUnit_Hierarchy.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIncludeEnd | bool | If True the list of results will include the last element. | Units/Execution/RigUnit_Hierarchy.h |
|
| bIncludeStart | bool | If True the list of results will include the first element. | Units/Execution/RigUnit_Hierarchy.h |
|
| bReverse | bool | If True the list of results will be reversed. | Units/Execution/RigUnit_Hierarchy.h |
|
| CachedChain | FRigElementKeyCollection | Used to cache the internally used siblings. | Units/Execution/RigUnit_Hierarchy.h | |
| CachedEnd | FCachedRigElement | Used to cache the internally used item. | Units/Execution/RigUnit_Hierarchy.h | |
| CachedStart | FCachedRigElement | Used to cache the internally used item. | Units/Execution/RigUnit_Hierarchy.h | |
| Chain | TArray< FRigElementKey > | The resulting array of elements on the chain. | Units/Execution/RigUnit_Hierarchy.h |
|
| End | FRigElementKey | The last element of the chain. | Units/Execution/RigUnit_Hierarchy.h |
|
| Start | FRigElementKey | The first element of the chain. | Units/Execution/RigUnit_Hierarchy.h |
|
Functions
Public
Public Virtual
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Units/Execution/RigUnit_Hierarchy.h |