A general-purpose range object, that simply represents any linear range with a start and end point. More...

#include <juce_Range.h>

Inheritance diagram for juce::Range< ValueType >:

[legend]

Collaboration diagram for juce::Range< ValueType >:

Public Member Functions
constexpr	Range ()=default
	Constructs an empty range. More...

constexpr	Range (const Range &)=default
	Constructs a copy of another range. More...

constexpr	Range (const ValueType startValue, const ValueType endValue) noexcept
	Constructs a range with given start and end values. More...

ValueType	clipValue (const ValueType value) const noexcept
	Returns the nearest value to the one supplied, which lies within the range. More...

Range	constrainRange (Range rangeToConstrain) const noexcept
	Returns a given range, after moving it forwards or backwards to fit it within this range. More...

constexpr bool	contains (const ValueType position) const noexcept
	Returns true if the given position lies inside this range. More...

constexpr bool	contains (Range other) const noexcept
	Returns true if the given range lies entirely inside this range. More...

constexpr JUCE_NODISCARD Range	expanded (ValueType amount) const noexcept
	Returns a range which has its start moved down and its end moved up by the given amount. More...

constexpr ValueType	getEnd () const noexcept
	Returns the end of the range. More...

constexpr JUCE_NODISCARD Range	getIntersectionWith (Range other) const noexcept
	Returns the range that is the intersection of the two ranges, or an empty range with an undefined start position if they don't overlap. More...

constexpr ValueType	getLength () const noexcept
	Returns the length of the range. More...

constexpr ValueType	getStart () const noexcept
	Returns the start of the range. More...

constexpr JUCE_NODISCARD Range	getUnionWith (const ValueType valueToInclude) const noexcept
	Returns the smallest range that contains both this one and the given value. More...

constexpr JUCE_NODISCARD Range	getUnionWith (Range other) const noexcept
	Returns the smallest range that contains both this one and the other one. More...

constexpr bool	intersects (Range other) const noexcept
	Returns true if the given range intersects this one. More...

constexpr bool	isEmpty () const noexcept
	Returns true if the range has a length of zero. More...

constexpr JUCE_NODISCARD Range	movedToEndAt (const ValueType newEnd) const noexcept
	Returns a range with the same length as this one, but moved to have the given end position. More...

constexpr JUCE_NODISCARD Range	movedToStartAt (const ValueType newStart) const noexcept
	Returns a range with the same length as this one, but moved to have the given start position. More...

constexpr bool	operator!= (Range other) const noexcept

constexpr Range	operator+ (const ValueType amountToAdd) const noexcept
	Returns a range that is equal to this one with an amount added to its start and end. More...

Range	operator+= (const ValueType amountToAdd) noexcept
	Adds an amount to the start and end of the range. More...

constexpr Range	operator- (const ValueType amountToSubtract) const noexcept
	Returns a range that is equal to this one with the specified amount subtracted from its start and end. More...

Range	operator-= (const ValueType amountToSubtract) noexcept
	Subtracts an amount from the start and end of the range. More...

Range &	operator= (const Range &)=default
	Copies another range object. More...

constexpr bool	operator== (Range other) const noexcept

void	setEnd (const ValueType newEnd) noexcept
	Changes the end position of the range, leaving the start unchanged. More...

void	setLength (const ValueType newLength) noexcept
	Changes the length of the range. More...

void	setStart (const ValueType newStart) noexcept
	Changes the start position of the range, leaving the end position unchanged. More...

constexpr JUCE_NODISCARD Range	withEnd (const ValueType newEnd) const noexcept
	Returns a range with the same start position as this one, but a different end. More...

constexpr JUCE_NODISCARD Range	withLength (const ValueType newLength) const noexcept
	Returns a range with the same start as this one, but a different length. More...

constexpr JUCE_NODISCARD Range	withStart (const ValueType newStart) const noexcept
	Returns a range with the same end as this one, but a different start. More...

Static Public Member Functions
constexpr static Range	between (const ValueType position1, const ValueType position2) noexcept
	Returns the range that lies between two positions (in either order). More...

constexpr static JUCE_NODISCARD Range	emptyRange (const ValueType start) noexcept
	Returns a range with the specified start position and a length of zero. More...

template<typename Integral , std::enable_if_t< std::is_integral< Integral >::value, int > = 0>
static Range	findMinAndMax (const ValueType *values, Integral numValues) noexcept
	Scans an array of values for its min and max, and returns these as a Range. More...

static JUCE_NODISCARD Range	withStartAndLength (const ValueType startValue, const ValueType length) noexcept
	Returns a range with a given start and length. More...

Private Attributes
ValueType	end {}

ValueType	start {}

Detailed Description

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

A general-purpose range object, that simply represents any linear range with a start and end point.

Note that when checking whether values fall within the range, the start value is considered to be inclusive, and the end of the range exclusive.

The templated parameter is expected to be a primitive integer or floating point type, though class types could also be used if they behave in a number-like way.

@tags{Core}

Constructor & Destructor Documentation

◆ Range() [1/3]

template<typename ValueType >

constexpr juce::Range< ValueType >::Range ( )

constexprdefault

Constructs an empty range.

◆ Range() [2/3]

template<typename ValueType >

constexpr juce::Range< ValueType >::Range	(	const ValueType	startValue,
		const ValueType	endValue
	)

inlineconstexprnoexcept

Constructs a range with given start and end values.

◆ Range() [3/3]

template<typename ValueType >

constexpr juce::Range< ValueType >::Range ( const Range< ValueType > & )

constexprdefault

Constructs a copy of another range.

Member Function Documentation

◆ between()

template<typename ValueType >

constexpr static Range juce::Range< ValueType >::between	(	const ValueType	position1,
		const ValueType	position2
	)

inlinestaticconstexprnoexcept

Returns the range that lies between two positions (in either order).

◆ clipValue()

template<typename ValueType >

ValueType juce::Range< ValueType >::clipValue ( const ValueType value ) const

inlinenoexcept

Returns the nearest value to the one supplied, which lies within the range.

Referenced by juce::AnimatedPosition< Behaviour >::setPositionAndSendChange().

◆ constrainRange()

template<typename ValueType >

Range juce::Range< ValueType >::constrainRange ( Range< ValueType > rangeToConstrain ) const

inlinenoexcept

Returns a given range, after moving it forwards or backwards to fit it within this range.

If the supplied range has a greater length than this one, the return value will be this range.

Otherwise, if the supplied range is smaller than this one, the return value will be the new range, shifted forwards or backwards so that it doesn't extend beyond this one, but keeping its original length.

◆ contains() [1/2]

template<typename ValueType >

constexpr bool juce::Range< ValueType >::contains ( const ValueType position ) const

inlineconstexprnoexcept

Returns true if the given position lies inside this range.

When making this comparison, the start value is considered to be inclusive, and the end of the range exclusive.

Referenced by juce::SparseSet< int >::removeRange().

◆ contains() [2/2]

template<typename ValueType >

constexpr bool juce::Range< ValueType >::contains ( Range< ValueType > other ) const

inlineconstexprnoexcept

Returns true if the given range lies entirely inside this range.

◆ emptyRange()

template<typename ValueType >

constexpr static JUCE_NODISCARD Range juce::Range< ValueType >::emptyRange ( const ValueType start )

inlinestaticconstexprnoexcept

Returns a range with the specified start position and a length of zero.

◆ expanded()

template<typename ValueType >

constexpr JUCE_NODISCARD Range juce::Range< ValueType >::expanded ( ValueType amount ) const

inlineconstexprnoexcept

Returns a range which has its start moved down and its end moved up by the given amount.

Returns: The returned range will be (start - amount, end + amount)

◆ findMinAndMax()

template<typename ValueType >

template<typename Integral , std::enable_if_t< std::is_integral< Integral >::value, int > = 0>

static Range juce::Range< ValueType >::findMinAndMax	(	const ValueType *	values,
		Integral	numValues
	)

inlinestaticnoexcept

Scans an array of values for its min and max, and returns these as a Range.

◆ getEnd()

template<typename ValueType >

constexpr ValueType juce::Range< ValueType >::getEnd ( ) const

inlineconstexprnoexcept

Returns the end of the range.

Referenced by juce::UIATextProvider::UIATextRangeProvider::CompareEndpoints(), juce::UIATextProvider::UIATextRangeProvider::MoveEndpointByUnit(), juce::SparseSet< int >::removeRange(), and juce::UIATextProvider::UIATextRangeProvider::setEndpointChecked().

◆ getIntersectionWith()

template<typename ValueType >

constexpr JUCE_NODISCARD Range juce::Range< ValueType >::getIntersectionWith ( Range< ValueType > other ) const

inlineconstexprnoexcept

Returns the range that is the intersection of the two ranges, or an empty range with an undefined start position if they don't overlap.

Referenced by juce::Reservoir::doBufferedRead().

◆ getLength()

template<typename ValueType >

constexpr ValueType juce::Range< ValueType >::getLength ( ) const

inlineconstexprnoexcept

Returns the length of the range.

Referenced by juce::Range< int64 >::constrainRange(), juce::MemoryMappedFile::openInternal(), and juce::MemoryMappedFile::~MemoryMappedFile().

◆ getStart()

template<typename ValueType >

constexpr ValueType juce::Range< ValueType >::getStart ( ) const

inlineconstexprnoexcept

Returns the start of the range.

Referenced by juce::UIATextProvider::UIATextRangeProvider::CompareEndpoints(), juce::Reservoir::doBufferedRead(), juce::UIATextProvider::UIATextRangeProvider::ExpandToEnclosingUnit(), juce::UIATextProvider::UIATextRangeProvider::MoveEndpointByUnit(), juce::MemoryMappedFile::openInternal(), juce::SparseSet< int >::removeRange(), and juce::UIATextProvider::UIATextRangeProvider::setEndpointChecked().

◆ getUnionWith() [1/2]

template<typename ValueType >

constexpr JUCE_NODISCARD Range juce::Range< ValueType >::getUnionWith ( const ValueType valueToInclude ) const

inlineconstexprnoexcept

Returns the smallest range that contains both this one and the given value.

◆ getUnionWith() [2/2]

template<typename ValueType >

constexpr JUCE_NODISCARD Range juce::Range< ValueType >::getUnionWith ( Range< ValueType > other ) const

inlineconstexprnoexcept

Returns the smallest range that contains both this one and the other one.

◆ intersects()

template<typename ValueType >

constexpr bool juce::Range< ValueType >::intersects ( Range< ValueType > other ) const

inlineconstexprnoexcept

Returns true if the given range intersects this one.

◆ isEmpty()

template<typename ValueType >

constexpr bool juce::Range< ValueType >::isEmpty ( ) const

inlineconstexprnoexcept

Returns true if the range has a length of zero.

Referenced by juce::Reservoir::doBufferedRead(), juce::UIATextProvider::GetSelection(), and juce::SparseSet< int >::removeRange().

◆ movedToEndAt()

template<typename ValueType >

constexpr JUCE_NODISCARD Range juce::Range< ValueType >::movedToEndAt ( const ValueType newEnd ) const

inlineconstexprnoexcept

Returns a range with the same length as this one, but moved to have the given end position.

◆ movedToStartAt()

template<typename ValueType >

constexpr JUCE_NODISCARD Range juce::Range< ValueType >::movedToStartAt ( const ValueType newStart ) const

inlineconstexprnoexcept

Returns a range with the same length as this one, but moved to have the given start position.

◆ operator!=()

template<typename ValueType >

constexpr bool juce::Range< ValueType >::operator!= ( Range< ValueType > other ) const

inlineconstexprnoexcept

◆ operator+()

template<typename ValueType >

constexpr Range juce::Range< ValueType >::operator+ ( const ValueType amountToAdd ) const

inlineconstexprnoexcept

Returns a range that is equal to this one with an amount added to its start and end.

◆ operator+=()

template<typename ValueType >

Range juce::Range< ValueType >::operator+= ( const ValueType amountToAdd )

inlinenoexcept

Adds an amount to the start and end of the range.

◆ operator-()

template<typename ValueType >

constexpr Range juce::Range< ValueType >::operator- ( const ValueType amountToSubtract ) const

inlineconstexprnoexcept

Returns a range that is equal to this one with the specified amount subtracted from its start and end.

◆ operator-=()

template<typename ValueType >

Range juce::Range< ValueType >::operator-= ( const ValueType amountToSubtract )

inlinenoexcept

Subtracts an amount from the start and end of the range.

◆ operator=()

template<typename ValueType >

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

default

Copies another range object.

◆ operator==()

template<typename ValueType >

constexpr bool juce::Range< ValueType >::operator== ( Range< ValueType > other ) const

inlineconstexprnoexcept

◆ setEnd()

template<typename ValueType >

void juce::Range< ValueType >::setEnd ( const ValueType newEnd )

inlinenoexcept

Changes the end position of the range, leaving the start unchanged.

If the new end position is below the current start of the range, the start point will be pushed back to equal the new end point.

Referenced by juce::UIATextProvider::UIATextRangeProvider::setEndpointChecked().

◆ setLength()

template<typename ValueType >

void juce::Range< ValueType >::setLength ( const ValueType newLength )

inlinenoexcept

Changes the length of the range.

Lengths less than zero are treated as zero.

◆ setStart()

template<typename ValueType >

void juce::Range< ValueType >::setStart ( const ValueType newStart )

inlinenoexcept

Changes the start position of the range, leaving the end position unchanged.

If the new start position is higher than the current end of the range, the end point will be pushed along to equal it, leaving an empty range at the new position.

Referenced by juce::Reservoir::doBufferedRead(), juce::MemoryMappedFile::openInternal(), and juce::UIATextProvider::UIATextRangeProvider::setEndpointChecked().

◆ withEnd()

template<typename ValueType >

constexpr JUCE_NODISCARD Range juce::Range< ValueType >::withEnd ( const ValueType newEnd ) const

inlineconstexprnoexcept

Returns a range with the same start position as this one, but a different end.

If the new end position is below the current start of the range, the start point will be pushed back to equal the new end point.

◆ withLength()

template<typename ValueType >

constexpr JUCE_NODISCARD Range juce::Range< ValueType >::withLength ( const ValueType newLength ) const

inlineconstexprnoexcept

Returns a range with the same start as this one, but a different length.

Lengths less than zero are treated as zero.

◆ withStart()

template<typename ValueType >

constexpr JUCE_NODISCARD Range juce::Range< ValueType >::withStart ( const ValueType newStart ) const

inlineconstexprnoexcept

Returns a range with the same end as this one, but a different start.

If the new start position is higher than the current end of the range, the end point will be pushed along to equal it, returning an empty range at the new position.

◆ withStartAndLength()

template<typename ValueType >

static JUCE_NODISCARD Range juce::Range< ValueType >::withStartAndLength	(	const ValueType	startValue,
		const ValueType	length
	)

inlinestaticnoexcept

Returns a range with a given start and length.

Referenced by juce::Rectangle< int >::getHorizontalRange(), and juce::Rectangle< int >::getVerticalRange().

Member Data Documentation

◆ end

template<typename ValueType >

ValueType juce::Range< ValueType >::end {}

private

◆ start

template<typename ValueType >

ValueType juce::Range< ValueType >::start {}

private

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

juce_Range.h

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ Range() [1/3]

◆ Range() [2/3]

◆ Range() [3/3]

Member Function Documentation

◆ between()

◆ clipValue()

◆ constrainRange()

◆ contains() [1/2]

◆ contains() [2/2]

◆ emptyRange()

◆ expanded()

◆ findMinAndMax()

◆ getEnd()

◆ getIntersectionWith()

◆ getLength()

◆ getStart()

◆ getUnionWith() [1/2]

◆ getUnionWith() [2/2]

◆ intersects()

◆ isEmpty()

◆ movedToEndAt()

◆ movedToStartAt()

◆ operator!=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator=()

◆ operator==()

◆ setEnd()

◆ setLength()

◆ setStart()

◆ withEnd()

◆ withLength()

◆ withStart()

◆ withStartAndLength()

Member Data Documentation

◆ end

◆ start

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