Une classe d'intervalle. Plus de détails...

#include <Range.hpp>

Graphe d'héritage de castor::Range< T >:

[légende]

Fonctions membres publiques
	Range (T const &min, T const &max) noexcept
	Constructeur.

T const &	clamp (T const &value) const noexcept
	Remet une valeur dans l'intervalle.

bool	has (T const &value) const noexcept

float	percent (T const &value) const noexcept
	Retourne le pourcentage correspondant à la valeur donnée.

float	invPercent (T const &value) const noexcept
	Retourne le pourcentage correspondant à la valeur donnée.

T	value (float const &percent) const noexcept
	Retourne la valeur correspondant au pourcentage donné.

T	invValue (float const &percent) const noexcept
	Retourne la valeur correspondant au pourcentage donné.

T const &	getMin () const noexcept

T const &	getMax () const noexcept

Description détaillée

template<typename T>
class castor::Range< T >

Une classe d'intervalle.

Documentation des constructeurs et destructeur

◆ Range()

template<typename T >

castor::Range< T >::Range	(	T const &	min,
		T const &	max )

inlinenoexcept

Constructeur.

Paramètres

[in] min,max Les bornes de l'intervalle.

Documentation des fonctions membres

◆ clamp()

template<typename T >

T const & castor::Range< T >::clamp ( T const & value ) const

inlinenoexcept

Remet une valeur dans l'intervalle.

Paramètres

[in] value La valeur.

Renvoie: m_min si la valeur y est inférieure.
m_max si la valeur y est supérieure.
value sinon.

Références castor::Range< T >::value().

Référencé par castor::Range< T >::percent().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ getMax()

template<typename T >

T const & castor::Range< T >::getMax ( ) const

inlinenoexcept

Renvoie: La borne maximale.

◆ getMin()

template<typename T >

T const & castor::Range< T >::getMin ( ) const

inlinenoexcept

Renvoie: La borne minimale.

◆ has()

template<typename T >

bool castor::Range< T >::has ( T const & value ) const

inlinenoexcept

Renvoie: true si value est dans l'intervalle.

Références castor::Range< T >::value().

Voici le graphe d'appel pour cette fonction :

◆ invPercent()

template<typename T >

float castor::Range< T >::invPercent ( T const & value ) const

inlinenoexcept

Retourne le pourcentage correspondant à la valeur donnée.

Paramètres

[in] value La valeur.

Renvoie: 0.0 si value est égal à ou supérieur à m_max.
1.0 si value est égal à ou inférieur à m_min.
Une pourcentage allant de 0.0 à 1.0, selon que la valeur est plus proche de m_max ou de m_min.

Références castor::Range< T >::percent(), et castor::Range< T >::value().

Voici le graphe d'appel pour cette fonction :

◆ invValue()

template<typename T >

T castor::Range< T >::invValue ( float const & percent ) const

inlinenoexcept

Retourne la valeur correspondant au pourcentage donné.

Paramètres

[in] percent Le pourcentage.

Renvoie: m_max si percent vaut 0.0.
m_min si percent vaut 1.0.
Une valeur comprise entre m_min et m_max.

Références castor::Range< T >::percent().

Voici le graphe d'appel pour cette fonction :

◆ percent()

template<typename T >

float castor::Range< T >::percent ( T const & value ) const

inlinenoexcept

Retourne le pourcentage correspondant à la valeur donnée.

Paramètres

[in] value La valeur.

Renvoie: 0.0 si value est égal à ou inférieur à m_min.
1.0 si value est égal à ou supérieur à m_max.
Une pourcentage allant de 0.0 à 1.0, selon que la valeur est plus proche de m_min ou de m_max.

Références castor::Range< T >::clamp(), et castor::Range< T >::value().

Référencé par castor::Range< T >::invPercent(), castor::Range< T >::invValue(), et castor::Range< T >::value().

Voici le graphe d'appel pour cette fonction :