# Photo wall (C)

Un visionneur d'images avec Clutter
Chris Kühl
chrisk@openismus.com
Johannes Schmid
jhs@gnome.org
Marta Maria Casetti
mmcasetti@gmail.com 2013

# Photo wall

      Dans cet exemple, nous allons fabriquer un visionneur d'images simple avec Clutter. Vous apprendrez :

        comment dimensionner et positionner les ClutterActor,
        comment placer une image dans un ClutterActor,
        comment faire des transitions simples avec la structure d'animation de Clutter,
        comment faire réagir les ClutterActor aux événements de la souris,
        et comment récupérer des noms de fichier depuis un répertoire.

# Introduction

Clutter est une bibliothèque pour créer des interfaces utilisateur dynamiques utilisant OpenGL pour l'accélération matérielle. Cet exemple montre une petite partie, mais néanmoins centrale, de la bibliothèque Clutter pour écrire un programme simple, mais sympathique, de visionneur d'images.

To help us reach our goal we will be utilising a few other common pieces of GLib as well. Most importantly, we'll use one `GPtrArray`, a dynamic array of pointers, to hold the file path names. We will also use `GDir`, a utility for working with directories, to access our image directory and gather file paths.

# Création d'un projet dans Anjuta

Avant de commencer à programmer, vous devez ouvrir un nouveau projet dans Anjuta. Ceci crée tous les fichiers qui vous sont nécessaires pour construire et exécuter votre programme plus tard. C'est aussi utile pour tout regrouper en un seul endroit.

Lancez Anjuta et cliquez sur Fichier Nouveau Projet pour ouvrir l'assistant de création de projet.

Choose GTK+ (simple) from the C tab, click Continue, and fill out your details on the next few pages. Use photo-wall as project name and directory.

Assurez-vous d'avoir désactivé Utiliser GtkBuilder pour l'interface utilisateur car nous allons créer l'interface utilisateur manuellement dans cet exemple. Consultez le tutoriel Accordeur de guitare si vous souhaitez savoir comment utiliser le constructeur d'interface GtkBuilder.

Activez Configuration des paquets externes. Sur la page suivante, sélectionnez clutter-1.0 dans la liste pour inclure la bibliothèque Clutter à votre projet.

Cliquez sur Appliquer et votre projet est créé. Ouvrez src/main.c depuis l'onglet Projet ou l'onglet Fichiers. Vous devez voir apparaître du code commençant par les lignes :

#include <config.h> #include <gtk/gtk.h>

# Un aperçu du mur de photos

Notre visionneur d'images vous montre un mur de photos.

Quand une image est cliquée, elle est animée pour remplir la zone d'affichage. Lorsque la photo qui possède le focus est cliquée, elle retourne à sa position d'origine en utilisant une animation qui dure également 500 millisecondes.

# Configuration initiale

La partie de code suivante contient beaucoup de définitions et de variables qui sont utilisées dans les sections suivantes. Servez-vous en comme référence. Copiez ce code au début du fichier src/main.c :

#include <gdk-pixbuf/gdk-pixbuf.h> #include <clutter/clutter.h>

#define STAGE_WIDTH 800 #define STAGE_HEIGHT 600

#define THUMBNAIL_SIZE 200 #define ROW_COUNT (STAGE_HEIGHT / THUMBNAIL_SIZE) #define COL_COUNT (STAGE_WIDTH / THUMBNAIL_SIZE) #define THUMBNAIL_COUNT (ROW_COUNT * COL_COUNT)

#define ANIMATION_DURATION_MS 500

#define IMAGE_DIR_PATH "./berlin_images/"

static GPtrArray *img_paths;

static ClutterPoint unfocused_pos;

# Immersion dans le code

Nous commencerons par analyser la fonction `main()` dans son ensemble. Ensuite nous discuterons des autres parties du programme en détail. Modifiez le fichier src/main.c pour qu'il contienne la fonction `main()`. Vous pouvez aussi supprimer la fonction `create_window()` car on n'en a plus besoin dans cet exemple.

int main(int argc, char *argv[]) { ClutterColor stage_color = { 16, 16, 16, 255 }; ClutterActor *stage = NULL;

if (clutter_init (&argc, &argv) != CLUTTER_INIT_SUCCESS) return 1;

stage = clutter_stage_new(); clutter_actor_set_size(stage, STAGE_WIDTH, STAGE_HEIGHT); clutter_actor_set_background_color(stage, &stage_color); clutter_stage_set_title(CLUTTER_STAGE (stage), "Photo Wall"); g_signal_connect(stage, "destroy", G_CALLBACK(clutter_main_quit), NULL);

load_image_path_names();

guint row = 0; guint col = 0; for(row=0; row < ROW_COUNT; ++row) { for(col=0; col < COL_COUNT; ++col) { const char *img_path = g_ptr_array_index(img_paths, (row * COL_COUNT) + col); GdkPixbuf *pixbuf = gdk_pixbuf_new_from_file_at_size(img_path, STAGE_HEIGHT, STAGE_HEIGHT, NULL); ClutterContent *image = clutter_image_new (); ClutterActor *actor = clutter_actor_new ();

if (pixbuf != NULL) { clutter_image_set_data(CLUTTER_IMAGE(image), gdk_pixbuf_get_pixels(pixbuf), gdk_pixbuf_get_has_alpha(pixbuf) ? COGL_PIXEL_FORMAT_RGBA_8888 : COGL_PIXEL_FORMAT_RGB_888, gdk_pixbuf_get_width(pixbuf), gdk_pixbuf_get_height(pixbuf), gdk_pixbuf_get_rowstride(pixbuf), NULL); }

clutter_actor_set_content(actor, image); g_object_unref(image); g_object_unref(pixbuf);

initialize_actor(actor, row, col); clutter_actor_add_child(stage, actor); } }

/* Show the stage. */ clutter_actor_show(stage);

/* Start the clutter main loop. */ clutter_main();

g_ptr_array_unref(img_paths);

return 0; }

Ligne 4 : configuration de `ClutterColor` en paramétrant les valeurs rouge, vert, bleu et celle de transparence (alpha). Les valeurs sont comprises entre 0 et 255. Pour la transparence, une valeur de 255 représente l'opacité.

Ligne 7 : vous devez initialiser Clutter. Attention, si vous oubliez de le faire, vous aurez de très étranges messages d'erreur. Vous êtes prévenu.

Lines 10‒14: Here we create a new `ClutterStage` . We then set the size using the defines from the previous section and the address of the `ClutterColor` we just defined.

Un `ClutterStage` est le `ClutterActor` de premier niveau sur lequel les autres `ClutterActor` sont disposés.

Line 16: Here we call our function for getting the image file paths. We'll look at this in a bit.

Lines 18‒49: This is where we set up the `ClutterActor`s, load the images and place them into their spot in the image wall. We will look at this in detail in the next section.

Line 52: Show the stage and all its children, meaning our images.

Line 55: Start the Clutter main loop.

# Mise en place de nos acteurs image

Dans Clutter, un acteur est l'élément visuel le plus élémentaire. En gros, tout ce que vous voyez est un acteur.

Dans cette section, nous allons regarder plus en détail la boucle utilisée pour paramétrer les `ClutterActor` qui affichent nos images.

guint row = 0; guint col = 0; for(row=0; row < ROW_COUNT; ++row) { for(col=0; col < COL_COUNT; ++col) { const char *img_path = g_ptr_array_index(img_paths, (row * COL_COUNT) + col); GdkPixbuf *pixbuf = gdk_pixbuf_new_from_file_at_size(img_path, STAGE_HEIGHT, STAGE_HEIGHT, NULL); ClutterContent *image = clutter_image_new (); ClutterActor *actor = clutter_actor_new ();

if (pixbuf != NULL) { clutter_image_set_data(CLUTTER_IMAGE(image), gdk_pixbuf_get_pixels(pixbuf), gdk_pixbuf_get_has_alpha(pixbuf) ? COGL_PIXEL_FORMAT_RGBA_8888 : COGL_PIXEL_FORMAT_RGB_888, gdk_pixbuf_get_width(pixbuf), gdk_pixbuf_get_height(pixbuf), gdk_pixbuf_get_rowstride(pixbuf), NULL); }

clutter_actor_set_content(actor, image); g_object_unref(image); g_object_unref(pixbuf);

initialize_actor(actor, row, col); clutter_actor_add_child(stage, actor); } }

Line 7: Here we want to get the path at the nth location in the `GPtrArray` that is holding our image path names. The nth position is calculated based on `row` and `col`.

Line 8‒23: This is where we actually create the `ClutterActor` and place the image into the actor. The first argument is the path which we access through our `GSList` node. The second argument is for error reporting but we are ignoring that to keep things short.

Line 47: This adds the `ClutterActor` to the stage, which is a container. It also assumes ownership of the `ClutterActor` which is something you'll want to look into as you get deeper into GNOME development. See the `GObject` documentation for the gory details.

# Chargement des images

Oublions un court instant Clutter pour regarder comment nous pouvons obtenir les noms des fichiers contenus dans notre répertoire d'images.

static void load_image_path_names() { /* Ensure we can access the directory. */ GError *error = NULL; GDir *dir = g_dir_open(IMAGE_DIR_PATH, 0, &error); if(error) { g_warning("g_dir_open() failed with error: %s\n", error->message); g_clear_error(&error); return; }

img_paths = g_ptr_array_new_with_free_func (g_free);

const gchar *filename = g_dir_read_name(dir); while(filename) { if(g_str_has_suffix(filename, ".jpg") || g_str_has_suffix(filename, ".png")) { gchar *path = g_build_filename(IMAGE_DIR_PATH, filename, NULL); g_ptr_array_add (img_paths, path); } filename = g_dir_read_name(dir); } }

Lignes 5 et 12 : cela ouvre notre répertoire ou, en cas d'erreur, quitte la fonction après affichage d'un message d'erreur.

Lines 16‒25: The first line gets another file name from the `GDir` we opened earlier. If there was an image file (which we check by looking at its extension, ".png" or ".jpg") in the directory we proceed to prepend the image directory path to the filename and prepend that to the list we set up earlier. Lastly we attempt to get the next path name and reenter the loop if another file was found.

# Mise en place des acteurs

Examinons maintenant le choix de la taille et du positionnement des `ClutterActor` et également la préparation du `ClutterActor` pour une interaction de l'utilisateur.

/* This function handles setting up and placing the rectangles. */ static void initialize_actor(ClutterActor *actor, guint row, guint col) { clutter_actor_set_size(actor, THUMBNAIL_SIZE, THUMBNAIL_SIZE); clutter_actor_set_position(actor, col * THUMBNAIL_SIZE, row * THUMBNAIL_SIZE); clutter_actor_set_reactive(actor, TRUE);

g_signal_connect(actor, "button-press-event", G_CALLBACK(actor_clicked_cb), NULL); }

Ligne 7 : le fait de définir un acteur comme « reactive » signifie qu'il réagit aux événements, au `button-press-event` dans notre cas. Pour le mur de photos, tous les `ClutterActor` du mur doivent être initialisés comme « reactive ».

Ligne 9-12 : nous connectons maintenant l'événement `button-press-event` à la fonction de rappel `actor_clicked_cb` que nous examinons ci-dessous.

À cet instant, nous obtenons un mur d'images qui sont prêtes à être regardées.

# Réaction aux clics

static gboolean actor_clicked_cb(ClutterActor *actor, ClutterEvent *event, gpointer user_data) { /* Flag to keep track of our state. */ static gboolean is_focused = FALSE; ClutterActorIter iter; ClutterActor *child;

/* Reset the focus state on all the images */ clutter_actor_iter_init (&iter, clutter_actor_get_parent(actor)); while (clutter_actor_iter_next(&iter, &child)) clutter_actor_set_reactive(child, is_focused);

clutter_actor_save_easing_state(actor); clutter_actor_set_easing_duration(actor, ANIMATION_DURATION_MS);

if(is_focused) { /* Restore the old location and size. */ clutter_actor_set_position(actor, unfocused_pos.x, unfocused_pos.y); clutter_actor_set_size(actor, THUMBNAIL_SIZE, THUMBNAIL_SIZE); } else { /* Save the current location before animating. */ clutter_actor_get_position(actor, &unfocused_pos.x, &unfocused_pos.y); /* Only the currently focused image should receive events. */ clutter_actor_set_reactive(actor, TRUE);

/* Put the focused image on top. */ clutter_actor_set_child_above_sibling(clutter_actor_get_parent(actor), actor, NULL);

clutter_actor_set_position(actor, (STAGE_WIDTH - STAGE_HEIGHT) / 2.0, 0); clutter_actor_set_size(actor, STAGE_HEIGHT, STAGE_HEIGHT); }

clutter_actor_restore_easing_state(actor);

/* Toggle our flag. */ is_focused = !is_focused;

return TRUE; }

Ligne 1-4 : nous devons être sûr que notre fonction de rappel correspond à la signature requise par notre signal `button_clicked_event`. Dans notre exemple, nous n'utilisons que le premier argument, le `ClutterActor` qui est réellement cliqué.

Quelques mots sur les arguments que nous n'utilisons pas dans cet exemple. L'événement `ClutterEvent` est différent en fonction de l'événement géré. Par exemple, un événement appui sur une touche du clavier produit un `ClutterKeyEvent` à partir duquel vous pouvez obtenir comme information, entre autres, la touche qui a été enfoncée. Pour un événement clic de souris, vous obtenez un `ClutterButtonEvent` à partir duquel vous pouvez connaître les valeurs `x` et `y`. Consultez la documentation de Clutter pour les autres types d'événement `ClutterEvent`.

The `user_data` is what one uses to pass data into the function. A pointer to any data type can be passed in. If you need multiple data to be passed into the callback, you can place the data into a struct and pass its address in.

Ligne 7 : nous définissons un drapeau de type « static » pour enregistrer l'état dans lequel nous sommes : en mode mur ou en mode focus. Nous commençons en mode mur donc aucune image ne possède le focus, par conséquent, nous paramétrons le drapeau à `FALSE` (FAUX) au départ.

Line 12‒14: These set the image actors to receive events if they are focused.

Line 16‒17: Here we set the animation duration and save the current state.

Lines 21‒23: Reaching this code means that one image currently has focus and we want to return to wall mode. Setting a position on a `ClutterActor` begins an animation with the duration that we set in line 17.

Ligne 24 : ces lignes sont atteintes lorsque nous sommes actuellement dans l'état mur et que nous allons donner le focus à un `ClutterActor`. Ici nous enregistrons la position de départ afin de pouvoir le repositionner plus tard.

Ligne 25 : le fait de paramétrer la propriété `reactive` du `ClutterActor` à `TRUE` rend ce `ClutterActor` réactif aux événements. Dans cet état de focus, le seul `ClutterActor` qui doit recevoir des événements est le `ClutterActor` qui est actuellement affiché. Un clic sur ce `ClutterActor` le repositionne à sa position de départ.

Lines 27‒36: This is where we save the current position of the image, set it to receive events and then make it appear above the other images and start animating it to fill the stage.

Line 39: Here we restore the easing state to what was set before we changed it in line 16.

Line 42: Here we toggle the `is_focused` flag to the current state.

Comme mentionné ci-dessus, les `ClutterActor` qui possèdent des valeurs `depth` plus grandes reçoivent les événements mais peuvent autoriser les `ClutterActor` en dessous d'eux à recevoir les événements également. En renvoyant `TRUE`, l'acteur empêche la transmission des événements alors qu'en renvoyant `FALSE` la transmission se fait.

Rappelez-vous cependant que pour recevoir des événements les `ClutterActor` doivent être définis à `reactive`.

# Construction et lancement de l'application

Le programme complet devrait maintenant être prêt à fonctionner. Tout ce dont vous avez besoin est de quelques images à charger. Par défaut, les images sont chargées à partir d'un répertoire berlin_images. Vous pouvez, si vous voulez, modifier la ligne `#define IMAGE_DIR_PATH` qui se trouve au début du fichier pour faire référence à votre répertoire de photos ou créer un répertoire berlin_images en cliquant sur Projet Nouveau répertoire... et en créant un sous-répertoire berlin_images dans le répertoire murdephotos. Assurez-vous de mettre au moins 12 images dans le répertoire !

Après avoir fait cela, cliquez sur Construire Construire le projet pour tout reconstruire, puis sur Exécuter Exécuter pour lancer l'application.

Si vous ne l'avez pas déjà fait, choisissez l'application Debug/src/murdephotos dans la boîte de dialogue qui apparaît. Enfin, cliquez sur Lancer et amusez-vous !

# Implémentation de référence

Si vous rencontrez des difficultés avec ce tutoriel, comparez votre programme à ce programme de référence.