AAX SDK  2.4.1
Avid Audio Extensions Development Kit
AAX_IACFEffectGUI.h
Go to the documentation of this file.
1 /*================================================================================================*/
2 /*
3  *
4  * Copyright 2013-2017 by Avid Technology, Inc.
5  * All rights reserved.
6  *
7  * CONFIDENTIAL: This document contains confidential information. Do not
8  * read or examine this document unless you are an Avid Technology employee
9  * or have signed a non-disclosure agreement with Avid Technology which protects
10  * the confidentiality of this document. DO NOT DISCLOSE ANY INFORMATION
11  * CONTAINED IN THIS DOCUMENT TO ANY THIRD-PARTY WITHOUT THE PRIOR WRITTEN CONSENT
12  * OF Avid Technology, INC.
13  *
14  */
15 
22 /*================================================================================================*/
23 
24 
25 #ifndef AAX_IACFEFFECTGUI_H
26 #define AAX_IACFEFFECTGUI_H
27 
28 #include "AAX.h"
29 #include "AAX_GUITypes.h"
30 #include "AAX_IString.h"
31 
32 #ifdef __clang__
33 #pragma clang diagnostic push
34 #pragma clang diagnostic ignored "-Wnon-virtual-dtor"
35 #endif
36 
37 #include "acfunknown.h"
38 
39 
86 {
87 public:
88 
100  virtual AAX_Result Initialize ( IACFUnknown * iController ) = 0;
107  virtual AAX_Result Uninitialize () = 0;
109 
138  virtual AAX_Result NotificationReceived(/* AAX_ENotificationEvent */ AAX_CTypeID inNotificationType, const void * inNotificationData, uint32_t inNotificationDataSize) = 0;
140 
150  virtual AAX_Result SetViewContainer ( IACFUnknown * iViewContainer ) = 0;
159  virtual AAX_Result GetViewSize ( AAX_Point * oViewSize ) const = 0;
161 
168  virtual AAX_Result Draw ( AAX_Rect * iDrawRect ) = 0;
183  virtual AAX_Result TimerWakeup () = 0;
197  virtual AAX_Result ParameterUpdated( AAX_CParamID inParamID) = 0;
199 
200 
217  virtual AAX_Result GetCustomLabel ( AAX_EPlugInStrings iSelector, AAX_IString * oString ) const = 0;
235  virtual AAX_Result SetControlHighlightInfo ( AAX_CParamID iParameterID, AAX_CBoolean iIsHighlighted, AAX_EHighlightColor iColor ) = 0;
237 
238 };
239 
240 #ifdef __clang__
241 #pragma clang diagnostic pop
242 #endif
243 
244 #endif //AAX_IACFEFFECTGUI_H
Various utility definitions for AAX.
const char * AAX_CParamID
Parameter identifier.
Definition: AAX.h:352
int32_t AAX_Result
Definition: AAX.h:337
uint8_t AAX_CBoolean
Cross-compiler boolean type used by AAX interfaces.
Definition: AAX.h:329
uint32_t AAX_CTypeID
Matches type of OSType used in classic plugins.
Definition: AAX.h:336
AAX_EHighlightColor
Highlight color selector.
Definition: AAX_Enums.h:59
AAX_EPlugInStrings
Effect string identifiers.
Definition: AAX_Enums.h:323
Constants and other definitions used by AAX plug-in GUIs.
An AAX string interface.
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:248
Data structure representing a two-dimensional coordinate point.
Definition: AAX_GUITypes.h:42
Data structure representing a rectangle in a two-dimensional coordinate plane.
Definition: AAX_GUITypes.h:99
The interface for a AAX Plug-in's GUI (graphical user interface).
Definition: AAX_IACFEffectGUI.h:86
virtual AAX_Result NotificationReceived(AAX_CTypeID inNotificationType, const void *inNotificationData, uint32_t inNotificationDataSize)=0
Notification Hook.
virtual AAX_Result SetControlHighlightInfo(AAX_CParamID iParameterID, AAX_CBoolean iIsHighlighted, AAX_EHighlightColor iColor)=0
Called by host application. Indicates that a control widget should be updated with a highlight color.
virtual AAX_Result ParameterUpdated(AAX_CParamID inParamID)=0
Notifies the GUI that a parameter value has changed.
virtual AAX_Result Draw(AAX_Rect *iDrawRect)=0
DEPRECATED, Not called from host any longer. Your chosen graphics framework should be directly handli...
virtual AAX_Result SetViewContainer(IACFUnknown *iViewContainer)=0
Provides a handle to the main plug-in window.
virtual AAX_Result GetCustomLabel(AAX_EPlugInStrings iSelector, AAX_IString *oString) const =0
Called by host application to retrieve a custom plug-in string.
virtual AAX_Result Initialize(IACFUnknown *iController)=0
Main GUI initialization.
virtual AAX_Result TimerWakeup()=0
Periodic wakeup callback for idle-time operations.
virtual AAX_Result Uninitialize()=0
Main GUI uninitialization.
virtual AAX_Result GetViewSize(AAX_Point *oViewSize) const =0
Retrieves the size of the plug-in window.
A simple string container that can be passed across a binary boundary. This class,...
Definition: AAX_IString.h:41