--- a/front_idill/doc/Documentation - Front IDILL.html Mon Jul 23 16:59:35 2012 +0200
+++ b/front_idill/doc/Documentation - Front IDILL.html Tue Jul 24 11:14:52 2012 +0200
@@ -133,7 +133,7 @@
<p>A l'inverse, une recherche dans une vidéo n'affecte pas la mosaïque.</p>
</ol>
- <ol type="A" start="2">
+ <ol type="A" start="3">
<h4><li>Quitter la recherche.</li></h4>
<p>Pour quitter une recherche en cours, il suffit de placer le curseur sur le macaron de recherche, qui apparaîtra alors barré. Ensuite, un clic le fait disparaître et quitte la recherche.</p>
@@ -196,7 +196,19 @@
<p>A l'inverse, une recherche dans une vidéo n'affecte pas la mosaïque.</p>
</ol>
- <ol type="A" start="2">
+ <ol type="A" start="3">
+ <h4><li>Reconnaissance de gestures.</li></h4>
+
+ <p>Une fois une demande de recherche effectuée, vous pouvez lancer une recherche en effectuant 4 gestures (correspondantes aux 4 marqueurs représentés par ces gestures) :</p>
+ <ul>
+ <li>FALL (chute) : S'accroupir les genoux en avant.</li>
+ <li>JUMP (saut) : Sauter verticalement sans élan.</li>
+ <li>KNEE-UP (levé de genou) : Lever l'un des genoux en l'avancant par rapport au reste du corps.</li>
+ <li>BEND (penché) : Se pencher vers l'avant sans plier les jambes.</li>
+ </ul>
+ </ol>
+
+ <ol type="A" start="4">
<h4><li>Quitter la recherche.</li></h4>
<p>Pour quitter une recherche en cours, il suffit de placer un pointeur sur le macaron de recherche, qui apparaîtra alors barré. Ensuite, une mire se remplit au fur et à mesure. Lorsque la mire est pleine, la notification et la recherche sont enlevées.</p>
@@ -207,12 +219,66 @@
<ol type="I" start="4">
<h3><a name="#IV"><li>Configuration</li></a></h3>
+
+ <p>Le Front IDILL possède deux configurations :</p>
+ <ul>
+ <li>Une configuration par défaut.<br />Elle est placée dans un fichier javascript et qu'il ne vaut mieux pas modifier sous peine d'engendrer des erreurs s'il y a une erreur de saisie.</li>
+ <li>Une configuration personnalisable.<br />Elle se situe dans le fichier config.json et est dans le dossier principal du Front IDILL. Il s'agit des paramètres étant chargés au démarrage du Front (ou au redémarrage s'il y a un raffraîchissement de la fenêtre du navigateur). Si un paramètre a une valeur incorrecte, celui-ci prend sa valeur par défaut.</li>
+ <p>Voici la liste des différents paramètres du Front IDILL :</p>
+ <table border="1">
+ <tr><th>Nom du paramètre</th><th>Type</th><th>Valeur par défaut</th><th>Description</th></tr>
+ <tr><td>local</td><td>booléen</td><td>true</td><td>Indique si le chargement des métadonnées se fait localement ou en ligne.</td></tr>
+ <tr><td>videoConfigFileLocal</td><td>string (path)</td><td>"./player/json/local_videos.json"</td><td>Chemin vers le fichier de chargement des images, vidéos et métadonnées pour un chargement local.</td></tr>
+ <tr><td>videoConfigFileOnline</td><td>string (path)</td><td>"./player/json/online_videos.json"</td><td>Chemin vers le fichier de chargement des images, vidéos et métadonnées pour un chargement en ligne.</td></tr>
+ <tr><td>mouseInteractions</td><td>booléen</td><td>true</td><td>Spécifie le mode d'interaction (souris/Kinect).</td></tr>
+ <tr><td>noUserModeEnabled</td><td>booléen</td><td>true</td><td>Spécifie si on active la phase d'approche de l'utilisateur (de remplissage de la mosaïque en mode d'interaction Kinect).</td></tr>
+ <tr><td>imagesByLine</td><td>int</td><td>5</td><td>Longueur de la mosaïque en images.</td></tr>
+ <tr><td>imagesToShow</td><td>int</td><td>20</td><td>Nombre d'images affichées dans la mosaïque.</td></tr>
+ <tr><td>totalImages</td><td>int</td><td>22</td><td>Nombre d'images disponibles au total.</td></tr>
+ <tr><td>timeReloadAfterResize</td><td>int (msec)</td><td>1000</td><td>Temps d'attente avant de recharger la page lorsqu'elle est redimensionnée.</td></tr>
+ <tr><td>timePrezoom</td><td>int (msec)</td><td>500</td><td>Temps qu'il faut à une image pour entrer en phase de prézoom (présélection pour le zoom).</td></tr>
+ <tr><td>timePreUnzoom</td><td>int (msec)</td><td>200</td><td>Temps qu'il faut à une image pour quitter une phase de prézoom.</td></tr>
+ <tr><td>zoomTime</td><td>int (msec)</td><td>500</td><td>Temps qu'il faut pour zoomer sur une image et passer en mode vidéo.</td></tr>
+ <tr><td>timeUnzoom</td><td>int (msec)</td><td>400</td><td>Temps qu'il faut pour dézoomer et revenir à la mosaïque.</td></tr>
+ <tr><td>timeNeighbourGlowing</td><td>int (msec)</td><td>1000</td><td>Temps qu'il faut à une vidéo voisine en mode vidéo pour être sélectionnée.</td></tr>
+ <tr><td>timeNeighbourUnglowing</td><td>int (msec)</td><td>1000</td><td>Temps qu'il faut à une vidéo voisine en mode vidéo pour être désélectionnée.</td></tr>
+ <tr><td>timeMovingToNeighbour</td><td>int (msec)</td><td>1000</td><td>Temps qu'il faut pour bouger vers une vidéo voisine.</td></tr>
+ <tr><td>timeSearchFade</td><td>int (msec)</td><td>2000</td><td>Temps qu'il faut pour que le canvas de recherche par courbes disparaisse.</td></tr>
+ <tr><td>timeNotifyFade</td><td>int (msec)</td><td>2000</td><td>Temps qu'il faut pour que le panneau d'aide disparaisse.</td></tr>
+ <tr><td>timeFilterFade</td><td>int (msec)</td><td>2000</td><td>Temps que le filtrage de la mosaïque s'enlève.</td></tr>
+ <tr><td>timeANFade</td><td>int (msec)</td><td>500</td><td>Temps qu'il faut pour qu'un voisin additionnel disparaisse (voisin de bord de mosaïque).</td></tr>
+ <tr><td>timeoutZoom</td><td>int (msec)</td><td>2000</td><td>Temps qu'il faut pour valider la sélection d'une image pour zoomer (Kinect).</td></tr>
+ <tr><td>timeoutUnzoom</td><td>int (msec)</td><td>1000</td><td>Temps qu'il faut avant de bloquer le dézoom quand les pointeurs quittent les voisins opposés (Kinect).</td></tr>
+ <tr><td>timeoutMoveToNeighbour</td><td>int (msec)</td><td>250</td><td>Temps qu'il faut avant de bloquer le passage vers un voisin lorsque le pointeur quitte un voisin (Kinect).</td></tr>
+ <tr><td>timeoutPointersIdle</td><td>int (msec)</td><td>2000</td><td>Temps qu'il faut pour valider l'immobilité des deux pointeurs pour faire une demande de recherche (Kinect).</td></tr>
+ <tr><td>timeoutAreBothPointersHere</td><td>int (msec)</td><td>500</td><td>Temps qu'il faut pour détecter que les deux pointeurs sont là ou non (Kinect).</td></tr>
+ <tr><td>timeoutRemoveNotificationByGesture</td><td>int (msec)</td><td>1500</td><td>Temps qu'il faut pour valider la suppression de recherche quand on est sur le macaron de la recherche (Kinect).</td></tr>
+ <tr><td>timeoutNotifySwipe</td><td>int (msec)</td><td>1000</td><td>Temps qu'il faut pour être de nouveau capable de faire un swipe après en avoir fait un (Kinect).</td></tr>
+ <tr><td>timeoutSelectTL</td><td>int (msec)</td><td>100</td><td>Temps qu'il faut pour sélectionner la timeline quand on a un pointeur ou la souris dessus.</td></tr>
+ <tr><td>timeoutSlideTL</td><td>int (msec)</td><td>1000</td><td>Temps qu'il faut avant de pouvoir déplacer le curseur de lecture quand on vient d'entrer dans la timeline.</td></tr>
+ <tr><td>timeoutCanNotifyHelp</td><td>int (msec)</td><td>1000</td><td>Temps qu'il faut avant de pouvoir afficher le panneau d'aide lorsqu'il a déjà été affiché ou après une demande de recherche (Kinect).</td></tr>
+ <tr><td>timeoutRemoveSpinner</td><td>int (msec)</td><td>1000</td><td>Temps qu'il faut pour faire disparaître la mire d'un pointeur (généralement en même temps que lui) (Kinect).</td></tr>
+ <tr><td>timeoutCanNotifyHelp</td><td>int (msec)</td><td>1000</td><td>Temps qu'il faut avant de pouvoir afficher le panneau d'aide lorsqu'il a déjà été affiché ou après une demande de recherche (Kinect).</td></tr>
+ <tr><td>timeoutNouser</td><td>int (msec)</td><td>3000</td><td>Temps de latence séparant la sortie de l'utilisateur du champ de détection de Kinect de la réinitialisation de l'interface (Kinect).</td></tr>
+ <tr><td>timeoutNextDrawCurve</td><td>int (msec)</td><td>500</td><td>Temps qu'il faut avant de pouvoir dessiner une courbe de recherche quand on vient d'entrer en mode de recherche par courbes ou bien après en avoir tracé une (Kinect).</td></tr>
+ <tr><td>zoomPercentage</td><td>float (entre 0 et 1)</td><td>0.80</td><td>Pourcentage d'agrandissement de l'image initiale pour un zoom.</td></tr>
+ <tr><td>prezoomPercentage</td><td>float (entre 0 et 1)</td><td>0.25</td><td>Pourcentage d'agrandissement de l'image initiale pour un prézoom (une sélection qui précède un zoom).</td></tr>
+ <tr><td>zoomedMargin</td><td>int (px)</td><td>42</td><td>Epaisseur de la marge qui sépare les images de la mosaïque lorsqu'elle est zoomée.</td></tr>
+ <tr><td>host</td><td>string (adresse ip)</td><td>"127.0.0.1"</td><td>Adresse ip sur lequel le serveur du Middleware est hébergé (Kinect).</td></tr>
+ <tr><td>port</td><td>int</td><td>8090</td><td>Port sur lequel on peut se connecter au serveur du Middleware (Kinect).</td></tr>
+ <tr><td>mouseUpDownDeltaTreshold</td><td>int (px)</td><td>15</td><td>Distance à partir de laquelle le déplacement du pointeur de la souris lorsqu'on a appuyé sur le bouton gauche est considéré non plus comme le début d'un click mais le début d'un tracé de courbe de recherche.</td></tr>
+ <tr><td>curveDictionary</td><td>string (path)</td><td>"./dico.json"</td><td>Chemin du dictionnaire de courbes de recherche.</td></tr>
+ <tr><td>lang</td><td>string (abréviation)</td><td>""</td><td>Langue utilisée dans le Front (en, fr...). Si elle est vide alors la langue du navigateur est prise.</td></tr>
+ </table>
+ </ul>
</ol>
<hr />
<ol type="I" start="5">
<h3><a name="#V"><li>Notices à prendre en compte</li></a></h3>
+
+ <p>Ce projet étant un prototype, il est possible que certains bugs surviennent. Si vous expérimentez ce genre de désagrément, vous pouvez nous en faire part (actions menant au problème + description du problème + capture d'écran).</p>
</ol>
<p>Si vous expérimentez des difficultés ou souhaitez nous soumettre une requête, veuillez consulter le fichier contact.txt à la racine du projet.</p>