UModeManagerInteractiveToolsContext

[UModeManagerInteractiveToolsContext](API\Editor\EditorInteractiveToolsFramework\UModeManagerInteractiveToolsCont-) extends [UEditorInteractiveToolsContext](API\Editor\EditorInteractiveToolsFramework\UEditorInteractiveToolsContext) with various functions for handling device (mouse) input.

Unreal Engine C++ API Reference > Editor > EditorInteractiveToolsFramework

Inheritance Hierarchy

References

   
Module EditorInteractiveToolsFramework
Header /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/EdModeInteractiveToolsContext.h
Include #include "EdModeInteractiveToolsContext.h"

Syntax

class UModeManagerInteractiveToolsContext : public [UEditorInteractiveToolsContext](API\Editor\EditorInteractiveToolsFramework\UEditorInteractiveToolsContext)  

Remarks

UModeManagerInteractiveToolsContext extends UEditorInteractiveToolsContext with various functions for handling device (mouse) input. These functions are currently called by the EdMode Manager (FEditorModeTools).

Variables

Type Name Description
FDelegateHandle BeginPIEDelegateHandle Called when PIE is about to start, shuts down active tools
FInputDeviceSta... CurrentMouseState Input event instance used to keep track of various button states, etc, that we cannot directly query on-demand
TArray< TObject... EdModeToolsContexts  
FDelegateHandle PreSaveWorldDelegateHandle Called before a Save starts. This currently shuts down active tools.
FDelegateHandle ViewportClientListChangedHandle Called when viewport clients change
FDelegateHandle WorldTearDownDelegateHandle Called when a map is changed

Functions

Type Name Description
bool CapturedMouseMove ( FEditorViewportClient* InViewp..., FViewport* InViewport, int32 InMouseX, int32 InMouseY )  
UEdModeInter... CreateNewChildEdModeToolsContext () Create and initialize a new EdMode-level ToolsContext derived from the ModeManager ToolsContext.
bool EndTracking ( FEditorViewportClient* InViewp..., FViewport* InViewport )  
bool InputKey ( FEditorViewportClient* Viewpor..., FViewport* Viewport, FKey Key, EInputEvent Event ) Input handling, these functions forward ViewportClient events to the UInputRouter
bool MouseEnter ( FEditorViewportClient* Viewpor..., FViewport* Viewport, int32 x, int32 y )  
bool MouseLeave ( FEditorViewportClient* Viewpor..., FViewport* Viewport )  
bool MouseMove ( FEditorViewportClient* Viewpor..., FViewport* Viewport, int32 x, int32 y )  
bool OnChildEdModeActivated ( UEdModeInteractiveToolsContext*... ) Call to add a child EdMode ToolsContext created using the above function
bool OnChildEdModeDeactivated ( UEdModeInteractiveToolsContext*... ) Call to release a child EdMode ToolsContext created using the above function
bool StartTracking ( FEditorViewportClient* InViewp..., FViewport* InViewport )  

Overridden from UEditorInteractiveToolsContext

Type Name Description
void DrawHUD ( FViewportClient* ViewportClien..., FViewport* Viewport, const FSceneView* View, FCanvas* Canvas )  
FRay GetLastWorldRay ()  
bool ProcessEditDelete ()  
void Render ( const FSceneView* View, FViewport* Viewport, FPrimitiveDrawInterface* PDI )  
void Tick ( FEditorViewportClient* Viewpor..., float DeltaTime ) UEditorInteractiveToolsContext API implementations that also forward calls to any child EdMode ToolsContexts

Overridden from UInteractiveToolsContext

Type Name Description
void DeactivateAllActiveTools ( EToolShutdownType ShutdownType )  
void Initialize ( IToolsContextQueriesAPI* Queri..., IToolsContextTransactionsAPI* ... ) We hide these
void Shutdown () Shutdown Context by destroying InputRouter and ToolManager

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library