Navigation
API > API/Plugins > API/Plugins/ModelingEditorUI
Inheritance Hierarchy
- FSlateControlledConstruction
- TSharedFromThis
- SWidget
- SCompoundWidget
- STransformGizmoNumericalUIOverlay
References
| Module | ModelingEditorUI |
| Header | /Engine/Plugins/Experimental/MeshModelingToolsetExp/Source/ModelingEditorUI/Public/STransformGizmoNumericalUIOverlay.h |
| Include | #include "STransformGizmoNumericalUIOverlay.h" |
Syntax
class STransformGizmoNumericalUIOverlay : public SCompoundWidget
Remarks
An overlay that contains a draggable panel that mirrors the values of a UCombinedTransformGizmo and allows them to be settable by scrubbing the values or typing.
To use it, just add the overlay to your viewport and call BindToGizmoContextObject (sometime after TransformGizmoUtil::RegisterTransformGizmoContextObject has already been called). This will bind any gizmos subsequently created through TransformGizmoUtil to the panel.
MakeNumericalUISubMenu creates a submenu that can be slotted somewhere to enable/disable the UI panel or to reset its position in the viewport.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bIsEnabled | |
 |
bool | bPositionRelativeToBottom | |
 |
TSharedPtr< FTransformGizmoDataBinder > | DataBinder | Holds the functionality that binds the displayed values to the gizmo. |
 |
float | DefaultLeftPadding | The values to which the UI positioning is reset if asked. |
 |
float | DefaultVerticalPadding | |
 |
FVector3d | DisplayEulerAngles | |
 |
FVector3d | DisplayScale | |
 |
FVector3d | DisplayTranslation | Currently displayed values. |
 |
TSharedPtr< SDraggableBoxOverlay > | DraggableBoxOverlay | |
 |
EToolContextCoordinateSystem | LastCoordinateSystem | We have to respond to coordinate system changes for the gizmo, and to do that we need to be able to poll on tick, since we don't get notifications about it. |
 |
double | TranslationScrubSensitivity | Modifier for scrubbing translation, if we're using custom display functions. |
 |
TSharedPtr< SBorder > | WidgetContents | The part of the UI that changes when a different gizmo is chosen. |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
bool | BindToGizmoContextObject
(
UInteractiveToolsContext* ToolsContext |
Binding to the context object makes it so that the overlay gets attached to any subsequently created transform gizmos. |
 |
void | Construct
(
const FArguments& InArgs |
|
 |
SNumericEntryBox< double >::FArguments | CreateComponentBaseArgs
(
FVector3d& TargetVector, |
|
 |
TSharedRef< SWidget > | CreateRotationComponent
(
int ComponentIndex, |
|
 |
TSharedRef< SWidget > | CreateScaleComponent
(
int ComponentIndex, |
|
 |
TSharedRef< SWidget > | CreateTranslationComponent
(
int ComponentIndex, |
|
 |
TSharedRef< SWidget > | CreateWidgetForGizmo
(
ETransformGizmoSubElements GizmoElements |
Helpers for building the UI when changing gizmo. |
  |
bool | IsEnabled () |
|
  |
void | MakeNumericalUISubMenu
(
FMenuBuilder& MenuBuilder |
Creates a submenu to deal with the numerical UI, for placement in some toolbar by the mode/editor. |
 |
void | OnTickWidget
(
const FGeometry& AllottedGeometry, |
|
  |
void | Reset () |
Clears all gizmo bindings |
  |
void | Resets the position of the draggable UI box in the overlay to its default. | |
  |
void | SetCustomDisplayConversionFunctions
(
TFunction< FVector3d(const FVector3d&InternalValue)> InternalToDisplayConversionIn, |
Allows the positional (translation) copmonent to be displayed in different units than the gizmo world, for instance in a UV editor where the world coordinates are not actually 0 to 1. |
  |
void | SetDefaultLocalReferenceTransform
(
const TOptional< FTransform >& CustomReferenceTransform |
After calling this function, any newly initialized gizmos will be given the provided reference transform as their custom reference transform. |
  |
void | SetEnabled
(
bool bEnabledIn |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FArguments |