1. Epic GamesDeveloper
  3. FRigControlSettings

FRigControlSettings

API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Rigs

References

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

Syntax

USTRUCT&40;BlueprintType&41;  
struct FRigControlSettings

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite ERigControlAnimationType AnimationType  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bDrawLimits True if the limits should be drawn in debug.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bGroupWithParentControl If set to true the animation channel will be grouped with the parent control in sequencer
Public variable UProperty Transient bool bIsCurve If Created from a Curve Container
Public variable UProperty Category BlueprintReadWrite bool bIsTransientControl If the control is transient and only visible in the control rig editor
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bRestrictSpaceSwitching Allow to space switch only to the available spaces
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bShapeVisible Set to true if the shape is currently visible in 3d
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bUsePreferredRotationOrder Whether to use a specfied rotation order or just use the default FRotator order and conversion functions
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UEnum > ControlEnum If the control is 4transient and only visible in the control rig editor
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite ERigControlType ControlType  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly FRigControlElementCustomization Customization The User interface customization used for a control This will be used as the default content for the space picker and other widgets
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FName DisplayName  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TArray< FRigElementKey > DrivenControls The list of driven controls for this proxy control.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TArray< ERigControlTransformChannel > FilteredChannels Filtered Visible Transform channels. If this is empty everything is visible
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< FRigControlLimitEnabled > LimitEnabled True if the control has limits.
Public variable UProperty Category BlueprintReadWrite FRigControlValue MaximumValue The maximum limit of the control's value
Public variable UProperty Category BlueprintReadWrite FRigControlValue MinimumValue The minimum limit of the control's value
Public variable UProperty Category, EditAnywhere BlueprintReadOnly EEulerRotationOrder PreferredRotationOrder The euler rotation order this control prefers for animation, if we aren't using default UE rotator
Public variable TArray< FRigElementKey > PreviouslyDrivenControls The list of previously driven controls - prior to a procedural change
Public variable UProperty Category, EditAnywhere BlueprintReadWrite ERigControlAxis PrimaryAxis The primary axis to use for float controls
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FLinearColor ShapeColor  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FName ShapeName 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 BlueprintReadWrite ERigControlVisibility ShapeVisibility Defines how the shape visibility should be changed

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const void

ApplyLimits ( FTransform& InOutValue
)

 Applies the limits expressed by these settings to a transform
Public function Const void

ApplyLimits ( FRigControlValue& InOutValue
)

 Applies the limits expressed by these settings to a value
Public function Const FRigControlValue  
Public function Const TOptional< EEulerRotationOrder > The euler rotation order this control prefers for animation if it is active.
Public function Const bool  
Public function Const bool

IsSelectable ( bool bRespectVisibility
)

  
Public function Const bool  
Public function void

Load ( FArchive& Ar
)

  
Public function void

Save ( FArchive& Ar
)

  
Public function void

SetAnimationTypeFromDeprecatedData ( bool bAnimatable,
bool bShapeEnabled
)

  
Public function void

SetRotationOrder ( const TOptional< EEulerRotationOrder >& EulerRotation
)

 Set the rotation order if the rotation is set otherwise use default rotator
Public function void

SetupLimitArrayForType ( bool bLimitTranslation,
bool bLimitRotation,
bool bLimitScale
)

  
Public function bool

SetVisible ( bool bVisible,
bool bForce
)

  
Public function Const bool  
Public function Const bool  

Operators

  Type Name Description
Public function Const bool

operator!= ( const FRigControlSettings& InOther
)

  
Public function Const bool

operator== ( const FRigControlSettings& InOther
)

  

Deprecated Variables

  Type Name Description
Public variable UProperty Meta bool bAnimatable_DEPRECATED Deprecated properties.
Public variable UProperty Meta bool bShapeEnabled_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page