1. Epic GamesDeveloper
  3. FTransformGizmoDataBinder

FTransformGizmoDataBinder

Helper class for binding a [UCombinedTransformGizmo](API\Runtime\InteractiveToolsFramework\BaseGizmos\UCombinedTransformGizmo) to several FVector3d's such that they are updated when the gizmo is changed, and the gizmo is updated from the vectors if the approriate function is called.

Unreal Engine C++ API Reference > Plugins > ModelingComponents > Transforms

Inheritance Hierarchy

References

   
Module ModelingComponents
Header /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/Transforms/TransformGizmoDataBinder.h
Include #include "Transforms/TransformGizmoDataBinder.h"

Syntax

class FTransformGizmoDataBinder : public TSharedFromThis< FTransformGizmoDataBinder, ESPMode::ThreadSafe >

Remarks

Helper class for binding a UCombinedTransformGizmo to several FVector3d's such that they are updated when the gizmo is changed, and the gizmo is updated from the vectors if the approriate function is called. The vectors can serve as a display of the gizmo's values, and if they are made modifiable, they can serve as a numerical control of the gizmo.

To use, just call InitializeBoundVectors with 3 vectors (it can be fewer, but the binder currently does the same amount of work regardless of whether 3 or fewer are bound), and then either call BindToGizmoContextObject with the context object that will be used to create the gizmos (in which case the vectors will bind to all newly created gizmos, and will switch bindings as different gizmos are dragged), or just bind to a particular gizmo using BindToInitializedGizmo after its SetActiveTarget call has been made..

Variables

  Type Name Description
Protected variable TFunction< FVector3d(const FVector3d &UIValues)> ActualToBoundConversion See comment for SetTranslationConversionFunctions.
Protected variable bool bCurrentGizmoLacksDegreeOfFreedom If a gizmo doesn't have all three axes and is not aligned to world (i.e. is in local mode) then we currently require a reference transform to allow the user to be in destination mode.
Protected variable bool bCurrentGizmoOnlyHasUniformScale  
Protected variable bool bGizmoIsBeingDragged  
Protected variable bool bIgnoreCallbackForDebouncing Used for debouncing when editing the gizmo via the UI.
Protected variable bool bInDataEditSequence Additional state that lets us respond appropriately to various notifications.
Protected variable FVector3d * BoundEulerAngles  
Protected variable TSet< TWeakObjectPtr< UCombinedTransformGizmo > > BoundGizmos All the gizmos the numerical UI can correspond to.
Protected variable FVector3d * BoundScale  
Protected variable TFunction< FVector3d(const FVector3d &UIValues)> BoundToActualConversion  
Protected variable FVector3d * BoundTranslation  
Protected variable bool bUsingDeltaMode Controls delta mode, where the gizmo specifies a difference from some start transform.
Protected variable TArray< TWeakObjectPtr< UCombinedTransformGizmoContextObject > > ContextObjectsToUnregisterWith Used to clean up our registration with context object when being destroyed.
Protected variable TOptional< FTransform > CurrentCustomLocalReferenceTransform Reference transform to use when in local gizmo mode.
Protected variable TWeakObjectPtr< UCombinedTransformGizmo > CurrentlyTrackedGizmo Gizmo to which the values are currently bound.
Protected variable TOptional< FTransform > DefaultCustomLocalReferenceTransform Reference transform to use in local gizmo mode by default.
Protected variable FTransform DeltaStartTransform  
Protected variable EToolContextCoordinateSystem LastCoordinateSystem Used to determine whether the current gizmo's coordinate system has changed, when we receive an UpdateCoordinateSystem() call.
Protected variable FVector3d LastEulerAngles  
Protected variable FVector3d LastScale  
Protected variable FVector3d LastTranslation Used to detect whether anything actually changed.
Public variable FOnTrackedGizmoChanged OnTrackedGizmoChanged  
Protected variable FVector3d ProportionalDragInitialVector Used when we only allow uniform scaling, to scale everything proportionally.
Protected variable FVector3d[3] VectorsToUseIfUnbound  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void Should be called at the beginning of a sequence of UpdateAfterDataEdit calls, for instance if the bound values are being scrubbed in a display.
Public function Virtual void Makes it so that the gizmo binder attaches to any gizmos created by the context object in the future.
Public function Virtual void Binds to a specific gizmo for tracking.
Protected function void Used for binding to context object, called from the OnGizmoCreated delegate.
Public function void Should be called at the end of a sequence of UpdateAfterDataEdit calls, for instance if the bound values are being scrubbed in a display.
Protected function FTransform

GetGizmoTransformFromDataValues ( bool bLocalCoordinates
)

  
Public function Virtual bool Determines whether there is a visible currently tracked gizmo.
Public function Virtual void

InitializeBoundVectors ( FVector3d* Translation,
FVector3d* RotaionEulerAngles,
FVector3d* Scale
)

 Set the vectors that should reflect the gizmo transform.
Public function Virtual bool In delta mode, the bound values hold the difference of the current gizmo transform relative to some previous start transform.
Protected function void  
Protected function void  
Protected function void Used in binding to gizmos.
Protected function void  
Protected function void

OnProxyTransformChanged ( UTransformProxy* TransformProxy,
FTransform Transform,
UCombinedTransformGizmo* Gizmo
)

  
Public function Virtual void

Reset ()

 Unbinds from everything
Public function Virtual void Much like SetToDeltaMode, but uses the current gizmo transform as the start transform, meaning that the bound data values will be reset to zero.
Public function void

SetDefaultLocalReferenceTransform ( TOptional< FTransform > DefaultTransform
)

 In local coordinate destination mode, when a DisplaySpaceTransform is not available on the gizmo, this default transform can be used instead.
Public function Virtual void

SetToDeltaMode ( const FTransform& StartTransform
)

 Sets to delta mode with given start transform.
Public function Virtual void Sets to destination mode (as opposed to delta mode).
Public function Virtual void Changes which gizmo is being tracked, out of those to which the data binder has been bound to via BindToInitializedGizmo().
Public function Virtual void

SetTranslationConversionFunctions ( TFunction< FVector3d(const FVector3d&InternalValue)> ActualToBoundConversionIn,
TFunction< FVector3d(const FVector3d&DisplayValue)> BoundToActualConversionIn
)

 Allows the data bound to the translation component to be stored in different units than used by the gizmo.
Public function Virtual bool If the gizmo doesn't have all three axes, then it likely needs to stay constrained in some plane/line.
Public function Virtual void Unbinds from a given gizmo.
Public function void Called to update the gizmo after updating the bound data.
Public function Virtual void Can either be called on tick or in response to some broadcast to allow the binder to respond to coordinate system changes.
Protected function void  

Typedefs

Name Description
FOnTrackedGizmoChanged Broadcast whenever the tracked gizmo is changed (because one of multiple gizmos is dragged, or a new gizmo appears after no others are present).

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page