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

#include <juce_NormalisableRange.h>

Inheritance diagram for NormalisableRange< ValueType >:

Collaboration diagram for NormalisableRange< ValueType >:

Public Member Functions
	NormalisableRange () noexcept
	Creates a continuous range that performs a dummy mapping. More...

	NormalisableRange (const NormalisableRange &other) noexcept
	Creates a copy of another range. More...

	NormalisableRange (ValueType rangeStart, ValueType rangeEnd, ValueType intervalValue, ValueType skewFactor, bool useSymmetricSkew=false) noexcept
	Creates a NormalisableRange with a given range, interval and skew factor. More...

	NormalisableRange (ValueType rangeStart, ValueType rangeEnd, ValueType intervalValue) noexcept
	Creates a NormalisableRange with a given range and interval, but a dummy skew-factor. More...

	NormalisableRange (ValueType rangeStart, ValueType rangeEnd) noexcept
	Creates a NormalisableRange with a given range, continuous interval, but a dummy skew-factor. More...

	NormalisableRange (ValueType rangeStart, ValueType rangeEnd, std::function< ValueType(ValueType currentRangeStart, ValueType currentRangeEnd, ValueType normalisedValue)> convertFrom0To1Func, std::function< ValueType(ValueType currentRangeStart, ValueType currentRangeEnd, ValueType mappedValue)> convertTo0To1Func, std::function< ValueType(ValueType currentRangeStart, ValueType currentRangeEnd, ValueType valueToSnap)> snapToLegalValueFunc=nullptr) noexcept
	Creates a NormalisableRange with a given range and an injective mapping function. More...

ValueType	convertFrom0to1 (ValueType proportion) const noexcept
	Uses the properties of this mapping to convert a normalised 0->1 value to its full-range representation. More...

ValueType	convertTo0to1 (ValueType v) const noexcept
	Uses the properties of this mapping to convert a non-normalised value to its 0->1 representation. More...

Range< ValueType >	getRange () const noexcept
	Returns the extent of the normalisable range. More...

NormalisableRange &	operator= (const NormalisableRange &other) noexcept
	Creates a copy of another range. More...

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. More...

ValueType	snapToLegalValue (ValueType v) const noexcept
	Takes a non-normalised value and snaps it based on either the interval property of this NormalisedRange or the lambda function supplied to the constructor. More...

Public Attributes
ValueType	end
	The maximum value of the non-normalised range. More...

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

ValueType	skew
	An optional skew factor that alters the way values are distribute across the range. More...

ValueType	start
	The minimum value of the non-normalised range. More...

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

Private Member Functions
void	checkInvariants () const

Private Attributes
std::function< ValueType(ValueType, ValueType, ValueType)>	convertFrom0To1Function = nullptr

std::function< ValueType(ValueType, ValueType, ValueType)>	convertTo0To1Function = nullptr

std::function< ValueType(ValueType, ValueType, ValueType)>	snapToLegalValueFunction = nullptr

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

Constructor & Destructor Documentation

◆ NormalisableRange() [1/6]

template<typename ValueType>

NormalisableRange< ValueType >::NormalisableRange ( )

inlinenoexcept

Creates a continuous range that performs a dummy mapping.

◆ NormalisableRange() [2/6]

template<typename ValueType>

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

inlinenoexcept

Creates a copy of another range.

◆ NormalisableRange() [3/6]

template<typename ValueType>

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

inlinenoexcept

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

◆ NormalisableRange() [4/6]

template<typename ValueType>

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

inlinenoexcept

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

◆ NormalisableRange() [5/6]

template<typename ValueType>

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

inlinenoexcept

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

◆ NormalisableRange() [6/6]

template<typename ValueType>

NormalisableRange< ValueType >::NormalisableRange	(	ValueType	rangeStart,
		ValueType	rangeEnd,
		std::function< ValueType(ValueType currentRangeStart, ValueType currentRangeEnd, ValueType normalisedValue)>	convertFrom0To1Func,
		std::function< ValueType(ValueType currentRangeStart, ValueType currentRangeEnd, ValueType mappedValue)>	convertTo0To1Func,
		std::function< ValueType(ValueType currentRangeStart, ValueType currentRangeEnd, ValueType valueToSnap)>	snapToLegalValueFunc = `nullptr`
	)

inlinenoexcept

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

◆ checkInvariants()

template<typename ValueType>

void NormalisableRange< ValueType >::checkInvariants ( ) const

inlineprivate

Referenced by NormalisableRange< float >::NormalisableRange(), NormalisableRange< float >::operator=(), and NormalisableRange< float >::setSkewForCentre().

◆ convertFrom0to1()

template<typename ValueType>

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

inlinenoexcept

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

◆ convertTo0to1()

template<typename ValueType>

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

inlinenoexcept

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

◆ getRange()

template<typename ValueType>

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

inlinenoexcept

Returns the extent of the normalisable range.

◆ operator=()

template<typename ValueType>

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

inlinenoexcept

Creates a copy of another range.

◆ setSkewForCentre()

template<typename ValueType>

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

inlinenoexcept

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.

◆ snapToLegalValue()

template<typename ValueType>

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

inlinenoexcept

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

Member Data Documentation

◆ convertFrom0To1Function

template<typename ValueType>

std::function<ValueType (ValueType, ValueType, ValueType)> NormalisableRange< ValueType >::convertFrom0To1Function = nullptr

private

Referenced by NormalisableRange< float >::convertFrom0to1(), and NormalisableRange< float >::operator=().

◆ convertTo0To1Function

template<typename ValueType>

std::function<ValueType (ValueType, ValueType, ValueType)> NormalisableRange< ValueType >::convertTo0To1Function = nullptr

private

Referenced by NormalisableRange< float >::convertTo0to1(), and NormalisableRange< float >::operator=().

◆ end

template<typename ValueType>

ValueType NormalisableRange< ValueType >::end

The maximum value of the non-normalised range.

Referenced by NormalisableRange< float >::convertFrom0to1(), NormalisableRange< float >::convertTo0to1(), NormalisableRange< float >::getRange(), NormalisableRange< float >::operator=(), NormalisableRange< float >::setSkewForCentre(), and NormalisableRange< float >::snapToLegalValue().

◆ interval

template<typename ValueType>

ValueType NormalisableRange< ValueType >::interval

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< float >::operator=(), and NormalisableRange< float >::snapToLegalValue().

◆ skew

template<typename ValueType>

ValueType NormalisableRange< ValueType >::skew

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 NormalisableRange< float >::convertFrom0to1(), NormalisableRange< float >::convertTo0to1(), NormalisableRange< float >::operator=(), and NormalisableRange< float >::setSkewForCentre().

◆ snapToLegalValueFunction

template<typename ValueType>

std::function<ValueType (ValueType, ValueType, ValueType)> NormalisableRange< ValueType >::snapToLegalValueFunction = nullptr

private

Referenced by NormalisableRange< float >::operator=(), and NormalisableRange< float >::snapToLegalValue().

◆ start

template<typename ValueType>

ValueType NormalisableRange< ValueType >::start

The minimum value of the non-normalised range.

Referenced by NormalisableRange< float >::convertFrom0to1(), NormalisableRange< float >::convertTo0to1(), NormalisableRange< float >::getRange(), NormalisableRange< float >::operator=(), NormalisableRange< float >::setSkewForCentre(), and NormalisableRange< float >::snapToLegalValue().

◆ symmetricSkew

template<typename ValueType>

bool NormalisableRange< ValueType >::symmetricSkew

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

Referenced by NormalisableRange< float >::convertFrom0to1(), NormalisableRange< float >::convertTo0to1(), NormalisableRange< float >::operator=(), and NormalisableRange< float >::setSkewForCentre().

The documentation for this class was generated from the following file:

juce_NormalisableRange.h

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

template<typename ValueType> class NormalisableRange< ValueType >

Constructor & Destructor Documentation

◆ NormalisableRange() [1/6]

◆ NormalisableRange() [2/6]

◆ NormalisableRange() [3/6]

◆ NormalisableRange() [4/6]

◆ NormalisableRange() [5/6]

◆ NormalisableRange() [6/6]

Member Function Documentation

◆ checkInvariants()

◆ convertFrom0to1()

◆ convertTo0to1()

◆ getRange()

◆ operator=()

◆ setSkewForCentre()

◆ snapToLegalValue()

Member Data Documentation

◆ convertFrom0To1Function

◆ convertTo0To1Function

◆ end

◆ interval

◆ skew

◆ snapToLegalValueFunction

◆ start

◆ symmetricSkew

template<typename ValueType>
class NormalisableRange< ValueType >