AAX_CLogTaperDelegate.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_CLOGTAPERDELEGATE_H
#define AAX_CLOGTAPERDELEGATE_H

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

#include <cmath>    //for floor(), log()



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

private:
    T   mMinValue;
    T   mMaxValue;
};

template <typename T, int32_t RealPrecision>
T   AAX_CLogTaperDelegate<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_CLogTaperDelegate<T, RealPrecision>::AAX_CLogTaperDelegate(T minValue, T maxValue)  :  AAX_ITaperDelegate<T>(),
    mMinValue(minValue),
    mMaxValue(maxValue)
{

}

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

template <typename T, int32_t RealPrecision>
T       AAX_CLogTaperDelegate<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_CLogTaperDelegate<T, RealPrecision>::NormalizedToReal(double normalizedValue) const
{
    double minLog = AAX::SafeLog(double(mMinValue));
    double maxLog = AAX::SafeLog(double(mMaxValue));

    double doubleRealValue = exp(normalizedValue * (maxLog - minLog) + minLog);
    T realValue = (T) doubleRealValue;
    
    return ConstrainRealValue(realValue);
}

template <typename T, int32_t RealPrecision>
double  AAX_CLogTaperDelegate<T, RealPrecision>::RealToNormalized(T realValue) const
{
    double minLog = AAX::SafeLog(double(mMinValue));
    double maxLog = AAX::SafeLog(double(mMaxValue));

    realValue = ConstrainRealValue(realValue);
    double normalizedValue = (AAX::SafeLog(double(realValue)) - minLog) / (maxLog - minLog);
    return normalizedValue;
}
    
#endif // AAX_CLOGTAPERDELEGATE_H