1. Epic GamesDeveloper
  3. UModeManagerInteractiveToolsContext

UModeManagerInteractiveToolsContext

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

API > API/Editor > API/Editor/EditorInteractiveToolsFramework

Inheritance Hierarchy

References

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

Syntax

UCLASS (Transient)  
class UModeManagerInteractiveToolsContext : public 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
Protected variable FDelegateHandle BeginPIEDelegateHandle Called when PIE is about to start, shuts down active tools
Protected variable FInputDeviceState CurrentMouseState Input event instance used to keep track of various button states, etc, that we cannot directly query on-demand
Protected variable UProperty TArray< TObjectPtr< UEdModeInteractiveToolsContext > > EdModeToolsContexts  
Protected variable FDelegateHandle PreSaveWorldDelegateHandle Called before a Save starts. This currently shuts down active tools.
Protected variable FDelegateHandle ViewportClientListChangedHandle Called when viewport clients change
Protected variable FDelegateHandle WorldTearDownDelegateHandle Called when a map is changed

Functions

  Type Name Description
Public function bool

CapturedMouseMove ( FEditorViewportClient* InViewportClient,
FViewport* InViewport,
int32 InMouseX,
int32 InMouseY
)

  
Public function UEdModeInteractiveToolsContext * Create and initialize a new EdMode-level ToolsContext derived from the ModeManager ToolsContext.
Public function bool

EndTracking ( FEditorViewportClient* InViewportClient,
FViewport* InViewport
)

  
Public function Const bool

GetCursor ( EMouseCursor::Type& OutCursor
)

  
Public function bool

InputKey ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
FKey Key,
EInputEvent Event
)

 Input handling, these functions forward ViewportClient events to the UInputRouter
Public function bool

MouseEnter ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
int32 x,
int32 y
)

  
Public function bool

MouseLeave ( FEditorViewportClient* ViewportClient,
FViewport* Viewport
)

  
Public function bool

MouseMove ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
int32 x,
int32 y
)

  
Public function bool Call to add a child EdMode ToolsContext created using the above function
Public function bool Call to release a child EdMode ToolsContext created using the above function
Public function bool

StartTracking ( FEditorViewportClient* InViewportClient,
FViewport* InViewport
)

  
Public function void

UpdateStateWithoutRoutingInputKey ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
FKey Key,
EInputEvent Event
)

 This updates internal state like InputKey, but doesn't route the results to the input router.

Overridden from UEditorInteractiveToolsContext

  Type Name Description
Protected function Virtual void

DeactivateAllActiveTools ( EToolShutdownType ShutdownType
)

  
Public function Virtual void

DrawHUD ( FViewportClient* ViewportClient,
FViewport* Viewport,
const FSceneView* View,
FCanvas* Canvas
)

  
Public function Virtual Const FRay  
Protected function Virtual void

Initialize ( IToolsContextQueriesAPI* QueriesAPI,
IToolsContextTransactionsAPI* TransactionsAPI
)

 We hide these
Public function Virtual bool  
Public function Virtual void

Render ( const FSceneView* View,
FViewport* Viewport,
FPrimitiveDrawInterface* PDI
)

  
Protected function Virtual void  
Public function Virtual void

Tick ( FEditorViewportClient* ViewportClient,
float DeltaTime
)

 UEditorInteractiveToolsContext API implementations that also forward calls to any child EdMode ToolsContexts

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page