Project

General

Profile

1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
2
<!--NewPage-->
3
<HTML>
4
<HEAD>
5
<TITLE>
6
MovieLoop
7
</TITLE>
8
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
9
</HEAD>
10
<SCRIPT>
11
function asd()
12
{
13
parent.document.title="MovieLoop";
14
}
15
</SCRIPT>
16
<BODY BGCOLOR="white" onload="asd();">
17

    
18
<!-- ========== START OF NAVBAR ========== -->
19
<A NAME="navbar_bottom"><!-- --></A>
20
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
21
<TR>
22
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
23
<A NAME="navbar_bottom_firstrow"><!-- --></A>
24
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
25
  <TR ALIGN="center" VALIGN="top">
26
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
27
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">  <A HREF="overview-summary-MovieLoop.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A>&nbsp;</TD>
28
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">&nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
29
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
30
  <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"-->    <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!--&nbsp;</TD-->
31
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"--><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
32
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
33
  </TR>
34
</TABLE>
35
</TD>
36
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
37
<B><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</B>
38
</EM>
39
</TD
40
</TR>
41

    
42
<TR>
43
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
44
&nbsp;<A HREF="ModelUrlInput.html"><B>PREV CLASS</B></A><!-- 
45
   NEXT CLASS 
46
-->
47
&nbsp;<A HREF="OpenLSForm.html"><B>NEXT CLASS</B></A></FONT></TD>
48
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
49
  <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
50
&nbsp;<A HREF="MovieLoop.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
51
&nbsp;
52
<SCRIPT>
53
  <!--
54
  if(window==top) {
55
    document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
56
  }
57
  //-->
58
</SCRIPT>
59
<NOSCRIPT>
60
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
61
</NOSCRIPT>
62
</FONT></TD>
63
</TR>
64
<TR>
65
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
66
  SUMMARY:&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
67
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
68
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
69
</TR>
70
</TABLE>
71
<!-- =========== END OF NAVBAR =========== -->
72
<HR>
73

    
74
<!-- ======== START OF CLASS DATA ======== -->
75
<H2>Class MovieLoop</H2>
76
<PRE>Object
77
   |
78
   +--<a href='ToolBase.html'>ToolBase</a>
79
         |
80
         +--<b>MovieLoop</b>
81
</PRE>
82

    
83

    
84
<HR>
85
<DL>
86
   <!-- Class definition -->
87
   <DT>class 
88
   <B>MovieLoop</B>
89
   
90
      <DT>extends <a href='ToolBase.html'>ToolBase</a> 
91
   
92

    
93
</DL>
94
   
95
   <P>
96
   <I>Defined in <a href='overview-summary-MovieLoop.js.html'>MovieLoop.js</a></I><BR/><BR/><B>Author:</B> Adair  <BR/>
97
   </P>
98
   
99
   <HR>
100

    
101
<!-- ======== NESTED CLASS SUMMARY ======== -->
102

    
103
<!-- ======== END NESTED CLASS SUMMARY ======== -->
104

    
105

    
106
<!-- =========== FIELD SUMMARY =========== -->
107

    
108
   <A NAME="field_summary"><!-- --></A>
109
      <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
110
         <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
111
            <TD COLSPAN=2><FONT SIZE="+2">
112
               <B>Field Summary</B></FONT></TD>
113
         </TR>
114

    
115
   <!-- This is one instance field summary -->
116
   
117
   <TR BGCOLOR="white" CLASS="TableRowColor">
118
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
119
   <CODE>&nbsp;Object</CODE></FONT></TD>
120
   <TD><CODE><B><A HREF="#delay">delay</A></B></CODE>
121
   <BR>
122
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
123
   </TR>
124
   
125
   <TR BGCOLOR="white" CLASS="TableRowColor">
126
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
127
   <CODE>&nbsp;Object</CODE></FONT></TD>
128
   <TD><CODE><B><A HREF="#frameIncrement">frameIncrement</A></B></CODE>
129
   <BR>
130
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
131
   </TR>
132
   
133
   <TR BGCOLOR="white" CLASS="TableRowColor">
134
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
135
   <CODE>&nbsp;Object</CODE></FONT></TD>
136
   <TD><CODE><B><A HREF="#frameIsLoading">frameIsLoading</A></B></CODE>
137
   <BR>
138
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
139
   </TR>
140
   
141
   <TR BGCOLOR="white" CLASS="TableRowColor">
142
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
143
   <CODE>&nbsp;Object</CODE></FONT></TD>
144
   <TD><CODE><B><A HREF="#isRunning">isRunning</A></B></CODE>
145
   <BR>
146
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
147
   </TR>
148
   
149
   <TR BGCOLOR="white" CLASS="TableRowColor">
150
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151
   <CODE>&nbsp;Object</CODE></FONT></TD>
152
   <TD><CODE><B><A HREF="#maxFrames">maxFrames</A></B></CODE>
153
   <BR>
154
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
155
   </TR>
156
   
157
   <TR BGCOLOR="white" CLASS="TableRowColor">
158
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159
   <CODE>&nbsp;Object</CODE></FONT></TD>
160
   <TD><CODE><B><A HREF="#movieTimer">movieTimer</A></B></CODE>
161
   <BR>
162
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
163
   </TR>
164
   
165
   <TR BGCOLOR="white" CLASS="TableRowColor">
166
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167
   <CODE>&nbsp;Object</CODE></FONT></TD>
168
   <TD><CODE><B><A HREF="#timestampIndex">timestampIndex</A></B></CODE>
169
   <BR>
170
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
171
   </TR>
172
   
173

    
174
   </TABLE>
175
   &nbsp;
176
   
177

    
178
   
179
   
180
   &nbsp;<A NAME=""><!-- --></A>
181
   <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
182
   <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
183
   <TD><B>Fields inherited from class <A HREF="ToolBase.html">ToolBase</A></B></TD>
184
   </TR>
185
   <TR BGCOLOR="white" CLASS="TableRowColor">
186
   <TD><CODE>
187
   <a href="ToolBase.html#model">model</a>, <a href="ToolBase.html#toolNode">toolNode</a>, <a href="ToolBase.html#enabled">enabled</a>
188
   </CODE></TD>
189
   </TR>
190
</TABLE>
191
&nbsp;
192

    
193

    
194

    
195
<!-- =========== END FIELD SUMMARY =========== -->
196

    
197

    
198
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
199

    
200
<A NAME="constructor_summary"><!-- --></A>
201
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
202
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
203
<TD COLSPAN=2><FONT SIZE="+2">
204
<B>Constructor Summary</B></FONT></TD>
205
</TR>
206
<TR BGCOLOR="white" CLASS="TableRowColor">
207
   <TD>
208
      <CODE>
209
	 <B>
210
	    <A HREF="MovieLoop.html#MovieLoop()">MovieLoop</A> 
211
	 </B>
212
	 (toolNode, model)
213
      </CODE>
214
      <BR>
215
      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
216
      Controller for a movie loop.
217
      </TD>
218
</TR>
219
</TABLE>
220

    
221
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
222

    
223
&nbsp;
224

    
225
<!-- ========== METHOD SUMMARY =========== -->
226

    
227
<A NAME="method_summary"><!-- --></A>
228
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
229
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
230
<TD COLSPAN=2><FONT SIZE="+2">
231
<B>Method Summary</B></FONT></TD>
232
</TR>
233

    
234

    
235
   <TR BGCOLOR="white" CLASS="TableRowColor">
236
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
237
	 <FONT SIZE="-1">
238
	    <CODE>&nbsp;void</CODE>
239
	 </FONT>
240
      </TD>
241
      <TD>
242
	 <CODE>
243
	    <B>
244
	       <A HREF="#init">init</A></B>(objRef)
245
	 </CODE>
246
	 <BR>
247
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
248
	 initialize the movie loop.
249
      </TD>
250
   </TR>
251

    
252
   <TR BGCOLOR="white" CLASS="TableRowColor">
253
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
254
	 <FONT SIZE="-1">
255
	    <CODE>&nbsp;void</CODE>
256
	 </FONT>
257
      </TD>
258
      <TD>
259
	 <CODE>
260
	    <B>
261
	       <A HREF="#nextFrame">nextFrame</A></B>(step)
262
	 </CODE>
263
	 <BR>
264
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
265
	 Advances the frame array by the frame increment.
266
      </TD>
267
   </TR>
268

    
269
   <TR BGCOLOR="white" CLASS="TableRowColor">
270
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
271
	 <FONT SIZE="-1">
272
	    <CODE>&nbsp;void</CODE>
273
	 </FONT>
274
      </TD>
275
      <TD>
276
	 <CODE>
277
	    <B>
278
	       <A HREF="#pause">pause</A></B>()
279
	 </CODE>
280
	 <BR>
281
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
282
	 Stops the JavaScript movie loop timer.
283
      </TD>
284
   </TR>
285

    
286
   <TR BGCOLOR="white" CLASS="TableRowColor">
287
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
288
	 <FONT SIZE="-1">
289
	    <CODE>&nbsp;void</CODE>
290
	 </FONT>
291
      </TD>
292
      <TD>
293
	 <CODE>
294
	    <B>
295
	       <A HREF="#play">play</A></B>()
296
	 </CODE>
297
	 <BR>
298
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
299
	 Starts the movie loop playing by using a JavaScript timer.
300
      </TD>
301
   </TR>
302

    
303
   <TR BGCOLOR="white" CLASS="TableRowColor">
304
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
305
	 <FONT SIZE="-1">
306
	    <CODE>&nbsp;void</CODE>
307
	 </FONT>
308
      </TD>
309
      <TD>
310
	 <CODE>
311
	    <B>
312
	       <A HREF="#reset">reset</A></B>(objRef)
313
	 </CODE>
314
	 <BR>
315
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
316
	 Resets the frame index to the firstFrame property
317
      </TD>
318
   </TR>
319

    
320
   <TR BGCOLOR="white" CLASS="TableRowColor">
321
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
322
	 <FONT SIZE="-1">
323
	    <CODE>&nbsp;void</CODE>
324
	 </FONT>
325
      </TD>
326
      <TD>
327
	 <CODE>
328
	    <B>
329
	       <A HREF="#setFrame">setFrame</A></B>(index)
330
	 </CODE>
331
	 <BR>
332
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
333
	 Sets the frame to the specified index in the frame array
334
      </TD>
335
   </TR>
336

    
337
   <TR BGCOLOR="white" CLASS="TableRowColor">
338
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
339
	 <FONT SIZE="-1">
340
	    <CODE>&nbsp;void</CODE>
341
	 </FONT>
342
      </TD>
343
      <TD>
344
	 <CODE>
345
	    <B>
346
	       <A HREF="#setFrameLimits">setFrameLimits</A></B>(objRef)
347
	 </CODE>
348
	 <BR>
349
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
350
	 Listener fucntion to set the start and end frames based on the 
351
 firstFrame and maxFrames property values.
352
      </TD>
353
   </TR>
354

    
355
   <TR BGCOLOR="white" CLASS="TableRowColor">
356
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
357
	 <FONT SIZE="-1">
358
	    <CODE>&nbsp;void</CODE>
359
	 </FONT>
360
      </TD>
361
      <TD>
362
	 <CODE>
363
	    <B>
364
	       <A HREF="#stop">stop</A></B>()
365
	 </CODE>
366
	 <BR>
367
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
368
	 Stops the JavaScript movie loop timer and sets the index back to the first 
369
 frame.
370
      </TD>
371
   </TR>
372

    
373
   <TR BGCOLOR="white" CLASS="TableRowColor">
374
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
375
	 <FONT SIZE="-1">
376
	    <CODE>&nbsp;void</CODE>
377
	 </FONT>
378
      </TD>
379
      <TD>
380
	 <CODE>
381
	    <B>
382
	       <A HREF="#stopListener">stopListener</A></B>(objRef)
383
	 </CODE>
384
	 <BR>
385
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
386
	 A "stopLoop" event listener to call the stop method
387
      </TD>
388
   </TR>
389

    
390
   <TR BGCOLOR="white" CLASS="TableRowColor">
391
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
392
	 <FONT SIZE="-1">
393
	    <CODE>&nbsp;void</CODE>
394
	 </FONT>
395
      </TD>
396
      <TD>
397
	 <CODE>
398
	    <B>
399
	       <A HREF="#uninit">uninit</A></B>(objRef)
400
	 </CODE>
401
	 <BR>
402
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
403
	 set the initialized state of the movie loop to false
404
      </TD>
405
   </TR>
406

    
407

    
408
</TABLE>
409

    
410

    
411

    
412
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
413
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
414
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
415
<TD><B>Methods inherited from class <a href="ToolBase.html">ToolBase</a></B></TD>
416
</TR>
417
<TR BGCOLOR="white" CLASS="TableRowColor">
418
<TD><CODE>
419
<!-- Inherited methods -->
420
<a href="ToolBase.html#initTargetModel">initTargetModel</a>, <a href="ToolBase.html#initMouseHandler">initMouseHandler</a>, <a href="ToolBase.html#getProperty">getProperty</a>
421
</CODE></TD>
422
</TR>
423
</TABLE>
424
&nbsp;
425

    
426
<P>
427
<!-- ========== END METHOD SUMMARY =========== -->
428

    
429

    
430
<!-- ============ FIELD DETAIL START =========== -->
431

    
432
   <A NAME="field_detail"><!-- --></A>
433
   <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
434
      <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
435
         <TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
436
      </TR>
437
   </TABLE>
438

    
439
   
440
   <A NAME="delay"><!-- --></A>
441
   <H3>delay</H3>
442
   <PRE>Object&nbsp;<B>delay</B></PRE>
443
   <UL>
444
   
445
   
446
   </UL>
447
   <HR>
448
   
449
   <A NAME="frameIncrement"><!-- --></A>
450
   <H3>frameIncrement</H3>
451
   <PRE>Object&nbsp;<B>frameIncrement</B></PRE>
452
   <UL>
453
   
454
   
455
   </UL>
456
   <HR>
457
   
458
   <A NAME="frameIsLoading"><!-- --></A>
459
   <H3>frameIsLoading</H3>
460
   <PRE>Object&nbsp;<B>frameIsLoading</B></PRE>
461
   <UL>
462
   
463
   
464
   </UL>
465
   <HR>
466
   
467
   <A NAME="isRunning"><!-- --></A>
468
   <H3>isRunning</H3>
469
   <PRE>Object&nbsp;<B>isRunning</B></PRE>
470
   <UL>
471
   
472
   
473
   </UL>
474
   <HR>
475
   
476
   <A NAME="maxFrames"><!-- --></A>
477
   <H3>maxFrames</H3>
478
   <PRE>Object&nbsp;<B>maxFrames</B></PRE>
479
   <UL>
480
   
481
   
482
   </UL>
483
   <HR>
484
   
485
   <A NAME="movieTimer"><!-- --></A>
486
   <H3>movieTimer</H3>
487
   <PRE>Object&nbsp;<B>movieTimer</B></PRE>
488
   <UL>
489
   
490
   
491
   </UL>
492
   <HR>
493
   
494
   <A NAME="timestampIndex"><!-- --></A>
495
   <H3>timestampIndex</H3>
496
   <PRE>Object&nbsp;<B>timestampIndex</B></PRE>
497
   <UL>
498
   
499
   
500
   </UL>
501
   <HR>
502
   
503

    
504

    
505
<!-- ============ FIELD DETAIL END =========== -->
506

    
507
    <!-- ========= CONSTRUCTOR DETAIL START ======== -->
508

    
509
<A NAME="constructor_detail"><!-- --></A>
510
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
511
   <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
512
      <TD COLSPAN=1>
513
      <FONT SIZE="+2"><B>Constructor Detail</B></FONT>
514
      </TD>
515
   </TR>
516
</TABLE>
517

    
518
<A NAME="MovieLoop()"><!-- --></A><H3>
519
MovieLoop</H3>
520
<PRE><B>MovieLoop</B>(toolNode, model)</PRE>
521

    
522

    
523
<UL>
524
   Controller for a movie loop.  Set framesPerSec to control the frame rate 
525
 and frameIncrement (+n/-n) to control the steps through the loop (n is number
526
 of frames to increment.
527
</UL>
528

    
529

    
530

    
531
   <UL>
532
   <B>Parameters:</B>
533
   
534
     <UL><CODE>toolNode</CODE> -  The tool node from the config document for this tool  
535
     </UL>
536
   
537
     <UL><CODE>model</CODE> -   the model object that contains this tool
538
     </UL>
539
   
540
   
541
   </UL>
542

    
543

    
544
<!-- Constructor return value(s) -->
545

    
546
<!-- End constructor return value(s) -->
547

    
548
<!-- ADDITIONAL ATTRIBUTES -->
549

    
550
<UL>   
551
<B>Author:</B> Adair  <BR/>
552
</UL>
553

    
554
<HR/>
555
<!-- END ADDITIONAL ATTRIBUTES  -->
556

    
557
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
558

    
559

    
560
<!-- ============ METHOD DETAIL START ========== -->
561

    
562
<A NAME="method_detail"><!-- --></A>
563
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
564
   <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
565
      <TD COLSPAN=1><FONT SIZE="+2">
566
         <B>Method Detail</B></FONT>
567
      </TD>
568
   </TR>
569
</TABLE>
570

    
571
<!-- One single method detail entry -->
572

    
573
   <A NAME="init"><!-- --></A>
574
   <H3>init</H3>
575
   <PRE>void <B>init</B>(objRef)</PRE>
576
   
577
      <UL>initialize the movie loop. This only happens at the first bbox event,
578
 which shows us that the map is loaded.</UL>
579
   
580

    
581
   <!-- METHOD PARAMETERS START -->
582
   
583
   <!-- METHOD PARAMETERS END -->
584

    
585
   
586

    
587
   <!-- ADDITIONAL ATTRIBUTES START -->
588
   
589
   <!-- ADDITIONAL ATTRIBUTES  END -->
590
<HR>
591

    
592
   <A NAME="nextFrame"><!-- --></A>
593
   <H3>nextFrame</H3>
594
   <PRE>void <B>nextFrame</B>(step)</PRE>
595
   
596
      <UL>Advances the frame array by the frame increment.</UL>
597
   
598

    
599
   <!-- METHOD PARAMETERS START -->
600
   
601
   <UL>
602
   <B>Parameters:</B>
603
   
604
     <UL><CODE>step</CODE> -  optional parameter to override default frame increment      
605
      </UL> 
606
   
607
   </UL>
608
   
609
   <!-- METHOD PARAMETERS END -->
610

    
611
   
612

    
613
   <!-- ADDITIONAL ATTRIBUTES START -->
614
   
615
   <!-- ADDITIONAL ATTRIBUTES  END -->
616
<HR>
617

    
618
   <A NAME="pause"><!-- --></A>
619
   <H3>pause</H3>
620
   <PRE>void <B>pause</B>()</PRE>
621
   
622
      <UL>Stops the JavaScript movie loop timer.</UL>
623
   
624

    
625
   <!-- METHOD PARAMETERS START -->
626
   
627
   <!-- METHOD PARAMETERS END -->
628

    
629
   
630

    
631
   <!-- ADDITIONAL ATTRIBUTES START -->
632
   
633
   <!-- ADDITIONAL ATTRIBUTES  END -->
634
<HR>
635

    
636
   <A NAME="play"><!-- --></A>
637
   <H3>play</H3>
638
   <PRE>void <B>play</B>()</PRE>
639
   
640
      <UL>Starts the movie loop playing by using a JavaScript timer.</UL>
641
   
642

    
643
   <!-- METHOD PARAMETERS START -->
644
   
645
   <!-- METHOD PARAMETERS END -->
646

    
647
   
648

    
649
   <!-- ADDITIONAL ATTRIBUTES START -->
650
   
651
   <!-- ADDITIONAL ATTRIBUTES  END -->
652
<HR>
653

    
654
   <A NAME="reset"><!-- --></A>
655
   <H3>reset</H3>
656
   <PRE>void <B>reset</B>(objRef)</PRE>
657
   
658
      <UL>Resets the frame index to the firstFrame property</UL>
659
   
660

    
661
   <!-- METHOD PARAMETERS START -->
662
   
663
   <UL>
664
   <B>Parameters:</B>
665
   
666
     <UL><CODE>objRef</CODE> -  pointer to this object      
667
      </UL> 
668
   
669
   </UL>
670
   
671
   <!-- METHOD PARAMETERS END -->
672

    
673
   
674

    
675
   <!-- ADDITIONAL ATTRIBUTES START -->
676
   
677
   <!-- ADDITIONAL ATTRIBUTES  END -->
678
<HR>
679

    
680
   <A NAME="setFrame"><!-- --></A>
681
   <H3>setFrame</H3>
682
   <PRE>void <B>setFrame</B>(index)</PRE>
683
   
684
      <UL>Sets the frame to the specified index in the frame array</UL>
685
   
686

    
687
   <!-- METHOD PARAMETERS START -->
688
   
689
   <UL>
690
   <B>Parameters:</B>
691
   
692
     <UL><CODE>index</CODE> -  the 0-based frame index in the frame array      
693
      </UL> 
694
   
695
   </UL>
696
   
697
   <!-- METHOD PARAMETERS END -->
698

    
699
   
700

    
701
   <!-- ADDITIONAL ATTRIBUTES START -->
702
   
703
   <!-- ADDITIONAL ATTRIBUTES  END -->
704
<HR>
705

    
706
   <A NAME="setFrameLimits"><!-- --></A>
707
   <H3>setFrameLimits</H3>
708
   <PRE>void <B>setFrameLimits</B>(objRef)</PRE>
709
   
710
      <UL>Listener fucntion to set the start and end frames based on the 
711
 firstFrame and maxFrames property values.</UL>
712
   
713

    
714
   <!-- METHOD PARAMETERS START -->
715
   
716
   <UL>
717
   <B>Parameters:</B>
718
   
719
     <UL><CODE>objRef</CODE> -  pointer to this object      
720
      </UL> 
721
   
722
   </UL>
723
   
724
   <!-- METHOD PARAMETERS END -->
725

    
726
   
727

    
728
   <!-- ADDITIONAL ATTRIBUTES START -->
729
   
730
   <!-- ADDITIONAL ATTRIBUTES  END -->
731
<HR>
732

    
733
   <A NAME="stop"><!-- --></A>
734
   <H3>stop</H3>
735
   <PRE>void <B>stop</B>()</PRE>
736
   
737
      <UL>Stops the JavaScript movie loop timer and sets the index back to the first 
738
 frame.</UL>
739
   
740

    
741
   <!-- METHOD PARAMETERS START -->
742
   
743
   <!-- METHOD PARAMETERS END -->
744

    
745
   
746

    
747
   <!-- ADDITIONAL ATTRIBUTES START -->
748
   
749
   <!-- ADDITIONAL ATTRIBUTES  END -->
750
<HR>
751

    
752
   <A NAME="stopListener"><!-- --></A>
753
   <H3>stopListener</H3>
754
   <PRE>void <B>stopListener</B>(objRef)</PRE>
755
   
756
      <UL>A "stopLoop" event listener to call the stop method</UL>
757
   
758

    
759
   <!-- METHOD PARAMETERS START -->
760
   
761
   <UL>
762
   <B>Parameters:</B>
763
   
764
     <UL><CODE>objRef</CODE> -  pointer to this object      
765
      </UL> 
766
   
767
   </UL>
768
   
769
   <!-- METHOD PARAMETERS END -->
770

    
771
   
772

    
773
   <!-- ADDITIONAL ATTRIBUTES START -->
774
   
775
   <!-- ADDITIONAL ATTRIBUTES  END -->
776
<HR>
777

    
778
   <A NAME="uninit"><!-- --></A>
779
   <H3>uninit</H3>
780
   <PRE>void <B>uninit</B>(objRef)</PRE>
781
   
782
      <UL>set the initialized state of the movie loop to false</UL>
783
   
784

    
785
   <!-- METHOD PARAMETERS START -->
786
   
787
   <!-- METHOD PARAMETERS END -->
788

    
789
   
790

    
791
   <!-- ADDITIONAL ATTRIBUTES START -->
792
   
793
   <!-- ADDITIONAL ATTRIBUTES  END -->
794
<HR>
795

    
796

    
797

    
798
<!-- ============ METHOD DETAIL END ========== -->
799

    
800
<!-- ========= END OF CLASS DATA ========= -->
801

    
802
<!-- ========== START OF NAVBAR ========== -->
803
<A NAME="navbar_bottom"><!-- --></A>
804
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
805
<TR>
806
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
807
<A NAME="navbar_bottom_firstrow"><!-- --></A>
808
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
809
  <TR ALIGN="center" VALIGN="top">
810
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
811
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">  <A HREF="overview-summary-MovieLoop.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A>&nbsp;</TD>
812
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
813
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A>&nbsp;</TD>
814
  <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"-->    <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!--&nbsp;</TD-->
815
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
816
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
817
  </TR>
818
</TABLE>
819
</TD>
820
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
821
<B><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</B>
822
</EM>
823
</TD
824
</TR>
825

    
826
<TR>
827
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
828
&nbsp;<A HREF="ModelUrlInput.html"><B>PREV CLASS</B></A><!-- 
829
   NEXT CLASS 
830
-->
831
&nbsp;<A HREF="OpenLSForm.html"><B>NEXT CLASS</B></A></FONT></TD>
832
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
833
  <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
834
&nbsp;<A HREF="MovieLoop.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
835
&nbsp;
836
<SCRIPT>
837
  <!--
838
  if(window==top) {
839
    document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
840
  }
841
  //-->
842
</SCRIPT>
843
<NOSCRIPT>
844
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
845
</NOSCRIPT>
846
</FONT></TD>
847
</TR>
848
<TR>
849
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
850
  SUMMARY:&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
851
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
852
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
853
</TR>
854
</TABLE>
855

    
856
<!-- =========== END OF NAVBAR =========== -->
857

    
858
<HR>
859
<FONT SIZE="-1">
860

    
861
</FONT>
862
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Sun Apr 27 20:30:54 2008</div>
863
</BODY>
864
</HTML>
(60-60/316)