1. Epic GamesDeveloper
  3. UInteractiveGizmoManager

UInteractiveGizmoManager

[UInteractiveGizmoManager](API\Runtime\InteractiveToolsFramework\UInteractiveGizmoManager) allows users of the Tools framework to create and operate Gizmo instances.

API > API/Runtime > API/Runtime/InteractiveToolsFramework

UInteractiveGizmoManager allows users of the Tools framework to create and operate Gizmo instances. For each Gizmo, a (string,GizmoBuilder) pair is registered with the GizmoManager. Gizmos can then be activated via the string identifier.

   
Name UInteractiveGizmoManager
Type class
Header File /Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveGizmoManager.h
Include Path #include "InteractiveGizmoManager.h"

Syntax

UCLASS (Transient, MinimalAPI)  
class UInteractiveGizmoManager :  
    public UObject ,  
    public IToolContextTransactionProvider

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UInteractiveGizmoManager()

   InteractiveGizmoManager.h  

Constants

Name Type Remarks Include Path
CustomRepositionableThreeAxisTransformBuilderIdentifier const FString   InteractiveGizmoManager.h
CustomThreeAxisTransformBuilderIdentifier const FString   InteractiveGizmoManager.h
DefaultAxisAngleBuilderIdentifier FString   InteractiveGizmoManager.h
DefaultAxisPositionBuilderIdentifier FString Builder identifiers for default gizmo types. Perhaps should have an API for this... InteractiveGizmoManager.h
DefaultPlanePositionBuilderIdentifier FString   InteractiveGizmoManager.h
DefaultScalableSphereBuilderIdentifier FString   InteractiveGizmoManager.h
DefaultThreeAxisTransformBuilderIdentifier FString   InteractiveGizmoManager.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual UCombinedTransformGizmo * Create3AxisTransformGizmo ( void* Owner,
const FString& InstanceIdentifier
)

 Activate a new instance of the default 3-axis transformation Gizmo. InteractiveGizmoManager.h  

virtual UCombinedTransformGizmo * CreateCustomRepositionableTransformGizmo ( ETransformGizmoSubElements Elements,
void* Owner,
const FString& InstanceIdentifier
)

   InteractiveGizmoManager.h  

virtual UCombinedTransformGizmo * CreateCustomTransformGizmo ( ETransformGizmoSubElements Elements,
void* Owner,
const FString& InstanceIdentifier
)

 Activate a new customized instance of the default 3-axis transformation Gizmo, with only certain elements included. InteractiveGizmoManager.h  

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

 Try to activate a new Gizmo instance InteractiveGizmoManager.h  

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

 Try to activate a new Gizmo instance InteractiveGizmoManager.h  

virtual bool DeregisterGizmoType ( const FString& BuilderIdentifier
)

 Remove a GizmoBuilder from the set of known GizmoBuilders InteractiveGizmoManager.h  

virtual void DestroyAllGizmosByOwner ( void* Owner
)

 Destroy all Gizmos that are owned by the given pointer InteractiveGizmoManager.h  

virtual void DestroyAllGizmosOfType ( const FString& BuilderIdentifier
)

 Destroy all Gizmos that were created by the identified GizmoBuilder InteractiveGizmoManager.h  

virtual bool DestroyGizmo ( UInteractiveGizmo* Gizmo
)

 Shutdown and remove a Gizmo InteractiveGizmoManager.h  

virtual void DisplayMessage ( const FText& Message,
EToolMessageLevel Level
)

 Functions that Gizmos can call to interact with Transactions API Post a message via the Transactions API InteractiveGizmoManager.h  

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

 Let active Gizmos do screen space drawing. InteractiveGizmoManager.h  

virtual TArray< UInteractiveGizmo * > FindAllGizmosOfType ( const FString& BuilderIdentifier
)

 Find all the existing Gizmo instances that were created by the identified GizmoBuilder InteractiveGizmoManager.h  

virtual UInteractiveGizmo * FindGizmoByInstanceIdentifier ( const FString& Identifier
) const

 Find the Gizmo that was created with the given instance identifier InteractiveGizmoManager.h  

UContextObjectStore * GetContextObjectStore()

   InteractiveGizmoManager.h  

virtual IToolsContextQueriesAPI * GetContextQueriesAPI()

 Access to APIs, etc InteractiveGizmoManager.h  

virtual void PostInvalidation()

 Request an Invalidation via the Transactions API (ie to cause a repaint, etc) InteractiveGizmoManager.h  

virtual void RegisterDefaultGizmos()

 Standard Gizmos Register default gizmo types InteractiveGizmoManager.h  

virtual void RegisterGizmoType ( const FString& BuilderIdentifier,
UInteractiveGizmoBuilder* Builder
)

 GizmoBuilder Registration and Gizmo Creation/Shutdown Register a new GizmoBuilder InteractiveGizmoManager.h  

virtual void Render ( IToolsContextRenderAPI* RenderAPI
)

 Render any active Gizmos. InteractiveGizmoManager.h  

virtual void Tick ( float DeltaTime
)

 State control ( Tick any active Gizmos. Called by UInteractiveToolsContext InteractiveGizmoManager.h  

Overridden from IToolContextTransactionProvider

Name Remarks Include Path Unreal Specifiers

virtual void BeginUndoTransaction ( const FText& Description
)

 Request that the Context open a Transaction, whatever that means to the current Context InteractiveGizmoManager.h  

virtual void EmitObjectChange ( UObject* TargetObject,
TUniquePtr< FToolCommandChange > Change,
const FText& Description
)

 Forward an FChange object to the Context InteractiveGizmoManager.h  

virtual void EndUndoTransaction()

 Request that the Context close and commit the open Transaction InteractiveGizmoManager.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void Initialize ( IToolsContextQueriesAPI* QueriesAPI,
IToolsContextTransactionsAPI* TransactionsAPI,
UInputRouter* InputRouter
)

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

virtual void Shutdown ()

 Shutdown the GizmoManager. InteractiveGizmoManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page