1. Epic GamesDeveloper
  3. UInteractiveToolsContext

UInteractiveToolsContext

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

API > API/Runtime > API/Runtime/InteractiveToolsFramework

Inheritance Hierarchy

References

   
Module InteractiveToolsFramework
Header /Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveToolsContext.h
Include #include "InteractiveToolsContext.h"

Syntax

class UInteractiveToolsContext : public UObject

Remarks

InteractiveToolsContext owns the core parts of an Interactive Tools Framework implementation - the InputRouter, ToolManager, GizmoManager, TargetManager, 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.

Variables

  Type Name Description
Public variable TObjectPtr< UContextObjectStore > ContextObjectStore Current Context Object Store for this Context.
Protected variable TUniqueFunction< UContextObjectStore *(const FContextInitInfo &)> CreateContextStoreFunc  
Protected variable TUniqueFunction< UInteractiveGizmoManager *(const FContextInitInfo &)> CreateGizmoManagerFunc  
Protected variable TUniqueFunction< UInputRouter *(const FContextInitInfo &)> CreateInputRouterFunc Initialize() calls these functions to create the main child objects needed to operate the Tools Framework - InputRouter, ToolManager, GizmoManager, TargetManager, ContextStore.
Protected variable TUniqueFunction< UInteractiveToolManager *(const FContextInitInfo &)> CreateToolManagerFunc  
Protected variable TUniqueFunction< UToolTargetManager *(const FContextInitInfo &)> CreateToolTargetManagerFunc  
Public variable TObjectPtr< UInteractiveGizmoManager > GizmoManager Current UInteractiveGizmoManager for this Context
Public variable TObjectPtr< UInputRouter > InputRouter Current UInputRouter for this Context
Public variable FToolsContextToolNotification OnToolNotificationMessage  
Public variable FToolsContextToolNotification OnToolWarningMessage  
Protected variable TUniqueFunction< void(UContextObjectStore *)> ShutdownContextStoreFunc  
Protected variable TUniqueFunction< void(UInteractiveGizmoManager *)> ShutdownGizmoManagerFunc  
Protected variable TUniqueFunction< void(UInputRouter *)> ShutdownInputRouterFunc Analogous to the CreateX() functions above, these function are called by Shutdown() to terminate and clean up after the various elements.
Protected variable TUniqueFunction< void(UInteractiveToolManager *)> ShutdownToolManagerFunc  
Protected variable TUniqueFunction< void(UToolTargetManager *)> ShutdownToolTargetManagerFunc  
Public variable TObjectPtr< UToolTargetManager > TargetManager Current UToolTargetManager for this Context
Public variable TObjectPtr< UInteractiveToolManager > ToolManager Current UInteractiveToolManager for this Context
Protected variable TSoftClassPtr< UInteractiveToolManager > ToolManagerClass Todo: deprecate and remove this, can now be accomplished via CreateToolManagerFunc()

Constructors

  Type Name Description
Public function    

Functions

  Type 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 ( EToolShutdownType ShutdownType
)

  
Public function void

EndTool ( EToolSide WhichSide,
EToolShutdownType ShutdownType
)

  
Public function Const FString

GetActiveToolName ( EToolSide WhichSide
)

  
Public function Const bool

HasActiveTool ( EToolSide WhichSide
)

  
Public function Virtual void Initialize the Context.
Public function Const bool

IsToolActive ( EToolSide WhichSide,
const FString ToolIdentifier
)

  
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  
Public function Virtual void  
Public function Virtual void Replace the internal functions that are called to create/destroy the sub-objects owned by the ITC.
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void Shutdown Context by destroying InputRouter and ToolManager
Public function bool

StartTool ( EToolSide WhichSide,
const FString& ToolTypeIdentifier
)

  

Classes

  Type Name Description
Public struct FContextInitInfo FContextInitInfo is used by Initialize() to pass information to the various creator functions below.  

Typedefs

Name Description
FToolsContextToolNotification  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page