Version

menu_open
Wwise SDK 2023.1.5
AK.Wwise::Plugin::V1::UndoEvent< Backend > Class Template Referenceabstract

Base API to create a custom undo event in a plug-in. More...

#include <HostUndoManager.h>

Inheritance diagram for AK.Wwise::Plugin::V1::UndoEvent< Backend >:
AK.Wwise::Plugin::V1::BaseUndoEvent ak_wwise_plugin_undo_event_instance_v1 ak_wwise_plugin_cpp_base_instance ak_wwise_plugin_instance_ptr

Classes

struct  Interface
 

Public Member Functions

virtual BaseUndoEvent::InterfaceGetInterfacePointer () final
 
virtual bool Undo (Backend &in_backend)=0
 Called when the user asks to undo an action. More...
 
virtual bool Redo (Backend &in_backend)=0
 Called when the user asks to redo an action. More...
 
virtual bool GetName (const char **out_csName) const =0
 Get the event name, to show after the "Undo " and "Redo " terms in the menu. More...
 
- Public Member Functions inherited from AK.Wwise::Plugin::V1::BaseUndoEvent
CUndoEvent::InstanceGetInstancePointer ()
 
const CUndoEvent::InstanceGetInstancePointer () const
 
 BaseUndoEvent ()
 
virtual ~BaseUndoEvent ()
 
- Public Member Functions inherited from ak_wwise_plugin_cpp_base_instance
virtual ~ak_wwise_plugin_cpp_base_instance ()
 

Additional Inherited Members

- Public Types inherited from AK.Wwise::Plugin::V1::BaseUndoEvent
enum  : InterfaceTypeValue { k_interfaceType = AK_WWISE_PLUGIN_INTERFACE_TYPE_UNDO_EVENT }
 The interface type, as provided by this plug-in. More...
 
enum  : InterfaceVersion { k_interfaceVersion = 1 }
 The interface version, as provided by this plug-in. More...
 
using Interface = CUndoEvent
 

Detailed Description

template<typename Backend>
class AK.Wwise::Plugin::V1::UndoEvent< Backend >

Base API to create a custom undo event in a plug-in.

This is useful when you handle custom properties, not handled by Property Sets.

Undo events should be derived by your undo class, providing UndoEvent::Undo, UndoEvent::Redo and UndoEvent::GetName methods.

No pointer to the backend class should be kept inside the undo event, as the object can be deleted and recreated when the plug-in gets removed through undo. The backend will be recreated at that point, making the pointer invalid.

Template Parameters
BackendThe plug-in backend type.

Definition at line 327 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