# Photo Wall (C)

Un visualitzador d'imatges fet amb Clutter
Chris Kühl
chrisk@openismus.com
Johannes Schmid
jhs@gnome.org

# Mur de fotografies

      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́

La Clutter és una biblioteca per crear interfícies d'usuari dinàmiques amb OpenGL per beneficiar-se de l'acceleració per maquinari. Aquest exemple mostra una petita, però important, part de la biblioteca Clutter per crear un visualitzador d'imatges simple però atractiu.

Per facilitar l'obtenció del nostre objectiu també s'utilitzaran algunes parts comunes de la GLib. Principalment utilitzarem una `GSList`, una llista enllaçada simple, per contenir els `ClutterActor` i una altra llista pels camins dels fitxers. També utilitzarem la `GDir`, una utilitat per treballar amb directoris, per accedir al directori d'imatges de l'usuari i obtenir-ne els camins dels fitxers.

# 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 Fitxer Nou Projecte 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. Feu 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 miŀ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 <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 FOCUS_DEPTH 100.0 #define UNFOCUS_DEPTH 0.0

#define IMAGE_DIR_PATH "./berlin_images/"

static GSList *actor_list = NULL; static GSList *img_path_list = NULL;

typedef struct Position { float x; float y; } Position;

static Position origin = {0, 0};

# Primers passos en el codi

Es farà 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;

clutter_init(&argc, &argv);

stage = clutter_stage_get_default(); clutter_actor_set_size(stage, STAGE_WIDTH, STAGE_HEIGHT); clutter_stage_set_color(CLUTTER_STAGE (stage), &stage_color);

load_image_path_names();

guint row = 0; guint col = 0; for(row=0; row < ROW_COUNT; ++row) { for(col=0; col < COL_COUNT; ++col) { GSList *img_path_node = g_slist_nth(img_path_list, (row * COL_COUNT) + col); ClutterActor *actor = clutter_texture_new_from_file((gchar *)(img_path_node->data), NULL); initialize_actor(actor, row, col); clutter_container_add_actor(CLUTTER_CONTAINER(stage), actor); actor_list = g_slist_prepend(actor_list, actor); } }

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

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

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.

Línies 9-11: aquí s'obté el `ClutterStage` genèric que proporciona el `clutter_init`. Llavors s'estableix les dimensions amb les definicions de la secció anterior i l'adreça del `ClutterColor` que s'acaba de definir.

Un `ClutterStage` és el `ClutterActor` de més alt nivell on es posen d'altres `ClutterActor`.

Línia 12: aquí es crida una funció pròpia per obtenir els camins a les imatges. Es repassarà el codi d'aquesta una mica més avall.

Línies 14-26: aquí és on defineixen els `ClutterActor`, es carreguen les imatges i es coŀloquen en el seu lloc dins el mur d'imatges. En la secció següent si entrarà en més detall.

Línia 29: mostra l'escenari i tots els seus fills, o sigui totes les imatges.

Línia 32: s'inicia el bucle principal de la Clutter.

# 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.

for(row=0; row < ROW_COUNT; ++row) { for(col=0; col < COL_COUNT; ++col) { GSList *img_path_node = g_slist_nth(img_path_list, (row * COL_COUNT) + col); ClutterActor *actor = clutter_texture_new_from_file((gchar *)(img_path_node->data), NULL); initialize_actor(actor, row, col); clutter_container_add_actor(CLUTTER_CONTAINER(stage), actor); actor_list = g_slist_prepend(actor_list, actor); } }

Línia 5: aquí s'obté el camí a la enèsima posició de la `GSList` que conté el nom del camí a la imatge. El càlcul de la enèsima posició es basa en la `row` i la `col`. El valor retornat és un punter a una `GSList`, la qual és només un node de la llista. S'utilitzarà aquest punter per obtenir el camí real en la línia següent. El primer paràmetre és un punter al capdavant de la llista.

Línia 6: aquí és on es crea realment el `ClutterActor` i se li assigna la imatge dins l'actor. El primer argument és el camí al qual hi ha la imatge a través del node de la `GSList`. El segon argument s'utilitza per informar sobre errades, però s'ignora per fer-ho més breu.

Línia 7: aquesta funció es mirarà amb més detall més endavant.

Línia 8: s'afegeix el `ClutterActor` a l'escenari, el qual és un contenidor. També assumeix la propietat del `ClutterActor`, aspecte que voldreu investigar a mesura que progresseu en el desenvolupament de GNOME. Mireu la documentació del `GObject` pels detalls sòrdids.

Línia 9: s'afegeix el `ClutterActor` a una `GSList` per tal que més tard puguem iterar sobre els `ClutterActor`.

És interessant ressaltar que s'afegeixen els `ClutterActor` al principi en comptes de al final, per tal d'evitar recorre la llista en cada inserció. Veureu sovint `g_slist_prepend` seguit de `g_slist_reverse` perquè és més ràpid que inserir molts objectes al final d'una llista.

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

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); img_path_list = g_slist_prepend(img_path_list, path); } filename = g_dir_read_name(dir); } }

Línies 5 i 12: s'obre el directori de l'usuari o, si es produeix un error, retorna després de mostrar un missatge d'error.

Línies 14-23: la primera línia obté un altre nom de fitxer del `GDir` que s'ha obert anteriorment. Si en el directori hi ha un fitxer d'imatge (es comprova mirant l'extensió sigui «.png» o «.jpg») es concatena el camí del directori i el de la imatge i el resultat es posa al principi de la llista que s'ha establert abans. Finalment s'intenta obtenir el nom de camí següent i en cas que s'hagi trobat un fitxer es torna a entrar al bucle.

# 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;

g_slist_foreach(actor_list, foreach_set_focus_state, &is_focused);

if(is_focused) { clutter_actor_animate(actor, CLUTTER_LINEAR, ANIMATION_DURATION_MS, "x", origin.x, "y", origin.y, "depth", UNFOCUS_DEPTH, "width", (float) THUMBNAIL_SIZE, "height", (float) THUMBNAIL_SIZE, NULL); } else { /*Save the current location before animating. */ clutter_actor_get_position(actor, &origin.x, &origin.y); clutter_actor_set_reactive(actor, TRUE); clutter_actor_animate(actor, CLUTTER_LINEAR, ANIMATION_DURATION_MS, "x", (STAGE_WIDTH - STAGE_HEIGHT) / 2.0, "y", 0.0, "depth", FOCUS_DEPTH, "width", (float) STAGE_HEIGHT, "height", (float) STAGE_HEIGHT, NULL); }

/* 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 de la 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`.

El paràmetre `user_data` és el que es faria servir per passar dades dins la funció. S'hi pot passar un punter a qualsevol tipus de dades. Si necessiteu passar diverses dades a la crida de retorn, podeu posar les dades en una estructura i passar-ne només l'adreça.

Línia 7: s'estableix un indicador estàtic per fer un seguiment de l'esta 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`.

Línia 9: en aquesta línia de codi s'executa un funció personalitzada: `foreach_set_focus_state`, per cada element de `actor_list` se li passa l'adreça de l'indicador `is_focused`. Veurem la definició de la funció `foreach_set_focus_state` en la següent funció.

Línies 13 a 19: si s'executa aquest bloc de codi significa que una imatge té el focus i volem tornar al mode mur. La funció `clutter_actor_animate` s'utilitza per animar una o diverses propietats del `ClutterActor` de l'estat en que es troben a l'estat que s'especifica. Els arguments són els següents:

L'adreça del `ClutterActor` que s'animarà

El mode d'animació que s'utilitzarà. En l'exemple s'utilitza el mode `CLUTTER_LINEAR` per tal de realitzar una animació a velocitat constant.

La durada de l'animació en miŀlisegons. S'ha escollit 500 ms per aquest exemple.

La resta d'arguments són parelles propietat/valor. S'estableix el valor de `x` al valor inicial que tenia el `ClutterActor` abans de tenir el focus.

L'últim argument ha de ser sempre `NULL` per indicar que no es vol canviar cap més propietat.

La propietat `depth` requereix un mica més d'explicació. S'ha de destacar la imatge que té el focus de manera que no quedi darrera d'altres `ClutterActor`. En aquesta secció se li estableix la mateixa profunditat que les altres imatges en el mur.

La profunditat també determina quins `ClutterActor` reben esdeveniments. Un `ClutterActor` amb un valor de profunditat més alt rep els esdeveniments de clic i pot escollir si l'esdeveniment s'envia als `ClutterActor` que estan sota seu. Una mica més avall se'n mostra un exemple.

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.

Línies 27 a 33: és semblant al bloc de codi anterior. Noteu que s'estableix la profunditat per elevar-lo per sobre les altres imatges.

Línia 37: es canvia l'indicador `is_focused` a l'estat actual.

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`.

El codi següent és la funció de conveniència que es passa a `g_slist_foreach`.

static void foreach_set_focus_state(gpointer data, gpointer user_data) { ClutterActor *actor = CLUTTER_ACTOR(data); gboolean is_reactive = *((gboolean*)user_data);

clutter_actor_set_reactive(actor, is_reactive); }

Línies 2 a 5: la signatura d'aquesta funció requereix dos `gpointer`. El primer és un punter al `ClutterActor` que està desat a la `GSList` i l'altre és l'indicador `is_focused` que s'ha establert en la secció anterior. S'han d'adaptar i desar-los per facilitar-ne el seu ús posterior.

Línia 7: segons el valor booleà que es rebi com a paràmetre, s'establirà si el `ClutterActor` ha de respondre a esdeveniments.

# 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 Projecte Directori 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 Munta Munta el projecte per tornar-ho a muntar tot, llavors seleccioneu Executa Executa 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.