UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IToolContextTransactionProvider Class Referenceabstract

#include <InteractiveToolChange.h>

+ Inheritance diagram for IToolContextTransactionProvider:

Public Member Functions

virtual void BeginUndoTransaction (const FText &Description)=0
 
virtual void EndUndoTransaction ()=0
 
virtual void EmitObjectChange (UObject *TargetObject, TUniquePtr< FToolCommandChange > Change, const FText &Description)=0
 

Detailed Description

IToolContextTransactionProvider is a UInterface that defines several functions that InteractiveTool code uses to interface with the higher-level transaction system. UInteractiveToolManager and UInteractiveGizmoManager both implement this interface.

Member Function Documentation

◆ BeginUndoTransaction()

virtual void IToolContextTransactionProvider::BeginUndoTransaction ( const FText Description)
pure virtual

Request that the Context open a Transaction, whatever that means to the current Context

Parameters
Descriptiontext description of this transaction (this is the string that appears on undo/redo in the UE Editor)

Implemented in UInteractiveGizmoManager, and UInteractiveToolManager.

◆ EmitObjectChange()

virtual void IToolContextTransactionProvider::EmitObjectChange ( UObject TargetObject,
TUniquePtr< FToolCommandChange Change,
const FText Description 
)
pure virtual

Forward an FChange object to the Context

Parameters
TargetObjectthe object that the FChange applies to
Changethe change object that the Context should insert into the transaction history
Descriptiontext description of this change (this is the string that appears on undo/redo in the UE Editor)

Implemented in UInteractiveGizmoManager, and UInteractiveToolManager.

◆ EndUndoTransaction()

virtual void IToolContextTransactionProvider::EndUndoTransaction ( )
pure virtual

Request that the Context close and commit the open Transaction

Implemented in UInteractiveGizmoManager, and UInteractiveToolManager.


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