![]() |
AAX SDK
2.4.1
Avid Audio Extensions Development Kit
|
#include <AAX_CEffectGUI.h>
Default implementation of the AAX_IEffectGUI interface.
This class provides a default implementation of the AAX_IEffectGUI interface.
Public Member Functions | |
AAX_CEffectGUI (void) | |
~AAX_CEffectGUI (void) AAX_OVERRIDE | |
Initialization and uninitialization | |
AAX_Result | Initialize (IACFUnknown *iController) AAX_OVERRIDE |
Main GUI initialization. More... | |
AAX_Result | Uninitialize (void) AAX_OVERRIDE |
Main GUI uninitialization. More... | |
AAX host and plug-in event notification | |
AAX_Result | NotificationReceived (AAX_CTypeID inNotificationType, const void *inNotificationData, uint32_t inNotificationDataSize) AAX_OVERRIDE |
Notification Hook. More... | |
View accessors | |
AAX_Result | SetViewContainer (IACFUnknown *iViewContainer) AAX_OVERRIDE |
Provides a handle to the main plug-in window. More... | |
AAX_Result | GetViewSize (AAX_Point *) const AAX_OVERRIDE |
Retrieves the size of the plug-in window. More... | |
GUI update methods | |
AAX_Result | Draw (AAX_Rect *) AAX_OVERRIDE |
DEPRECATED, Not called from host any longer. Your chosen graphics framework should be directly handling draw events from the OS. More... | |
AAX_Result | TimerWakeup (void) AAX_OVERRIDE |
Periodic wakeup callback for idle-time operations. More... | |
AAX_Result | ParameterUpdated (AAX_CParamID paramID) AAX_OVERRIDE |
Notifies the GUI that a parameter value has changed. More... | |
Host interface methods | |
Miscellaneous methods to provide host-specific functionality | |
AAX_Result | GetCustomLabel (AAX_EPlugInStrings iSelector, AAX_IString *oString) const AAX_OVERRIDE |
Called by host application to retrieve a custom plug-in string. More... | |
AAX_Result | SetControlHighlightInfo (AAX_CParamID, AAX_CBoolean, AAX_EHighlightColor) AAX_OVERRIDE |
Called by host application. Indicates that a control widget should be updated with a highlight color. More... | |
![]() | |
ACF_DECLARE_STANDARD_UNKNOWN () ACFMETHOD(InternalQueryInterface)(const acfIID &riid | |
AAX_DELETE (AAX_IEffectGUI &operator=(const AAX_IEffectGUI &)) | |
Initialization and uninitialization | |
AAX host and plug-in event notification | |
View accessors | |
GUI update methods | |
Host interface methods | |
Miscellaneous methods to provide host-specific functionality | |
![]() | |
virtual BEGIN_ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE | QueryInterface (const acfIID &iid, void **ppOut)=0 |
Returns pointers to supported interfaces. More... | |
virtual acfUInt32 ACFMETHODCALLTYPE | AddRef (void)=0 |
Increments reference count. More... | |
virtual acfUInt32 ACFMETHODCALLTYPE | Release (void)=0 |
Decrements reference count. More... | |
Protected Member Functions | |
AAX_CEffectGUI pure virtual interface | |
The implementations of these methods will be specific to the particular GUI framework that is being incorporated with AAX_CEffectGUI. Classes that inherit from AAX_CEffectGUI must override these methods with their own framework-specific implementations. | |
virtual void | CreateViewContents (void)=0 |
Creates any required top-level GUI components. More... | |
virtual void | CreateViewContainer (void)=0 |
Initializes the plug-in window and creates the main GUI view or frame. More... | |
virtual void | DeleteViewContainer (void)=0 |
Uninitializes the plug-in window and deletes the main GUI view or frame. More... | |
Helper methods | |
virtual void | UpdateAllParameters (void) |
Requests an update to the GUI for every parameter view. More... | |
Private member accessors | |
AAX_IController * | GetController (void) |
Retrieves a reference to the plug-in's controller interface. More... | |
const AAX_IController * | GetController (void) const |
AAX_IEffectParameters * | GetEffectParameters (void) |
Retrieves a reference to the plug-in's data model interface. More... | |
const AAX_IEffectParameters * | GetEffectParameters (void) const |
AAX_IViewContainer * | GetViewContainer (void) |
Retrieves a reference to the plug-in's view container interface. More... | |
const AAX_IViewContainer * | GetViewContainer (void) const |
AAX_ITransport * | Transport () |
Retrieves a reference to the plug-in's Transport interface. More... | |
const AAX_ITransport * | Transport () const |
AAX_EViewContainer_Type | GetViewContainerType () |
Retrieves the Container and it's type. More... | |
void * | GetViewContainerPtr () |
Additional Inherited Members | |
![]() | |
void **ppvObjOut | override |
AAX_CEffectGUI::AAX_CEffectGUI | ( | void | ) |
AAX_CEffectGUI::~AAX_CEffectGUI | ( | void | ) |
|
virtual |
Main GUI initialization.
Called when the GUI is created
[in] | iController | A versioned reference that resolves to an AAX_IController interface |
Implements AAX_IACFEffectGUI.
|
virtual |
Main GUI uninitialization.
Called when the GUI is destroyed. Frees the GUI.
Implements AAX_IACFEffectGUI.
|
virtual |
Notification Hook.
Called from the host to deliver notifications to this object.
Look at the AAX_ENotificationEvent enumeration to see a description of events you can listen for and the data they come with.
NotificationReceived()
methods.NotificationReceived()
method (e.g. the data model).[in] | inNotificationType | Type of notification being received. Notifications form the host are one of AAX_ENotificationEvent |
[in] | inNotificationData | Block of incoming notification data |
[in] | inNotificationDataSize | Size of inNotificationData , in bytes |
Implements AAX_IACFEffectGUI.
|
virtual |
Provides a handle to the main plug-in window.
[in] | iViewContainer | An AAX_IViewContainer providing a native handle to the plug-in's window |
Implements AAX_IACFEffectGUI.
|
inlinevirtual |
Retrieves the size of the plug-in window.
[out] | oViewSize | The size of the plug-in window as a point (width, height) |
Implements AAX_IACFEffectGUI.
References AAX_SUCCESS.
|
inlinevirtual |
DEPRECATED, Not called from host any longer. Your chosen graphics framework should be directly handling draw events from the OS.
Implements AAX_IACFEffectGUI.
References AAX_SUCCESS.
|
inlinevirtual |
Periodic wakeup callback for idle-time operations.
GUI animation events such as meter updates should be triggered from this method.
This method is called from the host's main thread. In general, it should be driven at approximately one call per 30 ms. However, the wakeup is not guaranteed to be called at any regular interval - for example, it could be held off by a high real-time processing load - and there is no host contract regarding maximum latency between wakeup calls.
This wakeup runs continuously and cannot be armed/disarmed by the plug-in.
Implements AAX_IACFEffectGUI.
References AAX_SUCCESS.
|
virtual |
Notifies the GUI that a parameter value has changed.
This method is called by the host whenever a parameter value has been modified
This method may be called on a non-main thread
Implements AAX_IACFEffectGUI.
|
virtual |
Called by host application to retrieve a custom plug-in string.
If no string is provided then the host's default will be used.
[in] | iSelector | The requested strong. One of AAX_EPlugInStrings |
[out] | oString | The plug-in's custom value for the requested string |
Implements AAX_IACFEffectGUI.
|
inlinevirtual |
Called by host application. Indicates that a control widget should be updated with a highlight color.
SetControlHighliteInfo()
, its name in the legacy plug-in SDK.[in] | iParameterID | ID of parameter whose widget(s) must be highlighted |
[in] | iIsHighlighted | True if turning highlight on, false if turning it off |
[in] | iColor | Desired highlight color. One of AAX_EHighlightColor |
Implements AAX_IACFEffectGUI.
References AAX_SUCCESS.
|
protectedpure virtual |
Creates any required top-level GUI components.
This method is called by default from AAX_CEffectGUI::Initialize()
|
protectedpure virtual |
Initializes the plug-in window and creates the main GUI view or frame.
This method is called by default from AAX_CEffectGUI::SetViewContainer() when a valid window is present
|
protectedpure virtual |
Uninitializes the plug-in window and deletes the main GUI view or frame.
This method is called by default from AAX_CEffectGUI::SetViewContainer() when no valid window is present. It may also be appropriate for inheriting classes to call this method from their destructors, depending on their own internal implementation.
|
protectedvirtual |
Requests an update to the GUI for every parameter view.
By default, calls AAX_CEffectGUI::ParameterUpdated() on every registered parameter.
By default, called from AAX_CEffectGUI::SetViewContainer() after a new view container has been created.
UpdateAllParameterViews()
or another name that does not lead to confusion regarding what exactly this method should be doing. AAX_IController* AAX_CEffectGUI::GetController | ( | void | ) |
Retrieves a reference to the plug-in's controller interface.
const AAX_IController* AAX_CEffectGUI::GetController | ( | void | ) | const |
AAX_IEffectParameters* AAX_CEffectGUI::GetEffectParameters | ( | void | ) |
Retrieves a reference to the plug-in's data model interface.
const AAX_IEffectParameters* AAX_CEffectGUI::GetEffectParameters | ( | void | ) | const |
AAX_IViewContainer* AAX_CEffectGUI::GetViewContainer | ( | void | ) |
Retrieves a reference to the plug-in's view container interface.
const AAX_IViewContainer* AAX_CEffectGUI::GetViewContainer | ( | void | ) | const |
AAX_ITransport* AAX_CEffectGUI::Transport | ( | ) |
Retrieves a reference to the plug-in's Transport interface.
const AAX_ITransport* AAX_CEffectGUI::Transport | ( | ) | const |
AAX_EViewContainer_Type AAX_CEffectGUI::GetViewContainerType | ( | ) |
Retrieves the Container and it's type.
void* AAX_CEffectGUI::GetViewContainerPtr | ( | ) |