| UObjectBase
|
Module |
|
Header |
/Engine/Source/Runtime/Experimental/InteractiveToolsFramework/Public/BaseGizmos/TransformGizmo.h |
Include |
#include "BaseGizmos/TransformGizmo.h" |
class UTransformGizmo :
public UInteractiveGizmo,
public IToolCommandChangeSource
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).
The in-scene representation of the Gizmo is a ATransformGizmoActor (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 UTransformGizmoBuilder registered with the GizmoManager. Return a suitably-configured GizmoActor and everything else will be handled automatically.
Name | Description | ||
---|---|---|---|
|
TUniquePtr< FTr... |
ActiveChange |
Ongoing transform change is tracked here, initialized in the IToolCommandChangeSource implementation. |
|
ActiveComponents |
List of current-active child components |
|
|
ActiveGizmos |
List of currently-active child gizmos |
|
|
ActiveTarget |
The active target object for the Gizmo |
|
|
AxisXSource |
X-axis source is shared across Gizmos, and created internally during SetActiveTarget() |
|
|
AxisYSource |
Y-axis source is shared across Gizmos, and created internally during SetActiveTarget() |
|
|
AxisZSource |
Z-axis source is shared across Gizmos, and created internally during SetActiveTarget() |
|
|
bSnapToWorldGrid |
If true, then when using world frame, Axis and Plane translation snap to the world grid via the ContextQueriesAPI (in PositionSnapFunction) |
|
|
bUseContextCoordinateSystem |
Whether to use the World/Local coordinate system provided by the context via the ContextyQueriesAPI. |
|
|
CameraAxisSource |
Axis SourcesAxis that points towards camera, X/Y plane tangents aligned to right/up. |
|
|
CurrentCoordinateSystem |
Current coordinate system in use. |
|
|
GizmoActor |
Current active GizmoActor that was spawned by this Gizmo. Will be destroyed when Gizmo is. |
|
|
TSharedPtr< FTr... |
GizmoActorBuilder |
|
|
NonuniformScaleComponents |
List of nonuniform scale components. |
|
|
ScaledTransformSource |
This TransformSource wraps a UGizmoComponentWorldTransformSource that is on the Gizmo Actor directly. |
|
|
SeparateChildScale |
Scaling on the active target UTransformProxy is stored here. |
|
|
StateTarget |
Other Gizmo Components State target is shared across gizmos, and created internally during SetActiveTarget(). |
|
|
UnitAxisXSource |
Scaling support. |
|
|
UnitAxisYSource |
Y-axis source (ie 0,1,0) is shared across Scale Gizmos, and created internally during SetActiveTarget() |
|
|
UnitAxisZSource |
Z-axis source (ie 0,0,1) is shared across Scale Gizmos, and created internally during SetActiveTarget() |
|
|
UpdateCoordSystemFunction |
This function is called on each active GizmoActor Component to update it's coordinate system (eg world/local). |
|
|
UpdateHoverFunction |
This function is called on each active GizmoActor Component to update it's hover state. |
|
|
UWorld * |
World |
GizmoActors will be spawned in this World |
Name | Description | ||
---|---|---|---|
|
UInteractive... |
AddAxisRotationGizmo ( |
|
|
UInteractive... |
AddAxisScaleGizmo ( |
|
|
UInteractive... |
AddAxisTranslationGizmo ( |
|
|
UInteractive... |
AddPlaneScaleGizmo ( |
|
|
UInteractive... |
AddPlaneTranslationGizmo ( |
|
|
UInteractive... |
AddUniformScaleGizmo ( |
|
|
ClearActiveTarget() |
Clear the active target object for the Gizmo |
|
|
ExternalSetChildScale ( |
This function is called by FTransformGizmoTransformChange to update SeparateChildScale on Undo/Redo. |
|
|
ATransformGi... |
GetGizmoActor() |
|
|
PositionSnapFunction |
Axis and Plane TransformSources use this function to execute worldgrid snap queries. |
|
|
SetActiveTarget ( |
Set the active target object for the Gizmo |
|
|
SetGizmoActorBuilder |
||
|
SetNewChildScale ( |
Explicitly set the child scale. |
|
|
SetNewGizmoTransform ( |
Set a new position for the Gizmo. |
|
|
SetUpdateCoordSystemFunction |
||
|
SetUpdateHoverFunction |
||
|
SetVisibility ( |
Set visibility for this Gizmo |
|
|
SetWorld ( |
||
|
UpdateCameraAxisSource() |
Internal function that updates CameraAxisSource by getting current view state from GizmoManager |
Name | Description | ||
---|---|---|---|
|
BeginChange() |
IToolCommandChangeSource implementation, used to initialize and emit ActiveChange. |
|
|
TUniquePtr< ... |
EndChange() |
|
|
GetChangeDescription() |
||
|
UObject *... |
GetChangeTarget() |