AAX_IParameter.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2013-2017, 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_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_IParameterValue
{
public:
    virtual ~AAX_IParameterValue()          {  }
    
    virtual AAX_IParameterValue*        Clone() const = 0;
    
    virtual AAX_CParamID                Identifier() const = 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;
};
 
class AAX_IParameter
{
public: 
    virtual ~AAX_IParameter()           {  }
    
    virtual AAX_IParameterValue*    CloneValue() const = 0;
    
    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 double      GetNormalizedValueFromStep(uint32_t iStep) const = 0;
    
    virtual uint32_t    GetStepValueFromNormalizedValue(double normalizedValue) 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        GetNormalizedValueFromBool(bool value, double *normalizedValue) const = 0;
    
    virtual bool        GetNormalizedValueFromInt32(int32_t value, double *normalizedValue) const = 0;
    
    virtual bool        GetNormalizedValueFromFloat(float value, double *normalizedValue) const = 0;
    
    virtual bool        GetNormalizedValueFromDouble(double value, double *normalizedValue) const = 0;
    
    virtual bool        GetNormalizedValueFromString(const AAX_CString& valueString, double *normalizedValue) const = 0;
    
    virtual bool        GetBoolFromNormalizedValue(double normalizedValue, bool* value) const = 0;
    
    virtual bool        GetInt32FromNormalizedValue(double normalizedValue, int32_t* value) const = 0;
    
    virtual bool        GetFloatFromNormalizedValue(double normalizedValue, float* value) const = 0;
    
    virtual bool        GetDoubleFromNormalizedValue(double normalizedValue, double* value) 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 & inTaperDelegate, bool inPreserveValue ) = 0;
 
    virtual void SetDisplayDelegate ( AAX_IDisplayDelegateBase & inDisplayDelegate ) = 0;
 
public:
    virtual void        UpdateNormalizedValue(double newNormalizedValue) = 0;
        
};
 
#endif //AAX_IPARAMETER_H