-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocumentation.html
More file actions
738 lines (738 loc) · 71.6 KB
/
documentation.html
File metadata and controls
738 lines (738 loc) · 71.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
<html>
<head>
<title>Photoedit Documentation</title>
</head>
<body>
<h1> Photoedit Documentation </h1>
<h1> Introduction </h1>
<p> Photoedit est une interface extensible par des opérateurs de traitement
d'images. </p>
<p> Ecrite en JavaScript grâce aux librairies <a href=
"http://jquery.com/">jQuery</a> et <a href="http://jqueryui.com/">jQuery
UI</a>. </p>
<p> L'interface est composée de plusieurs modules. jquery.photoedit.js
"editor" est le module principal. </p>
<h1> Les Fichiers </h1>
<ul>
<li> <a href="#photoedit">jquery.photoedit.js</a><br>
<a href=
"http://wiki.jqueryui.com/w/page/12138135/Widget-factory">widget jquery
UI</a>. Module principale qui gère les liens entre les autres modules
et l'affichage la page. </li>
<br/>
<li> <a href="#selection">jquery.photoedit.sélection.js</a><br>
<a href=
"http://wiki.jqueryui.com/w/page/12138135/Widget-factory">widget jquery
UI</a>. Module qui gère la sélection rectangulaire. </li>
<br/>
<li> <a href="#cords">jquery.photoedit.cords.js</a><br>
<a href="widget%20jquery%20UI">widgetjquery UI</a>. Module qui
récupere les coordonnées de la souris. </li>
<br/>
<li> <a href="#history">jquery.photoedit.history.js</a><br>
<a href=
"http://wiki.jqueryui.com/w/page/12138135/Widget-factory">widget jquery
UI</a>. Module qui gère l'historique il conserve les états
précédents du canvas.<br>
Il affiche des liens contenant des vignettes des images précédentes
pour permettre un retour en arrière. </li>
<br/>
<li> <a href="#matrice">jquery.photoedit.matrice.js</a><br>
<a href=
"http://wiki.jqueryui.com/w/page/12138135/Widget-factory">widget jquery
UI</a>. Permet de créé une entrée de type matrice. </li>
<br/>
<li> <a href="#scale">jquery.photoedit.scale.js</a><br>
<a href=
"http://wiki.jqueryui.com/w/page/12138135/Widget-factory">widget jquery
UI</a>. Module qui gère la mise à l'échelle du canvas. </li>
<br/>
<li> <a href="#actions">photoedit.actions.js</a><br>
Contients les fonctions qui gèrent les prérequis; la fonction par
défaut pour les <a href="http://www.pixastic.com/lib/docs/">actions
pixastic</a>;<br>
et les définitions des différentes actions. </li>
<br/>
<li> <a href="#imageTools">photoedit.imageTools.js</a><br>
Définit les outils tels la sélection rectangulaire. </li>
<br/>
<li> <a href="#inputs">photoedit.inputs.js</a><br>
Définit les entrées possible pour les actions. </li>
<br/>
<li> <a href="#index">index.html</a><br>
Exemple d'interface. </li>
<br/>
<li> <a href="#style">style.css</a><br>
Style css pour la mise en page. </li>
</ul>
<p> Plugin tierce: </p>
<ul>
<li>ahpi.imgload.js:<br>
<a href="http://docs.jquery.com/Plugins/Authoring">plugin jquery</a> qui surcharge la méthode on load des images pour garantir qu'elle
s'effectue même si l'image est dans la cache du navigateur. </li>
<li>jquery.mousewheel.js<br>
<a href="http://docs.jquery.com/Plugins/Authoring">plugin jquery</a> qui permet d'attacher l'évènement mousewheel utile si on veut
implémenter le zoom. </li>
</ul>
<h2> <a name="photoedit">jquery.photoedit.js</a> </h2>
<h3> options </h3>
<ul>
<li>width: largeur maximale du canvas </li>
<li>height: hauteur maximale du canvas </li>
</ul>
<h3> data </h3>
<ul>
<li> <strong>canvas, canvas2, canvas3</strong>: le premier canvas nous sert
pour afficher l'image en tenant compte des dimensions maximale définis
par les options, le second pour afficher la sélection rectangulaire du
module sélection et le troisième pour traiter l'image en taille
réelle lors de l'application d'une action. </li>
<li> <strong>ctx</strong> : contient le contexte du premier canvas. </li>
<li> <strong>img</strong> <strong>:</strong> contient l'image que l'on
charge et est mis à jour après chaque action. On se sert de cette
variable pour vérifier qu'une image a été chargée. </li>
<li> <strong>cords,scale,info</strong> <strong>, selectionPlugin,
history:</strong> contient l'instance du module correspondant. </li>
<li> <strong>inputs</strong> : contient les entrées définis dans le
fichier photoedit.inputs.js </li>
<li> <strong>actions</strong> : contient les actions définis dans le
fichier photoedit.actions.js </li>
<li> <strong>imageTools</strong> <strong>:</strong> contient les outils
définis dans le fichiers photoedit.imageTools.js </li>
<li> <strong>loadFromHistory</strong> : booléen qu'on utilise lors de
l'evenement on load de l'image pour savoir si il s'agit d'un chargement
à partir de l'historique. </li>
<li> <strong>action</strong> : contient le nom de l'action qui a été
appliqué. On s'en sert pour étiqueter les vignettes de l'historique. </li>
<li> <strong>canvas3Load</strong> : booléen qui indique si l'on doit mettre
a jour le troisième canvas. Suite au chargement d'une nouvelle image
oui. Si l'on applique une action, non car canvas3 contient déjà
l'image traité. </li>
</ul>
<h3> méthodes </h3>
<p> <strong>_requirements</strong> </p>
<blockquote>
<p> La méthode _requirements est appelé à l'initiation du widget. Elle
vérifie si le navigateur est compatible avec photoedit. On a besoin du <a href="http://fr.wikipedia.org/wiki/Canvas_%28HTML%29">canvas</a> et
du <a href="http://dev.w3.org/2006/webapi/FileAPI/">file</a> class=MsoHyperlink> API </p>
style='font-size:12.0pt;font-family:"Times New
Roman","serif";"MS
Mincho";'>. Si le navigateur n'est pas compatible on affiche la raison de
son incompatibilité. On verifie le support du canvas grâce à la
librairie <a href="http://modernizr.com/">Modernizr</a>. </blockquote>
<p> <strong>_ create</strong> </p>
<blockquote>
<p> La méthode _create est le constructeur du widget. Elle est appelée lors
de l'initiation du widget. On créé les élements canvas grâce a la
fonction <a href="http://api.jquery.com/jQuery/">jquery</a>. jQuery nous
permet de définir les attributs width et le height directement dans
l'objet avec où l'on a spécifier l'id mais ca sera en css et non en
attributs html. Donc on utilise la méthode <a href=
"http://api.jquery.com/attr/">attr</a>.<br>
Ici la variable canvas contient un objet jquery pour récupérer
l'élément dom on utilise canvas[0].<br>
L'enchainement des fonctions nous permet d'initialiser le widget info en
appelant jquery, appendTo, info et data l'un après l'autre.<br>
A l'initiation d'un widget une instance du widget est stocké dans data
avec comme nom le nom du widget. C'est pour cela que l'on peut
récupérer une instance du info widget avec .data('info'). </p>
<p> Les méthodes <a href="http://api.jquery.com/append/">append</a> et <a href="http://api.jquery.com/appendTo/">appendTo</a> servent à
rajouter les éléments sur la page.<br>
this.element contient l'élément sur lequel on a instancié le widget.
L'éditeur sera instancié sur le div photoedit dans index.html.
this.element fait donc référence à ce div. </p>
<p> La méthode <a href="http://api.jquery.com/hide/">hide</a> permet de
rendre l'élément invisible. C'est ce que l'on veut pour canvas3 qui ne
sert que pour le traitement de l'image. </p>
<p> A l'initiation du module cords par exemple on définit les options du
widget qui vont remplacer les options définis par défaut dans le
widget. Ici on définis la fonction de rappel, callback, qui est appelé
pour mettre à jour l'affichage des coordonnées. Il faut qu'on prenne en
compte l'échelle pour les coordonnées. Et l'on veut borner les
coordonnées par la taille du canvas en prenant encore une fois compte de
l'échelle. </p>
<p> Le widget sélection est initialisé avec des fonctions rappels pour
mettre à jour les dimensions et les coordonnées. </p>
<p> Le widget history a une fonction de rappel qui est appelé lors du
chargement d'un état précédent. On se contente de charger l'image, la
méthode on load de l'image s'occupera du reste. On a mis le booléen
loadFromHistory à vrai pour que la méthode on load de l'image sache
qu'il s'agit d'un chargement à partir de l'historique. </p>
<p> On met a jours les données dans data. </p>
<p> On rajoute la propriété dataTransfer aux évènements de jQuery.
Nécessaire pour récupérer un fichier suite à un glisser déposer. </p>
<p> Et on appelle la méthode show du widget. </p>
</blockquote>
<p> <strong>show</strong> </p>
<blockquote>
<p> Si le navigateur supporte le glisser déposer on affiche un message sur
le canvas indiquant que l'utilisateur peut glisser une image dessus pour
la charger. </p>
<p> On gère les évènements dragenter, dragover et drop pour le canvas2 qui
est superposé au-dessus de canvas.<br>
On se sert de la méthode <a href="http://api.jquery.com/on/">on</a>. Si
l'on passe false au lieu d'une fonction en second paramètre, jQuery
s'occupe d'empêcher le comportement par défaut du navigateur en
appelant event.stopPropagation() et event.preventDefault().<br>
Pour le drop on vérifie qu'on a un fichier et on le charge en appelant
la méthode load de notre widget. </p>
<p> Pour data.img on gère l'évènement load qui est appelé chaque fois que
l'on modifie la propriété src de l'image.<br>
On met à jour canvas3 si la variable canvas3Load est vrai.<br>
Si le chargement ne provient pas de l'historique on enregistre le nouvel
état dans l'historique.<br>
On se sert du scale widget pour afficher l'image mise à l'échelle sur
le canvas.<br>
Si une sélection est active, on la désactive.<br>
On met à jour data.canvas pour qu'il contienne bien le nouveau
canvas.<br>
On aligne les dimensions de canvas2 à celle de canvas.<br>
Et finalement on met à jour les dimensions affichées par l'info widget. </p>
<p> Grâce aux fonctions <a href="http://api.jquery.com/before/">before</a> et <a href="http://api.jquery.com/insertBefore/">insertBefore</a> on
insert le div d'id imageTools avant le canvas. Ce div va contenir nos
outils définis dans data.imageTools.<br>
On utilise la méthode <a href="http://api.jquery.com/jQuery.each/">.
each</a> pour ittérer sur l'objet data.imageTools.<br>
Avec la méthode <a href="http://api.jquery.com/jQuery.extend/">.
extend</a> on étend les propriétés de l'outil avec la propriété
"type: 'checkbox'". Ceci nous permet de créé un bouton de type checkbox
avec l'appel de data.inputs.append. data.inputs contient l'objet
photoedit_inputs du fichier photoedit.inputs.js. La méthode append de
data.inputs s'occupe de créé l'entrée correspondante, ici un bouton
checkbox et de la rajouter a l'élément dont l'id est passer en
paramètre.<br>
On connait l'id du bouton créé par append. On va définir le
comportement pour l'évènement click de ce bouton.<br>
On veut appeler la fonction fun de l'outil si l'on vérifie les
prérequis. La fonction photoedit_requirementsFun du fichier
photoedit.actions.js s'occupe de vérifier les prérequis.<br>
Si les prérequis ne sont pas vérifier on veut décocher le bouton
checkbox. Pour cela il faut enlever l'attribut checked avec la méthode <a href="http://api.jquery.com/removeAttr/">removeAttr</a> et appeler la
méthode <a href=
"http://jqueryui.com/demos/button/#method-refresh">refresh</a> du bouton
pour le mettre à jour. </p>
<p> On rajoute les actions. On veut créer un <a href=
"http://jqueryui.com/demos/accordion/">jQuery UI Accordion</a> pour
contenir les actions. On doit donc respecter la création de titre h3 et
de divs. La méthode <a href="http://api.jquery.com/length/">lenghth</a> nous permet de vérifier si un élément existe déjà.<br>
On crée un <a href="http://jqueryui.com/demos/button/">jQuery UI
button</a>. L'attribut text défini le libellé du bouton, icons défini
les icones.<br>
Quand on clique sur le bouton on veut récupérer la sélection
rectangulaire si le widget sélection est activé on le vérifie avec la
méthode isOn du sélection widget.<br>
Il faut utilise la méthode eval du scale widget pour traduire les
coordonnées et les dimensions de la sélection rectangulaire par rapport
à l’échelle.<br>
Si on n'a pas de sélection on sélection l'image toute entière.<br>
On vérifie si l'action a des entrées, appelés inputs, définis. Si
c'est le cas on veut créer un div dans lequel on rajoute les entrées
grâce à la méthode append de l'objet data.inputs.<br>
On va rajouter un bouton OK qui va étendre les options avec les valeurs
des entrées et appeler le traitement de canvas3 avec les options. A
partir de ce div on crée un dialogue en indiquant que lorsque l'on ferme
se dialogue, à l' evenement close, il faut supprimer le code html de la
page avec la méthode <a href=
"http://api.jquery.com/remove/">remove</a>.<br>
Finalement on initialise le widget accordion sur le div actions que l'on
a rempli. </p>
</blockquote>
<p> <strong>load</strong> </p>
<blockquote>
<p> Méthode qui s'occupe de charger le fichier passé en paramètre.<br>
On définit data.action en tant que "chargement de fichier", pour
étiqueter la vignette de l'historique.<br>
On vérifie qu'il s'agit bien d'une image. On créé un <a href=
"https://developer.mozilla.org/fr/DOM/FileReader">FileReader</a> pour
lire le contenu de l'image. Une fois la lecture de l'image terminer par
le reader l'evenement onload est déclencher et on met à jour la
propriété src du data.img ce qui a pour conséquence d'appeler
l'evenement onload de l'image vu dans la méthode show. </p>
</blockquote>
<p> <strong>update</strong> </p>
<blockquote>
<p> Méthode appelé après le traitement de l'image par une action. Voir
fichier photoedit.actions.js.<br>
On récupère le canvas3 modifié.<br>
On met à jour la variable data.action pour qu'elle contienne le nom de
l'action passé en paramètre à la méthode update. Il ne s'agit pas
d'un chargement de l'historique donc on met data.loadFromHistory à
false.<br>
data.canvas3 est à jour donc on met data.canvas3Load à false
également.<br>
On met à jour data.img ce qui a pour conséquence d' appeller
l'évènement onload de l'image vu dans la méthode show. </p>
</blockquote>
<p> <strong>_destroy</strong> </p>
<blockquote>
<p> Destructeur par défaut on ne s'en sert pas. </p>
</blockquote>
<p> <strong>_ setOptions</strong> </p>
<blockquote>
<p> Permet de modifier les options après l'initialisation. On ne s'en sert
pas. </p>
</blockquote>
<p> <strong>_ setOption</strong> </p>
<blockquote>
<p> Utiliser par _setOptions </p>
</blockquote>
<h2> <a name="history">jquery.photoedit.history.js</a> </h2>
<h3> options </h3>
<ul>
<li>maxHistory : maximum d'états à conserver </li>
<li>callback: fonction appelé après chargement d’un état
précédent. </li>
</ul>
<h3> data </h3>
<ul>
<li>restorePoints : <a href=
"http://www.w3schools.com/js/js_obj_array.asp">Array JavaScript</a> qui
contient les images précédentes </li>
<li>thumbnails : <a href="http://www.w3schools.com/js/js_obj_array.asp"> Array JavaScript</a> qui contient les vignettes des images
précédentes. </li>
<li>head : indique la position à laquelle on va enregistrer la prochaine
image. </li>
</ul>
<h3> Méthodes </h3>
<p> <strong>thumbnail</strong> </p>
<blockquote>
<p> Créé une vignette à partir d'une image ou d'un canvas. Prends en
paramètre les dimensions.<br>
J'utilise l'algorithme de Pixastic resize. On crée un canvas aux
dimensions prescrites et on utilise la méthode <a href=
"https://developer.mozilla.org/en/Canvas_tutorial/Using_images">drawImage</a> pour dessiner l'image à ces dimensions. </p>
</blockquote>
<p> <em><b>save</b></em> </p>
<blockquote>
<p> On distingue 3 cas particulier: </p>
<p> Historique est vide. Dans ce cas on créé un élément ul pour contenir
la liste. </p>
<p><a href=
"http://www.toutjavascript.com/reference/reference.php?iref=124">pop</a> sur restorePoints et thumbnails. On utilise la méthode <a href=
"http://api.jquery.com/find/">find</a> pour trouver le dernier élément li
et le supprimer tant que la tête de l'historique est inférieur à la
taille de l'historique.<a href=
"http://www.toutjavascript.com/reference/reference.php?iref=128">shift</a> sur restorePoints et thumbnails. On parcourt les éléments li et on met à
jour les liens. </p>
<p> La méthode save reçoit le nom de l'action, et l'image sous forme d'une
image ou d'un canvas en paramètre. Avec la propriété tagName on
verifie si il s'agit d'un canvas ou d'une image. Pour le canvas on
recupert l'image avec la méthode <a href=
"http://msdn.microsoft.com/en-us/library/ie/ff975241%28v=vs.85%29.aspx">toDataURL</a>.
Pour une image on accède à la propriété src.<br>
On crée l'élément li en gérant le lévènement onclick par un appel
à la méthode load, le lien contient l'index de l'image à charger dans
son attribut href que l'on lit en tant qu'entier grâce à la fonction <a href=
"http://www.w3schools.com/jsref/jsref_parseint.asp">parseInt</a>.<br>
On met à jour data.head qui doit toujours représenté l'index à
laquelle on va sauver le prochain état. </p>
</blockquote>
<p> <strong>load</strong> </p>
<blockquote>
<p> On se contente d'appeler la fonction callback avec le contenu de l'image.
On met à jour data.head qui doit toujours indiquer la position à
laquelle on enregistre la prochaine image. </p>
</blockquote>
<p> <strong>_destroy</strong> </p>
<blockquote>
<p> On ne se sert pas de cette méthode. </p>
</blockquote>
<p> <strong>_setOptions</strong> </p>
<blockquote>
<p> On ne se sert pas de cette méthode. </p>
</blockquote>
<h2> <a name="selection">jquery.photoedit.sélection.js</a> </h2>
<h3> options : </h3>
<ul>
<li>interval définis le temps utilisé par la fonction setInterval qui
va redessiner le canvas. </li>
<li>mySelColor : couleur des traits pour le rectangle de sélection. </li>
<li>mySelWidth : largeur des traits du rectangle de sélection. </li>
<li>mySelBoxColor : couleur des poignets pour le redimensionnement de la
sélection. </li>
<li>mySelBoxSize : taille des poignets. </li>
<li>fill : couleur du rectangle de sélection. </li>
<li>callbackDimensions : fonction callback pour les dimensions de la
sélection. </li>
<li>callbackCords : fonction callback pour les coordonnées de la
sélection. </li>
<li>offcallBack : fonction callback appelé quand on désactive la
sélection. </li>
</ul>
<h3> data : </h3>
<ul>
<li>isOn : indique si le module de sélection est activé ou non. </li>
<li>canvas : contient le canvas sur lequel on dessine la sélection </li>
<li>ctx : contient le contexte du canvas. </li>
<li>ghostcanvas : contient un canvas temporaire qui sert à tester si on
a sélectionné la sélection pour un déplacement. </li>
<li>gctx : le context du ghostcanvas </li>
<li>selectionHandles : contient les poignets de sélection. </li>
<li>isDrag : indique si on est en action de glisser </li>
<li>expectResize : indique si on sélectionne un poignet de sélection et
sa direction. </li>
<li>rectangle: contient le rectangle de sélection. </li>
<li>offsetx , offsety utilisés pour calculer la position de la souris
par rapport au rectangle de sélection </li>
<li>intervalId : contient l'identifiant pour setInterval. </li>
<li>mx,my : position de la souris. </li>
<li>canvasValid : indique si le canvas doit être redessiner ou non voire
la fonction mainDraw dans la méthode on. </li>
</ul>
<h3> Methodes </h3>
<p> <strong>_create</strong> </p>
<blockquote>
<p> On sauve le canvas dans data.canvas ainsi que son contexte dans
data.ctx. On crée le ghostcanvas et on le garde dans data.ghostcanvas
ainsi que son contexte dans data.gctx. </p>
</blockquote>
<p> <strong>getMouse</strong> </p>
<blockquote>
<p> On appelle la méthode getMouse du cords widget. On met à jour data.mx
et data.my. </p>
</blockquote>
<p> <strong>off</strong> </p>
<blockquote>
<p> On désactive le module de sélection. On utilise clearInterval pour
arrêter de mettre à jour le canvas.<br>
On enlève les évènements du namespace '.sélection' du canvas. On
efface le canvas pour enlever la sélection. On met à jour la variable
data.isOn. On appelle l’offCallback. </p>
</blockquote>
<p> <strong>hasSelection</strong> </p>
<blockquote>
<p> Inique si on a un rectangle de sélection </p>
</blockquote>
<p> <strong>on</strong> </p>
<blockquote>
<p> Active le module de sélection. On y défini l'objet Box2 et son
prototype. On s’en sert pour le rectangle et les poignets de
sélection.<br>
On initialise les poignets de sélection. </p>
<p> La fonction mainDraw gère la mise à jour du canvas. Si la variable
data.canvasValid est fausse cela indique qu'il faut redessiner la
sélection sur le canvas. </p>
<p> La fonction sanitize rend les données du rectangle de sélection
saine. On borne les dimensions avec celle du canvas. En cas de
sélection négative on corrige en déplaçant les coordonnées du
rectangle pour obtenir des dimensions positives. On borne les
coordonnées du rectangle avec les dimensions du canvas. </p>
<p> Pour la sélection j'ai implémenté http://jsbin.com/apitak/4 et
http://simonsarris.com/blog/225-canvas-selecting-resizing-shape. La
première solution superpose deux canvas afin de dessiner un rectangle
semi transparent sur le canvas superposant celui qui contient l'image.
La seconde solution apporte la capacité de bouger et de redimensionner
un rectangle sur le canvas. </p>
<p> Les fonctions myUp, myDown, myMove, sont celle de la première
solution. myUp2 myDown2 myMove2 celles de la seconde. </p>
<p> Donc dans un premier temps on ne s'occupe que de dessiner un rectangle.
Une fois celuis ci dessiner on remplace myUp, myDown, myMove par
myUp2,myDown2,myMove2 pour les évènements on mousedown, mouseup,
mousemove pour permettre de bouger et de redimensionner la sélection. </p>
<p> On met en place la mise à jour du canvas grâce a un appel à
setInterval qui va appeler mainDraw toute les options.interval. </p>
</blockquote>
<p> <strong>getSelection</strong> </p>
<blockquote>
<p> Retourne la sélection. On arrondi les valeurs pour éviter d'avoir des
flottants. Si on n’a pas de rectangle de sélection on retourne un
rectangle de sélection sur le canvas tout entier. </p>
</blockquote>
<p> <strong>_destroy</strong> </p>
<blockquote>
<p> On ne se sert pas de cette méthode. </p>
</blockquote>
<p> <strong>_setOptions</strong> </p>
<blockquote>
<p> On ne se sert pas de cette méthode. </p>
</blockquote>
<h2> <a name="cords">jquery.photoedit.cords.js</a> </h2>
<h3> options </h3>
<ul>
<li>callback: fonction qui gère l'affichage des coordonnées </li>
</ul>
<h3> data </h3>
<ul>
<li>mx, my: coordonnées de la souris </li>
<li>offsetX , offsetY: décalage du canvas par rapport à la page. </li>
</ul>
<h3> méthodes </h3>
<p> <strong>_create</strong> </p>
<blockquote>
<p> On instancie le module sur un canvas.<br>
On appel _calculateOffset qui calcule offsetX et offsetY.<br>
On active le module avec la méthode on. </p>
</blockquote>
<p> <strong>_calculateOffset</strong> </p>
<blockquote>
<p> Calcule le décalage du canvas contenu dans this.element[0] par rapport
à la page.<br>
Met à jour offsetX et offsetY. </p>
</blockquote>
<p> <strong>getMouse</strong> </p>
<blockquote>
<p> Calcule les coordonnées de la souris par rapport au canvas. Retourne
un objet qui contient les coordonnées. Utilisé dans
jquery.photoedit.sélection.js.<br>
Met à jour data.mx et data.my. </p>
</blockquote>
<p> <strong>on</strong> </p>
<blockquote>
<p> Active le module coordonné en mettant en place l'évènement mousemove
sur le canvas. On va appeler getMouse et le callback chaque fois que la
souris bouge. Si la souris sors du canvas l’évènement mouseout
appelle le callback avec comme valeurs -1,-1 que l'on pourra traiter
comme le cas d'effacement de l'affichage des coordonnées.
(Actuellement vu que l'on corrige l'affichage des coordonnées en
bornant les coordonnées entre 0 et les dimensions de l'image dans
jquery.photoedit.js ceci aura pour effet d'afficher 0,0 comme
coordonnée.) </p>
</blockquote>
<p> <strong>off</strong> </p>
<blockquote>
<p> Désactive les évènements du namespace . cords, l'évènement que
l'on a rajouté dans méthode on. </p>
</blockquote>
<p> <strong>_destroy</strong> </p>
<blockquote>
<p> On ne se sert pas de cette méthode. </p>
</blockquote>
<p> <strong>_setOptions</strong> </p>
<blockquote>
<p> On ne se sert pas de cette méthode. </p>
</blockquote>
<h2> <a name="matrice">jquery.photoedit.matrice.js</a> </h2>
<p> Ce widget permet de créé des entrées de types matrices. Qui peuvent
être utilisé pour les actions. </p>
<h3> options </h3>
<ul>
<li>n,m : dimensions de la matrice </li>
<li>values: valeurs de la matrice </li>
</ul>
<h3> méthodes </h3>
<p> <strong>_create</strong> </p>
<blockquote>
<p> On initialise ce widget sur un div. This.element fait référence à
l’objet jQuery qui contient ce div.<br>
On appel la méthode _refresh. </p>
</blockquote>
<p> <strong>_refresh</strong> </p>
<blockquote>
<p> Initialise la matrice identité si on n’a pas de valeurs définis
dans les options.<br>
On crée un formulaire qui permet de modifier les valeurs de la matrice
grâce à l'évènement onchange sur les entrées du formulaire. On
rajoute ce formulaire à this.element. </p>
</blockquote>
<p> <strong>_isNumber</strong> </p>
<blockquote>
<p> Vérifie que la valeur est bien un nombre. Retourne vrai si oui et faux
sinon. </p>
</blockquote>
<p> <strong>_dsetroy</strong> </p>
<blockquote>
<p> On supprime le formulaire de this.element avec la méthode <a href=
"http://api.jquery.com/remove/">remove</a>. </p>
</blockquote>
<p> <strong>getArray</strong> </p>
<blockquote>
<p> Retourne les valeurs de la matrice. </p>
</blockquote>
<p> <strong>_setOptions</strong> </p>
<blockquote>
<p> Permet de changer les dimensions de la matrice et les valeurs. On appel
la méthode _destroy et ensuite la méthode _refresh qui va
reconstruire le formulaire pour la nouvelle matrice. </p>
</blockquote>
<h2> <a name="scale">jquery.photoedit.scale.js</a> </h2>
<p> Ce widget s'instancie sur un canvas et permet de dessiner une image mise
à l'échelle.<br>
Pour avoir un affichage cohérent avec la mise en page il a fallu limiter
les dimensions maximales du canvas. D'où la nécessité de ce widget. </p>
<h3> data </h3>
<ul>
<li>scale : la valeur de la mise à l'échelle. Initialiser à 1 pour
aucune mise à l’échelle. </li>
<li>width,height : contient les dimensions à afficher par l'info widget </li>
</ul>
<h3> méthodes </h3>
<p> <strong>_create</strong> </p>
<blockquote>
<p> On a initialiser le widget sur un canvas que le widget nous met à
disposition avec la variable this.element [0] que l'on stock dans
data.canvas. On met à jour data.width et data.height. </p>
</blockquote>
<p> <strong>draw</strong> </p>
<blockquote>
<p> Prends en paramètre l'image à dessiner, et les dimensions à
utiliser.<br>
On met à jour data.width et data.height avec les dimensions de l'image
d'origine.<br>
Si les dimensions de l'image dépassent celle du canvas on calcule
l'échelle à utiliser et on met à jour les dimensions du canvas.<br>
Sinon on remet l'échelle à 1 et on redimensionne le canvas pour qu'il
corresponde à l'image.<br>
On applique l'échelle au canvas avec la méthode <a href=
"https://developer.mozilla.org/samples/canvas-tutorial/5_4_canvas_scale.html"> scale</a>.<br>
On dessine l'image sur le canvas avec la méthode <a href=
"https://developer.mozilla.org/en/Canvas_tutorial/Using_images">drawImage</a>. </p>
</blockquote>
<p> <strong>get</strong> </p>
<blockquote>
<p> Retourne l'échelle (data.scale). </p>
</blockquote>
<p> <strong>eval</strong> </p>
<blockquote>
<p> Enlève la mise à l’échelle sur la valeur passée en paramètre et
retourne cette nouvelle valeur. </p>
</blockquote>
<p> <strong>_destroy</strong> </p>
<blockquote>
<p> On ne se sert pas de cette méthode. </p>
</blockquote>
<p> <strong>_setOptions</strong> </p>
<blockquote>
<p> On ne se sert pas de cette méthode. </p>
</blockquote>
<h2> photoedit.actions.js </h2>
<h3> Fonctions </h3>
<p> <a name="requirements"></a> <strong>photoedit_requirementsFun</strong> </p>
<blockquote>
<p> Fonctions qui vérifie les prérequis passer en paramètre.<br>
On récupère les données du module principal grâce au fait qu'un
widget instancier sauve une instance d’elle même dans .
data(nomduwidget). </p>
<p> L'editeur a été instancier sur le div d'id photoedit. Donc on peut
récupérer une instance de l'editor widget avec $('#
photoedit').data('editor').<br>
L'objet data qui contient les données est accessible avec $('#
photoedit').data('editor').data. </p>
<p> On vérifie que l'on a bien une image de chargé. data.img.src != "". </p>
<p> Ensuite on vérifie tous les autres prérequis. La fonction . each
retourne un objet jQuery donc on ne peut pas retourner vrai ou faux. On
utilise donc une variable flag qui contient la valeur de retour. </p>
<p> Vous pouvez rajouter ici les cas à traiter. Pour l'instant le seul
prérequi gérer est la sélection. </p>
<p> On retourne la valeur du flag. </p>
</blockquote>
<p> <strong>photoedit_defaultPixasticFun</strong> </p>
<blockquote>
<p> Fonction associé aux actions Pixastic. Elle prend en paramètre le
canvas à traiter et les options.<br>
On récupère une instance de l'editor avec $('#photoedit').
data('editor'); (qui est stocker là lors de l'initiation du widget). </p>
<p> On <a href="http://www.pixastic.com/lib/docs">applique</a> l'action au
canvas.<br>
On appel la méthode update du module principale pour mettre à jour
l'affichage du canvas. </p>
</blockquote>
<h3> Objet </h3>
<p> <strong>photoedit_actions</strong> </p>
<blockquote>
<p> Contient les actions. Vous pouvez modifier cette objet pour rajouter
vos propres actions. </p>
<p> Voici un exemple avec des commentaires: </p>
<pre>
'example': { // le nom a afficher sur l'interface
action: 'nothing', // le nom de l'action, utilisé comme legende pour les vignettes de l'historique
// ainsi que par la function photoedit_defaultPixasticFun
icon: '', // l'icone a afficher sur le jQuery UI
cat: 'Transformations', // La catégorie ou ranger le bouton dans le jQuery UI Accordion
fun: function(){}, // La fonction à utiliser, pour les actions pixastic on peut utiliser photoedit_defaultPixasticFun
options: {}, // Les paramètres à passer à la fonction
requirements: {}, // Les prérequis à vérifier avant d'appliquer de la fonction.
inputs: { // Les entrées, si on en défini le bouton va ouvrir un dialogue jQuery UI
'contrast': { // Nom a afficher sur le dialogue
optionName: 'contrast', // Nom a passer en parametre a la fonction fun, avec la valeur récupérer par photoedit_inputs.val()
type: 'slider', // type d'entrée
options: {min: 0,max: 100,step: 10,value:50} // les options de l'entrée
},
},
},</pre
>
</blockquote>
<h2> photoedit.imageTools.js </h2>
<h3> Objet </h3>
<p><strong>photoedit_imageTools</strong> </p>
<blockquote>
<p> Objet qui contient les outils. La spécification est la même que
pour les actions. Un outil sera forcément de type bouton checkbox.
Pour que l'on puisse l'activer et le désactiver. J'ai implémenté
l'outil de sélection rectangulaire. C'est la fonction <a href=
"#requirements">photoedit_requirementsFun</a> du fichier
photoedit.acitons.js qui vérifie les prérequis </p>
<p> <strong>sélection</strong> </p>
<blockquote>
<p> La fonction fun vérifie si la sélection est active avec
data.selectionPlugin.isOn() si tel est le cas on désactive la
sélection. On réactive le module cords qui avait été remplacé
par le module de sélection. On décoche la checkbox. On connait
l'id de la checkbox car celle-ci est créé à partir de l'
optionName auquel on rajoutte '_ checkbox' voire
photoedit.inputs.js. </p>
<p> Si la sélection n'est pas active. On désactive le module cords et
on active la sélection. </p>
</blockquote>
</blockquote>
<h2> photoedit.inputs.js </h2>
<h3> Objet </h3>
<p> <strong>photoedit_inputs</strong> </p>
<blockquote>
<p> Cette objet à deux méthodes: append et val. La méthode append
s'occupe de créé et rajouter l'entrée à l'élément dont l'id est
passé en paramètre.<br>
Vous pouvez rajouter vos nouvelles entrées au switch. Pour l'instant
on gère le checkbox, le slider, la matrice, et la sélection (choix
entre plusieurs options). </p>
<p> La méthode val récupère la valeur de l'entrée sous forme d'objet. </p>
</blockquote>
<h2> <a name="index">index.html</a> </h2>
<p> Exemple de l'interface. Pour instancier l'interface il faut créer un
div d'id 'photoedit'. L'interface utilise des id spécifique pour
certains modules, il faudra les changer ou s'assurer que les ids
utiliser dans votre page ne rentre pas en conflits. </p>
<p> L'interface à les prérequis suivants: </p>
<ul>
<li>jQuery </li>
<li>jQuery UI </li>
<li>Modernizr </li>
<li>style.css qui superpose les canvas nécessaire pour la sélection. </li>
<li>Pour les actions déjà définis dans photoedit_actions.js:
Pixastic </li>
</ul>
<h2> <a name="style">style.css</a> </h2>
<p> <strong>#actions</strong>: on définit la largeur pour que le jquery UI
accordion s'affiche correctement. </p>
<p> <strong>#info:</strong> on rajoute du style à la boite d'information </p>
<p> <strong>#history:</strong> positionner en dessous du canvas. </p>
<p> <strong>#history ul:</strong> on veut afficher la liste à
l'horizontale. </p>
<p> <strong>#history li:</strong> on ne veut pas de marqueur avant les
éléments on veut rajouter un espace entre les éléments. </p>
<p> <strong>.inputs-seperator:</strong> utiliser dans les dialogues pour
séparer les entrées. </p>
<h1> Notes </h1>
<h2> Les Widgets </h2>
<p> Les options par défauts des widgets peuvent être modifié à
l'initialisation du module. </p>
<p> Par exemple l'historique a comme option maxHistory qui définit le
nombre maximum d'états à conserver:<br>
On peut modifier l'appel dans jquery.photoedit.js comme suit: </p>
<pre>
.history({
callback: function(imageDataURL) {
data.loadFromHistory = true;
data.img.src = imageDataURL;
},
maxHistory: 20,
// Ajouter autres options ici
})
</pre>
<p> Vous pouvez également facilement changer certains comportement de
l'application en modifiants les fonctions callbacks<br>
des différents modules. </p>
<h2> Le zoom </h2>
<p> Le zoom n'a pas été implémenté. Le fichier jquery.mousewheel.js
permet de rajouter l'évènement mousewheel sur le canvas. </p>
</body>
</html>