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

#include <juce_NormalisableRange.h>

Inheritance diagram for juce::NormalisableRange< ValueType >:

Collaboration diagram for juce::NormalisableRange< ValueType >:

[legend]

Public Types
using	ValueRemapFunction = 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. More...

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

	NormalisableRange (const NormalisableRange &)=default

	NormalisableRange (NormalisableRange &&)=default

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

	NormalisableRange (Range< ValueType > range, 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, ValueRemapFunction convertFrom0To1Func, ValueRemapFunction convertTo0To1Func, ValueRemapFunction snapToLegalValueFunc={}) noexcept
	Creates a NormalisableRange with a given range and an injective mapping function. 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, ValueType intervalValue, ValueType skewFactor, bool useSymmetricSkew=false) noexcept
	Creates a NormalisableRange with a given range, interval and skew factor. 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 &)=default

NormalisableRange &	operator= (NormalisableRange &&)=default

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 NormalisableRange or the lambda function supplied to the constructor. More...

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

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

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

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

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

Private Member Functions
void	checkInvariants () const

Static Private Member Functions
static ValueType	clampTo0To1 (ValueType value)

Private Attributes
ValueRemapFunction	convertFrom0To1Function

ValueRemapFunction	convertTo0To1Function

ValueRemapFunction	snapToLegalValueFunction

Detailed Description

template<typename ValueType>
class juce::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

@tags{Core}

Member Typedef Documentation

◆ ValueRemapFunction

template<typename ValueType >

using juce::NormalisableRange< ValueType >::ValueRemapFunction = 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 >

juce::NormalisableRange< ValueType >::NormalisableRange ( )

default

Creates a continuous range that performs a dummy mapping.

◆ NormalisableRange() [2/9]

template<typename ValueType >

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

default

◆ NormalisableRange() [3/9]

template<typename ValueType >

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

default

◆ NormalisableRange() [4/9]

template<typename ValueType >

juce::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() [5/9]

template<typename ValueType >

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

inlinenoexcept

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

◆ NormalisableRange() [6/9]

template<typename ValueType >

juce::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() [7/9]

template<typename ValueType >

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

inlinenoexcept

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

◆ NormalisableRange() [8/9]

template<typename ValueType >

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

inlinenoexcept

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

◆ NormalisableRange() [9/9]

template<typename ValueType >

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

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 juce::NormalisableRange< ValueType >::checkInvariants ( ) const

inlineprivate

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

◆ clampTo0To1()

template<typename ValueType >

static ValueType juce::NormalisableRange< ValueType >::clampTo0To1 ( ValueType value )

inlinestaticprivate

Referenced by juce::NormalisableRange< float >::convertFrom0to1(), and juce::NormalisableRange< float >::convertTo0to1().

◆ convertFrom0to1()

template<typename ValueType >

ValueType juce::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 juce::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> juce::NormalisableRange< ValueType >::getRange ( ) const

inlinenoexcept

Returns the extent of the normalisable range.

◆ operator=() [1/2]

template<typename ValueType >

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

default

◆ operator=() [2/2]

template<typename ValueType >

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

default

◆ setSkewForCentre()

template<typename ValueType >

void juce::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 juce::NormalisableRange< ValueType >::snapToLegalValue ( ValueType v ) const

inlinenoexcept

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.

Member Data Documentation

◆ convertFrom0To1Function

template<typename ValueType >

ValueRemapFunction juce::NormalisableRange< ValueType >::convertFrom0To1Function

private

Referenced by juce::NormalisableRange< float >::convertFrom0to1().

◆ convertTo0To1Function

template<typename ValueType >

ValueRemapFunction juce::NormalisableRange< ValueType >::convertTo0To1Function

private

Referenced by juce::NormalisableRange< float >::convertTo0to1().

◆ end

template<typename ValueType >

ValueType juce::NormalisableRange< ValueType >::end = 1

The maximum value of the non-normalised range.

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

◆ interval

template<typename ValueType >

ValueType juce::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 juce::NormalisableRange< float >::checkInvariants(), and juce::NormalisableRange< float >::snapToLegalValue().

◆ skew

template<typename ValueType >

ValueType juce::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 juce::NormalisableRange< float >::checkInvariants(), juce::NormalisableRange< float >::convertFrom0to1(), juce::NormalisableRange< float >::convertTo0to1(), and juce::NormalisableRange< float >::setSkewForCentre().

◆ snapToLegalValueFunction

template<typename ValueType >

ValueRemapFunction juce::NormalisableRange< ValueType >::snapToLegalValueFunction

private

Referenced by juce::NormalisableRange< float >::snapToLegalValue().

◆ start

template<typename ValueType >

ValueType juce::NormalisableRange< ValueType >::start = 0

The minimum value of the non-normalised range.

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

◆ symmetricSkew

template<typename ValueType >

bool juce::NormalisableRange< ValueType >::symmetricSkew = false

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

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

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

juce_NormalisableRange.h

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

template<typename ValueType> class juce::NormalisableRange< ValueType >

Member Typedef Documentation

◆ ValueRemapFunction

Constructor & Destructor Documentation

◆ NormalisableRange() [1/9]

◆ NormalisableRange() [2/9]

◆ NormalisableRange() [3/9]

◆ NormalisableRange() [4/9]

◆ NormalisableRange() [5/9]

◆ NormalisableRange() [6/9]

◆ NormalisableRange() [7/9]

◆ NormalisableRange() [8/9]

◆ NormalisableRange() [9/9]

Member Function Documentation

◆ checkInvariants()

◆ clampTo0To1()

◆ convertFrom0to1()

◆ convertTo0to1()

◆ getRange()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setSkewForCentre()

◆ snapToLegalValue()

Member Data Documentation

◆ convertFrom0To1Function

◆ convertTo0To1Function

◆ end

◆ interval

◆ skew

◆ snapToLegalValueFunction

◆ start

◆ symmetricSkew

template<typename ValueType>
class juce::NormalisableRange< ValueType >