How about this for juce_NormalisableRange.h ?
It should still preserve existing behaviour but adds true log behaviour…
/*
==============================================================================
This file is part of the juce_core module of the JUCE library.
Copyright (c) 2015 - ROLI Ltd.
Permission to use, copy, modify, and/or distribute this software for any purpose with
or without fee is hereby granted, provided that the above copyright notice and this
permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
------------------------------------------------------------------------------
NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
All other JUCE modules are covered by a dual GPL/commercial license, so if you are
using any other modules, be sure to check that you also comply with their license.
For more details, visit www.juce.com
==============================================================================
*/
#ifndef JUCE_NORMALISABLERANGE_H_INCLUDED
#define JUCE_NORMALISABLERANGE_H_INCLUDED
//==============================================================================
/**
Represents a mapping between an arbitrary range of values and a
normalised 0->1 range.
The properties of the mapping also include an optional snapping interval
and skew-factor.
@see Range
*/
template <typename ValueType>
class NormalisableRange
{
public:
/** Creates a continuous range that performs a dummy mapping. */
NormalisableRange() noexcept : start(), end (1), interval(), skew (static_cast<ValueType> (1)), skewLog (static_cast<ValueType> (0)) {}
/** Creates a copy of another range. */
NormalisableRange (const NormalisableRange& other) noexcept
: start (other.start), end (other.end),
interval (other.interval), skew (other.skew), skewLog (other.skewLog)
{
checkInvariants();
}
/** Creates a copy of another range. */
NormalisableRange& operator= (const NormalisableRange& other) noexcept
{
start = other.start;
end = other.end;
interval = other.interval;
skew = other.skew;
skewLog = other.skewLog;
checkInvariants();
return *this;
}
/** Creates a NormalisableRange with a given range, interval and skew factor. */
NormalisableRange (ValueType rangeStart,
ValueType rangeEnd,
ValueType intervalValue,
ValueType skewFactor,
ValueType skewLogFactor = 0) noexcept
: start (rangeStart), end (rangeEnd),
interval (intervalValue), skew (skewFactor), skewLog (skewLogFactor)
{
checkInvariants();
}
/** Creates a NormalisableRange with a given range and interval, but dummy skew-factors. */
NormalisableRange (ValueType rangeStart,
ValueType rangeEnd,
ValueType intervalValue) noexcept
: start (rangeStart), end (rangeEnd),
interval (intervalValue), skew (static_cast<ValueType> (1)), skewLog (static_cast<ValueType> (0))
{
checkInvariants();
}
/** Creates a NormalisableRange with a given range, continuous interval, but a dummy skew-factor. */
NormalisableRange (ValueType rangeStart,
ValueType rangeEnd) noexcept
: start (rangeStart), end (rangeEnd),
interval(), skew (static_cast<ValueType> (1)), skewLog (static_cast<ValueType> (0))
{
checkInvariants();
}
/** Uses the properties of this mapping to convert a non-normalised value to
its 0->1 representation.
*/
ValueType convertTo0to1 (ValueType v) const noexcept
{
ValueType proportion = (v - start) / (end - start);
if (skew != static_cast<ValueType> (1) && skewLog == static_cast<ValueType>(0))
proportion = std::pow (proportion, skew);
if (skewLog != static_cast<ValueType> (0))
{
const ValueType one = static_cast<ValueType> (1.0);
const ValueType ten = static_cast<ValueType> (10.0);
const ValueType tenPowSkewLog = std::pow (ten, skewLog);
proportion = (std::log10 ((proportion * (tenPowSkewLog - one)) + one)) / std::log10 (tenPowSkewLog);
}
return proportion;
}
/** Uses the properties of this mapping to convert a normalised 0->1 value to
its full-range representation.
*/
ValueType convertFrom0to1 (ValueType proportion) const noexcept
{
if (skew != static_cast<ValueType> (1) && proportion > ValueType() && skewLog == static_cast<ValueType>(0))
proportion = std::exp (std::log (proportion) / skew);
if (skewLog != static_cast<ValueType> (0))
{
const ValueType one = static_cast<ValueType> (1.0);
const ValueType ten = static_cast<ValueType> (10.0);
const ValueType tenPowSkewLog = std::pow (ten, skewLog);
proportion = (std::pow (tenPowSkewLog, proportion) - one) / (tenPowSkewLog - one);
}
return start + (end - start) * proportion;
}
/** Takes a non-normalised value and snaps it based on the interval property of
this NormalisedRange. */
ValueType snapToLegalValue (ValueType v) const noexcept
{
if (interval > ValueType())
v = start + interval * std::floor ((v - start) / interval + static_cast<ValueType> (0.5));
if (v <= start || end <= start)
return start;
if (v >= end)
return end;
return v;
}
Range<ValueType> getRange() const noexcept { return Range<ValueType> (start, end); }
/** The start of the non-normalised range. */
ValueType start;
/** The end of the non-normalised range. */
ValueType end;
/** The snapping interval that should be used (in non-normalised value). Use 0 for a continuous range. */
ValueType interval;
/** An optional skew factor that alters the way values are distribute across the range.
The skew factor lets you skew the mapping logarithmically so that larger or smaller
values are given a larger proportion of the available space.
A factor of 1.0 has no skewing effect at all. If the factor is < 1.0, the lower end
of the range will fill more of the slider's length; if the factor is > 1.0, the upper
end of the range will be expanded.
*/
ValueType skew;
/** If this skew factor is set the other is ignored. Uses a more computationally expensive
calculation but is more accurate for things like decade based frequency scales.
A factor of 1.0 will have 1 log decade per scale, 2.0 will give 2 etc. A factor of -1.0
will be the inverse of +1.0. A factor of 0.0 will skip calculation allowing regular
skew or linear behaviour.
For a 3 decade Hz frequency scale, start and end should be 20 and 20000 respectively and
skewLog should be set to 3.0.
*/
ValueType skewLog;
private:
void checkInvariants() const
{
jassert (end > start);
jassert (interval >= ValueType());
jassert (skew > ValueType());
}
};
#endif // JUCE_NORMALISABLERANGE_H_INCLUDED
Here’s a rough of the equations used in the conversion methods…
www.Desmos.com/calculator doesn’t support link sharing but here’s the new behaviour in green vs. current JUCE behaviour in blue…