1. Epic GamesDeveloper
  3. UEditorInteractiveToolsContext

UEditorInteractiveToolsContext

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

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 UEditorInteractiveToolsContext : public UInteractiveToolsContext

Remarks

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

Variables

  Type Name Description
Protected variable UGizmoViewContext * GizmoViewContext An object in which we save the current scene view information that gizmos can use on the game thread to figure out how big the gizmo is for hit testing.
Protected variable TMap< FViewportClient *, int32 > InvalidationMap Tools need to be able to Invalidate the view, in case it is not Realtime.
Protected variable int32 InvalidationTimestamp Current invalidation timestamp, incremented by invalidation calls
Public variable FOnDrawHUD OnDrawHUD  
Public variable FOnRender OnRender  
Public variable FOnTick OnTick  
Protected variable TOptional< EToolShutdownType > PendingToolShutdownType  
Protected variable TOptional< FString > PendingToolToStart  
Protected variable IToolsContextQueriesAPI * QueriesAPI EdMode implementation of InteractiveToolFramework APIs - see ToolContextInterfaces.h.
Public variable UProperty TObjectPtr< UMaterialInterface > StandardVertexColorMaterial  
Protected variable IToolsContextTransactionsAPI * TransactionAPI  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool

CanStartTool ( const FString ToolTypeIdentifier
)

 Utility functions useful for hooking up to UICommand/etc
Public function void  
Protected function Virtual void

DeactivateActiveTool ( EToolSide WhichSide,
EToolShutdownType ShutdownType
)

  
Protected function Virtual void

DeactivateAllActiveTools ( EToolShutdownType ShutdownType
)

  
Public function Virtual void

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

  
Public function Virtual void

EndTool ( EToolShutdownType ShutdownType
)

  
Public function Const bool  
Public function Virtual Const FString  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual Const FRay  
Public function Const FEditorModeTools *  
Public function Const IToolsContextQueriesAPI *  
Protected function 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.
Public function Const IToolsContextTransactionsAPI *  
Public function Virtual Const UWorld *  
Public function Virtual Const bool  
Protected function Virtual void

Initialize ( IToolsContextQueriesAPI* QueriesAPI,
IToolsContextTransactionsAPI* TransactionsAPI
)

 We hide these
Public function void

InitializeContextWithEditorModeManager ( FEditorModeTools* InEditorModeManager,
UInputRouter* UseInputRouter
)

 Initialize a new ToolsContext for an EdMode owned by the given InEditorModeManager
Protected function void

OnToolEnded ( UInteractiveToolManager* InToolManager,
UInteractiveTool* InEndedTool
)

  
Protected function void

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

  
Public function Virtual void Call this to notify the Editor that the viewports this ToolsContext is related to may need a repaint, ie during interactive tool usage
Public function Virtual bool  
Public function Virtual void

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

  
Protected function void  
Public function void 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.
Public function void

SetDeactivateToolsOnPIEStart ( bool bDeactivateTools
)

 Configure whether tools should shutdown when entering PIE.
Protected function void 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
Public function void Configuration functions Configure whether Render() should early-out for HitProxy rendering passes.
Public function void

SetForceCombinedGizmoMode ( bool bEnabled
)

 Configure whether Transform Gizmos created by the ITF (eg CombinedTransformGizmo) should prefer to show in 'Combined' mode.
Protected function Virtual void  
Public function Virtual void Shutdown ToolsContext and clean up any connections/etc
Public function Virtual void

StartTool ( const FString ToolTypeIdentifier
)

  
Public function Virtual void Default behavior is to cancel active tool
Public function Virtual void Default behavior is to accept active tool
Public function Virtual void Default behavior is to accept active tool
Public function Virtual void Default behavior is to cancel active tool
Public function Virtual void

Tick ( FEditorViewportClient* ViewportClient,
float DeltaTime
)

 Call functions of the same name on the ToolManager and GizmoManager

Typedefs

Name Description
FOnDrawHUD  
FOnRender These delegates can be used to hook into the Render() / DrawHUD() / Tick() calls above.
FOnTick  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page