Navigation
API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/URigHierarchy
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetActiveParent
(
int32 InIndex |
Get the current active parent for a given element index. | Rigs/RigHierarchy.h | |
FRigBaseElement * GetActiveParent
(
const FRigBaseElement* InElement |
Get the current active parent for the passed in key. | Rigs/RigHierarchy.h | |
FRigElementKey GetActiveParent
(
const FRigElementKey& InKey, |
Get the current active parent for the passed in key. | Rigs/RigHierarchy.h |
GetActiveParent(int32)
Description
Get the current active parent for a given element index. This is only valid when only one parent has a weight value and the other parents have zero weights
| Name | GetActiveParent |
| Type | function |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchy.h |
| Include Path | #include "Rigs/RigHierarchy.h" |
| Source | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Private/Rigs/RigHierarchy.cpp |
int32 GetActiveParent
(
int32 InIndex
) const
Returns the first parent index (or INDEX_NONE) with a non-zero weight
Parameters
| Name | Remarks |
|---|---|
| InIndex | The index of the element to retrieve the parent for |
GetActiveParent(const FRigBaseElement *)
Description
Get the current active parent for the passed in key. This is only valid when only one parent has a weight value and the other parents have zero weights
| Name | GetActiveParent |
| Type | function |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchy.h |
| Include Path | #include "Rigs/RigHierarchy.h" |
| Source | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Private/Rigs/RigHierarchy.cpp |
FRigBaseElement * GetActiveParent
(
const FRigBaseElement * InElement
) const
Returns the first parent with a non-zero weight
Parameters
| Name | Remarks |
|---|---|
| InElement | The element to retrieve the parents for |
GetActiveParent(const FRigElementKey &, bool)
Description
Get the current active parent for the passed in key. This is only valid when only one parent has a weight value and the other parents have zero weights
| Name | GetActiveParent |
| Type | function |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchy.h |
| Include Path | #include "Rigs/RigHierarchy.h" |
| Source | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Private/Rigs/RigHierarchy.cpp |
FRigElementKey GetActiveParent
(
const FRigElementKey & InKey,
bool bReferenceKey
) const
Returns the first parent with a non-zero weight
Parameters
| Name | Remarks |
|---|---|
| InKey | The multi parented element |
| bReferenceKey | Whether or not to return a reference key |