1. Epic GamesDeveloper
  3. UCombinedTransformGizmo

UCombinedTransformGizmo

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

Unreal Engine C++ API Reference > Runtime > InteractiveToolsFramework > BaseGizmos

Inheritance Hierarchy

References

   
Module InteractiveToolsFramework
Header /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/CombinedTransformGizmo.h
Include #include "BaseGizmos/CombinedTransformGizmo.h"

Syntax

class UCombinedTransformGizmo : public UInteractiveGizmo

Remarks

UCombinedTransformGizmo 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).

The in-scene representation of the Gizmo is a ACombinedTransformGizmoActor (or subclass). This Actor has FProperty members for the various sub-widgets, each as a separate Component. Any particular sub-widget of the Gizmo can be disabled by setting the respective Actor Component to null.

So, to create non-standard variants of the Transform Gizmo, set a new GizmoActorBuilder in the UCombinedTransformGizmoBuilder registered with the GizmoManager. Return a suitably-configured GizmoActor and everything else will be handled automatically.

Variables

  Type Name Description
Protected variable TArray< TObjectPtr< UPrimitiveComponent > > ActiveComponents List of current-active child components
Public variable EToolContextTransformGizmoMode ActiveGizmoMode Current dynamic sub-widget visibility mode to use (eg Translate-Only, Scale-Only, Combined, etc) If bUseContextGizmoMode is true, this value will be updated internally every Tick() by quering the ContextyQueriesAPI, otherwise the default is Combined and the client can change it as necessary
Protected variable TArray< TObjectPtr< UInteractiveGizmo > > ActiveGizmos List of currently-active child gizmos
Public variable TObjectPtr< UTransformProxy > ActiveTarget The active target object for the Gizmo
Protected variable FString AxisAngleBuilderIdentifier  
Protected variable FString AxisPositionBuilderIdentifier  
Protected variable TObjectPtr< UGizmoComponentAxisSource > AxisXSource X-axis source is shared across Gizmos, and created internally during SetActiveTarget()
Protected variable TObjectPtr< UGizmoComponentAxisSource > AxisYSource Y-axis source is shared across Gizmos, and created internally during SetActiveTarget()
Protected variable TObjectPtr< UGizmoComponentAxisSource > AxisZSource Z-axis source is shared across Gizmos, and created internally during SetActiveTarget()
Protected variable bool bDisallowNegativeScaling  
Public variable bool bGridSizeIsExplicit Optional grid size which overrides the Context Grid
Public variable bool bRotationGridSizeIsExplicit Optional grid size which overrides the Context Rotation Grid
Public variable bool bSnapToWorldGrid BSnapToWorldGrid controls whether any position snapping is applied, if possible, for Axis and Plane translations, via the ContextQueriesAPI Despite the name, this flag controls both world-space grid snapping and relative snapping
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 bUseContextCoordinateSystem Whether to use the World/Local coordinate system provided by the context via the ContextyQueriesAPI.
Public variable bool bUseContextGizmoMode Whether to use the Gizmo Mode provided by the context via the ContextyQueriesAPI.
Protected variable TObjectPtr< UGizmoConstantFrameAxisSource > CameraAxisSource Axis SourcesAxis that points towards camera, X/Y plane tangents aligned to right/up.
Public variable EToolContextCoordinateSystem CurrentCoordinateSystem Current coordinate system in use.
Protected variable TUniqueFunction< bool(const FRay &, FVector &)> DestinationAlignmentRayCaster  
Protected variable TOptional< FTransform > DisplaySpaceTransform See comment for SetDisplaySpaceTransform;.
Public variable FVector ExplicitGridSize  
Public variable FRotator ExplicitRotationGridSize  
Protected variable ACombinedTransformGizmoActor * GizmoActor Current active GizmoActor that was spawned by this Gizmo. Will be destroyed when Gizmo is.
Protected variable TSharedPtr< FCombinedTransformGizmoActorFactory > GizmoActorBuilder  
Protected variable TUniqueFunction< bool()> IsNonUniformScaleAllowedFunc  
Protected variable TArray< FSubGizmoInfo > NonUniformScaleSubGizmos  
Public variable FOnClearActiveTarget OnAboutToClearActiveTarget  
Public variable FOnDisplaySpaceTransformChanged OnDisplaySpaceTransformChanged  
Public variable FOnSetActiveTarget OnSetActiveTarget  
Public variable FOnVisibilityChanged OnVisibilityChanged  
Protected variable FString PlanePositionBuilderIdentifier  
Public variable FToolContextOptionalToggle RelativeTranslationSnapping Specify whether Relative snapping for Translations should be used in World frame mode.
Protected variable TArray< FSubGizmoInfo > RotationSubGizmos  
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 TObjectPtr< UGizmoTransformChangeStateTarget > StateTarget Other Gizmo Components State target is shared across gizmos, and created internally during SetActiveTarget().
Protected variable TArray< FSubGizmoInfo > TranslationSubGizmos  
Protected variable TArray< FSubGizmoInfo > UniformScaleSubGizmos  
Protected variable TObjectPtr< UGizmoComponentAxisSource > UnitAxisXSource Scaling support.
Protected variable TObjectPtr< UGizmoComponentAxisSource > UnitAxisYSource Y-axis source (ie 0,1,0) is shared across Scale Gizmos, and created internally during SetActiveTarget()
Protected variable TObjectPtr< UGizmoComponentAxisSource > UnitAxisZSource Z-axis source (ie 0,0,1) is shared across Scale Gizmos, and created internally during SetActiveTarget()
Protected variable TFunction< void(UPrimitiveComponent *, EToolContextCoordinateSystem)> UpdateCoordSystemFunction This function is called on each active GizmoActor Component to update it's coordinate system (eg world/local).
Protected variable TFunction< void(UPrimitiveComponent *, bool)> UpdateHoverFunction This function is called on each active GizmoActor Component to update it's hover state.
Protected variable UWorld * World GizmoActors will be spawned in this World

Functions

  Type Name Description
Protected function Virtual UInteractiveGizmo *

AddAxisRotationGizmo ( UPrimitiveComponent* AxisComponent,
USceneComponent* RootComponent,
IGizmoAxisSource* AxisSource,
IGizmoTransformSource* TransformSource,
IGizmoStateTarget* StateTarget
)

  
Protected function Virtual UInteractiveGizmo *

AddAxisScaleGizmo ( UPrimitiveComponent* AxisComponent,
USceneComponent* RootComponent,
IGizmoAxisSource* GizmoAxisSource,
IGizmoAxisSource* ParameterAxisSource,
IGizmoTransformSource* TransformSource,
IGizmoStateTarget* StateTarget
)

  
Protected function Virtual UInteractiveGizmo *

AddAxisTranslationGizmo ( UPrimitiveComponent* AxisComponent,
USceneComponent* RootComponent,
IGizmoAxisSource* AxisSource,
IGizmoTransformSource* TransformSource,
IGizmoStateTarget* StateTarget,
int AxisIndex
)

  
Protected function Virtual UInteractiveGizmo *

AddPlaneScaleGizmo ( UPrimitiveComponent* AxisComponent,
USceneComponent* RootComponent,
IGizmoAxisSource* GizmoAxisSource,
IGizmoAxisSource* ParameterAxisSource,
IGizmoTransformSource* TransformSource,
IGizmoStateTarget* StateTarget
)

  
Protected function Virtual UInteractiveGizmo *

AddPlaneTranslationGizmo ( UPrimitiveComponent* AxisComponent,
USceneComponent* RootComponent,
IGizmoAxisSource* AxisSource,
IGizmoTransformSource* TransformSource,
IGizmoStateTarget* StateTarget,
int XAxisIndex,
int YAxisIndex
)

  
Protected function Virtual UInteractiveGizmo *

AddUniformScaleGizmo ( UPrimitiveComponent* ScaleComponent,
USceneComponent* RootComponent,
IGizmoAxisSource* GizmoAxisSource,
IGizmoAxisSource* ParameterAxisSource,
IGizmoTransformSource* TransformSource,
IGizmoStateTarget* StateTarget
)

  
Public function Virtual void Called at the start of a sequence of gizmo transform edits, for instance while dragging or manipulating the gizmo numerical UI.
Public function Virtual void Clear the active target object for the Gizmo
Public function Virtual void Called at the end of a sequence of gizmo transform edits.
Public function const TOptional< FTransform > &  
Public function Const ACombinedTransformGizmoActor *  
Public function ETransformGizmoSubElements Gets the elements that this gizmo was initialized with.
Public function Const FTransform  
Public function Virtual Const bool Exposes the return value of the current IsNonUniformScaleAllowed function so that, for instance, numerical UI can react appropriately.
Public function Virtual bool  
Protected function Const bool

PositionAxisDeltaSnapFunction ( double AxisDelta,
double& SnappedDeltaOut,
int AxisIndex
)

  
Protected function Const bool

PositionSnapFunction ( const FVector& WorldPosition,
FVector& SnappedPositionOut
)

 Axis and Plane TransformSources use these function to execute snapping queries.
Public function void

ReinitializeGizmoTransform ( const FTransform& NewTransform,
bool bKeepGizmoUnscaled
)

 Repositions the gizmo without issuing undo/redo changes, triggering callbacks, or moving any components.
Protected function Const bool

RotationAxisAngleSnapFunction ( double AxisAngleDelta,
double& SnappedAxisAngleDeltaOut,
int AxisIndex
)

  
Protected function Const FQuat

RotationSnapFunction ( const FQuat& DeltaRotation
)

  
Public function Virtual void Set the active target object for the Gizmo
Public function Virtual void

SetDisallowNegativeScaling ( bool bDisallow
)

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

SetDisplaySpaceTransform ( TOptional< FTransform > TransformIn
)

 The DisplaySpaceTransform is not used by the gizmo itself, but can be used by external adapters that might display gizmo values, to give values relative to this transform rather than relative to world origin and axes.
Public function Virtual void  
Public function Virtual void

SetIsNonUniformScaleAllowedFunction ( TUniqueFunction< bool()>&& IsNonUniformScaleAllowed
)

 By default, non-uniform scaling handles appear (assuming they exist in the gizmo to begin with), when CurrentCoordinateSystem == EToolContextCoordinateSystem::Local, since components can only be locally scaled.
Public function Virtual void

SetNewChildScale ( const FVector& NewChildScale
)

 Explicitly set the child scale.
Public function Virtual void

SetNewGizmoTransform ( const FTransform& NewTransform,
bool bKeepGizmoUnscaled
)

 Set a new position for the Gizmo.
Public function Virtual void

SetSubGizmoBuilderIdentifiers ( FString AxisPositionBuilderIdentifier,
FString PlanePositionBuilderIdentifier,
FString AxisAngleBuilderIdentifier
)

  
Public function Virtual void

SetUpdateCoordSystemFunction ( TFunction< void(UPrimitiveComponent*, EToolContextCoordinateSystem)> CoordSysFunction
)

  
Public function Virtual void

SetUpdateHoverFunction ( TFunction< void(UPrimitiveComponent*, bool)> HoverFunction
)

  
Public function Virtual void

SetVisibility ( bool bVisible
)

 Set visibility for this Gizmo
Public function Virtual void

SetWorld ( UWorld* World
)

  
Public function Virtual void

SetWorldAlignmentFunctions ( TUniqueFunction< bool()>&& ShouldAlignDestination,
TUniqueFunction< bool(const FRay&, FVector&)>&& DestinationAlignmentRayCaster
)

 If used, binds alignment functions to the sub gizmos that they can use to align to geometry in the scene.
Protected function void Internal function that updates CameraAxisSource by getting current view state from GizmoManager
Public function void

UpdateTransformDuringEditSequence ( const FTransform& NewTransform,
bool bKeepGizmoUnscaled
)

 Updates the gizmo transform between Begin/EndTransformeditSequence calls.

Overridden from UInteractiveGizmo

  Type Name Description
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

Classes

  Type Name Description
Protected struct FSubGizmoInfo FSubGizmoInfo stores the (UPrimitiveComponent,UInteractiveGizmo) pair for a sub-element of the widget.  

Typedefs

Name Description
FOnClearActiveTarget Broadcast at the beginning of a ClearActiveTarget call, when the ActiveTarget (if present) is not yet disconnected.
FOnDisplaySpaceTransformChanged Broadcast at the end of a SetDisplaySpaceTransform call that changes the display space transform.
FOnSetActiveTarget Broadcast at the end of a SetActiveTarget call.
FOnVisibilityChanged Broadcast at the end of a SetVisibility call if the visibility changes.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page