UAxisAngleGizmo

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

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

Include

#include "BaseGizmos/AxisAngleGizmo.h"

Syntax

class UAxisAngleGizmo :
    public UInteractiveGizmo,
    public IClickDragBehaviorTarget,
    public IHoverBehaviorTarget

Variables

Name Description

Public variable

TScriptInterfac...

 

AngleSource

Public variable

TScriptInterfac...

 

AxisSource

Public variable

bool

 

bInInteraction

Protected variable

float

 

ClosestAxisStartAngle

The angle of the closest axis in the plane of the angle gizmo (will be 0, pi/2, pi, or 3pi/2).

Public variable

TUniqueFunction...

 

CustomDestinationFunc

If ShouldUseCustomDestinationFunc() returns true, this function is used to get a destination point, and the output parameter is picked in such a way that the closest axis in the plane of the gizmo (the positive or negative x or y, if we're rotating around z, for instance) moves to the closest point in the plane to the destination point.

Public variable

TScriptInterfac...

 

HitTarget

Protected variable

float

 

InitialTargetAngle

Public variable

float

 

InteractionCurAngle

Public variable

FVector

 

InteractionCurPoint

Public variable

float

 

InteractionStartAngle

Public variable

FVector

 

InteractionStartPoint

Protected variable

FVector

 

LastHitPosition

Public variable

TObjectPtr< UCl...

 

MouseBehavior

The mouse click behavior of the gizmo is accessible so that it can be modified to use different mouse keys.

Public variable

FVector

 

RotationAxis

Public variable

FVector

 

RotationOrigin

Public variable

FVector

 

RotationPlaneX

Public variable

FVector

 

RotationPlaneY

Public variable

TUniqueFunction...

 

ShouldUseCustomDestinationFunc

This gets checked to see if we should use the custom ray caster to get a destination point for the gizmo, rather than grabbing the intersection with the gizmo plane.

Public variable

TScriptInterfac...

 

StateTarget

Overridden from UInteractiveGizmo

Name Description

Public function Virtual

void

 

Setup()

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

Overridden from IClickDragBehaviorTarget

Name Description

Public function Virtual

FInputRayHit

 

CanBeginClickDragSequence

(
    const FInputDeviceRay& PressPos
)

Test if target can begin click-drag interaction at this point

Public function Virtual

void

 

OnClickDrag

(
    const FInputDeviceRay& DragPos
)

Notify Target that input position has changed

Public function Virtual

void

 

OnClickPress

(
    const FInputDeviceRay& PressPos
)

Notify Target that click press ocurred

Public function Virtual

void

 

OnClickRelease

(
    const FInputDeviceRay& ReleasePos
)

Notify Target that click release occurred

Public function Virtual

void

 

OnTerminateDragSequence()

Notify Target that click-drag sequence has been explicitly terminated (eg by escape key)

Overridden from IModifierToggleBehaviorTarget

Name Description

Public function Virtual

void

 

OnUpdateModifierState

(
    int ModifierID,
    bool bIsOn
)

IModifierToggleBehaviorTarget implementation (inherited via IClickDragBehaviorTarget)

Overridden from IHoverBehaviorTarget

Name Description

Public function Virtual

FInputRayHit

 

BeginHoverSequenceHitTest

(
    const FInputDeviceRay& PressPos
)

IHoverBehaviorTarget implementation.

Public function Virtual

void

 

OnBeginHover

(
    const FInputDeviceRay& DevicePos
)

Initialize hover sequence at given position

Public function Virtual

void

 

OnEndHover()

Terminate active hover sequence

Public function Virtual

bool

 

OnUpdateHover

(
    const FInputDeviceRay& DevicePos
)

Update active hover sequence with new input position

Classes

Name

Description

Public struct

FCustomDestinationParams