Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > EditorInteractiveToolsFramework > UEdModeInteractiveToolsContext

Light Theme

Dark Theme

UEdModeInteractiveToolsContext

EdModeInteractiveToolsContext is an extension/adapter of an InteractiveToolsContext which allows it to be easily embedded inside an [FEdMode](API\Editor\UnrealEd\FEdMode).

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveToolsContext

UEdModeInteractiveToolsContext

References

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

Syntax

class UEdModeInteractiveToolsContext : public UInteractiveToolsContext

Remarks

EdModeInteractiveToolsContext is an extension/adapter of an InteractiveToolsContext which 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

Variables

	Name	Description
IToolsContextAs...	AssetAPI
FDelegateHandle	BeginPIEDelegateHandle	Called when PIE is about to start, shuts down active tools
bool	bHaveSavedEditorState	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
bool	bInFlyMode	This will be set to true if user is in right-mouse "fly mode", which requires special handling to intercept hotkeys/etc
bool	bInvalidationPending	If true, we invalidate the ViewportClient on next tick
FInputDeviceSta...	CurrentMouseState	Input event instance used to keep track of various button states, etc, that we cannot directly query on-demand
FEdMode *	EditorMode
TArray< TUnique...	NextTickExecuteActions	Any actions in this array are executed at the start of the next Tick()
FDelegateHandle	PreSaveWorldDelegateHandle	Called before a Save starts. This currently shuts down active tools.
IToolsContextQu...	QueriesAPI	EdMode implementation of InteractiveToolFramework APIs - see ToolContextInterfaces.h.
UMaterialInterf...	StandardVertexColorMaterial
IToolsContextTr...	TransactionAPI
FDelegateHandle	ViewportClientListChangedHandle	Called when viewport clients change
FDelegateHandle	WorldTearDownDelegateHandle	Called when a map is changed

Constructors

	Name	Description
	UEdModeInteractiveToolsContext()

Functions

	Name	Description
bool	ActiveToolHasAccept()
bool	CanAcceptActiveTool()
bool	CanCancelActiveTool()
bool	CanCompleteActiveTool()
bool	CanStartTool ( const FString& ToolTypeIdentifier )	Utility functions useful for hooking up to UICommand/etc
bool	CapturedMouseMove ( FEditorViewportClient* InViewp..., FViewport* InViewport, int32 InMouseX, int32 InMouseY )
void	EndTool ( EToolShutdownType ShutdownType )
bool	EndTracking ( FEditorViewportClient* InViewp..., FViewport* InViewport )
IToolsContex...	GetAssetAPI()
FRay	GetLastWorldRay()
IToolsContex...	GetQueriesAPI()
FRay	GetRayFromMousePos ( FEditorViewportClient* Viewpor..., FViewport* Viewport, int MouseX, int MouseY )	Utility function to convert viewport x/y from mouse events (and others?) into scene ray.
IToolsContex...	GetTransactionAPI()
void	InitializeContextFromEdMode ( FEdMode* EditorMode, IToolsContextAssetAPI* UseAsse... )
bool	InputKey ( FEditorViewportClient* Viewpor..., FViewport* Viewport, FKey Key, EInputEvent Event )
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 )
void	PostInvalidation()
bool	ProcessEditDelete()
void	Render ( const FSceneView* View, FViewport* Viewport, FPrimitiveDrawInterface* PDI )
void	RestoreEditorState()
void	SaveEditorStateAndSetForTool()
void	ScheduleExecuteAction ( TUniqueFunction< void()> Action )	Push the input action onto the NextTickExecuteActions list.
bool	ShouldIgnoreHotkeys()
void	ShutdownContext()
void	StartTool ( const FString& ToolTypeIdentifier )
bool	StartTracking ( FEditorViewportClient* InViewp..., FViewport* InViewport )
void	TerminateActiveToolsOnPIEStart()	Default behavior is to accept active tool
void	TerminateActiveToolsOnSaveWorld()	Default behavior is to accept active tool
void	TerminateActiveToolsOnWorldTearDown()	Default behavior is to accept active tool
void	Tick ( FEditorViewportClient* Viewpor..., float DeltaTime )

Overridden from UInteractiveToolsContext

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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss