Navigation
API > API/Plugins > API/Plugins/ControlRig
GetControlVector is used to retrieve a single Vector from a hierarchy, can be used for Controls of type "Position" or "Scale".
| Name | FRigUnit_GetControlVector |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Hierarchy/RigUnit_GetControlTransform.h |
| Include Path | #include "Units/Hierarchy/RigUnit_GetControlTransform.h" |
Syntax
USTRUCT (
Meta=(DisplayName="Get Control Vector", Category="Controls", DocumentationPolicy="Strict", Keywords="GetControlVector, GetControlPosition, GetControlScale", TemplateName="GetControlValue", NodeColor="0.462745, 1,0, 0.329412", Varying))
struct FRigUnit_GetControlVector : public FRigUnit
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnit_GetControlVector
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_GetControlVector() |
Units/Hierarchy/RigUnit_GetControlTransform.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CachedControlIndex | FCachedRigElement | Used to cache the internally used bone index. | Units/Hierarchy/RigUnit_GetControlTransform.h | |
| Control | FName | The name of the Control to retrieve the Vector for. | Units/Hierarchy/RigUnit_GetControlTransform.h |
|
| Maximum | FVector | The maximum value of the control. | Units/Hierarchy/RigUnit_GetControlTransform.h |
|
| Minimum | FVector | The minimum value of the control. | Units/Hierarchy/RigUnit_GetControlTransform.h |
|
| Space | ERigVMTransformSpace | Defines if the Control's Vector should be retrieved in local or global space. | Units/Hierarchy/RigUnit_GetControlTransform.h |
|
| Vector | FVector | The current value of the control. | Units/Hierarchy/RigUnit_GetControlTransform.h |
|
Functions
Public
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Units/Hierarchy/RigUnit_GetControlTransform.h |