1. Epic GamesDeveloper
  3. UEditorInteractiveToolsContext

UEditorInteractiveToolsContext

[UEditorInteractiveToolsContext](API\Editor\UnrealEd\UEditorInteractiveToolsContext) is an extension/adapter of an InteractiveToolsContext designed for use in the UE Editor.

API > API/Editor > API/Editor/UnrealEd

UEditorInteractiveToolsContext is an extension/adapter of an InteractiveToolsContext designed for use in the UE Editor. Currently this implementation assumes that it is created by a Mode Manager (FEditorModeTools), and that the Mode Manager will call various API functions like Render() and Tick() when necessary.

allows it to be easily embedded inside an FEdMode. A set of functions are provided which can be called from the FEdMode functions of the same name. These will handle the data type conversions and forwarding calls necessary to operate the ToolsContext

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

Syntax

UCLASS (MinimalAPI, Transient)  
class UEditorInteractiveToolsContext : public UInteractiveToolsContext

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UEditorInteractiveToolsContext()

   Tools/EdModeInteractiveToolsContext.h  

Typedefs

Name Type Remarks Include Path
FOnDrawHUD TMulticastDelegate_TwoParams< void, FCanvas *Canvas, IToolsContextRenderAPI *RenderAPI >   Tools/EdModeInteractiveToolsContext.h
FOnRender TMulticastDelegate_OneParam< void, IToolsContextRenderAPI *RenderAPI > These delegates can be used to hook into the Render() / DrawHUD() / Tick() calls above. Tools/EdModeInteractiveToolsContext.h
FOnTick TMulticastDelegate_OneParam< void, float DeltaTime >   Tools/EdModeInteractiveToolsContext.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnDrawHUD FOnDrawHUD   Tools/EdModeInteractiveToolsContext.h  
OnRender FOnRender   Tools/EdModeInteractiveToolsContext.h  
OnTick FOnTick   Tools/EdModeInteractiveToolsContext.h  
StandardVertexColorMaterial TObjectPtr< UMaterialInterface >   Tools/EdModeInteractiveToolsContext.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bDeactivateOnPIEStart bool   Tools/EdModeInteractiveToolsContext.h  
bDeactivateOnSaveWorld bool   Tools/EdModeInteractiveToolsContext.h  
bEnableAbsoluteWorldSnapping bool   Tools/EdModeInteractiveToolsContext.h  
bEnableRenderingDuringHitProxyPass bool Currently defaulting to enabled as FEdModes generally assume this, and in most cases hitproxy pass is not expensive. Tools/EdModeInteractiveToolsContext.h  
bForceCombinedGizmoMode bool   Tools/EdModeInteractiveToolsContext.h  
bIsActive bool   Tools/EdModeInteractiveToolsContext.h  
EditorModeManager FEditorModeTools *   Tools/EdModeInteractiveToolsContext.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Activate()

   Tools/EdModeInteractiveToolsContext.h  

virtual bool ActiveToolHasAccept()

   Tools/EdModeInteractiveToolsContext.h  

virtual bool CanAcceptActiveTool()

   Tools/EdModeInteractiveToolsContext.h  

virtual bool CanCancelActiveTool()

   Tools/EdModeInteractiveToolsContext.h  

virtual bool CanCompleteActiveTool()

   Tools/EdModeInteractiveToolsContext.h  

virtual bool CanStartTool ( const FString ToolTypeIdentifier
) const

 Utility functions useful for hooking up to UICommand/etc Tools/EdModeInteractiveToolsContext.h  

void Deactivate()

   Tools/EdModeInteractiveToolsContext.h  

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

   Tools/EdModeInteractiveToolsContext.h  

virtual void EndTool ( EToolShutdownType ShutdownType
)

   Tools/EdModeInteractiveToolsContext.h  

bool GetAbsoluteWorldSnappingEnabled()

   Tools/EdModeInteractiveToolsContext.h  

virtual FString GetActiveToolName()

   Tools/EdModeInteractiveToolsContext.h  

bool GetDeactivateToolsOnPIEStart()

   Tools/EdModeInteractiveToolsContext.h  

bool GetDeactivateToolsOnSaveWorld()

   Tools/EdModeInteractiveToolsContext.h  

bool GetEnableRenderingDuringHitProxyPass()

   Tools/EdModeInteractiveToolsContext.h  

bool GetForceCombinedGizmoModeEnabled()

   Tools/EdModeInteractiveToolsContext.h  

virtual FRay GetLastWorldRay()

   Tools/EdModeInteractiveToolsContext.h  

FEditorModeTools * GetParentEditorModeManager()

   Tools/EdModeInteractiveToolsContext.h  

IToolsContextQueriesAPI * GetQueriesAPI()

   Tools/EdModeInteractiveToolsContext.h  

IToolsContextTransactionsAPI * GetTransactionAPI()

   Tools/EdModeInteractiveToolsContext.h  

virtual UWorld * GetWorld()

   Tools/EdModeInteractiveToolsContext.h  

virtual bool HasActiveTool()

   Tools/EdModeInteractiveToolsContext.h  

void InitializeContextWithEditorModeManager ( FEditorModeTools* InEditorModeManager,
UInputRouter* UseInputRouter
)

 Initialize a new ToolsContext for an EdMode owned by the given InEditorModeManager Tools/EdModeInteractiveToolsContext.h  

virtual void PostInvalidation()

 Call this to notify the Editor that the viewports this ToolsContext is related to may need a repaint, ie during interactive tool usage Tools/EdModeInteractiveToolsContext.h  

virtual bool ProcessEditDelete()

   Tools/EdModeInteractiveToolsContext.h  

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

   Tools/EdModeInteractiveToolsContext.h  

void SetAbsoluteWorldSnappingEnabled ( bool bEnabled
)

 Configure whether Transform Gizmos created by the ITF (eg CombinedTransformGizmo) should, when in World coordinate system, snap to an Absolute world-aligned grid, or snap Relative to the initial position of any particular gizmo transform. Tools/EdModeInteractiveToolsContext.h  

void SetDeactivateToolsOnPIEStart ( bool bDeactivateTools
)

 Configure whether tools should shutdown when entering PIE. Tools/EdModeInteractiveToolsContext.h  

void SetDeactivateToolsOnSaveWorld ( bool bDeactivateTools
)

 Configure whether tools should shutdown when the world is saving. Tools/EdModeInteractiveToolsContext.h  

void SetEnableRenderingDuringHitProxyPass ( bool bEnabled
)

 Configuration functions Configure whether Render() should early-out for HitProxy rendering passes. Tools/EdModeInteractiveToolsContext.h  

void SetForceCombinedGizmoMode ( bool bEnabled
)

 Configure whether Transform Gizmos created by the ITF (eg CombinedTransformGizmo) should prefer to show in 'Combined' mode. Tools/EdModeInteractiveToolsContext.h  

virtual void ShutdownContext()

 Shutdown ToolsContext and clean up any connections/etc Tools/EdModeInteractiveToolsContext.h  

virtual void StartTool ( const FString ToolTypeIdentifier
)

   Tools/EdModeInteractiveToolsContext.h  

virtual void TerminateActiveToolsOnLevelChange()

 Default behavior is to cancel active tool Tools/EdModeInteractiveToolsContext.h  

virtual void TerminateActiveToolsOnPIEStart()

 Default behavior is to accept active tool Tools/EdModeInteractiveToolsContext.h  

virtual void TerminateActiveToolsOnSaveWorld()

 Default behavior is to accept active tool Tools/EdModeInteractiveToolsContext.h  

virtual void TerminateActiveToolsOnWorldTearDown()

 Default behavior is to cancel active tool Tools/EdModeInteractiveToolsContext.h  

virtual void Tick ( FEditorViewportClient* ViewportClient,
float DeltaTime
)

 Call functions of the same name on the ToolManager and GizmoManager Tools/EdModeInteractiveToolsContext.h  

Protected

Name Remarks Include Path Unreal Specifiers

void OnToolEnded ( UInteractiveToolManager* InToolManager,
UInteractiveTool* InEndedTool
)

   Tools/EdModeInteractiveToolsContext.h  

void OnToolPostBuild ( UInteractiveToolManager* InToolManager,
EToolSide InSide,
UInteractiveTool* InBuiltTool,
UInteractiveToolBuilder* InToolBuilder,
const FToolBuilderState& ToolState
)

   Tools/EdModeInteractiveToolsContext.h  

void RestoreEditorState()

   Tools/EdModeInteractiveToolsContext.h  

void SetEditorStateForTool()

 Editor UI state that we set before starting tool and when exiting tool Currently disabling anti-aliasing during active Tools because it causes PDI flickering Tools/EdModeInteractiveToolsContext.h  

Overridden from UInteractiveToolsContext

Name Remarks Include Path Unreal Specifiers

virtual void DeactivateActiveTool ( EToolSide WhichSide,
EToolShutdownType ShutdownType
)

   Tools/EdModeInteractiveToolsContext.h  

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  

Static

Name Remarks Include Path Unreal Specifiers

static FRay GetRayFromMousePos ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
int MouseX,
int MouseY
)

 Utility function to convert viewport x/y from mouse events (and others?) into scene ray. Tools/EdModeInteractiveToolsContext.h  

static FRay GetRayFromMousePos ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
int MouseX,
int MouseY,
const bool bInClampMouseToBounds
)

 Utility function to convert viewport x/y from mouse events (and others?) into scene ray. 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