AAX_IParameter.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_IPARAMETER_H
#define AAX_IPARAMETER_H

#include "AAX.h"    //for types

//Forward Declarations
class AAX_CString;
class AAX_IAutomationDelegate;
class AAX_ITaperDelegateBase;
class AAX_IDisplayDelegateBase;
class AAX_IString;

class AAX_IParameter
{
public: 
    virtual ~AAX_IParameter()           {  }


    virtual AAX_CParamID        Identifier() const = 0;

    virtual void                SetName(const AAX_CString& name) = 0;
    
    virtual const AAX_CString&  Name() const = 0;
    
    virtual void                AddShortenedName(const AAX_CString& name) = 0;
    
    virtual const AAX_CString&  ShortenedName(int32_t iNumCharacters) const = 0;
    
    virtual void                ClearShortenedNames() = 0;  
    
    
    virtual bool        Automatable() const = 0;
    
    virtual void        SetAutomationDelegate( AAX_IAutomationDelegate * iAutomationDelegate ) = 0;
    
    virtual void        Touch() = 0;
    
    virtual void        Release() = 0;
        
    virtual void        SetNormalizedValue(double newNormalizedValue) = 0;  
        
    virtual double      GetNormalizedValue() const = 0;

    virtual void        SetNormalizedDefaultValue(double normalizedDefault) = 0;

    virtual double      GetNormalizedDefaultValue() const = 0;
    
    virtual void        SetToDefaultValue() = 0;

    virtual void        SetNumberOfSteps(uint32_t numSteps) = 0;

    virtual uint32_t    GetNumberOfSteps() const = 0;
    
    virtual uint32_t    GetStepValue() const = 0;
    
    virtual void        SetStepValue(uint32_t iStep) = 0;
        
    
    
    virtual bool        GetValueString(AAX_CString* valueString) const = 0;

    virtual bool        GetValueString(int32_t iMaxNumChars, AAX_CString*   valueString) const = 0;
    
    virtual bool        GetNormalizedValueFromString(const AAX_CString& valueString, double *normalizedValue) const = 0;

    virtual bool        GetStringFromNormalizedValue(double normalizedValue, AAX_CString&   valueString) const = 0;

    virtual bool        GetStringFromNormalizedValue(double normalizedValue, int32_t iMaxNumChars, AAX_CString& valueString) const = 0;
    
    virtual bool        SetValueFromString(const AAX_CString&   newValueString) = 0;
    
    virtual bool        GetValueAsBool(bool* value) const = 0;
    
    virtual bool        GetValueAsInt32(int32_t* value) const = 0;

    virtual bool        GetValueAsFloat(float* value) const = 0;

    virtual bool        GetValueAsDouble(double* value) const = 0;
    
    virtual bool        GetValueAsString(AAX_IString* value) const = 0;

    virtual bool        SetValueWithBool(bool value) = 0;

    virtual bool        SetValueWithInt32(int32_t value) = 0;
        
    virtual bool        SetValueWithFloat(float value) = 0;
    
    virtual bool        SetValueWithDouble(double value) = 0;

    virtual bool        SetValueWithString(const AAX_IString& value) = 0;


    virtual void        SetType( AAX_EParameterType iControlType ) = 0;
    
    virtual AAX_EParameterType  GetType() const = 0;

    
    virtual void        SetOrientation( AAX_EParameterOrientation iOrientation ) = 0;
    
    virtual AAX_EParameterOrientation   GetOrientation() const = 0;
    
    virtual void SetTaperDelegate ( AAX_ITaperDelegateBase & iTaperDelegate, bool iPreserveValue ) = 0;
    virtual void SetDisplayDelegate ( AAX_IDisplayDelegateBase & iDisplayDelegate ) = 0;

public:
    virtual void        UpdateNormalizedValue(double newNormalizedValue) = 0;
        
};

#endif //AAX_IPARAMETER_H