Range< T > Struct Template Reference

Defines a range of values. More...

#include <Lerp.h>

Public Types
using	value_type = T
	Gives access to the type of elements in the range.

Public Member Functions
template<typename U>
Range< U >	cast () const
	Cast this range to another one.
T	clamp (T iValue) const
	Clamp the value to this range.
bool	contains (T iValue) const
	This method assumes that fFrom and fTo are part of the range or another way to put it:
bool	isSingleValue () const
template<typename U, typename TLerp = DPLerpXY<T, U>>
Range< U >	mapRange (Range< U > const &iRange) const
	Map this range to the other range.
template<typename U, typename TLerp = DPLerpXY<T, U>>
Range< U >	mapSubRange (Range< T > const &iSubRange, Range< U > const &iRange, bool iClampToRange=true) const
	Map a sub range of this range to the other range.
template<typename U, typename TLerp = DPLerpXY<T, U>>
U	mapValue (T iValue, Range< U > const &iRange, bool iClampToRange=true) const
	Map the value from this range into the provide range.
bool	operator!= (const Range &rhs) const
bool	operator== (const Range &rhs) const
	Range ()=default
	Range (T iFrom, T iTo)
	Range (T iValue) noexcept

Public Attributes
T	fFrom {}
T	fTo {}

Detailed Description

template<typename T>
struct pongasoft::Utils::Range< T >

Defines a range of values.

Member Typedef Documentation

value_type

template<typename T>

using value_type = T

Gives access to the type of elements in the range.

Constructor & Destructor Documentation

Range() [1/3]

template<typename T>

Range ( )

default

Range() [2/3]

template<typename T>

Range ( T iValue )

inlineexplicitnoexcept

Range() [3/3]

template<typename T>

Range ( T iFrom, T iTo )

inline

Member Function Documentation

cast()

template<typename T>

template<typename U>

Range< U > cast ( ) const

inline

Cast this range to another one.

clamp()

template<typename T>

T clamp ( T iValue ) const

inline

Clamp the value to this range.

Returns

a value between fFrom and fTo

contains()

template<typename T>

bool contains ( T iValue ) const

inline

This method assumes that fFrom and fTo are part of the range or another way to put it:

range.contains(range.fFrom) // returns true
range.contains(range.fTo) // returns true

Returns

true if the range contains the value

isSingleValue()

template<typename T>

bool isSingleValue ( ) const

inline

mapRange()

template<typename T>

template<typename U, typename TLerp = DPLerpXY<T, U>>

Range< U > mapRange ( Range< U > const & iRange ) const

inline

Map this range to the other range.

Parameters

iRange

the range to map this range into

Returns

the new range

mapSubRange()

template<typename T>

template<typename U, typename TLerp = DPLerpXY<T, U>>

Range< U > mapSubRange ( Range< T > const & iSubRange, Range< U > const & iRange, bool iClampToRange = true ) const

inline

Map a sub range of this range to the other range.

Parameters

iSubRange	the sub-range of this range to use as source
iRange	the range to map iSubRange into
iClampToRange	determines whether iSubRange should first be clamped to this range

Returns

the new range

Todo

optimize by computing TLerp only once

mapValue()

template<typename T>

template<typename U, typename TLerp = DPLerpXY<T, U>>

U mapValue ( T iValue, Range< U > const & iRange, bool iClampToRange = true ) const

inline

Map the value from this range into the provide range.

Parameters

iValue	the value from this range [fFrom, fTo]
iRange	the range to map the iValue into
iClampToRange	determines whether iValue should first be clamped to this range

Returns

the new value

operator!=()

template<typename T>

bool operator!= ( const Range< T > & rhs ) const

inline

operator==()

template<typename T>

bool operator== ( const Range< T > & rhs ) const

inline

Member Data Documentation

fFrom

template<typename T>

T fFrom {}

fTo

template<typename T>

T fTo {}

---

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

• pongasoft/Utils/Lerp.h