Version

menu_open
Wwise SDK 2023.1.5
AK.Wwise::Plugin::V1::UndoManager Class Reference

Host API to handle the plug-in's undo operations. More...

#include <HostUndoManager.h>

Inheritance diagram for AK.Wwise::Plugin::V1::UndoManager:
AK.Wwise::Plugin::CBaseInstanceGlue< CHostUndoManager > AK.Wwise::Plugin::CBaseInterfaceGlue< CHostUndoManager >

Public Types

enum  : InterfaceTypeValue { k_interfaceType = AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_UNDO_MANAGER }
 The interface type, as requested by this plug-in. More...
 
enum  : InterfaceVersion { k_interfaceVersion = 1 }
 The interface version, as requested by this plug-in. More...
 
using Interface = CHostUndoManager
 
- Public Types inherited from AK.Wwise::Plugin::CBaseInstanceGlue< CHostUndoManager >
using Instance = typename CInterface::Instance
 
- Public Types inherited from AK.Wwise::Plugin::CBaseInterfaceGlue< CHostUndoManager >
using GluedInterface = CHostUndoManager
 

Public Member Functions

ak_wwise_plugin_undo_group_id OpenGroup (ak_wwise_plugin_undo_group_id in_reopenGroupId=0)
 Open a group that will contain all subsequent undo events. More...
 
bool CloseGroup (ak_wwise_plugin_undo_group_close_action in_action=AK_WWISE_PLUGIN_UNDO_GROUP_CLOSE_ACTION_APPLY, ak_wwise_plugin_undo_group_id in_groupId=0, const char *in_szApplyEventName=nullptr)
 Closes the last opened group, in stack ordering. More...
 
bool AddCustomEvent (BaseUndoEvent *in_pEvent)
 Adds a custom event to the currently opened group. More...
 
bool CanAddEvent () const
 Check if we are currently in a state where we can add undo events. More...
 
bool IsBusy () const
 Check if we are busy (undoing or redoing). More...
 
bool CanLogUndos () const
 Returns whether logging can occur or not. More...
 

Additional Inherited Members

- Static Public Attributes inherited from AK.Wwise::Plugin::CBaseInterfaceGlue< CHostUndoManager >
static GluedInterfaceg_cinterface
 The unique instance of the CInterface interface. Defined at nullptr first, overridden by the Host once loaded. More...
 

Detailed Description

Host API to handle the plug-in's undo operations.

Definition at line 487 of file HostUndoManager.h.


Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise