Public Member Functions | Static Public Member Functions | Static Public Attributes

# USpeedGameEngine::Core Class Reference

Noyau de l'application. More...

List of all members.

## Public Member Functions

| ~Core ()
| Destructeur par défaut.
int | run (int argNumber, char *argList[], void(*customInit)(void), void(*customMain)(unsigned long int), void(*customFinish)(void), USGE_RenderEngine renderEngine)
| Point d'entrée du USpeedGameEngine : lancement du programme.
void | endMain ()
| Fonction permettant de quitter la boucle principale.
std::string | getUserInput (unsigned int textMaxLen, std::string const &defaultText)
| Affiche une zone de saisie pour que l'utilisateur entre quelque chose.
std::string | getUserInput (unsigned int textMaxLen, std::string const &defaultText, std::string const &comment)
| Affiche une zone de saisie pour que l'utilisateur entre quelque chose.
std::string | getUserInput (unsigned int textMaxLen, std::string const &defaultText, std::string const &comment, std::string const &okLabel, std::string const &cancelLabel)
| Affiche une zone de saisie pour que l'utilisateur entre quelque chose.
void | setSuspendFunction (void(*suspendFct)(bool))
| Permet de définir la fonction à appeler lors de la mise en veille du programme.
bool | messageBox (const char *title, const char *text, bool askYesNo)
| Affiche une boîte de message et demande éventuellement à l'utilisateur de répondre "Oui" ou "Non".
void | messageBox (const char *title, const char *text)
| Affiche une boîte de message avec le bouton "Ok" pour quitter.
bool | messageBox (std::string const &title, std::string const &text, bool askYesNo)
| Affiche une boîte de message et demande éventuellement à l'utilisateur de répondre "Oui" ou "Non".
void | messageBox (std::string const &title, std::string const &text)
| Affiche une boîte de message avec le bouton "Ok" pour quitter.
unsigned int | getMainVarCount ()
| Retourne le nombre de paramètres passés au programme (via le main).
const char * | getMainVars (unsigned int myIndex)
| Retourne les paramètres passés au programme (via le main).
std::string | getAppFolder ()
| Retourne le chemin complet de l'application (avec le "/" à la fin).
unsigned int | getTargetSystem ()
| Retourne la plateforme pour laquelle est destinée le programme.
const char * | getApplicationTitle ()
| Retourne le titre de l'application.
void | setApplicationTitle (const char *title)
| Permet de définir le titre de l'application.
void | setFPS (unsigned int fps)
| Permet de définir le nombre d'images par seconde désiré.
unsigned int | getFPS ()
| Permet de connaître à combien d'images par seconde le moteur est paramétré.
void | toFullscreen ()
| Passage de l'application en mode plein écran.
void | toWindowed ()
| Passage de l'application en mode fenêtré.
int | createThread (bool(*functionToRun)(int))
| Demande de création d'un thread par l'utilisateur.

## Static Public Member Functions

static Core * | getInstance ()
| Retourne le pointeur de l'instance unique du "Core".
static const char * | getEngineInfos ()
| Retourne les informations sur le moteur de jeu.
static void | doSleep (unsigned long int ms)
| Mise en pause de l'application ou du thread courant.

## Static Public Attributes

static const unsigned int | systemUnk = 0
| Code pour un système inconnu.
static const unsigned int | systemPSP = 1
| Code pour un système PlayStation Portable.
static const unsigned int | systemWin32 = 2
| Code pour un système Windows.

## Detailed Description

Noyau de l'application.

Author:
  U.Speed

## Constructor & Destructor Documentation

Core::~Core | ( |  | ) |

Destructeur par défaut.

Author:
  U.Speed

## Member Function Documentation

int Core::createThread | ( | bool(*)(int) | functionToRun | ) |

Demande de création d'un thread par l'utilisateur.

Author:
  U.Speed

Parameters:

  | functionToRun | bool (*)(int) : pointeur de fonction pour l'initialisation côté utilisateur
  - Retourne bool : "true" si il faut continuer l'exécution du thread.
  - Paramètre int : l'identifiant du thread.

Returns:
  int : l'identifiant du thread (ou -1 pour si le thread n'a pas été créé)

void Core::doSleep | ( | unsigned long int | ms | ) | `[static]`

Mise en pause de l'application ou du thread courant.

Author:
  U.Speed

Parameters:

  | ms | unsigned long int : temps de pause en millisecondes

void Core::endMain | ( |  | ) |

Fonction permettant de quitter la boucle principale.

Author:
  U.Speed

std::string Core::getAppFolder | ( |  | ) |

Retourne le chemin complet de l'application (avec le "/" à la fin).

Author:
  U.Speed

Returns:
  std::string : le chemin complet de l'application

const char * Core::getApplicationTitle | ( |  | ) |

Retourne le titre de l'application.

Author:
  U.Speed

Returns:
  const char* : le titre

const char * Core::getEngineInfos | ( |  | ) | `[static]`

Retourne les informations sur le moteur de jeu.

Author:
  U.Speed

Returns:
  const char* : les informations sur une ligne

unsigned int Core::getFPS | ( |  | ) |

Permet de connaître à combien d'images par seconde le moteur est paramétré.

Par défaut, le moteur tourne à 60 images par seconde.
Il ne s'agit pas d'une mesure mais de ce vers quoi doit tendre le moteur.

Author:
  U.Speed

Returns:
  unsigned int : le nombre d'images par seconde désiré. "0" pour le mode "traitement permanent".

Core * Core::getInstance | ( |  | ) | `[static]`

Retourne le pointeur de l'instance unique du "Core".

Author:
  U.Speed

Returns:
  Core* : l'instance unique du Core

unsigned int Core::getMainVarCount | ( |  | ) |

Retourne le nombre de paramètres passés au programme (via le main).

Author:
  U.Speed

Returns:
  unsigned int : le nombre de paramètres

const char * Core::getMainVars | ( | unsigned int | myIndex | ) |

Retourne les paramètres passés au programme (via le main).

Author:
  U.Speed

Parameters:

  | myIndex | unsigned int : n° du paramètre ( . < this->getMainVarCount())

Returns:
  const char** : le paramètre ou pointeur nul

unsigned int Core::getTargetSystem | ( |  | ) |

Retourne la plateforme pour laquelle est destinée le programme.

Author:
  U.Speed

Returns:
  unsigned int : le système cible (Cf. les constantes "Core::systemXXXXX")

std::string Core::getUserInput | ( | unsigned int | textMaxLen,
|  | std::string const & | defaultText,
|  | std::string const & | comment,
|  | std::string const & | okLabel,
|  | std::string const & | cancelLabel |
| ) |  |  |

Affiche une zone de saisie pour que l'utilisateur entre quelque chose.

Author:
  U.Speed

Parameters:

  | textMaxLen | unsigned int : taille maximale de la saisie que pourra faire l'utilisateur (DLG_USER_INPUT_MAX_LENGTH = 4096 maximum)
  | defaultText | std::string const& : le texte qui sera déjà dans la zone de saisie avant que l'utilisateur agisse
  | comment | std::string const& : la ligne de commentaire pour l'invitation à saisir du texte (127 caractères maximum)
  | okLabel | std::string const& : l'intitulé du bouton "Valider" pour la version Win32
  | cancelLabel | std::string const& : l'intitulé du bouton "Annuler" pour la version Win32

Returns:
  std::string : la saisie de l'utilisateur

std::string Core::getUserInput | ( | unsigned int | textMaxLen,
|  | std::string const & | defaultText |
| ) |  |  |

Affiche une zone de saisie pour que l'utilisateur entre quelque chose.

Author:
  U.Speed

See also:
  std::string Core::getUserInput(unsigned int textMaxLen, std::string defaultText, std::string comment)

Parameters:

  | textMaxLen | unsigned int : taille maximale de la saisie que pourra faire l'utilisateur
  | defaultText | std::string const& : le texte qui sera déjà dans la zone de saisie avant que l'utilisateur agisse

Returns:
  std::string : la saisie de l'utilisateur

std::string Core::getUserInput | ( | unsigned int | textMaxLen,
|  | std::string const & | defaultText,
|  | std::string const & | comment |
| ) |  |  |

Affiche une zone de saisie pour que l'utilisateur entre quelque chose.

Author:
  U.Speed

See also:
  std::string Core::getUserInput(unsigned int textMaxLen, std::string defaultText, std::string comment, std::string okLabel, std::string cancelLabel)

Parameters:

  | textMaxLen | unsigned int : taille maximale de la saisie que pourra faire l'utilisateur (DLG_USER_INPUT_MAX_LENGTH = 4096 maximum)
  | defaultText | std::string const& : le texte qui sera déjà dans la zone de saisie avant que l'utilisateur agisse
  | comment | std::string const& : la ligne de commentaire pour l'invitation à saisir du texte (127 caractères maximum)

Returns:
  std::string : la saisie de l'utilisateur

bool Core::messageBox | ( | const char * | title,
|  | const char * | text,
|  | bool | askYesNo |
| ) |  |  |

Affiche une boîte de message et demande éventuellement à l'utilisateur de répondre "Oui" ou "Non".

Author:
  U.Speed

Parameters:

  | title | const char* : le titre de la boîte de message
  | text | const char* : le texte de la boîte de message
  | askYesNo | bool : pour savoir si l'utilisateur peut choisir "Oui" ou "Non"
  - true : l'utilisateur est amené à répondre par "Oui" ou "Non"
  - false : l'utilisateur est amené à répondre par "Oui" ou "Non"

void Core::messageBox | ( | const char * | title,
|  | const char * | text |
| ) |  |  |

Affiche une boîte de message avec le bouton "Ok" pour quitter.

Author:
  U.Speed

See also:
  bool Core::messageBox(const char *title, const char *text, bool askYesNo)

Parameters:

  | title | const char* : le titre de la boîte de message
  | text | const char* : le texte de la boîte de message

bool Core::messageBox | ( | std::string const & | title,
|  | std::string const & | text,
|  | bool | askYesNo |
| ) |  |  |

Affiche une boîte de message et demande éventuellement à l'utilisateur de répondre "Oui" ou "Non".

Author:
  U.Speed

See also:
  bool Core::messageBox(const char *title, const char *text, bool askYesNo)

Parameters:

  | title | std::string const& : le titre de la boîte de message
  | text | std::string const& : le texte de la boîte de message
  | askYesNo | bool : pour savoir si l'utilisateur peut choisir "Oui" ou "Non"
  - true : l'utilisateur est amené à répondre par "Oui" ou "Non"
  - false : l'utilisateur est amené à répondre par "Oui" ou "Non"

void Core::messageBox | ( | std::string const & | title,
|  | std::string const & | text |
| ) |  |  |

Affiche une boîte de message avec le bouton "Ok" pour quitter.

Author:
  U.Speed

See also:
  bool Core::messageBox(const char *title, const char *text, bool askYesNo)

Parameters:

  | title | std::string const& : le titre de la boîte de message
  | text | std::string const& : le texte de la boîte de message

int Core::run | ( | int | argNumber,
|  | char * | argList[],
|  | void(*)(void) | customInit,
|  | void(*)(unsigned long int) | customMain,
|  | void(*)(void) | customFinish,
|  | USGE_RenderEngine | renderEngine |
| ) |  |  |

Point d'entrée du USpeedGameEngine : lancement du programme.

Author:
  U.Speed

Parameters:

  | argNumber | int : le nombre d'arguments passés
  | argList | char *[] : liste des arguments passés
  | customInit | void (*)(void) : pointeur de fonction pour l'initialisation côté utilisateur
  | customMain | void (*)(unsigned long int) : pointeur de fonction pour le traitement principal côté utilisateur (qui prend en paramètre, le temps écoulé depuis le dernier appel)
  | customFinish | void (*)(void) : pointeur de fonction pour la finalisation côté utilisateur
  | renderEngine | USGE_RenderEngine : le moteur de rendu à utiliser

Returns:
  int : le code de retour de l'application
  - 0 : pas d'erreur
  - 1 : ERREUR : instance du noyau (Core) introuvable
  - 2 : ERREUR : pas de traitement principal (customMain = 0)
  - 3 : ERREUR : Erreur d'initialisation du système.
  - 4 : ERREUR : Erreur d'initialisation de la couche "Vidéo".

void Core::setApplicationTitle | ( | const char * | title | ) |

Permet de définir le titre de l'application.

Author:
  U.Speed

Parameters:

  | title | const char* : le titre

void Core::setFPS | ( | unsigned int | fps | ) |

Permet de définir le nombre d'images par seconde désiré.

Par défaut, le moteur tourne à 60 images par seconde.
Si les calculs sont trop gourmands, l'application peut ramer (surtout pour un nombre d'images par seconde trop élevé).
Si les calculs sont peu consomateurs, l'application effectue le traitement puis se met en attente "iddle" avant le prochain traitement.

Author:
  U.Speed

Parameters:

  | fps | unsigned int : le nombre d'images par seconde souhaité. "0" pour ne pas limiter le moteur : traitement permanent.

void Core::setSuspendFunction | ( | void(*)(bool) | suspendFct | ) |

Permet de définir la fonction à appeler lors de la mise en veille du programme.

Author:
  U.Speed

Parameters:

  | suspendFct | void *(bool) : le pointeur de fonction

void Core::toFullscreen | ( |  | ) |

Passage de l'application en mode plein écran.

Author:
  U.Speed

void Core::toWindowed | ( |  | ) |

Passage de l'application en mode fenêtré.

Author:
  U.Speed

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

- src/Core/Core.hpp
- src/Core/Core.cpp
- src/Core/Core_createThread.cpp
- src/Core/Core_doSleep.cpp
- src/Core/Core_endMain.cpp
- src/Core/Core_getAppFolder.cpp
- src/Core/Core_getApplicationTitle.cpp
- src/Core/Core_getEngineInfos.cpp
- src/Core/Core_getFPS.cpp
- src/Core/Core_getInstance.cpp
- src/Core/Core_getMainVarCount.cpp
- src/Core/Core_getMainVars.cpp
- src/Core/Core_getTargetSystem.cpp
- src/Core/Core_getUserInput.cpp
- src/Core/Core_messageBox.cpp
- src/Core/Core_run.cpp
- src/Core/Core_setApplicationTitle.cpp
- src/Core/Core_setFPS.cpp
- src/Core/Core_setSuspendFunction.cpp
- src/Core/Core_toFullscreen.cpp
- src/Core/Core_toWindowed.cpp