Wwise SDK
_host_frontend_model_8h_source
版本
menu_open
link
HostFrontendModel.h
浏览该文件的文档.
221 * \param[in] in_handler Static function of the form 'void StaticHandler(void* in_owner, ArgsT... in_args, void* in_data)'.
239 * \param[in] in_handler Static function of the form 'void StaticHandler(ak_wwise_plugin_widget*, void* in_data)'.
283 };
293 };
446 * \param[in] in_handler Static function of the form 'void StaticHandler(void* in_owner, ArgsT... in_args, void* in_data)'.
465 * \param[in] in_handler Static function of the form 'void StaticHandler(ak_wwise_plugin_widget*, void* in_data)'.
482 * Deriving your plug-in class from RequestFrontendModel will automatically request the FrontendModel interface.
483 * From this point, you will be able to access the host-provided functions in the `m_frontendModel` variable.
bool(* HasWidget)(struct ak_wwise_plugin_host_frontend_model_instance_v1 *in_this, const char *in_absoluteId)
Checks if a specific widget exists.
Definition: HostFrontendModel.h:69
bool IsWidgetContainer(ak_wwise_plugin_widget *in_widget)
Checks if the widget can contain other widgets.
Definition: HostFrontendModel.h:365
@ k_interfaceVersion
The interface version, as requested by this plug-in.
Definition: HostFrontendModel.h:292
ak_wwise_plugin_widget *(* GetRootWidget)(struct ak_wwise_plugin_host_frontend_model_instance_v1 *in_this)
Returns the main layout widget of a given Frontend Handle hierarchy.
Definition: HostFrontendModel.h:90
void(* EnableWidget)(struct ak_wwise_plugin_host_frontend_model_instance_v1 *in_this, ak_wwise_plugin_widget *in_widget, bool in_enable)
Enables or disables mouse and keyboard input for the widget.
Definition: HostFrontendModel.h:185
void(*)() GenericCallback
Definition: HostFrontendModel.h:271
static GluedInterface * g_cinterface
The unique instance of the CInterface interface. Defined at nullptr first, overridden by the Host onc...
Definition: PluginInfoGenerator.h:89
Interface used to interact with the frontend model.
Definition: HostFrontendModel.h:267
decltype(BaseInterface::m_version) InterfaceVersion
PluginInfoGenerator: Type for the m_version value in BaseInterface
Definition: PluginInfoGenerator.h:50
void(* SetWidgetFocus)(struct ak_wwise_plugin_host_frontend_model_instance_v1 *in_this, ak_wwise_plugin_widget *in_widget)
Claims the input focus for the widget.
Definition: HostFrontendModel.h:210
bool(* IsWidgetVisible)(struct ak_wwise_plugin_host_frontend_model_instance_v1 *in_this, ak_wwise_plugin_widget *in_widget)
Determines the visibility state of the given widget.
Definition: HostFrontendModel.h:161
bool(* Connect)(struct ak_wwise_plugin_host_frontend_model_instance_v1 *in_this, ak_wwise_plugin_widget *in_widget, const char *in_name, void(*in_handler)(), void *in_userData)
Connects a signal to a handler taking some user-defined data.
Definition: HostFrontendModel.h:226
bool IsWidgetTopLevel(ak_wwise_plugin_widget *in_widget)
Checks if the widget is top-level.
Definition: HostFrontendModel.h:376
void ForEachChildren(const char *in_absoluteId, ForEachCallback in_handler, void *in_userData)
Applies a user-defined handler to every child of a container.
Definition: HostFrontendModel.h:469
void ShowWidget(ak_wwise_plugin_widget *in_widget, bool in_show)
Sets the visibility state of the widget.
Definition: HostFrontendModel.h:423
ak_wwise_plugin_widget *(* GetWidget)(struct ak_wwise_plugin_host_frontend_model_instance_v1 *in_this, const char *in_absoluteId)
Returns a specific widget of a given Frontend Handle hierarchy.
Definition: HostFrontendModel.h:101
void(* ShowWidget)(struct ak_wwise_plugin_host_frontend_model_instance_v1 *in_this, ak_wwise_plugin_widget *in_widget, bool in_show)
Sets the visibility state of the widget.
Definition: HostFrontendModel.h:198
bool(* IsWidgetTopLevel)(struct ak_wwise_plugin_host_frontend_model_instance_v1 *in_this, ak_wwise_plugin_widget *in_widget)
Checks if the widget is top-level.
Definition: HostFrontendModel.h:149
bool Connect(ak_wwise_plugin_widget *in_widget, const char *in_name, GenericCallback in_handler, void *in_userData)
Connects a signal to a handler taking some user-defined data.
Definition: HostFrontendModel.h:451
const char *(* GetWidgetType)(struct ak_wwise_plugin_host_frontend_model_instance_v1 *in_this, ak_wwise_plugin_widget *in_widget)
Gets the type ID of a widget.
Definition: HostFrontendModel.h:125
const char * GetWidgetID(ak_wwise_plugin_widget *in_widget)
Gets the ID of a widget.
Definition: HostFrontendModel.h:343
@ k_interfaceType
The interface type, as requested by this plug-in.
Definition: HostFrontendModel.h:282
Interface used to interact with the frontend model.
Definition: HostFrontendModel.h:49
V1::FrontendModel FrontendModel
Latest version of the C++ FrontendModel interface.
Definition: HostFrontendModel.h:495
Wwise Authoring Plug-ins - C++ class helper to automatically determine the plug-in interfaces used in...
bool(* IsWidgetEnabled)(struct ak_wwise_plugin_host_frontend_model_instance_v1 *in_this, ak_wwise_plugin_widget *in_widget)
Determines if a widget is enabled for mouse and keyboard input.
Definition: HostFrontendModel.h:173
bool HasWidget(const char *in_absoluteId)
Checks if a specific widget exists.
Definition: HostFrontendModel.h:301
RequestedHostInterface< FrontendModel > RequestFrontendModel
Requests a FrontendModel interface, provided as m_frontendModel variable.
Definition: HostFrontendModel.h:488
PluginInfoGenerator: Associates an existing C Interface with a variable that can be used....
Definition: PluginInfoGenerator.h:104
ak_wwise_plugin_widget *(* GetParentWidget)(struct ak_wwise_plugin_host_frontend_model_instance_v1 *in_this)
Returns the parent widget of a given Frontend Handle hierarchy.
Definition: HostFrontendModel.h:80
ak_wwise_plugin_widget * GetRootWidget()
Returns the main layout widget of a given Frontend Handle hierarchy.
Definition: HostFrontendModel.h:321
bool IsWidgetEnabled(ak_wwise_plugin_widget *in_widget)
Determines if a widget is enabled for mouse and keyboard input.
Definition: HostFrontendModel.h:398
bool IsWidgetVisible(ak_wwise_plugin_widget *in_widget)
Determines the visibility state of the given widget.
Definition: HostFrontendModel.h:387
std::underlying_type< InterfaceType >::type InterfaceTypeValue
PluginInfoGenerator: Underlying storage type for the m_interface value in BaseInterface
Definition: PluginInfoGenerator.h:49
const char *(* GetWidgetID)(struct ak_wwise_plugin_host_frontend_model_instance_v1 *in_this, ak_wwise_plugin_widget *in_widget)
Gets the ID of a widget.
Definition: HostFrontendModel.h:113
ak_wwise_plugin_host_frontend_model_v1 CHostFrontendModel
Definition: HostFrontendModel.h:263
const char * GetWidgetType(ak_wwise_plugin_widget *in_widget)
Gets the type ID of a widget.
Definition: HostFrontendModel.h:354
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION(AudioPlugin)
void(*)(ak_wwise_plugin_widget *, void *) ForEachCallback
Definition: HostFrontendModel.h:272
bool(* IsWidgetContainer)(struct ak_wwise_plugin_host_frontend_model_instance_v1 *in_this, ak_wwise_plugin_widget *in_widget)
Checks if the widget can contain other widgets.
Definition: HostFrontendModel.h:137
Interface description and base class for every Wwise Authoring plug-in interface.
Definition: PluginBaseInterface.h:120
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_FRONTEND_MODEL
Definition: PluginBaseInterface.h:96
ak_wwise_plugin_widget * GetWidget(const char *in_absoluteId)
Returns a specific widget of a given Frontend Handle hierarchy.
Definition: HostFrontendModel.h:332
void SetWidgetFocus(ak_wwise_plugin_widget *in_widget)
Claims the input focus for the widget.
Definition: HostFrontendModel.h:436
void EnableWidget(ak_wwise_plugin_widget *in_widget, bool in_enable)
Enables or disables mouse and keyboard input for the widget.
Definition: HostFrontendModel.h:409
ak_wwise_plugin_widget * GetParentWidget()
Returns the parent widget of a given Frontend Handle hierarchy.
Definition: HostFrontendModel.h:311
#define AK_WWISE_PLUGIN_SPECIALIZE_HOST_INTERFACE(in_name, in_varname,...)
PluginInfoGenerator: Creates a C++ host specialization for interface class specified in in_name,...
Definition: PluginInfoGenerator.h:237
ak_wwise_plugin_host_frontend_model_v1()
Definition: HostFrontendModel.h:57
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS(AudioPlugin)
void(* ForEachChildren)(struct ak_wwise_plugin_host_frontend_model_instance_v1 *in_this, const char *in_absoluteId, void(*in_handler)(ak_wwise_plugin_widget *, void *), void *in_userData)
Applies a user-defined handler to every child of a container.
Definition: HostFrontendModel.h:243
Wwise Authoring Plug-ins - Base plug-in definitions
Definition: AudioPlugin.h:111