1. Epic GamesDeveloper
  3. FControlRigEditMode

FControlRigEditMode

API > API/Plugins > API/Plugins/ControlRigEditor > API/Plugins/ControlRigEditor/EditMode

Inheritance Hierarchy

References

   
Module ControlRigEditor
Header /Engine/Plugins/Animation/ControlRig/Source/ControlRigEditor/Public/EditMode/ControlRigEditMode.h
Include #include "EditMode/ControlRigEditMode.h"

Syntax

class FControlRigEditMode : public IPersonaEditMode

Variables

  Type Name Description
Protected variable bool bIsTracking True if there's tracking going on right now
Protected variable bool bisTrackingAnimToolDrag Params to handle mouse move for changing anim tools sliders
Protected variable bool bManipulatorMadeChange Whether a manipulator actually made a change when transacting
Protected variable bool bSelecting Guard value for selection
Protected variable bool bSelectionChanged If selection was changed, we set up proxies on next tick
Protected variable bool bSuspendHierarchyNotifs Flag to temporarily disable handling notifs from the hierarchy
Protected variable TSharedPtr< FUICommandList > CommandBindings Command bindings for keyboard shortcuts
Protected variable TObjectPtr< UControlRigDetailPanelControlProxies > ControlProxy  
Protected variable TMap< UControlRig *, TArray< TObjectPtr< AControlRigShapeActor > > > ControlRigShapeActors Shape actors
Protected variable TArray< UControlRig * > ControlRigsToRecreate List of Control Rigs we should recreate
Public variable TSharedPtr< FDetailKeyFrameCacheAndHandler > DetailKeyFrameCache  
Protected variable TMap< UControlRig *, FControlRigInteractionScope * > InteractionScopes The scope for the interaction, one per manipulated Control rig
Protected variable FGuid LastMovieSceneSig  
Protected variable TMap< UControlRig *, FTransform > LastPivotTransforms Previous cached transforms, need this to check on tick if any transform changed, gizmo may have changed
Protected variable FSimpleMulticastDelegate OnAnimSystemInitializedDelegate  
Protected variable FNewMenuCommandsDelegate OnContextMenuCommandsDelegate  
Protected variable FControlRigAddedOrRemoved OnControlRigAddedOrRemovedDelegate  
Protected variable FControlRigSelected OnControlRigSelectedDelegate  
Protected variable FOnGetContextMenu OnGetContextMenuDelegate  
Protected variable FOnGetRigElementTransform OnGetRigElementTransformDelegate  
Protected variable FOnSetRigElementTransform OnSetRigElementTransformDelegate  
Protected variable TMap< UControlRig *, FTransform > PivotTransforms Cached transform of pivot point for selected objects for each Control Rig
Protected variable float PreviousGizmoScale Previous Gizmo(Widget) scale before we enter this mode, used to set it back
Protected variable ERecreateControlRigShape RecreateControlShapesRequired Flag to recreate shapes during tick
Protected variable TOptional< int32 > StartXValue Starting X Value
Protected variable TWeakPtr< ISequencer > WeakSequencer  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function bool

AddControlRigObject ( UControlRig* InControlRig,
TWeakPtr< ISequencer > InSequencer
)

 Add a Control Rig object if it doesn't exist, will return true if it was added, false if it wasn't since it's already there.
Public function Virtual Const bool This is used to differentiate between the control rig editor and any other (asset/level) editors in which this edit mode is used
Protected function Const bool  
Public function Const bool

AreRigElementsSelected ( uint32 InTypes,
UControlRig* InControlRig
)

 Check if any RigElements are selected
Public function Virtual bool

BeginTransform ( const FGizmoState& InState
)

  
Public function Virtual bool

BoxSelect ( FBox& InBox,
bool InSelect
)

  
Protected function Const bool If Anim Slider is open, then can drag
Public function bool

CanRemoveFromPreviewScene ( const USceneComponent* InComponent
)

 Return true if it can be removed from preview scene
Protected function void If Anim Slider is open, got to the next tool
Public function void Clear all selected RigElements
Public function void Clear Selection
Protected function Const bool

ComputePivotFromEditedShape ( UControlRig* InControlRig,
FTransform& OutTransform
)

  
Protected function Const bool

ComputePivotFromElements ( UControlRig* InControlRig,
FTransform& OutTransform
)

  
Protected function Const bool

ComputePivotFromShapeActors ( UControlRig* InControlRig,
const bool bEachLocalSpace,
const bool bIsParentSpace,
FTransform& OutTransform
)

  
Protected function void

DragAnimSliderTool ( double Val
)

 If Anim Slider is open, drag the tool
Public function Virtual void

DrawHUD ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
const FSceneView* View,
FCanvas* Canvas
)

  
Public function Virtual bool

EndTracking ( FEditorViewportClient* InViewportClient,
FViewport* InViewport
)

  
Public function Virtual bool

EndTransform ( const FGizmoState& InState
)

  
Public function void

FrameItems ( const TArray< FRigElementKey >& InItems
)

 Frame a list of provided items
Public function void Frame to current Control Selection
Public function Virtual bool

FrustumSelect ( const FConvexVolume& InFrustum,
FEditorViewportClient* InViewportClient,
bool InSelect
)

  
Public function Const void

GetAllSelectedControls ( TMap< UControlRig*, TArray< FRigElementKey > >& OutSelectedControls
)

 Get all of the selected Controls
Public function Const FUICommandList *  
Public function UControlRigDetailPanelControlProxies *  
Public function TArrayView< TWeakObjectPtr< UControlRig > >  
Public function Const TArrayView< const TWeakObjectPtr< UControlRig > > Get all of the ControlRigs, maybe not valid anymore
Public function TArray< UControlRig * >

GetControlRigsArray ( bool bIsVisible
)

 Get valid Control Rigs possibly just visible
Public function Const TArray< const UControlRig * >

GetControlRigsArray ( bool bIsVisible
)

  
Protected function Const AControlRigShapeActor *

GetControlShapeFromControlName ( UControlRig* InControlRig,
const FName& InControlName
)

 Shape related functions wrt enable/selection
Protected function Const ECoordSystem Get the current coordinate system space
Public function Virtual bool

GetCustomDrawingCoordinateSystem ( FMatrix& OutMatrix,
void* InData
)

  
Public function Virtual bool

GetCustomInputCoordinateSystem ( FMatrix& OutMatrix,
void* InData
)

  
Public function UControlRigDetailPanelControlProxies * Get the detail proxies control rig
Public function Static FControlRigEditMode *

GetEditModeFromWorldContext ( UWorld* InWorldContext
)

 Find the edit mode corresponding to the specified world context
Protected function Const USceneComponent *

GetHostingSceneComponent ( const UControlRig* ControlRig
)

 If the passed in ControlRig is nullptr we use the first Control Rig(this can happen from the BP Editors).
Protected function Const FTransform  
Public function Const int32

GetNumSelectedRigElements ( uint32 InTypes,
UControlRig* InControlRig
)

 Get the number of selected RigElements
Public function Const bool  
Public function Virtual Const bool

GetPivotForOrbit ( FVector& OutPivot
)

  
Protected function Const TArray< FRigElementKey > GetSelectedRigElements, if InControlRig is nullptr get the first one
Public function TWeakPtr< ISequencer > Get Sequencer Driving This
Public function Virtual Const FVector  
Protected function bool

HandleBeginTransform ( const FEditorViewportClient* InViewportClient
)

  
Public function Virtual bool

HandleClick ( FEditorViewportClient* InViewportClient,
HHitProxy* HitProxy,
const FViewportClick& Click
)

  
Protected function bool

HandleEndTransform ( FEditorViewportClient* InViewportClient
)

  
Protected function void Handle selection internally
Public function Virtual bool

InputDelta ( FEditorViewportClient* InViewportClient,
FViewport* InViewport,
FVector& InDrag,
FRotator& InRot,
FVector& InScale
)

  
Public function Virtual bool

InputKey ( FEditorViewportClient* InViewportClient,
FViewport* InViewport,
FKey InKey,
EInputEvent InEvent
)

  
Protected function bool

IntersectSelect ( bool InSelect,
const TFunctionRef< bool(const AControlRigShapeActor*, const FTransform&)>& Intersects
)

 Helper function for box/frustum intersection
Public function void

InvertInputPose ( bool bSelectionOnly
)

 Invert Input Pose
Public function Virtual Const bool  
Protected function Const bool Get if the hosted component is visible.
Protected function Const bool Utility functions for UI/Some other viewport manipulation
Protected function bool

IsDragAnimSliderToolPressed ( FViewport* InViewport
)

 If the Drag Anim Slider Tool is pressed
Public function Virtual Const bool This edit mode is re-used between the level editor and the asset editors (control rig editor etc.).
Protected function Const bool Return true if transform setter/getter delegates are available
Public function Virtual bool

MouseLeave ( FEditorViewportClient* ViewportClient,
FViewport* Viewport
)

  
Public function Virtual bool

MouseMove ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
int32 x,
int32 y
)

  
Public function FSimpleMulticastDelegate &  
Public function FNewMenuCommandsDelegate &  
Public function void

OnControlModified ( UControlRig* Subject,
FRigControlElement* InControlElement,
const FRigControlModifiedContext& Context
)

  
Public function FControlRigAddedOrRemoved & Control Rig Changed Delegate
Public function FControlRigSelected & Control Rig Selected Delegate
Public function FOnGetContextMenu & Context Menu Delegates
Public function FOnGetRigElementTransform & Bone Manipulation Delegates
Public function void

OnHierarchyModified ( ERigHierarchyNotification InNotif,
URigHierarchy* InHierarchy,
const FRigBaseElement* InElement
)

 Callback that gets called when rig element is selected in other view
Public function void  
Protected function void

OnObjectsReplaced ( const TMap< UObject*, UObject* >& OldToNewInstanceMap
)

 Called from the editor when a blueprint object replacement has occurred
Public function void

OnPostConstruction_AnyThread ( UControlRig* InRig,
const FName& InEventName
)

  
Public function void

OnPreConstruction_AnyThread ( UControlRig* InRig,
const FName& InEventName
)

  
Public function FOnSetRigElementTransform &  
Protected function void

OpenContextMenu ( FEditorViewportClient* InViewportClient
)

 Set initial transform handlers
Public function void Opens up the space picker widget
Public function Virtual void  
Public function Virtual bool

ProcessCapturedMouseMoves ( FEditorViewportClient* InViewportClient,
FViewport* InViewport,
const TArrayView< FIntPoint >& CapturedMouseMoves
)

  
Public function void Refresh our internal object list (they may have changed)
Public function void

RemoveControlRig ( UControlRig* InControlRig
)

 Remove control rig
Public function Virtual void

Render ( const FSceneView* View,
FViewport* Viewport,
FPrimitiveDrawInterface* PDI
)

  
Public function void

ReplaceControlRig ( UControlRig* OldControlRig,
UControlRig* NewControlRig
)

 Replace old Control Rig with the New Control Rig, perhaps from a recompile in the level editor
Public function void Requests to recreate the shape actors in the next tick.
Public function void Request a certain transform widget for the next update
Protected function void Reset and stop user the anim slider tool
Public function Virtual void  
Public function void

SetObjects ( UControlRig* InControlRig,
UObject* BindingObject,
TWeakPtr< ISequencer > InSequencer
)

 Set the Control Rig Object to be active in the edit mode.
Protected function void Helper function: set ControlRigs array to the details panel
Public function void Toolbar functions.
Public function void

SetRigElementSelection ( UControlRig* ControlRig,
ERigElementType Type,
const TArray< FName >& InRigElementNames,
bool bSelected
)

 Set multiple RigElement's selection states
Public function void

SetRigElementSelection ( UControlRig* ControlRig,
ERigElementType Type,
const FName& InRigElementName,
bool bSelected
)

 Set a RigElement's selection state
Public function bool

SetSequencer ( TWeakPtr< ISequencer > InSequencer
)

  
Protected function void Set up Details Panel based upon Selected Objects
Public function Virtual Const bool  
Protected function void Start Slider Tool
Public function Virtual bool

StartTracking ( FEditorViewportClient* InViewportClient,
FViewport* InViewport
)

  
Public function void

SuspendHierarchyNotifs ( bool bVal
)

 Suspend Rig Hierarchy Notifies
Public function Virtual void

Tick ( FEditorViewportClient* ViewportClient,
float DeltaTime
)

  
Protected function void Toggles visibility of all control rig shapes in the viewport
Public function void Toggle Shape Transform Edit
Protected function void Toggles visibility of acive control rig shapes in the viewport
Protected function void Updates cached pivot transforms
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Static uint32  
Public function void

ZeroTransforms ( bool bSelectionOnly
)

 Reset Transforms

Overridden from FAnimationEditMode

  Type Name Description
Public function Virtual void FGCObject interface
Public function Virtual void

Enter ()

  
Public function Virtual void

Exit ()

  

Overridden from IAnimationEditContext

  Type Name Description
Public function Virtual Const IPersonaPreviewScene &  
Public function Virtual Const bool

GetCameraTarget ( FSphere& OutTarget
)

 IPersonaEditMode interface
Public function Virtual Const void

GetOnScreenDebugInfo ( TArray< FText >& OutDebugInfo
)

 Function to collect strings from nodes to display in the viewport.

Constants

Name Description
ModeName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page