Open 3D Engine LyShine Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
UiAnimUndoManager Class Reference

#include <UiAnimUndoManager.h>

Public Member Functions

void Begin ()
 
void Restore (bool bUndo=true)
 
void Accept (const AZStd::string &name)
 
void Cancel ()
 Cancel changes and restore undo objects.
 
void Suspend ()
 Temporarily suspends recording of undo.
 
void Resume ()
 Resume recording if was suspended.
 
void Undo ()
 
void Redo ()
 Redo last undo.
 
void RedoStep (UiAnimUndoStep *step)
 
void UndoStep (UiAnimUndoStep *step)
 
bool IsUndoRecording () const
 Check if undo information is recording now.
 
bool IsUndoSuspended () const
 
void RecordUndo (UiAnimUndoObject *obj)
 Put new undo object, must be called between Begin and Accept/Cancel methods.
 
void Flush ()
 
void AddListener (IUndoManagerListener *pListener)
 
void RemoveListener (IUndoManagerListener *pListener)
 
void SetActiveUndoStack (UndoStack *undoStack)
 
UndoStackGetActiveUndoStack () const
 

Static Public Member Functions

static UiAnimUndoManagerGet ()
 

Detailed Description

UiAnimUndoManager is keeping and operating on UiAnimUndo class instances.

Member Function Documentation

◆ Accept()

void UiAnimUndoManager::Accept ( const AZStd::string &  name)

Accept changes and registers an undo object with the undo manager. This will allow the user to undo the operation.

◆ Begin()

void UiAnimUndoManager::Begin ( )

Begin operation requiring undo. Undo manager enters holding state.

◆ Flush()

void UiAnimUndoManager::Flush ( )

Completly flush all Undo and redo buffers. Must be done on level reloads or global Fetch operation.

◆ Restore()

void UiAnimUndoManager::Restore ( bool  bUndo = true)

Restore all undo objects registered since last Begin call.

Parameters
bUndoif true all Undo object registered up to this point will be undone.

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