SF2::Render::Range< T > Class Template Reference

Representation of a range of values between low and high values inclusive. More...

#include <Range.hpp>

Public Types
using	ValueType = T

Public Member Functions
	Range (ValueType low, ValueType high)
	Construct new range between two values. More...
	Range (const Entity::Generator::Amount &range)
	Conversion constructor from Entity::Generator::Amount. More...
bool	contains (ValueType value) const
	Determine if a given value is within the defined range. More...
ValueType	low () const
ValueType	high () const

Detailed Description

template<typename T>
class SF2::Render::Range< T >

Representation of a range of values between low and high values inclusive.

It can answer if a given value is within the range.

Member Typedef Documentation

ValueType

template<typename T >

using SF2::Render::Range< T >::ValueType = T

Constructor & Destructor Documentation

Range() [1/2]

template<typename T >

SF2::Render::Range< T >::Range ( ValueType  low, ValueType  high  )

inline

Construct new range between two values.

Parameters

low	the first value in the range
high	the last value in the range

Range() [2/2]

template<typename T >

SF2::Render::Range< T >::Range ( const Entity::Generator::Amount &  range )

inlineexplicit

Conversion constructor from Entity::Generator::Amount.

Parameters

range

the union value to use for range bounds

Member Function Documentation

contains()

template<typename T >

bool SF2::Render::Range< T >::contains ( ValueType  value ) const

inline

Determine if a given value is within the defined range.

Parameters

value

the value to test

Returns

true if so

Referenced by SF2::Render::Zone::appliesTo().

high()

template<typename T >

ValueType SF2::Render::Range< T >::high ( ) const

inline

Returns

highest value in range

low()

template<typename T >

ValueType SF2::Render::Range< T >::low ( ) const

inline

Returns

lowest value in range

---

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

• SoundFontInfoLib/SoundFontInfoLib/Render/Range.hpp