UTransformGizmo

[UTransformGizmo](API\Editor\EditorInteractiveToolsFramework\EditorGizmos\UTransformGizmo) provides standard Transformation Gizmo interactions, applied to a [UTransformProxy](API\Runtime\InteractiveToolsFramework\BaseGizmos\UTransformProxy) target object.

API > API/Editor > API/Editor/EditorInteractiveToolsFramework > API/Editor/EditorInteractiveToolsFramework/EditorGizmos

Inheritance Hierarchy

References

   
Module EditorInteractiveToolsFramework
Header /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/EditorGizmos/TransformGizmo.h
Include #include "EditorGizmos/TransformGizmo.h"

Syntax

class UTransformGizmo :  
    public UInteractiveGizmo,  
    public IHoverBehaviorTarget,  
    public IClickDragBehaviorTarget

Remarks

UTransformGizmo provides standard Transformation Gizmo interactions, applied to a UTransformProxy target object. By default the Gizmo will be a standard XYZ translate/rotate Gizmo (axis and plane translation).

Variables

  Type Name Description
Public variable TObjectPtr< UTransformProxy > ActiveTarget The active target object for the Gizmo
Protected variable TObjectPtr< UMaterialInstanceDynamic > AxisMaterialX  
Protected variable TObjectPtr< UMaterialInstanceDynamic > AxisMaterialY  
Protected variable TObjectPtr< UMaterialInstanceDynamic > AxisMaterialZ  
Protected variable bool bDisallowNegativeScaling  
Public variable bool bGridSizeIsExplicit Optional grid size which overrides the Context Grid
Public variable bool bInInteraction Whether gizmo is interacting.
Public variable bool bRotationGridSizeIsExplicit Optional grid size which overrides the Context Rotation Grid
Public variable bool bSnapToWorldGrid If true, then when using world frame, Axis and Plane translation snap to the world grid via the ContextQueriesAPI (in PositionSnapFunction)
Public variable bool bSnapToWorldRotGrid If true, then when using world frame, Axis and Plane translation snap to the world grid via the ContextQueriesAPI (in RotationSnapFunction)
Public variable bool bVisible Whether gizmo is visible.
Protected variable TObjectPtr< UGizmoConstantFrameAxisSource > CameraAxisSource Axis that points towards camera, X/Y plane tangents aligned to right/up.
Protected variable TObjectPtr< UMaterialInstanceDynamic > CurrentAxisMaterial  
Protected variable TEnumAsByte< EAxisList::Type > CurrentAxisToDraw Currently rendered axis list
Protected variable EGizmoTransformMode CurrentMode Currently rendered transform mode
Protected variable FTransform CurrentTransform Current transform
Protected variable TFunction< const FGizmoCustomization()> CustomizationFunction Customization function (to override default material or increment gizmo size for example)
Protected variable TUniqueFunction< bool(const FRay &, FVector &)> DestinationAlignmentRayCaster  
Public variable FVector ExplicitGridSize  
Public variable FRotator ExplicitRotationGridSize  
Public variable TObjectPtr< UGizmoElementGroup > GizmoElementRoot Root of renderable gizmo elements
Public variable TObjectPtr< UGizmoViewContext > GizmoViewContext Gizmo view context, needed for screen space interactions
Protected variable TObjectPtr< UMaterialInstanceDynamic > GreyMaterial  
Protected variable TObjectPtr< UMaterialInterface > GridMaterial  
Public variable TObjectPtr< UGizmoElementHitMultiTarget > HitTarget The hit target object
Protected variable float InteractionAxisCurrParam Active interaction current hit param (only valid between state target BeginModify/EndModify)
Protected variable FVector InteractionAxisDirection Active world space axis (only valid between state target BeginModify/EndModify)
Protected variable TEnumAsByte< EAxisList::Type > InteractionAxisList The values below are used in the context of a single click-drag interaction, ie if bInInteraction = true They otherwise should be considered uninitializedActive axis type (only valid between state target BeginModify/EndModify)
Protected variable FVector InteractionAxisOrigin Active world space axis origin (only valid between state target BeginModify/EndModify)
Protected variable float InteractionAxisStartParam Active interaction start hit param (only valid between state target BeginModify/EndModify)
Protected variable float InteractionCurrAngle Active interaction rotation curr angle (only valid between state target BeginModify/EndModify)
Protected variable FVector InteractionPlanarAxisX Active world space axis X used for planar (only valid between state target BeginModify/EndModify)
Protected variable FVector InteractionPlanarAxisY Active world space axis Y used for planar (only valid between state target BeginModify/EndModify)
Protected variable FVector InteractionPlanarCurrPoint Active interaction current point planar (only valid between state target BeginModify/EndModify)
Protected variable FVector InteractionPlanarNormal Active world space normal used for planar (only valid between state target BeginModify/EndModify)
Protected variable FVector InteractionPlanarOrigin Active world space planar origin (only valid between state target BeginModify/EndModify)
Protected variable FVector InteractionPlanarStartPoint Active interaction start point planar (only valid between state target BeginModify/EndModify)
Protected variable FVector2D InteractionScreenAxisDirection Active interaction screen axis dir (only valid between state target BeginModify/EndModify)
Protected variable FVector2D InteractionScreenCurrPos Active interaction screen current pos (only valid between state target BeginModify/EndModify)
Protected variable FVector2D InteractionScreenEndPos Active interaction screen end pos (only valid between state target BeginModify/EndModify)
Protected variable FVector2D InteractionScreenStartPos Active interaction screen start pos (only valid between state target BeginModify/EndModify)
Protected variable float InteractionStartAngle Active interaction rotation start angle (only valid between state target BeginModify/EndModify)
Protected variable ETransformGizmoPartIdentifier LastHitPart Last hit part
Public variable TObjectPtr< UClickDragInputBehavior > MouseBehavior The mouse click behavior of the gizmo is accessible so that it can be modified to use different mouse keys.
Protected variable TArray< TFunction< void(UTransformGizmo *TransformGizmo, const FInputDeviceRay &DragPos)> > OnClickDragFunctions Array of function pointers, indexed by gizmo part id, to handle click drag behavior
Protected variable TArray< TFunction< void(UTransformGizmo *TransformGizmo, const FInputDeviceRay &PressPos)> > OnClickPressFunctions Array of function pointers, indexed by gizmo part id, to handle click press behavior
Protected variable TArray< TFunction< void(UTransformGizmo *TransformGizmo, const FInputDeviceRay &ReleasePos)> > OnClickReleaseFunctions Array of function pointers, indexed by gizmo part id, to handle click release behavior
Protected variable TArray< TFunction< void(UTransformGizmo *TransformGizmo, bool bInHover, uint32 InHitParts)> > OnUpdateHoverFunctions Array of function pointers, indexed by gizmo part id, to handle update hovering state
Protected variable TArray< TFunction< void(UTransformGizmo *TransformGizmo, bool bInInteracting, uint32 InHitPart)>... OnUpdateInteractingFunctions Array of function pointers, indexed by gizmo part id, to handle update interacting state
Protected variable TObjectPtr< UMaterialInstanceDynamic > OpaquePlaneMaterialXY  
Protected variable TObjectPtr< UGizmoElementCircle > RotateArcballInnerElement Rotate arcball inner circle
Protected variable TObjectPtr< UGizmoElementCircle > RotateArcballOuterElement Rotate arcball outer circle
Protected variable TObjectPtr< UGizmoElementCircle > RotateOuterCircleElement Rotate outer circle
Protected variable TObjectPtr< UGizmoElementCircle > RotateScreenSpaceElement Rotate screen space circle
Protected variable TObjectPtr< UGizmoElementTorus > RotateXAxisElement Rotate X Axis
Protected variable TObjectPtr< UGizmoElementTorus > RotateYAxisElement Rotate Y Axis
Protected variable TObjectPtr< UGizmoElementTorus > RotateZAxisElement Rotate Z Axis
Protected variable double ScaleMultiplier Percentage-based scale multiplier
Protected variable TObjectPtr< UGizmoElementRectangle > ScalePlanarXYElement Scale planar XY handle
Protected variable TObjectPtr< UGizmoElementRectangle > ScalePlanarXZElement Scale planar XZ handle
Protected variable TObjectPtr< UGizmoElementRectangle > ScalePlanarYZElement Scale planar YZ handle
Protected variable TObjectPtr< UGizmoElementBox > ScaleUniformElement Uniform scale object
Protected variable TObjectPtr< UGizmoElementArrow > ScaleXAxisElement Scale X Axis object
Protected variable TObjectPtr< UGizmoElementArrow > ScaleYAxisElement Scale Y Axis object
Protected variable TObjectPtr< UGizmoElementArrow > ScaleZAxisElement Scale Z Axis object
Protected variable TUniqueFunction< bool()> ShouldAlignDestination These are used to let the translation subgizmos use raycasts into the scene to align the gizmo with scene geometry.
Protected variable TScriptInterface< IGizmoStateTarget > StateTarget The state target is created internally during SetActiveTarget() if no one is provided.
Public variable TScriptInterface< ITransformGizmoSource > TransformGizmoSource Transform Gizmo Source
Protected variable TObjectPtr< UGizmoElementRectangle > TranslatePlanarXYElement Translate planar XY handle
Protected variable TObjectPtr< UGizmoElementRectangle > TranslatePlanarXZElement Translate planar XZ handle
Protected variable TObjectPtr< UGizmoElementRectangle > TranslatePlanarYZElement Translate planar YZ handle
Protected variable TObjectPtr< UGizmoElementRectangle > TranslateScreenSpaceElement Translate screen-space
Protected variable TObjectPtr< UGizmoElementArrow > TranslateXAxisElement Gizmo Objects, used for rendering and hit testingTranslate X Axis
Protected variable TObjectPtr< UGizmoElementArrow > TranslateYAxisElement Translate Y Axis
Protected variable TObjectPtr< UGizmoElementArrow > TranslateZAxisElement Translate Z Axis
Protected variable TObjectPtr< UMaterialInterface > TransparentVertexColorMaterial Materials and colors to be used when drawing the items for each axis
Protected variable TObjectPtr< UMaterialInstanceDynamic > WhiteMaterial  

Functions

  Type Name Description
Protected function Virtual void

ApplyRotateDelta ( const FQuat& InRotateDelta
)

 Apply rotate delta to transform proxy
Protected function Virtual void

ApplyScaleDelta ( const FVector& InScaleDelta
)

 Apply scale delta to transform proxy
Protected function Virtual void

ApplyTranslateDelta ( const FVector& InTranslateDelta
)

 Apply transform delta methodsApply translate delta to transform proxy
Public function Virtual void Clear the active target object for the Gizmo
Protected function Virtual FQuat

ComputeAngularRotateDelta ( double InStartAngle,
double InEndAngle
)

 Compute rotate delta based on start/end angles
Protected function Virtual FQuat

ComputeAxisRotateDelta ( const FVector2D& InStartPos,
const FVector2D& InEndPos
)

 Compute rotate delta based on screen-space start/end positions
Protected function Virtual FVector

ComputeAxisTranslateDelta ( double InStartParam,
double InEndParam
)

 Compute translate axis delta based on start/end params
Protected function Virtual FVector

ComputePlanarTranslateDelta ( const FVector& InStartPoint,
const FVector& InEndPoint
)

 Compute translate planar delta based on world space start/end points
Protected function Virtual FVector

ComputeScaleDelta ( const FVector2D& InStartPos,
const FVector2D& InEndPos,
FVector2D& OutScreenDelta
)

 Compute scale delta based on screen space start/end positions
Protected function Virtual void

EnableMode ( EGizmoTransformMode InGizmoMode,
EAxisList::Type InAxisListToDraw
)

 Enable the given mode with the specified axes, EAxisList::Type::None will hide objects associated with mode
Protected function Virtual void

EnablePlanarObjects ( bool bTranslate,
bool bEnableX,
bool bEnableY,
bool bEnableZ
)

 Enable planar handles used by translate and scale
Protected function Virtual void

EnableRotate ( EAxisList::Type InAxisListToDraw
)

 Enable rotate using specified axis list
Protected function Virtual void

EnableScale ( EAxisList::Type InAxisListToDraw
)

 Enable scale using specified axis list
Protected function Virtual void

EnableTranslate ( EAxisList::Type InAxisListToDraw
)

 Enable translate using specified axis list
Protected function Virtual Const FTransform Get gizmo transform based on cached current transform.
Protected function Virtual Const uint32 Get max part identifier.
Protected function Virtual float Get nearest param along input ray to the current interaction axis
Protected function Virtual bool

GetRayParamIntersectionWithInteractionPlane ( const FInputDeviceRay& InRay,
float& OutHitParam
)

 Return true if input ray intersects current interaction plane and return param along ray in OutHitParam
Protected function Const FVector2D

GetScreenProjectedAxis ( const UGizmoViewContext* View,
const FVector& InLocalAxis,
const FTransform& InLocalToWorld
)

 Screen-space helper methodReturns 2D vector projection of input axis onto input view plane
Protected function FVector2D

GetScreenRotateAxisDir ( const FVector& InAxis0,
const FVector& InAxis1
)

 Get screen-space axis for rotation drag
Protected function Virtual FVector

GetWorldAxis ( const FVector& InAxis
)

 Get current interaction axis
Protected function Virtual UGizmoElementRectangle *

MakePlanarHandle ( ETransformGizmoPartIdentifier InPartId,
const FVector& InUpDirection,
const FVector& InSideDirection,
const FVector& InPlaneNormal,
UMaterialInterface* InMaterial,
const FLinearColor& InVertexColor
)

 Construct planar axis handle
Protected function Virtual UGizmoElementTorus *

MakeRotateAxis ( ETransformGizmoPartIdentifier InPartId,
const FVector& TorusAxis0,
const FVector& TorusAxis1,
UMaterialInterface* InMaterial,
UMaterialInterface* InCurrentMaterial
)

 Construct rotate axis handle
Protected function Virtual UGizmoElementCircle *

MakeRotateCircleHandle ( ETransformGizmoPartIdentifier InPartId,
float InRadius,
const FLinearColor& InColor,
float bFill
)

 Construct rotate screen space handle
Protected function Virtual UGizmoElementArrow *

MakeScaleAxis ( ETransformGizmoPartIdentifier InPartId,
const FVector& InAxisDir,
const FVector& InSideDir,
UMaterialInterface* InMaterial
)

 Construct scale axis handle
Protected function Virtual UGizmoElementArrow *

MakeTranslateAxis ( ETransformGizmoPartIdentifier InPartId,
const FVector& InAxisDir,
const FVector& InSideDir,
UMaterialInterface* InMaterial
)

 Construct translate axis handle
Protected function Virtual UGizmoElementRectangle * Construct translate screen space handle
Protected function Virtual UGizmoElementBox * Construct uniform scale handle
Protected function Virtual void Handle click drag for rotate axis
Protected function Virtual void

OnClickDragScale ( const FInputDeviceRay& DragPos
)

 Handle click drag for all scale
Protected function Virtual void Handle click drag for scale axes
Protected function Virtual void Handle click drag for scale planar
Protected function Virtual void Handle click drag for uniform scale
Protected function Virtual void Handle click drag for screen-space rotate
Protected function Virtual void Handle click drag for screen-space translate
Protected function Virtual void Handle click drag for translate axes
Protected function Virtual void Handle click drag for translate planar
Protected function Virtual void

OnClickPressAxis ( const FInputDeviceRay& PressPos
)

 Handle click press for translate axes
Protected function Virtual void

OnClickPressPlanar ( const FInputDeviceRay& PressPos
)

 Handle click press for generic planar
Protected function Virtual void Rotate interaction methodsHandle click press for rotate X axis
Protected function Virtual void Handle click press for rotate Y axis
Protected function Virtual void Handle click press for rotate Z axis
Protected function Virtual void

OnClickPressScale ( const FInputDeviceRay& PressPos
)

 Handle click press for all scale methods
Protected function Virtual void Scale click-drag handling methodsHandle click press for scale X axis
Protected function Virtual void Handle click press for scale XY planar
Protected function Virtual void Handle click press for uniform scale
Protected function Virtual void Handle click press for scale XZ planar
Protected function Virtual void Handle click press for scale Y axis
Protected function Virtual void Handle click press for scale YZ planar
Protected function Virtual void Handle click press for scale Z axis
Protected function Virtual void Screen-space rotate interaction methodsHandle click press for screen-space rotate
Protected function Virtual void Screen-space translate interaction methodsHandle click press for screen-space translate
Protected function Virtual void Translate axis click-drag handling methods Handle click press for translate X axis
Protected function Virtual void Translate and scale planar click-drag handling methodsHandle click press for translate XY planar
Protected function Virtual void Handle click press for translate XZ planar
Protected function Virtual void Handle click press for translate Y axis
Protected function Virtual void Handle click press for translate YZ planar
Protected function Virtual void Handle click press for translate Z axis
Protected function Virtual void Handle click release for rotate axes
Protected function Virtual void Handle click release for scale axes
Protected function Virtual void Handle click release for scale planar
Protected function Virtual void

OnClickReleaseScaleXYZ ( const FInputDeviceRay& ReleasePos
)

 Handle click release for uniform scale
Protected function Virtual void Handle click release for screen-space rotate
Protected function Virtual void Handle click release for screen-space translate
Protected function Virtual void Handle click release for translate axes
Protected function Virtual void Handle click release for translate planar
Protected function Const bool

PositionSnapFunction ( const FVector& WorldPosition,
FVector& SnappedPositionOut
)

 Axis and Plane TransformSources use this function to execute worldgrid snap queries.
Protected function Const FQuat

RotationSnapFunction ( const FQuat& DeltaRotation
)

  
Public function Virtual void

SetActiveTarget ( UTransformProxy* Target,
IToolContextTransactionProvider* TransactionProvider,
IGizmoStateTarget* InStateTarget
)

 Set the active target object for the Gizmo
Public function void

SetCustomizationFunction ( const TFunction< const FGizmoCustomization()>& InFunction
)

 Set customization function for this Gizmo
Public function Virtual void

SetDisallowNegativeScaling ( bool bDisallow
)

 By default, the nonuniform scale components can scale negatively.
Public function Virtual void

SetNewChildScale ( const FVector& NewChildScale
)

 Explicitly set the child scale.
Protected function Virtual void Setup behaviors
Protected function Virtual void Setup materials
Protected function Virtual void Setup on click functions
Public function Virtual void

SetVisibility ( bool bVisible
)

 Set visibility for this Gizmo
Protected function void Internal function that updates CameraAxisSource by getting current view state from GizmoManager
Protected function Virtual FInputRayHit

UpdateHoveredPart ( const FInputDeviceRay& DevicePos
)

 Determine hit part and update hover state based on current input ray
Protected function Virtual void

UpdateHoverState ( bool bInHover,
ETransformGizmoPartIdentifier InPartId
)

 Update hover state for given part id
Protected function Virtual void

UpdateInteractingState ( bool bInInteracting,
ETransformGizmoPartIdentifier InPartId
)

 Update interacting state for given part id
Protected function Virtual void Update current gizmo mode based on transform source
Protected function Virtual Const bool

VerifyPartIdentifier ( uint32 InPartIdentifier
)

 Verify part identifier is within recognized range of transform gizmo part ids.

Overridden from UInteractiveGizmo

  Type Name Description
Public function Virtual void Allow the Gizmo to do any custom drawing (ie via PDI/RHI)
Public function Virtual void

Setup ()

 Called by GizmoManager to initialize the Gizmo after GizmoBuilder::BuildGizmo() has been called
Public function Virtual void Called by GizmoManager to shut down the Gizmo
Public function Virtual void

Tick ( float DeltaTime
)

 Allow the Gizmo to do any necessary processing on Tick

Overridden from IHoverBehaviorTarget

  Type Name Description
Public function Virtual FInputRayHit IHoverBehaviorTarget implementation.
Public function Virtual void

OnBeginHover ( const FInputDeviceRay& DevicePos
)

 Initialize hover sequence at given position
Public function Virtual void Terminate active hover sequence
Public function Virtual bool

OnUpdateHover ( const FInputDeviceRay& DevicePos
)

 Update active hover sequence with new input position

Overridden from IClickDragBehaviorTarget

  Type Name Description
Public function Virtual FInputRayHit IClickDragBehaviorTarget implementation.
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 Notify Target that click-drag sequence has been explicitly terminated (eg by escape key)

Constants

Name Description
ArcBallColor A linear, 32-bit/component floating point RGBA color.
AxisColorX  
AxisColorY A linear, 32-bit/component floating point RGBA color.
AxisColorZ A linear, 32-bit/component floating point RGBA color.
AxisLengthOffset  
AxisRadius  
AxisTransp  
CurrentColor A linear, 32-bit/component floating point RGBA color.
GreyColor A linear, 32-bit/component floating point RGBA color.
LargeOuterAlpha  
PlanarHandleOffset  
PlanarHandleSize  
PlaneColorXY A linear, 32-bit/component floating point RGBA color.
RotateArcballCircleColor  
RotateArcballInnerRadius Rotate constants.
RotateArcballOuterRadius  
RotateArcballSphereRadius  
RotateAxisInnerRadius  
RotateAxisInnerSlices  
RotateAxisNumSegments  
RotateAxisOuterRadius  
RotateOuterCircleColor  
RotateOuterCircleRadius  
RotateScreenSpaceCircleColor  
RotateScreenSpaceRadius  
ScaleAxisCubeDim  
ScaleAxisLength  
ScreenAxisColor A linear, 32-bit/component floating point RGBA color.
ScreenSpaceColor A linear, 32-bit/component floating point RGBA color.
TranslateAxisConeAngle  
TranslateAxisConeHeight  
TranslateAxisConeRadius  
TranslateAxisLength  
TranslateScreenSpaceHandleSize  
WhiteColor A linear, 32-bit/component floating point RGBA color.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page