Navigation
API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/URigHierarchy
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool SwitchToParent
(
FRigElementKey InChild, |
Switches a multi parent element to a single parent. | Rigs/RigHierarchy.h |
|
bool SwitchToParent
(
FRigBaseElement* InChild, |
Switches a multi parent element to a single parent. | Rigs/RigHierarchy.h | |
bool SwitchToParent
(
FRigElementKey InChild, |
Rigs/RigHierarchy.h | ||
bool SwitchToParent
(
FRigBaseElement* InChild, |
Switches a multi parent element to a single parent. | Rigs/RigHierarchy.h |
SwitchToParent(FRigElementKey, FRigElementKey, bool, bool)
Description
Switches a multi parent element to a single parent. This sets the new parent's weight to 1.0 and disables weights for all other potential parents.
| Name | SwitchToParent |
| Type | function |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchy.h |
| Include Path | #include "Rigs/RigHierarchy.h" |
UFUNCTION (BlueprintCallable, Category=URigHierarchy)
bool SwitchToParent
(
FRigElementKey InChild,
FRigElementKey InParent,
bool bInitial,
bool bAffectChildren
)
Returns true if changing the weight was successful
Parameters
| Name | Remarks |
|---|---|
| InChild | The key of the multi parented element |
| InParent | The key of the parent to look up the weight for |
| bInitial | If true the initial weights will be used |
| bAffectChildren | If set to false children will not move (maintain global). |
SwitchToParent(FRigBaseElement *, int32, bool, bool)
Description
Switches a multi parent element to a single parent. This sets the new parent's weight to 1.0 and disables weights for all other potential parents.
| Name | SwitchToParent |
| 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 |
bool SwitchToParent
(
FRigBaseElement * InChild,
int32 InParentIndex,
bool bInitial,
bool bAffectChildren
)
Returns true if changing the weight was successful
Parameters
| Name | Remarks |
|---|---|
| InChild | The multi parented element |
| InParentIndex | The index of the parent inside of the multi parent element |
| bInitial | If true the initial weights will be used |
| bAffectChildren | If set to false children will not move (maintain global). |
SwitchToParent(FRigElementKey, FRigElementKey, bool, bool, const IRigDependenciesProvider &, FString *)
| Name | SwitchToParent |
| 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 |
bool SwitchToParent
(
FRigElementKey InChild,
FRigElementKey InParent,
bool bInitial,
bool bAffectChildren,
const IRigDependenciesProvider & InDependencyProvider,
FString * OutFailureReason
)
SwitchToParent(FRigBaseElement , FRigBaseElement , bool, bool, const IRigDependenciesProvider &, FString *)
Description
Switches a multi parent element to a single parent. This sets the new parent's weight to 1.0 and disables weights for all other potential parents.
| Name | SwitchToParent |
| 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 |
bool SwitchToParent
(
FRigBaseElement * InChild,
FRigBaseElement * InParent,
bool bInitial,
bool bAffectChildren,
const IRigDependenciesProvider & InDependencyProvider,
FString * OutFailureReason
)
Returns true if changing the weight was successful
Parameters
| Name | Remarks |
|---|---|
| InChild | The multi parented element |
| InParent | The parent to look up the weight for |
| bInitial | If true the initial weights will be used |
| bAffectChildren | If set to false children will not move (maintain global). |
| InDependencyProvider | An additional object providing dependencies to respect |
| OutFailureReason | An optional pointer to retrieve the reason for failure |