ENIB S5-OBJ_Rust Etape_1 - Sujet sur les collaborations

{} Contexte : Affichage d’une fenêtre graphique

Commencez par récupérer le code Entities.zip en Rust fourni pour ce labo et ouvrez un terminal dans le dossier.
La commande subl . ouvrira le projet entier dans sublime text, évidemment, seulement si vous avez bien suivi les consignes sur l’environnement de travail données lors du labo de rappel.
Dans le projet, vous trouverez les fichiers suivants :

src/s5.rs : contenant du code utilitaire qui nous sera nécessaire pour dessiner, gérer les événements et calculer la cinématique des éléments graphiques que nous afficherons sur la fenêtre.
Vous n'aurez jamais à modifier ce fichier.
Survolez rapidement ce code. Vous pouvez le faire assez confortablement en ouvrant la documentation qui peut être obtenue avec la commande :
cargo doc --no-deps --open
Remarquez que ce code fournit, entre autres, les types suivants :
- Point : un point en 2D,
- Rect : la dimension d’un rectangle (largeur, hauteur),
- Color : la couleur en rgb,
- Screen : l’écran sur lequel dessiner. Ce type fournit tous les services pour dessiner des formes graphiques (lignes, rectangles, ellipses…),
- KineticState : ce type mémorise la position, la rotation et les vitesses d’une entité graphique et fournit des fonctionnalités pour simuler la physique de manière simpliste.
src/simu.rs : contenant le type Window dans sa version minimale. Ce type sera notre fenêtre graphique.
src/lib.rs : constituant le programme principal qui se chargera à terme de créer les entités qui peupleront la fenêtre graphique.
La fonction populate_window() servira à cet effet.
Pour le moment, elle ne fait que générer de façon aléatoire les données qui nous seront nécessaires à l’instanciation de 16 objets graphiques, telles que leurs propriétés cinématiques, leur couleur et leur dimension.
Assurez-vous d'avoir bien compris de quelle partie du code il s'agit avant d'avancer.

La compilation du code fourni s’obtient en tapant dans le terminal la commande cargo build.
Celle-ci produira une bibliothèque.

Pour exécuter l’application, il faudra taper ./run_s5obj.sh (sous Linux) ou .\run_s5obj.bat (sous Windows).
Ce script lance une application Python qui ouvre une fenêtre graphique et se sert de la bibliothèque en Rust pour en déterminer le contenu.
Dans l’état actuel, le code fourni ne fait rien d’autre qu’afficher une fenêtre vide capable de capturer certains événements de la souris.
Dans la console, toutes les 5 secondes, le temps écoulé s'affiche.

Enfin, pour nettoyer le code (par exemple, avant de le déplacer d’un support à l’autre) tapez cargo clean.

Attention ! Avant de vous lancer dans le sujet de ce labo, il faut avoir lu et compris le code donné dans les fichiers lib.rs et simu.rs et survolé celui dans s5.rs !

Il faudra partir du code fourni et implémenter le diagramme de classes suivant.
Attention, faute de place le diagramme n’est pas exhaustif.
Regardez bien le code fourni, la collaboration entre Window et Rect est déjà implémentée.

{} Classe Entity

Dans le fichier src/simu.rs, à la suite du type Window et son implémentation, déclarez la classe Entity, comme indiqué dans le diagramme de classes (sans oublier la composition avec le type Color et celle avec le type KineticState dont le code est donné par le module s5 (voir fichier s5.rs)).
Initialement, toute entité sera dessinée comme un carré, par la suite nous améliorerons cela en permettant la création de formes différentes.

Implémentez le type Entity en fournissant les méthodes suivantes :

un constructeur (fonction new()) qui reçoit en paramètre :
- un objet de type KineticState,
- un objet de type Color,
- la dimension de son côté, et utilise ces paramètres pour initialiser ses membres.
  Remarquez que les données passées en paramètre doivent être stockées.
  Dans ce cas, les bonnes pratiques conseillent d’utiliser un passage des paramètres par valeur.
  Le compilateur Rust déplacera automatiquement ces données à l’emplacement de destination en évitant les copies inutiles.
une fonction membre draw() qui ne renvoie rien et reçoit en paramètre un objet de type Screen qui représente l’écran sur lequel dessiner.
Le dessin d’un carré s’obtient en invoquant la fonction rectangle() du type Screen.
Vous pouvez voir le prototype de cette fonction dans le module s5 et vous remarquerez qu’elle doit recevoir en paramètre :
- une référence partagée (non-mutable) sur un objet de type Point (la position du carré),
- une référence partagée (non-mutable) sur un objet de type Rect (la dimension du carré),
- une référence partagée (non-mutable) optionnelle sur un objet de type Rect (la dimension du carré interne, lorsqu’on ne veut dessiner qu’un cadre carré),
- l’angle de rotation,
- la couleur du carré.
Dans la fonction draw() de la classe Entity, préparez toutes ces données avant d’invoquer la fonction rectangle().
Voir exemple ici✍
Exemple d’instructions pour dessiner un cadre carré rouge en position (1.0, 1.0), de dimension 10.0x20.0, dont l’épaisseur du cadre fait 25 % du carré, et avec une rotation initiale de 15.0 degrés.
L’objet screen doit être de type s5::Screen :
```
let point = s5::Point {x: 1.0, y: 1.0};
let size = s5::Rect {w: 10.0, h: 20.0};
let inner_size = s5::Rect {w: 10.0 * 0.75, h: 20.0 * 0.75};
screen.rectangle(
    &point,
    &size,
    Some(&inner_size),
    15.0,  // angle de rotation
    s5::Color{r:255, g:0, b:0},
); 
```
Attention ! Évidemment cet exemple est à adapter à votre problème.
.

Quelle accessibilité faut-il donner aux fonctions de la classe Entity ? Où doivent-elle être visibles ?

Si vous avez bien paramétré votre éditeur de texte, vous devez voir les erreurs apparaître en rouge, ce qui vous aidera pour les corriger tout de suite.
Autrement, il faudra compiler régulièrement pour les corriger au fur et à mesure.
Évidemment, paramétrer correctement votre éditeur fait partie des consignes initiales.
Dans l’état actuel, rien ne changera dans les fenêtres.
Pour cela, il faut commencer par modifier la classe Window pour qu'elle contienne plusieurs entités comme indiqué dans le diagramme de classes.

{} Classe Window – composition à plusieurs composants