1. Epic GamesDeveloper
  3. ABaseTransformGizmo

ABaseTransformGizmo

Displays measurements along the bounds of selected objects Base class for transform gizmo

API > API/Editor > API/Editor/ViewportInteraction

Displays measurements along the bounds of selected objects Base class for transform gizmo

   
Name ABaseTransformGizmo
Type class
Header File /Engine/Source/Editor/ViewportInteraction/Public/VIBaseTransformGizmo.h
Include Path #include "VIBaseTransformGizmo.h"

Syntax

UCLASS (MinimalAPI, Abstract, NotPlaceable)  
class ABaseTransformGizmo : public AActor

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

ABaseTransformGizmo()

 Default constructor that sets up CDO properties VIBaseTransformGizmo.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetAnimationAlpha()

 Updates the animation with the current time and selected time VIBaseTransformGizmo.h  

EGizmoHandleTypes GetGizmoType()

 Gets the current gizmo handle type VIBaseTransformGizmo.h  

UViewportDragOperationComponent * GetInteractionType ( UActorComponent* DraggedComponent,
TOptional< FTransformGizmoHandlePlacement >& OutHandlePlacement
)

 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. VIBaseTransformGizmo.h  

UViewportWorldInteraction * GetOwnerWorldInteraction()

 Gets the owner VIBaseTransformGizmo.h  

void OnNewObjectsSelected()

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

void SetOwnerWorldInteraction ( UViewportWorldInteraction* InWorldInteraction
)

 Sets the owner VIBaseTransformGizmo.h  

virtual void UpdateGizmo ( const EGizmoHandleTypes InGizmoType,
const ECoordSystem InGizmoCoordinateSpace,
const FTransform& InLocalToWorld,
const FBox& InLocalBounds,
const FVector& InViewLocation,
const float InScaleMultiplier,
bool bInAllHandlesVisible,
const bool bInAllowRotationAndScaleHandles,
UActorComponent* DraggingHandle,
const TArray< UActorComponent* >& InHoveringOverHandles,
const float InGizmoHoverScale,
const float InGizmoHoverAnimationDuration
)

 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 VIBaseTransformGizmo.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsEditorOnly()

   VIBaseTransformGizmo.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool GetShowMeasurementText()

 Gets if the gizmo shows measurement texts VIBaseTransformGizmo.h  

void UpdateHandleVisibility ( const EGizmoHandleTypes InGizmoType,
const ECoordSystem InGizmoCoordinateSpace,
bool bInAllHandlesVisible,
UActorComponent* DraggingHandle
)

 Updates the visibility of all the handles VIBaseTransformGizmo.h  

Static

Name Remarks Include Path Unreal Specifiers

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 VIBaseTransformGizmo.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page