Wwise Version
arrow_right Table of Contents
Wwise SDK 2021.1.3
ak_wwise_plugin_undo_event_v1 Struct Reference

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

#include <HostUndoManager.h>

Inheritance diagram for ak_wwise_plugin_undo_event_v1:
ak_wwise_plugin_interface_ptr AK.Wwise::Plugin::V1::DynamicUndoEvent< BackendDerivedClass >::Interface AK.Wwise::Plugin::V1::UndoEvent< Backend >::Interface

Public Types

using  Instance = ak_wwise_plugin_undo_event_instance_v1
  Base instance type for providing custom undo operations. More...
 

Public Member Functions

  ak_wwise_plugin_undo_event_v1 ()
 
  ak_wwise_plugin_undo_event_v1 (decltype(m_interface) in_interface, decltype(m_version) in_version)
 
  ak_wwise_plugin_undo_event_v1 (std::underlying_type< decltype(m_interface)>::type in_interface, decltype(m_version) in_version)
 
- Public Member Functions inherited from ak_wwise_plugin_interface_ptr
constexpr  ak_wwise_plugin_base_interface (decltype(m_interface) in_interface, decltype(m_version) in_version)
 
constexpr  ak_wwise_plugin_base_interface ()
 
constexpr  ak_wwise_plugin_base_interface (std::underlying_type< decltype(m_interface)>::type in_interface, decltype(m_version) in_version)
 

Public Attributes

void(*  Destroy )(struct ak_wwise_plugin_undo_event_instance_v1 *in_this)
  Called when the system needs to destroy your ak_wwise_plugin_undo_event_v1 instance. More...
 
bool(*  Undo )(struct ak_wwise_plugin_undo_event_instance_v1 *in_this, struct ak_wwise_plugin_backend_instance *in_backend)
  Called when the user asks to undo an action. More...
 
bool(*  Redo )(struct ak_wwise_plugin_undo_event_instance_v1 *in_this, struct ak_wwise_plugin_backend_instance *in_backend)
  Called when the user asks to redo an action. More...
 
bool(*  GetName )(const struct ak_wwise_plugin_undo_event_instance_v1 *in_this, const char **out_csName)
  Get the event name, to show after the "Undo " and "Redo " terms in the menu. More...
 
- Public Attributes inherited from ak_wwise_plugin_interface_ptr
ak_wwise_plugin_interface_type  m_interface: 32
  Interface type (see ak_wwise_plugin_interface_type) More...
 
uint32_t  m_version: 32
  Version of the interface. More...
 

Detailed Description

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

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

Definition at line 42 of file HostUndoManager.h.