UControlRigEditorSettings | Unreal Engine 5.8 Documentation

API > API/Plugins > API/Plugins/ControlRig

Customize Control Rig Editor.


Name	UControlRigEditorSettings
Type	class
Header File	/Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Settings/ControlRigSettings.h
Include Path	#include "Settings/ControlRigSettings.h"

Syntax

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

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UDeveloperSettings → URigVMEditorSettings → UControlRigEditorSettings

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UControlRigEditorSettings ( const FObjectInitializer& ObjectInitializer )		Settings/ControlRigSettings.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
AxisScale	float	The scale for axes to draw on the selection	Settings/ControlRigSettings.h	Config EditAnywhere Category="Animation Settings"
BackwardsAndForwardsBorderColor	FLinearColor	The border color of the viewport when entering "Backwards And Forwards" mode	Settings/ControlRigSettings.h	EditAnywhere Config Category=Viewport
BackwardsSolveBorderColor	FLinearColor	The border color of the viewport when entering "Backwards Solve" mode	Settings/ControlRigSettings.h	EditAnywhere Config Category=Viewport
bArrangeByModules	bool	If turned on the controls in the Anim Outliner will be arranged by modules in Modular Rigs.	Settings/ControlRigSettings.h	EditAnywhere Config Category=Outliner
bCompileResetsEventQueue	bool	When true the Event Queue is reset to Forward Solve after compiling	Settings/ControlRigSettings.h	Config
bDisplayAxesOnSelection	bool	Should we show axes for the selected elements	Settings/ControlRigSettings.h	Config EditAnywhere Category="Animation Settings"
bDisplayNulls	bool	Whether to show all nulls in the hierarchy	Settings/ControlRigSettings.h	Config EditAnywhere Category="Animation Settings"
bDisplaySockets	bool	Should we show sockets in the viewport	Settings/ControlRigSettings.h	Config EditAnywhere Category="Animation Settings"
bEnableFlashlightInDependencyViewer	bool	Whether or not to use a flash light effect around the mouse pointer in the dependency viewer to brighten up faded out nodes	Settings/ControlRigSettings.h	EditAnywhere Config Category=NodeGraph
bEnableUndoForPoseInteraction	bool	When this is checked any hierarchy interaction within the Control Rig Editor will be stored on the undo stack	Settings/ControlRigSettings.h	EditAnywhere Config Category=Interaction
bFlattenModules	bool	If turned on the modules in the Anim Outliner will be arranged in a flat list.	Settings/ControlRigSettings.h	EditAnywhere Config Category=Outliner
bFocusOnSelection	bool	If turned on the Anim Outliner will focus on the selection.	Settings/ControlRigSettings.h	EditAnywhere Config Category=Outliner
bHideControlShapes	bool	When true, controls are hidden in editor	Settings/ControlRigSettings.h	Config EditAnywhere Category="Animation Settings" Meta=(EditCondition="!bHideControlShapes")
bLeftMouseDragDoesMarquee	bool	If turned on we'll offer box / marquee selection in the control rig editor viewport.	Settings/ControlRigSettings.h	EditAnywhere Config Category=Hierarchy
bResetControlsOnCompile	bool	When this is checked all controls will return to their initial value as the user hits the Compile button.	Settings/ControlRigSettings.h	EditAnywhere Config Category=Interaction
bResetControlsOnPinValueInteraction	bool	When this is checked all controls will return to their initial value as the user interacts with a pin value	Settings/ControlRigSettings.h	EditAnywhere Config Category=Interaction
bResetControlTransformsOnCompile	bool	When checked controls will be reset during a manual compilation (when pressing the Compile button)	Settings/ControlRigSettings.h	EditAnywhere Config Category=Compilation
bResetPoseWhenTogglingEventQueue	bool	When this is checked all elements will be reset to their initial value if the user changes the event queue (for example between forward / backward solve)	Settings/ControlRigSettings.h	EditAnywhere Config Category=Interaction
bSchematicViewportShowEmptySocketsOnly	bool	When set to true, only shows empty sockets in the schematic viewport	Settings/ControlRigSettings.h	EditAnywhere Config Category=Viewport
bShowControlsAsOverlay	bool	Determines if controls should be rendered on top of other controls	Settings/ControlRigSettings.h	Config EditAnywhere Category="Animation Settings" Meta=(EditCondition="!bHideControlShapes")
bShowSchematicViewInModularRig	bool	Show or hide the schematic view icons in the modular rig viewport	Settings/ControlRigSettings.h	EditAnywhere Config Category=Viewport
bShowStackedHierarchy	bool	Option to toggle displaying the stacked hierarchy items.	Settings/ControlRigSettings.h	EditAnywhere Config Category=Hierarchy
ConstructionEventBorderColor	FLinearColor	The border color of the viewport when entering "Construction Event" mode	Settings/ControlRigSettings.h	EditAnywhere Config Category=Viewport
ElementNameDisplayMode	EElementNameDisplayMode	Defines how the element names will be displayed in treeviews, anim outliner etc	Settings/ControlRigSettings.h	EditAnywhere Config Category=Outliner
MaxStackSize	int32	The maximum number of stacked items in the view Note that changing this option potentially requires to re-open the editors in question.	Settings/ControlRigSettings.h	EditAnywhere Config Category=Hierarchy Meta=(EditCondition="bShowStackedHierarchy")
MirrorSettings	FRigVMMirrorSettings	The mirror settings to use when mirroring rig elements	Settings/ControlRigSettings.h	Config
ModularRigHierarchyHiddenColums	TArray< FName >	Hidden columns in the modular rig hierarchy tree view	Settings/ControlRigSettings.h	Config
OutlinerMultiRigDisplayMode	EMultiRigTreeDisplayMode	Outliner reflection mode for multi rigs	Settings/ControlRigSettings.h	EditAnywhere Config Category=Outliner
RigUnitPinExpansion	TMap< FString, FControlRigSettingsPerPinBool >	A map which remembers the expansion setting for each rig unit pin.	Settings/ControlRigSettings.h	EditAnywhere Config Category=NodeGraph

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
ModularRigHierarchyConnectorVisibilityFlags	uint8	Visibility flags for different types of connectors in the rig hierarchy.	Settings/ControlRigSettings.h	Config

Functions

Public

Name	Remarks	Include Path
EModularRigHierarchyEditorConnectorVisibilityFlags GetModularRigHierarchyConnectorVisibilityFlags()	Gets the modular rig hierarchy connector visibility flags	Settings/ControlRigSettings.h
bool HasAnyModularRigHierarchyConnectorVisibilityFlags ( const EModularRigHierarchyEditorConnectorVisibilityFlags Flags ) const	Returns true if these settings have any modular rig hierarchy connector visibility flags	Settings/ControlRigSettings.h
void SetModularRigHierarchyConnectorVisibilityFlags ( const EModularRigHierarchyEditorConnectorVisibilityFlags Flags )	Sets the modular rig hierarchy connector visibility flags	Settings/ControlRigSettings.h

Public Virtual

Overridden from UDeveloperSettings

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent )		Settings/ControlRigSettings.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static UControlRigEditorSettings * Get()		Settings/ControlRigSettings.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Public

Protected

Functions

Public

Public Virtual

Overridden from UDeveloperSettings

Static