1. Epic GamesDeveloper
  3. FRigControl

FRigControl

Unreal Engine C++ API Reference > Plugins > ControlRig > Rigs

Inheritance Hierarchy

References

   
Module ControlRig
Header /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigControlHierarchy.h
Include #include "Rigs/RigControlHierarchy.h"

Syntax

USTRUCT&40;&41;  
struct FRigControl : public FRigElement

Variables

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

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const void

ApplyLimits ( FRigControlValue& InOutValue
)

  
Public function Static FProperty *  
Public function Const const FName &  
Public function Virtual Const FRigElementKey  
Public function Virtual Const FRigElementKey  
Public function Const FTransform  
Public function Const const FRigControlValue &

GetValue ( ERigControlValueType InValueType
)

  
Public function FRigControlValue &

GetValue ( ERigControlValueType InValueType
)

  
Public function void

SetValueFromTransform ( const FTransform& InTransform,
ERigControlValueType InValueType
)

  

Overridden from FRigElement

  Type Name Description
Public function Virtual Const ERigElementType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page