ABaseTransformGizmo

Base class for transform gizmo

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

ViewportInteraction

Header

/Engine/Source/Editor/ViewportInteraction/Public/VIBaseTransformGizmo.h

Include

#include "VIBaseTransformGizmo.h"

Syntax

class ABaseTransformGizmo : public AActor

Remarks

Base class for transform gizmo

Variables

Name Description

Protected variable

TArray < class U ...

 

AllHandleGroups

All gizmo components

Protected variable

EGizmoHandleTyp ...

 

GizmoType

Current gizmo type

Protected variable

USceneComponent ...

 

SceneComponent

Scene component root of this actor

Protected variable

FTimespan

 

SelectedAtTime

Real time that the gizmo was last attached to a selected set of objects.

Protected variable

UViewportWorldI ...

 

WorldInteraction

Owning object

Constructors

Name Description

Public function

ABaseTransformGizmo()

Default constructor that sets up CDO properties

Functions

Name Description

Public function

float

 

GetAnimationAlpha()

Updates the animation with the current time and selected time

Protected function Static

void

 

GetBoundingBoxEdge

(
    const FBox & Box,
    const int32 AxisIndex,
    const int32 EdgeIndex,
    FVector & OutVertex0,
    FVector & OutVertex1
)

Static: Given a bounding box and information about which edge to query, returns the vertex positions of that edge

Public function Const

EGizmoHandle ...

 

GetGizmoType()

Gets the current gizmo handle type

Public function

UViewportDra ...

 

GetInteractionType

(
    UActorComponent * DraggedCompon...,
    TOptional < FTransformGizmoHandlePla ...
)

Called by the world interaction system when one of our components is dragged by the user to find out what type of interaction to do.

Public function Const

UViewportWor ...

 

GetOwnerWorldInteraction()

Gets the owner

Protected function Const

bool

 

GetShowMeasurementText()

Gets if the gizmo shows measurement texts

Public function

void

 

OnNewObjectsSelected()

Call this when new objects become selected. This triggers an animation transition.

Public function

void

 

SetOwnerWorldInteraction

(
    UViewportWorldInteraction * InW...
)

Sets the owner

Public function Virtual

void

 

UpdateGizmo

(
    const EGizmoHandleTypes InGizmoType,
    const ECoordSystem InGizmoCoordinat...,
    const FTransform & InLocalToWorld,
    const FBox & InLocalBounds,
    const FVector & InViewLocation,
    const float InScaleMultiplier,
    bool bInAllHandlesVisible,
    const bool bInAllowRotationAndScale...,
    UActorComponent * DraggingHandl...,
    const TArray < UActorComponent *...,
    const float InGizmoHoverScale,
    const float InGizmoHoverAnimationDu...
)

Called by the world interaction system after we've been spawned into the world, to allow us to create components and set everything up nicely for the selected objects that we'll be used to manipulate

Protected function

void

 

UpdateHandleVisibility

(
    const EGizmoHandleTypes InGizmoType,
    const ECoordSystem InGizmoCoordinat...,
    bool bInAllHandlesVisible,
    UActorComponent * DraggingHandl...
)

Updates the visibility of all the handles

Overridden from UObject

Name Description

Public function Virtual Const

bool

 

IsEditorOnly()

Called during saving to determine if the object is forced to be editor only or not

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback