IInteractiveToolNestedAcceptCancelAPI Class Reference

#include <InteractiveToolQueryInterfaces.h>

Public Member Functions
virtual bool	SupportsNestedCancelCommand ()
virtual bool	CanCurrentlyNestedCancel ()
virtual bool	ExecuteNestedCancelCommand ()
virtual bool	SupportsNestedAcceptCommand ()
virtual bool	CanCurrentlyNestedAccept ()
virtual bool	ExecuteNestedAcceptCommand ()

Detailed Description

IInteractiveToolNestedAcceptCancelAPI provides an API for a Tool to publish intent and ability to Accept or Cancel sub-operations. For example in a Tool that has an editable active Selection, we might want the Escape hotkey to Clear any active selection, and then on a second press, to Cancel the Tool. This API allows a Tool to say "I can consume a Cancel action", and similarly for Accept (although this is much less common).

Member Function Documentation

CanCurrentlyNestedAccept()

virtual bool IInteractiveToolNestedAcceptCancelAPI::CanCurrentlyNestedAccept ( )

inlinevirtual

Returns

true if the implementor of this API can currently consume an Accept action

CanCurrentlyNestedCancel()

virtual bool IInteractiveToolNestedAcceptCancelAPI::CanCurrentlyNestedCancel ( )

inlinevirtual

Returns

true if the implementor of this API can currently consume a Cancel action

ExecuteNestedAcceptCommand()

virtual bool IInteractiveToolNestedAcceptCancelAPI::ExecuteNestedAcceptCommand ( )

inlinevirtual

Called by Editor levels to tell the implementor (eg Tool) to execute a nested Accept action

Returns

true if the implementor consumed the Accept action

ExecuteNestedCancelCommand()

virtual bool IInteractiveToolNestedAcceptCancelAPI::ExecuteNestedCancelCommand ( )

inlinevirtual

Called by Editor levels to tell the implementor (eg Tool) to execute a nested Cancel action

Returns

true if the implementor consumed the Cancel action

SupportsNestedAcceptCommand()

virtual bool IInteractiveToolNestedAcceptCancelAPI::SupportsNestedAcceptCommand ( )

inlinevirtual

Returns

true if the implementor of this API may be able to consume an Accept action

SupportsNestedCancelCommand()

virtual bool IInteractiveToolNestedAcceptCancelAPI::SupportsNestedCancelCommand ( )

inlinevirtual

Returns

true if the implementor of this API may be able to consume a Cancel action

---

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

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