版本

menu_open
Wwise SDK 2022.1.12
AK.Wwise::Plugin::V1::CustomData类 参考

Backend API to load and save custom data in XML format. 更多...

#include <CustomData.h>

类 AK.Wwise::Plugin::V1::CustomData 继承关系图:
ak_wwise_plugin_custom_data_instance_v1 AK.Wwise::Plugin::RequestedHostInterface< XmlReader > ak_wwise_plugin_cpp_base_instance AK.Wwise::Plugin::HostInterfaceGlue< XmlReader, false > ak_wwise_plugin_instance_ptr ak_wwise_plugin_cpp_base_instance

struct  Interface
 

Public 类型

enum  : InterfaceTypeValue { k_interfaceType = AK_WWISE_PLUGIN_INTERFACE_TYPE_CUSTOM_DATA }
 The interface type, as provided by this plug-in. 更多...
 
enum  : InterfaceVersion { k_interfaceVersion = 1 }
 The interface version, as provided by this plug-in. 更多...
 
using Instance = CCustomData::Instance
 Base instance type for providing custom data loading and saving. 更多...
 
- Public 类型 继承自 AK.Wwise::Plugin::RequestedHostInterface< XmlReader >
using HostInterfaceDefinition = HostInterfaceGlue< XmlReader, false >
 
- Public 类型 继承自 AK.Wwise::Plugin::HostInterfaceGlue< XmlReader, false >
enum  
 
enum  
 
using GluedInterface = typename CPPInstance::GluedInterface
 
using Instance = XmlReader
 
using CInstance = typename CPPInstance::Instance
 

Public 成员函数

InterfacePtr GetInterfacePointer ()
 The C interface, fulfilled by your plug-in. 更多...
 
CCustomData::InstanceGetInstancePointer ()
 
const CCustomData::InstanceGetInstancePointer () const
 
 CustomData ()
 
virtual ~CustomData ()
 
virtual void InitToDefault ()
 Initializes the plug-in's custom data to its default values. 更多...
 
virtual bool InitFromInstance (const CustomData &in_source)
 Copy the plug-in's custom data from another instance of the same plug-in. 更多...
 
virtual bool InitFromWorkunit (XmlReader &in_reader)
 Load the custom data structure from the provided Work Unit's XML. 更多...
 
virtual bool Save (XmlWriter &in_writer)
 Save custom data structure in the provided XML. 更多...
 
virtual void OnDelete ()
 OnDelete function is called when the user presses the "delete" button on a plug-in. 更多...
 
virtual bool GetPluginData (const GUID &in_guidPlatform, AkPluginParamID in_idParam, DataWriter &in_dataWriter) const
 Obtains parameters that will be sent to the sound engine when Wwise is connected. 更多...
 
- Public 成员函数 继承自 ak_wwise_plugin_cpp_base_instance
virtual ~ak_wwise_plugin_cpp_base_instance ()
 
- Public 成员函数 继承自 AK.Wwise::Plugin::RequestedHostInterface< XmlReader >
 RequestedHostInterface ()
 

额外继承的成员函数

- Public 属性 继承自 AK.Wwise::Plugin::RequestedHostInterface< XmlReader >
XmlReader ::Interface & g_xmlTextReaderInterface = HostInterfaceDefinition::g_cppinterface
 
- 静态 Public 属性 继承自 AK.Wwise::Plugin::HostInterfaceGlue< XmlReader, false >
static GluedInterface g_cppinterface
 The unique interface for this plug-in interface. 更多...
 

详细描述

Backend API to load and save custom data in XML format.

The initialization of custom-data-aware plug-ins is done using one of three mutually exclusive possibilities:

  • InitToDefault : Initializes a new instance using the default values
  • InitFromInstance : Initializes a new instance using the values provided by the original instance.
  • InitFromWorkunit : Initializes a new instance using the values provided in the Save method.
备注: AK::Wwise::Plugin::The RequestXml class is automatically derived when providing CustomData in C++.

在文件 CustomData.h194 行定义.


此页面对您是否有帮助?

需要技术支持?

仍有疑问?或者问题?需要更多信息?欢迎联系我们,我们可以提供帮助!

查看我们的“技术支持”页面

介绍一下自己的项目。我们会竭力为您提供帮助。

来注册自己的项目,我们帮您快速入门,不带任何附加条件!

开始 Wwise 之旅