UInteractiveGizmo

[UInteractiveGizmo](API\Runtime\InteractiveToolsFramework\UInteractiveGizmo) is the base class for all Gizmos in the InteractiveToolsFramework.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveGizmo.h

Include

#include "InteractiveGizmo.h"

Syntax

class UInteractiveGizmo :
    public UObject,
    public IInputBehaviorSource

Remarks

UInteractiveGizmo is the base class for all Gizmos in the InteractiveToolsFramework.

Variables

Name Description

Protected variable

TObjectPtr< UIn...

 

InputBehaviors

The current set of InputBehaviors provided by this Gizmo

Constructors

Name Description

Public function

UInteractiveGizmo()

Functions

Name Description

Public function Virtual

void

 

AddInputBehavior

(
    UInputBehavior* Behavior
)

Input Behaviors support Add an input behavior for this Gizmo

Public function Virtual

void

 

DrawHUD

(
    FCanvas* Canvas,
    IToolsContextRenderAPI* Render...
)

Allow the Gizmo to do any custom screen space drawing

Public function Virtual Const

UInteractive...

 

GetGizmoManager()

Public function Virtual

void

 

Render

(
    IToolsContextRenderAPI* Render...
)

Allow the Gizmo to do any custom drawing (ie via PDI/RHI)

Public function Virtual

void

 

Setup()

Called by GizmoManager to initialize the Gizmo after GizmoBuilder::BuildGizmo() has been called

Public function Virtual

void

 

Shutdown()

Called by GizmoManager to shut down the Gizmo

Public function Virtual

void

 

Tick

(
    float DeltaTime
)

Allow the Gizmo to do any necessary processing on Tick

Overridden from IInputBehaviorSource

Name Description

Public function Virtual Const

const UInput...

 

GetInputBehaviors()