Navigation
| Name | EditorInteractiveToolsFramework |
| Type | Editor |
| Location | /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/ |
| Module Build Rules | EditorInteractiveToolsFramework.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FEditor2DMouseWheelZoomBehaviorTarget | Allows the mouse wheel to move the camera forwards/backwards relative to the XY plane, in the direction pointed to by the mouse. |
| FEditor2DScrollBehaviorTarget | Allows click-dragging to move the camera in the XY plane. |
| FEditorBoxSelect | |
| FEditorDragToolBehaviorTarget | The base class that all drag tools inherit from. |
| FEditorDuplicateDragSelection | Listens for key press of a specified modifier key, and if Level Viewport Gizmo is dragging, it duplicates current selection. |
| FEditorFrustumSelect | Draws a box in the current viewport and when the mouse button is released, it selects/unselects everything inside of it. |
| FEditorGizmoSelectionBuilderHelper | |
| FEditorInteractiveToolsFrameworkGlobals | |
| FEditorInteractiveToolsFrameworkModule | |
| FEditorMeasureTool | |
| FEditorMoveCameraWithObject | Listens for key press of a specified modifier key, and if Level Viewport Gizmo is dragging, it duplicates current selection. |
| FEditorTransformGizmoDataBinder | FEditorTransformGizmoDataBinder is a helper class for binding a UTransformGizmo to a FEditorModeTools |
| FEditorViewportChange | |
| FEditorViewportClientProxy | |
| FLevelEditorViewportClientProxy | |
| FRelativeTransformInterfaceRegistry | FRelativeTransformInterfaceRegistry |
| UDragToolsBehaviorSource | Hosts Drag Tools and needed behaviors. |
| UEditorGizmoRegistryCategoryEntry | |
| UEditorGizmoRegistryCategoryEntry_Accessory | |
| UEditorGizmoRegistryCategoryEntry_ConditionalSelection | |
| UEditorGizmoRegistryCategoryEntry_Primary | |
| UEditorGizmoStateTarget | UEditorGizmoStateTarget |
| UEditorInteractiveGizmoConditionalBuilder | Gizmo builders which should be built once a condition is satisfied in the current scene state implement the IEditorInteractiveGizmoConditionalBuilder interface. |
| UEditorInteractiveGizmoManager | UEditorInteractiveGizmoManager allows users of the Tools framework to register and create selection-based Gizmo instances. |
| UEditorInteractiveGizmoRegistry | Gizmo types should be registered in either UEditorInteractiveGizmoSubsystem or UEditorInteractiveGizmoManager. |
| UEditorInteractiveGizmoSelectionBuilder | |
| UEditorSceneSnappingManager | |
| UEditorTransformGizmo | UEditorTransformGizmo handles Editor-specific functionality for the TransformGizmo, applied to a UEditorTransformProxy target object. |
| UEditorTransformGizmoBuilder | |
| UEditorTransformGizmoContextObject | UEditorTransformGizmoContextObject is a utility object that registers a Gizmo Builder for UTransformGizmo. |
| UEditorTransformGizmoSource | UEditorTransformGizmoSource is an ITransformGizmoSource implementation that provides current state information used to configure the Editor transform gizmo. |
| UEditorTransformProxy | UEditorTransformProxy is a derivation of UTransformProxy that returns the transform that defines the current space of the default Editor transform gizmo for a given mode manager / viewport. |
| UGizmoEdModeInterface | Interface for the new editor TRS gizmos |
| UGizmoElementGimbal | Gimbal rotation group object intended to be used as part of 3D Rotation Gizmos This group expects three rotation sub-elements |
| UMultiButtonClickDragBehavior | MultiButtonClickDragBehavior is an implementation of UClickDragInputBehavior that can manage several mouse buttons at once and also implements IClickDragBehaviorTarget directly, via a set of local lambda functions. |
| UToolStackContext | Context needed to support tool stacks, add this to your ContextObjectStore if you want to use tool stacks |
| UTransformGizmo | UTransformGizmo provides standard Transformation Gizmo interactions, applied to a UTransformProxy target object. |
| UTransformGizmoEditorSettings | |
| UTransformGizmoSource | |
| UWidgetToolsContext | UWidgetToolsContext extends UModeManagerInteractiveToolsContext with methods needed for tools operating on general widgets that do not have a viewport. |
Structs
| Name | Remarks |
|---|---|
| FActiveEditorGizmo | |
| FActorRelativeTransformInterface | Handles get / set relative transform operations UActorElementWorldInterface & UActorElementEditorWorldInterface |
| FComponentRelativeTransformInterface | Handles get / set relative transform operations UActorElementWorldInterface & UActorElementEditorWorldInterface |
| FEditorGizmoTypePriority | FEditorGizmoTypePriority is used to establish relative priority between conditional gizmo builders. |
| FGizmoCustomization | FGizmoCustomization is a struct that can be used to make some display overrides (currently material and size) |
| FGizmosParameters | |
| FGizmoState | Gizmo state structure used to pass gizmo data if needed |
| FInteractiveToolStack | FInteractiveToolStack represents a bundle of tools that may or may not share the same input chord Should some tools share a chord the most recently used tool will be activated by the chord. |
| FRotationContext | FRotationContext is a datastore for rotation data sent to the gizmo |
| FRotationDecomposition | FRotationDecomposition is a data storage structure representing the rotations around the X, Y and Z axis |
| IRelativeTransformInterface | IRelativeTransformInterface |
Interfaces
| Name | Remarks |
|---|---|
| IEditorInteractiveGizmoConditionalBuilder | |
| IEditorInteractiveGizmoSelectionBuilder | |
| IEditorViewportClientProxy | |
| IGizmoEdModeInterface | |
| ITransformGizmoSource | ITransformGizmoSource is an interface for providing gizmo mode configuration information. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnEditorDragToolsToggleDelegate | TMulticastDelegate_NoParams< void > | EditorDragTools/EditorDragToolBehaviorTarget.h |
Enums
Public
| Name | Remarks |
|---|---|
| EAxisRotateMode::Type | |
| EEditorGizmoCategory | Gizmo category used for registering Editor gizmo selection-based builders |
| EGizmoTransformMode | Interface for the Transform gizmo. |
| EGizmoTransformScaleType | |
| ETransformGizmoPartIdentifier | Interface for the Transform gizmo. |
| EViewportContext |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AltKeyMod | int | EditorDragTools/EditorDragToolBehaviorTarget.h | ||
| CtrlKeyMod | int | EditorDragTools/EditorDragToolBehaviorTarget.h | ||
| ShiftKeyMod | int | EditorDragTools/EditorDragToolBehaviorTarget.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
EGizmoTransformMode FEditorTransformGizmoUtil::GetGizmoMode
(
UE::Widget::EWidgetMode InWidgetMode |
Convert UE::Widget::EWidgetMode to ETransformGizmoMode | EditorGizmos/EditorTransformGizmoSource.h | |
UE::Widget::EWidgetMode FEditorTransformGizmoUtil::GetWidgetMode
(
EGizmoTransformMode InGizmoMode |
Convert EEditorGizmoMode to UE::Widget::EWidgetMode | EditorGizmos/EditorTransformGizmoSource.h | |
UTransformGizmo * UE::EditorTransformGizmoUtil::CreateTransformGizmo
(
UInteractiveToolManager* InToolManager, |
Spawn an editor like Transform Gizmo. | EditorGizmos/EditorTransformGizmoUtil.h | |
UTransformGizmo * UE::EditorTransformGizmoUtil::FindDefaultTransformGizmo
(
UInteractiveToolManager* InToolManager |
Returns the existing default Transform Gizmo if any. | EditorGizmos/EditorTransformGizmoUtil.h | |
UTransformGizmo * UE::EditorTransformGizmoUtil::GetDefaultTransformGizmo
(
UInteractiveToolManager* InToolManager |
Spawn an editor like Transform Gizmo. | EditorGizmos/EditorTransformGizmoUtil.h | |
bool UE::EditorTransformGizmoUtil::RegisterTransformGizmoContextObject
(
FEditorModeTools* InModeTools |
The functions below are helper functions that simplify usage of a UEditorTransformGizmoContextObject that is registered as a ContextStoreObject in an InteractiveToolsContext If one does not already exist, create a new instance of UEditorTransformGizmoContextObject and add it to the ToolsContext's ContextObjectStore | EditorGizmos/EditorTransformGizmoUtil.h | |
void UE::EditorTransformGizmoUtil::RemoveDefaultTransformGizmo
(
UInteractiveToolManager* InToolManager |
Removes the existing default Transform Gizmo if any. | EditorGizmos/EditorTransformGizmoUtil.h | |
bool UE::EditorTransformGizmoUtil::UnregisterTransformGizmoContextObject
(
FEditorModeTools* InModeTools |
Remove any existing UEditorTransformGizmoContextObject from the ToolsContext's ContextObjectStore | EditorGizmos/EditorTransformGizmoUtil.h |