1. Epic GamesDeveloper
  3. FRigControl

FRigControl

API > API/Plugins > API/Plugins/ControlRig

   
Name FRigControl
Type struct
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigControlHierarchy.h
Include Path #include "Rigs/RigControlHierarchy.h"

Syntax

USTRUCT ()  
struct FRigControl : public FRigElement

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FRigControl()

   Rigs/RigControlHierarchy.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FRigControl()

   Rigs/RigControlHierarchy.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAnimatable bool If the control is animatable in sequencer Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Control
bDrawLimits bool True if the limits should be drawn in debug. Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Limits
  • Meta=(EditCondition="bLimitTranslation || bLimitRotation || bLimitScale")
bGizmoEnabled bool Set to true if the gizmo is enabled in 3d Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Gizmo
bGizmoVisible bool Set to true if the gizmo is currently visible in 3d Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Gizmo
  • Meta=(EditCondition="bGizmoEnabled")
bIsCurve bool If Created from a Curve Container Rigs/RigControlHierarchy.h
  • Transient
bIsTransientControl bool If the control is transient and only visible in the control rig editor Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Control
bLimitRotation bool True if the control has to obey rotation limits. Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Limits
bLimitScale bool True if the control has to obey scale limits. Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Limits
bLimitTranslation bool True if the control has to obey translation limits. Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Limits
ControlEnum TObjectPtr< UEnum > If the control is transient and only visible in the control rig editor Rigs/RigControlHierarchy.h
  • BlueprintReadOnly
  • EditAnywhere
  • Category=Control
ControlType ERigControlType   Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Control
Dependents TArray< int32 > Dependent list - direct dependent for child or anything that needs to update due to this Rigs/RigControlHierarchy.h
  • Transient
DisplayName FName   Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Control
GizmoColor FLinearColor   Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Gizmo
  • Meta=(EditCondition="bGizmoEnabled")
GizmoName FName This is optional UI setting - this doesn't mean this is always used, but it is optional for manipulation layer to use this Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Gizmo
  • Meta=(EditCondition="bGizmoEnabled")
GizmoTransform FTransform   Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Gizmo
  • Meta=(EditCondition="bGizmoEnabled")
InitialValue FRigControlValue The value that a control is reset to during begin play or when the control rig is instantiated. Rigs/RigControlHierarchy.h
  • BlueprintReadOnly
  • VisibleAnywhere
  • Category=Control
MaximumValue FRigControlValue The maximum limit of the control's value Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Limits
  • Meta=(EditCondition="bLimitTranslation || bLimitRotation || bLimitScale")
MinimumValue FRigControlValue The minimum limit of the control's value Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Limits
  • Meta=(EditCondition="bLimitTranslation || bLimitRotation || bLimitScale")
OffsetTransform FTransform Used to offset a control in global space. Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Control
  • Meta=(DisplayAfter="ControlType")
ParentIndex int32   Rigs/RigControlHierarchy.h
  • BlueprintReadOnly
  • Transient
  • Category=Control
ParentName FName   Rigs/RigControlHierarchy.h
  • BlueprintReadOnly
  • VisibleAnywhere
  • Category=Control
PrimaryAxis ERigControlAxis The primary axis to use for float controls Rigs/RigControlHierarchy.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=Control
SpaceIndex int32   Rigs/RigControlHierarchy.h
  • BlueprintReadOnly
  • Transient
  • Category=Control
SpaceName FName   Rigs/RigControlHierarchy.h
  • BlueprintReadOnly
  • VisibleAnywhere
  • Category=Control
Value FRigControlValue The current value of the control. Rigs/RigControlHierarchy.h
  • BlueprintReadOnly
  • Transient
  • VisibleAnywhere
  • Category=Control

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplyLimits ( FRigControlValue& InOutValue
) const

   Rigs/RigControlHierarchy.h  

const FName & GetDisplayName()

   Rigs/RigControlHierarchy.h  

virtual FRigElementKey GetParentElementKey()

   Rigs/RigControlHierarchy.h  

virtual FRigElementKey GetSpaceElementKey()

   Rigs/RigControlHierarchy.h  

FTransform GetTransformFromValue ( ERigControlValueType InValueType
) const

   Rigs/RigControlHierarchy.h  

const FRigControlValue & GetValue ( ERigControlValueType InValueType
) const

   Rigs/RigControlHierarchy.h  
  Rigs/RigControlHierarchy.h  

void SetValueFromTransform ( const FTransform& InTransform,
ERigControlValueType InValueType
)

   Rigs/RigControlHierarchy.h  

Overridden from FRigElement

Name Remarks Include Path Unreal Specifiers

virtual ERigElementType GetElementType()

   Rigs/RigControlHierarchy.h  

Static

Name Remarks Include Path Unreal Specifiers

static FProperty * FindPropertyForValueType ( ERigControlValueType InValueType
)

   Rigs/RigControlHierarchy.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page