1. Epic GamesDeveloper
  3. UInteractiveGizmoManager

UInteractiveGizmoManager

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

Unreal Engine C++ API Reference > Runtime > InteractiveToolsFramework

Inheritance Hierarchy

References

   
Module InteractiveToolsFramework
Header /Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveGizmoManager.h
Include #include "InteractiveGizmoManager.h"

Syntax

class UInteractiveGizmoManager :  
    public UObject,  
    public IToolContextTransactionProvider

Remarks

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.

Variables

  Type Name Description
Protected variable TArray< FActiveGizmo > ActiveGizmos Set of Currently-active Gizmos
Protected variable bool bDefaultGizmosRegistered  
Protected variable TSharedPtr< FCombinedTransformGizmoActorFactory > GizmoActorBuilder  
Protected variable TMap< FString, TObjectPtr< UInteractiveGizmoBuilder > > GizmoBuilders Current set of named GizmoBuilders
Protected variable UInputRouter * InputRouter Current InputRouter (Context owns this)
Protected variable IToolsContextQueriesAPI * QueriesAPI Current Context-Queries implementation
Protected variable IToolsContextTransactionsAPI * TransactionsAPI Current Transactions implementation

Constructors

  Type Name Description
Protected function    

Functions

  Type Name Description
Public function Virtual UCombinedTransformGizmo *

Create3AxisTransformGizmo ( void* Owner,
const FString& InstanceIdentifier
)

 Activate a new instance of the default 3-axis transformation Gizmo.
Public function Virtual UCombinedTransformGizmo *

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

  
Public function 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.
Public function Virtual UInteractiveGizmo *

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

 Try to activate a new Gizmo instance
Public function GizmoType *

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

 Try to activate a new Gizmo instance
Public function Virtual bool

DeregisterGizmoType ( const FString& BuilderIdentifier
)

 Remove a GizmoBuilder from the set of known GizmoBuilders
Public function Virtual void

DestroyAllGizmosByOwner ( void* Owner
)

 Destroy all Gizmos that are owned by the given pointer
Public function Virtual void

DestroyAllGizmosOfType ( const FString& BuilderIdentifier
)

 Destroy all Gizmos that were created by the identified GizmoBuilder
Public function Virtual bool Shutdown and remove a Gizmo
Public function Virtual void

DisplayMessage ( const FText& Message,
EToolMessageLevel Level
)

 Functions that Gizmos can call to interact with Transactions APIPost a message via the Transactions API
Public function Virtual void

DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

 Let active Gizmos do screen space drawing.
Public function Virtual TArray< UInteractiveGizmo * >

FindAllGizmosOfType ( const FString& BuilderIdentifier
)

 Find all the existing Gizmo instances that were created by the identified GizmoBuilder
Public function Virtual UInteractiveGizmo *

FindGizmoByInstanceIdentifier ( const FString& Identifier
)

 Find the Gizmo that was created with the given instance identifier
Public function Const UContextObjectStore *  
Public function Virtual IToolsContextQueriesAPI * Access to APIs, etc
Protected function Virtual void

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

 Initialize the GizmoManager with the necessary Context-level state.
Public function Virtual void Request an Invalidation via the Transactions API (ie to cause a repaint, etc)
Public function Virtual void Standard Gizmos Register default gizmo types
Public function Virtual void

RegisterGizmoType ( const FString& BuilderIdentifier,
UInteractiveGizmoBuilder* Builder
)

 GizmoBuilder Registration and Gizmo Creation/Shutdown Register a new GizmoBuilder
Public function Virtual void Render any active Gizmos.
Protected function Virtual void Shutdown the GizmoManager.
Public function Virtual void

Tick ( float DeltaTime
)

 State control (Tick any active Gizmos. Called by UInteractiveToolsContext

Overridden from IToolContextTransactionProvider

  Type Name Description
Public function Virtual void

BeginUndoTransaction ( const FText& Description
)

 Request that the Context open a Transaction, whatever that means to the current Context
Public function Virtual void

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

 Forward an FChange object to the Context
Public function Virtual void Request that the Context close and commit the open Transaction

Constants

Name Description
CustomRepositionableThreeAxisTransformBuilderIdentifier  
CustomThreeAxisTransformBuilderIdentifier  
DefaultAxisAngleBuilderIdentifier  
DefaultAxisPositionBuilderIdentifier Builder identifiers for default gizmo types. Perhaps should have an API for this...
DefaultPlanePositionBuilderIdentifier  
DefaultScalableSphereBuilderIdentifier  
DefaultThreeAxisTransformBuilderIdentifier  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page