Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. FRigControlSettings

FRigControlSettings

API > API/Plugins > API/Plugins/ControlRig

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

Syntax

USTRUCT (BlueprintType )  
struct FRigControlSettings

Constructors

Name Remarks Include Path Unreal Specifiers

FRigControlSettings()

   Rigs/RigHierarchyElements.h  

Variables

Public

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

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplyLimits ( FTransform& InOutValue
) const

 Applies the limits expressed by these settings to a transform Rigs/RigHierarchyElements.h  

void ApplyLimits ( FRigControlValue& InOutValue
) const

 Applies the limits expressed by these settings to a value Rigs/RigHierarchyElements.h  

FRigControlValue GetIdentityValue()

   Rigs/RigHierarchyElements.h  
The euler rotation order this control prefers for animation if it is active. Rigs/RigHierarchyElements.h  

bool IsAnimatable()

   Rigs/RigHierarchyElements.h  

bool IsSelectable ( bool bRespectVisibility
) const

   Rigs/RigHierarchyElements.h  

bool IsVisible()

   Rigs/RigHierarchyElements.h  

void Load ( FArchive& Ar
)

   Rigs/RigHierarchyElements.h  

void Save ( FArchive& Ar
)

   Rigs/RigHierarchyElements.h  

void SetAnimationTypeFromDeprecatedData ( bool bAnimatable,
bool bShapeEnabled
)

   Rigs/RigHierarchyElements.h  

void SetRotationOrder ( const TOptional< EEulerRotationOrder >& EulerRotation
)

 Set the rotation order if the rotation is set otherwise use default rotator Rigs/RigHierarchyElements.h  

void SetupLimitArrayForType ( bool bLimitTranslation,
bool bLimitRotation,
bool bLimitScale
)

   Rigs/RigHierarchyElements.h  

bool SetVisible ( bool bVisible,
bool bForce
)

   Rigs/RigHierarchyElements.h  

bool ShouldBeGrouped()

   Rigs/RigHierarchyElements.h  

bool SupportsShape()

   Rigs/RigHierarchyElements.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const FRigControlSettings& InOther
) const

   Rigs/RigHierarchyElements.h  

bool operator== ( const FRigControlSettings& InOther
) const

   Rigs/RigHierarchyElements.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bAnimatable_DEPRECATED bool Deprecated properties. Rigs/RigHierarchyElements.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Use animation_type instead.")
bShapeEnabled_DEPRECATED bool   Rigs/RigHierarchyElements.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Use animation_type or shape_visible instead.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page