Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UModeManagerInteractiveToolsContext

UModeManagerInteractiveToolsContext

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

API > API/Editor > API/Editor/UnrealEd

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

   
Name UModeManagerInteractiveToolsContext
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/Tools/EdModeInteractiveToolsContext.h
Include Path #include "Tools/EdModeInteractiveToolsContext.h"

Syntax

UCLASS (MinimalAPI, Transient)  
class UModeManagerInteractiveToolsContext : public UEditorInteractiveToolsContext

Inheritance Hierarchy

Derived Classes

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsTrackingMouse bool   Tools/EdModeInteractiveToolsContext.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   Tools/EdModeInteractiveToolsContext.h  
Create and initialize a new EdMode-level ToolsContext derived from the ModeManager ToolsContext. Tools/EdModeInteractiveToolsContext.h  

bool EndTracking ( FEditorViewportClient* InViewportClient,
FViewport* InViewport
)

   Tools/EdModeInteractiveToolsContext.h  

bool GetCursor ( EMouseCursor::Type& OutCursor
) const

   Tools/EdModeInteractiveToolsContext.h  

TSharedPtr< SWidget > GetCursorWidget()

   Tools/EdModeInteractiveToolsContext.h  

FEditorViewportClient * GetFocusedViewportClient()

   Tools/EdModeInteractiveToolsContext.h  

FEditorViewportClient * GetHoveredViewportClient()

   Tools/EdModeInteractiveToolsContext.h  

UViewportInteractionsBehaviorSource * GetViewportInteractionsBehaviorSource()

 Return the current Input Tools Behavior Source - nullptr if not enabled Tools/EdModeInteractiveToolsContext.h  

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

 Input handling, these functions forward ViewportClient events to the UInputRouter Tools/EdModeInteractiveToolsContext.h  

bool LostFocus ( FEditorViewportClient* InViewportClient,
FViewport* Viewport
) const

   Tools/EdModeInteractiveToolsContext.h  

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

   Tools/EdModeInteractiveToolsContext.h  

bool MouseLeave ( FEditorViewportClient* ViewportClient,
FViewport* Viewport
)

   Tools/EdModeInteractiveToolsContext.h  

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

   Tools/EdModeInteractiveToolsContext.h  

bool OnChildEdModeActivated ( UEdModeInteractiveToolsContext* ChildToolsContext
)

 Call to add a child EdMode ToolsContext created using the above function Tools/EdModeInteractiveToolsContext.h  

bool OnChildEdModeDeactivated ( UEdModeInteractiveToolsContext* ChildToolsContext
)

 Call to release a child EdMode ToolsContext created using the above function Tools/EdModeInteractiveToolsContext.h  

void SetDragToolsEnabled ( bool bInEnabled
)

 Mark Editor Modes Tools for Drag Tools Support Tools/EdModeInteractiveToolsContext.h  

void SetInputToolsEnabled ( bool bInEnabled
)

 Enable ITF Input tools support (e.g. Viewport Interactions as camera movement and selection) Tools/EdModeInteractiveToolsContext.h  

bool StartTracking ( FEditorViewportClient* InViewportClient,
FViewport* InViewport
)

   Tools/EdModeInteractiveToolsContext.h  

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. Tools/EdModeInteractiveToolsContext.h  

bool UsesDragTools()

 Are Drag Tools supported? e.g. Marquee Select Enable/Disable support by using SetDragToolsEnabled(...) Tools/EdModeInteractiveToolsContext.h  

bool UsesViewportInteractions()

 Are Viewport Interactions supported? e.g. camera movements, commands, clicking, etc Tools/EdModeInteractiveToolsContext.h  

Overridden from UEditorInteractiveToolsContext

Name Remarks Include Path Unreal Specifiers

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

   Tools/EdModeInteractiveToolsContext.h  

virtual FRay GetLastWorldRay()

   Tools/EdModeInteractiveToolsContext.h  

virtual bool ProcessEditDelete()

   Tools/EdModeInteractiveToolsContext.h  

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

   Tools/EdModeInteractiveToolsContext.h  

virtual void Tick ( FEditorViewportClient* ViewportClient,
float DeltaTime
)

 UEditorInteractiveToolsContext API implementations that also forward calls to any child EdMode ToolsContexts Tools/EdModeInteractiveToolsContext.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool BypassAltModifier()

 Is this Interactive Tools Context skipping Alt processing? Tools/EdModeInteractiveToolsContext.h  

void OnEditorModeChanged ( const FEditorModeID& InModeID,
bool bInIsEnteringMode
)

 Responding to Mode Changes in order to deactivate/activate Drag Tools accordingly Tools/EdModeInteractiveToolsContext.h  

void RegisterDragTools()

 Activating Drag Tools if current Mode Manager requires them Tools/EdModeInteractiveToolsContext.h  

void RegisterViewportInteractions()

 Activating Viewport Interactions if current Mode Manager requires them Tools/EdModeInteractiveToolsContext.h  

void SetBypassAltModifier ( bool bInBypassAltModifier
)

 These functions are declared protected to avoid having to deal with deprecation later on. Tools/EdModeInteractiveToolsContext.h  

void UnregisterDragTools()

 Deactivating Drag Tools Tools/EdModeInteractiveToolsContext.h  

void UnregisterViewportInteractions()

 Deactivating Viewport Interactions Tools/EdModeInteractiveToolsContext.h  

Overridden from UInteractiveToolsContext

Name Remarks Include Path Unreal Specifiers

virtual void DeactivateAllActiveTools ( EToolShutdownType ShutdownType
)

   Tools/EdModeInteractiveToolsContext.h  

virtual void Initialize ( IToolsContextQueriesAPI* QueriesAPI,
IToolsContextTransactionsAPI* TransactionsAPI
)

 We hide these Tools/EdModeInteractiveToolsContext.h  

virtual void Shutdown()

   Tools/EdModeInteractiveToolsContext.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page