IToolsContextTransactionsAPI

Users of the Tools Framework need to implement [IToolsContextTransactionsAPI](API\Runtime\InteractiveToolsFramework\IToolsContextTransactionsAPI) so that the Tools have the ability to create Transactions and emit Changes.

Windows
MacOS
Linux

References

Module

InteractiveToolsFramework

Header

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

Include

#include "ToolContextInterfaces.h"

Syntax

class IToolsContextTransactionsAPI

Remarks

Users of the Tools Framework need to implement IToolsContextTransactionsAPI so that the Tools have the ability to create Transactions and emit Changes.

that this is technically optional, but that undo/redo won't be supported without it.

Destructors

Functions

Name Description

Public function

void

 

AppendChange

(
    UObject* TargetObject,
    TUniquePtr< FToolCommandChange > Ch...,
    const FText& Description
)

Insert an FChange into the transaction history in the current Context.

Public function

void

 

BeginUndoTransaction

(
    const FText& Description
)

Begin a Transaction, whatever this means in the current Context.

Public function

void

 

DisplayMessage

(
    const FText& Message,
    EToolMessageLevel Level
)

Request that context display message information.

Public function

void

 

EndUndoTransaction()

Complete the Transaction. Assumption is that Begin/End are called in pairs.

Public function

void

 

PostInvalidation()

Forward an invalidation request from Tools framework, to cause repaint/etc.

Public function

bool

 

RequestSelectionChange

(
    const FSelectedOjectsChangeList& S...
)

Request a modification to the current selected objects
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss