From f06a2c91b41e5e54ffbad7dd46bd700207fbdb84 Mon Sep 17 00:00:00 2001
From: ribet
Date: Fri, 1 Jun 2007 11:14:18 +0000
Subject: Documentation de l'animation de translation.

---
 doc/exemple_translator.pl  | 39 ++++++++++++++++++++++++++++
 doc/manuel_utilisateur.txt | 63 ++++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 100 insertions(+), 2 deletions(-)
 create mode 100755 doc/exemple_translator.pl

(limited to 'doc')

diff --git a/doc/exemple_translator.pl b/doc/exemple_translator.pl
new file mode 100755
index 0000000..6e4e9b8
--- /dev/null
+++ b/doc/exemple_translator.pl
@@ -0,0 +1,39 @@
+#!/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::MTranslator;
+
+new MTools (800, 600, "Exemple de animation translator");
+
+my $rect = new MTools::GUI::MRect (1, 300, 100, 300, 50, -filled => 1);
+
+my $anim = new MTools::Anim::MTranslator(targets => $rect,
+					 loop => 1,
+					 duration => 2,
+					 to_x => 100,
+					 to_y => 300);
+
+$anim->start();
+
+mrun;
+
diff --git a/doc/manuel_utilisateur.txt b/doc/manuel_utilisateur.txt
index 57ba3d6..419f4b4 100644
--- a/doc/manuel_utilisateur.txt
+++ b/doc/manuel_utilisateur.txt
@@ -499,6 +499,9 @@ MPath permet de r
 chemin est une suite de segments. L'animation peut porter sur un objet ou un
 tableau d'objets.
 
+Remarque : si le chemin est composé seulement d'un segment, MTranslator.pm
+suffit.
+
 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
@@ -524,8 +527,8 @@ Les 
 
 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.
+l'objet (ce vecteur n'est pas proportionnel à la vitesse). La position est un
+point du chemin.
 
 Les fonctions applicables à un objet MPath sont :
 	- start : démarre l'animation
@@ -617,6 +620,62 @@ $anim->start();
 mrun;
 ______________
 MTranslator.pm :
+MTranslator permet de realiser une animation de translation d'un ou plusieurs
+objets, c'est un déplacement suivant un segment.
+
+Remarque : dans le cas où le déplacement à effectuer ne peut pas être décrit par
+un seul segment, il suffit d'utiliser MPath.pm.
+
+La translation est décrite par un segment. Les coordonnées du segment n'ont
+aucun lien avec les coordonnées de l'objet, c'est-à-dire que l'objet ne va pas
+se déplacer pour aller à l'endroit du segment. Le segment est plutôt à
+considérer comme un vecteur déplacement.
+
+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
+	- from_x, from_y : coordonnées de l'origine du segment (défaut : 0)
+	- to_x, to_y : coordonnées de destination du segment (défaut : 0)
+ 	- 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".
+
+Dans le cas où on souhaite faire un déplacement, de (dx, dy), il suffit de
+positionner ces valeurs dans to_x et to_y puisque les valeurs par défaut de
+from_x et from_y sont 0.
+
+Les évènements émis sont :
+	- ANIMATION_END : Notifie la fin de l'annimation
+	- MOTION : Notifie un changement de position au cours de l'animation
+	- ANIMATION_ABORD : Notifie un arrêt prématuré de l'animation
+
+Les évènements MOTION et ANIMATION_ABORD fournissent la valeur courante de la
+position (x, y). La position est un point du segment.
+
+Les fonctions applicables à un objet MTranslator sont :
+	- start : démarre l'animation
+	- stop: arrête l'animation
+	- isRunning : détermine si l'animation est en cours
+
+*** Attention : dans le cas où une cible est de type MMover, le comportement est
+différent. Voir dans quelle mesure et pourquoi.
+
+Exemple d'utilisation :
+use MTools;
+use MTools::GUI::MRect;
+use MTools::Anim::MTranslator;
+new MTools (800, 600, "Exemple de animation translator");
+my $rect = new MTools::GUI::MRect (1, 300, 100, 300, 50, -filled => 1);
+my $anim = new MTools::Anim::MTranslator(targets => $rect,
+					 loop => 1,
+					 duration => 2,
+					 to_x => 100,
+					 to_y => 300);
+$anim->start();
+mrun;
 
 2.6 Les comportements
 ---------------------
-- 
cgit v1.1