Navigation
API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/URigHierarchy
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigControlValue GetControlValue
(
FRigElementKey InKey, |
Returns a control's current value given its key | Rigs/RigHierarchy.h |
|
T GetControlValue
(
FRigElementKey InKey, |
Returns a control's current value given its key | Rigs/RigHierarchy.h | |
FRigControlValue GetControlValue
(
int32 InElementIndex, |
Returns a control's current value given its index | Rigs/RigHierarchy.h | |
T GetControlValue
(
int32 InElementIndex, |
Returns a control's current value given its index | Rigs/RigHierarchy.h | |
T GetControlValue
(
FRigControlElement* InControlElement, |
Rigs/RigHierarchy.h | ||
FVector2D GetControlValue
(
FRigControlElement* InControlElement, |
Rigs/RigHierarchy.h | ||
FRigControlValue GetControlValue
(
FRigControlElement* InControlElement, |
Returns a control's current value | Rigs/RigHierarchy.h |
GetControlValue(FRigElementKey, ERigControlValueType)
Description
Returns a control's current value given its key
| Name | GetControlValue |
| Type | function |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchy.h |
| Include Path | #include "Rigs/RigHierarchy.h" |
UFUNCTION (BlueprintCallable, Category=URigHierarchy)
FRigControlValue GetControlValue
(
FRigElementKey InKey,
ERigControlValueType InValueType
) const
Returns the current value of the control
Parameters
| Name | Remarks |
|---|---|
| InKey | The key of the element to retrieve the current value for |
| InValueType | The type of value to return |
GetControlValue(FRigElementKey, ERigControlValueType)
Description
Returns a control's current value given its key
| Name | GetControlValue |
| Type | function |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchy.h |
| Include Path | #include "Rigs/RigHierarchy.h" |
template<typename T>
T GetControlValue
(
FRigElementKey InKey,
ERigControlValueType InValueType
) const
Returns the current value of the control
Parameters
| Name | Remarks |
|---|---|
| InKey | The key of the element to retrieve the current value for |
| InValueType | The type of value to return |
GetControlValue(int32, ERigControlValueType)
Description
Returns a control's current value given its index
| Name | GetControlValue |
| Type | function |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchy.h |
| Include Path | #include "Rigs/RigHierarchy.h" |
FRigControlValue GetControlValue
(
int32 InElementIndex,
ERigControlValueType InValueType
) const
Returns the current value of the control
Parameters
| Name | Remarks |
|---|---|
| InElementIndex | The index of the element to retrieve the current value for |
| InValueType | The type of value to return |
GetControlValue(int32, ERigControlValueType)
Description
Returns a control's current value given its index
| Name | GetControlValue |
| Type | function |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchy.h |
| Include Path | #include "Rigs/RigHierarchy.h" |
template<typename T>
T GetControlValue
(
int32 InElementIndex,
ERigControlValueType InValueType
) const
Returns the current value of the control
Parameters
| Name | Remarks |
|---|---|
| InElementIndex | The index of the element to retrieve the current value for |
| InValueType | The type of value to return |
GetControlValue(FRigControlElement *, ERigControlValueType)
| Name | GetControlValue |
| Type | function |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchy.h |
| Include Path | #include "Rigs/RigHierarchy.h" |
template<typename T>
T GetControlValue
(
FRigControlElement * InControlElement,
ERigControlValueType InValueType
) const
GetControlValue(FRigControlElement *, ERigControlValueType)
| Name | GetControlValue |
| Type | function |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchy.h |
| Include Path | #include "Rigs/RigHierarchy.h" |
template<>
FVector2D GetControlValue
(
FRigControlElement * InControlElement,
ERigControlValueType InValueType
) const
GetControlValue(FRigControlElement *, ERigControlValueType, bool)
Description
Returns a control's current value
| Name | GetControlValue |
| 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 |
FRigControlValue GetControlValue
(
FRigControlElement * InControlElement,
ERigControlValueType InValueType,
bool bUsePreferredAngles
) const
Returns the current value of the control
Parameters
| Name | Remarks |
|---|---|
| InControlElement | The element to retrieve the current value for |
| InValueType | The type of value to return |
| bUsePreferredAngles | When true will use euler preferred angles to compute the value |