Navigation
API > API/Plugins > API/Plugins/ControlRigEditor
| Name | FControlRigEditMode |
| Type | class |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRigEditor/Public/EditMode/ControlRigEditMode.h |
| Include Path | #include "EditMode/ControlRigEditMode.h" |
Syntax
class FControlRigEditMode : public IPersonaEditMode
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FControlRigEditMode() |
EditMode/ControlRigEditMode.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FControlRigEditMode() |
EditMode/ControlRigEditMode.h |
Classes
| Name | Remarks |
|---|---|
| FPendingControlRigEvaluator | |
| FTurnOffPosePoseUpdate |
Structs
| Name | Remarks |
|---|---|
| FMarqueeDragTool |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| bDoPostPoseUpdate | bool | To disable post pose update, needed for offfline evlauations | EditMode/ControlRigEditMode.h |
| ModeName | const FLazyName | EditMode/ControlRigEditMode.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DetailKeyFrameCache | TSharedPtr< FDetailKeyFrameCacheAndHandler > | EditMode/ControlRigEditMode.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsChangingControlShapeTransform | bool | Enable editing of control's shape transform instead of control's transform | EditMode/ControlRigEditMode.h | |
| bIsChangingCoordSystem | bool | EditMode/ControlRigEditMode.h | ||
| bIsConstructionEventRunning | bool | EditMode/ControlRigEditMode.h | ||
| bOtherSelectedObjects | bool | Whether there are other objects selected in the world that are not shape actors or components bound to the rigs | EditMode/ControlRigEditMode.h | |
| bPivotsNeedUpdate | bool | EditMode/ControlRigEditMode.h | ||
| bSequencerPlaying | bool | EditMode/ControlRigEditMode.h | ||
| bShowControlsAsOverlay | bool | EditMode/ControlRigEditMode.h | ||
| bUpdateNonInteractingRigs | bool | EditMode/ControlRigEditMode.h | ||
| ConstraintsCache | UE::TransformConstraintUtil::FConstraintsInteractionCache | EditMode/ControlRigEditMode.h | ||
| CoordSystemPerWidgetMode | TArray< ECoordSystem > | EditMode/ControlRigEditMode.h | ||
| CurrentViewportClient | FEditorViewportClient * | EditMode/ControlRigEditMode.h | ||
| DeferredItemsToFrame | TArray< FRigElementKey > | EditMode/ControlRigEditMode.h | ||
| DelegateHelpers | TMap< UControlRig *, TStrongObjectPtr< UControlRigEditModeDelegateHelper > > | EditMode/ControlRigEditMode.h | ||
| DragToolHandler | FMarqueeDragTool | EditMode/ControlRigEditMode.h | ||
| InteractionType | uint8 | EditMode/ControlRigEditMode.h | ||
| Keyframer | UE::AnimationEditMode::FControlRigKeyframer | Used to store and apply keyframes (if deferred) | EditMode/ControlRigEditMode.h | |
| LastHierarchyHash | TArray< uint32 > | EditMode/ControlRigEditMode.h | ||
| LastShapeLibraryHash | TArray< uint32 > | EditMode/ControlRigEditMode.h | ||
| NonInteractingRigs | TArray< TWeakObjectPtr< UControlRig > > | EditMode/ControlRigEditMode.h | ||
| OnWorldCleanupHandle | FDelegateHandle | World clean up handlers | EditMode/ControlRigEditMode.h | |
| PendingFocus | FPendingWidgetFocus | Pending focus handler | EditMode/ControlRigEditMode.h | |
| PendingFocusHandle | FDelegateHandle | EditMode/ControlRigEditMode.h | ||
| RequestedWidgetModes | TArray< UE::Widget::EWidgetMode > | EditMode/ControlRigEditMode.h | ||
| RigEvaluationBracket | uint32 | EditMode/ControlRigEditMode.h | ||
| RigsToEvaluateDuringThisTick | TArray< UControlRig * > | A list of rigs we need to run during this tick | EditMode/ControlRigEditMode.h | |
| SelectedObjects | TSet< TWeakObjectPtr< UObject > > | EditMode/ControlRigEditMode.h | ||
| StoredPose | TObjectPtr< UControlRigPoseAsset > | Pose used by the hotkeys | EditMode/ControlRigEditMode.h | |
| WeakGizmoContext | TWeakObjectPtr< UEditorTransformGizmoContextObject > | EditMode/ControlRigEditMode.h | ||
| WeakSettings | TWeakObjectPtr< UControlRigEditModeSettings > | EditMode/ControlRigEditMode.h | ||
| WorldPtr | UWorld * | EditMode/ControlRigEditMode.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddControlRigObject
(
UControlRig* InControlRig, |
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. | EditMode/ControlRigEditMode.h | |
void AddMirroredControlsToSelection() |
Select Mirrored Controls on Current Selection, keeping current selection | EditMode/ControlRigEditMode.h | |
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
FGCObject interface | EditMode/ControlRigEditMode.h | |
virtual bool AreEditingControlRigDirectly() |
This is used to differentiate between the control rig editor and any other (asset/level) editors in which this edit mode is used | EditMode/ControlRigEditMode.h | |
bool AreRigElementsSelected
(
uint32 InTypes, |
Check if any RigElements are selected | EditMode/ControlRigEditMode.h | |
virtual bool BeginTransform
(
const FGizmoState& InState |
EditMode/ControlRigEditMode.h | ||
virtual bool BoxSelect
(
FBox& InBox, |
EditMode/ControlRigEditMode.h | ||
bool CanRemoveFromPreviewScene
(
const USceneComponent* InComponent |
Return true if it can be removed from preview scene | EditMode/ControlRigEditMode.h | |
void ClearOutHidden
(
UControlRig* InControlRig |
EditMode/ControlRigEditMode.h | ||
void ClearRigElementSelection
(
uint32 InTypes |
Clear all selected RigElements | EditMode/ControlRigEditMode.h | |
void ClearSelection() |
Clear Selection | EditMode/ControlRigEditMode.h | |
virtual void DrawHUD
(
FEditorViewportClient* ViewportClient, |
EditMode/ControlRigEditMode.h | ||
virtual bool EndTracking
(
FEditorViewportClient* InViewportClient, |
EditMode/ControlRigEditMode.h | ||
virtual bool EndTransform
(
const FGizmoState& InState |
EditMode/ControlRigEditMode.h | ||
virtual void Enter() |
EditMode/ControlRigEditMode.h | ||
virtual void Exit() |
EditMode/ControlRigEditMode.h | ||
void FrameItems
(
const TArray< FRigElementKey >& InItems |
Frame a list of provided items | EditMode/ControlRigEditMode.h | |
void FrameSelection() |
Frame to current Control Selection | EditMode/ControlRigEditMode.h | |
virtual bool FrustumSelect
(
const FConvexVolume& InFrustum, |
EditMode/ControlRigEditMode.h | ||
| Get all of the selected Controls | EditMode/ControlRigEditMode.h | ||
UAnimDetailsProxyManager * GetAnimDetailsProxyManager() |
Get the detail proxies control rig | EditMode/ControlRigEditMode.h | |
virtual IPersonaPreviewScene & GetAnimPreviewScene() |
EditMode/ControlRigEditMode.h | ||
virtual bool GetCameraTarget
(
FSphere& OutTarget |
IPersonaEditMode interface | EditMode/ControlRigEditMode.h | |
TSharedPtr< FUICommandList > GetCommandBindings() |
EditMode/ControlRigEditMode.h | ||
TArrayView< TWeakObjectPtr< UControlRig > > GetControlRigs () |
EditMode/ControlRigEditMode.h | ||
TArrayView< const TWeakObjectPtr< UControlRig > > GetControlRigs () |
Get all of the ControlRigs, maybe not valid anymore | EditMode/ControlRigEditMode.h | |
TArray< UControlRig * > GetControlRigsArray
(
bool bIsVisible |
Get valid Control Rigs possibly just visible | EditMode/ControlRigEditMode.h | |
TArray< const UControlRig * > GetControlRigsArray
(
bool bIsVisible |
EditMode/ControlRigEditMode.h | ||
virtual bool GetCustomDrawingCoordinateSystem
(
FMatrix& OutMatrix, |
EditMode/ControlRigEditMode.h | ||
virtual bool GetCustomInputCoordinateSystem
(
FMatrix& OutMatrix, |
EditMode/ControlRigEditMode.h | ||
bool GetOnlySelectRigControls() |
EditMode/ControlRigEditMode.h | ||
| EditMode/ControlRigEditMode.h | |||
virtual bool GetPivotForOrbit
(
FVector& OutPivot |
EditMode/ControlRigEditMode.h | ||
TWeakPtr< ISequencer > GetWeakSequencer() |
Get Sequencer Driving This | EditMode/ControlRigEditMode.h | |
virtual FVector GetWidgetLocation() |
EditMode/ControlRigEditMode.h | ||
virtual bool HandleClick
(
FEditorViewportClient* InViewportClient, |
EditMode/ControlRigEditMode.h | ||
virtual bool InputDelta
(
FEditorViewportClient* InViewportClient, |
EditMode/ControlRigEditMode.h | ||
virtual bool InputKey
(
FEditorViewportClient* InViewportClient, |
EditMode/ControlRigEditMode.h | ||
void InvertInputPose
(
bool bSelectionOnly, |
Invert Input Pose | EditMode/ControlRigEditMode.h | |
virtual bool IsCompatibleWith
(
FEditorModeID OtherModeID |
EditMode/ControlRigEditMode.h | ||
virtual bool IsInLevelEditor () |
This edit mode is re-used between the level editor and the asset editors (control rig editor etc.). | EditMode/ControlRigEditMode.h | |
void MirrorSelectedControls() |
Put Selected Controls To Mirrored Pose | EditMode/ControlRigEditMode.h | |
void MirrorUnselectedControls() |
Put Unselected Controls To Mirrored PosePut Unselected Controls To Mirrored selcted controls | EditMode/ControlRigEditMode.h | |
virtual bool MouseEnter
(
FEditorViewportClient* ViewportClient, |
EditMode/ControlRigEditMode.h | ||
virtual bool MouseLeave
(
FEditorViewportClient* ViewportClient, |
EditMode/ControlRigEditMode.h | ||
virtual bool MouseMove
(
FEditorViewportClient* ViewportClient, |
EditMode/ControlRigEditMode.h | ||
FSimpleMulticastDelegate & OnAnimSystemInitialized() |
EditMode/ControlRigEditMode.h | ||
FNewMenuCommandsDelegate & OnContextMenuCommands() |
EditMode/ControlRigEditMode.h | ||
void OnControlModified
(
UControlRig* Subject, |
EditMode/ControlRigEditMode.h | ||
FControlRigAddedOrRemoved & OnControlRigAddedOrRemoved() |
Control Rig Changed Delegate | EditMode/ControlRigEditMode.h | |
FControlRigSelected & OnControlRigSelected() |
Control Rig Selected Delegate | EditMode/ControlRigEditMode.h | |
FSimpleMulticastDelegate & OnControlRigShapeActorsRecreated() |
Returns a delegate broadcast when control rig shape actors were recreated | EditMode/ControlRigEditMode.h | |
FOnControlRigVisibilityChanged & OnControlRigVisibilityChanged() |
Control Rig Visibility Delegate | EditMode/ControlRigEditMode.h | |
FOnGetContextMenu & OnGetContextMenu() |
Context Menu Delegates | EditMode/ControlRigEditMode.h | |
FOnGetRigElementTransform & OnGetRigElementTransform() |
Bone Manipulation Delegates | EditMode/ControlRigEditMode.h | |
FControlRigEditModeInteractionEndedEvent & OnGizmoInteractionEnded() |
Broadcasts a notification when a gizmo manipulation has ended | EditMode/ControlRigEditMode.h | |
FControlRigEditModeInteractionUpdatedEvent & OnGizmoInteractionPostUpdated() |
Broadcasts a notification when a gizmo manipulation has been updated (after the transforms have been updated) | EditMode/ControlRigEditMode.h | |
FControlRigEditModeInteractionUpdatedEvent & OnGizmoInteractionPreUpdated() |
Broadcasts a notification when a gizmo manipulation has been updated (before the update actually takes place) | EditMode/ControlRigEditMode.h | |
FControlRigEditModeInteractionStartedEvent & OnGizmoInteractionStarted() |
Broadcasts a notification when a gizmo manipulation has started | EditMode/ControlRigEditMode.h | |
void OnHierarchyModified
(
ERigHierarchyNotification InNotif, |
Callback that gets called when rig element is selected in other view | EditMode/ControlRigEditMode.h | |
void OnHierarchyModified_AnyThread
(
ERigHierarchyNotification InNotif, |
EditMode/ControlRigEditMode.h | ||
void OnPostConstruction_AnyThread
(
UControlRig* InRig, |
EditMode/ControlRigEditMode.h | ||
void OnPreConstruction_AnyThread
(
UControlRig* InRig, |
EditMode/ControlRigEditMode.h | ||
FOnSetRigElementTransform & OnSetRigElementTransform() |
EditMode/ControlRigEditMode.h | ||
void OpenSpacePickerWidget() |
Opens up the space picker widget | EditMode/ControlRigEditMode.h | |
void PastePose
(
bool bDoMirror, |
Paste saved pose | EditMode/ControlRigEditMode.h | |
virtual void PostUndo() |
EditMode/ControlRigEditMode.h | ||
void RefreshObjects() |
Refresh our internal object list (they may have changed) | EditMode/ControlRigEditMode.h | |
void RemoveControlRig
(
UControlRig* InControlRig |
Remove control rig | EditMode/ControlRigEditMode.h | |
virtual void Render
(
const FSceneView* View, |
EditMode/ControlRigEditMode.h | ||
void ReplaceControlRig
(
UControlRig* OldControlRig, |
Replace old Control Rig with the New Control Rig, perhaps from a recompile in the level editor | EditMode/ControlRigEditMode.h | |
void RequestToRecreateControlShapeActors
(
UControlRig* ControlRig |
Requests to recreate the shape actors in the next tick. | EditMode/ControlRigEditMode.h | |
void RequestTransformWidgetMode
(
UE::Widget::EWidgetMode InWidgetMode |
Request a certain transform widget for the next update | EditMode/ControlRigEditMode.h | |
void SavePose
(
int32 PoseNum |
For the following pose functions we only support one pose(PoseNum = 0) but may support more later Save a pose of selected controls | EditMode/ControlRigEditMode.h | |
void SelectAllControls() |
Select All Controls | EditMode/ControlRigEditMode.h | |
void SelectMirroredControls() |
Select Mirrored Controls on Current Selection | EditMode/ControlRigEditMode.h | |
virtual void SelectNone() |
EditMode/ControlRigEditMode.h | ||
void SelectPose
(
bool bDoMirror, |
Select controls in saved pose | EditMode/ControlRigEditMode.h | |
void SetAnimLayerPassthroughKey() |
Sets Passthrough Key on selected anim layers | EditMode/ControlRigEditMode.h | |
void SetObjects
(
UControlRig* InControlRig, |
Set the Control Rig Object to be active in the edit mode. | EditMode/ControlRigEditMode.h | |
void SetOnlySelectRigControls
(
bool val |
Toolbar functions. | EditMode/ControlRigEditMode.h | |
void SetRigElementSelection
(
UControlRig* ControlRig, |
Set a RigElement's selection state | EditMode/ControlRigEditMode.h | |
void SetRigElementSelection
(
UControlRig* ControlRig, |
Set multiple RigElement's selection states | EditMode/ControlRigEditMode.h | |
bool SetSequencer
(
TWeakPtr< ISequencer > InSequencer |
EditMode/ControlRigEditMode.h | ||
virtual bool ShouldDrawWidget() |
EditMode/ControlRigEditMode.h | ||
void ShowControlRigControls
(
UControlRig* InControlRig, |
Show or hide the specified Controls on this Control Rig; | EditMode/ControlRigEditMode.h | |
virtual bool StartTracking
(
FEditorViewportClient* InViewportClient, |
EditMode/ControlRigEditMode.h | ||
void SuspendHierarchyNotifs
(
bool bVal |
Suspend Rig Hierarchy Notifies | EditMode/ControlRigEditMode.h | |
virtual void Tick
(
FEditorViewportClient* ViewportClient, |
EditMode/ControlRigEditMode.h | ||
void ToggleControlsAsOverlay() |
Toggle controls as overlay | EditMode/ControlRigEditMode.h | |
void ToggleControlShapeTransformEdit() |
Toggle Shape Transform Edit | EditMode/ControlRigEditMode.h | |
void ToggleModuleManipulators() |
Toggles visibility of acive control rig shapes inside the selected module in the viewport | EditMode/ControlRigEditMode.h | |
void ToggleMotionTrails() |
Toggle Motion Trail Mode | EditMode/ControlRigEditMode.h | |
void TogglePivotMode() |
Toggle Pivot Mode | EditMode/ControlRigEditMode.h | |
virtual bool UsesToolkits() |
EditMode/ControlRigEditMode.h | ||
virtual bool UsesTransformWidget () |
EditMode/ControlRigEditMode.h | ||
virtual bool UsesTransformWidget
(
UE::Widget::EWidgetMode CheckMode |
EditMode/ControlRigEditMode.h | ||
void ZeroTransforms
(
bool bSelectionOnly, |
Reset Transforms | EditMode/ControlRigEditMode.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AreControlsVisible() |
Returns true if all control rig shapes are visible in the viewport | EditMode/ControlRigEditMode.h | |
bool AreRigElementSelectedAndMovable
(
UControlRig* InControlRig |
EditMode/ControlRigEditMode.h | ||
bool ComputePivotFromEditedShape
(
UControlRig* InControlRig, |
EditMode/ControlRigEditMode.h | ||
bool ComputePivotFromElements
(
UControlRig* InControlRig, |
EditMode/ControlRigEditMode.h | ||
bool ComputePivotFromShapeActors
(
UControlRig* InControlRig, |
EditMode/ControlRigEditMode.h | ||
void CopyControlsVisibility
(
const UControlRig* SourceRig, |
Copy control visibility from the source rig (and its modules if necessary) to the target rig | EditMode/ControlRigEditMode.h | |
AControlRigShapeActor * GetControlShapeFromControlName
(
UControlRig* InControlRig, |
Shape related functions wrt enable/selection | EditMode/ControlRigEditMode.h | |
ECoordSystem GetCoordSystemSpace() |
Get the current coordinate system space | EditMode/ControlRigEditMode.h | |
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). | EditMode/ControlRigEditMode.h | |
FTransform GetHostingSceneComponentTransform
(
const UControlRig* ControlRig |
EditMode/ControlRigEditMode.h | ||
UE::ControlRigEditMode::FInteractionDependencyCache & GetInteractionDependencies
(
UControlRig* InControlRig |
Returns the interaction dependencies of that ControlRig. | EditMode/ControlRigEditMode.h | |
FTransform GetPivotOrientation
(
const FRigElementKey& InControlKey, |
EditMode/ControlRigEditMode.h | ||
TArray< FRigElementKey > GetSelectedRigElements () |
GetSelectedRigElements, if InControlRig is nullptr get the first one | EditMode/ControlRigEditMode.h | |
EControlRigInteractionTransformSpace GetTransformSpace() |
EditMode/ControlRigEditMode.h | ||
virtual bool HandleBeginTransform
(
const FEditorViewportClient* InViewportClient |
EditMode/ControlRigEditMode.h | ||
virtual bool HandleEndTransform
(
FEditorViewportClient* InViewportClient |
EditMode/ControlRigEditMode.h | ||
void HandleSelectionChanged() |
Handle selection internally | EditMode/ControlRigEditMode.h | |
bool IsControlRigSkelMeshVisible
(
const UControlRig* InControlRig |
Get if the hosted component is visible. | EditMode/ControlRigEditMode.h | |
bool IsControlSelected
(
const bool bUseShapes |
Utility functions for UI/Some other viewport manipulation | EditMode/ControlRigEditMode.h | |
bool IsTransformDelegateAvailable() |
Return true if transform setter/getter delegates are available | EditMode/ControlRigEditMode.h | |
void MoveControlShape
(
AControlRigShapeActor* ShapeActor, |
EditMode/ControlRigEditMode.h | ||
bool MoveControlShapeLocally
(
AControlRigShapeActor* ShapeActor, |
EditMode/ControlRigEditMode.h | ||
| Called from the editor when a blueprint object replacement has occurred | EditMode/ControlRigEditMode.h | ||
void OpenContextMenu
(
FEditorViewportClient* InViewportClient |
Set initial transform handlers | EditMode/ControlRigEditMode.h | |
void SetObjects_Internal() |
Helper function: set ControlRigs array to the details panel | EditMode/ControlRigEditMode.h | |
void SetUpDetailPanel() |
Set up Details Panel based upon Selected Objects | EditMode/ControlRigEditMode.h | |
void ToggleAllManipulators() |
Toggles visibility of all control rig shapes in the viewport | EditMode/ControlRigEditMode.h | |
void ToggleManipulators() |
Toggles visibility of acive control rig shapes in the viewport | EditMode/ControlRigEditMode.h | |
void UpdatePivotTransforms() |
Updates cached pivot transforms | EditMode/ControlRigEditMode.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void ChangeControlShapeTransform
(
AControlRigShapeActor* ShapeActor, |
EditMode/ControlRigEditMode.h | ||
static void EvaluateRig
(
UControlRig* InControlRig |
EditMode/ControlRigEditMode.h | ||
static FTransform GetControlShapeTransform
(
const AControlRigShapeActor* ShapeActor |
EditMode/ControlRigEditMode.h | ||
static FControlRigEditMode * GetEditModeFromWorldContext
(
UWorld* InWorldContext |
Find the edit mode corresponding to the specified world context | EditMode/ControlRigEditMode.h | |
static uint8 GetInteractionType
(
const FEditorViewportClient* InViewportClient |
Computes the current interaction types based on the widget mode | EditMode/ControlRigEditMode.h | |
static TArray< FRigElementKey > GetRigElementsForSettingTransforms
(
UControlRig* InControlRig, |
Get the rig elements, based upon the selection or if it's a channel, also will do internal additive filters(like no bools) | EditMode/ControlRigEditMode.h | |
static TArray< FRigElementKey > GetSelectedRigElements
(
UControlRig* InControlRig |
EditMode/ControlRigEditMode.h | ||
static void InvertInputPose
(
UControlRig* ControlRig, |
Invert Input Pose for this Control Rig Controls based upon selection and channel states | EditMode/ControlRigEditMode.h | |
static void NotifyDrivenControls
(
UControlRig* InControlRig, |
Notify driven controls, should this be inside CR instead? | EditMode/ControlRigEditMode.h | |
static uint32 ValidControlTypeMask() |
EditMode/ControlRigEditMode.h | ||
static void ZeroTransforms
(
UControlRig* ControlRig, |
Reset Transforms for this Control Rig Controls based upon selection and channel states | EditMode/ControlRigEditMode.h |