/
jquery.reel.html
1724 lines (1451 loc) · 355 KB
/
jquery.reel.html
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
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html> <html> <head> <title>jquery.reel.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> jQuery Reel <!--%= title %--> </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id='section-1'> <td class="docs"> <ul class="navigation"> <li> <a href="#Methods">Methods</a> <ul> <li><a href="#Construction"><code>.reel([options])</code></a></li> <li><a href="#Destruction"><code>.unreel()</code></a></li> </ul> </li> <li> <a href="#Options">Options</a> <ul> <li><a href="#Annotations"><code>annotations</code></a></li> <li><a href="#Customization"><code>area</code></a></li> <li><a href="#Customization"><code>attr</code></a></li> <li><a href="#Momentum"><code>brake</code></a></li> <li><a href="#Interaction"><code>clickfree</code></a></li> <li><a href="#Order-of-Images"><code>cw</code></a></li> <li><a href="#Customization"><code>cursor</code></a></li> <li><a href="#Animation"><code>delay</code></a></li> <li><a href="#Directional-Mode"><code>directional</code></a></li> <li><a href="#Interaction"><code>draggable</code></a></li> <li><a href="#Opening-Animation"><code>entry</code></a></li> <li><a href="#Sprite-Layout"><code>footage</code></a></li> <li><a href="#Basic-Definition"><code>frame</code></a></li> <li><a href="#Basic-Definition"><code>frames</code></a></li> <li><a href="#Mathematics"><code>graph</code></a></li> <li><a href="#Customization"><code>hint</code></a></li> <li><a href="#Sprite-Layout"><code>horizontal</code></a></li> <li><a href="#Sprite-Layout"><code>image</code></a></li> <li><a href="#Sequence"><code>images</code></a></li> <li><a href="#Customization"><code>indicator</code></a></li> <li><a href="#Dual-Orbit-Mode"><code>inversed</code></a></li> <li><a href="#Customization"><code>klass</code></a></li> <li><a href="#Basic-Definition"><code>loops</code></a></li> <li><a href="#Monitor"><code>monitor</code></a></li> <li><a href="#Opening-Animation"><code>opening</code></a></li> <li><a href="#Dual-Orbit-Mode"><code>orbital</code></a></li> <li><a href="#Sequence"><code>path</code></a></li> <li><a href="#Images-Preload-Order"><code>preload</code></a></li> <li><a href="#Customization"><code>preloader</code></a></li> <li><a href="#Animation"><code>rebound</code></a></li> <li><a href="#Sensitivity"><code>revolution</code></a></li> <li><a href="#Multi-Row-Mode"><code>row</code></a></li> <li><a href="#Multi-Row-Mode"><code>rows</code></a></li> <li><a href="#Interaction"><code>scrollable</code></a></li> <li><a href="#Sprite-Layout"><code>spacing</code></a></li> <li><a href="#Animation"><code>speed</code></a></li> <li><a href="#Deprecated-Options"><code>step</code></a></li> <li><a href="#Interaction"><code>steppable</code></a></li> <li><a href="#Deprecated-Options"><code>steps</code></a></li> <li><a href="#Rectilinear-Panorama"><code>stitched</code></a></li> <li><a href="#Sprite-Layout"><code>suffix</code></a></li> <li><a href="#Ticker"><code>tempo</code></a></li> <li><a href="#Interaction"><code>throwable</code></a></li> <li><a href="#Animation"><code>timeout</code></a></li> <li><a href="#Momentum"><code>velocity</code></a></li> <li><a href="#Dual-Orbit-Mode"><code>vertical</code></a></li> <li><a href="#Interaction"><code>wheelable</code></a></li> </ul> </li> <li> <a href="#Events">Events</a> <ul> <li><a href="#down-Event"><code>down</code></a></li> <li><a href="#loaded-Event"><code>loaded</code></a></li> <li><a href="#opening-Event"><code>opening</code></a></li> <li><a href="#openingDone-Event"><code>openingDone</code></a></li> <li><a href="#pan-Event"><code>pan</code></a></li> <li><a href="#pause-Event"><code>pause</code></a></li> <li><a href="#play-Event"><code>play</code></a></li> <li><a href="#preload-Event"><code>preload</code></a></li> <li><a href="#preloaded-Event"><code>preloaded</code></a></li> <li><a href="#setup-Event"><code>setup</code></a></li> <li><a href="#stepLeft-Event"><code>stepLeft</code></a></li> <li><a href="#stepRight-Event"><code>stepRight</code></a></li> <li><a href="#stop-Event"><code>stop</code></a></li> <li><a href="#teardown-Event"><code>teardown</code></a></li> <li><a href="#up-Event"><code>up</code></a></li> <li><a href="#wheel-Event"><code>wheel</code></a></li> </ul> </li> <li> <a href="#$.reel">Global Namespace</a> <ul> <li><a href="#Content-Delivery-Network"><code>cdn</code></a></li> <li><a href="#Reel-Instances"><code>cost</code></a></li> <li><a href="#Options"><code>def</code></a></li> <li><a href="#Methods"><code>fn</code></a></li> <li><a href="#Reel-Instances"><code>instances</code></a></li> <li><a href="#Reel-Instances"><code>leader</code></a></li> <li><a href="#Math"><code>math</code></a></li> <li><a href="#Data-Value-Normalization"><code>normal</code></a></li> <li><a href="#Preloading-Modes"><code>preload</code></a></li> <li><a href="#Regular-Expressions"><code>re</code></a></li> <li><a href="#Sequence-Build-up"><code>sequence()</code></a></li> <li><a href="#$.reel.version"><code>version</code></a></li> </ul> </li> </ul> </td> <td class="code"> <div class="highlight"><pre><span class="cm">/**</span>
<span class="cm"> @@@@@@@@@@@@@@</span>
<span class="cm"> @@@@@@@@@@@@@@@@@@@@@@</span>
<span class="cm"> @@@@@@@@ @@@@@@@@</span>
<span class="cm"> @@@@@@@ @@@@@@@</span>
<span class="cm"> @@@@@@@ @@@@@@@</span>
<span class="cm"> @@@@@@@ @@@@@@@</span>
<span class="cm"> @@@@@@@@ @ @@@@@@@@</span>
<span class="cm"> @@@@@@@@@ @@@ @@@@@@@@@</span>
<span class="cm"> @@@@@@@@@@@@@@ @@@@@@@@@@@</span>
<span class="cm"> @@@@@@@@@@@@@ @@@@@@@</span>
<span class="cm"> @@@@@@@@@@@@ @@@</span>
<span class="cm"> @@@@@@</span>
<span class="cm"> @@@@</span>
<span class="cm"> @@</span>
<span class="cm"> *</span>
<span class="cm"> * jQuery Reel</span>
<span class="cm"> * ===========</span>
<span class="cm"> * The 360° plugin for jQuery</span>
<span class="cm"> *</span>
<span class="cm"> * @license Copyright (c) 2009-2012 Petr Vostrel (http://petr.vostrel.cz/)</span>
<span class="cm"> * Dual licensed under the MIT (MIT-LICENSE.txt)</span>
<span class="cm"> * and GPL (GPL-LICENSE.txt) licenses.</span>
<span class="cm"> *</span>
<span class="cm"> * jQuery Reel</span>
<span class="cm"> * http://jquery.vostrel.cz/reel</span>
<span class="cm"> * Version: 1.2-post-loaded-velocity</span>
<span class="cm"> * Updated: 2012-08-19</span>
<span class="cm"> *</span>
<span class="cm"> * Requires jQuery 1.5 or higher</span>
<span class="cm"> */</span>
<span class="cm">/*</span>
<span class="cm"> * CDN</span>
<span class="cm"> * ---</span>
<span class="cm"> * - http://code.vostrel.cz/jquery.reel-bundle.js (recommended)</span>
<span class="cm"> * - http://code.vostrel.cz/jquery.reel.js</span>
<span class="cm"> * - http://code.vostrel.cz/jquery.reel-debug.js</span>
<span class="cm"> * - or http://code.vostrel.cz/jquery.reel-edge.js if you feel like it ;)</span>
<span class="cm"> *</span>
<span class="cm"> * Optional Plugins</span>
<span class="cm"> * ----------------</span>
<span class="cm"> * - jQuery.disableTextSelect [B] (James Dempster, http://www.jdempster.com/category/jquery/disabletextselect/)</span>
<span class="cm"> * - jQuery.mouseWheel [B] (Brandon Aaron, http://plugins.jquery.com/project/mousewheel)</span>
<span class="cm"> * - or jQuery.event.special.wheel (Three Dub Media, http://blog.threedubmedia.com/2008/08/eventspecialwheel.html)</span>
<span class="cm"> *</span>
<span class="cm"> * [B] Marked plugins are contained (with permissions) in the "bundle" version from the CDN</span>
<span class="cm"> */</span>
<span class="nx">jQuery</span><span class="p">.</span><span class="nx">reel</span> <span class="o">||</span> <span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">$</span><span class="p">,</span> <span class="nb">window</span><span class="p">,</span> <span class="nb">document</span><span class="p">,</span> <span class="kc">undefined</span><span class="p">){</span></pre></div> </td> </tr> <tr id='section-2'> <td class="docs"> <p>One vital requirement is the correct jQuery. Reel requires at least version 1.5
and a make sure check is made at the very beginning.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">if</span> <span class="p">(</span><span class="o">+</span><span class="nx">$</span><span class="p">().</span><span class="nx">jquery</span><span class="p">.</span><span class="nx">replace</span><span class="p">(</span><span class="nx">dot</span><span class="p">(),</span> <span class="nx">__</span><span class="p">).</span><span class="nx">substr</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> <span class="o"><</span> <span class="mi">15</span><span class="p">)</span>
<span class="k">throw</span> <span class="s1">'Too old jQuery for Reel.'</span></pre></div> </td> </tr> <tr id='section-3'> <td class="docs"> <p><code>$.reel</code> (or <code>jQuery.reel</code>) namespace is provided for storage of all Reel belongings.
It is locally referenced as just <code>reel</code> for speedier access.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="kd">var</span>
<span class="nx">reel</span><span class="o">=</span> <span class="nx">$</span><span class="p">.</span><span class="nx">reel</span><span class="o">=</span> <span class="p">{</span></pre></div> </td> </tr> <tr id='reel-version'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#reel-version">¶</a> </div> <h3><code>$.reel.version</code></h3>
<p><code>String</code> (major.minor.patch), since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">version</span><span class="o">:</span> <span class="s1">'1.2-post-loaded-velocity'</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Options'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Options">¶</a> </div> <h2>Options</h2>
<p>When calling <code>.reel()</code> method you have plenty of options (far too many) available.
You collect them into one hash and supply them with your call.</p>
<p><strong><em>Example:</strong> For a non-looping Reel with 12 frames:</em></p>
<pre><code>.reel({
frames: 12,
looping: false
})
</code></pre>
<p>All options are optional and if omitted, default value is used instead.
Defaults are being housed as members of <code>$.reel.def</code> hash.
If you customize any default value therein, all subsequent <code>.reel()</code> calls
will use the new value as default.</p>
<p><strong><em>Example:</strong> Change default initial frame to 5th:</em></p>
<pre><code>$.reel.def.frame = 5
</code></pre> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='reel-def'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#reel-def">¶</a> </div> <h3><code>$.reel.def</code></h3>
<p><code>Object</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">def</span><span class="o">:</span> <span class="p">{</span></pre></div> </td> </tr> <tr id='Basic-Definition'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Basic-Definition">¶</a> </div> <hr />
<h3>Basic Definition</h3>
<p>Reel is just fine with you not setting any options, however if you don't have
36 frames or beginning at frame 1, you will want to set total number
of <code>frames</code> and pick a different starting <code>frame</code>.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='frame-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#frame-Option">¶</a> </div> <h4><code>frame</code> Option</h4>
<p><code>Number</code> (frames), since 1.0</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">frame</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span></pre></div> </td> </tr> <tr id='frames-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#frames-Option">¶</a> </div> <h4><code>frames</code> Option</h4>
<p><code>Number</code> (frames), since 1.0</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">frames</span><span class="o">:</span> <span class="mi">36</span><span class="p">,</span></pre></div> </td> </tr> <tr id='section-10'> <td class="docs"> <p>~~~</p>
<p>Another common characteristics of any Reel is whether it <code>loops</code> and covers
entire 360° or not.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='loops-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#loops-Option">¶</a> </div> <h4><code>loops</code> Option</h4>
<p><code>Boolean</code>, since 1.0</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">loops</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Interaction'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Interaction">¶</a> </div> <hr />
<h3>Interaction</h3>
<p>Using boolean switches many user interaction aspects can be turned on and off.
You can disable the mouse wheel control with <code>wheelable</code>, the drag & throw
action with <code>throwable</code>, disallow the dragging completely with <code>draggable</code>,
on "touchy" devices you can disable the browser's decision to scroll the page
instead of Reel script and you can of course disable the stepping of Reel by
clicking on either half of the image with <code>steppable</code>.</p>
<p>You can even enable <code>clickfree</code> operation,
which will cause Reel to bind to mouse enter/leave events instead of mouse down/up,
thus allowing a click-free dragging.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='clickfree-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#clickfree-Option">¶</a> </div> <h4><code>clickfree</code> Option</h4>
<p><code>Boolean</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">clickfree</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span></pre></div> </td> </tr> <tr id='draggable-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#draggable-Option">¶</a> </div> <h4><code>draggable</code> Option</h4>
<p><code>Boolean</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">draggable</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span></pre></div> </td> </tr> <tr id='scrollable-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#scrollable-Option">¶</a> </div> <h4><code>scrollable</code> Option</h4>
<p>[NEW] <code>Boolean</code>, since 1.2</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">scrollable</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span></pre></div> </td> </tr> <tr id='steppable-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#steppable-Option">¶</a> </div> <h4><code>steppable</code> Option</h4>
<p>[NEW] <code>Boolean</code>, since 1.2</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">steppable</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span></pre></div> </td> </tr> <tr id='throwable-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#throwable-Option">¶</a> </div> <h4><code>throwable</code> Option</h4>
<p><code>Boolean</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">throwable</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span></pre></div> </td> </tr> <tr id='wheelable-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#wheelable-Option">¶</a> </div> <h4><code>wheelable</code> Option</h4>
<p><code>Boolean</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">wheelable</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Order-of-Images'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Order-of-Images">¶</a> </div> <hr />
<h3>Order of Images</h3>
<p>Reel presumes counter-clockwise order of the pictures taken. If the neerer facing
side doesn't follow your cursor/finger, you did clockwise. Use the <code>cw</code> option to
correct this.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='cw-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#cw-Option">¶</a> </div> <h4><code>cw</code> Option</h4>
<p><code>Boolean</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">cw</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Sensitivity'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Sensitivity">¶</a> </div> <hr />
<h3>Sensitivity</h3>
<p>In Reel sensitivity is set through the <code>revolution</code> parameter, which represents horizontal
dragging distance one must cover to perform one full revolution. By default this value
is calculated based on the setup you have - it is either twice the width of the image
or half the width of stitched panorama. You may also set your own.</p>
<p>Optionally <code>revolution</code> can be set as an Object with <code>x</code> member for horizontal revolution
and/or <code>y</code> member for vertical revolution in multi-row movies.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='revolution-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#revolution-Option">¶</a> </div> <h4><code>revolution</code> Option</h4>
<p><code>Number</code> (pixels) or <code>Object</code>, since 1.1, <code>Object</code> support since 1.2</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">revolution</span><span class="o">:</span> <span class="kc">undefined</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Rectilinear-Panorama'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Rectilinear-Panorama">¶</a> </div> <hr />
<h3>Rectilinear Panorama</h3>
<p>The easiest of all is the stitched panorama mode. For this mode, instead of the sprite,
a single seamlessly stitched stretched image is used and the view scrolls the image.
This mode is triggered by setting a pixel width of the <code>stitched</code> image.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='stitched-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#stitched-Option">¶</a> </div> <h4><code>stitched</code> Option</h4>
<p><code>Number</code> (pixels), since 1.0</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">stitched</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Directional-Mode'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Directional-Mode">¶</a> </div> <hr />
<h3>Directional Mode</h3>
<p>As you may have noticed on Reel's homepage or in [this example][logo]
when you drag the arrow will point to either direction. In such <code>directional</code> mode, the sprite
is actually 2 in 1 - one file contains two sprites one tightly following the other, one
for visually going one way (<code>A</code>) and one for the other (<code>B</code>).</p>
<pre><code>A01 A02 A03 A04 A05 A06
A07 A08 A09 A10 A11 A12
A13 A14 A15 B01 B02 B03
B04 B05 B06 B07 B08 B09
B10 B11 B12 B13 B14 B15
</code></pre>
<p>Switching between <code>A</code> and <code>B</code> frames is based on direction of the drag. Directional mode isn't
limited to sprites only, sequences also apply. The figure below shows the very same setup like
the above figure, only translated into actual frames of the sequence.</p>
<pre><code>001 002 003 004 005 006
007 008 009 010 011 012
013 014 015 016 017 018
019 020 021 022 023 024
025 026 027 028 029 030
</code></pre>
<p>Frame <code>016</code> represents the <code>B01</code> so it actually is first frame of the other direction.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='directional-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#directional-Option">¶</a> </div> <h4><code>directional</code> Option</h4>
<p><code>Boolean</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">directional</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Multi-Row-Mode'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Multi-Row-Mode">¶</a> </div> <hr />
<h3>Multi-Row Mode</h3>
<p>As <code>example/object-movie-multirow-sequence</code> very nicely demonstrates, in multi-row arrangement you
can perform two-axis manipulation allowing you to add one or more vertical angles. Think of it as
a layered cake, each new elevation of the camera during shooting creates one layer of the cake -
- a <em>row</em>. One plain horizontal object movie full spin is one row:</p>
<pre><code>A01 A02 A03 A04 A05 A06
A07 A08 A09 A10 A11 A12
A13 A14 A15
</code></pre>
<p>Second row tightly follows after the first one:</p>
<pre><code>A01 A02 A03 A04 A05 A06
A07 A08 A09 A10 A11 A12
A13 A14 A15 B01 B02 B03
B04 B05 B06 B07 B08 B09
B10 B11 B12 B13 B14 B15
C01...
</code></pre>
<p>This way you stack up any number of <strong><code>rows</code></strong> you wish and set the initial <code>row</code> to start with.
Again, not limited to sprites, sequences also apply.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='row-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#row-Option">¶</a> </div> <h4><code>row</code> Option</h4>
<p><code>Number</code> (rows), since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">row</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span></pre></div> </td> </tr> <tr id='rows-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#rows-Option">¶</a> </div> <h4><code>rows</code> Option</h4>
<p><code>Number</code> (rows), since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">rows</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Dual-Orbit-Mode'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Dual-Orbit-Mode">¶</a> </div> <hr />
<h3>Dual-Orbit Mode</h3>
<p>Special form of multi-axis movie is the dual-axis mode. In this mode the object offers two plain
spins - horizontal and vertical orbits combined together crossing each other at the <code>frame</code>
forming sort of a cross if envisioned. [This example][phone] demonstrate this setup. When the
phone in the example is facing you (marked in the example with green square in the top right),
you are at the center. That is within the distance (in frames) defined by the <code>orbital</code> option.
Translation from horizontal to vertical orbit can be achieved on this sweet-spot. By default
horizontal orbit is chosen first, unless <code>vertical</code> option is used against.</p>
<p>In case the image doesn't follow the vertical drag, you may have your vertical orbit <code>inversed</code>.</p>
<p>Technically it is just a two-layer movie:</p>
<pre><code>A01 A02 A03 A04 A05 A06
A07 A08 A09 A10 A11 A12
A13 A14 A15 B01 B02 B03
B04 B05 B06 B07 B08 B09
B10 B11 B12 B13 B14 B15
</code></pre> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='orbital-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#orbital-Option">¶</a> </div> <h4><code>orbital</code> Option</h4>
<p><code>Number</code> (frames), since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">orbital</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span></pre></div> </td> </tr> <tr id='vertical-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#vertical-Option">¶</a> </div> <h4><code>vertical</code> Option</h4>
<p><code>Boolean</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">vertical</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span></pre></div> </td> </tr> <tr id='inversed-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#inversed-Option">¶</a> </div> <h4><code>inversed</code> Option</h4>
<p><code>Boolean</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">inversed</span><span class="o">:</span> <span class="kc">false</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Sprite-Layout'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Sprite-Layout">¶</a> </div> <hr />
<h3>Sprite Layout</h3>
<p>For both object movies and panoramas Reel presumes you use a combined <em>Sprite</em> to hold all your
frames in a single file. This powerful technique of using a sheet of several individual images
has many advantages in terms of compactness, loading, caching, etc. However, know your enemy,
be also aware of the limitations, which stem from memory limits of mobile
(learn more in <a href="https://github.com/pisi/Reel/wiki/FAQ">FAQ</a>).</p>
<p>Inside the sprite, individual frames are laid down one by one, to the right of the previous one
in a straight <em>Line</em>:</p>
<pre><code>01 02 03 04 05 06
07...
</code></pre>
<p>Horizontal length of the line is reffered to as <code>footage</code>. Unless frames <code>spacing</code> in pixels
is set, edges of frames must touch.</p>
<pre><code>01 02 03 04 05 06
07 08 09 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
</code></pre>
<p>This is what you'll get by calling <code>.reel()</code> without any options. All frames laid out 6 in line.
By default nicely even 6 x 6 grid like, which also inherits the aspect ratio of your frames.</p>
<p>By setting <code>horizontal</code> to <code>false</code>, instead of forming lines, frames are expected to form
<em>Columns</em>. All starts at the top left corner in both cases.</p>
<pre><code>01 07 13 19 25 31
02 08 14 20 26 32
03 09 15 21 27 33
04 10 16 22 28 34
05 11 17 23 29 35
06 12 18 24 30 36
</code></pre>
<p>URL for the sprite image file is being build from the name of the original <code><img></code> <code>src</code> image
by adding a <code>suffix</code> to it. By default this results in <code>"object-reel.jpg"</code> for <code>"object.jpg"</code>.
You can also take full control over the sprite <code>image</code> URL that will be used.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='footage-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#footage-Option">¶</a> </div> <h4><code>footage</code> Option</h4>
<p><code>Number</code> (frames), since 1.0</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">footage</span><span class="o">:</span> <span class="mi">6</span><span class="p">,</span></pre></div> </td> </tr> <tr id='spacing-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#spacing-Option">¶</a> </div> <h4><code>spacing</code> Option</h4>
<p><code>Number</code> (pixels), since 1.0</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">spacing</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span></pre></div> </td> </tr> <tr id='horizontal-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#horizontal-Option">¶</a> </div> <h4><code>horizontal</code> Option</h4>
<p><code>Boolean</code>, since 1.0</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">horizontal</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span></pre></div> </td> </tr> <tr id='suffix-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#suffix-Option">¶</a> </div> <h4><code>suffix</code> Option</h4>
<p><code>String</code>, since 1.0</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">suffix</span><span class="o">:</span> <span class="s1">'-reel'</span><span class="p">,</span></pre></div> </td> </tr> <tr id='image-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#image-Option">¶</a> </div> <h4><code>image</code> Option</h4>
<p><code>String</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">image</span><span class="o">:</span> <span class="kc">undefined</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Sequence'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Sequence">¶</a> </div> <hr />
<h3>Sequence</h3>
<p>Collection of individual frame images is called <em>Sequence</em> and it this way one HTTP request per
frame is made carried out as opposed to sprite with one request per entire sprite. Define it with
string like: <code>"image_###.jpg"</code>. The <code>#</code> placeholders will be replaced with a numeric +1 counter
padded to the placeholders length.
Learn more about <a href="Sequences">sequences</a>.</p>
<p>In case you work with hashed filenames like <code>64bc654d21cb.jpg</code>, where no counter element can
be indentified, or you prefer direct control, <code>images</code> can also accept array of plain URL strings.</p>
<p>All images are retrieved from a specified <code>path</code>.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='images-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#images-Option">¶</a> </div> <h4><code>images</code> Option</h4>
<p>[IMPROVED] <code>String</code> or <code>Array</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">images</span><span class="o">:</span> <span class="s1">''</span><span class="p">,</span></pre></div> </td> </tr> <tr id='path-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#path-Option">¶</a> </div> <h4><code>path</code> Option</h4>
<p><code>String</code> (URL path), since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">path</span><span class="o">:</span> <span class="s1">''</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Images-Preload-Order'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Images-Preload-Order">¶</a> </div> <hr />
<h3>Images Preload Order</h3>
<p>Given sequence images can be additionally reordered to achieve a perceived faster preloading.
Value given to <code>preload</code> option must match a name of a pre-registered function within
<code>$.reel.preload</code> object. There are two functions built-in:</p>
<ul>
<li><code>"fidelity"</code> - non-linear way that ensures even spreading of preloaded images around the entire
revolution leaving the gaps in-between as small as possible. This results in a gradually
increasing fidelity of the image rather than having one large shrinking gap. This is the default
behavior.</li>
<li><code>"linear"</code> - linear order of preloading</li>
</ul> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='preload-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#preload-Option">¶</a> </div> <h4><code>preload</code> Option</h4>
<p>[NEW] <code>String</code>, since 1.2</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">preload</span><span class="o">:</span> <span class="s1">'fidelity'</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Animation'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Animation">¶</a> </div> <hr />
<h3>Animation</h3>
<p>Your object movie or a panorama can perform an autonomous sustained motion in one direction.
When <code>speed</code> is set in revolutions per second (Hz), after a given <code>delay</code> the instance will
animate and advance frames by itself.</p>
<pre><code>t
|-------›|-----------›
Delay Animation
</code></pre>
<p>Start and resume of animation happens when given <code>timeout</code> has elapsed since user became idle.</p>
<pre><code>t
|-----------›|= == == = === = = | |-----------›
Animation User interaction Timeout Animation
</code></pre>
<p>When a scene doesn't loop (see <code>loops</code>) and the animation reaches one end, it stays there
for a while and then reversing the direction of the animation it bounces back towards the other
end. The time spent on the edge can be customized with <code>rebound</code>.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='speed-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#speed-Option">¶</a> </div> <h4><code>speed</code> Option</h4>
<p><code>Number</code> (Hz), since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">speed</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span></pre></div> </td> </tr> <tr id='delay-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#delay-Option">¶</a> </div> <h4><code>delay</code> Option</h4>
<p><code>Number</code> (seconds), since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">delay</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span></pre></div> </td> </tr> <tr id='timeout-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#timeout-Option">¶</a> </div> <h4><code>timeout</code> Option</h4>
<p><code>Number</code> (seconds), since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">timeout</span><span class="o">:</span> <span class="mi">2</span><span class="p">,</span></pre></div> </td> </tr> <tr id='rebound-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#rebound-Option">¶</a> </div> <h4><code>rebound</code> Option</h4>
<p><code>Number</code> (seconds), since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">rebound</span><span class="o">:</span> <span class="mf">0.5</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Opening-Animation'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Opening-Animation">¶</a> </div> <hr />
<h3>Opening Animation</h3>
<p>Chance is you want the object to spin a little to attract attention and then stop and wait
for the user to engage. This is called "opening animation" and it is performed for given number
of seconds (<code>opening</code>) at dedicated <code>entry</code> speed. The <code>entry</code> speed defaults to value of <code>speed</code>
option. After the opening animation has passed, regular animation procedure begins starting with
the delay (if any).</p>
<pre><code>t
|--------›|-------›|-----------›
Opening Delay Animation
</code></pre> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='entry-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#entry-Option">¶</a> </div> <h4><code>entry</code> Option</h4>
<p><code>Number</code> (Hz), since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">entry</span><span class="o">:</span> <span class="kc">undefined</span><span class="p">,</span></pre></div> </td> </tr> <tr id='opening-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#opening-Option">¶</a> </div> <h4><code>opening</code> Option</h4>
<p><code>Number</code> (seconds), since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">opening</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Momentum'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Momentum">¶</a> </div> <hr />
<h3>Momentum</h3>
<p>Often also called inertial motion is a result of measuring a velocity of dragging. This velocity
builds up momentum, so when a drag is released, the image still retains the momentum and continues
to spin on itself. Naturally the momentum soon wears off as <code>brake</code> is being applied.</p>
<p>One can utilize this momentum for a different kind of an opening animation. By setting initial
<code>velocity</code>, the instance gets artificial momentum and spins to slow down to stop.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='brake-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#brake-Option">¶</a> </div> <h4><code>brake</code> Option</h4>
<p><code>Number</code>, since 1.1, where it also has a different default <code>0.5</code></p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">brake</span><span class="o">:</span> <span class="mf">0.23</span><span class="p">,</span></pre></div> </td> </tr> <tr id='velocity-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#velocity-Option">¶</a> </div> <h4><code>velocity</code> Option</h4>
<p>[NEW] <code>Number</code>, since 1.2</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">velocity</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Ticker'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Ticker">¶</a> </div> <hr />
<h3>Ticker</h3>
<p>For purposes of animation, Reel starts and maintains a timer device which emits ticks timing all
animations. There is only one ticker running in the document and all instances subscribe to this
one ticker. Ticker is equipped with a mechanism, which compensates for the measured costs
of running Reels to ensure the ticker ticks on time. The <code>tempo</code> (in Hz) of the ticker can be
specified.</p>
<p>Please note, that ticker is synchronized with a <em>leader</em>, the oldest living instance on page,
and adjusts to his tempo.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='tempo-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#tempo-Option">¶</a> </div> <h4><code>tempo</code> Option</h4>
<p><code>Number</code> (Hz, ticks per second), since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">tempo</span><span class="o">:</span> <span class="mi">36</span><span class="p">,</span></pre></div> </td> </tr> <tr id='section-58'> <td class="docs"> <p>~~~</p>
<p>Since many mobile devices are sometimes considerably underpowered in comparison with desktops,
they often can keep up with the 36 Hz rhythm. In Reel these are called <strong>lazy devices</strong>
and everything mobile qualifies as lazy for the sake of the battery and interaction fluency.
The ticker is under-clocked for them by a <code>laziness</code> factor, which is used to divide the <code>tempo</code>.
Default <code>laziness</code> of <code>6</code> will effectively use 6 Hz instead (6 = 36 / 6) on lazy devices.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='laziness-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#laziness-Option">¶</a> </div> <h4><code>laziness</code> Option</h4>
<p><code>Number</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">laziness</span><span class="o">:</span> <span class="mi">6</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Customization'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Customization">¶</a> </div> <hr />
<h3>Customization</h3>
<p>You can customize Reel on both functional and visual front. The most visible thing you can
customize is probably the <code>cursor</code>, size of the <code>preloader</code>, perhaps add visual <code>indicator</code>(s)
of Reel's position within the range. You can also set custom <code>hint</code> for the tooltip, which appears
when you mouse over the image area. Last but not least you can also add custom class name <code>klass</code>
to the instance.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='cursor-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#cursor-Option">¶</a> </div> <h4><code>cursor</code> Option</h4>
<p>[NEW] <code>String</code>, since 1.2</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">cursor</span><span class="o">:</span> <span class="kc">undefined</span><span class="p">,</span></pre></div> </td> </tr> <tr id='hint-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#hint-Option">¶</a> </div> <h4><code>hint</code> Option</h4>
<p><code>String</code>, since 1.0</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">hint</span><span class="o">:</span> <span class="s1">''</span><span class="p">,</span></pre></div> </td> </tr> <tr id='indicator-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#indicator-Option">¶</a> </div> <h4><code>indicator</code> Option</h4>
<p><code>Number</code> (pixels), since 1.0</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">indicator</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span></pre></div> </td> </tr> <tr id='klass-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#klass-Option">¶</a> </div> <h4><code>klass</code> Option</h4>
<p><code>String</code>, since 1.0</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">klass</span><span class="o">:</span> <span class="s1">''</span><span class="p">,</span></pre></div> </td> </tr> <tr id='preloader-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#preloader-Option">¶</a> </div> <h4><code>preloader</code> Option</h4>
<p><code>Number</code> (pixels), since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">preloader</span><span class="o">:</span> <span class="mi">2</span><span class="p">,</span></pre></div> </td> </tr> <tr id='section-66'> <td class="docs"> <p>~~~</p>
<p>You can use custom attributes (<code>attr</code>) on the node - it accepts the same name-value pairs object
jQuery <code>.attr()</code> does. In case you want to delegate full interaction control over the instance
to some other DOM element(s) on page, you can with <code>area</code>.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='area-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#area-Option">¶</a> </div> <h4><code>area</code> Option</h4>
<p><code>jQuery</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">area</span><span class="o">:</span> <span class="kc">undefined</span><span class="p">,</span></pre></div> </td> </tr> <tr id='attr-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#attr-Option">¶</a> </div> <h4><code>attr</code> Option</h4>
<p>[NEW] <code>Object</code>, since 1.2</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">attr</span><span class="o">:</span> <span class="p">{},</span></pre></div> </td> </tr> <tr id='Annotations'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Annotations">¶</a> </div> <hr />
<h3>Annotations</h3>
<p>To further visually describe your scene you can place all kinds of in-picture HTML annotations
by defining an <code>annotations</code> object. Learn more about <a href="https://github.com/pisi/Reel/wiki/Annotations">Annotations</a> in a dedicated article.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='annotations-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#annotations-Option">¶</a> </div> <h4><code>annotations</code> Option</h4>
<p>[NEW] <code>Object</code>, since 1.2</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">annotations</span><span class="o">:</span> <span class="kc">undefined</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Mathematics'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Mathematics">¶</a> </div> <hr />
<h3>Mathematics</h3>
<p>When reeling, instance conforms to a graph function, which defines whether it will loop
(<code>$.reel.math.hatch</code>) or it won't (<code>$.reel.math.envelope</code>). My math is far from flawless
and I'm sure there are much better ways how to handle things. the <code>graph</code> option is there for you
shall you need it. It accepts a function, which should process given criteria and return
a fraction of 1.</p>
<pre><code>function( x, start, revolution, lo, hi, cwness, y ){
return fraction // 0.0 - 1.0
}
</code></pre> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='graph-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#graph-Option">¶</a> </div> <h4><code>graph</code> Option</h4>
<p><code>Function</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">graph</span><span class="o">:</span> <span class="kc">undefined</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Monitor'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Monitor">¶</a> </div> <hr />
<h3>Monitor</h3>
<p>Specify a string data key and you will see its real-time value dumped in the upper-left corner
of the viewport. Its visual can be customized by CSS using <code>.jquery-reel-monitor</code> selector.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='monitor-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#monitor-Option">¶</a> </div> <h4><code>monitor</code> Option</h4>
<p><code>String</code> (data key), since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">monitor</span><span class="o">:</span> <span class="kc">undefined</span><span class="p">,</span></pre></div> </td> </tr> <tr id='Deprecated-Options'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Deprecated-Options">¶</a> </div> <hr />
<h3>Deprecated Options</h3>
<p>Two options are currently deprecated in version 1.2. Learn more about <a href="https://github.com/pisi/Reel/wiki/Deprecations">Deprecations</a></p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='step-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#step-Option">¶</a> </div> <h4><code>step</code> Option</h4>
<p><code>Number</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">step</span><span class="o">:</span> <span class="kc">undefined</span><span class="p">,</span> <span class="c1">// use `frame` instead</span></pre></div> </td> </tr> <tr id='steps-Option'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#steps-Option">¶</a> </div> <h4><code>steps</code> Option</h4>
<p><code>Number</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">steps</span><span class="o">:</span> <span class="kc">undefined</span> <span class="c1">// use `frames` instead</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='Methods'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Methods">¶</a> </div> <hr />
<h2>Methods</h2>
<p>Reel's methods extend jQuery core functions with members of its <code>$.reel.fn</code> object. Despite Reel
being a typical one-method plug-in with its <code>.reel()</code> function, for convenience it also offers
its dipolar twin <code>.unreel()</code>.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='reel-fn'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#reel-fn">¶</a> </div> <h3><code>$.reel.fn</code></h3>
<p>returns <code>Object</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">fn</span><span class="o">:</span> <span class="p">{</span></pre></div> </td> </tr> <tr id='Construction'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Construction">¶</a> </div> <hr />
<h2>Construction</h2>
<p><code>.reel()</code> method is the core of Reel and similar to some jQuery functions, this one is three-fold.
It either performs the following builder's duty or the <a href="#Data">data duty</a>.</p> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='reel-Method'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#reel-Method">¶</a> </div> <h3><code>.reel()</code> Method</h3>
<p>returns <code>jQuery</code>, since 1.0</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">reel</span><span class="o">:</span> <span class="kd">function</span><span class="p">(){</span></pre></div> </td> </tr> <tr id='section-82'> <td class="docs"> <p>The decision on what to actually do is made upon given arguments.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="kd">var</span>
<span class="nx">args</span><span class="o">=</span> <span class="nx">arguments</span><span class="p">,</span>
<span class="nx">t</span><span class="o">=</span> <span class="nx">$</span><span class="p">(</span><span class="k">this</span><span class="p">),</span>
<span class="nx">data</span><span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">data</span><span class="p">(),</span>
<span class="nx">name</span><span class="o">=</span> <span class="nx">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">||</span> <span class="p">{},</span>
<span class="nx">value</span><span class="o">=</span> <span class="nx">args</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">if</span> <span class="p">(</span><span class="k">typeof</span> <span class="nx">name</span> <span class="o">==</span> <span class="s1">'object'</span><span class="p">){</span>
<span class="kd">var</span></pre></div> </td> </tr> <tr id='section-83'> <td class="docs"> <p>Establish local <code>opt</code> object made by extending the defaults.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">opt</span><span class="o">=</span> <span class="nx">$</span><span class="p">.</span><span class="nx">extend</span><span class="p">({},</span> <span class="nx">reel</span><span class="p">.</span><span class="nx">def</span><span class="p">,</span> <span class="nx">name</span><span class="p">),</span></pre></div> </td> </tr> <tr id='section-84'> <td class="docs"> <p>Limit the given jQuery collection to <code><img></code> tags.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">applicable</span><span class="o">=</span> <span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">tags</span><span class="p">){</span>
<span class="kd">var</span>
<span class="nx">pass</span><span class="o">=</span> <span class="p">[]</span>
<span class="nx">tags</span><span class="p">.</span><span class="nx">filter</span><span class="p">(</span><span class="nx">_img_</span><span class="p">).</span><span class="nx">each</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">ix</span><span class="p">){</span></pre></div> </td> </tr> <tr id='section-85'> <td class="docs"> <p>Verify they have a workable set of properties. They need to have at least:</p>
<ul>
<li>non-empty <code>src</code> attribute defined</li>
<li>non-zero <code>width</code> and <code>height</code> attributes defined</li>
</ul> </td> <td class="code"> <div class="highlight"><pre> <span class="kd">var</span>
<span class="nx">$this</span><span class="o">=</span> <span class="nx">$</span><span class="p">(</span><span class="k">this</span><span class="p">),</span>
<span class="nx">src</span><span class="o">=</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">images</span><span class="p">.</span><span class="nx">length</span> <span class="o">&&</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">images</span> <span class="o">||</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">sequence</span> <span class="o">||</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">image</span> <span class="o">||</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">attr</span><span class="p">.</span><span class="nx">src</span> <span class="o">||</span> <span class="nx">$this</span><span class="p">.</span><span class="nx">attr</span><span class="p">(</span><span class="s1">'src'</span><span class="p">),</span>
<span class="nx">width</span><span class="o">=</span> <span class="nx">number</span><span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">attr</span><span class="p">.</span><span class="nx">width</span> <span class="o">||</span> <span class="nx">$this</span><span class="p">.</span><span class="nx">css</span><span class="p">(</span><span class="nx">_width_</span><span class="p">)),</span>
<span class="nx">height</span><span class="o">=</span> <span class="nx">number</span><span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">attr</span><span class="p">.</span><span class="nx">height</span> <span class="o">||</span> <span class="nx">$this</span><span class="p">.</span><span class="nx">css</span><span class="p">(</span><span class="nx">_height_</span><span class="p">))</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">src</span> <span class="o">&&</span> <span class="nx">src</span> <span class="o">!=</span> <span class="nx">__</span> <span class="o">&&</span> <span class="nx">width</span> <span class="o">&&</span> <span class="nx">height</span><span class="p">)</span> <span class="nx">pass</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">$this</span><span class="p">);</span>
<span class="p">});</span></pre></div> </td> </tr> <tr id='section-86'> <td class="docs"> <p>If a Reel instance already, tear it down first.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">tags</span><span class="p">.</span><span class="nx">filter</span><span class="p">(</span><span class="nx">dot</span><span class="p">(</span><span class="nx">klass</span><span class="p">)).</span><span class="nx">each</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">ix</span><span class="p">){</span>
<span class="nx">pass</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">$</span><span class="p">(</span><span class="k">this</span><span class="p">).</span><span class="nx">unreel</span><span class="p">());</span>
<span class="p">});</span>
<span class="k">return</span> <span class="nx">$</span><span class="p">(</span><span class="nx">pass</span><span class="p">);</span>
<span class="p">})(</span><span class="k">this</span><span class="p">),</span>
<span class="nx">instances</span><span class="o">=</span> <span class="p">[]</span></pre></div> </td> </tr> <tr id='section-87'> <td class="docs"> <p>Backward-compatibility of [deprecated] legacy options</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">opt</span><span class="p">.</span><span class="nx">step</span> <span class="o">&&</span> <span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">frame</span><span class="o">=</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">step</span><span class="p">);</span>
<span class="nx">opt</span><span class="p">.</span><span class="nx">steps</span> <span class="o">&&</span> <span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">frames</span><span class="o">=</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">steps</span><span class="p">);</span>
<span class="nx">applicable</span><span class="p">.</span><span class="nx">each</span><span class="p">(</span><span class="kd">function</span><span class="p">(){</span>
<span class="kd">var</span>
<span class="nx">t</span><span class="o">=</span> <span class="nx">$</span><span class="p">(</span><span class="k">this</span><span class="p">),</span></pre></div> </td> </tr> <tr id='section-88'> <td class="docs"> <p>Quick data interface</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">set</span><span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">name</span><span class="p">,</span> <span class="nx">value</span><span class="p">){</span> <span class="k">return</span> <span class="nx">t</span><span class="p">.</span><span class="nx">reel</span><span class="p">(</span><span class="nx">name</span><span class="p">,</span> <span class="nx">value</span><span class="p">)</span> <span class="o">&&</span> <span class="nx">value</span> <span class="p">},</span>
<span class="nx">get</span><span class="o">=</span> <span class="kd">function</span><span class="p">(</span><span class="nx">name</span><span class="p">){</span> <span class="k">return</span> <span class="nx">t</span><span class="p">.</span><span class="nx">reel</span><span class="p">(</span><span class="nx">name</span><span class="p">)</span> <span class="p">},</span>
<span class="nx">on</span><span class="o">=</span> <span class="p">{</span></pre></div> </td> </tr> <tr id='Initialization'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Initialization">¶</a> </div> <hr />
<h2>Initialization</h2>
<p>This internally called private pseudo-handler:</p>
<ul>
<li>initiates all data store keys</li>
<li>binds to ticker</li>
<li>triggers <code>"setup</code> Event when finished</li>
</ul> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">setup</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">){</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">t</span><span class="p">.</span><span class="nx">hasClass</span><span class="p">(</span><span class="nx">klass</span><span class="p">))</span> <span class="k">return</span><span class="p">;</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_options_</span><span class="p">,</span> <span class="nx">opt</span><span class="p">);</span>
<span class="kd">var</span>
<span class="nx">src</span><span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">attr</span><span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">attr</span><span class="p">).</span><span class="nx">attr</span><span class="p">(</span><span class="s1">'src'</span><span class="p">),</span>
<span class="nx">id</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_id_</span><span class="p">,</span> <span class="nx">t</span><span class="p">.</span><span class="nx">attr</span><span class="p">(</span><span class="nx">_id_</span><span class="p">)</span> <span class="o">||</span> <span class="nx">t</span><span class="p">.</span><span class="nx">attr</span><span class="p">(</span><span class="nx">_id_</span><span class="p">,</span> <span class="nx">klass</span><span class="o">+</span><span class="s1">'-'</span><span class="o">+</span><span class="p">(</span><span class="o">+</span><span class="k">new</span> <span class="nb">Date</span><span class="p">())).</span><span class="nx">attr</span><span class="p">(</span><span class="nx">_id_</span><span class="p">)),</span>
<span class="nx">styles</span><span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">attr</span><span class="p">(</span><span class="nx">_style_</span><span class="p">),</span>
<span class="nx">data</span><span class="o">=</span> <span class="nx">$</span><span class="p">.</span><span class="nx">extend</span><span class="p">({},</span> <span class="nx">t</span><span class="p">.</span><span class="nx">data</span><span class="p">()),</span>
<span class="nx">sequence</span><span class="o">=</span> <span class="nx">reel</span><span class="p">.</span><span class="nx">re</span><span class="p">.</span><span class="nx">sequence</span><span class="p">.</span><span class="nx">exec</span><span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">images</span><span class="p">),</span>
<span class="nx">images</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_images_</span><span class="p">,</span> <span class="nx">sequence</span> <span class="o">?</span> <span class="nx">reel</span><span class="p">.</span><span class="nx">sequence</span><span class="p">(</span><span class="nx">sequence</span><span class="p">,</span> <span class="nx">opt</span><span class="p">,</span> <span class="nx">get</span><span class="p">)</span> <span class="o">:</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">images</span> <span class="o">||</span> <span class="p">[]),</span>
<span class="nx">stitched</span><span class="o">=</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">stitched</span><span class="p">,</span>
<span class="nx">loops</span><span class="o">=</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">loops</span><span class="p">,</span>
<span class="nx">size</span><span class="o">=</span> <span class="p">{</span> <span class="nx">x</span><span class="o">:</span> <span class="nx">number</span><span class="p">(</span><span class="nx">t</span><span class="p">.</span><span class="nx">css</span><span class="p">(</span><span class="nx">_width_</span><span class="p">)</span> <span class="o">||</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">attr</span><span class="p">.</span><span class="nx">width</span><span class="p">),</span> <span class="nx">y</span><span class="o">:</span> <span class="nx">number</span><span class="p">(</span><span class="nx">t</span><span class="p">.</span><span class="nx">css</span><span class="p">(</span><span class="nx">_height_</span><span class="p">)</span> <span class="o">||</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">attr</span><span class="p">.</span><span class="nx">height</span><span class="p">)</span> <span class="p">},</span>
<span class="nx">frames</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_frames_</span><span class="p">,</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">orbital</span> <span class="o">&&</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">footage</span> <span class="o">||</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">rows</span> <span class="o"><=</span> <span class="mi">1</span> <span class="o">&&</span> <span class="nx">images</span><span class="p">.</span><span class="nx">length</span> <span class="o">||</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">frames</span><span class="p">),</span>
<span class="nx">multirow</span><span class="o">=</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">rows</span> <span class="o">></span> <span class="mi">1</span> <span class="o">||</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">orbital</span><span class="p">,</span>
<span class="nx">revolution</span><span class="o">=</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">revolution</span><span class="p">,</span>
<span class="nx">revolution_x</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_revolution_</span><span class="p">,</span> <span class="nx">axis</span><span class="p">(</span><span class="s1">'x'</span><span class="p">,</span> <span class="nx">revolution</span><span class="p">)</span> <span class="o">||</span> <span class="nx">stitched</span> <span class="o">/</span> <span class="mi">2</span> <span class="o">||</span> <span class="nx">size</span><span class="p">.</span><span class="nx">x</span> <span class="o">*</span> <span class="mi">2</span><span class="p">),</span>
<span class="nx">revolution_y</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_revolution_y_</span><span class="p">,</span> <span class="o">!</span><span class="nx">multirow</span> <span class="o">?</span> <span class="mi">0</span> <span class="o">:</span> <span class="p">(</span><span class="nx">axis</span><span class="p">(</span><span class="s1">'y'</span><span class="p">,</span> <span class="nx">revolution</span><span class="p">)</span> <span class="o">||</span> <span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">rows</span> <span class="o">></span> <span class="mi">3</span> <span class="o">?</span> <span class="nx">size</span><span class="p">.</span><span class="nx">y</span> <span class="o">:</span> <span class="nx">size</span><span class="p">.</span><span class="nx">y</span> <span class="o">/</span> <span class="p">(</span><span class="mi">5</span> <span class="o">-</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">rows</span><span class="p">)))),</span>
<span class="nx">rows</span><span class="o">=</span> <span class="nx">stitched</span> <span class="o">?</span> <span class="mi">1</span> <span class="o">:</span> <span class="nx">ceil</span><span class="p">(</span><span class="nx">frames</span> <span class="o">/</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">footage</span><span class="p">),</span>
<span class="nx">stage_id</span><span class="o">=</span> <span class="nx">hash</span><span class="p">(</span><span class="nx">id</span><span class="o">+</span><span class="nx">opt</span><span class="p">.</span><span class="nx">suffix</span><span class="p">),</span>
<span class="nx">classes</span><span class="o">=</span> <span class="nx">t</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="nx">className</span> <span class="o">||</span> <span class="nx">__</span><span class="p">,</span>
<span class="nx">$overlay</span><span class="o">=</span> <span class="nx">$</span><span class="p">(</span><span class="nx">tag</span><span class="p">(</span><span class="nx">_div_</span><span class="p">),</span> <span class="p">{</span> <span class="nx">id</span><span class="o">:</span> <span class="nx">stage_id</span><span class="p">.</span><span class="nx">substr</span><span class="p">(</span><span class="mi">1</span><span class="p">),</span> <span class="s1">'class'</span><span class="o">:</span> <span class="nx">classes</span><span class="o">+</span><span class="nx">___</span><span class="o">+</span><span class="nx">overlay_klass</span><span class="o">+</span><span class="nx">___</span><span class="o">+</span><span class="nx">frame_klass</span><span class="o">+</span><span class="s1">'0'</span> <span class="p">}),</span>
<span class="nx">$instance</span><span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">wrap</span><span class="p">(</span><span class="nx">$overlay</span><span class="p">.</span><span class="nx">addClass</span><span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">klass</span><span class="p">)).</span><span class="nx">attr</span><span class="p">({</span> <span class="s1">'class'</span><span class="o">:</span> <span class="nx">klass</span> <span class="p">}),</span>
<span class="nx">instances_count</span><span class="o">=</span> <span class="nx">instances</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">add_instance</span><span class="p">(</span><span class="nx">$instance</span><span class="p">)[</span><span class="mi">0</span><span class="p">]),</span>
<span class="nx">$overlay</span><span class="o">=</span> <span class="nx">$instance</span><span class="p">.</span><span class="nx">parent</span><span class="p">().</span><span class="nx">bind</span><span class="p">(</span><span class="nx">on</span><span class="p">.</span><span class="nx">instance</span><span class="p">)</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_image_</span><span class="p">,</span> <span class="nx">images</span><span class="p">.</span><span class="nx">length</span> <span class="o">?</span> <span class="nx">__</span> <span class="o">:</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">image</span> <span class="o">||</span> <span class="nx">src</span><span class="p">.</span><span class="nx">replace</span><span class="p">(</span><span class="nx">reel</span><span class="p">.</span><span class="nx">re</span><span class="p">.</span><span class="nx">image</span><span class="p">,</span> <span class="s1">'$1'</span> <span class="o">+</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">suffix</span> <span class="o">+</span> <span class="s1">'.$2'</span><span class="p">));</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_cached_</span><span class="p">,</span> <span class="p">[]);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_spacing_</span><span class="p">,</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">spacing</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_rows_</span><span class="p">,</span> <span class="nx">rows</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_dimensions_</span><span class="p">,</span> <span class="nx">size</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_bit_</span><span class="p">,</span> <span class="mi">1</span> <span class="o">/</span> <span class="p">(</span><span class="nx">frames</span> <span class="o">-</span> <span class="p">(</span><span class="nx">loops</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">stitched</span> <span class="o">?</span> <span class="mi">0</span> <span class="o">:</span> <span class="mi">1</span><span class="p">)));</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_stitched_</span><span class="p">,</span> <span class="nx">stitched</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_stitched_travel_</span><span class="p">,</span> <span class="nx">stitched</span> <span class="o">-</span> <span class="p">(</span><span class="nx">loops</span> <span class="o">?</span> <span class="mi">0</span> <span class="o">:</span> <span class="nx">size</span><span class="p">.</span><span class="nx">x</span><span class="p">));</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_stitched_shift_</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_stage_</span><span class="p">,</span> <span class="nx">stage_id</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_backwards_</span><span class="p">,</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_speed_</span><span class="p">,</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">speed</span><span class="p">)</span> <span class="o"><</span> <span class="mi">0</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_velocity_</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_vertical_</span><span class="p">,</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">vertical</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_preloaded_</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_cwish_</span><span class="p">,</span> <span class="nx">negative_when</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="o">!</span><span class="nx">opt</span><span class="p">.</span><span class="nx">cw</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">stitched</span><span class="p">));</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_clicked_location_</span><span class="p">,</span> <span class="p">{});</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_clicked_</span><span class="p">,</span> <span class="kc">false</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_clicked_on_</span><span class="p">,</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_clicked_tier_</span><span class="p">,</span> <span class="mi">0</span><span class="p">));</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_lo_</span><span class="p">,</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_hi_</span><span class="p">,</span> <span class="mi">0</span><span class="p">));</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_reeling_</span><span class="p">,</span> <span class="kc">false</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_reeled_</span><span class="p">,</span> <span class="kc">false</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_opening_</span><span class="p">,</span> <span class="kc">false</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_brake_</span><span class="p">,</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">brake</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_center_</span><span class="p">,</span> <span class="o">!!</span><span class="nx">opt</span><span class="p">.</span><span class="nx">orbital</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_tempo_</span><span class="p">,</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">tempo</span> <span class="o">/</span> <span class="p">(</span><span class="nx">reel</span><span class="p">.</span><span class="nx">lazy</span><span class="o">?</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">laziness</span> <span class="o">:</span> <span class="mi">1</span><span class="p">));</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_opening_ticks_</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">);</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_annotations_</span><span class="p">,</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">annotations</span> <span class="o">||</span> <span class="nx">$overlay</span><span class="p">.</span><span class="nx">unbind</span><span class="p">(</span><span class="nx">dot</span><span class="p">(</span><span class="nx">_annotations_</span><span class="p">))</span> <span class="o">&&</span> <span class="p">{});</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_backup_</span><span class="p">,</span> <span class="p">{</span>
<span class="nx">src</span><span class="o">:</span> <span class="nx">src</span><span class="p">,</span>
<span class="nx">classes</span><span class="o">:</span> <span class="nx">classes</span><span class="p">,</span>
<span class="nx">style</span><span class="o">:</span> <span class="nx">styles</span> <span class="o">||</span> <span class="nx">__</span><span class="p">,</span>
<span class="nx">data</span><span class="o">:</span> <span class="nx">data</span>
<span class="p">});</span>
<span class="nx">opt</span><span class="p">.</span><span class="nx">steppable</span> <span class="o">||</span> <span class="nx">$overlay</span><span class="p">.</span><span class="nx">unbind</span><span class="p">(</span><span class="s1">'up.steppable'</span><span class="p">);</span>
<span class="nx">opt</span><span class="p">.</span><span class="nx">indicator</span> <span class="o">||</span> <span class="nx">$overlay</span><span class="p">.</span><span class="nx">unbind</span><span class="p">(</span><span class="s1">'.indicator'</span><span class="p">);</span>
<span class="nx">css</span><span class="p">(</span><span class="nx">__</span><span class="p">,</span> <span class="p">{</span> <span class="nx">width</span><span class="o">:</span> <span class="nx">size</span><span class="p">.</span><span class="nx">x</span><span class="p">,</span> <span class="nx">height</span><span class="o">:</span> <span class="nx">size</span><span class="p">.</span><span class="nx">y</span><span class="p">,</span> <span class="nx">overflow</span><span class="o">:</span> <span class="nx">_hidden_</span><span class="p">,</span> <span class="nx">position</span><span class="o">:</span> <span class="s1">'relative'</span> <span class="p">});</span>
<span class="nx">css</span><span class="p">(</span><span class="nx">____</span><span class="o">+</span><span class="nx">___</span><span class="o">+</span><span class="nx">dot</span><span class="p">(</span><span class="nx">klass</span><span class="p">),</span> <span class="p">{</span> <span class="nx">display</span><span class="o">:</span> <span class="nx">_block_</span> <span class="p">});</span>
<span class="nx">pool</span><span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="nx">on</span><span class="p">.</span><span class="nx">pool</span><span class="p">);</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">trigger</span><span class="p">(</span><span class="s1">'setup'</span><span class="p">);</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='Initialization-Events'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Initialization-Events">¶</a> </div> <hr />
<h2>Initialization Events</h2>
<p>Reel is completely event-driven meaning there are many events, which can be called
(triggered). By binding event handler to any of the events you can easily hook on to any
event to inject your custom behavior where and when this event was triggered.
<em>For example to make <code>#image</code> element reel and execute some code right after the newly
created instance is initialized and completely loaded:</em></p>
<pre><code>$("#image")
.reel()
.bind("loaded", function(ev){
// Your code
})
</code></pre> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='section-91'> <td class="docs"> <p>Events bound to all individual instances.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">instance</span><span class="o">:</span> <span class="p">{</span></pre></div> </td> </tr> <tr id='teardown-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#teardown-Event">¶</a> </div> <h3><code>teardown</code> Event</h3>
<p><code>Event</code>, since 1.1</p>
<p>This event does do how it sounds like. It will teardown an instance with all its
belongings leaving no trace.</p>
<ul>
<li>It reconstructs the original <code><img></code> element,</li>
<li>wipes out the data store,</li>
<li>removes instance stylesheet</li>
<li>and unbinds all its events.</li>
</ul> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">teardown</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">){</span>
<span class="kd">var</span>
<span class="nx">backup</span><span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">data</span><span class="p">(</span><span class="nx">_backup_</span><span class="p">)</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">parent</span><span class="p">().</span><span class="nx">unbind</span><span class="p">(</span><span class="nx">on</span><span class="p">.</span><span class="nx">instance</span><span class="p">);</span>
<span class="nx">get</span><span class="p">(</span><span class="nx">_style_</span><span class="p">).</span><span class="nx">remove</span><span class="p">();</span>
<span class="nx">get</span><span class="p">(</span><span class="nx">_area_</span><span class="p">).</span><span class="nx">unbind</span><span class="p">(</span><span class="nx">ns</span><span class="p">).</span><span class="nx">enableTextSelect</span><span class="p">();</span>
<span class="nx">remove_instance</span><span class="p">(</span><span class="nx">t</span><span class="p">.</span><span class="nx">unbind</span><span class="p">(</span><span class="nx">ns</span><span class="p">).</span><span class="nx">removeData</span><span class="p">().</span><span class="nx">siblings</span><span class="p">().</span><span class="nx">unbind</span><span class="p">(</span><span class="nx">ns</span><span class="p">).</span><span class="nx">remove</span><span class="p">().</span><span class="nx">end</span><span class="p">().</span><span class="nx">attr</span><span class="p">({</span>
<span class="s1">'class'</span><span class="o">:</span> <span class="nx">backup</span><span class="p">.</span><span class="nx">classes</span><span class="p">,</span>
<span class="nx">src</span><span class="o">:</span> <span class="nx">backup</span><span class="p">.</span><span class="nx">src</span><span class="p">,</span>
<span class="nx">style</span><span class="o">:</span> <span class="nx">backup</span><span class="p">.</span><span class="nx">style</span>
<span class="p">}).</span><span class="nx">data</span><span class="p">(</span><span class="nx">backup</span><span class="p">.</span><span class="nx">data</span><span class="p">).</span><span class="nx">unwrap</span><span class="p">());</span>
<span class="nx">no_bias</span><span class="p">();</span>
<span class="nx">pool</span><span class="p">.</span><span class="nx">unbind</span><span class="p">(</span><span class="nx">on</span><span class="p">.</span><span class="nx">pool</span><span class="p">);</span>
<span class="nx">pools</span><span class="p">.</span><span class="nx">unbind</span><span class="p">(</span><span class="nx">pns</span><span class="p">);</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='setup-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#setup-Event">¶</a> </div> <h3><code>setup</code> Event</h3>
<p><code>Event</code>, since 1.0</p>
<p><code>"setup</code> Event continues with what has been started by the private <code>on.setup()</code>
handler.</p>
<ul>
<li>It prepares all additional on-stage DOM elements,</li>
<li>and cursors for the instance stylesheet.</li>
</ul> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">setup</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">){</span>
<span class="kd">var</span>
<span class="nx">space</span><span class="o">=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_dimensions_</span><span class="p">),</span>
<span class="nx">frames</span><span class="o">=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_frames_</span><span class="p">),</span>
<span class="nx">id</span><span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">attr</span><span class="p">(</span><span class="nx">_id_</span><span class="p">),</span>
<span class="nx">$overlay</span><span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">parent</span><span class="p">()</span>
<span class="nx">area</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_area_</span><span class="p">,</span> <span class="nx">$</span><span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">area</span> <span class="o">||</span> <span class="nx">$overlay</span> <span class="p">))</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">touchy</span><span class="p">){</span></pre></div> </td> </tr> <tr id='section-94'> <td class="docs"> <p>workaround for downsizing-sprites-bug-in-iPhoneOS inspired by Katrin Ackermann</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">css</span><span class="p">(</span><span class="nx">___</span><span class="o">+</span><span class="nx">dot</span><span class="p">(</span><span class="nx">klass</span><span class="p">),</span> <span class="p">{</span> <span class="nx">WebkitUserSelect</span><span class="o">:</span> <span class="nx">_none_</span><span class="p">,</span> <span class="nx">WebkitBackgroundSize</span><span class="o">:</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_images_</span><span class="p">).</span><span class="nx">length</span>
<span class="o">?</span> <span class="kc">undefined</span> <span class="o">:</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_stitched_</span><span class="p">)</span> <span class="o">&&</span> <span class="nx">px</span><span class="p">(</span><span class="nx">get</span><span class="p">(</span><span class="nx">_stitched_</span><span class="p">))</span><span class="o">+</span><span class="nx">___</span><span class="o">+</span><span class="nx">px</span><span class="p">(</span><span class="nx">space</span><span class="p">.</span><span class="nx">y</span><span class="p">)</span>
<span class="o">||</span> <span class="nx">px</span><span class="p">(</span><span class="nx">space</span><span class="p">.</span><span class="nx">x</span> <span class="o">*</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">footage</span><span class="p">)</span><span class="o">+</span><span class="nx">___</span><span class="o">+</span><span class="nx">px</span><span class="p">(</span><span class="nx">space</span><span class="p">.</span><span class="nx">y</span> <span class="o">*</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_rows_</span><span class="p">)</span> <span class="o">*</span> <span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">rows</span> <span class="o">||</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">directional</span><span class="o">?</span> <span class="mi">2</span><span class="o">:</span><span class="mi">1</span><span class="p">))</span>
<span class="p">});</span>
<span class="nx">area</span>
<span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="nx">_touchstart_</span><span class="p">,</span> <span class="nx">press</span><span class="p">())</span>
<span class="p">}</span><span class="k">else</span><span class="p">{</span>
<span class="kd">var</span>
<span class="nx">cursor</span><span class="o">=</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">cursor</span> <span class="o">==</span> <span class="nx">_hand_</span> <span class="o">?</span> <span class="nx">drag_cursor</span> <span class="o">:</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">cursor</span> <span class="o">||</span> <span class="nx">reel_cursor</span><span class="p">,</span>
<span class="nx">cursor_down</span><span class="o">=</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">cursor</span> <span class="o">==</span> <span class="nx">_hand_</span> <span class="o">?</span> <span class="nx">drag_cursor_down</span><span class="o">+</span><span class="nx">___</span><span class="o">+</span><span class="s1">'!important'</span> <span class="o">:</span> <span class="kc">undefined</span>
<span class="nx">css</span><span class="p">(</span><span class="nx">__</span><span class="p">,</span> <span class="p">{</span> <span class="nx">cursor</span><span class="o">:</span> <span class="nx">cdn</span><span class="p">(</span><span class="nx">cursor</span><span class="p">)</span> <span class="p">});</span>
<span class="nx">css</span><span class="p">(</span><span class="nx">dot</span><span class="p">(</span><span class="nx">loading_klass</span><span class="p">),</span> <span class="p">{</span> <span class="nx">cursor</span><span class="o">:</span> <span class="s1">'wait'</span> <span class="p">});</span>
<span class="nx">css</span><span class="p">(</span><span class="nx">dot</span><span class="p">(</span><span class="nx">panning_klass</span><span class="p">)</span><span class="o">+</span><span class="nx">____</span><span class="o">+</span><span class="nx">dot</span><span class="p">(</span><span class="nx">panning_klass</span><span class="p">)</span><span class="o">+</span><span class="s1">' *'</span><span class="p">,</span> <span class="p">{</span> <span class="nx">cursor</span><span class="o">:</span> <span class="nx">cdn</span><span class="p">(</span><span class="nx">cursor_down</span> <span class="o">||</span> <span class="nx">cursor</span><span class="p">)</span> <span class="p">},</span> <span class="kc">true</span><span class="p">);</span>
<span class="nx">area</span>
<span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">wheelable</span> <span class="o">?</span> <span class="nx">_mousewheel_</span> <span class="o">:</span> <span class="nx">__</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">,</span> <span class="nx">delta</span><span class="p">){</span> <span class="k">return</span> <span class="nx">e</span><span class="p">.</span><span class="nx">preventDefault</span><span class="p">()</span> <span class="o">||</span> <span class="o">!</span><span class="nx">delta</span> <span class="o">||</span> <span class="nx">t</span><span class="p">.</span><span class="nx">trigger</span><span class="p">(</span><span class="s1">'wheel'</span><span class="p">,</span> <span class="p">[</span><span class="nx">delta</span><span class="p">])</span> <span class="o">&&</span> <span class="kc">false</span> <span class="p">})</span>
<span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">clickfree</span> <span class="o">?</span> <span class="nx">_mouseenter_</span> <span class="o">:</span> <span class="nx">_mousedown_</span><span class="p">,</span> <span class="nx">press</span><span class="p">())</span>
<span class="p">.</span><span class="nx">disableTextSelect</span><span class="p">();</span>
<span class="p">}</span>
<span class="kd">function</span> <span class="nx">press</span><span class="p">(</span><span class="nx">r</span><span class="p">){</span> <span class="k">return</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">){</span> <span class="k">if</span> <span class="p">(</span><span class="nx">e</span><span class="p">.</span><span class="nx">button</span> <span class="o">==</span> <span class="nx">DRAG_BUTTON</span><span class="p">)</span> <span class="k">return</span> <span class="nx">e</span><span class="p">.</span><span class="nx">preventDefault</span><span class="p">()</span> <span class="o">||</span> <span class="nx">t</span><span class="p">.</span><span class="nx">trigger</span><span class="p">(</span><span class="s1">'down'</span><span class="p">,</span> <span class="p">[</span><span class="nx">finger</span><span class="p">(</span><span class="nx">e</span><span class="p">).</span><span class="nx">clientX</span><span class="p">,</span> <span class="nx">finger</span><span class="p">(</span><span class="nx">e</span><span class="p">).</span><span class="nx">clientY</span><span class="p">])</span> <span class="o">&&</span> <span class="nx">r</span> <span class="p">}}</span>
<span class="nx">opt</span><span class="p">.</span><span class="nx">hint</span> <span class="o">&&</span> <span class="nx">area</span><span class="p">.</span><span class="nx">attr</span><span class="p">(</span><span class="s1">'title'</span><span class="p">,</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">hint</span><span class="p">);</span>
<span class="nx">opt</span><span class="p">.</span><span class="nx">indicator</span> <span class="o">&&</span> <span class="nx">$overlay</span><span class="p">.</span><span class="nx">append</span><span class="p">(</span><span class="nx">indicator</span><span class="p">(</span><span class="s1">'x'</span><span class="p">));</span>
<span class="nx">opt</span><span class="p">.</span><span class="nx">rows</span> <span class="o">></span> <span class="mi">1</span> <span class="o">&&</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">indicator</span> <span class="o">&&</span> <span class="nx">$overlay</span><span class="p">.</span><span class="nx">append</span><span class="p">(</span><span class="nx">indicator</span><span class="p">(</span><span class="s1">'y'</span><span class="p">));</span>
<span class="nx">opt</span><span class="p">.</span><span class="nx">monitor</span> <span class="o">&&</span> <span class="nx">$overlay</span><span class="p">.</span><span class="nx">append</span><span class="p">(</span><span class="nx">$monitor</span><span class="o">=</span> <span class="nx">$</span><span class="p">(</span><span class="nx">tag</span><span class="p">(</span><span class="nx">_div_</span><span class="p">),</span> <span class="p">{</span> <span class="s1">'class'</span><span class="o">:</span> <span class="nx">monitor_klass</span> <span class="p">}))</span>
<span class="o">&&</span> <span class="nx">css</span><span class="p">(</span><span class="nx">___</span><span class="o">+</span><span class="nx">dot</span><span class="p">(</span><span class="nx">monitor_klass</span><span class="p">),</span> <span class="p">{</span> <span class="nx">position</span><span class="o">:</span> <span class="nx">_absolute_</span><span class="p">,</span> <span class="nx">left</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span> <span class="nx">top</span><span class="o">:</span> <span class="mi">0</span> <span class="p">});</span>
<span class="nx">css</span><span class="p">(</span><span class="nx">___</span><span class="o">+</span><span class="nx">dot</span><span class="p">(</span><span class="nx">cached_klass</span><span class="p">),</span> <span class="p">{</span> <span class="nx">display</span><span class="o">:</span> <span class="nx">_none_</span> <span class="p">});</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='preload-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#preload-Event">¶</a> </div> <h3><code>preload</code> Event</h3>
<p><code>Event</code>, since 1.1</p>
<p>Reel keeps a cache of all images it needs for its operation. Either a sprite or all
sequence images. Physically, this cache is made up of a hidden <code><img></code> sibling for each
preloaded image. It first determines the order of requesting the images and then
asynchronously loads all of them.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">preload</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">){</span>
<span class="cm">/*</span>
<span class="cm"> - preloads all frames and sprites</span>
<span class="cm"> */</span>
<span class="kd">var</span>
<span class="nx">space</span><span class="o">=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_dimensions_</span><span class="p">),</span>
<span class="nx">$overlay</span><span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">parent</span><span class="p">(),</span>
<span class="nx">images</span><span class="o">=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_images_</span><span class="p">),</span>
<span class="nx">is_sprite</span><span class="o">=</span> <span class="o">!</span><span class="nx">images</span><span class="p">.</span><span class="nx">length</span><span class="p">,</span>
<span class="nx">frames</span><span class="o">=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_frames_</span><span class="p">),</span>
<span class="nx">order</span><span class="o">=</span> <span class="nx">reel</span><span class="p">.</span><span class="nx">preload</span><span class="p">[</span><span class="nx">opt</span><span class="p">.</span><span class="nx">preload</span><span class="p">]</span> <span class="o">||</span> <span class="nx">reel</span><span class="p">.</span><span class="nx">preload</span><span class="p">[</span><span class="nx">reel</span><span class="p">.</span><span class="nx">def</span><span class="p">.</span><span class="nx">preload</span><span class="p">],</span>
<span class="nx">preload</span><span class="o">=</span> <span class="nx">is_sprite</span> <span class="o">?</span> <span class="p">[</span><span class="nx">get</span><span class="p">(</span><span class="nx">_image_</span><span class="p">)]</span> <span class="o">:</span> <span class="nx">order</span><span class="p">(</span><span class="nx">images</span><span class="p">.</span><span class="nx">slice</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span> <span class="nx">opt</span><span class="p">,</span> <span class="nx">get</span><span class="p">),</span>
<span class="nx">to_load</span><span class="o">=</span> <span class="nx">preload</span><span class="p">.</span><span class="nx">length</span><span class="p">,</span>
<span class="nx">preloaded</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_preloaded_</span><span class="p">,</span> <span class="nx">is_sprite</span> <span class="o">?</span> <span class="mf">0.5</span> <span class="o">:</span> <span class="mi">0</span><span class="p">),</span>
<span class="nx">uris</span><span class="o">=</span> <span class="p">[]</span>
<span class="nx">$overlay</span><span class="p">.</span><span class="nx">addClass</span><span class="p">(</span><span class="nx">loading_klass</span><span class="p">).</span><span class="nx">append</span><span class="p">(</span><span class="nx">preloader</span><span class="p">());</span></pre></div> </td> </tr> <tr id='section-96'> <td class="docs"> <p>It also finalizes the instance stylesheet and prepends it to the head.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">set</span><span class="p">(</span><span class="nx">_style_</span><span class="p">,</span> <span class="nx">$</span><span class="p">(</span><span class="s1">'<'</span><span class="o">+</span><span class="nx">_style_</span><span class="o">+</span><span class="s1">' type="text/css">'</span><span class="o">+</span><span class="nx">css</span><span class="p">.</span><span class="nx">rules</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s1">'\n'</span><span class="p">)</span><span class="o">+</span><span class="s1">'</'</span><span class="o">+</span><span class="nx">_style_</span><span class="o">+</span><span class="s1">'>'</span><span class="p">).</span><span class="nx">prependTo</span><span class="p">(</span><span class="nx">_head_</span><span class="p">));</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">trigger</span><span class="p">(</span><span class="s1">'stop'</span><span class="p">);</span>
<span class="k">while</span><span class="p">(</span><span class="nx">preload</span><span class="p">.</span><span class="nx">length</span><span class="p">){</span>
<span class="kd">var</span>
<span class="nx">uri</span><span class="o">=</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">path</span><span class="o">+</span><span class="nx">preload</span><span class="p">.</span><span class="nx">shift</span><span class="p">(),</span>
<span class="nx">width</span><span class="o">=</span> <span class="nx">space</span><span class="p">.</span><span class="nx">x</span> <span class="o">*</span> <span class="p">(</span><span class="o">!</span><span class="nx">is_sprite</span> <span class="o">?</span> <span class="mi">1</span> <span class="o">:</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">footage</span><span class="p">),</span>
<span class="nx">height</span><span class="o">=</span> <span class="nx">space</span><span class="p">.</span><span class="nx">y</span> <span class="o">*</span> <span class="p">(</span><span class="o">!</span><span class="nx">is_sprite</span> <span class="o">?</span> <span class="mi">1</span> <span class="o">:</span> <span class="nx">frames</span> <span class="o">/</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">footage</span><span class="p">)</span> <span class="o">*</span> <span class="p">(</span><span class="o">!</span><span class="nx">opt</span><span class="p">.</span><span class="nx">directional</span> <span class="o">?</span> <span class="mi">1</span> <span class="o">:</span> <span class="mi">2</span><span class="p">),</span>
<span class="nx">$img</span><span class="o">=</span> <span class="nx">$</span><span class="p">(</span><span class="nx">tag</span><span class="p">(</span><span class="nx">_img_</span><span class="p">)).</span><span class="nx">attr</span><span class="p">({</span> <span class="s1">'class'</span><span class="o">:</span> <span class="nx">cached_klass</span><span class="p">,</span> <span class="nx">width</span><span class="o">:</span> <span class="nx">width</span><span class="p">,</span> <span class="nx">height</span><span class="o">:</span> <span class="nx">height</span> <span class="p">}).</span><span class="nx">appendTo</span><span class="p">(</span><span class="nx">$overlay</span><span class="p">)</span></pre></div> </td> </tr> <tr id='section-97'> <td class="docs"> <p>Each image, which finishes the load triggers <code>"preloaded</code> Event.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">$img</span><span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="s1">'load error abort'</span><span class="p">,</span> <span class="kd">function</span><span class="p">(){</span>
<span class="k">return</span> <span class="o">!!</span><span class="nx">$</span><span class="p">(</span><span class="k">this</span><span class="p">).</span><span class="nx">parent</span><span class="p">().</span><span class="nx">length</span> <span class="o">&&</span> <span class="nx">t</span><span class="p">.</span><span class="nx">trigger</span><span class="p">(</span><span class="s1">'preloaded'</span><span class="p">)</span> <span class="o">&&</span> <span class="kc">false</span><span class="p">;</span>
<span class="p">});</span>
<span class="nx">load</span><span class="p">(</span><span class="nx">uri</span><span class="p">,</span> <span class="nx">$img</span><span class="p">);</span>
<span class="nx">uris</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">uri</span><span class="p">);</span>
<span class="p">}</span>
<span class="nx">set</span><span class="p">(</span><span class="nx">_cached_</span><span class="p">,</span> <span class="nx">uris</span><span class="p">);</span>
<span class="kd">function</span> <span class="nx">load</span><span class="p">(</span><span class="nx">uri</span><span class="p">,</span> <span class="nx">$img</span><span class="p">){</span> <span class="nx">setTimeout</span><span class="p">(</span><span class="kd">function</span><span class="p">(){</span>
<span class="nx">$img</span><span class="p">.</span><span class="nx">parent</span><span class="p">().</span><span class="nx">length</span> <span class="o">&&</span> <span class="nx">$img</span><span class="p">.</span><span class="nx">attr</span><span class="p">({</span> <span class="nx">src</span><span class="o">:</span> <span class="nx">reen</span><span class="p">(</span><span class="nx">uri</span><span class="p">)</span> <span class="p">});</span>
<span class="p">},</span> <span class="p">(</span><span class="nx">to_load</span> <span class="o">-</span> <span class="nx">preload</span><span class="p">.</span><span class="nx">length</span><span class="p">)</span> <span class="o">*</span> <span class="mi">2</span><span class="p">)</span> <span class="p">}</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='preloaded-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#preloaded-Event">¶</a> </div> <h3><code>preloaded</code> Event</h3>
<p><code>Event</code>, since 1.1</p>
<p>This event is fired by every preloaded image and adjusts the preloader indicator's
target position. Once all images are preloaded, <code>"loaded</code> Event is triggered.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">preloaded</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">){</span>
<span class="kd">var</span>
<span class="nx">images</span><span class="o">=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_images_</span><span class="p">).</span><span class="nx">length</span> <span class="o">||</span> <span class="mi">1</span><span class="p">,</span>
<span class="nx">preloaded</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_preloaded_</span><span class="p">,</span> <span class="nx">min</span><span class="p">(</span><span class="nx">get</span><span class="p">(</span><span class="nx">_preloaded_</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span><span class="p">,</span> <span class="nx">images</span><span class="p">))</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">preloaded</span> <span class="o">===</span> <span class="nx">images</span><span class="p">){</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">parent</span><span class="p">().</span><span class="nx">removeClass</span><span class="p">(</span><span class="nx">loading_klass</span><span class="p">).</span><span class="nx">unbind</span><span class="p">(</span><span class="nx">_preloaded_</span><span class="p">,</span> <span class="nx">on</span><span class="p">.</span><span class="nx">instance</span><span class="p">.</span><span class="nx">preloaded</span><span class="p">);</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">trigger</span><span class="p">(</span><span class="s1">'loaded'</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">preloaded</span> <span class="o">===</span> <span class="mi">1</span><span class="p">)</span> <span class="kd">var</span>
<span class="nx">frame</span><span class="o">=</span> <span class="nx">t</span><span class="p">.</span><span class="nx">trigger</span><span class="p">(</span><span class="s1">'frameChange'</span><span class="p">,</span> <span class="p">[</span><span class="kc">undefined</span><span class="p">,</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_frame_</span><span class="p">)])</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='loaded-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#loaded-Event">¶</a> </div> <h3><code>loaded</code> Event</h3>
<p><code>Event</code>, since 1.1</p>
<p><code>"loaded</code> Event is the one announcing when the instance is "locked and loaded".
At this time, all is prepared, preloaded and configured for user interaction
or animation.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">loaded</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">){</span>
<span class="nx">get</span><span class="p">(</span><span class="nx">_images_</span><span class="p">).</span><span class="nx">length</span> <span class="o">></span> <span class="mi">1</span> <span class="o">||</span> <span class="nx">t</span><span class="p">.</span><span class="nx">css</span><span class="p">({</span> <span class="nx">backgroundImage</span><span class="o">:</span> <span class="nx">url</span><span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">path</span><span class="o">+</span><span class="nx">get</span><span class="p">(</span><span class="nx">_image_</span><span class="p">))</span> <span class="p">}).</span><span class="nx">attr</span><span class="p">({</span> <span class="nx">src</span><span class="o">:</span> <span class="nx">cdn</span><span class="p">(</span><span class="nx">transparent</span><span class="p">)</span> <span class="p">});</span>
<span class="nx">get</span><span class="p">(</span><span class="nx">_reeled_</span><span class="p">)</span> <span class="o">||</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_velocity_</span><span class="p">,</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">velocity</span> <span class="o">||</span> <span class="mi">0</span><span class="p">);</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='Animation-Events'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Animation-Events">¶</a> </div> <hr />
<h2>Animation Events</h2> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='opening-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#opening-Event">¶</a> </div> <h3><code>opening</code> Event</h3>
<p><code>Event</code>, since 1.1</p>
<p>When <a href="#Opening-Animation">opening animation</a> is configured for the instance, <code>"opening"</code>
event engages the animation by pre-calculating some of its properties, which will make
the tick handler</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">opening</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">){</span>
<span class="cm">/*</span>
<span class="cm"> - initiates opening animation</span>
<span class="cm"> - or simply plays the reel when without opening</span>
<span class="cm"> */</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">opt</span><span class="p">.</span><span class="nx">opening</span><span class="p">)</span> <span class="k">return</span> <span class="nx">t</span><span class="p">.</span><span class="nx">trigger</span><span class="p">(</span><span class="s1">'openingDone'</span><span class="p">);</span>
<span class="kd">var</span>
<span class="nx">opening</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_opening_</span><span class="p">,</span> <span class="kc">true</span><span class="p">),</span>
<span class="nx">stopped</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_stopped_</span><span class="p">,</span> <span class="o">!</span><span class="nx">get</span><span class="p">(</span><span class="nx">_speed_</span><span class="p">)),</span>
<span class="nx">speed</span><span class="o">=</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">entry</span> <span class="o">||</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">speed</span><span class="p">,</span>
<span class="nx">end</span><span class="o">=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_fraction_</span><span class="p">),</span>
<span class="nx">duration</span><span class="o">=</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">opening</span><span class="p">,</span>
<span class="nx">start</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_fraction_</span><span class="p">,</span> <span class="nx">end</span> <span class="o">-</span> <span class="nx">speed</span> <span class="o">*</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">opening</span><span class="p">),</span>
<span class="nx">ticks</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_opening_ticks_</span><span class="p">,</span> <span class="nx">ceil</span><span class="p">(</span><span class="nx">duration</span> <span class="o">*</span> <span class="nx">leader</span><span class="p">(</span><span class="nx">_tempo_</span><span class="p">)))</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='openingDone-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#openingDone-Event">¶</a> </div> <h3><code>openingDone</code> Event</h3>
<p><code>Event</code>, since 1.1</p>
<p><code>"openingDone"</code> is fired onceWhen <a href="#Opening-Animation">opening animation</a> is configured for the instance, <code>"opening"</code>
event engages the animation by pre-calculating some of its properties, which will make
the tick handler</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">openingDone</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">){</span>
<span class="kd">var</span>
<span class="nx">playing</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_playing_</span><span class="p">,</span> <span class="kc">false</span><span class="p">),</span>
<span class="nx">opening</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_opening_</span><span class="p">,</span> <span class="kc">false</span><span class="p">),</span>
<span class="nx">evnt</span><span class="o">=</span> <span class="nx">_tick_</span><span class="o">+</span><span class="nx">dot</span><span class="p">(</span><span class="nx">_opening_</span><span class="p">)</span>
<span class="nx">pool</span><span class="p">.</span><span class="nx">unbind</span><span class="p">(</span><span class="nx">evnt</span><span class="p">,</span> <span class="nx">on</span><span class="p">.</span><span class="nx">pool</span><span class="p">[</span><span class="nx">evnt</span><span class="p">]);</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">delay</span> <span class="o">></span> <span class="mi">0</span><span class="p">)</span> <span class="nx">delay</span><span class="o">=</span> <span class="nx">setTimeout</span><span class="p">(</span><span class="kd">function</span><span class="p">(){</span> <span class="nx">t</span><span class="p">.</span><span class="nx">trigger</span><span class="p">(</span><span class="s1">'play'</span><span class="p">)</span> <span class="p">},</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">delay</span> <span class="o">*</span> <span class="mi">1000</span><span class="p">)</span>
<span class="k">else</span> <span class="nx">t</span><span class="p">.</span><span class="nx">trigger</span><span class="p">(</span><span class="s1">'play'</span><span class="p">);</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='Playback-Control-Events'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Playback-Control-Events">¶</a> </div> <hr />
<h2>Playback Control Events</h2> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='play-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#play-Event">¶</a> </div> <h3><code>play</code> Event</h3>
<p><code>Event</code>, since 1.1</p>
<p><code>"play</code> Event can optionally accept a <code>speed</code> parameter (in Hz) to change the animation
speed on the fly.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">play</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">,</span> <span class="nx">speed</span><span class="p">){</span>
<span class="kd">var</span>
<span class="nx">speed</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_speed_</span><span class="p">,</span> <span class="nx">speed</span> <span class="o">||</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_speed_</span><span class="p">)),</span>
<span class="nx">backwards</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_backwards_</span><span class="p">,</span> <span class="nx">speed</span> <span class="o"><</span> <span class="mi">0</span><span class="p">),</span>
<span class="nx">playing</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_playing_</span><span class="p">,</span> <span class="o">!!</span><span class="nx">speed</span><span class="p">),</span>
<span class="nx">stopped</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_stopped_</span><span class="p">,</span> <span class="o">!</span><span class="nx">playing</span><span class="p">)</span>
<span class="nx">idle</span><span class="p">();</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='pause-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#pause-Event">¶</a> </div> <h3><code>pause</code> Event</h3>
<p><code>Event</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">pause</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">){</span>
<span class="kd">var</span>
<span class="nx">playing</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_playing_</span><span class="p">,</span> <span class="kc">false</span><span class="p">)</span>
<span class="nx">unidle</span><span class="p">();</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='stop-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#stop-Event">¶</a> </div> <h3><code>stop</code> Event</h3>
<p><code>Event</code>, since 1.1</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">stop</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">){</span>
<span class="kd">var</span>
<span class="nx">stopped</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_stopped_</span><span class="p">,</span> <span class="kc">true</span><span class="p">),</span>
<span class="nx">playing</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_playing_</span><span class="p">,</span> <span class="o">!</span><span class="nx">stopped</span><span class="p">)</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='Human-Interaction-Events'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Human-Interaction-Events">¶</a> </div> <hr />
<h2>Human Interaction Events</h2> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='down-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#down-Event">¶</a> </div> <h3><code>down</code> Event</h3>
<p><code>Event</code>, since 1.1</p>
<p>Marks the very beginning of touch or mouse interaction. It receives <code>x</code> and <code>y</code>
coordinates in arguments. It:</p>
<ul>
<li>calibrates the center point (origin),</li>
<li>considers user active not idle,</li>
<li>flags the <code><html></code> tag with <code>.reel-panning</code> class name,</li>
<li>and binds dragging events for move and lift. These
are usually bound to the pool (document itself) to get a consistent treating regardless
the event target element. However in click-free mode, it binds directly to the instance.</li>
</ul> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">down</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">,</span> <span class="nx">x</span><span class="p">,</span> <span class="nx">y</span><span class="p">){</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">draggable</span><span class="p">){</span>
<span class="kd">var</span>
<span class="nx">clicked</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_clicked_</span><span class="p">,</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_frame_</span><span class="p">)),</span>
<span class="nx">velocity</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_velocity_</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
<span class="nx">scrollable</span><span class="o">=</span> <span class="o">!</span><span class="nx">get</span><span class="p">(</span><span class="nx">_reeling_</span><span class="p">)</span> <span class="o">||</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">rows</span> <span class="o"><=</span> <span class="mi">1</span> <span class="o">||</span> <span class="o">!</span><span class="nx">opt</span><span class="p">.</span><span class="nx">orbital</span> <span class="o">||</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">scrollable</span><span class="p">,</span>
<span class="nx">origin</span><span class="o">=</span> <span class="nx">last</span><span class="o">=</span> <span class="nx">recenter_mouse</span><span class="p">(</span><span class="nx">get</span><span class="p">(</span><span class="nx">_revolution_</span><span class="p">),</span> <span class="nx">x</span><span class="p">,</span> <span class="nx">y</span><span class="p">)</span>
<span class="nx">unidle</span><span class="p">();</span>
<span class="nx">no_bias</span><span class="p">();</span>
<span class="nx">panned</span><span class="o">=</span> <span class="kc">false</span><span class="p">;</span>
<span class="nx">$</span><span class="p">(</span><span class="nx">_html_</span><span class="p">,</span> <span class="nx">pools</span><span class="p">).</span><span class="nx">addClass</span><span class="p">(</span><span class="nx">panning_klass</span><span class="p">);</span></pre></div> </td> </tr> <tr id='section-109'> <td class="docs"> <p>Browser events differ for touch and mouse, but both of them are treated equally and
forwarded to the same <code>"pan"</code> or <code>"up</code> Events.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="k">if</span> <span class="p">(</span><span class="nx">touchy</span><span class="p">){</span>
<span class="nx">pools</span>
<span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="nx">_touchmove_</span><span class="p">,</span> <span class="nx">drag</span><span class="p">(</span><span class="o">!</span><span class="nx">scrollable</span><span class="p">))</span>
<span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="nx">_touchend_</span><span class="o">+</span><span class="nx">___</span><span class="o">+</span><span class="nx">_touchcancel_</span><span class="p">,</span> <span class="nx">lift</span><span class="p">())</span>
<span class="p">}</span><span class="k">else</span><span class="p">{</span>
<span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">clickfree</span> <span class="o">?</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_area_</span><span class="p">)</span> <span class="o">:</span> <span class="nx">pools</span><span class="p">)</span>
<span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="nx">_mousemove_</span><span class="p">,</span> <span class="nx">drag</span><span class="p">())</span>
<span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">clickfree</span> <span class="o">?</span> <span class="nx">_mouseleave_</span> <span class="o">:</span> <span class="nx">_mouseup_</span><span class="p">,</span> <span class="nx">lift</span><span class="p">())</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="kd">function</span> <span class="nx">drag</span><span class="p">(</span><span class="nx">r</span><span class="p">){</span> <span class="k">return</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">){</span> <span class="nx">e</span><span class="p">.</span><span class="nx">preventDefault</span><span class="p">();</span> <span class="nx">t</span><span class="p">.</span><span class="nx">trigger</span><span class="p">(</span><span class="s1">'pan'</span><span class="p">,</span> <span class="p">[</span><span class="nx">finger</span><span class="p">(</span><span class="nx">e</span><span class="p">).</span><span class="nx">clientX</span><span class="p">,</span> <span class="nx">finger</span><span class="p">(</span><span class="nx">e</span><span class="p">).</span><span class="nx">clientY</span><span class="p">,</span> <span class="nx">e</span><span class="p">]);</span> <span class="k">return</span> <span class="nx">r</span> <span class="p">}}</span>
<span class="kd">function</span> <span class="nx">lift</span><span class="p">(</span><span class="nx">r</span><span class="p">){</span> <span class="k">return</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">){</span> <span class="nx">e</span><span class="p">.</span><span class="nx">preventDefault</span><span class="p">();</span> <span class="nx">t</span><span class="p">.</span><span class="nx">trigger</span><span class="p">(</span><span class="s1">'up'</span><span class="p">,</span> <span class="p">[</span><span class="nx">e</span><span class="p">]);</span> <span class="k">return</span> <span class="nx">r</span> <span class="p">}}</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='up-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#up-Event">¶</a> </div> <h3><code>up</code> Event</h3>
<p><code>Event</code>, since 1.1</p>
<p>This marks the termination of user's interaction. She either released the mouse button
or lift the finger of the touch screen. This event handler:</p>
<ul>
<li>calculates the velocity of the drag at that very moment,</li>
<li>removes the <code>.reel-panning</code> class from <code><body></code>,</li>
<li>and unbinds dragging events from the pool.</li>
</ul> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">up</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">,</span> <span class="nx">ev</span><span class="p">){</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">opt</span><span class="p">.</span><span class="nx">draggable</span><span class="p">)</span> <span class="k">return</span><span class="p">;</span>
<span class="kd">var</span>
<span class="nx">clicked</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_clicked_</span><span class="p">,</span> <span class="kc">false</span><span class="p">),</span>
<span class="nx">reeling</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_reeling_</span><span class="p">,</span> <span class="kc">false</span><span class="p">),</span>
<span class="nx">velocity</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_velocity_</span><span class="p">,</span> <span class="o">!</span><span class="nx">opt</span><span class="p">.</span><span class="nx">throwable</span> <span class="o">?</span> <span class="mi">0</span> <span class="o">:</span> <span class="nx">abs</span><span class="p">(</span><span class="nx">bias</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="nx">bias</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="o">/</span> <span class="mi">60</span><span class="p">),</span>
<span class="nx">brakes</span><span class="o">=</span> <span class="nx">braking</span><span class="o">=</span> <span class="nx">velocity</span> <span class="o">?</span> <span class="mi">1</span> <span class="o">:</span> <span class="mi">0</span>
<span class="nx">unidle</span><span class="p">();</span>
<span class="nx">no_bias</span><span class="p">();</span>
<span class="nx">$</span><span class="p">(</span><span class="nx">_html_</span><span class="p">,</span> <span class="nx">pools</span><span class="p">).</span><span class="nx">removeClass</span><span class="p">(</span><span class="nx">panning_klass</span><span class="p">);</span>
<span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">clickfree</span> <span class="o">?</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_area_</span><span class="p">)</span> <span class="o">:</span> <span class="nx">pools</span><span class="p">).</span><span class="nx">unbind</span><span class="p">(</span><span class="nx">pns</span><span class="p">);</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='pan-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#pan-Event">¶</a> </div> <h3><code>pan</code> Event</h3>
<p>[RENAMED] <code>Event</code>, since 1.2</p>
<p>Regardles the actual source of movement (mouse or touch), this event is always triggered
in response and similar to the <code>"down</code> Event it receives <code>x</code> and <code>y</code> coordinates
in arguments and in addition it is passed a reference to the original browser event.
This handler:</p>
<ul>
<li>syncs with timer to achieve good performance,</li>
<li>calculates the distance from drag center and applies graph on it to get <code>fraction</code>,</li>
<li>recenters the drag when dragged over limits,</li>
<li>detects the direction of the motion,</li>
<li>and builds up inertial motion bias.</li>
</ul>
<p>Historically <code>pan</code> was once called <code>slide</code> (conflicted with Mootools - <a href="https://github.com/pisi/Reel/issues/51">GH-51</a>)
or <code>drag</code> (that conflicted with MSIE).</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">pan</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">,</span> <span class="nx">x</span><span class="p">,</span> <span class="nx">y</span><span class="p">,</span> <span class="nx">ev</span><span class="p">){</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">draggable</span> <span class="o">&&</span> <span class="nx">slidable</span><span class="p">){</span>
<span class="nx">slidable</span><span class="o">=</span> <span class="kc">false</span><span class="p">;</span>
<span class="nx">unidle</span><span class="p">();</span>
<span class="kd">var</span>
<span class="nx">host_offset</span><span class="o">=</span> <span class="nx">ev</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">$</span><span class="p">(</span><span class="nx">ev</span><span class="p">.</span><span class="nx">currentTarget</span><span class="p">).</span><span class="nx">is</span><span class="p">(</span><span class="nx">pool</span><span class="p">)</span> <span class="o">&&</span> <span class="nx">$iframe</span><span class="p">.</span><span class="nx">offset</span><span class="p">()</span> <span class="o">||</span> <span class="p">{</span> <span class="nx">left</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span> <span class="nx">top</span><span class="o">:</span> <span class="mi">0</span> <span class="p">},</span>
<span class="nx">x</span><span class="o">=</span> <span class="nx">x</span> <span class="o">-</span> <span class="nx">host_offset</span><span class="p">.</span><span class="nx">left</span><span class="p">,</span>
<span class="nx">y</span><span class="o">=</span> <span class="nx">y</span> <span class="o">-</span> <span class="nx">host_offset</span><span class="p">.</span><span class="nx">top</span><span class="p">,</span>
<span class="nx">delta</span><span class="o">=</span> <span class="p">{</span> <span class="nx">x</span><span class="o">:</span> <span class="nx">x</span> <span class="o">-</span> <span class="nx">last</span><span class="p">.</span><span class="nx">x</span><span class="p">,</span> <span class="nx">y</span><span class="o">:</span> <span class="nx">y</span> <span class="o">-</span> <span class="nx">last</span><span class="p">.</span><span class="nx">y</span> <span class="p">}</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">abs</span><span class="p">(</span><span class="nx">delta</span><span class="p">.</span><span class="nx">x</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span> <span class="o">||</span> <span class="nx">abs</span><span class="p">(</span><span class="nx">delta</span><span class="p">.</span><span class="nx">y</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">){</span>
<span class="nx">panned</span><span class="o">=</span> <span class="kc">true</span><span class="p">;</span>
<span class="nx">last</span><span class="o">=</span> <span class="p">{</span> <span class="nx">x</span><span class="o">:</span> <span class="nx">x</span><span class="p">,</span> <span class="nx">y</span><span class="o">:</span> <span class="nx">y</span> <span class="p">};</span>
<span class="kd">var</span>
<span class="nx">revolution</span><span class="o">=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_revolution_</span><span class="p">),</span>
<span class="nx">origin</span><span class="o">=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_clicked_location_</span><span class="p">),</span>
<span class="nx">vertical</span><span class="o">=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_vertical_</span><span class="p">),</span>
<span class="nx">fraction</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_fraction_</span><span class="p">,</span> <span class="nx">graph</span><span class="p">(</span><span class="nx">vertical</span> <span class="o">?</span> <span class="nx">y</span> <span class="o">-</span> <span class="nx">origin</span><span class="p">.</span><span class="nx">y</span> <span class="o">:</span> <span class="nx">x</span> <span class="o">-</span> <span class="nx">origin</span><span class="p">.</span><span class="nx">x</span><span class="p">,</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_clicked_on_</span><span class="p">),</span> <span class="nx">revolution</span><span class="p">,</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_lo_</span><span class="p">),</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_hi_</span><span class="p">),</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_cwish_</span><span class="p">),</span> <span class="nx">vertical</span> <span class="o">?</span> <span class="nx">y</span> <span class="o">-</span> <span class="nx">origin</span><span class="p">.</span><span class="nx">y</span> <span class="o">:</span> <span class="nx">x</span> <span class="o">-</span> <span class="nx">origin</span><span class="p">.</span><span class="nx">x</span><span class="p">)),</span>
<span class="nx">reeling</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_reeling_</span><span class="p">,</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_reeling_</span><span class="p">)</span> <span class="o">||</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_frame_</span><span class="p">)</span> <span class="o">!=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_clicked_</span><span class="p">)),</span>
<span class="nx">motion</span><span class="o">=</span> <span class="nx">to_bias</span><span class="p">(</span><span class="nx">vertical</span> <span class="o">?</span> <span class="nx">delta</span><span class="p">.</span><span class="nx">y</span> <span class="o">:</span> <span class="nx">delta</span><span class="p">.</span><span class="nx">x</span> <span class="o">||</span> <span class="mi">0</span><span class="p">),</span>
<span class="nx">backwards</span><span class="o">=</span> <span class="nx">motion</span> <span class="o">&&</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_backwards_</span><span class="p">,</span> <span class="nx">motion</span> <span class="o"><</span> <span class="mi">0</span><span class="p">)</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">orbital</span> <span class="o">&&</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_center_</span><span class="p">))</span> <span class="kd">var</span>
<span class="nx">vertical</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_vertical_</span><span class="p">,</span> <span class="nx">abs</span><span class="p">(</span><span class="nx">y</span> <span class="o">-</span> <span class="nx">origin</span><span class="p">.</span><span class="nx">y</span><span class="p">)</span> <span class="o">></span> <span class="nx">abs</span><span class="p">(</span><span class="nx">x</span> <span class="o">-</span> <span class="nx">origin</span><span class="p">.</span><span class="nx">x</span><span class="p">)),</span>
<span class="nx">origin</span><span class="o">=</span> <span class="nx">recenter_mouse</span><span class="p">(</span><span class="nx">revolution</span><span class="p">,</span> <span class="nx">x</span><span class="p">,</span> <span class="nx">y</span><span class="p">)</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">rows</span> <span class="o">></span> <span class="mi">1</span><span class="p">)</span> <span class="kd">var</span>
<span class="nx">space_y</span><span class="o">=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_dimensions_</span><span class="p">).</span><span class="nx">y</span><span class="p">,</span>
<span class="nx">revolution_y</span><span class="o">=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_revolution_y_</span><span class="p">),</span>
<span class="nx">start</span><span class="o">=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_clicked_tier_</span><span class="p">),</span>
<span class="nx">lo</span><span class="o">=</span> <span class="o">-</span> <span class="nx">start</span> <span class="o">*</span> <span class="nx">revolution_y</span><span class="p">,</span>
<span class="nx">tier</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_tier_</span><span class="p">,</span> <span class="nx">reel</span><span class="p">.</span><span class="nx">math</span><span class="p">.</span><span class="nx">envelope</span><span class="p">(</span><span class="nx">y</span> <span class="o">-</span> <span class="nx">origin</span><span class="p">.</span><span class="nx">y</span><span class="p">,</span> <span class="nx">start</span><span class="p">,</span> <span class="nx">revolution_y</span><span class="p">,</span> <span class="nx">lo</span><span class="p">,</span> <span class="nx">lo</span> <span class="o">+</span> <span class="nx">revolution_y</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">))</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="p">(</span><span class="nx">fraction</span> <span class="o">%</span> <span class="mi">1</span><span class="p">)</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">opt</span><span class="p">.</span><span class="nx">loops</span><span class="p">)</span> <span class="kd">var</span>
<span class="nx">origin</span><span class="o">=</span> <span class="nx">recenter_mouse</span><span class="p">(</span><span class="nx">revolution</span><span class="p">,</span> <span class="nx">x</span><span class="p">,</span> <span class="nx">y</span><span class="p">)</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='wheel-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#wheel-Event">¶</a> </div> <h3><code>wheel</code> Event</h3>
<p><code>Event</code>, since 1.0</p>
<p>Maps Reel to mouse wheel position change event which is provided by a nifty plug-in
written by Brandon Aaron - the <a href="https://github.com/brandonaaron/jquery-mousewheel">Mousewheel plug-in</a>, which you will need to enable
the mousewheel wheel for reeling. You can also choose to use <a href="http://blog.threedubmedia.com/2008/08/eventspecialwheel.html">Wheel Special Event
plug-in</a> by Three Dub Media instead. Either way <code>"wheel</code> Event handler receives
the positive or negative wheeled distance in arguments. This event:</p>
<ul>
<li>calculates wheel input delta and adjusts the <code>fraction</code> using the graph,</li>
<li>recenters the "drag" each and every time,</li>
<li>detects motion direction,</li>
<li>and nullifies the velocity.</li>
</ul> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">wheel</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">,</span> <span class="nx">distance</span><span class="p">){</span>
<span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">distance</span><span class="p">)</span> <span class="k">return</span><span class="p">;</span>
<span class="nx">wheeled</span><span class="o">=</span> <span class="kc">true</span><span class="p">;</span>
<span class="kd">var</span>
<span class="nx">delta</span><span class="o">=</span> <span class="nx">ceil</span><span class="p">(</span><span class="nx">math</span><span class="p">.</span><span class="nx">sqrt</span><span class="p">(</span><span class="nx">abs</span><span class="p">(</span><span class="nx">distance</span><span class="p">))</span> <span class="o">/</span> <span class="mi">2</span><span class="p">),</span>
<span class="nx">delta</span><span class="o">=</span> <span class="nx">negative_when</span><span class="p">(</span><span class="nx">delta</span><span class="p">,</span> <span class="nx">distance</span> <span class="o">></span> <span class="mi">0</span><span class="p">),</span>
<span class="nx">revolution</span><span class="o">=</span> <span class="mf">0.0833</span> <span class="o">*</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_revolution_</span><span class="p">),</span> <span class="c1">// Wheel's revolution is 1/12 of full revolution</span>
<span class="nx">origin</span><span class="o">=</span> <span class="nx">recenter_mouse</span><span class="p">(</span><span class="nx">revolution</span><span class="p">),</span>
<span class="nx">backwards</span><span class="o">=</span> <span class="nx">delta</span> <span class="o">&&</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_backwards_</span><span class="p">,</span> <span class="nx">delta</span> <span class="o"><</span> <span class="mi">0</span><span class="p">),</span>
<span class="nx">velocity</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_velocity_</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span>
<span class="nx">fraction</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_fraction_</span><span class="p">,</span> <span class="nx">graph</span><span class="p">(</span><span class="nx">delta</span><span class="p">,</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_clicked_on_</span><span class="p">),</span> <span class="nx">revolution</span><span class="p">,</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_lo_</span><span class="p">),</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_hi_</span><span class="p">),</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_cwish_</span><span class="p">)))</span>
<span class="nx">unidle</span><span class="p">();</span>
<span class="nx">t</span><span class="p">.</span><span class="nx">trigger</span><span class="p">(</span><span class="s1">'up'</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">false</span><span class="p">;</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='Data-Change-Events'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#Data-Change-Events">¶</a> </div> <hr />
<h2>Data Change Events</h2>
<p>Besides Reel being event-driven, it also is data-driven respectively data-change-driven
meaning that there is a mechanism in place, which detects real changes in data being
stored with <code>.reel(name, value)</code>. Learn more about <a href="#Changes">data changes</a>.</p>
<p>These data change bindings are for internal use only and you don't ever trigger them
per se, you change data and that will trigger respective change event. If the value
being stored is the same as the one already stored, nothing will be triggered.
_For example to change Reel's <code>frame</code> you don't trigger <code>"frameChange"</code> and instead
you do:</p>
<pre><code>.reel("frame", 15)
</code></pre>
<p>Change events always receive the actual data key value in the third argument.
_For example this will log each viewed frame number into the developers console.</p>
<pre><code>.bind("frameChange", function(e, d, frame){
console.log(frame)
})
</code></pre> </td> <td class="code"> <div class="highlight"><pre></pre></div> </td> </tr> <tr id='fractionChange-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#fractionChange-Event">¶</a> </div> <h3><code>fractionChange</code> Event</h3>
<p><code>Event</code>, since 1.0</p>
<p>Internally Reel doesn't really work with the frames you set it up with. It uses
<strong>fraction</strong>, which is a numeric value ranging from 0.0 to 1.0. When <code>fraction</code> changes
this handler basically calculates and sets new value of <code>frame</code>.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">fractionChange</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">,</span> <span class="nx">set_fraction</span><span class="p">,</span> <span class="nx">fraction</span><span class="p">){</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">set_fraction</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="k">return</span> <span class="nx">deprecated</span><span class="p">(</span><span class="nx">set</span><span class="p">(</span><span class="nx">_fraction_</span><span class="p">,</span> <span class="nx">set_fraction</span><span class="p">));</span>
<span class="kd">var</span>
<span class="nx">frame</span><span class="o">=</span> <span class="mi">1</span> <span class="o">+</span> <span class="nx">floor</span><span class="p">(</span><span class="nx">fraction</span> <span class="o">/</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_bit_</span><span class="p">)),</span>
<span class="nx">multirow</span><span class="o">=</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">rows</span> <span class="o">></span> <span class="mi">1</span><span class="p">,</span>
<span class="nx">orbital</span><span class="o">=</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">orbital</span><span class="p">,</span>
<span class="nx">center</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_center_</span><span class="p">,</span> <span class="o">!!</span><span class="nx">orbital</span> <span class="o">&&</span> <span class="p">(</span><span class="nx">frame</span> <span class="o"><=</span> <span class="nx">orbital</span> <span class="o">||</span> <span class="nx">frame</span> <span class="o">>=</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">footage</span> <span class="o">-</span> <span class="nx">orbital</span> <span class="o">+</span> <span class="mi">2</span><span class="p">))</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">multirow</span><span class="p">)</span> <span class="kd">var</span>
<span class="nx">frame</span><span class="o">=</span> <span class="nx">frame</span> <span class="o">+</span> <span class="p">(</span><span class="nx">get</span><span class="p">(</span><span class="nx">_row_</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_frames_</span><span class="p">)</span>
<span class="kd">var</span>
<span class="nx">frame</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_frame_</span><span class="p">,</span> <span class="nx">frame</span><span class="p">)</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='tierChange-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#tierChange-Event">¶</a> </div> <h3><code>tierChange</code> Event</h3>
<p><code>Event</code>, since 1.2</p>
<p>The situation of <code>tier</code> is very much similar to the one of <code>fraction</code>. In multi-row
movies, <strong>tier</strong> is an internal value for the vertical axis. Its value also ranges from
0.0 to 1.0. Handler calculates and sets new value of <code>frame</code>.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">tierChange</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">,</span> <span class="nx">deprecated_set</span><span class="p">,</span> <span class="nx">tier</span><span class="p">){</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">deprecated_set</span> <span class="o">===</span> <span class="kc">undefined</span><span class="p">)</span> <span class="kd">var</span>
<span class="nx">row</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_row_</span><span class="p">,</span> <span class="nx">round</span><span class="p">(</span><span class="nx">interpolate</span><span class="p">(</span><span class="nx">tier</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="nx">opt</span><span class="p">.</span><span class="nx">rows</span><span class="p">))),</span>
<span class="nx">frames</span><span class="o">=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_frames_</span><span class="p">),</span>
<span class="nx">frame</span><span class="o">=</span> <span class="nx">get</span><span class="p">(</span><span class="nx">_frame_</span><span class="p">)</span> <span class="o">%</span> <span class="nx">frames</span> <span class="o">||</span> <span class="nx">frames</span><span class="p">,</span>
<span class="nx">frame</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_frame_</span><span class="p">,</span> <span class="nx">frame</span> <span class="o">+</span> <span class="nx">row</span> <span class="o">*</span> <span class="nx">frames</span> <span class="o">-</span> <span class="nx">frames</span><span class="p">)</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='rowChange-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#rowChange-Event">¶</a> </div> <h3><code>rowChange</code> Event</h3>
<p><code>Event</code>, since 1.1</p>
<p>The physical vertical position of Reel is expressed in <strong>rows</strong> and ranges
from 1 to the total number of rows defined with <a href="#rows-Option"><code>rows</code></a>. This handler
only converts <code>row</code> value to <code>tier</code> and sets it.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">rowChange</span><span class="o">:</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">,</span> <span class="nx">set_row</span><span class="p">,</span> <span class="nx">row</span><span class="p">){</span>
<span class="k">if</span> <span class="p">(</span><span class="nx">set_row</span> <span class="o">!==</span> <span class="kc">undefined</span><span class="p">)</span> <span class="k">return</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_row_</span><span class="p">,</span> <span class="nx">set_row</span><span class="p">);</span>
<span class="kd">var</span>
<span class="nx">tier</span><span class="o">=</span> <span class="nx">set</span><span class="p">(</span><span class="nx">_tier_</span><span class="p">,</span> <span class="mi">1</span> <span class="o">/</span> <span class="p">(</span><span class="nx">opt</span><span class="p">.</span><span class="nx">rows</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="p">(</span><span class="nx">row</span> <span class="o">-</span> <span class="mi">1</span><span class="p">))</span>
<span class="p">},</span></pre></div> </td> </tr> <tr id='frameChange-Event'> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#frameChange-Event">¶</a> </div> <h3><code>frameChange</code> Event</h3>