UIntervalGizmo

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/IntervalGizmo.h

Include

#include "BaseGizmos/IntervalGizmo.h"

Syntax

class UIntervalGizmo : public UInteractiveGizmo

Variables

Name Description

Protected variable

TArray< TObject...

 

ActiveComponents

List of current-active child components

Protected variable

TArray< TObject...

 

ActiveGizmos

List of currently-active child gizmos

Protected variable

TObjectPtr< UGi...

 

AxisYSource

Y-axis source is shared across Gizmos, and created internally during SetActiveTarget()

Protected variable

TObjectPtr< UGi...

 

AxisZSource

Z-axis source is shared across Gizmos, and created internally during SetActiveTarget()

Protected variable

TUniqueFunction...

 

DestinationAlignmentRayCaster

Protected variable

UGizmoLocalFloa...

 

DownIntervalSource

Protected variable

UGizmoLocalFloa...

 

ForwardIntervalSource

Protected variable

AIntervalGizmoA...

 

GizmoActor

Protected variable

TSharedPtr< FIn...

 

GizmoActorBuilder

Public variable

FOnBeginInterva...

 

OnBeginIntervalGizmoEdit

Public variable

FOnEndIntervalE...

 

OnEndIntervalGizmoEdit

Public variable

FOnIntervalChan...

 

OnIntervalChanged

Protected variable

TUniqueFunction...

 

ShouldAlignDestination

Public variable

TObjectPtr< UGi...

 

StateTarget

State target is shared across gizmos, and created internally during SetActiveTarget()

Protected variable

TObjectPtr< UTr...

 

TransformProxy

The gizmo tracks the location and orientation of the transform in this TransformProxy.

Protected variable

TFunction< void...

 

UpdateCoordSystemFunction

This function is called on each active GizmoActor Component to update it's coordinate system (eg world/local).

Protected variable

TFunction< void...

 

UpdateHoverFunction

This function is called on each active GizmoActor Component to update it's hover state.

Protected variable

UGizmoLocalFloa...

 

UpIntervalSource

Protected variable

UWorld *

 

World

GizmoActors will be spawned in this World

Functions

Name Description

Protected function Virtual

UInteractive...

 

AddIntervalHandleGizmo

(
    USceneComponent* RootComponent,
    UPrimitiveComponent* HandleCom...,
    IGizmoAxisSource* AxisSource,
    IGizmoFloatParameterSource* Fl...,
    float MinParameter,
    float MaxParameter,
    IGizmoStateTarget* StateTarget...
)

Public function Virtual

void

 

BeginEditSequence()

Notifies listeners that a sequence of edits to the gizmo is beginning/ending (at the start/end of a drag).

Public function Virtual

void

 

ClearActiveTarget()

Clear the active target object for the Gizmo

Public function Virtual

void

 

ClearSources()

Clear the parameter sources for this gizmo

Public function Virtual

void

 

EndEditSequence()

Public function Virtual Const

FTransform

 

GetGizmoTransform()

Gets the location and orientation of the interval gizmo.

Public function Virtual

void

 

SetActiveTarget

Public function Virtual

void

 

SetGizmoActorBuilder

Public function Virtual

void

 

SetUpdateCoordSystemFunction

(
    TFunction< void...
)

Public function Virtual

void

 

SetUpdateHoverFunction

(
    TFunction< void...
)

Public function Virtual

void

 

SetWorld

(
    UWorld* WorldIn
)

Public function Virtual

void

 

SetWorldAlignmentFunctions

(
    TUniqueFunction< bool()>&& ShouldA...,
    TUniqueFunction< bool&,...
)

Sets functions that allow the endpoints of the intervals to be snapped to world geometry when ShouldAlignDestination is true

Overridden from UInteractiveGizmo

Name Description

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

Typedefs

Name

Description

FOnBeginIntervalEdit

Called when the gizmo is notified about the start of a sequence of interval changes.

FOnEndIntervalEdit

Called when the gizmo is notified about the end of a sequence of interval changes.

FOnIntervalChanged

Called when an interval is changed.

Constants

Name

Description

GizmoName