AAX_CLinearTaperDelegate.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2013-2017, 2019, 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_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 AAX_OVERRIDE;
    T       GetMinimumValue()   const AAX_OVERRIDE          { return mMinValue; }
    T       GetMaximumValue()   const AAX_OVERRIDE          { return mMaxValue; }
    T       ConstrainRealValue(T value) const AAX_OVERRIDE;
    T       NormalizedToReal(double normalizedValue) const AAX_OVERRIDE;
    double  RealToNormalized(T realValue) const AAX_OVERRIDE;
    
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 (mMinValue == mMaxValue)
        return mMinValue;
    
    if (RealPrecision)
        value = Round(value);       //reduce the precision to get proper rounding behavior with integers.
    
    const T& highValue = mMaxValue > mMinValue ? mMaxValue : mMinValue;
    const T& lowValue = mMaxValue > mMinValue ? mMinValue : mMaxValue;
    
    if (value > highValue)
        return highValue;
    if (value < lowValue)
        return lowValue;
    
    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 = (mMaxValue == mMinValue) ? 0.5 : (double(realValue) - double(mMinValue)) / (double(mMaxValue) - double(mMinValue));
    return normalizedValue;
}
    
 
 
 
#endif //AAX_CLINEARTAPERDELEGATE_H