UInteractiveToolsContext

InteractiveToolsContext owns the core parts of an Interactive Tools Framework implementation - the InputRouter, ToolManager, GizmoManager, TargetManager, ToolGroupManager, and ContextStore.

API > API/Runtime > API/Runtime/InteractiveToolsFramework

InteractiveToolsContext owns the core parts of an Interactive Tools Framework implementation - the InputRouter, ToolManager, GizmoManager, TargetManager, ToolGroupManager, and ContextStore. In the simplest use case, UInteractiveToolsContext is just a top-level container that will keep the various UObjects alive, and provide an easy way to access them. However in a more complex situation it may be desirable to subclass and extend the ToolsContext. For example, UEdModeInteractiveToolsContext allows a ToolsContext to live within a UEdMode.

   
Name UInteractiveToolsContext
Type class
Header File /Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveToolsContext.h
Include Path #include "InteractiveToolsContext.h"

Syntax

UCLASS (Transient, MinimalAPI)  
class UInteractiveToolsContext : public UObject

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UInteractiveToolsContext()

   InteractiveToolsContext.h  

Structs

Name Remarks
FContextInitInfo FContextInitInfo is used by Initialize() to pass information to the various creator functions below.

Typedefs

Name Type Remarks Include Path
FToolsContextToolNotification TMulticastDelegate_OneParam< void, const FText & >   InteractiveToolsContext.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ContextObjectStore TObjectPtr< UContextObjectStore > Current Context Object Store for this Context. InteractiveToolsContext.h  
GizmoManager TObjectPtr< UInteractiveGizmoManager > Current UInteractiveGizmoManager for this Context InteractiveToolsContext.h  
InputRouter TObjectPtr< UInputRouter > Current UInputRouter for this Context InteractiveToolsContext.h  
OnToolNotificationMessage FToolsContextToolNotification   InteractiveToolsContext.h  
OnToolWarningMessage FToolsContextToolNotification   InteractiveToolsContext.h  
TargetManager TObjectPtr< UToolTargetManager > Current UToolTargetManager for this Context InteractiveToolsContext.h  
ToolGroupManager TObjectPtr< UToolGroupManager > Current UToolGroupManager for this Context InteractiveToolsContext.h  
ToolManager TObjectPtr< UInteractiveToolManager > Current UInteractiveToolManager for this Context InteractiveToolsContext.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ActiveToolHasAccept ( EToolSide WhichSide
) const

   InteractiveToolsContext.h  

bool CanAcceptActiveTool ( EToolSide WhichSide
) const

   InteractiveToolsContext.h  

bool CanCancelActiveTool ( EToolSide WhichSide
) const

   InteractiveToolsContext.h  

bool CanCompleteActiveTool ( EToolSide WhichSide
) const

   InteractiveToolsContext.h  

bool CanStartTool ( EToolSide WhichSide,
const FString& ToolTypeIdentifier
) const

   InteractiveToolsContext.h  

void EndTool ( EToolSide WhichSide,
EToolShutdownType ShutdownType
)

   InteractiveToolsContext.h  

FString GetActiveToolName ( EToolSide WhichSide
) const

   InteractiveToolsContext.h  

bool HasActiveTool ( EToolSide WhichSide
) const

   InteractiveToolsContext.h  

bool IsToolActive ( EToolSide WhichSide,
const FString ToolIdentifier
) const

   InteractiveToolsContext.h  

bool StartTool ( EToolSide WhichSide,
const FString& ToolTypeIdentifier
)

   InteractiveToolsContext.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void DeactivateActiveTool ( EToolSide WhichSide,
EToolShutdownType ShutdownType
)

   InteractiveToolsContext.h  

virtual void DeactivateAllActiveTools ( EToolShutdownType ShutdownType
)

   InteractiveToolsContext.h  

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

 Initialize the Context. InteractiveToolsContext.h  

virtual void PostToolNotificationMessage ( const FText& Message
)

 Forwards message to OnToolNotificationMessage delegate InteractiveToolsContext.h  

virtual void PostToolWarningMessage ( const FText& Message
)

   InteractiveToolsContext.h  

virtual void SetCreateContextStoreFunc ( TUniqueFunction< UContextObjectStore*(const FContextInitInfo&)> Func
)

   InteractiveToolsContext.h  

virtual void SetCreateGizmoManagerFunc ( TUniqueFunction< UInteractiveGizmoManager*(const FContextInitInfo&)> Func
)

   InteractiveToolsContext.h  
Replace the internal functions that are called to create/destroy the sub-objects owned by the ITC. InteractiveToolsContext.h  

virtual void SetCreateToolGroupManagerFunc ( TUniqueFunction< UToolGroupManager*(const FContextInitInfo&)> Func
)

   InteractiveToolsContext.h  

virtual void SetCreateToolManagerFunc ( TUniqueFunction< UInteractiveToolManager*(const FContextInitInfo&)> Func
)

   InteractiveToolsContext.h  

virtual void SetCreateToolTargetManagerFunc ( TUniqueFunction< UToolTargetManager*(const FContextInitInfo&)> Func
)

   InteractiveToolsContext.h  

virtual void SetShutdownContextStoreFunc ( TUniqueFunction< void(UContextObjectStore*)> Func
)

   InteractiveToolsContext.h  

virtual void SetShutdownGizmoManagerFunc ( TUniqueFunction< void(UInteractiveGizmoManager*)> Func
)

   InteractiveToolsContext.h  

virtual void SetShutdownInputRouterFunc ( TUniqueFunction< void(UInputRouter*)> Func
)

   InteractiveToolsContext.h  

virtual void SetShutdownToolGroupManagerFunc ( TUniqueFunction< void(UToolGroupManager*)> Func
)

   InteractiveToolsContext.h  

virtual void SetShutdownToolManagerFunc ( TUniqueFunction< void(UInteractiveToolManager*)> Func
)

   InteractiveToolsContext.h  

virtual void SetShutdownToolTargetManagerFunc ( TUniqueFunction< void(UToolTargetManager*)> Func
)

   InteractiveToolsContext.h  

virtual void Shutdown()

 Shutdown Context by destroying InputRouter and ToolManager InteractiveToolsContext.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page