# Photo wall (C)

Un visualitzador d'imatges fet amb Clutter
Chris Kühl
chrisk@openismus.com
Johannes Schmid
jhs@gnome.org
Marta Maria Casetti
mmcasetti@gmail.com 2013

# Photo wall

      En aquest exemple es construirà un visualitzador d'imatges senzill amb la Clutter. Aprendreu a:

        Com dimensionar i posicionar els ClutterActor
        Com posar una imatge en un ClutterActor
        Com fer transicions senzilles utilitzant l'entorn de treball d'animacions de la Clutter
        Com fer que els ClutterActor responguin a esdeveniments del ratolí
        Com obtenir els noms dels fitxers d'un directori

# Introducció

Clutter is a library for creating dynamic user interfaces using OpenGL for hardware acceleration. This example demonstrates a small, but central, part of the Clutter library to create a simple but attractive image viewing program.

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.

# Creació d'un projecte a l'Anjuta

Abans de començar a programar, heu de crear un projecte nou a l'Anjuta. L'Anjuta crearà tots els fitxers necessaris per, més endavant, construir i executar el codi. És molt útil per així mantenir-ho tot junt.

Inicieu l'Anjuta i feu clic a FitxerNouProjecte per obrir l'auxiliar de projectes.

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.

Assegureu-vos que Utilitza el GtkBuilder per a la interfície d'usuari està desactivat ja que en aquest programa d'aprenentatge es crearà la interfície d'usuari manualment. Doneu una ullada al programa d'aprenentatge Afinació de guitarres que utilitza el constructor d'interfícies (GtkBuilder).

Habiliteu Configura els paquets externs. A la llista de la pàgina següent seleccioneu clutter-1.0 per incloure la biblioteca Clutter al projecte.

Feu clic a Aplica i es crearà el projecte. Obriu src/main.c des de les pestanyes Projecte o Fitxer. Hauríeu de veure una mica de codi que comença amb les línies:

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

# Una mirada al Mur de Fotografies

El visualitzador d'imatges mostra un mur d'imatges a l'usuari.

Quan es fa clic a una imatge, aquesta s'anima per cobrir l'àrea de visualització. Quan es fa clic a la imatge que té el focus, aquesta retorna a la seva posició original amb una animació que dura exactament 500 mil·lisegons.

# Configuració inicial

El segment de codi que ve a continuació conté la majoria de definicions i variables que utilitzarem en les seccions següents. Podeu utilitzar-ho com a referència per a les seccions posteriors. Copieu aquest codi a l'inici de 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;

# Primers passos en el codi

Es donarà primer una ullada general a la funció `main()`. Després es mirarà la resta de seccions del codi en més profunditat. Canvieu el fitxer src/main.c perquè contingui aquesta funció `main()`. Podeu esborrar la funció `create_window()` perquè no fa falta per aquest 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; }

Línia 4: el `ClutterColor` es defineix establint els valors del vermell, el verd, el blau i de la transparència (alfa). El rang de valors és de 0 a 255. Per la transparència un valor de 255 és opac.

Línia 7: heu d'inicialitzar la Clutter. Si us en descuideu, obtindreu errors molt estranys. Tingueu-ho en compte.

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` és el `ClutterActor` de més alt nivell on es posen d'altres `ClutterActor`.

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.

# Configuració dels actors d'imatges

A la Clutter un actor és l'element visual bàsic. Tot el que es veu és un actor.

En aquesta secció, es farà una repassada amb més detall al bucle que s'utilitza per definir els `ClutterActor` que mostraran les imatges.

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.

# Càrrega de les imatges

Abans de continuar amb la Clutter s'explica a continuació com es poden obtenir els noms dels fitxers del directori d'imatges de l'usuari.

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); } }

Lines 5 and 12: This opens our directory or, if an error occurred, returns after printing an error message.

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.

# Configuració dels actors

En aquesta secció es descriu com dimensionar i posicionar els `ClutterActor` i com preparar-los per la interacció amb l'usuari.

/* 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); }

Línia 7: establir un actor en mode reactiu significa que reaccionarà als esdeveniments, com ara el `button-press-event` de l'exemple que segueix. Pel mur de fotografies, tots els `ClutterActor` del mur s'han d'establir com a reactius inicialment.

Línia 9 a 12: es connecta el `button-press-event` a la crida de retorn `actor_clicked_cb`, que es detallarà tot més endavant.

En aquest moment ja s'ha obtingut un mur de fotografies a punt per visualitzar-se.

# Reacció als 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; }

Línies 1 a 4: assegureu-vos que la funció de crida de retorn coincideix amb la signatura del senyal `button_clicked_event`. A l'exemple només es fa servir el primer argument, el `ClutterActor` al que es fa clic.

Un breu resum sobre els arguments que no s'utilitzen en aquest exemple. El `ClutterEvent` és diferent depenent de quin esdeveniment es gestiona. Per exemple, un esdeveniment de tecla produeix un `ClutterKeyEvent` del qual podeu obtenir la tecla premuda a més d'altra informació. Pels esdeveniments de ratolí obteniu un `ClutterButtonEvent` del qual obtindreu els valors `x` i `y`. Vegeu la documentació de la Clutter per altres tipus de `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.

Línia 7: s'estableix un indicador estàtic per fer un seguiment de l'estat d'execució: en mode mur o en mode focus. A l'inici s'està en mode mur i per tan cap imatge té el focus. Així, s'estableix l'indicador a `FALSE`.

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.

Línia 24: si s'arriba a aquesta línia de codi és que ens l'aplicació està en l'estat de mur i s'ha de donar el focus a un `ClutterActor`. Es desa la posició inicial per poder tornar-hi més endavant.

Línia 25: s'estableix la propietat `reactive` del `ClutterActor` a `TRUE` permetent que reaccioni als esdeveniments. En el mode focus l'únic `ClutterActor` que ha de rebre esdeveniments és el `ClutterActor` que es visualitza. Fent-li clic tornarà a la seva posició inicial.

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.

Com s'ha comentat més amunt, els `ClutterActor` amb el valor de `depth` més alt rebran els esdeveniments però poden passar-lo als `ClutterActor` de sota seu. Si retorna `TRUE` no es passarà l'esdeveniment als `ClutterActor` de sota, mentre que si es retorna `FALSE` es passarà.

Recordeu, però, que per rebre esdeveniments els `ClutterActor` s'han d'establir com a `reactive`.

# Muntatge i execució de l'aplicació

Tot el codi hauria d'estar llest per funcionar. Només fan falta les imatges per carregar. Per defecte, les imatges es carreguen des del directori berlin_images. Si voleu, podeu canviar-lo a línia `#define IMAGE_DIR_PATH` que està al principi del fitxer perquè apunti al directori de fotos de l'usuari, o podeu crear un directori berlin_images fent clic a ProjecteDirectori nou.... El directori berlin_images serà un subdirectori del directori photo-wall. Comproveu que poseu com a mínim dotze imatges en el directori.

Un cop ho hàgiu fet, feu clic a MuntaMunta el projecte per tornar-ho a muntar tot, llavors seleccioneu ExecutaExecuta per iniciar l'aplicació.

Si encara no ho heu fet, seleccioneu l'aplicació Debug/src/photo-wall en el diàleg que apareix. Per acabar, premeu Executa i ja podreu provar l'aplicació.

# Implementació de referència

Si teniu algun problema amb el programa d'aprenentatge, compareu el codi amb el codi de referència.