1. Epic GamesDeveloper
  3. ABaseTransformGizmo

ABaseTransformGizmo

Base class for transform gizmo

Unreal Engine C++ API Reference > Editor > ViewportInteraction

Inheritance Hierarchy

  • AActor
  • ABaseTransformGizmo

References

   
Module ViewportInteraction
Header /Engine/Source/Editor/ViewportInteraction/Public/VIBaseTransformGizmo.h
Include #include "VIBaseTransformGizmo.h"

Syntax

UCLASS (Abstract, NotPlaceable)  
class ABaseTransformGizmo : public AActor

Remarks

Base class for transform gizmo

Variables

  Type Name Description
Protected variable UProperty TArray< TObjectPtr< class UGizmoHandleGroup > > AllHandleGroups All gizmo components
Protected variable EGizmoHandleTypes GizmoType Current gizmo type
Protected variable UProperty TObjectPtr< 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 UProperty TObjectPtr< class UViewportWorldInteraction > WorldInteraction Owning object

Constructors

  Type Name Description
Public function   Default constructor that sets up CDO properties

Functions

  Type Name Description
Public function float 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 EGizmoHandleTypes Gets the current gizmo handle type
Public function 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.
Public function Const UViewportWorldInteraction * Gets the owner
Protected function Const bool Gets if the gizmo shows measurement texts
Public function Virtual Const bool  
Public function void Call this when new objects become selected. This triggers an animation transition.
Public function void Sets the owner
Public function 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
Protected function void

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

 Updates the visibility of all the handles

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page