Version

menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.9.8628 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2023.1.9
ak_wwise_plugin_host_undo_manager_v1 Struct Reference

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

#include <HostUndoManager.h>

Inheritance diagram for ak_wwise_plugin_host_undo_manager_v1:
ak_wwise_plugin_interface_ptr

Public Types

using Instance = ak_wwise_plugin_host_undo_manager_instance_v1
 Base host-provided instance type for ak_wwise_plugin_host_undo_manager_v1. More...
 

Public Member Functions

 ak_wwise_plugin_host_undo_manager_v1 ()
 
- 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

ak_wwise_plugin_undo_group_id(* OpenGroup )(struct ak_wwise_plugin_host_undo_manager_instance_v1 *in_this, ak_wwise_plugin_undo_group_id in_reopenGroupId)
 Open a group that will contain all subsequent undo events. More...
 
bool(* CloseGroup )(struct ak_wwise_plugin_host_undo_manager_instance_v1 *in_this, ak_wwise_plugin_undo_group_close_action in_action, ak_wwise_plugin_undo_group_id in_groupId, const char *in_szApplyEventName)
 Closes the last opened group, in stack ordering. More...
 
bool(* AddCustomEvent )(struct ak_wwise_plugin_host_undo_manager_instance_v1 *in_this, struct ak_wwise_plugin_undo_event_pair_v1 in_event)
 Adds a custom event to the currently opened group. More...
 
bool(* CanAddEvent )(const struct ak_wwise_plugin_host_undo_manager_instance_v1 *in_this)
 Check if we are currently in a state where we can add undo events. More...
 
bool(* IsBusy )(const struct ak_wwise_plugin_host_undo_manager_instance_v1 *in_this)
 Check if we are busy (undoing or redoing). More...
 
bool(* CanLogUndos )(const struct ak_wwise_plugin_host_undo_manager_instance_v1 *in_this)
 Returns whether logging can occur or not. 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

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

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