AAX_CEffectGUI.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2013-2017, 2019, 2023-2024 Avid Technology, Inc.
 *  All rights reserved.
 *  
 *  This file is part of the Avid AAX SDK.
 *  
 *  The AAX SDK is subject to commercial or open-source licensing.
 *  
 *  By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
 *  Agreement and Avid Privacy Policy.
 *  
 *  AAX SDK License: https://developer.avid.com/aax
 *  Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
 *  
 *  Or: You may also use this code under the terms of the GPL v3 (see
 *  www.gnu.org/licenses).
 *  
 *  THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
 *  EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
 *  DISCLAIMED.
 *
 */
 
/*================================================================================================*/
 
 
#ifndef AAX_CEFFECTGUI_H
#define AAX_CEFFECTGUI_H
 
#include "AAX_IEffectGUI.h"
#include "AAX_IACFEffectParameters.h"
 
#include <string>
#include <vector>
#include <map>
#include <memory>
 
 
class AAX_IEffectParameters;
class AAX_IController;
class AAX_IViewContainer;
class AAX_ITransport;
 
 
 
class AAX_CEffectGUI :  public AAX_IEffectGUI
{
public: 
 
    AAX_CEffectGUI(void);
    ~AAX_CEffectGUI(void) AAX_OVERRIDE;
 
public: 
 
    AAX_Result  Initialize (IACFUnknown * iController ) AAX_OVERRIDE;
    AAX_Result  Uninitialize (void) AAX_OVERRIDE;
 
    AAX_Result  NotificationReceived(AAX_CTypeID inNotificationType, const void * inNotificationData, uint32_t inNotificationDataSize) AAX_OVERRIDE;
    
    AAX_Result SetViewContainer (IACFUnknown * iViewContainer ) AAX_OVERRIDE;
    AAX_Result GetViewSize (AAX_Point * /* oViewSize */ ) const AAX_OVERRIDE
    {
        return AAX_SUCCESS;
    }
 
    AAX_Result Draw (AAX_Rect * /* iDrawRect */ ) AAX_OVERRIDE
    {
        return AAX_SUCCESS;
    }
    AAX_Result TimerWakeup (void) AAX_OVERRIDE
    {
        return AAX_SUCCESS;
    }
    AAX_Result ParameterUpdated(AAX_CParamID paramID) AAX_OVERRIDE;
    
    AAX_Result      GetCustomLabel ( AAX_EPlugInStrings iSelector, AAX_IString * oString ) const AAX_OVERRIDE;
 
    AAX_Result SetControlHighlightInfo (AAX_CParamID /* iParameterID */, AAX_CBoolean /* iIsHighlighted */, AAX_EHighlightColor /* iColor */) AAX_OVERRIDE
    {
        return AAX_SUCCESS;
    }
 
protected: 
 
    virtual void CreateViewContents (void) = 0;
    virtual void CreateViewContainer (void) = 0;
    virtual void DeleteViewContainer (void) = 0;
    
    virtual void UpdateAllParameters (void);
 
public:  //These accessors are public here as they are often needed by contained views.
    
    AAX_IController* GetController (void);
    const AAX_IController* GetController (void) const;
    
    AAX_IEffectParameters* GetEffectParameters (void);
    const AAX_IEffectParameters* GetEffectParameters (void) const;
    
    AAX_IViewContainer* GetViewContainer (void);
    const AAX_IViewContainer* GetViewContainer (void) const;
    
    AAX_ITransport*             Transport();
    const AAX_ITransport*       Transport() const;
    
    AAX_EViewContainer_Type     GetViewContainerType ();
    void *                      GetViewContainerPtr (); 
 
private:
    //These are private, but they all have protected accessors. 
    AAX_IController *           mController;
    AAX_IEffectParameters *     mEffectParameters;
    AAX_UNIQUE_PTR(AAX_IViewContainer)  mViewContainer;
    AAX_ITransport*             mTransport;
};
 
 
#endif