doc/page.html

   1 <div>
   2 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
   3 <script type="text/javascript" src="../SVGAnimation.js"></script>
   4 <script type="text/javascript" src="../SVGPlayerOne.js"></script>
   5 <script type="text/javascript">
   6   function charge(i,p,a,b) {
   7     var anim = new Animation(i,p,a,b);
   8     anim.loopOnload();
   9     var player = new Controle(anim);
  10     player.connect();
  11   }
  12   function charge_anim2() {
  13     var a = new Animation('anim2','../ellipsographe/svg/ellipsographe-',1,91);
  14     a.loopOnload();
  15     var b = new Controle(a);
  16     b.connect();
  17   }
  18   $(window).load(function() {
  19     anim = new Animation('XXXX','../ellipsographe/svg/ellipsographe-',1,91);
  20     anim.loopOnload();
  21     player = new Controle(anim);
  22     player.connect();
  23     });
  24 </script>
  25 <p><strong>Participants :</strong> Chupin Maxime, Sarlat Jean-Michel.</p>
  26 <p><strong>Interface du dépôt Git :</strong> <a href="http://melusine.eu.org/syracuse/G/git/?p=svganimation.git;a=summary" class="uri">http://melusine.eu.org/syracuse/G/git/?p=svganimation.git;a=summary</a></p>
  27 <p>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.</p>
  28 <div class="alert alert-warning">
  29 <p>
  30 Les différents exemples se charge en cliquant sur le bouton dédié. Ceci <strong>n'est pas</strong> 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.
  31 </p>
  32 <p>
  33 Nous présentons, dans la section <a
  34 href="#chargement-différé">Chargement différé</a>, le code qui permet de charger l'animation sur demande.
  35 </p>
  36 </div>
  37 <h2 id="installation">Installation</h2>
  38 <p>Le fichier <code>SVGAnimation.js</code> (que l'on supposera dans un répertoire nommé <code>js</code>) est à charger dans la page <code>html</code> en mettant les lignes suivantes :</p>
  39 <pre><code>&lt;script type=&quot;text/javascript&quot; src=&quot;js/SVGAnimation.js&quot;&gt;&lt;/script&gt;</code></pre>
  40 <h2 id="principe">Principe</h2>
  41 <p>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 <code>SVGAnimation</code> permet de visionner cette animation dans une page HTML grâce à JavaScript.</p>
  42 <h3 id="la-famille-dimages">La famille d'images</h3>
  43 <p>Les différentes images composant l'animation doivent se nommer avec un <em>prefixe</em> suivi d'un nombre (indice), celui-ci pouvant être formater de différente façons :</p>
  44 <pre><code>monfichier-1.svg  monfichier-2.svg monfichier-3.svg ...</code></pre>
  45 <p>ou, autre exemple :</p>
  46 <pre><code>monfichier-001.svg  monfichier-002.svg monfichier-003.svg ...</code></pre>
  47 <p>Nous verrons comment gérer le formatage de l'indice des images dans les sections suivantes.</p>
  48 <div class="alert alert-info">
  49 <p>
  50 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.
  51 </p>
  52 </div>
  53 <h2 id="lutilisation">L'utilisation</h2>
  54 <h3 id="côté-html">Côté HTML</h3>
  55 <p>La librairie <code>SVGAnimation</code> définit le <em>prototype</em> javascript <code>Animation</code>. Pour l'utiliser il faut déclarer une balise HTML <code>div</code> avec un identifiant (<code>id</code>) unique. Choisissons pour l'exemple <code>XXXX</code>. À l'intérieur de ces balises, il faut :</p>
  56 <ul>
  57 <li>une balise <code>img</code> contenant un image <code>svg</code> qui servira de vignette à l'animation;</li>
  58 <li>une balise <code>div</code> avec l'identifiant <code>id=&quot;XXXX_message&quot;</code> où <code>XXXX</code> est l'identifiant de la balise englobante. Dans cette balise <em>message</em>, on y met, si on le souhaite, un message à afficher avant le chargement de l'animation;</li>
  59 <li>une balise <code>div</code> avec l'identifiant <code>id=&quot;XXXX_boutons&quot;</code>.</li>
  60 </ul>
  61 <p>En supposant que les images SVG se trouvent dans un répertoire nommé <code>svg</code>, voici un exemple d'une telle structure :</p>
  62 <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;anim1&quot;</span><span class="kw">&gt;</span>
  63   <span class="kw">&lt;img</span><span class="ot"> src=</span><span class="st">&quot;svg/ellipsographe-1.svg&quot;</span><span class="ot"> alt=</span><span class="st">&quot;animation1&quot;</span><span class="kw">/&gt;</span>
  64   <span class="kw">&lt;div</span><span class="ot"> class=</span><span class="st">&quot;message&quot;</span><span class="ot"> id=</span><span class="st">&quot;anim1_message&quot;</span><span class="kw">&gt;</span>Chargement<span class="kw">&lt;/div&gt;</span>
  65   <span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;anim1_boutons&quot;</span><span class="kw">&gt;&lt;/div&gt;</span>
  66 <span class="kw">&lt;/div&gt;</span></code></pre></div>
  67 <h3 id="côté-javascript">Côté JavaScript</h3>
  68 <p>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.</p>
  69 <h4 id="construire-lobjet-animation">Construire l'objet <code>Animation</code></h4>
  70 <p>Le <em>constructeur</em> du prototype JavaScript s'utilise, pour l'exemple donné à la section précédente, de la façon suivante :</p>
  71 <div class="sourceCode"><pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> anim <span class="op">=</span> <span class="kw">new</span> <span class="at">Animation</span>(<span class="st">&#39;XXXX&#39;</span><span class="op">,</span><span class="st">&#39;svg/ellipsographe-&#39;</span><span class="op">,</span><span class="dv">1</span><span class="op">,</span><span class="dv">91</span>)<span class="op">;</span>
  72 <span class="va">anim</span>.<span class="at">loopOnload</span>()<span class="op">;</span></code></pre></div>
  73 <p><code>XXXX</code> est l'identifiant de la balise <code>div</code> HTML <em>englobante</em>, <code>svg/ellipsographe-</code> est le préfixe dont on a parlé plus haut, <code>1</code> est l'indice de la première image à animer, et <code>91</code> l'indice de la dernière.</p>
  74 <p><code>anim.loopOnload()</code> permet le chargement de l'animation.</p>
  75 <p>Une fois celle-ci chargée, il faut en permettre la lecture qui se fait grâce à un nouvel objet nommé <code>Controle</code>. Ce contrôle s'utilise en fait comme ceci :</p>
  76 <div class="sourceCode"><pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> anim <span class="op">=</span> <span class="kw">new</span> <span class="at">Animation</span>(<span class="st">&#39;XXXX&#39;</span><span class="op">,</span><span class="st">&#39;svg/ellipsographe-&#39;</span><span class="op">,</span><span class="dv">1</span><span class="op">,</span><span class="dv">91</span>)<span class="op">;</span>
  77 <span class="va">anim</span>.<span class="at">loopOnload</span>()<span class="op">;</span>
  78 <span class="kw">var</span> player <span class="op">=</span> <span class="kw">new</span> <span class="at">Controle</span>(anim)<span class="op">;</span>
  79 <span class="va">player</span>.<span class="at">connect</span>()<span class="op">;</span></code></pre></div>
  80 <p>Nous verrons par la suite comment personnaliser le contrôle de la lecture de l'animation.</p>
  81 <p>Tout ceci n'est toujours pas suffisant car il faut exécuter ce code JavaScript. Ceci peut être fait grâce à <code>JQuery</code> par exemple, en exécutant ces quatre lignes de code à l'ouverture de la fenêtre :</p>
  82 <div class="sourceCode"><pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="at">$</span>(window).<span class="at">load</span>(<span class="kw">function</span>() <span class="op">{</span>
  83     <span class="kw">var</span> anim <span class="op">=</span> <span class="kw">new</span> <span class="at">Animation</span>(<span class="st">&#39;XXXX&#39;</span><span class="op">,</span><span class="st">&#39;svg/ellipsographe-&#39;</span><span class="op">,</span><span class="dv">1</span><span class="op">,</span><span class="dv">91</span>)<span class="op">;</span>
  84     <span class="va">anim</span>.<span class="at">loopOnload</span>()<span class="op">;</span>
  85     <span class="kw">var</span> player <span class="op">=</span> <span class="kw">new</span> <span class="at">Controle</span>(anim)<span class="op">;</span>
  86     <span class="va">player</span>.<span class="at">connect</span>()<span class="op">;</span>
  87 <span class="op">}</span>)<span class="op">;</span></code></pre></div>
  88 <p>Bien sûr, ceci nécessite le chargement, dans la page HTML, de la librairie <code>JQuery</code>.</p>
  89 <h4 id="le-résultat">Le résultat</h4>
  90 <p>Tout ceci donne le code suivant</p>
  91 <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;script</span><span class="ot"> src=</span><span class="st">&quot;https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js&quot;</span><span class="kw">&gt;&lt;/script&gt;</span>
  92 <span class="kw">&lt;script</span><span class="ot"> type=</span><span class="st">&quot;text/javascript&quot;</span><span class="ot"> src=</span><span class="st">&quot;../SVGAnimation.js&quot;</span><span class="kw">&gt;&lt;/script&gt;</span>
  93 <span class="kw">&lt;script</span><span class="ot"> type=</span><span class="st">&quot;text/javascript&quot;</span><span class="kw">&gt;</span>
  94 <span class="at">$</span>(window).<span class="at">load</span>(<span class="kw">function</span>() <span class="op">{</span>
  95     <span class="kw">var</span> anim <span class="op">=</span> <span class="kw">new</span> <span class="at">Animation</span>(<span class="st">&#39;XXXX&#39;</span><span class="op">,</span><span class="st">&#39;svg/ellipsographe-&#39;</span><span class="op">,</span><span class="dv">1</span><span class="op">,</span><span class="dv">91</span>)<span class="op">;</span>
  96     <span class="va">anim</span>.<span class="at">loopOnload</span>()<span class="op">;</span>
  97     <span class="kw">var</span> player <span class="op">=</span> <span class="kw">new</span> <span class="at">Controle</span>(anim)<span class="op">;</span>
  98     <span class="va">player</span>.<span class="at">connect</span>()<span class="op">;</span>
  99 <span class="op">}</span>)<span class="op">;</span>
 100 <span class="op">&lt;</span><span class="ss">/script&gt;</span>
 101 <span class="ss">&lt;!--</span><span class="sc">[...]</span><span class="ss">--&gt;</span>
 102 <span class="ss">&lt;div id=&quot;XXXX&quot;&gt;</span>
 103 <span class="ss">  &lt;img src=&quot;svg/ellipsographe</span><span class="fl">-1.</span>svg<span class="st">&quot; alt=&quot;</span>animation1<span class="st">&quot;/&gt;</span>
 104   <span class="op">&lt;</span>div <span class="kw">class</span><span class="op">=</span><span class="st">&quot;message&quot;</span> id<span class="op">=</span><span class="st">&quot;XXXX_message&quot;</span><span class="op">&gt;</span><span class="va">Chargement</span>...<span class="op">&lt;</span><span class="ss">/div&gt;</span>
 105 <span class="ss">  &lt;div id=&quot;XXXX_boutons&quot;&gt;&lt;/div</span><span class="op">&gt;</span>
 106 <span class="op">&lt;</span><span class="ss">/div&gt;</span></code></pre></div>
 107 <p>dont l'affichage est :</p>
 108 <div id="XXXX">
 109 <img src="../ellipsographe/svg/ellipsographe-1.svg" alt="animation1"/>
 110 <div id="XXXX_message" class="message">
 111 Chargement...
 112 </div>
 113 <div id="XXXX_boutons">
 114
 115 </div>
 116 </div>
 117 <h4 id="chargement-différé">Chargement différé</h4>
 118 <p>On peut laisser le chargement d'une animation à la demande en créant une fonction Javascript.</p>
 119 <div class="sourceCode"><pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">function</span> <span class="at">charge_anim2</span>() <span class="op">{</span>
 120   <span class="kw">var</span> a <span class="op">=</span> <span class="kw">new</span> <span class="at">Animation</span>(<span class="st">&#39;anim2&#39;</span><span class="op">,</span><span class="st">&#39;svg/ellipsographe-&#39;</span><span class="op">,</span><span class="dv">1</span><span class="op">,</span><span class="dv">91</span>)<span class="op">;</span>
 121   <span class="va">a</span>.<span class="at">loopOnload</span>()<span class="op">;</span>
 122   <span class="kw">var</span> b <span class="op">=</span> <span class="kw">new</span> <span class="at">Controle</span>(a)<span class="op">;</span>
 123   <span class="va">b</span>.<span class="at">connect</span>()<span class="op">;</span>
 124 <span class="op">}</span></code></pre></div>
 125 <p>Fonction qui sera liée à l'<em>événement</em> <code>onclick</code> d'un bouton proposant justement le chargement de l'animation...</p>
 126 <div class="sourceCode"><pre class="sourceCode html"><code class="sourceCode html"><span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;anim2&quot;</span>
 127 <span class="ot">  style=</span><span class="st">&quot;margin:10px auto;padding:10px;width:354px;border:2px solid #AAA;border-radius:4px&quot;</span><span class="kw">&gt;</span>
 128  <span class="kw">&lt;img</span><span class="ot"> src=</span><span class="st">&quot;../ellipsographe/svg/ellipsographe-1.svg&quot;</span><span class="ot"> alt=</span><span class="st">&quot;animation1&quot;</span><span class="ot"> style=</span><span class="st">&quot;width:330px;height:240px&quot;</span><span class="kw">/&gt;</span>
 129  <span class="kw">&lt;div</span><span class="ot"> class=</span><span class="st">&quot;message&quot;</span><span class="ot"> id=</span><span class="st">&quot;anim2_message&quot;</span><span class="kw">&gt;</span>Ellipsographe<span class="kw">&lt;/div&gt;</span>
 130  <span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;anim2_boutons&quot;</span><span class="kw">&gt;&lt;button</span><span class="ot"> onclick=</span><span class="st">&quot;charge_anim2();&quot;</span><span class="kw">&gt;</span>Charger l&#39;animation<span class="kw">&lt;/button&gt;&lt;/div&gt;</span>
 131 <span class="kw">&lt;/div&gt;</span></code></pre></div>
 132 <p>Dans le même temps, le <em>style</em> des éléments englobants a été adapté.</p>
 133 <div id="anim2" style="margin:10px auto;padding:10px;width:354px;border:2px solid #AAA;border-radius:4px">
 134 <img src="../ellipsographe/svg/ellipsographe-1.svg" alt="animation1" style="width:330px;height:240px"/>
 135 <div id="anim2_message" class="message">
 136 Ellipsographe
 137 </div>
 138 <div id="anim2_boutons">
 139 <button onclick="charge_anim2()">
 140 Charger l'animation
 141 </button>
 142 </div>
 143 </div>
 144 <h3 id="les-paramètres">Les paramètres</h3>
 145 <p>L'objet <code>Animation</code> ne possède que deux propriétés configurables, autres que celles (4) qui lui sont passées en argument.</p>
 146 <p>• <strong>delai</strong> <em>(valeur par défaut : 50)</em> — C'est la durée, en millisecondes, entre deux images.</p>
 147 <div class="sourceCode"><pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> a <span class="op">=</span> <span class="kw">new</span> <span class="at">Animation</span>(<span class="st">&#39;anim&#39;</span><span class="op">,</span><span class="st">&#39;svg/pre&#39;</span><span class="op">,</span><span class="dv">1</span><span class="op">,</span><span class="dv">100</span>)<span class="op">;</span>
 148 <span class="va">a</span>.<span class="at">delai</span> <span class="op">=</span> <span class="dv">200</span><span class="op">;</span>
 149 <span class="va">a</span>.<span class="at">loopOnload</span>()<span class="op">;</span></code></pre></div>
 150 <p>Ceci fixera le défilement à 5 images/s. Un <em>player</em> comme ceux que nous vous proposons ci-dessous peut modifier cette valeur.</p>
 151 <p>• <strong>pad</strong> <em>(valeur par défaut : 0)</em> — 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.</p>
 152 <div class="sourceCode"><pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">var</span> a <span class="op">=</span> <span class="kw">new</span> <span class="at">Animation</span>(<span class="st">&#39;anim&#39;</span><span class="op">,</span><span class="st">&#39;svg/pre&#39;</span><span class="op">,</span><span class="dv">1</span><span class="op">,</span><span class="dv">100</span>)<span class="op">;</span>
 153 <span class="va">a</span>.<span class="at">pad</span> <span class="op">=</span> <span class="dv">3</span><span class="op">;</span>
 154 <span class="va">a</span>.<span class="at">loopOnload</span>()<span class="op">;</span></code></pre></div>
 155 <p>Les images chargées seront, successivement, <code>svg/pre001.svg</code>, <code>svg/pre002.svg</code>, ..., <code>svg/pre100.svg</code>.</p>
 156 <h2 id="les-players">Les <em>players</em></h2>
 157 <p>Le fichier <code>SVGAnimation.js</code> contient le constructeur <code>Controle</code> qui est la base des <em>players</em>. S'il est invoqué directement, il fournit un contrôle <em>simpliste</em> de l'animation, comme cela a été vu <a href="#côté-javascript">ci-dessus</a>.</p>
 158 <h3 id="svgplayerone.js"><code>SVGPlayerOne.js</code></h3>
 159 <h3 id="svgplayerbuttons.js"><code>SVGPlayerButtons.js</code></h3>
 160 <h2 id="exemples-dutilisation">Exemples d'utilisation</h2>
 161 </div>
 162 <div id="TDM" class="tdm">
 163 <div style="text-align:center">
 164   <a href="javascript:tdmgauche();">&larr;</a>&nbsp;<b>Sections</b>&nbsp;<a href="javascript:tdmdroite();">&rarr;</a>
 165 </div>
 166  <ul>
 167  <li><a href="#installation">Installation</a></li>
 168  <li><a href="#principe">Principe</a><ul>
 169  <li><a href="#la-famille-dimages">La famille d'images</a></li>
 170  </ul></li>
 171  <li><a href="#lutilisation">L'utilisation</a><ul>
 172  <li><a href="#côté-html">Côté HTML</a></li>
 173  <li><a href="#côté-javascript">Côté JavaScript</a></li>
 174  <li><a href="#les-paramètres">Les paramètres</a></li>
 175  </ul></li>
 176  <li><a href="#les-players">Les <em>players</em></a><ul>
 177  <li><a href="#svgplayerone.js"><code>SVGPlayerOne.js</code></a></li>
 178  <li><a href="#svgplayerbuttons.js"><code>SVGPlayerButtons.js</code></a></li>
 179  </ul></li>
 180  <li><a href="#exemples-dutilisation">Exemples d'utilisation</a></li>
 181  </ul>
 182 </div>
 183 <div style="clear:both"></div>