\hypertarget{a00422_source}{}\doxysection{AAX\+\_\+\+CEffect\+GUI.\+h}
\label{a00422_source}\index{AAX\_CEffectGUI.h@{AAX\_CEffectGUI.h}}
\mbox{\hyperlink{a00422}{Go to the documentation of this file.}}
\begin{DoxyCode}{0}
\DoxyCodeLine{00001\ \textcolor{comment}{/*================================================================================================*/}}
\DoxyCodeLine{00002\ \textcolor{comment}{/*}}
\DoxyCodeLine{00003\ \textcolor{comment}{\ *}}
\DoxyCodeLine{00004\ \textcolor{comment}{\ *\ \ Copyright\ 2013-\/2017,\ 2019,\ 2023-\/2024\ Avid\ Technology,\ Inc.}}
\DoxyCodeLine{00005\ \textcolor{comment}{\ *\ \ All\ rights\ reserved.}}
\DoxyCodeLine{00006\ \textcolor{comment}{\ *\ \ }}
\DoxyCodeLine{00007\ \textcolor{comment}{\ *\ \ This\ file\ is\ part\ of\ the\ Avid\ AAX\ SDK.}}
\DoxyCodeLine{00008\ \textcolor{comment}{\ *\ \ }}
\DoxyCodeLine{00009\ \textcolor{comment}{\ *\ \ The\ AAX\ SDK\ is\ subject\ to\ commercial\ or\ open-\/source\ licensing.}}
\DoxyCodeLine{00010\ \textcolor{comment}{\ *\ \ }}
\DoxyCodeLine{00011\ \textcolor{comment}{\ *\ \ By\ using\ the\ AAX\ SDK,\ you\ agree\ to\ the\ terms\ of\ both\ the\ Avid\ AAX\ SDK\ License}}
\DoxyCodeLine{00012\ \textcolor{comment}{\ *\ \ Agreement\ and\ Avid\ Privacy\ Policy.}}
\DoxyCodeLine{00013\ \textcolor{comment}{\ *\ \ }}
\DoxyCodeLine{00014\ \textcolor{comment}{\ *\ \ AAX\ SDK\ License:\ https://developer.avid.com/aax}}
\DoxyCodeLine{00015\ \textcolor{comment}{\ *\ \ Privacy\ Policy:\ https://www.avid.com/legal/privacy-\/policy-\/statement}}
\DoxyCodeLine{00016\ \textcolor{comment}{\ *\ \ }}
\DoxyCodeLine{00017\ \textcolor{comment}{\ *\ \ Or:\ You\ may\ also\ use\ this\ code\ under\ the\ terms\ of\ the\ GPL\ v3\ (see}}
\DoxyCodeLine{00018\ \textcolor{comment}{\ *\ \ www.gnu.org/licenses).}}
\DoxyCodeLine{00019\ \textcolor{comment}{\ *\ \ }}
\DoxyCodeLine{00020\ \textcolor{comment}{\ *\ \ THE\ AAX\ SDK\ IS\ PROVIDED\ "{}AS\ IS"{}\ WITHOUT\ ANY\ WARRANTY,\ AND\ ALL\ WARRANTIES,\ WHETHER}}
\DoxyCodeLine{00021\ \textcolor{comment}{\ *\ \ EXPRESSED\ OR\ IMPLIED,\ INCLUDING\ MERCHANTABILITY\ AND\ FITNESS\ FOR\ PURPOSE,\ ARE}}
\DoxyCodeLine{00022\ \textcolor{comment}{\ *\ \ DISCLAIMED.}}
\DoxyCodeLine{00023\ \textcolor{comment}{\ *}}
\DoxyCodeLine{00024\ \textcolor{comment}{\ */}}
\DoxyCodeLine{00025\ }
\DoxyCodeLine{00032\ \textcolor{comment}{/*================================================================================================*/}}
\DoxyCodeLine{00033\ }
\DoxyCodeLine{00034\ }
\DoxyCodeLine{00035\ \textcolor{preprocessor}{\#ifndef\ AAX\_CEFFECTGUI\_H}}
\DoxyCodeLine{00036\ \textcolor{preprocessor}{\#define\ AAX\_CEFFECTGUI\_H}}
\DoxyCodeLine{00037\ }
\DoxyCodeLine{00038\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{a00593}{AAX\_IEffectGUI.h}}"{}}}
\DoxyCodeLine{00039\ \textcolor{preprocessor}{\#include\ "{}\mbox{\hyperlink{a00767}{AAX\_IACFEffectParameters.h}}"{}}}
\DoxyCodeLine{00040\ }
\DoxyCodeLine{00041\ \textcolor{preprocessor}{\#include\ <string>}}
\DoxyCodeLine{00042\ \textcolor{preprocessor}{\#include\ <vector>}}
\DoxyCodeLine{00043\ \textcolor{preprocessor}{\#include\ <map>}}
\DoxyCodeLine{00044\ \textcolor{preprocessor}{\#include\ <memory>}}
\DoxyCodeLine{00045\ }
\DoxyCodeLine{00046\ }
\DoxyCodeLine{00047\ \textcolor{keyword}{class\ }\mbox{\hyperlink{a02266}{AAX\_IEffectParameters}};}
\DoxyCodeLine{00048\ \textcolor{keyword}{class\ }\mbox{\hyperlink{a02222}{AAX\_IController}};}
\DoxyCodeLine{00049\ \textcolor{keyword}{class\ }\mbox{\hyperlink{a02354}{AAX\_IViewContainer}};}
\DoxyCodeLine{00050\ \textcolor{keyword}{class\ }\mbox{\hyperlink{a02350}{AAX\_ITransport}};}
\DoxyCodeLine{00051\ }
\DoxyCodeLine{00052\ }
\DoxyCodeLine{00053\ }
\DoxyCodeLine{00067\ \textcolor{keyword}{class\ }\mbox{\hyperlink{a01846}{AAX\_CEffectGUI}}\ :\ \ \ \ \textcolor{keyword}{public}\ \mbox{\hyperlink{a02262}{AAX\_IEffectGUI}}}
\DoxyCodeLine{00068\ \{}
\DoxyCodeLine{00069\ \textcolor{keyword}{public}:\ }
\DoxyCodeLine{00070\ }
\DoxyCodeLine{00071\ \ \ \ \ \mbox{\hyperlink{a01846_aff1112d89b87c0eaa94b9ed149134ce6}{AAX\_CEffectGUI}}(\textcolor{keywordtype}{void});}
\DoxyCodeLine{00072\ \ \ \ \ \mbox{\hyperlink{a01846_a2cc9b45d561a1dee0b540ef771e5a016}{\string~AAX\_CEffectGUI}}(\textcolor{keywordtype}{void})\ \mbox{\hyperlink{a00542_ac2f24a5172689ae684344abdcce55463}{AAX\_OVERRIDE}};}
\DoxyCodeLine{00073\ }
\DoxyCodeLine{00074\ \textcolor{keyword}{public}:\ }
\DoxyCodeLine{00075\ }
\DoxyCodeLine{00079\ \ \ \ \ \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\_Result}}\ \ \ \ \mbox{\hyperlink{a01846_a5fcb43bfa54847abe95c2ff76cc6cb13}{Initialize}}\ (\mbox{\hyperlink{a01770}{IACFUnknown}}\ *\ iController\ )\ \mbox{\hyperlink{a00542_ac2f24a5172689ae684344abdcce55463}{AAX\_OVERRIDE}};}
\DoxyCodeLine{00080\ \ \ \ \ \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\_Result}}\ \ \ \ \mbox{\hyperlink{a01846_a7d3230457433a1a8204114e57fef7bef}{Uninitialize}}\ (\textcolor{keywordtype}{void})\ \mbox{\hyperlink{a00542_ac2f24a5172689ae684344abdcce55463}{AAX\_OVERRIDE}};}
\DoxyCodeLine{00082\ }
\DoxyCodeLine{00092\ \ \ \ \ \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\_Result}}\ \ \ \ \mbox{\hyperlink{a01846_af00b27d16a45bccf632a445491c56833}{NotificationReceived}}(\mbox{\hyperlink{a00542_ac678f9c1fbcc26315d209f71a147a175}{AAX\_CTypeID}}\ inNotificationType,\ \textcolor{keyword}{const}\ \textcolor{keywordtype}{void}\ *\ inNotificationData,\ uint32\_t\ inNotificationDataSize)\ \mbox{\hyperlink{a00542_ac2f24a5172689ae684344abdcce55463}{AAX\_OVERRIDE}};}
\DoxyCodeLine{00094\ \ \ \ \ }
\DoxyCodeLine{00098\ \ \ \ \ \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\_Result}}\ \mbox{\hyperlink{a01846_a5ba8d0cf5326583ed9e2a4b9752e4287}{SetViewContainer}}\ (\mbox{\hyperlink{a01770}{IACFUnknown}}\ *\ iViewContainer\ )\ \mbox{\hyperlink{a00542_ac2f24a5172689ae684344abdcce55463}{AAX\_OVERRIDE}};}
\DoxyCodeLine{00099\ \ \ \ \ \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\_Result}}\ \mbox{\hyperlink{a01846_a23c51648957128cf563b31e1a5fbc249}{GetViewSize}}\ (\mbox{\hyperlink{a01998}{AAX\_Point}}\ *\ \textcolor{comment}{/*\ oViewSize\ */}\ )\ \textcolor{keyword}{const}\ \mbox{\hyperlink{a00542_ac2f24a5172689ae684344abdcce55463}{AAX\_OVERRIDE}}}
\DoxyCodeLine{00100\ \ \ \ \ \{}
\DoxyCodeLine{00101\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{a00539_a5f8c7439f3a706c4f8315a9609811937aeddbd1bb67e3a66e6af54a4b4a7a57b3}{AAX\_SUCCESS}};}
\DoxyCodeLine{00102\ \ \ \ \ \}}
\DoxyCodeLine{00104\ }
\DoxyCodeLine{00108\ \ \ \ \ \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\_Result}}\ \mbox{\hyperlink{a01846_a7a6e6ffea34c7c85f6e3d00bb6e564e0}{Draw}}\ (\mbox{\hyperlink{a02002}{AAX\_Rect}}\ *\ \textcolor{comment}{/*\ iDrawRect\ */}\ )\ \mbox{\hyperlink{a00542_ac2f24a5172689ae684344abdcce55463}{AAX\_OVERRIDE}}}
\DoxyCodeLine{00109\ \ \ \ \ \{}
\DoxyCodeLine{00110\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{a00539_a5f8c7439f3a706c4f8315a9609811937aeddbd1bb67e3a66e6af54a4b4a7a57b3}{AAX\_SUCCESS}};}
\DoxyCodeLine{00111\ \ \ \ \ \}}
\DoxyCodeLine{00112\ \ \ \ \ \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\_Result}}\ \mbox{\hyperlink{a01846_a0b7bada7e7d72da637bde2daa79f71ee}{TimerWakeup}}\ (\textcolor{keywordtype}{void})\ \mbox{\hyperlink{a00542_ac2f24a5172689ae684344abdcce55463}{AAX\_OVERRIDE}}}
\DoxyCodeLine{00113\ \ \ \ \ \{}
\DoxyCodeLine{00114\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{a00539_a5f8c7439f3a706c4f8315a9609811937aeddbd1bb67e3a66e6af54a4b4a7a57b3}{AAX\_SUCCESS}};}
\DoxyCodeLine{00115\ \ \ \ \ \}}
\DoxyCodeLine{00116\ \ \ \ \ \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\_Result}}\ \mbox{\hyperlink{a01846_aa86943fbaf8920b533ea31a7669fb009}{ParameterUpdated}}(\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\_CParamID}}\ paramID)\ \mbox{\hyperlink{a00542_ac2f24a5172689ae684344abdcce55463}{AAX\_OVERRIDE}};}
\DoxyCodeLine{00118\ \ \ \ \ }
\DoxyCodeLine{00124\ \ \ \ \ \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\_Result}}\ \ \ \ \ \ \ \ \mbox{\hyperlink{a01846_aa903a721baf5a5cfd0b959d0d8dbb874}{GetCustomLabel}}\ (\ \mbox{\hyperlink{a00446_a86f7310877399d9d4d2ea4863d472476}{AAX\_EPlugInStrings}}\ iSelector,\ \mbox{\hyperlink{a02330}{AAX\_IString}}\ *\ oString\ )\ \textcolor{keyword}{const}\ \mbox{\hyperlink{a00542_ac2f24a5172689ae684344abdcce55463}{AAX\_OVERRIDE}};}
\DoxyCodeLine{00125\ }
\DoxyCodeLine{00126\ \ \ \ \ \mbox{\hyperlink{a00542_a4d8f69a697df7f70c3a8e9b8ee130d2f}{AAX\_Result}}\ \mbox{\hyperlink{a01846_ab2080eb028030b8f180b9e3a39606ca7}{SetControlHighlightInfo}}\ (\mbox{\hyperlink{a00542_a1440c756fe5cb158b78193b2fc1780d1}{AAX\_CParamID}}\ \textcolor{comment}{/*\ iParameterID\ */},\ \mbox{\hyperlink{a00542_aa216506530f1d19a2965931ced2b274b}{AAX\_CBoolean}}\ \textcolor{comment}{/*\ iIsHighlighted\ */},\ \mbox{\hyperlink{a00446_a143056a07989a48e5db3a101f1b12567}{AAX\_EHighlightColor}}\ \textcolor{comment}{/*\ iColor\ */})\ \mbox{\hyperlink{a00542_ac2f24a5172689ae684344abdcce55463}{AAX\_OVERRIDE}}}
\DoxyCodeLine{00127\ \ \ \ \ \{}
\DoxyCodeLine{00128\ \ \ \ \ \ \ \ \ \textcolor{keywordflow}{return}\ \mbox{\hyperlink{a00539_a5f8c7439f3a706c4f8315a9609811937aeddbd1bb67e3a66e6af54a4b4a7a57b3}{AAX\_SUCCESS}};}
\DoxyCodeLine{00129\ \ \ \ \ \}}
\DoxyCodeLine{00131\ }
\DoxyCodeLine{00132\ \textcolor{keyword}{protected}:\ }
\DoxyCodeLine{00133\ }
\DoxyCodeLine{00147\ \ \ \ \ \textcolor{keyword}{virtual}\ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{a01846_ab84514feda09e4893ee0ff5e6df99b23}{CreateViewContents}}\ (\textcolor{keywordtype}{void})\ =\ 0;}
\DoxyCodeLine{00154\ \ \ \ \ \textcolor{keyword}{virtual}\ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{a01846_adbc45d3155099452ca746ee3940f16da}{CreateViewContainer}}\ (\textcolor{keywordtype}{void})\ =\ 0;}
\DoxyCodeLine{00162\ \ \ \ \ \textcolor{keyword}{virtual}\ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{a01846_a56632ebf59c5ef3f4fe3d7d76da27a37}{DeleteViewContainer}}\ (\textcolor{keywordtype}{void})\ =\ 0;}
\DoxyCodeLine{00164\ \ \ \ \ }
\DoxyCodeLine{00179\ \ \ \ \ \textcolor{keyword}{virtual}\ \textcolor{keywordtype}{void}\ \mbox{\hyperlink{a01846_a172074a301ac9c771443b4b63a5b426b}{UpdateAllParameters}}\ (\textcolor{keywordtype}{void});}
\DoxyCodeLine{00181\ }
\DoxyCodeLine{00182\ \textcolor{keyword}{public}:\ \ \textcolor{comment}{//These\ accessors\ are\ public\ here\ as\ they\ are\ often\ needed\ by\ contained\ views.}}
\DoxyCodeLine{00183\ \ \ \ \ }
\DoxyCodeLine{00191\ \ \ \ \ \mbox{\hyperlink{a02222}{AAX\_IController}}*\ \mbox{\hyperlink{a01846_a595840313e1c5ac83b5e4e245e2e6038}{GetController}}\ (\textcolor{keywordtype}{void});}
\DoxyCodeLine{00192\ \ \ \ \ \textcolor{keyword}{const}\ \mbox{\hyperlink{a02222}{AAX\_IController}}*\ \mbox{\hyperlink{a01846_a7e001f4cc288d5f2a6b432d1e478fd2d}{GetController}}\ (\textcolor{keywordtype}{void})\ \textcolor{keyword}{const};}
\DoxyCodeLine{00193\ \ \ \ \ }
\DoxyCodeLine{00198\ \ \ \ \ \mbox{\hyperlink{a02266}{AAX\_IEffectParameters}}*\ \mbox{\hyperlink{a01846_add67c9485b4c5cc9d08e286e53920f08}{GetEffectParameters}}\ (\textcolor{keywordtype}{void});}
\DoxyCodeLine{00199\ \ \ \ \ \textcolor{keyword}{const}\ \mbox{\hyperlink{a02266}{AAX\_IEffectParameters}}*\ \mbox{\hyperlink{a01846_a40be038b6d1f951ad4067652b52de894}{GetEffectParameters}}\ (\textcolor{keywordtype}{void})\ \textcolor{keyword}{const};}
\DoxyCodeLine{00200\ \ \ \ \ }
\DoxyCodeLine{00205\ \ \ \ \ \mbox{\hyperlink{a02354}{AAX\_IViewContainer}}*\ \mbox{\hyperlink{a01846_a97de106668e82a9790d43fb253609761}{GetViewContainer}}\ (\textcolor{keywordtype}{void});}
\DoxyCodeLine{00206\ \ \ \ \ \textcolor{keyword}{const}\ \mbox{\hyperlink{a02354}{AAX\_IViewContainer}}*\ \mbox{\hyperlink{a01846_a89d5e5a09db1180e797d12b06e97ab51}{GetViewContainer}}\ (\textcolor{keywordtype}{void})\ \textcolor{keyword}{const};}
\DoxyCodeLine{00207\ \ \ \ \ }
\DoxyCodeLine{00212\ \ \ \ \ \mbox{\hyperlink{a02350}{AAX\_ITransport}}*\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{a01846_a9bd4921e711d9ca56da93fb8a2974050}{Transport}}();}
\DoxyCodeLine{00213\ \ \ \ \ \textcolor{keyword}{const}\ \mbox{\hyperlink{a02350}{AAX\_ITransport}}*\ \ \ \ \ \mbox{\hyperlink{a01846_afb9c7fd2a00f7d66011ba93aa439180a}{Transport}}()\ \textcolor{keyword}{const};}
\DoxyCodeLine{00214\ \ \ \ \ }
\DoxyCodeLine{00219\ \ \ \ \ \mbox{\hyperlink{a00428_a89d5cb8c7fdb11f34e695fb0e057b764}{AAX\_EViewContainer\_Type}}\ \ \ \ \ \ \mbox{\hyperlink{a01846_a010cc00926a3d219fa4de47ac182eb9b}{GetViewContainerType}}\ ();}
\DoxyCodeLine{00220\ \ \ \ \ \textcolor{keywordtype}{void}\ *\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \mbox{\hyperlink{a01846_a5805bceec57ce532c688c0423dcbeb74}{GetViewContainerPtr}}\ ();\ \ }
\DoxyCodeLine{00222\ }
\DoxyCodeLine{00223\ \textcolor{keyword}{private}:}
\DoxyCodeLine{00224\ \ \ \ \ \textcolor{comment}{//These\ are\ private,\ but\ they\ all\ have\ protected\ accessors.\ }}
\DoxyCodeLine{00225\ \ \ \ \ \mbox{\hyperlink{a02222}{AAX\_IController}}\ *\ \ \ \ \ \ \ \ \ \ \ \ mController;}
\DoxyCodeLine{00226\ \ \ \ \ \mbox{\hyperlink{a02266}{AAX\_IEffectParameters}}\ *\ \ \ \ \ \ \ \ mEffectParameters;}
\DoxyCodeLine{00227\ \ \ \ \ \mbox{\hyperlink{a00542_a0a58bb9dab931dfe26d8edeb4e5e6319}{AAX\_UNIQUE\_PTR}}(\mbox{\hyperlink{a02354}{AAX\_IViewContainer}})\ \ mViewContainer;}
\DoxyCodeLine{00228\ \ \ \ \ \mbox{\hyperlink{a02350}{AAX\_ITransport}}*\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ mTransport;}
\DoxyCodeLine{00229\ \};}
\DoxyCodeLine{00230\ }
\DoxyCodeLine{00231\ }
\DoxyCodeLine{00232\ \textcolor{preprocessor}{\#endif}}

\end{DoxyCode}
