NormalisableRange< ValueType > Class Template Reference

Represents a mapping between an arbitrary range of values and a normalised 0->1 range. More...

Public Types
using	ValueRemapFunction
	A function object which can remap a value in some way based on the start and end of a range.

Public Member Functions
	NormalisableRange ()=default
	Creates a continuous range that performs a dummy mapping.
	NormalisableRange (const NormalisableRange &)=default
NormalisableRange &	operator= (const NormalisableRange &)=default
	NormalisableRange (NormalisableRange &&)=default
NormalisableRange &	operator= (NormalisableRange &&)=default
	NormalisableRange (ValueType rangeStart, ValueType rangeEnd, ValueType intervalValue, ValueType skewFactor, bool useSymmetricSkew=false) noexcept
	Creates a NormalisableRange with a given range, interval and skew factor.
	NormalisableRange (ValueType rangeStart, ValueType rangeEnd) noexcept
	Creates a NormalisableRange with a given range, continuous interval, but a dummy skew-factor.
	NormalisableRange (ValueType rangeStart, ValueType rangeEnd, ValueType intervalValue) noexcept
	Creates a NormalisableRange with a given range and interval, but a dummy skew-factor.
	NormalisableRange (Range< ValueType > range) noexcept
	Creates a NormalisableRange with a given range, continuous interval, but a dummy skew-factor.
	NormalisableRange (Range< ValueType > range, ValueType intervalValue) noexcept
	Creates a NormalisableRange with a given range and interval, but a dummy skew-factor.
	NormalisableRange (ValueType rangeStart, ValueType rangeEnd, ValueRemapFunction convertFrom0To1Func, ValueRemapFunction convertTo0To1Func, ValueRemapFunction snapToLegalValueFunc={}) noexcept
	Creates a NormalisableRange with a given range and an injective mapping function.
ValueType	convertTo0to1 (ValueType v) const noexcept
	Uses the properties of this mapping to convert a non-normalised value to its 0->1 representation.
ValueType	convertFrom0to1 (ValueType proportion) const noexcept
	Uses the properties of this mapping to convert a normalised 0->1 value to its full-range representation.
ValueType	snapToLegalValue (ValueType v) const noexcept
	Takes a non-normalised value and snaps it based on either the interval property of this NormalisableRange or the lambda function supplied to the constructor.
Range< ValueType >	getRange () const noexcept
	Returns the extent of the normalisable range.
void	setSkewForCentre (ValueType centrePointValue) noexcept
	Given a value which is between the start and end points, this sets the skew such that convertFrom0to1 (0.5) will return this value.

Public Attributes
ValueType	start = 0
	The minimum value of the non-normalised range.
ValueType	end = 1
	The maximum value of the non-normalised range.
ValueType	interval = 0
	The snapping interval that should be used (for a non-normalised value).
ValueType	skew = 1
	An optional skew factor that alters the way values are distribute across the range.
bool	symmetricSkew = false
	If true, the skew factor applies from the middle of the slider to each of its ends.

Detailed Description

template<typename ValueType>
class NormalisableRange< ValueType >

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 also

Range

Member Typedef Documentation

ValueRemapFunction

template<typename ValueType>

using NormalisableRange< ValueType >::ValueRemapFunction

Initial value:

 std::function<ValueType(ValueType rangeStart,
                                                       ValueType rangeEnd,
                                                       ValueType valueToRemap)>

A function object which can remap a value in some way based on the start and end of a range.

Constructor & Destructor Documentation

NormalisableRange() [1/9]

template<typename ValueType>

NormalisableRange< ValueType >::NormalisableRange ( )

default

Creates a continuous range that performs a dummy mapping.

Referenced by NormalisableRange(), NormalisableRange(), operator=(), and operator=().

NormalisableRange() [2/9]

template<typename ValueType>

NormalisableRange< ValueType >::NormalisableRange ( const NormalisableRange< ValueType > & )

default

References NormalisableRange().

NormalisableRange() [3/9]

template<typename ValueType>

NormalisableRange< ValueType >::NormalisableRange ( NormalisableRange< ValueType > && )

default

References NormalisableRange().

NormalisableRange() [4/9]

template<typename ValueType>

NormalisableRange< ValueType >::NormalisableRange ( ValueType rangeStart, ValueType rangeEnd, ValueType intervalValue, ValueType skewFactor, bool useSymmetricSkew = false )

noexcept

Creates a NormalisableRange with a given range, interval and skew factor.

References end, interval, skew, start, and symmetricSkew.

NormalisableRange() [5/9]

template<typename ValueType>

NormalisableRange< ValueType >::NormalisableRange ( ValueType rangeStart, ValueType rangeEnd )

noexcept

Creates a NormalisableRange with a given range, continuous interval, but a dummy skew-factor.

NormalisableRange() [6/9]

template<typename ValueType>

NormalisableRange< ValueType >::NormalisableRange ( ValueType rangeStart, ValueType rangeEnd, ValueType intervalValue )

noexcept

Creates a NormalisableRange with a given range and interval, but a dummy skew-factor.

NormalisableRange() [7/9]

template<typename ValueType>

NormalisableRange< ValueType >::NormalisableRange ( Range< ValueType > range )

noexcept

Creates a NormalisableRange with a given range, continuous interval, but a dummy skew-factor.

NormalisableRange() [8/9]

template<typename ValueType>

NormalisableRange< ValueType >::NormalisableRange ( Range< ValueType > range, ValueType intervalValue )

noexcept

Creates a NormalisableRange with a given range and interval, but a dummy skew-factor.

NormalisableRange() [9/9]

template<typename ValueType>

NormalisableRange< ValueType >::NormalisableRange ( ValueType rangeStart, ValueType rangeEnd, ValueRemapFunction convertFrom0To1Func, ValueRemapFunction convertTo0To1Func, ValueRemapFunction snapToLegalValueFunc = {} )

noexcept

Creates a NormalisableRange with a given range and an injective mapping function.

Parameters

rangeStart	The minimum value in the range.
rangeEnd	The maximum value in the range.
convertFrom0To1Func	A function which uses the current start and end of this NormalisableRange and produces a mapped value from a normalised value.
convertTo0To1Func	A function which uses the current start and end of this NormalisableRange and produces a normalised value from a mapped value.
snapToLegalValueFunc	A function which uses the current start and end of this NormalisableRange to take a mapped value and snap it to the nearest legal value.

Member Function Documentation

operator=() [1/2]

template<typename ValueType>

NormalisableRange & NormalisableRange< ValueType >::operator= ( const NormalisableRange< ValueType > & )

default

References NormalisableRange().

operator=() [2/2]

template<typename ValueType>

NormalisableRange & NormalisableRange< ValueType >::operator= ( NormalisableRange< ValueType > && )

default

References NormalisableRange().

convertTo0to1()

template<typename ValueType>

ValueType NormalisableRange< ValueType >::convertTo0to1 ( ValueType v ) const

noexcept

Uses the properties of this mapping to convert a non-normalised value to its 0->1 representation.

References end, exactlyEqual(), skew, start, and symmetricSkew.

convertFrom0to1()

template<typename ValueType>

ValueType NormalisableRange< ValueType >::convertFrom0to1 ( ValueType proportion ) const

noexcept

Uses the properties of this mapping to convert a normalised 0->1 value to its full-range representation.

References end, exactlyEqual(), skew, start, and symmetricSkew.

snapToLegalValue()

template<typename ValueType>

ValueType NormalisableRange< ValueType >::snapToLegalValue ( ValueType v ) const

noexcept

Takes a non-normalised value and snaps it based on either the interval property of this NormalisableRange or the lambda function supplied to the constructor.

References end, interval, and start.

getRange()

template<typename ValueType>

Range< ValueType > NormalisableRange< ValueType >::getRange ( ) const

noexcept

Returns the extent of the normalisable range.

References end, and start.

setSkewForCentre()

template<typename ValueType>

void NormalisableRange< ValueType >::setSkewForCentre ( ValueType centrePointValue )

noexcept

Given a value which is between the start and end points, this sets the skew such that convertFrom0to1 (0.5) will return this value.

If you have used lambda functions for convertFrom0to1Func and convertFrom0to1Func in the constructor of this class then the skew value is ignored.

Parameters

centrePointValue

this must be greater than the start of the range and less than the end.

References end, jassert, skew, start, and symmetricSkew.

Member Data Documentation

start

template<typename ValueType>

ValueType NormalisableRange< ValueType >::start = 0

The minimum value of the non-normalised range.

Referenced by convertFrom0to1(), convertTo0to1(), AudioParameterInt::getRange(), getRange(), NormalisableRange(), setSkewForCentre(), and snapToLegalValue().

end

template<typename ValueType>

ValueType NormalisableRange< ValueType >::end = 1

The maximum value of the non-normalised range.

Referenced by convertFrom0to1(), convertTo0to1(), AudioParameterInt::getRange(), getRange(), NormalisableRange(), setSkewForCentre(), and snapToLegalValue().

interval

template<typename ValueType>

ValueType NormalisableRange< ValueType >::interval = 0

The snapping interval that should be used (for a non-normalised value).

Use 0 for a continuous range.

If you have used a lambda function for snapToLegalValueFunction in the constructor of this class then the interval is ignored.

Referenced by NormalisableRange(), and snapToLegalValue().

skew

template<typename ValueType>

ValueType NormalisableRange< ValueType >::skew = 1

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.

If you have used lambda functions for convertFrom0to1Func and convertFrom0to1Func in the constructor of this class then the skew value is ignored.

Referenced by convertFrom0to1(), convertTo0to1(), NormalisableRange(), and setSkewForCentre().

symmetricSkew

template<typename ValueType>

bool NormalisableRange< ValueType >::symmetricSkew = false

If true, the skew factor applies from the middle of the slider to each of its ends.

Referenced by convertFrom0to1(), convertTo0to1(), NormalisableRange(), and setSkewForCentre().