UInteractiveToolsContext

InteractiveToolsContext owns a ToolManager and an InputRouter.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/Experimental/InteractiveToolsFramework/Public/InteractiveToolsContext.h

Include

#include "InteractiveToolsContext.h"

Syntax

class UInteractiveToolsContext : public UObject

Remarks

InteractiveToolsContext owns a ToolManager and an InputRouter. This is just a top-level UObject container, however implementations like UEdModeInteractiveToolsContext extend this class to make it easier to connect external systems (like an FEdMode) to the ToolsFramework.

Variables

Constructors

Name Description

Public function

UInteractiveToolsContext()

Functions

Name Description

Public function Const

bool

 

ActiveToolHasAccept

(
    EToolSide WhichSide
)

Public function Const

bool

 

CanAcceptActiveTool

(
    EToolSide WhichSide
)

Public function Const

bool

 

CanCancelActiveTool

(
    EToolSide WhichSide
)

Public function Const

bool

 

CanCompleteActiveTool

(
    EToolSide WhichSide
)

Public function Const

bool

 

CanStartTool

(
    EToolSide WhichSide,
    const FString& ToolTypeIdentifier
)

Public function Virtual

void

 

DeactivateActiveTool

(
    EToolSide WhichSide,
    EToolShutdownType ShutdownType
)

Public function Virtual

void

 

DeactivateAllActiveTools()

Public function

void

 

EndTool

(
    EToolSide WhichSide,
    EToolShutdownType ShutdownType
)

Public function Virtual

void

 

Initialize

(
    IToolsContextQueriesAPI* Queri...,
    IToolsContextTransactionsAPI* ...
)

Initialize the Context. This creates the InputRouter and ToolManager

Public function

bool

 

IsToolBuilderActive

(
    EToolSide WhichSide,
    UInteractiveToolBuilder* Build...
)

Public function Virtual

void

 

PostToolNotificationMessage

(
    const FText& Message
)

Forwards message to OnToolNotificationMessage delegate

Public function Virtual

void

 

PostToolWarningMessage

(
    const FText& Message
)

Public function Virtual

void

 

Shutdown()

Shutdown Context by destroying InputRouter and ToolManager

Public function

bool

 

StartTool

(
    EToolSide WhichSide,
    const FString& ToolTypeIdentifier
)

Typedefs

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