IInteractiveToolShutdownQueryAPI Class Reference

#include <InteractiveToolQueryInterfaces.h>

Public Member Functions
enum	UE_DEPRECATED (5.7, "EShutdownReason has moved to InteractiveTool.h (under the name EToolShutdownReason).") EShutdownReason
virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS EToolShutdownType	GetPreferredShutdownType (EShutdownReason ShutdownReason, EToolShutdownType StandardShutdownType) const PRAGMA_ENABLE_DEPRECATION_WARNINGS
virtual EToolShutdownType	GetPreferredShutdownType (EToolShutdownReason ShutdownReason, EToolShutdownType StandardShutdownType) const

Detailed Description

Allows an interactive tool to influence the way it is shut down, if the tool host supports that kind of customization. This can be helpful, for example, if your tool prefers a specific shutdown type in various situations, but a tool can't rely on this interface being queried unless it knows that it will only be used by systems that respect it. A simple interactive tools framework context implementation does not need to bother querying the tool on its preferences (aside from the already existing CanAccept method on the actual tool object).

Note that there are different systems that might choose to query this interface. The tool manager might want to query it if its ToolSwitchMode is set to be customizable, or the mode or mode toolkit might query it when shutting down the tool in various situations.

Member Function Documentation

GetPreferredShutdownType() [1/2]

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS EToolShutdownType IInteractiveToolShutdownQueryAPI::GetPreferredShutdownType ( EShutdownReason  ShutdownReason, EToolShutdownType  StandardShutdownType  ) const

inlinevirtual

Given a shutdown situation, tells what kind of shutdown method the tool might prefer.

Parameters

ShutdownReason	Information about the shutdown type
StandardShutdownType	Shutdown type that the host would use if it weren't giving the tool a chance to customize the behavior.

Returns

Shutdown type that the tool would prefer that the host use in this situation.

GetPreferredShutdownType() [2/2]

virtual EToolShutdownType IInteractiveToolShutdownQueryAPI::GetPreferredShutdownType ( EToolShutdownReason  ShutdownReason, EToolShutdownType  StandardShutdownType  ) const

inlinevirtual

Given a shutdown situation, tells what kind of shutdown method the tool might prefer.

Parameters

ShutdownReason	Information about the shutdown type
StandardShutdownType	Shutdown type that the host would use if it weren't giving the tool a chance to customize the behavior.

Returns

Shutdown type that the tool would prefer that the host use in this situation.

UE_DEPRECATED()

enum IInteractiveToolShutdownQueryAPI::UE_DEPRECATED ( 5.  7, "EShutdownReason has moved to InteractiveTool.h (under the name EToolShutdownReason)."    )

inlinestrong

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveToolQueryInterfaces.h