Documentation de l'animation path.

2 files changed, 96 insertions, 1 deletions

diff --git a/doc/exemple_path.pl b/doc/exemple_path.pl
new file mode 100755
index 0000000..a014865
--- /dev/null
+++ b/doc/exemple_path.pl
@@ -0,0 +1,41 @@
+#!/usr/bin/perl
+#	This program is free software; you can redistribute it and/or
+#	modify it under the terms of the GNU GPL General Public License
+#	as published by the Free Software Foundation; either version 2
+#	of the License, or (at your option) any later version.
+#
+#	This program is distributed in the hope that it will be useful,
+#	but WITHOUT ANY WARRANTY; without even the implied warranty of
+#	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#	GNU General Public License for more details.
+#	
+#	You should have received a copy of the GNU General Public License
+#	along with this program; if not, write to the Free Software
+#	Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA,
+#	or refer to http://www.gnu.org/copyleft/gpl.html
+#
+
+BEGIN {
+	unshift @INC, ".", "../src"; 
+}
+
+use MTools;
+use MTools::GUI::MRect;
+use MTools::Anim::MPath;
+
+new MTools (800, 600, "Exemple de animation path");
+
+my $rect = new MTools::GUI::MRect (1, 300, 100, 300, 50, -filled => 1);
+
+my $anim = new MTools::Anim::MPath(targets => $rect,
+				   loop => 1,
+				   duration => 5);
+$anim->mconfigure(path => [[0, 0], # point de référence
+			   [100, 300],
+			   [-300, 400],
+			   [0, 0]]); # on retourne au point de départ
+
+$anim->start();
+
+mrun;
+
diff --git a/doc/manuel_utilisateur.txt b/doc/manuel_utilisateur.txt
index 9ce625c..255b705 100644
--- a/doc/manuel_utilisateur.txt
+++ b/doc/manuel_utilisateur.txt
@@ -454,7 +454,7 @@ Les valeurs modifiables par mconfigure sont :
 	- -visible : permet d'activer ou stopper l'animation
 	- from_opacity : valeur initiale de l'opacité au départ de l'animation
 	- to_opacity : valeur de l'opacité à la fin de l'animation
- 	- duration : durée de l'animation (défaut: 1s)
+ 	- duration : durée de l'animation (défaut : 1s)
 	- loop : indique le caractère répétitif de l'animation (défaut : faux)
 	- targets : objet ou tableau d'objets cible de cette animation. Ces
 	objets doivent disposer d'une propriété "-alpha" (c'est le cas des
@@ -495,6 +495,60 @@ $anim->start();
 mrun;
 ________
 MPath.pm :
+MPath permet de réaliser une animation de déplacement suivant un chemin. Le
+chemin est une suite de segments.
+
+La description du chemin est une liste de points (x, y). L'objet se déplace en
+ligne droite d'un point à l'autre. La vitesse de déplacement est régulière tout
+au long du trajet. Elle est déterminée par la durée de l'animation. Le premier
+point du trajet correspond à l'endroit où se trouve l'objet au départ de
+l'animation, il sert donc de point de référence.
+
+La fonction de création ne nécessite aucun argument. Elle permet de configurer
+toutes les propriétés comme mconfigure.
+
+Les valeurs modifiables par mconfigure sont :
+	- -visible : permet d'activer ou stopper l'animation
+	- path : liste des points (x, y) par lesquels il faut passer
+ 	- duration : durée de l'animation (défaut : 1s)
+	- loop : indique le caractère répétitif de l'animation (défaut : faux)
+	- targets : objet ou tableau d'objets cible de cette animation. Ces
+	objets doivent disposer d'une fonction "translate".
+
+Les évènements émis sont :
+	- ANIMATION_END : Notifie la fin de l'annimation
+	- VALUE_CHANGED : Notifie un changement de position au cours de
+	l'animation
+	- ANIMATION_ABORD : Notifie un arrêt prématuré de l'animation
+
+Les évènements VALUE_CHANGED et ANIMATION_ABORD fournissent la valeur courante
+de la position (x, y) et un vecteur qui donne la direction de déplacement de
+l'objet (ce vecteur n'est pas proportionnel à la vitesse). La position est dans
+le système de coordonnées définit par le path.
+
+Les fonctions applicables à un objet MPath sont :
+	- start : démarre l'animation
+	- stop: arrête l'animation
+	- isRunning : détermine si l'animation est en cours
+
+*** Au moment du "rebouclage" de l'animation, il y a parfois un
+clignottement. Voir comment on peut régler ce problème
+
+Exemple d'utilisation :
+use MTools;
+use MTools::GUI::MRect;
+use MTools::Anim::MPath;
+new MTools (800, 600, "Exemple de animation path");
+my $rect = new MTools::GUI::MRect (1, 300, 100, 300, 50, -filled => 1);
+my $anim = new MTools::Anim::MPath(targets => $rect,
+				   loop => 1,
+				   duration => 5);
+$anim->mconfigure(path => [[0, 0], # point de référence
+			   [100, 300],
+			   [-300, 400],
+			   [0, 0]]); # on retourne au point de départ
+$anim->start();
+mrun;
 __________
 MScalor.pm :
 ______________