Version
menu_open
|
Wwise SDK 2024.1.4
|
AK.Wwise::Plugin::V1::FrontendModel Class Reference
Interface used to interact with the frontend model. More...
#include <HostFrontendModel.h>
Inheritance diagram for AK.Wwise::Plugin::V1::FrontendModel:
Public Types | |
| enum | : InterfaceTypeValue { k_interfaceType = AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_FRONTEND_MODEL } |
| The interface type, as requested by this plug-in. More... | |
| enum | : InterfaceVersion { k_interfaceVersion = 1 } |
| The interface version, as requested by this plug-in. More... | |
| using | Interface = CHostFrontendModel |
| using | GenericCallback = void(*)() |
| using | ForEachCallback = void(*)(ak_wwise_plugin_widget *, void *) |
 Public Types inherited from AK.Wwise::Plugin::CBaseInstanceGlue< CHostFrontendModel > | |
| using | Instance = typename CInterface::Instance |
| Public Types inherited from AK.Wwise::Plugin::CBaseInterfaceGlue< CHostFrontendModel > | |
| using | GluedInterface = CHostFrontendModel |
Public Member Functions | |
| bool | HasWidget (const char *in_absoluteId) |
| Checks if a specific widget exists. More... | |
| ak_wwise_plugin_widget * | GetParentWidget (const char *in_absoluteId) |
| Returns the parent widget of a given Frontend Handle hierarchy. More... | |
| ak_wwise_plugin_widget * | GetRootWidget () |
| Returns the main layout widget of a given Frontend Handle hierarchy. More... | |
| ak_wwise_plugin_widget * | GetWidget (const char *in_absoluteId) |
| Returns a specific widget of a given Frontend Handle hierarchy. More... | |
| const char * | GetWidgetID (ak_wwise_plugin_widget *in_widget) |
| Gets the ID of a widget. More... | |
| const char * | GetWidgetType (ak_wwise_plugin_widget *in_widget) |
| Gets the type ID of a widget. More... | |
| bool | IsWidgetContainer (ak_wwise_plugin_widget *in_widget) |
| Checks if the widget can contain other widgets. More... | |
| bool | IsWidgetTopLevel (ak_wwise_plugin_widget *in_widget) |
| Checks if the widget is top-level. More... | |
| bool | IsWidgetVisible (ak_wwise_plugin_widget *in_widget) |
| Determines the visibility state of the given widget. More... | |
| bool | IsWidgetEnabled (ak_wwise_plugin_widget *in_widget) |
| Determines if a widget is enabled for mouse and keyboard input. More... | |
| void | EnableWidget (ak_wwise_plugin_widget *in_widget, bool in_enable) |
| Enables or disables mouse and keyboard input for the widget. More... | |
| void | ShowWidget (ak_wwise_plugin_widget *in_widget, bool in_show) |
| Sets the visibility state of the widget. More... | |
| void | SetWidgetFocus (ak_wwise_plugin_widget *in_widget) |
| Claims the input focus for the widget. More... | |
| 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. More... | |
| void | ForEachChildren (const char *in_absoluteId, ForEachCallback in_handler, void *in_userData) |
| Applies a user-defined handler to every child of a container. More... | |
Additional Inherited Members | |
| Static Public Attributes inherited from AK.Wwise::Plugin::CBaseInterfaceGlue< CHostFrontendModel > | |
| static GluedInterface * | g_cinterface |
| The unique instance of the CInterface interface. Defined at nullptr first, overridden by the Host once loaded. More... | |
Detailed Description
Interface used to interact with the frontend model.
The frontend model is the service in charge of building GUI views and managing the objects's lifetime. It takes the description of a view in the form of a WAFM file, creates the widget hierarchy, and stores the objects in a specific handle. The handle is shared to the user to allow interaction with the view's widgets.
Definition at line 267 of file HostFrontendModel.h.
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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