Navigation
API > API/Plugins > API/Plugins/ControlRig
Creates an item array based on the direct or recursive children of a provided parent item. Returns an empty array for an invalid parent item.
| Name | FRigUnit_CollectionChildrenArray |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Execution/RigUnit_Collection.h |
| Include Path | #include "Units/Execution/RigUnit_Collection.h" |
Syntax
USTRUCT (
Meta=(DisplayName="Get Children", Category="Hierarchy", Keywords="Bone,Joint,Collection,Filter,Parent", Varying))
struct FRigUnit_CollectionChildrenArray : public FRigUnit_CollectionBase
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnit_CollectionBase → FRigUnit_CollectionChildrenArray
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_CollectionChildrenArray() |
Units/Execution/RigUnit_Collection.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDefaultChildren | bool | When true, it will return all children, regardless of whether the parent is active or not. | Units/Execution/RigUnit_Collection.h |
|
| bIncludeParent | bool | Units/Execution/RigUnit_Collection.h |
|
|
| bRecursive | bool | Units/Execution/RigUnit_Collection.h |
|
|
| Items | TArray< FRigElementKey > | Units/Execution/RigUnit_Collection.h |
|
|
| Parent | FRigElementKey | Units/Execution/RigUnit_Collection.h |
|
|
| TypeToSearch | ERigElementType | Units/Execution/RigUnit_Collection.h |
|
Functions
Public
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Units/Execution/RigUnit_Collection.h |