Castor3D 0.16.0
Multiplatform 3D engine
Fonctions membres publiques | Fonctions membres publiques statiques | Amis | Liste de tous les membres
Référence du modèle de la classe castor::LengthT< TypeT >

Classe de longueur. Plus de détails...

#include <Length.hpp>

Fonctions membres publiques

 LengthT (LengthUnit unit=LengthUnit::eMetre) noexcept
 Constructeur par défaut.
 
TypeT unit (LengthUnit u) const noexcept
 
TypeT kilometres () const noexcept
 
TypeT metres () const noexcept
 
TypeT centimetres () const noexcept
 
TypeT millimetres () const noexcept
 
TypeT yards () const noexcept
 
TypeT feet () const noexcept
 
TypeT inches () const noexcept
 
void kilometres (double value) noexcept
 
void metres (double value) noexcept
 
void centimetres (double value) noexcept
 
void millimetres (double value) noexcept
 
void yards (double value) noexcept
 
void feet (double value) noexcept
 
void inches (double value) noexcept
 
 operator TypeT const & () const noexcept
 
TypeT const & value () const noexcept
 
TypeT & operator* () noexcept
 
LengthUnit lengthUnit () const noexcept
 
Opérateurs arithmétiques.
LengthT< TypeT > & operator= (TypeT const &rhs) noexcept
 
LengthT< TypeT > & operator- () noexcept
 
LengthT< TypeT > & operator+= (LengthT< TypeT > const &rhs) noexcept
 
LengthT< TypeT > & operator-= (LengthT< TypeT > const &rhs) noexcept
 
LengthT< TypeT > & operator+= (TypeT const &rhs) noexcept
 
LengthT< TypeT > & operator-= (TypeT const &rhs) noexcept
 
LengthT< TypeT > & operator*= (double rhs) noexcept
 
LengthT< TypeT > & operator/= (double rhs) noexcept
 

Fonctions membres publiques statiques

template<typename TypeU >
static LengthT< TypeT > fromUnit (TypeU value, LengthUnit unit) noexcept
 Constructeur nommé, à partir d'une valeur exprimée dans l'unité donnée.
 
template<typename TypeU >
static LengthT< TypeT > fromKilometres (TypeU value) noexcept
 Constructeur nommé, à partir d'une valeur en kilomètres.
 
template<typename TypeU >
static LengthT< TypeT > fromMetres (TypeU value) noexcept
 Constructeur nommé, à partir d'une valeur en mètres.
 
template<typename TypeU >
static LengthT< TypeT > fromCentimetres (TypeU value) noexcept
 Constructeur nommé, à partir d'une valeur en centimètres.
 
template<typename TypeU >
static LengthT< TypeT > fromMillimetres (TypeU value) noexcept
 Constructeur nommé, à partir d'une valeur en millimètres.
 
template<typename TypeU >
static LengthT< TypeT > fromYards (TypeU value) noexcept
 Constructeur nommé, à partir d'une valeur en yards.
 
template<typename TypeU >
static LengthT< TypeT > fromFeet (TypeU value) noexcept
 Constructeur nommé, à partir d'une valeur en pieds.
 
template<typename TypeU >
static LengthT< TypeT > fromInches (TypeU value) noexcept
 Constructeur nommé, à partir d'une valeur en pouces.
 

Amis

template<typename TypeU >
bool operator== (LengthT< TypeU > const &lhs, LengthT< TypeU > const &rhs) noexcept
 
template<typename TypeU >
bool operator< (LengthT< TypeU > const &lhs, LengthT< TypeU > const &rhs) noexcept
 
template<typename TypeU >
bool operator> (LengthT< TypeU > const &lhs, LengthT< TypeU > const &rhs) noexcept
 

Description détaillée

template<typename TypeT>
class castor::LengthT< TypeT >

Classe de longueur.

Remarques
Gère les conversions d'unités de longueurs.

Documentation des constructeurs et destructeur

◆ LengthT()

template<typename TypeT >
castor::LengthT< TypeT >::LengthT ( LengthUnit unit = LengthUnit::eMetre)
explicitnoexcept

Constructeur par défaut.

Documentation des fonctions membres

◆ centimetres() [1/2]

template<typename TypeT >
TypeT castor::LengthT< TypeT >::centimetres ( ) const
noexcept
Renvoie
La valeur convertie en centimètres.

◆ centimetres() [2/2]

template<typename TypeT >
void castor::LengthT< TypeT >::centimetres ( double value)
noexcept
Paramètres
[in]valueLa longueur exprimée en centimètres.

◆ feet() [1/2]

template<typename TypeT >
TypeT castor::LengthT< TypeT >::feet ( ) const
noexcept
Renvoie
La valeur convertie en pieds.

◆ feet() [2/2]

template<typename TypeT >
void castor::LengthT< TypeT >::feet ( double value)
noexcept
Paramètres
[in]valueLa longueur exprimée en pieds.

◆ fromCentimetres()

template<typename TypeT >
template<typename TypeU >
static LengthT< TypeT > castor::LengthT< TypeT >::fromCentimetres ( TypeU value)
inlinestaticnoexcept

Constructeur nommé, à partir d'une valeur en centimètres.

Paramètres
[in]valueLa valeur.
Renvoie
La longueur.

Références castor::eCentimetre, et castor::LengthT< TypeT >::value().

Voici le graphe d'appel pour cette fonction :

◆ fromFeet()

template<typename TypeT >
template<typename TypeU >
static LengthT< TypeT > castor::LengthT< TypeT >::fromFeet ( TypeU value)
inlinestaticnoexcept

Constructeur nommé, à partir d'une valeur en pieds.

Paramètres
[in]valueLa valeur.
Renvoie
La longueur.

Références castor::eFoot, et castor::LengthT< TypeT >::value().

Voici le graphe d'appel pour cette fonction :

◆ fromInches()

template<typename TypeT >
template<typename TypeU >
static LengthT< TypeT > castor::LengthT< TypeT >::fromInches ( TypeU value)
inlinestaticnoexcept

Constructeur nommé, à partir d'une valeur en pouces.

Paramètres
[in]valueLa valeur.
Renvoie
La longueur.

Références castor::eInch, et castor::LengthT< TypeT >::value().

Voici le graphe d'appel pour cette fonction :

◆ fromKilometres()

template<typename TypeT >
template<typename TypeU >
static LengthT< TypeT > castor::LengthT< TypeT >::fromKilometres ( TypeU value)
inlinestaticnoexcept

Constructeur nommé, à partir d'une valeur en kilomètres.

Paramètres
[in]valueLa valeur.
Renvoie
La longueur.

Références castor::eKilometre, et castor::LengthT< TypeT >::value().

Voici le graphe d'appel pour cette fonction :

◆ fromMetres()

template<typename TypeT >
template<typename TypeU >
static LengthT< TypeT > castor::LengthT< TypeT >::fromMetres ( TypeU value)
inlinestaticnoexcept

Constructeur nommé, à partir d'une valeur en mètres.

Paramètres
[in]valueLa valeur.
Renvoie
La longueur.

Références castor::eMetre, et castor::LengthT< TypeT >::value().

Voici le graphe d'appel pour cette fonction :

◆ fromMillimetres()

template<typename TypeT >
template<typename TypeU >
static LengthT< TypeT > castor::LengthT< TypeT >::fromMillimetres ( TypeU value)
inlinestaticnoexcept

Constructeur nommé, à partir d'une valeur en millimètres.

Paramètres
[in]valueLa valeur.
Renvoie
La longueur.

Références castor::eMillimetre, et castor::LengthT< TypeT >::value().

Voici le graphe d'appel pour cette fonction :

◆ fromUnit()

template<typename TypeT >
template<typename TypeU >
static LengthT< TypeT > castor::LengthT< TypeT >::fromUnit ( TypeU value,
LengthUnit unit )
inlinestaticnoexcept

Constructeur nommé, à partir d'une valeur exprimée dans l'unité donnée.

Paramètres
[in]valueLa valeur.
[in]unitL'unité de la longueur.
Renvoie
La longueur.

Références castor::LengthT< TypeT >::unit(), et castor::LengthT< TypeT >::value().

Voici le graphe d'appel pour cette fonction :

◆ fromYards()

template<typename TypeT >
template<typename TypeU >
static LengthT< TypeT > castor::LengthT< TypeT >::fromYards ( TypeU value)
inlinestaticnoexcept

Constructeur nommé, à partir d'une valeur en yards.

Paramètres
[in]valueLa valeur.
Renvoie
La longueur.

Références castor::eYard, et castor::LengthT< TypeT >::value().

Voici le graphe d'appel pour cette fonction :

◆ inches() [1/2]

template<typename TypeT >
TypeT castor::LengthT< TypeT >::inches ( ) const
noexcept
Renvoie
La valeur convertie en pouces.

◆ inches() [2/2]

template<typename TypeT >
void castor::LengthT< TypeT >::inches ( double value)
noexcept
Paramètres
[in]valueLa longueur exprimée en pouces.

◆ kilometres() [1/2]

template<typename TypeT >
TypeT castor::LengthT< TypeT >::kilometres ( ) const
noexcept
Renvoie
La valeur convertie en kilomètres.

◆ kilometres() [2/2]

template<typename TypeT >
void castor::LengthT< TypeT >::kilometres ( double value)
noexcept
Paramètres
[in]valueLa longueur exprimée en kilomètres.

◆ lengthUnit()

template<typename TypeT >
LengthUnit castor::LengthT< TypeT >::lengthUnit ( ) const
inlinenoexcept

◆ metres() [1/2]

template<typename TypeT >
TypeT castor::LengthT< TypeT >::metres ( ) const
noexcept
Renvoie
La valeur convertie en mètres.

◆ metres() [2/2]

template<typename TypeT >
void castor::LengthT< TypeT >::metres ( double value)
noexcept
Paramètres
[in]valueLa longueur exprimée en mètres.

◆ millimetres() [1/2]

template<typename TypeT >
TypeT castor::LengthT< TypeT >::millimetres ( ) const
noexcept
Renvoie
La valeur convertie en millimètres.

◆ millimetres() [2/2]

template<typename TypeT >
void castor::LengthT< TypeT >::millimetres ( double value)
noexcept
Paramètres
[in]valueLa longueur exprimée en millimètres.

◆ operator TypeT const &()

template<typename TypeT >
castor::LengthT< TypeT >::operator TypeT const & ( ) const
inlineexplicitnoexcept
Renvoie
La valeur de la longueur, dans son unité.

◆ operator*()

template<typename TypeT >
TypeT & castor::LengthT< TypeT >::operator* ( )
inlinenoexcept

◆ operator*=()

template<typename TypeT >
LengthT< TypeT > & castor::LengthT< TypeT >::operator*= ( double rhs)
noexcept

◆ operator+=() [1/2]

template<typename TypeT >
LengthT< TypeT > & castor::LengthT< TypeT >::operator+= ( LengthT< TypeT > const & rhs)
noexcept

◆ operator+=() [2/2]

template<typename TypeT >
LengthT< TypeT > & castor::LengthT< TypeT >::operator+= ( TypeT const & rhs)
noexcept

◆ operator-()

template<typename TypeT >
LengthT< TypeT > & castor::LengthT< TypeT >::operator- ( )
noexcept

◆ operator-=() [1/2]

template<typename TypeT >
LengthT< TypeT > & castor::LengthT< TypeT >::operator-= ( LengthT< TypeT > const & rhs)
noexcept

◆ operator-=() [2/2]

template<typename TypeT >
LengthT< TypeT > & castor::LengthT< TypeT >::operator-= ( TypeT const & rhs)
noexcept

◆ operator/=()

template<typename TypeT >
LengthT< TypeT > & castor::LengthT< TypeT >::operator/= ( double rhs)
noexcept

◆ operator=()

template<typename TypeT >
LengthT< TypeT > & castor::LengthT< TypeT >::operator= ( TypeT const & rhs)
noexcept

◆ unit()

template<typename TypeT >
TypeT castor::LengthT< TypeT >::unit ( LengthUnit u) const
noexcept
Renvoie
La valeur convertie dans l'unité donnée.

Référencé par castor::LengthT< TypeT >::fromUnit().

Voici le graphe des appelants de cette fonction :

◆ value()

template<typename TypeT >
TypeT const & castor::LengthT< TypeT >::value ( ) const
inlinenoexcept

Référencé par castor::LengthT< TypeT >::fromCentimetres(), castor::LengthT< TypeT >::fromFeet(), castor::LengthT< TypeT >::fromInches(), castor::LengthT< TypeT >::fromKilometres(), castor::LengthT< TypeT >::fromMetres(), castor::LengthT< TypeT >::fromMillimetres(), castor::LengthT< TypeT >::fromUnit(), et castor::LengthT< TypeT >::fromYards().

Voici le graphe des appelants de cette fonction :

◆ yards() [1/2]

template<typename TypeT >
TypeT castor::LengthT< TypeT >::yards ( ) const
noexcept
Renvoie
La valeur convertie en yards.

◆ yards() [2/2]

template<typename TypeT >
void castor::LengthT< TypeT >::yards ( double value)
noexcept
Paramètres
[in]valueLa longueur exprimée en yards.

Documentation des fonctions amies et associées

◆ operator<

template<typename TypeT >
template<typename TypeU >
bool operator< ( LengthT< TypeU > const & lhs,
LengthT< TypeU > const & rhs )
friend

◆ operator==

template<typename TypeT >
template<typename TypeU >
bool operator== ( LengthT< TypeU > const & lhs,
LengthT< TypeU > const & rhs )
friend

◆ operator>

template<typename TypeT >
template<typename TypeU >
bool operator> ( LengthT< TypeU > const & lhs,
LengthT< TypeU > const & rhs )
friend
La documentation de cette classe a été générée à partir du fichier suivant :
Généré par doxygen 1.10.0