From: Jean-Michel Sarlat Date: Mon, 14 Nov 2016 18:46:01 +0000 (+0100) Subject: Doc: les paramètres et quelques petites modifications X-Git-Url: https://melusine.eu.org/syracuse/G/git/?p=svganimation.git;a=commitdiff_plain;h=73c1423ab31887669bb5fcbfcd5003abe74a0c87 Doc: les paramètres et quelques petites modifications --- diff --git a/doc/Makefile b/doc/Makefile index 1656d52..c4fdd58 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -4,4 +4,4 @@ TEX = $(patsubst %.text,%.tex,$(TXT)) html: $(HTM) $(HTM) : %.html : %.md - pandoc -s --ascii --toc --template page-html.tmpl --email-obfuscation=references -f markdown -t html $< > $@ + pandoc -s --toc --template page-html.tmpl --email-obfuscation=references -f markdown -t html $< > $@ diff --git a/doc/index.xml b/doc/index.xml index 1717411..3c39560 100644 --- a/doc/index.xml +++ b/doc/index.xml @@ -1,4 +1,4 @@ - + Documentation du projet SVGAnimation Syracuse diff --git a/doc/page.html b/doc/page.html index 4ce29b5..1c10097 100644 --- a/doc/page.html +++ b/doc/page.html @@ -1,5 +1,4 @@
-

Participants : Chupin Maxime, Sarlat Jean-Michel.

-

Interface du dépôt Git : http://melusine.eu.org/syracuse/G/git/?p=svganimation.git;a=summary

-

L'objectif est de développer, en particulier, du code Javascript afin de présenter des animations de fichiers SVG produits, en particulier, par MetaPost. Ce développement n'étant pas tout à fait prédéterminé, il sera constitué à partir de l'exploration de différents scénarios de présentation de ces animations et des modes de construction des fichiers SVG.

+

Interface du dépôt Git : http://melusine.eu.org/syracuse/G/git/?p=svganimation.git;a=summary

+

L'objectif est de développer, en particulier, du code Javascript afin de présenter des animations de fichiers SVG produits, en particulier, par MetaPost. Ce développement n'étant pas tout à fait prédéterminé, il sera constitué à partir de l'exploration de différents scénarios de présentation de ces animations et des modes de construction des fichiers SVG.

-Les différents exemples se charge en cliquant sur le bouton dédié. Ceci n'est pas le comportement par défaut, c'est du code JavaScript qui permettra de choisir quand l'animation se charge. Il s'agit d'éviter de charger toutes les animations présentes sur cette page, cela serait bien trop lourd. +Les différents exemples se charge en cliquant sur le bouton dédié. Ceci n'est pas le comportement par défaut, c'est du code JavaScript qui permettra de choisir quand l'animation se charge. Il s'agit d'éviter de charger toutes les animations présentes sur cette page, cela serait bien trop lourd.

-Nous présentons, dans la section XX, le code qui permet de charger l'animation sur demande. +Nous présentons, dans la section Chargement différé, le code qui permet de charger l'animation sur demande.

Installation

-

Le fichier SVGAnimation.js (que l'on supposera dans un répertoire nommé js) est à charger dans la page html en mettant les lignes suivantes :

+

Le fichier SVGAnimation.js (que l'on supposera dans un répertoire nommé js) est à charger dans la page html en mettant les lignes suivantes :

<script type="text/javascript" src="js/SVGAnimation.js"></script>

Principe

-

Le principe est simple : on dispose d'un ensemble d'images au format SVG qui constituent, par une suite chronologique, une animation à visionner. La libraire SVGAnimation permet de visionner cette animation dans une page HTML grâce à JavaScript.

+

Le principe est simple : on dispose d'un ensemble d'images au format SVG qui constituent, par une suite chronologique, une animation à visionner. La libraire SVGAnimation permet de visionner cette animation dans une page HTML grâce à JavaScript.

La famille d'images

-

Les différentes images composant l'animation doivent se nommer avec un prefixe suivi d'un nombre (indice), celui-ci pouvant être formater de différente façons :

+

Les différentes images composant l'animation doivent se nommer avec un prefixe suivi d'un nombre (indice), celui-ci pouvant être formater de différente façons :

monfichier-1.svg  monfichier-2.svg monfichier-3.svg ...

ou, autre exemple :

monfichier-001.svg  monfichier-002.svg monfichier-003.svg ...
-

Nous verrons comment gérer le formatage de l'indice des images dans les sections suivantes.

+

Nous verrons comment gérer le formatage de l'indice des images dans les sections suivantes.

-L'idée d'une telle librairie est venue du fait que le logiciel MetaPost permet de produire des images SVG, et nous l'utilisons abondamment pour la production d'animations. +L'idée d'une telle librairie est venue du fait que le logiciel MetaPost permet de produire des images SVG, et nous l'utilisons abondamment pour la production d'animations.

L'utilisation

-

Côté HTML

-

La librairie SVGAnimation définit le prototype javascript Animation. Pour l'utiliser il faut déclarer une balise HTML div avec un identifiant (id) unique. Choisissons pour l'exemple XXXX. À l'intérieur de ces balises, il faut :

+

Côté HTML

+

La librairie SVGAnimation définit le prototype javascript Animation. Pour l'utiliser il faut déclarer une balise HTML div avec un identifiant (id) unique. Choisissons pour l'exemple XXXX. À l'intérieur de ces balises, il faut :

    -
  • une balise img contenant un image svg qui servira de vignette à l'animation;
    • -
  • une balise div avec l'identifiant id="XXXX_message" où XXXX est l'identifiant de la balise englobante. Dans cette balise message, on y met, si on le souhaite, un message à afficher avant le chargement de l'animation;
    • +
  • une balise img contenant un image svg qui servira de vignette à l'animation;
    • +
  • une balise div avec l'identifiant id="XXXX_message" où XXXX est l'identifiant de la balise englobante. Dans cette balise message, on y met, si on le souhaite, un message à afficher avant le chargement de l'animation;
  • une balise div avec l'identifiant id="XXXX_boutons".
-

En supposant que les images SVG se trouvent dans un répertoire nommé svg, voici un exemple d'une telle structure :

+

En supposant que les images SVG se trouvent dans un répertoire nommé svg, voici un exemple d'une telle structure :

<div id="anim1">
   <img src="svg/ellipsographe-1.svg" alt="animation1"/>
   <div class="message" id="anim1_message">Chargement</div>
   <div id="anim1_boutons"></div>
 </div>
-

Côté JavaScript

-

Une fois qu'on a la structure HTML présentée ci-dessus, il est nécessaire d'ajouter un peu de code JavaScript pour permettre à l'animation de se jouer.

+

Côté JavaScript

+

Une fois qu'on a la structure HTML présentée ci-dessus, il est nécessaire d'ajouter un peu de code JavaScript pour permettre à l'animation de se jouer.

Construire l'objet Animation

-

Le constructeur du prototype JavaScript s'utilise, pour l'exemple donné à la section précédente, de la façon suivante :

+

Le constructeur du prototype JavaScript s'utilise, pour l'exemple donné à la section précédente, de la façon suivante :

var anim = new Animation('XXXX','svg/ellipsographe-',1,91);
 anim.loopOnload();
-

XXXX est l'identifiant de la balise div HTML englobante, svg/ellipsographe- est le préfixe dont on a parlé plus haut, 1 est l'indice de la première image à animer, et 91 l'indice de la dernière.

+

XXXX est l'identifiant de la balise div HTML englobante, svg/ellipsographe- est le préfixe dont on a parlé plus haut, 1 est l'indice de la première image à animer, et 91 l'indice de la dernière.

anim.loopOnload() permet le chargement de l'animation.

-

Une fois celle-ci chargée, il faut en permettre la lecture qui se fait grâce à un nouvel objet nommé Controle. Ce contrôle s'utilise en fait comme ceci :

+

Une fois celle-ci chargée, il faut en permettre la lecture qui se fait grâce à un nouvel objet nommé Controle. Ce contrôle s'utilise en fait comme ceci :

var anim = new Animation('XXXX','svg/ellipsographe-',1,91);
 anim.loopOnload();
 var player = new Controle(anim);
 player.connect();
-

Nous verrons par la suite comment personnaliser le contrôle de la lecture de l'animation.

-

Tout ceci n'est toujours pas suffisant car il faut exécuter ce code JavaScript. Ceci peut être fait grâce à JQuery par exemple, en exécutant ces quatre lignes de code à l'ouverture de la fenêtre :

+

Nous verrons par la suite comment personnaliser le contrôle de la lecture de l'animation.

+

Tout ceci n'est toujours pas suffisant car il faut exécuter ce code JavaScript. Ceci peut être fait grâce à JQuery par exemple, en exécutant ces quatre lignes de code à l'ouverture de la fenêtre :

$(window).load(function() {
     var anim = new Animation('XXXX','svg/ellipsographe-',1,91);
     anim.loopOnload();
     var player = new Controle(anim);
     player.connect();
 });
-

Bien sûr, ceci nécessite le chargement, dans la page HTML, de la librairie JQuery.

-

Le résultat

+

Bien sûr, ceci nécessite le chargement, dans la page HTML, de la librairie JQuery.

+

Le résultat

Tout ceci donne le code suivant

<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
 <script type="text/javascript" src="../SVGAnimation.js"></script>
@@ -113,22 +113,23 @@ Chargement...
-

Il est possible de différer le chargement de l'animation en créant une fonction Javascript.

+

Chargement différé

+

On peut laisser le chargement d'une animation à la demande en créant une fonction Javascript.

function charge_anim2() {
   var a = new Animation('anim2','svg/ellipsographe-',1,91);
   a.loopOnload();
   var b = new Controle(a);
   b.connect();
 }
-

Fonction qui sera liée à l'événement onclick d'un bouton proposant, à l'internaute, le chargement de l'animation...

+

Fonction qui sera liée à l'événement onclick d'un bouton proposant justement le chargement de l'animation...

<div id="anim2"
   style="margin:10px auto;padding:10px;width:354px;border:2px solid #AAA;border-radius:4px">
  <img src="../ellipsographe/svg/ellipsographe-1.svg" alt="animation1" style="width:330px;height:240px"/>
  <div class="message" id="anim2_message">Ellipsographe</div>
  <div id="anim2_boutons"><button onclick="charge_anim2();">Charger l'animation</button></div>
 </div>
-

On peut en profiter pour adapter le style des éléments englobants.

-
+

Dans le même temps, le style des éléments englobants a été adapté.

+
animation1
Ellipsographe @@ -139,7 +140,18 @@ Charger l'animation
-

Les paramètres

+

Les paramètres

+

L'objet Animation ne possède que deux propriétés configurables, autres que celles (4) qui lui sont passées en argument.

+

• delai (valeur par défaut : 50) — C'est la durée, en millisecondes, entre deux images.

+
var a = new Animation('anim','svg/pre',1,100);
+a.delai = 200;
+a.loopOnload();
+

Ceci fixera le défilement à 5 images/s. Un player comme ceux que nous vous proposons ci-dessus peut modifier cette valeur.

+

• pad (valeur par défaut : 0) — Ce paramètre n'a d'effet que s'il est supérieur ou égal à 2, il permet de fixer la longueur des index des images en complétant avec des 0.

+
var a = new Animation('anim','svg/pre',1,100);
+a.pad = 3;
+a.loopOnload();
+

Les images chargées seront, successivement, svg/pre001.svg, svg/pre002.svg, ..., svg/pre100.svg.

Les players

SVGPlayerOne.js

SVGPlayerButtons.js

@@ -155,9 +167,9 @@ Charger l'animation
  • La famille d'images
  • L'utilisation
  • Les players
    • SVGPlayerOne.js
      • diff --git a/doc/page.md b/doc/page.md index b1816df..0ef33ed 100644 --- a/doc/page.md +++ b/doc/page.md @@ -1,4 +1,3 @@ -