AAX_CLinearTaperDelegate.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_CLINEARTAPERDELEGATE_H
#define AAX_CLINEARTAPERDELEGATE_H

#include "AAX_ITaperDelegate.h"
#include "AAX.h"    //for types

#include <cmath>    //for floor()


template <typename T, int32_t RealPrecision=0>
class AAX_CLinearTaperDelegate : public AAX_ITaperDelegate<T>
{
public: 
    AAX_CLinearTaperDelegate(T minValue=0, T maxValue=1);
    
    //Virtual AAX_ITaperDelegate Overrides
    AAX_CLinearTaperDelegate<T, RealPrecision>* Clone() const;
    T       GetMinimumValue()   const                       { return mMinValue; }
    T       GetMaximumValue()   const                       { return mMaxValue; }
    T       ConstrainRealValue(T value) const;
    virtual T       NormalizedToReal(double normalizedValue) const;
    virtual double  RealToNormalized(T realValue) const;
    
protected:
    T   Round(double iValue) const;

private:
    T   mMinValue;
    T   mMaxValue;
};

template <typename T, int32_t RealPrecision>
T   AAX_CLinearTaperDelegate<T, RealPrecision>::Round(double iValue) const
{
    double precision = RealPrecision;
    if (precision > 0)
        return static_cast<T>(floor(iValue * precision + 0.5) / precision);
    return static_cast<T>(iValue);
}

template <typename T, int32_t RealPrecision>
AAX_CLinearTaperDelegate<T, RealPrecision>::AAX_CLinearTaperDelegate(T minValue, T maxValue)  :  AAX_ITaperDelegate<T>(),
    mMinValue(minValue),
    mMaxValue(maxValue)
{

}

template <typename T, int32_t RealPrecision>
AAX_CLinearTaperDelegate<T, RealPrecision>*     AAX_CLinearTaperDelegate<T, RealPrecision>::Clone() const
{
    return new AAX_CLinearTaperDelegate(*this);
}

template <typename T, int32_t RealPrecision>
T       AAX_CLinearTaperDelegate<T, RealPrecision>::ConstrainRealValue(T value) const
{
    if (RealPrecision)
        value = Round(value);       //reduce the precision to get proper rounding behavior with integers.

    if (value > mMaxValue)
        return mMaxValue;
    if (value < mMinValue)
        return mMinValue;
    return value;       
}

template <typename T, int32_t RealPrecision>
T       AAX_CLinearTaperDelegate<T, RealPrecision>::NormalizedToReal(double normalizedValue) const
{
    double doubleRealValue = normalizedValue * (double(mMaxValue) - double(mMinValue)) + double(mMinValue);
    
    // If RealPrecision is set, reduce the precision to get proper rounding behavior with integers.
    T realValue = (0 != RealPrecision) ? Round(doubleRealValue) : static_cast<T>(doubleRealValue);
    
    return ConstrainRealValue(realValue);
}

template <typename T, int32_t RealPrecision>
double  AAX_CLinearTaperDelegate<T, RealPrecision>::RealToNormalized(T realValue) const
{
    realValue = ConstrainRealValue(realValue);
    double normalizedValue = (double(realValue) - double(mMinValue)) / (double(mMaxValue) - double(mMinValue));
    return normalizedValue;
}
    



#endif //AAX_CLINEARTAPERDELEGATE_H