Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > ViewportInteraction > ABaseTransformGizmo

Light Theme

Dark Theme

ABaseTransformGizmo

Base class for transform gizmo

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

ABaseTransformGizmo

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
TArray< class U...	AllHandleGroups	All gizmo components
EGizmoHandleTyp...	GizmoType	Current gizmo type
USceneComponent...	SceneComponent	Scene component root of this actor
FTimespan	SelectedAtTime	Real time that the gizmo was last attached to a selected set of objects.
UViewportWorldI...	WorldInteraction	Owning object

Constructors

	Name	Description
	ABaseTransformGizmo()	Default constructor that sets up CDO properties

Functions

	Name	Description
float	GetAnimationAlpha()	Updates the animation with the current time and selected time
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
EGizmoHandle...	GetGizmoType()	Gets the current gizmo handle type
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.
UViewportWor...	GetOwnerWorldInteraction()	Gets the owner
bool	GetShowMeasurementText()	Gets if the gizmo shows measurement texts
void	OnNewObjectsSelected()	Call this when new objects become selected. This triggers an animation transition.
void	SetOwnerWorldInteraction ( UViewportWorldInteraction* InW... )	Sets the owner
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
void	UpdateHandleVisibility ( const EGizmoHandleTypes InGizmoType, const ECoordSystem InGizmoCoordinat..., bool bInAllHandlesVisible, UActorComponent* DraggingHandl... )	Updates the visibility of all the handles

Overridden from UObject

		Name	Description
	bool	IsEditorOnly()	Called during saving to determine if the object is forced to be editor only or not

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss