1. Epic GamesDeveloper
  3. UControlRigEditorSettings

UControlRigEditorSettings

Customize Control Rig Editor.

API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Settings

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 URigVMEditorSettings

Remarks

Customize Control Rig Editor.

Variables

  Type 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 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 bLeftMouseDragDoesMarquee If turned on we'll offer box / marquee selection in the control rig editor viewport.
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 bool bResetPoseWhenTogglingEventQueue 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)
Public variable UProperty Category, EditAnywhere Config bool bShowStackedHierarchy Option to toggle displaying the stacked hierarchy items.
Public variable UProperty Category, EditAnywhere Config FLinearColor ConstructionEventBorderColor The border color of the viewport when entering "Construction Event" mode
Public variable UProperty Category, EditAnywhere, Meta Config int32 MaxStackSize The maximum number of stacked items in the view Note that changing this option potentially requires to re-open the editors in question.
Public variable UProperty Category, EditAnywhere Config TMap< FString, FControlRigSettingsPerPinBool > RigUnitPinExpansion A map which remembers the expansion setting for each rig unit pin.

Constructors

  Type Name Description
Public function  

UControlRigEditorSettings ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static UControlRigEditorSettings *

Get ()

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page