UControlRigEditorSettings

Customize Control Rig Editor.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

ControlRig

Header

/Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Settings/ControlRigSettings.h

Include

#include "Settings/ControlRigSettings.h"

Syntax

UCLASS(Config=EditorPerProjectUserSettings, Meta=(DisplayName="Control Rig Editor"))
class UControlRigEditorSettings : public UDeveloperSettings

Remarks

Customize Control Rig Editor.

Variables

Name Description

Public variable UProperty Category, EditAnywhere Config

FLinearColor

 

BackwardsAndForwardsBorderColor

The border color of the viewport when entering "Backwards And Forwards" mode

Public variable UProperty Category, EditAnywhere Config

FLinearColor

 

BackwardsSolveBorderColor

The border color of the viewport when entering "Backwards Solve" mode

Public variable UProperty Category, EditAnywhere Config

bool

 

bAutoLinkMutableNodes

When this is checked mutable nodes (nodes with an execute pin) will be hooked up automatically.

Public variable UProperty Category, EditAnywhere Config

bool

 

bEnableUndoForPoseInteraction

When this is checked any hierarchy interaction within the Control Rig Editor will be stored on the undo stack

Public variable UProperty Category, EditAnywhere Config

bool

 

bResetControlsOnCompile

When this is checked all controls will return to their initial value as the user hits the Compile button.

Public variable UProperty Category, EditAnywhere Config

bool

 

bResetControlsOnPinValueInteraction

When this is checked all controls will return to their initial value as the user interacts with a pin value

Public variable UProperty Category, EditAnywhere Config

bool

 

bResetControlTransformsOnCompile

When checked controls will be reset during a manual compilation (when pressing the Compile button)

Public variable UProperty Category, EditAnywhere Config

FLinearColor

 

DynamicHierarchyBorderColor

The border color of the hierarchy tree in dynamic hierarchy mode

Public variable UProperty Category, EditAnywhere, Meta Config

FString

 

NodeSnippet_0

The default node snippet to create when pressing 0 + Left Mouse Button

Public variable UProperty Category, EditAnywhere, Meta Config

FString

 

NodeSnippet_1

The default node snippet to create when pressing 1 + Left Mouse Button

Public variable UProperty Category, EditAnywhere, Meta Config

FString

 

NodeSnippet_2

The default node snippet to create when pressing 2 + Left Mouse Button

Public variable UProperty Category, EditAnywhere, Meta Config

FString

 

NodeSnippet_3

The default node snippet to create when pressing 3 + Left Mouse Button

Public variable UProperty Category, EditAnywhere, Meta Config

FString

 

NodeSnippet_4

The default node snippet to create when pressing 4 + Left Mouse Button

Public variable UProperty Category, EditAnywhere, Meta Config

FString

 

NodeSnippet_5

The default node snippet to create when pressing 5 + Left Mouse Button

Public variable UProperty Category, EditAnywhere, Meta Config

FString

 

NodeSnippet_6

The default node snippet to create when pressing 6 + Left Mouse Button

Public variable UProperty Category, EditAnywhere, Meta Config

FString

 

NodeSnippet_7

The default node snippet to create when pressing 7 + Left Mouse Button

Public variable UProperty Category, EditAnywhere, Meta Config

FString

 

NodeSnippet_8

The default node snippet to create when pressing 8 + Left Mouse Button

Public variable UProperty Category, EditAnywhere, Meta Config

FString

 

NodeSnippet_9

The default node snippet to create when pressing 9 + Left Mouse Button

Public variable UProperty Category, EditAnywhere Config

TMap< FString, ...

 

RigUnitPinExpansion

A map which remembers the expansion setting for each rig unit pin.

Public variable UProperty Category, EditAnywhere Config

FLinearColor

 

SetupEventBorderColor

The border color of the viewport when entering "Setup Event" mode

Constructors

Name Description

Public function

UControlRigEditorSettings

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

UControlRigE...

 

Get()

Overridden from UDeveloperSettings

Name Description

Public function Virtual Const

FName

 

GetCategoryName()

Gets the category for the settings, some high level grouping like, Editor, Engine, Game...etc.