AAX_CEffectGUI.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2013 by Avid Technology, Inc.
 *  All rights reserved.
 *  
 *  CONFIDENTIAL: This document contains confidential information.  Do not 
 *  read or examine this document unless you are an Avid Technology employee
 *  or have signed a non-disclosure agreement with Avid Technology which protects
 *  the confidentiality of this document.  DO NOT DISCLOSE ANY INFORMATION 
 *  CONTAINED IN THIS DOCUMENT TO ANY THIRD-PARTY WITHOUT THE PRIOR WRITTEN CONSENT 
 *  OF Avid Technolgy, INC.
 *
 */

/*================================================================================================*/


#ifndef AAX_CEFFECTGUI_H
#define AAX_CEFFECTGUI_H

#include "AAX_IEffectGUI.h"
#include "AAX_IACFEffectParameters.h"

#include <string>
#include <vector>
#include <map>


class AAX_IEffectParameters;
class AAX_IController;
class AAX_IViewContainer;
class AAX_ITransport;



class AAX_CEffectGUI :  public AAX_IEffectGUI
{
public: 

    AAX_CEffectGUI(void);
    virtual ~AAX_CEffectGUI(void);

public: 

    virtual AAX_Result  Initialize (IACFUnknown * iController );
    virtual AAX_Result  Uninitialize (void);

    virtual AAX_Result  NotificationReceived(AAX_CTypeID iNotificationType, const void * iNotificationData, uint32_t iNotificationDataSize);    
    
    virtual AAX_Result SetViewContainer (IACFUnknown * iViewContainer );
    virtual AAX_Result GetViewSize (AAX_Point * /* oViewSize */ ) const
    {
        return AAX_SUCCESS;
    }

    virtual AAX_Result Draw (AAX_Rect * /* iDrawRect */ )
    {
        return AAX_SUCCESS;
    }
    virtual AAX_Result TimerWakeup (void)
    {
        return AAX_SUCCESS;
    }
    virtual AAX_Result ParameterUpdated(AAX_CParamID paramID);  
    
    virtual AAX_Result      GetCustomLabel ( AAX_EPlugInStrings iSelector, AAX_IString * oString ) const;

    virtual AAX_Result SetControlHighlightInfo (AAX_CParamID /* iParameterID */, AAX_CBoolean /* iIsHighlighted */, AAX_EHighlightColor /* iColor */) 
    {
        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_IViewContainer *        mViewContainer;
    AAX_ITransport*             mTransport;
};


#endif