1. Epic GamesDeveloper
  3. UEditorInteractiveGizmoManager

UEditorInteractiveGizmoManager

[UEditorInteractiveGizmoManager](API\Editor\EditorInteractiveToolsFramework\UEditorInteractiveGizmoManager) allows users of the Tools framework to register and create selection-based Gizmo instances.

API > API/Editor > API/Editor/EditorInteractiveToolsFramework

UEditorInteractiveGizmoManager allows users of the Tools framework to register and create selection-based Gizmo instances. For each selection-based Gizmo, a builder derived from UInteractiveGizmoSelectionBuilder is registered with the GizmoManager. When the section changes, the highest priority builders for which SatisfiesCondition() return true, will be used to build gizmos.

   
Name UEditorInteractiveGizmoManager
Type class
Header File /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/EditorInteractiveGizmoManager.h
Include Path #include "EditorInteractiveGizmoManager.h"

Syntax

UCLASS (Transient)  
class UEditorInteractiveGizmoManager : public UInteractiveGizmoManager

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UEditorInteractiveGizmoManager()

   EditorInteractiveGizmoManager.h  

Typedefs

Name Type Remarks Include Path
FOnGizmosParametersChanged TMulticastDelegate_OneParam< void, const FGizmosParameters &InParameters > Delegate to notify from FGizmosParameters changes EditorInteractiveGizmoManager.h
FOnUsesNewTRSGizmosChanged TMulticastDelegate_OneParam< void, const bool bUseNewTRSGizmos > Delegate to notify from bUseNewTRSGizmos changes EditorInteractiveGizmoManager.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual UInteractiveGizmo * CreateGizmo ( const FString& BuilderIdentifier,
const FString& InstanceIdentifier,
void* Owner
)

 Try to activate a new Gizmo instance (UInteractiveGizmoManager override) EditorInteractiveGizmoManager.h  

void DeregisterEditorGizmoType ( EEditorGizmoCategory InGizmoCategory,
UInteractiveGizmoBuilder* InGizmoBuilder
)

 Remove an Editor gizmo type from the set of known Editor gizmo types EditorInteractiveGizmoManager.h  

virtual void DestroyAllEditorGizmos()

 Shutdown and remove all active auto gizmos EditorInteractiveGizmoManager.h  

virtual bool DestroyEditorGizmo ( UInteractiveGizmo* Gizmo
)

 Shutdown and remove a selection-based Gizmo EditorInteractiveGizmoManager.h  

virtual bool DestroyGizmo ( UInteractiveGizmo* InGizmo
)

 Shutdown and remove a Gizmo (UInteractiveGizmoManager override) EditorInteractiveGizmoManager.h  

virtual void DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

   EditorInteractiveGizmoManager.h  

virtual bool GetEditorGizmoBuilderResolution()

 Returns the current auto gizmo resolution setting EditorInteractiveGizmoManager.h  

void GetQualifiedEditorGizmoBuilders ( EEditorGizmoCategory InGizmoCategory,
const FToolBuilderState& InToolBuilderState,
TArray< UInteractiveGizmoBuilder* >& InFoundBuilders
)

 Get all qualified Editor gizmo builders for the specified category, based on the current state. EditorInteractiveGizmoManager.h  

void RegisterEditorGizmoType ( EEditorGizmoCategory InGizmoCategory,
UInteractiveGizmoBuilder* InGizmoBuilder
)

 Register a new Editor gizmo type. EditorInteractiveGizmoManager.h  

virtual void Render ( IToolsContextRenderAPI* RenderAPI
)

   EditorInteractiveGizmoManager.h  

virtual void SetEditorGizmoBuilderResolution ( bool bLocalOnly
)

 Set how auto gizmo resolution should occur when CreateGizmosForCurrentState is invoked. EditorInteractiveGizmoManager.h  

virtual void Tick ( float DeltaTime
)

   EditorInteractiveGizmoManager.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual bool GetShowEditorGizmos()

 Returns true if selection gizmos should be visible. EditorInteractiveGizmoManager.h  

virtual bool GetShowEditorGizmosForView ( IToolsContextRenderAPI* RenderAPI
)

 Returns true if gizmos should be visible based on the current view's engine show flag. EditorInteractiveGizmoManager.h  

virtual void InitializeWithEditorModeManager ( IToolsContextQueriesAPI* QueriesAPI,
IToolsContextTransactionsAPI* TransactionsAPI,
UInputRouter* InputRouter,
FEditorModeTools* InEditorModeManager
)

 Initialize the GizmoManager with the necessary Context-level state. EditorInteractiveGizmoManager.h  

virtual void Shutdown()

   EditorInteractiveGizmoManager.h  

void UpdateActiveEditorGizmos()

 Updates active selection gizmos when show selection state changes EditorInteractiveGizmoManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static const TOptional< FGizmosParameters > & GetDefaultGizmosParameters()

 Returns the default gizmos parameters if set EditorInteractiveGizmoManager.h  

static bool IsExplicitModeEnabled()

 Returns true if the Explicit mode is enabled; EditorInteractiveGizmoManager.h  

static FOnGizmosParametersChanged & OnGizmosParametersChangedDelegate()

   EditorInteractiveGizmoManager.h  

static FOnUsesNewTRSGizmosChanged & OnUsesNewTRSGizmosChangedDelegate()

   EditorInteractiveGizmoManager.h  

static void SetGizmosParameters ( const FGizmosParameters& InParameters
)

 Notifies FGizmosParameters changes across bound transform gizmos EditorInteractiveGizmoManager.h  

static void SetUsesNewTRSGizmos ( const bool bUseNewTRSGizmos
)

 Updates the current New TRS Gizmo state and notifies that change using OnUsesNewTRSGizmosChangedDelegate EditorInteractiveGizmoManager.h  

static const FString & TransformBuilderIdentifier()

   EditorInteractiveGizmoManager.h  

static const FString & TransformInstanceIdentifier()

 Instance/builder identifiers for transform gizmo EditorInteractiveGizmoManager.h  

static bool UsesNewTRSGizmos()

 Returns true if the new TRS gizmos are used. EditorInteractiveGizmoManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page