doc: ce n'est pas convaincant!

[svganimation.git] / doc / page.html

diff --git a/doc/page.html b/doc/page.html
index d6a3f37..983be8e 100644 (file)
--- a/doc/page.html
+++ b/doc/page.html
@@ -27,7 +27,7 @@
 <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>
 <div class="alert alert-warning">
 <p>
-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.
+Les différents exemples se chargent 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.
 </p>
 <p>
 Nous présentons, dans la section <a
@@ -123,11 +123,12 @@ Chargement...
   <span class="va">b</span>.<span class="at">connect</span>()<span class="op">;</span>
 <span class="op">}</span></code></pre></div>
 <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>
-<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>
-<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>
- <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>
+<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><span class="ot"> style=</span><span class="st">&quot;...&quot;</span><span class="kw">&gt;</span>
+ <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;...&quot;</span><span class="kw">/&gt;</span>
  <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>
- <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>
+ <span class="kw">&lt;div</span><span class="ot"> id=</span><span class="st">&quot;anim2_boutons&quot;</span><span class="kw">&gt;</span>
+   <span class="kw">&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;</span>
+ <span class="kw">&lt;/div&gt;</span>
 <span class="kw">&lt;/div&gt;</span></code></pre></div>
 <p>Dans le même temps, le <em>style</em> des éléments englobants a été adapté.</p>
 <div id="anim2" style="margin:10px auto;padding:10px;width:354px;border:2px solid #AAA;border-radius:4px">
@@ -147,36 +148,132 @@ Charger l'animation
 <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>
 <span class="va">a</span>.<span class="at">delai</span> <span class="op">=</span> <span class="dv">200</span><span class="op">;</span>
 <span class="va">a</span>.<span class="at">loopOnload</span>()<span class="op">;</span></code></pre></div>
-<p>Ceci fixera le défilement à 5 images/s. Un <em>player</em> comme ceux que nous vous proposons ci-dessus peut modifier cette valeur.</p>
+<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>
 <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>
 <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>
 <span class="va">a</span>.<span class="at">pad</span> <span class="op">=</span> <span class="dv">3</span><span class="op">;</span>
 <span class="va">a</span>.<span class="at">loopOnload</span>()<span class="op">;</span></code></pre></div>
 <p>Les images chargées seront, successivement, <code>svg/pre001.svg</code>, <code>svg/pre002.svg</code>, ..., <code>svg/pre100.svg</code>.</p>
 <h2 id="les-players">Les <em>players</em></h2>
+<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>
 <h3 id="svgplayerone.js"><code>SVGPlayerOne.js</code></h3>
-<h3 id="svgplayerbuttons.js"><code>SVGPlayerButtons.js</code></h3>
+<p>Pour utiliser un <em>player</em> plus <em>sophistiqué</em>, il faut surcharger la méthode <code>Initialisation</code> de l'objet <code>Controle</code>. Pour plus de détails sur les <em>players</em>, nous vous invitons à consulter la page dédiée.</p>
+<p>L'idée que nous présentons ici est de construire un objet JavaScript qui mettra des boutons de contrôle (lecture, stop, etc.).</p>
+<p>Ceci peut se faire de la façon suivante :</p>
+<div class="sourceCode"><pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="kw">function</span> <span class="at">SVGPlayerOne</span>(a) <span class="op">{</span> <span class="co">// déclaration de l&#39;objet</span>
+  <span class="va">Controle</span>.<span class="at">call</span>(<span class="kw">this</span><span class="op">,</span>a)<span class="op">;</span> <span class="co">// construit à partir de l&#39;objet Controle</span>
+  <span class="va">SVGPlayerOne</span>.<span class="va">prototype</span>.<span class="at">connect</span> <span class="op">=</span> <span class="va">Controle</span>.<span class="va">prototype</span>.<span class="at">connect</span> <span class="co">// et de</span>
+  <span class="co">// la méthode connect du Controle</span>
+<span class="op">}</span></code></pre></div>
+<p>Une fois déclaré un tel objet, il suffit de surcharger la méthode <code>Initialisation</code> de l'objet <code>Controle</code> fourni dans <code>SVGAnimation.js</code>. Dans l'exemple ci-dessous, on « vide » la <code>div</code> <code>XXXX_message</code>, et on ajoute des boutons à la <code>div</code> <code>XXXX_boutons</code> qui réagissent aux <code>onclick</code> pour lancer les fonctions JavaScript adéquates définies dans le fichier <code>SVGAnimation.js</code>.</p>
+<div class="sourceCode"><pre class="sourceCode javascript"><code class="sourceCode javascript"><span class="co">// Surcharge de la méthode [Initialisation]</span>
+<span class="va">SVGPlayerOne</span>.<span class="va">prototype</span>.<span class="at">Initialisation</span> <span class="op">=</span> <span class="kw">function</span>() <span class="op">{</span>
+  <span class="kw">var</span> a <span class="op">=</span> <span class="kw">this</span>.<span class="at">a</span><span class="op">;</span> <span class="co">// l&#39;animation courante</span>
+  <span class="kw">var</span> self <span class="op">=</span> <span class="kw">this</span>.<span class="at">me</span><span class="op">;</span> <span class="co">// le player</span>
+  <span class="va">a</span>.<span class="va">image</span>.<span class="va">style</span>.<span class="at">display</span> <span class="op">=</span> <span class="st">&#39;inline&#39;</span><span class="op">;</span>
+  <span class="va">a</span>.<span class="va">message</span>.<span class="va">parentNode</span>.<span class="at">removeChild</span>(<span class="va">a</span>.<span class="at">message</span>)<span class="op">;</span> <span class="co">// on supprime la</span>
+      <span class="co">//balise d&#39;id=XXXX_message</span>
+  <span class="kw">var</span> play <span class="op">=</span> <span class="va">document</span>.<span class="at">createElement</span>(<span class="st">&#39;button&#39;</span>)<span class="op">;</span> <span class="co">// on crée un bouton</span>
+  <span class="va">play</span>.<span class="at">className</span> <span class="op">=</span> <span class="st">&quot;SVGplay playBtn&quot;</span><span class="op">;</span> <span class="co">// ajout de classe pour le style</span>
+  <span class="va">play</span>.<span class="at">innerHTML</span> <span class="op">=</span> <span class="st">&quot;Play&quot;</span><span class="op">;</span> <span class="co">// on y met du texte</span>
+  <span class="va">play</span>.<span class="at">onclick</span> <span class="op">=</span> <span class="kw">function</span>()<span class="op">{</span><span class="va">a</span>.<span class="at">action</span> <span class="op">=</span> <span class="kw">true</span><span class="op">;</span> <span class="va">a</span>.<span class="at">rotate</span>(<span class="va">self</span>.<span class="at">a</span>)<span class="op">};</span> <span class="co">// on</span>
+      <span class="co">// associe une fonction JS</span>
+  <span class="co">// on recommence</span>
+  <span class="kw">var</span> stop <span class="op">=</span> <span class="va">document</span>.<span class="at">createElement</span>(<span class="st">&#39;button&#39;</span>)<span class="op">;</span>
+  <span class="va">stop</span>.<span class="at">className</span> <span class="op">=</span> <span class="st">&quot;SVGplay stopBtn&quot;</span><span class="op">;</span>
+  <span class="va">stop</span>.<span class="at">innerHTML</span> <span class="op">=</span> <span class="st">&quot;Stop&quot;</span><span class="op">;</span>
+  <span class="va">stop</span>.<span class="at">onclick</span> <span class="op">=</span> <span class="kw">function</span>()<span class="op">{</span><span class="va">a</span>.<span class="at">action</span> <span class="op">=</span> <span class="kw">false</span><span class="op">;};</span>
+  <span class="kw">var</span> debut <span class="op">=</span> <span class="va">document</span>.<span class="at">createElement</span>(<span class="st">&#39;button&#39;</span>)<span class="op">;</span>
+  <span class="va">debut</span>.<span class="at">className</span> <span class="op">=</span> <span class="st">&quot;SVGplay debutBtn&quot;</span><span class="op">;</span>
+  <span class="va">debut</span>.<span class="at">innerHTML</span> <span class="op">=</span> <span class="st">&quot;Début&quot;</span><span class="op">;</span>
+  <span class="va">debut</span>.<span class="at">onclick</span> <span class="op">=</span> <span class="kw">function</span>()<span class="op">{</span><span class="va">a</span>.<span class="at">action</span> <span class="op">=</span> <span class="kw">false</span><span class="op">;</span> <span class="va">a</span>.<span class="at">first</span>(<span class="va">self</span>.<span class="at">a</span>)<span class="op">};</span>
+  <span class="kw">var</span> fin <span class="op">=</span> <span class="va">document</span>.<span class="at">createElement</span>(<span class="st">&#39;button&#39;</span>)<span class="op">;</span>
+  <span class="va">fin</span>.<span class="at">className</span> <span class="op">=</span> <span class="st">&quot;SVGplay finBtn&quot;</span><span class="op">;</span>
+  <span class="va">fin</span>.<span class="at">innerHTML</span> <span class="op">=</span> <span class="st">&quot;Fin&quot;</span><span class="op">;</span>
+  <span class="va">fin</span>.<span class="at">onclick</span> <span class="op">=</span> <span class="kw">function</span>()<span class="op">{</span><span class="va">a</span>.<span class="at">action</span> <span class="op">=</span> <span class="kw">false</span><span class="op">;</span> <span class="va">a</span>.<span class="at">last</span>(<span class="va">self</span>.<span class="at">a</span>)<span class="op">};</span>
+  <span class="kw">var</span> moins <span class="op">=</span> <span class="va">document</span>.<span class="at">createElement</span>(<span class="st">&#39;button&#39;</span>)<span class="op">;</span>
+  <span class="va">moins</span>.<span class="at">className</span> <span class="op">=</span> <span class="st">&quot;SVGplay moinsBtn&quot;</span><span class="op">;</span>
+  <span class="va">moins</span>.<span class="at">innerHTML</span> <span class="op">=</span> <span class="st">&quot;-&quot;</span><span class="op">;</span>
+  <span class="va">moins</span>.<span class="at">onclick</span> <span class="op">=</span> <span class="kw">function</span>()<span class="op">{</span><span class="va">a</span>.<span class="at">delai</span> <span class="op">=</span> <span class="va">a</span>.<span class="at">delai</span> <span class="op">&gt;</span> <span class="dv">2000</span> <span class="op">?</span> <span class="dv">2000</span> : <span class="va">a</span>.<span class="at">delai</span> <span class="op">*</span> <span class="fl">1.414</span><span class="op">};</span>
+  <span class="kw">var</span> plus <span class="op">=</span> <span class="va">document</span>.<span class="at">createElement</span>(<span class="st">&#39;button&#39;</span>)<span class="op">;</span>
+  <span class="va">plus</span>.<span class="at">className</span> <span class="op">=</span> <span class="st">&quot;SVGplay plusBtn&quot;</span><span class="op">;</span>
+  <span class="va">plus</span>.<span class="at">innerHTML</span> <span class="op">=</span> <span class="st">&quot;+&quot;</span><span class="op">;</span>
+  <span class="va">plus</span>.<span class="at">onclick</span> <span class="op">=</span> <span class="kw">function</span>()<span class="op">{</span><span class="va">a</span>.<span class="at">delai</span> <span class="op">=</span> <span class="va">a</span>.<span class="at">delai</span> <span class="op">&lt;</span> <span class="dv">30</span> <span class="op">?</span> <span class="dv">30</span> : <span class="va">a</span>.<span class="at">delai</span> / <span class="fl">1.414</span><span class="op">};</span>
+  <span class="co">// placement des boutons</span>
+  <span class="va">a</span>.<span class="va">boutons</span>.<span class="at">appendChild</span>(play)<span class="op">;</span>
+  <span class="va">a</span>.<span class="va">boutons</span>.<span class="at">appendChild</span>(stop)<span class="op">;</span>
+  <span class="va">a</span>.<span class="va">boutons</span>.<span class="at">appendChild</span>(debut)<span class="op">;</span>
+  <span class="va">a</span>.<span class="va">boutons</span>.<span class="at">appendChild</span>(fin)<span class="op">;</span>
+  <span class="va">a</span>.<span class="va">boutons</span>.<span class="at">appendChild</span>(moins)<span class="op">;</span>
+  <span class="va">a</span>.<span class="va">boutons</span>.<span class="at">appendChild</span>(plus)<span class="op">;</span>
+<span class="op">}</span></code></pre></div>
+<p>Un fois déclaré tout ceci (le mieux étant dans un fichier externe), on associe le <em>player</em> <code>SVGPlayerOne</code> à l'animation de la même façon que le <em>player</em> <code>Controle</code> :</p>
+<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;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>
+<span class="va">anim</span>.<span class="at">loopOnload</span>()<span class="op">;</span>
+<span class="kw">var</span> player <span class="op">=</span> <span class="kw">new</span> <span class="at">SVGPlayerOne</span>(anim)<span class="op">;</span>
+<span class="va">player</span>.<span class="at">connect</span>()<span class="op">;</span></code></pre></div>
+<script type="text/javascript">
+  function charge_anim3() {
+    var anim = new Animation('anim3','../ellipsographe/svg/ellipsographe-',1,91);
+    anim.loopOnload();
+    var player = new SVGPlayerOne(anim);
+    player.connect();
+  }
+</script>
+<div id="anim3" 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 id="anim3_message" class="message">
+Ellipsographe
+</div>
+<div id="anim3_boutons">
+<button onclick="charge_anim3()">
+Charger l'animation
+</button>
+</div>
+</div>
+<p>Le fichier <code>SVGPlayerOne.js</code> est fourni à la racine du projet SVGAnimation.</p>
 <h2 id="exemples-dutilisation">Exemples d'utilisation</h2>
+<div class="row">
+<div class="col-xs-12 col-md-6">
+<p><a href="//melusine.eu.org/syracuse/G/svganimation-exemples/mvtretrograde/"
+alt="lien vers l'exemple"><img class="img-response" src="img/mvtretrograde.png"
+alt="Image de l'exemple" style="width: 100%;"/></a></p>
+</div>
+<div class="col-md-6">
+<p>Animation avec le <em>player</em> <code>SVGPlayerButtons</code> et une factorisation avec MetaPost du matériel qui se répète sur chaque image. Le fond est mis en <em>background</em> de la balise englobante, permettant ainsi d'alléger l'animation.</p>
+</div>
+</div>
+<div class="row">
+<div class="col-xs-12 col-md-6">
+<p><a href="//melusine.eu.org/syracuse/G/svganimation-exemples/delaunay/"
+alt="lien vers l'exemple"><img class="img-responsive" src="img/delaunay.png"
+alt="Image de l'exemple" style="width: 100%;"/></a></p>
+</div>
+<div class="col-md-6">
+<p>Fabrication de l'animation à partir d'un fichier PDF transformé en fichiers SVG grâce au programme <code>pdf2svg</code>.</p>
+<p>Animation avec le <em>player</em> <code>SVGPlayerButtons</code>. L'animation est une animation de construction d'un maillage, le contrôle se fait donc image par image.</p>
+<p>Le player est donc paramétré pour n'afficher que les boutons de <em>début</em> et <em>fin</em> d'animation, ainsi que l'avance et le recule <em>image par image</em>.</p>
+<p>L'affichage des boutons est personnalisé grâce à du code CSS.</p>
+</div>
+</div>
+</div>
+<div id="tdm-doc" class="tdm-loc">
+  <div id="tdm-titre">SVGAnimation (documentation)</div>
+  <ul>
+  <li><a href="#installation">Installation</a></li>
+  <li><a href="#principe">Principe</a><ul>
+  <li><a href="#la-famille-dimages">La famille d'images</a></li>
+  </ul></li>
+  <li><a href="#lutilisation">L'utilisation</a><ul>
+  <li><a href="#côté-html">Côté HTML</a></li>
+  <li><a href="#côté-javascript">Côté JavaScript</a></li>
+  <li><a href="#les-paramètres">Les paramètres</a></li>
+  </ul></li>
+  <li><a href="#les-players">Les <em>players</em></a><ul>
+  <li><a href="#svgplayerone.js"><code>SVGPlayerOne.js</code></a></li>
+  </ul></li>
+  <li><a href="#exemples-dutilisation">Exemples d'utilisation</a></li>
+  </ul>
+  <div id="tdm-nav"></div>
 </div>
-<div id="TDM" class="tdm">
-<div style="text-align:center">
-  <a href="javascript:tdmgauche();">&larr;</a>&nbsp;<b>Sections</b>&nbsp;<a href="javascript:tdmdroite();">&rarr;</a>
-</div>
- <ul>
- <li><a href="#installation">Installation</a></li>
- <li><a href="#principe">Principe</a><ul>
- <li><a href="#la-famille-dimages">La famille d'images</a></li>
- </ul></li>
- <li><a href="#lutilisation">L'utilisation</a><ul>
- <li><a href="#côté-html">Côté HTML</a></li>
- <li><a href="#côté-javascript">Côté JavaScript</a></li>
- <li><a href="#les-paramètres">Les paramètres</a></li>
- </ul></li>
- <li><a href="#les-players">Les <em>players</em></a><ul>
- <li><a href="#svgplayerone.js"><code>SVGPlayerOne.js</code></a></li>
- <li><a href="#svgplayerbuttons.js"><code>SVGPlayerButtons.js</code></a></li>
- </ul></li>
- <li><a href="#exemples-dutilisation">Exemples d'utilisation</a></li>
- </ul>
-</div>
-<div style="clear:both"></div>
\ No newline at end of file
+<div id="tdm-ctl"></div>