Public Member Functions | Static Public Member Functions | Public Attributes

# USpeedGameEngine::Video::Light Class Reference

Classe de gestion de l'éclairage et des lumières. More...

List of all members.

## Public Member Functions

| ~Light ()
| Destructeur par défaut.
void | setState (bool activate)
| Définition de l'état activation.
bool | getState ()
| Accès à l'état activation.
void | setType (bool pos)
| Définition du type de lumière.
bool | getType ()
| Accès au type de lumière.
void | setPosition (USGE_Float3 pos)
| Définition de la position.
USGE_Float3 | getPosition ()
| Accès à la position.
void | setAmbient (USGE_Float3 color)
| Définition de la couleur ambiante.
USGE_Float3 | getAmbient ()
| Accès à la couleur ambiante.
void | setDiffuse (USGE_Float3 color)
| Définition de la couleur diffuse.
USGE_Float3 | getDiffuse ()
| Accès à la couleur diffuse.
void | setSpecular (USGE_Float3 color)
| Définition de la couleur spéculaire.
USGE_Float3 | getSpecular ()
| Accès à la couleur spéculaire.

## Static Public Member Functions

static Light * | getLight (unsigned int num)
| Sélection d'une lumière.
static void | activate (bool state)
| Permet d'activer/désactiver l'éclairage.
static bool | isActive ()
| Permet de savoir si l'éclairage est activé ou non.
static unsigned int | getMaxLights ()
| Retourne le nombre maximum de lumières autorisées.

## Public Attributes

USGE_Float3 | position
| Position de la lumière.
USGE_Float3 | ambient
| Couleur ambiante.
USGE_Float3 | diffuse
| Couleur diffuse.
USGE_Float3 | specular
| Couleur specular.
bool | positionnal
| Type de lumière : directionnelle ou positionnelle.
bool | state
| État de la lumière : active ou non ?

## Detailed Description

Classe de gestion de l'éclairage et des lumières.

Author:
  U.Speed

## Constructor & Destructor Documentation

Video::Light::~Light | ( |  | ) |

Destructeur par défaut.

Author:
  U.Speed

## Member Function Documentation

void Video::Light::activate | ( | bool | state | ) | `[static]`

Permet d'activer/désactiver l'éclairage.

Author:
  U.Speed

Parameters:

  | state | bool : `true` pour activer l'éclairage.

USGE_Float3 Video::Light::getAmbient | ( |  | ) |

Accès à la couleur ambiante.

Author:
  U.Speed

Returns:
  USGE_Float3 : les 3 composantes de la couleur

USGE_Float3 Video::Light::getDiffuse | ( |  | ) |

Accès à la couleur diffuse.

Author:
  U.Speed

Returns:
  USGE_Float3 : les 3 composantes de la couleur

Video::Light * Video::Light::getLight | ( | unsigned int | num | ) | `[static]`

Sélection d'une lumière.

Il n'y a que 8 sources de lumière possible.
Cette fonction retourne la source de lumière demandée ou la 1ère si la sélection n'est pas valide.

Author:
  U.Speed

Parameters:

  | num | unsigned int : le n° de la source (0 < .. < 9)

Returns:
  Video::Light* : l'instance de la lumière choisie. (Jamais de pointeur nul !)

unsigned int Video::Light::getMaxLights | ( |  | ) | `[static]`

Retourne le nombre maximum de lumières autorisées.

Author:
  U.Speed

Returns:
  unsigned int : le nombre de lumières maximum gérées par le moteur de rendu sélectionné.

USGE_Float3 Video::Light::getPosition | ( |  | ) |

Accès à la position.

Author:
  U.Speed

Returns:
  USGE_Float3 : la position de la lumière

USGE_Float3 Video::Light::getSpecular | ( |  | ) |

Accès à la couleur spéculaire.

Author:
  U.Speed

Returns:
  USGE_Float3 : les 3 composantes de la couleur

bool Video::Light::getState | ( |  | ) |

Accès à l'état activation.

Author:
  U.Speed

Returns:
  bool : `true` si la lumière concernée est active

bool Video::Light::getType | ( |  | ) |

Accès au type de lumière.

Author:
  U.Speed

Returns:
  bool : `true` pour une lumière positionnelle, `false` pour une lumière directionnelle.

bool Video::Light::isActive | ( |  | ) | `[static]`

Permet de savoir si l'éclairage est activé ou non.

Author:
  U.Speed

void Video::Light::setAmbient | ( | USGE_Float3 | color | ) |

Définition de la couleur ambiante.

Author:
  U.Speed

Parameters:

  | color | USGE_Float3 : les 3 composantes de la couleur

void Video::Light::setDiffuse | ( | USGE_Float3 | color | ) |

Définition de la couleur diffuse.

Author:
  U.Speed

Parameters:

  | color | USGE_Float3 : les 3 composantes de la couleur

void Video::Light::setPosition | ( | USGE_Float3 | pos | ) |

Définition de la position.

Author:
  U.Speed

Parameters:

  | pos | USGE_Float3 : la position de la lumière

void Video::Light::setSpecular | ( | USGE_Float3 | color | ) |

Définition de la couleur spéculaire.

Author:
  U.Speed

Parameters:

  | color | USGE_Float3 : les 3 composantes de la couleur

void Video::Light::setState | ( | bool | activate | ) |

Définition de l'état activation.

Author:
  U.Speed

Parameters:

  | activate | bool : `true` pour activer la lumière concernée.

void Video::Light::setType | ( | bool | pos | ) |

Définition du type de lumière.

Une lumière directionnelle possède les propriétés illustrées comme suit :

Une lumière positionnelle possède les propriétés illustrées comme suit :

Author:
  U.Speed

Parameters:

  | pos | bool : `true` pour une lumière positionnelle, `false` pour une lumière directionnelle.

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

- src/Video/Light.hpp
- src/Video/Light.cpp
- src/Video/Light_activate.cpp
- src/Video/Light_getAmbient.cpp
- src/Video/Light_getDiffuse.cpp
- src/Video/Light_getLight.cpp
- src/Video/Light_getMaxLights.cpp
- src/Video/Light_getPosition.cpp
- src/Video/Light_getSpecular.cpp
- src/Video/Light_getState.cpp
- src/Video/Light_getType.cpp
- src/Video/Light_isActive.cpp
- src/Video/Light_setAmbient.cpp
- src/Video/Light_setDiffuse.cpp
- src/Video/Light_setPosition.cpp
- src/Video/Light_setSpecular.cpp
- src/Video/Light_setState.cpp
- src/Video/Light_setType.cpp