jsc3d-rails 1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (144) hide show
  1. data/.gitignore +8 -0
  2. data/Gemfile +4 -0
  3. data/LICENSE +21 -0
  4. data/README.md +33 -0
  5. data/jsc3d-rails.gemspec +23 -0
  6. data/lib/generators/jquery/install/install_generator.rb +59 -0
  7. data/lib/jsc3d-rails.rb +1 -0
  8. data/lib/jsc3d/rails.rb +8 -0
  9. data/lib/jsc3d/rails/engine.rb +6 -0
  10. data/lib/jsc3d/rails/version.rb +6 -0
  11. data/vendor/assets/javascripts/bin/jsc3d.min.js +139 -0
  12. data/vendor/assets/javascripts/bin/jsc3d_ie.min.js +133 -0
  13. data/vendor/assets/javascripts/build/compile.bat +1 -0
  14. data/vendor/assets/javascripts/build/compile.sh +2 -0
  15. data/vendor/assets/javascripts/build/gendoc.bat +2 -0
  16. data/vendor/assets/javascripts/build/gendoc.sh +2 -0
  17. data/vendor/assets/javascripts/docs/files.html +247 -0
  18. data/vendor/assets/javascripts/docs/index.html +349 -0
  19. data/vendor/assets/javascripts/docs/symbols/JSC3D.AABB.html +436 -0
  20. data/vendor/assets/javascripts/docs/symbols/JSC3D.BinaryStream.html +1051 -0
  21. data/vendor/assets/javascripts/docs/symbols/JSC3D.LoaderSelector.html +455 -0
  22. data/vendor/assets/javascripts/docs/symbols/JSC3D.Material.html +430 -0
  23. data/vendor/assets/javascripts/docs/symbols/JSC3D.Math3D.html +468 -0
  24. data/vendor/assets/javascripts/docs/symbols/JSC3D.Matrix3x4.html +682 -0
  25. data/vendor/assets/javascripts/docs/symbols/JSC3D.Mesh.html +628 -0
  26. data/vendor/assets/javascripts/docs/symbols/JSC3D.ObjLoader.html +428 -0
  27. data/vendor/assets/javascripts/docs/symbols/JSC3D.PickInfo.html +332 -0
  28. data/vendor/assets/javascripts/docs/symbols/JSC3D.Scene.html +571 -0
  29. data/vendor/assets/javascripts/docs/symbols/JSC3D.StlLoader.html +473 -0
  30. data/vendor/assets/javascripts/docs/symbols/JSC3D.Texture.html +589 -0
  31. data/vendor/assets/javascripts/docs/symbols/JSC3D.Viewer.html +1156 -0
  32. data/vendor/assets/javascripts/docs/symbols/JSC3D.html +329 -0
  33. data/vendor/assets/javascripts/docs/symbols/_global_.html +279 -0
  34. data/vendor/assets/javascripts/docs/symbols/src/jsc3d.js.html +4804 -0
  35. data/vendor/assets/javascripts/jsc3d.console.js +146 -0
  36. data/vendor/assets/javascripts/jsc3d.js +4796 -0
  37. data/vendor/assets/javascripts/jsc3d_ie.js +4487 -0
  38. data/vendor/assets/javascripts/tools/closure/COPYING +202 -0
  39. data/vendor/assets/javascripts/tools/closure/README +261 -0
  40. data/vendor/assets/javascripts/tools/closure/USAGE +87 -0
  41. data/vendor/assets/javascripts/tools/closure/compiler.jar +0 -0
  42. data/vendor/assets/javascripts/tools/doc_generator/README.txt +146 -0
  43. data/vendor/assets/javascripts/tools/doc_generator/app/frame.js +33 -0
  44. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Chain.js +102 -0
  45. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Dumper.js +144 -0
  46. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Hash.js +84 -0
  47. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Link.js +148 -0
  48. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Namespace.js +10 -0
  49. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Opt.js +134 -0
  50. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Reflection.js +26 -0
  51. data/vendor/assets/javascripts/tools/doc_generator/app/frame/String.js +93 -0
  52. data/vendor/assets/javascripts/tools/doc_generator/app/frame/Testrun.js +129 -0
  53. data/vendor/assets/javascripts/tools/doc_generator/app/handlers/FOODOC.js +26 -0
  54. data/vendor/assets/javascripts/tools/doc_generator/app/handlers/XMLDOC.js +26 -0
  55. data/vendor/assets/javascripts/tools/doc_generator/app/handlers/XMLDOC/DomReader.js +159 -0
  56. data/vendor/assets/javascripts/tools/doc_generator/app/handlers/XMLDOC/XMLDoc.js +16 -0
  57. data/vendor/assets/javascripts/tools/doc_generator/app/handlers/XMLDOC/XMLParse.js +292 -0
  58. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC.js +101 -0
  59. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/DocComment.js +200 -0
  60. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/DocTag.js +294 -0
  61. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/JsDoc.js +126 -0
  62. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/JsPlate.js +109 -0
  63. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/Lang.js +144 -0
  64. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/Parser.js +107 -0
  65. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/PluginManager.js +33 -0
  66. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/Symbol.js +643 -0
  67. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/SymbolSet.js +229 -0
  68. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/TextStream.js +41 -0
  69. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/Token.js +18 -0
  70. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/TokenReader.js +332 -0
  71. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/TokenStream.js +133 -0
  72. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/Util.js +32 -0
  73. data/vendor/assets/javascripts/tools/doc_generator/app/lib/JSDOC/Walker.js +459 -0
  74. data/vendor/assets/javascripts/tools/doc_generator/app/main.js +111 -0
  75. data/vendor/assets/javascripts/tools/doc_generator/app/plugins/commentSrcJson.js +20 -0
  76. data/vendor/assets/javascripts/tools/doc_generator/app/plugins/frameworkPrototype.js +16 -0
  77. data/vendor/assets/javascripts/tools/doc_generator/app/plugins/functionCall.js +10 -0
  78. data/vendor/assets/javascripts/tools/doc_generator/app/plugins/publishSrcHilite.js +62 -0
  79. data/vendor/assets/javascripts/tools/doc_generator/app/plugins/symbolLink.js +9 -0
  80. data/vendor/assets/javascripts/tools/doc_generator/app/plugins/tagParamConfig.js +31 -0
  81. data/vendor/assets/javascripts/tools/doc_generator/app/plugins/tagSynonyms.js +43 -0
  82. data/vendor/assets/javascripts/tools/doc_generator/app/run.js +348 -0
  83. data/vendor/assets/javascripts/tools/doc_generator/app/t/TestDoc.js +144 -0
  84. data/vendor/assets/javascripts/tools/doc_generator/app/t/runner.js +13 -0
  85. data/vendor/assets/javascripts/tools/doc_generator/app/test.js +307 -0
  86. data/vendor/assets/javascripts/tools/doc_generator/app/test/addon.js +24 -0
  87. data/vendor/assets/javascripts/tools/doc_generator/app/test/anon_inner.js +14 -0
  88. data/vendor/assets/javascripts/tools/doc_generator/app/test/augments.js +31 -0
  89. data/vendor/assets/javascripts/tools/doc_generator/app/test/augments2.js +26 -0
  90. data/vendor/assets/javascripts/tools/doc_generator/app/test/borrows.js +41 -0
  91. data/vendor/assets/javascripts/tools/doc_generator/app/test/borrows2.js +23 -0
  92. data/vendor/assets/javascripts/tools/doc_generator/app/test/config.js +22 -0
  93. data/vendor/assets/javascripts/tools/doc_generator/app/test/constructs.js +18 -0
  94. data/vendor/assets/javascripts/tools/doc_generator/app/test/encoding.js +10 -0
  95. data/vendor/assets/javascripts/tools/doc_generator/app/test/encoding_other.js +12 -0
  96. data/vendor/assets/javascripts/tools/doc_generator/app/test/event.js +54 -0
  97. data/vendor/assets/javascripts/tools/doc_generator/app/test/functions_anon.js +39 -0
  98. data/vendor/assets/javascripts/tools/doc_generator/app/test/functions_nested.js +33 -0
  99. data/vendor/assets/javascripts/tools/doc_generator/app/test/global.js +13 -0
  100. data/vendor/assets/javascripts/tools/doc_generator/app/test/globals.js +25 -0
  101. data/vendor/assets/javascripts/tools/doc_generator/app/test/ignore.js +10 -0
  102. data/vendor/assets/javascripts/tools/doc_generator/app/test/inner.js +16 -0
  103. data/vendor/assets/javascripts/tools/doc_generator/app/test/jsdoc_test.js +477 -0
  104. data/vendor/assets/javascripts/tools/doc_generator/app/test/lend.js +33 -0
  105. data/vendor/assets/javascripts/tools/doc_generator/app/test/memberof.js +19 -0
  106. data/vendor/assets/javascripts/tools/doc_generator/app/test/memberof_constructor.js +17 -0
  107. data/vendor/assets/javascripts/tools/doc_generator/app/test/name.js +19 -0
  108. data/vendor/assets/javascripts/tools/doc_generator/app/test/namespace_nested.js +23 -0
  109. data/vendor/assets/javascripts/tools/doc_generator/app/test/nocode.js +13 -0
  110. data/vendor/assets/javascripts/tools/doc_generator/app/test/oblit_anon.js +20 -0
  111. data/vendor/assets/javascripts/tools/doc_generator/app/test/overview.js +20 -0
  112. data/vendor/assets/javascripts/tools/doc_generator/app/test/param_inline.js +37 -0
  113. data/vendor/assets/javascripts/tools/doc_generator/app/test/params_optional.js +8 -0
  114. data/vendor/assets/javascripts/tools/doc_generator/app/test/prototype.js +17 -0
  115. data/vendor/assets/javascripts/tools/doc_generator/app/test/prototype_nested.js +9 -0
  116. data/vendor/assets/javascripts/tools/doc_generator/app/test/prototype_oblit.js +13 -0
  117. data/vendor/assets/javascripts/tools/doc_generator/app/test/prototype_oblit_constructor.js +24 -0
  118. data/vendor/assets/javascripts/tools/doc_generator/app/test/public.js +10 -0
  119. data/vendor/assets/javascripts/tools/doc_generator/app/test/shared.js +42 -0
  120. data/vendor/assets/javascripts/tools/doc_generator/app/test/shared2.js +2 -0
  121. data/vendor/assets/javascripts/tools/doc_generator/app/test/shortcuts.js +22 -0
  122. data/vendor/assets/javascripts/tools/doc_generator/app/test/static_this.js +13 -0
  123. data/vendor/assets/javascripts/tools/doc_generator/app/test/synonyms.js +31 -0
  124. data/vendor/assets/javascripts/tools/doc_generator/app/test/tosource.js +23 -0
  125. data/vendor/assets/javascripts/tools/doc_generator/app/test/variable_redefine.js +14 -0
  126. data/vendor/assets/javascripts/tools/doc_generator/changes.txt +75 -0
  127. data/vendor/assets/javascripts/tools/doc_generator/conf/sample.conf +31 -0
  128. data/vendor/assets/javascripts/tools/doc_generator/java/build.xml +36 -0
  129. data/vendor/assets/javascripts/tools/doc_generator/java/build_1.4.xml +36 -0
  130. data/vendor/assets/javascripts/tools/doc_generator/java/classes/js.jar +0 -0
  131. data/vendor/assets/javascripts/tools/doc_generator/java/src/JsDebugRun.java +21 -0
  132. data/vendor/assets/javascripts/tools/doc_generator/java/src/JsRun.java +21 -0
  133. data/vendor/assets/javascripts/tools/doc_generator/jsdebug.jar +0 -0
  134. data/vendor/assets/javascripts/tools/doc_generator/jsrun.jar +0 -0
  135. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/allclasses.tmpl +17 -0
  136. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/allfiles.tmpl +56 -0
  137. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/class.tmpl +646 -0
  138. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/index.tmpl +39 -0
  139. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/publish.js +184 -0
  140. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/static/default.css +165 -0
  141. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/static/header.html +2 -0
  142. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/static/index.html +19 -0
  143. data/vendor/assets/javascripts/tools/doc_generator/templates/jsdoc/symbol.tmpl +35 -0
  144. metadata +234 -0
@@ -0,0 +1,436 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="content-type" content="text/html; charset=utf-8" />
6
+ <meta name="generator" content="JsDoc Toolkit" />
7
+
8
+ <title>JsDoc Reference - JSC3D.AABB</title>
9
+
10
+ <style type="text/css">
11
+ /* default.css */
12
+
13
+
14
+ body
15
+ {
16
+ font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
17
+ width: 800px;
18
+ }
19
+
20
+ .header
21
+ {
22
+ clear: both;
23
+ background-color: #ccc;
24
+ padding: 8px;
25
+ }
26
+
27
+ h1
28
+ {
29
+ font-size: 150%;
30
+ font-weight: bold;
31
+ padding: 0;
32
+ margin: 1em 0 0 .3em;
33
+ }
34
+
35
+ hr
36
+ {
37
+ border: none 0;
38
+ border-top: 1px solid #7F8FB1;
39
+ height: 1px;
40
+ }
41
+
42
+ pre.code
43
+ {
44
+ display: inline;
45
+ // padding: 8px;
46
+ // border: 1px dashed #ccc;
47
+ background-color: #4AA02C;
48
+ }
49
+
50
+ #index
51
+ {
52
+ margin-top: 24px;
53
+ float: left;
54
+ width: 160px;
55
+ position: absolute;
56
+ left: 8px;
57
+ background-color: #F3F3F3;
58
+ padding: 8px;
59
+ }
60
+
61
+ #content
62
+ {
63
+ margin-left: 190px;
64
+ width: 600px;
65
+ }
66
+
67
+ .classList
68
+ {
69
+ list-style-type: none;
70
+ padding: 0;
71
+ margin: 0 0 0 8px;
72
+ font-family: arial, sans-serif;
73
+ font-size: 1em;
74
+ overflow: auto;
75
+ }
76
+
77
+ .classList li
78
+ {
79
+ padding: 0;
80
+ margin: 0 0 8px 0;
81
+ }
82
+
83
+ .summaryTable { width: 100%; }
84
+
85
+ h1.classTitle
86
+ {
87
+ font-size:170%;
88
+ line-height:130%;
89
+ }
90
+
91
+ h2 { font-size: 110%; }
92
+ caption, div.sectionTitle
93
+ {
94
+ background-color: #7F8FB1;
95
+ color: #fff;
96
+ font-size:130%;
97
+ text-align: left;
98
+ padding: 2px 6px 2px 6px;
99
+ border: 1px #7F8FB1 solid;
100
+ }
101
+
102
+ div.sectionTitle { margin-bottom: 8px; }
103
+ .summaryTable thead { display: none; }
104
+
105
+ .summaryTable td
106
+ {
107
+ vertical-align: top;
108
+ padding: 4px;
109
+ border-bottom: 1px #7F8FB1 solid;
110
+ border-right: 1px #7F8FB1 solid;
111
+ }
112
+
113
+ /*col#summaryAttributes {}*/
114
+ .summaryTable td.attributes
115
+ {
116
+ border-left: 1px #7F8FB1 solid;
117
+ width: 140px;
118
+ text-align: right;
119
+ }
120
+
121
+ td.attributes, .fixedFont
122
+ {
123
+ line-height: 15px;
124
+ color: #002EBE;
125
+ font-family: "Courier New",Courier,monospace;
126
+ font-size: 13px;
127
+ }
128
+
129
+ .summaryTable td.nameDescription
130
+ {
131
+ text-align: left;
132
+ font-size: 13px;
133
+ line-height: 15px;
134
+ }
135
+
136
+ .summaryTable td.nameDescription, .description
137
+ {
138
+ line-height: 15px;
139
+ padding: 4px;
140
+ padding-left: 4px;
141
+ }
142
+
143
+ .summaryTable { margin-bottom: 8px; }
144
+
145
+ ul.inheritsList
146
+ {
147
+ list-style: square;
148
+ margin-left: 20px;
149
+ padding-left: 0;
150
+ }
151
+
152
+ .detailList {
153
+ margin-left: 20px;
154
+ line-height: 15px;
155
+ }
156
+ .detailList dt { margin-left: 20px; }
157
+
158
+ .detailList .heading
159
+ {
160
+ font-weight: bold;
161
+ padding-bottom: 6px;
162
+ margin-left: 0;
163
+ }
164
+
165
+ .light, td.attributes, .light a:link, .light a:visited
166
+ {
167
+ color: #777;
168
+ font-style: italic;
169
+ }
170
+
171
+ .fineprint
172
+ {
173
+ text-align: right;
174
+ font-size: 10px;
175
+ }
176
+ </style>
177
+ </head>
178
+
179
+ <body>
180
+ <!-- ============================== header ================================= -->
181
+ <!-- begin static/header.html -->
182
+ <div id="header">
183
+ </div>
184
+ <!-- end static/header.html -->
185
+
186
+ <!-- ============================== classes index ============================ -->
187
+ <div id="index">
188
+ <!-- begin publish.classesIndex -->
189
+ <div align="center"><a href="../index.html">Class Index</a>
190
+ | <a href="../files.html">File Index</a></div>
191
+ <hr />
192
+ <h2>Classes</h2>
193
+ <ul class="classList">
194
+
195
+ <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
196
+
197
+ <li><a href="../symbols/JSC3D.html">JSC3D</a></li>
198
+
199
+ <li><a href="../symbols/JSC3D.AABB.html">JSC3D.AABB</a></li>
200
+
201
+ <li><a href="../symbols/JSC3D.BinaryStream.html">JSC3D.BinaryStream</a></li>
202
+
203
+ <li><a href="../symbols/JSC3D.LoaderSelector.html">JSC3D.LoaderSelector</a></li>
204
+
205
+ <li><a href="../symbols/JSC3D.Material.html">JSC3D.Material</a></li>
206
+
207
+ <li><a href="../symbols/JSC3D.Math3D.html">JSC3D.Math3D</a></li>
208
+
209
+ <li><a href="../symbols/JSC3D.Matrix3x4.html">JSC3D.Matrix3x4</a></li>
210
+
211
+ <li><a href="../symbols/JSC3D.Mesh.html">JSC3D.Mesh</a></li>
212
+
213
+ <li><a href="../symbols/JSC3D.ObjLoader.html">JSC3D.ObjLoader</a></li>
214
+
215
+ <li><a href="../symbols/JSC3D.PickInfo.html">JSC3D.PickInfo</a></li>
216
+
217
+ <li><a href="../symbols/JSC3D.Scene.html">JSC3D.Scene</a></li>
218
+
219
+ <li><a href="../symbols/JSC3D.StlLoader.html">JSC3D.StlLoader</a></li>
220
+
221
+ <li><a href="../symbols/JSC3D.Texture.html">JSC3D.Texture</a></li>
222
+
223
+ <li><a href="../symbols/JSC3D.Viewer.html">JSC3D.Viewer</a></li>
224
+
225
+ </ul>
226
+ <hr />
227
+ <!-- end publish.classesIndex -->
228
+ </div>
229
+
230
+ <div id="content">
231
+ <!-- ============================== class title ============================ -->
232
+ <h1 class="classTitle">
233
+
234
+ Class JSC3D.AABB
235
+ </h1>
236
+
237
+ <!-- ============================== class summary ========================== -->
238
+ <p class="description">
239
+
240
+
241
+ AABB
242
+
243
+ This class implements the Axis-Aligned Bounding Box to measure spacial enclosure.
244
+
245
+
246
+ <br /><i>Defined in: </i> <a href="../symbols/src/jsc3d.js.html">jsc3d.js</a>.
247
+
248
+ </p>
249
+
250
+ <!-- ============================== constructor summary ==================== -->
251
+
252
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class JSC3D.AABB.">
253
+ <caption>Class Summary</caption>
254
+ <thead>
255
+ <tr>
256
+ <th scope="col">Constructor Attributes</th>
257
+ <th scope="col">Constructor Name and Description</th>
258
+ </tr>
259
+ </thead>
260
+ <tbody>
261
+ <tr>
262
+ <td class="attributes">&nbsp;</td>
263
+ <td class="nameDescription" >
264
+ <div class="fixedFont">
265
+ <b><a href="../symbols/JSC3D.AABB.html">JSC3D.AABB</a></b>()
266
+ </div>
267
+ <div class="description"></div>
268
+ </td>
269
+ </tr>
270
+ </tbody>
271
+ </table>
272
+
273
+
274
+ <!-- ============================== properties summary ===================== -->
275
+
276
+
277
+ <!-- ============================== methods summary ======================== -->
278
+
279
+
280
+
281
+ <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class JSC3D.AABB.">
282
+ <caption>Method Summary</caption>
283
+ <thead>
284
+ <tr>
285
+ <th scope="col">Method Attributes</th>
286
+ <th scope="col">Method Name and Description</th>
287
+ </tr>
288
+ </thead>
289
+ <tbody>
290
+
291
+ <tr>
292
+ <td class="attributes">&nbsp;</td>
293
+ <td class="nameDescription">
294
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.AABB.html#center">center</a></b>()
295
+ </div>
296
+ <div class="description">Get the center coordinates of the AABB.</div>
297
+ </td>
298
+ </tr>
299
+
300
+ <tr>
301
+ <td class="attributes">&nbsp;</td>
302
+ <td class="nameDescription">
303
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.AABB.html#lengthOfDiagonal">lengthOfDiagonal</a></b>()
304
+ </div>
305
+ <div class="description">Get the length of the diagonal of the AABB.</div>
306
+ </td>
307
+ </tr>
308
+
309
+ </tbody>
310
+ </table>
311
+
312
+
313
+
314
+
315
+ <!-- ============================== events summary ======================== -->
316
+
317
+
318
+ <!-- ============================== constructor details ==================== -->
319
+
320
+ <div class="details"><a name="constructor"> </a>
321
+ <div class="sectionTitle">
322
+ Class Detail
323
+ </div>
324
+
325
+ <div class="fixedFont">
326
+ <b>JSC3D.AABB</b>()
327
+ </div>
328
+
329
+ <div class="description">
330
+
331
+
332
+ </div>
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+ </div>
346
+
347
+
348
+ <!-- ============================== field details ========================== -->
349
+
350
+
351
+ <!-- ============================== method details ========================= -->
352
+
353
+ <div class="sectionTitle">
354
+ Method Detail
355
+ </div>
356
+
357
+ <a name="center"> </a>
358
+ <div class="fixedFont">
359
+
360
+ <span class="light">{Array}</span>
361
+ <b>center</b>()
362
+
363
+ </div>
364
+ <div class="description">
365
+ Get the center coordinates of the AABB.
366
+
367
+
368
+ </div>
369
+
370
+
371
+
372
+
373
+
374
+
375
+
376
+
377
+ <dl class="detailList">
378
+ <dt class="heading">Returns:</dt>
379
+
380
+ <dd><span class="light fixedFont">{Array}</span> center coordinates as an array.</dd>
381
+
382
+ </dl>
383
+
384
+
385
+
386
+
387
+ <hr />
388
+
389
+ <a name="lengthOfDiagonal"> </a>
390
+ <div class="fixedFont">
391
+
392
+ <span class="light">{Number}</span>
393
+ <b>lengthOfDiagonal</b>()
394
+
395
+ </div>
396
+ <div class="description">
397
+ Get the length of the diagonal of the AABB.
398
+
399
+
400
+ </div>
401
+
402
+
403
+
404
+
405
+
406
+
407
+
408
+
409
+ <dl class="detailList">
410
+ <dt class="heading">Returns:</dt>
411
+
412
+ <dd><span class="light fixedFont">{Number}</span> length of the diagonal.</dd>
413
+
414
+ </dl>
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+ <!-- ============================== event details ========================= -->
424
+
425
+
426
+ <hr />
427
+ </div>
428
+
429
+
430
+ <!-- ============================== footer ================================= -->
431
+ <div class="fineprint" style="clear:both">
432
+
433
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sat Oct 13 2012 19:21:53 GMT+0800 (CST)
434
+ </div>
435
+ </body>
436
+ </html>
@@ -0,0 +1,1051 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="content-type" content="text/html; charset=utf-8" />
6
+ <meta name="generator" content="JsDoc Toolkit" />
7
+
8
+ <title>JsDoc Reference - JSC3D.BinaryStream</title>
9
+
10
+ <style type="text/css">
11
+ /* default.css */
12
+
13
+
14
+ body
15
+ {
16
+ font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
17
+ width: 800px;
18
+ }
19
+
20
+ .header
21
+ {
22
+ clear: both;
23
+ background-color: #ccc;
24
+ padding: 8px;
25
+ }
26
+
27
+ h1
28
+ {
29
+ font-size: 150%;
30
+ font-weight: bold;
31
+ padding: 0;
32
+ margin: 1em 0 0 .3em;
33
+ }
34
+
35
+ hr
36
+ {
37
+ border: none 0;
38
+ border-top: 1px solid #7F8FB1;
39
+ height: 1px;
40
+ }
41
+
42
+ pre.code
43
+ {
44
+ display: inline;
45
+ // padding: 8px;
46
+ // border: 1px dashed #ccc;
47
+ background-color: #4AA02C;
48
+ }
49
+
50
+ #index
51
+ {
52
+ margin-top: 24px;
53
+ float: left;
54
+ width: 160px;
55
+ position: absolute;
56
+ left: 8px;
57
+ background-color: #F3F3F3;
58
+ padding: 8px;
59
+ }
60
+
61
+ #content
62
+ {
63
+ margin-left: 190px;
64
+ width: 600px;
65
+ }
66
+
67
+ .classList
68
+ {
69
+ list-style-type: none;
70
+ padding: 0;
71
+ margin: 0 0 0 8px;
72
+ font-family: arial, sans-serif;
73
+ font-size: 1em;
74
+ overflow: auto;
75
+ }
76
+
77
+ .classList li
78
+ {
79
+ padding: 0;
80
+ margin: 0 0 8px 0;
81
+ }
82
+
83
+ .summaryTable { width: 100%; }
84
+
85
+ h1.classTitle
86
+ {
87
+ font-size:170%;
88
+ line-height:130%;
89
+ }
90
+
91
+ h2 { font-size: 110%; }
92
+ caption, div.sectionTitle
93
+ {
94
+ background-color: #7F8FB1;
95
+ color: #fff;
96
+ font-size:130%;
97
+ text-align: left;
98
+ padding: 2px 6px 2px 6px;
99
+ border: 1px #7F8FB1 solid;
100
+ }
101
+
102
+ div.sectionTitle { margin-bottom: 8px; }
103
+ .summaryTable thead { display: none; }
104
+
105
+ .summaryTable td
106
+ {
107
+ vertical-align: top;
108
+ padding: 4px;
109
+ border-bottom: 1px #7F8FB1 solid;
110
+ border-right: 1px #7F8FB1 solid;
111
+ }
112
+
113
+ /*col#summaryAttributes {}*/
114
+ .summaryTable td.attributes
115
+ {
116
+ border-left: 1px #7F8FB1 solid;
117
+ width: 140px;
118
+ text-align: right;
119
+ }
120
+
121
+ td.attributes, .fixedFont
122
+ {
123
+ line-height: 15px;
124
+ color: #002EBE;
125
+ font-family: "Courier New",Courier,monospace;
126
+ font-size: 13px;
127
+ }
128
+
129
+ .summaryTable td.nameDescription
130
+ {
131
+ text-align: left;
132
+ font-size: 13px;
133
+ line-height: 15px;
134
+ }
135
+
136
+ .summaryTable td.nameDescription, .description
137
+ {
138
+ line-height: 15px;
139
+ padding: 4px;
140
+ padding-left: 4px;
141
+ }
142
+
143
+ .summaryTable { margin-bottom: 8px; }
144
+
145
+ ul.inheritsList
146
+ {
147
+ list-style: square;
148
+ margin-left: 20px;
149
+ padding-left: 0;
150
+ }
151
+
152
+ .detailList {
153
+ margin-left: 20px;
154
+ line-height: 15px;
155
+ }
156
+ .detailList dt { margin-left: 20px; }
157
+
158
+ .detailList .heading
159
+ {
160
+ font-weight: bold;
161
+ padding-bottom: 6px;
162
+ margin-left: 0;
163
+ }
164
+
165
+ .light, td.attributes, .light a:link, .light a:visited
166
+ {
167
+ color: #777;
168
+ font-style: italic;
169
+ }
170
+
171
+ .fineprint
172
+ {
173
+ text-align: right;
174
+ font-size: 10px;
175
+ }
176
+ </style>
177
+ </head>
178
+
179
+ <body>
180
+ <!-- ============================== header ================================= -->
181
+ <!-- begin static/header.html -->
182
+ <div id="header">
183
+ </div>
184
+ <!-- end static/header.html -->
185
+
186
+ <!-- ============================== classes index ============================ -->
187
+ <div id="index">
188
+ <!-- begin publish.classesIndex -->
189
+ <div align="center"><a href="../index.html">Class Index</a>
190
+ | <a href="../files.html">File Index</a></div>
191
+ <hr />
192
+ <h2>Classes</h2>
193
+ <ul class="classList">
194
+
195
+ <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
196
+
197
+ <li><a href="../symbols/JSC3D.html">JSC3D</a></li>
198
+
199
+ <li><a href="../symbols/JSC3D.AABB.html">JSC3D.AABB</a></li>
200
+
201
+ <li><a href="../symbols/JSC3D.BinaryStream.html">JSC3D.BinaryStream</a></li>
202
+
203
+ <li><a href="../symbols/JSC3D.LoaderSelector.html">JSC3D.LoaderSelector</a></li>
204
+
205
+ <li><a href="../symbols/JSC3D.Material.html">JSC3D.Material</a></li>
206
+
207
+ <li><a href="../symbols/JSC3D.Math3D.html">JSC3D.Math3D</a></li>
208
+
209
+ <li><a href="../symbols/JSC3D.Matrix3x4.html">JSC3D.Matrix3x4</a></li>
210
+
211
+ <li><a href="../symbols/JSC3D.Mesh.html">JSC3D.Mesh</a></li>
212
+
213
+ <li><a href="../symbols/JSC3D.ObjLoader.html">JSC3D.ObjLoader</a></li>
214
+
215
+ <li><a href="../symbols/JSC3D.PickInfo.html">JSC3D.PickInfo</a></li>
216
+
217
+ <li><a href="../symbols/JSC3D.Scene.html">JSC3D.Scene</a></li>
218
+
219
+ <li><a href="../symbols/JSC3D.StlLoader.html">JSC3D.StlLoader</a></li>
220
+
221
+ <li><a href="../symbols/JSC3D.Texture.html">JSC3D.Texture</a></li>
222
+
223
+ <li><a href="../symbols/JSC3D.Viewer.html">JSC3D.Viewer</a></li>
224
+
225
+ </ul>
226
+ <hr />
227
+ <!-- end publish.classesIndex -->
228
+ </div>
229
+
230
+ <div id="content">
231
+ <!-- ============================== class title ============================ -->
232
+ <h1 class="classTitle">
233
+
234
+ Class JSC3D.BinaryStream
235
+ </h1>
236
+
237
+ <!-- ============================== class summary ========================== -->
238
+ <p class="description">
239
+
240
+
241
+ BinaryStream
242
+ The helper class to parse data from a binary stream.
243
+
244
+
245
+ <br /><i>Defined in: </i> <a href="../symbols/src/jsc3d.js.html">jsc3d.js</a>.
246
+
247
+ </p>
248
+
249
+ <!-- ============================== constructor summary ==================== -->
250
+
251
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class JSC3D.BinaryStream.">
252
+ <caption>Class Summary</caption>
253
+ <thead>
254
+ <tr>
255
+ <th scope="col">Constructor Attributes</th>
256
+ <th scope="col">Constructor Name and Description</th>
257
+ </tr>
258
+ </thead>
259
+ <tbody>
260
+ <tr>
261
+ <td class="attributes">&nbsp;</td>
262
+ <td class="nameDescription" >
263
+ <div class="fixedFont">
264
+ <b><a href="../symbols/JSC3D.BinaryStream.html">JSC3D.BinaryStream</a></b>(data, isBigEndian)
265
+ </div>
266
+ <div class="description"></div>
267
+ </td>
268
+ </tr>
269
+ </tbody>
270
+ </table>
271
+
272
+
273
+ <!-- ============================== properties summary ===================== -->
274
+
275
+
276
+ <!-- ============================== methods summary ======================== -->
277
+
278
+
279
+
280
+ <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class JSC3D.BinaryStream.">
281
+ <caption>Method Summary</caption>
282
+ <thead>
283
+ <tr>
284
+ <th scope="col">Method Attributes</th>
285
+ <th scope="col">Method Name and Description</th>
286
+ </tr>
287
+ </thead>
288
+ <tbody>
289
+
290
+ <tr>
291
+ <td class="attributes">&nbsp;</td>
292
+ <td class="nameDescription">
293
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#available">available</a></b>()
294
+ </div>
295
+ <div class="description">Get count of the remaining bytes in the stream.</div>
296
+ </td>
297
+ </tr>
298
+
299
+ <tr>
300
+ <td class="attributes">&nbsp;</td>
301
+ <td class="nameDescription">
302
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#eof">eof</a></b>()
303
+ </div>
304
+ <div class="description">See if the position indicator is already at the end of the stream.</div>
305
+ </td>
306
+ </tr>
307
+
308
+ <tr>
309
+ <td class="attributes">&nbsp;</td>
310
+ <td class="nameDescription">
311
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#readBytes">readBytes</a></b>(buffer, bytesToRead)
312
+ </div>
313
+ <div class="description">Read a piece of the stream into a given buffer.</div>
314
+ </td>
315
+ </tr>
316
+
317
+ <tr>
318
+ <td class="attributes">&nbsp;</td>
319
+ <td class="nameDescription">
320
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#readFloat32">readFloat32</a></b>()
321
+ </div>
322
+ <div class="description">Read a 32-bits' (IEEE 754) floating point number.</div>
323
+ </td>
324
+ </tr>
325
+
326
+ <tr>
327
+ <td class="attributes">&nbsp;</td>
328
+ <td class="nameDescription">
329
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#readFloat64">readFloat64</a></b>()
330
+ </div>
331
+ <div class="description">Read a 64-bits' (IEEE 754) floating point number.</div>
332
+ </td>
333
+ </tr>
334
+
335
+ <tr>
336
+ <td class="attributes">&nbsp;</td>
337
+ <td class="nameDescription">
338
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#readInt16">readInt16</a></b>()
339
+ </div>
340
+ <div class="description">Read a 16-bits' signed int number.</div>
341
+ </td>
342
+ </tr>
343
+
344
+ <tr>
345
+ <td class="attributes">&nbsp;</td>
346
+ <td class="nameDescription">
347
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#readInt32">readInt32</a></b>()
348
+ </div>
349
+ <div class="description">Read a 32-bits' signed int number.</div>
350
+ </td>
351
+ </tr>
352
+
353
+ <tr>
354
+ <td class="attributes">&nbsp;</td>
355
+ <td class="nameDescription">
356
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#readInt8">readInt8</a></b>()
357
+ </div>
358
+ <div class="description">Read an 8-bits' signed int number.</div>
359
+ </td>
360
+ </tr>
361
+
362
+ <tr>
363
+ <td class="attributes">&nbsp;</td>
364
+ <td class="nameDescription">
365
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#readUInt16">readUInt16</a></b>()
366
+ </div>
367
+ <div class="description">Read a 16-bits' unsigned int number.</div>
368
+ </td>
369
+ </tr>
370
+
371
+ <tr>
372
+ <td class="attributes">&nbsp;</td>
373
+ <td class="nameDescription">
374
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#readUInt32">readUInt32</a></b>()
375
+ </div>
376
+ <div class="description">Read a 32-bits' unsigned int number.</div>
377
+ </td>
378
+ </tr>
379
+
380
+ <tr>
381
+ <td class="attributes">&nbsp;</td>
382
+ <td class="nameDescription">
383
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#readUInt8">readUInt8</a></b>()
384
+ </div>
385
+ <div class="description">Read an 8-bits' unsigned int number.</div>
386
+ </td>
387
+ </tr>
388
+
389
+ <tr>
390
+ <td class="attributes">&nbsp;</td>
391
+ <td class="nameDescription">
392
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#reset">reset</a></b>()
393
+ </div>
394
+ <div class="description">Reset the position indicator to the beginning of the stream.</div>
395
+ </td>
396
+ </tr>
397
+
398
+ <tr>
399
+ <td class="attributes">&nbsp;</td>
400
+ <td class="nameDescription">
401
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#seek">seek</a></b>(position)
402
+ </div>
403
+ <div class="description">Set the position indicator of the stream to a new position.</div>
404
+ </td>
405
+ </tr>
406
+
407
+ <tr>
408
+ <td class="attributes">&nbsp;</td>
409
+ <td class="nameDescription">
410
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#size">size</a></b>()
411
+ </div>
412
+ <div class="description">Get the full length (in bytes) of the stream.</div>
413
+ </td>
414
+ </tr>
415
+
416
+ <tr>
417
+ <td class="attributes">&nbsp;</td>
418
+ <td class="nameDescription">
419
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#skip">skip</a></b>(bytesToSkip)
420
+ </div>
421
+ <div class="description">Advance the position indicator to skip a given number of bytes.</div>
422
+ </td>
423
+ </tr>
424
+
425
+ <tr>
426
+ <td class="attributes">&nbsp;</td>
427
+ <td class="nameDescription">
428
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.BinaryStream.html#tell">tell</a></b>()
429
+ </div>
430
+ <div class="description">Get the current position indicator of the stream.</div>
431
+ </td>
432
+ </tr>
433
+
434
+ </tbody>
435
+ </table>
436
+
437
+
438
+
439
+
440
+ <!-- ============================== events summary ======================== -->
441
+
442
+
443
+ <!-- ============================== constructor details ==================== -->
444
+
445
+ <div class="details"><a name="constructor"> </a>
446
+ <div class="sectionTitle">
447
+ Class Detail
448
+ </div>
449
+
450
+ <div class="fixedFont">
451
+ <b>JSC3D.BinaryStream</b>(data, isBigEndian)
452
+ </div>
453
+
454
+ <div class="description">
455
+
456
+
457
+ </div>
458
+
459
+
460
+
461
+
462
+
463
+ <dl class="detailList">
464
+ <dt class="heading">Parameters:</dt>
465
+
466
+ <dt>
467
+ <b>data</b>
468
+
469
+ </dt>
470
+ <dd></dd>
471
+
472
+ <dt>
473
+ <b>isBigEndian</b>
474
+
475
+ </dt>
476
+ <dd></dd>
477
+
478
+ </dl>
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+ </div>
488
+
489
+
490
+ <!-- ============================== field details ========================== -->
491
+
492
+
493
+ <!-- ============================== method details ========================= -->
494
+
495
+ <div class="sectionTitle">
496
+ Method Detail
497
+ </div>
498
+
499
+ <a name="available"> </a>
500
+ <div class="fixedFont">
501
+
502
+ <span class="light">{Number}</span>
503
+ <b>available</b>()
504
+
505
+ </div>
506
+ <div class="description">
507
+ Get count of the remaining bytes in the stream.
508
+
509
+
510
+ </div>
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+ <dl class="detailList">
520
+ <dt class="heading">Returns:</dt>
521
+
522
+ <dd><span class="light fixedFont">{Number}</span> the number of bytes from current position to the end of the stream.</dd>
523
+
524
+ </dl>
525
+
526
+
527
+
528
+
529
+ <hr />
530
+
531
+ <a name="eof"> </a>
532
+ <div class="fixedFont">
533
+
534
+ <span class="light">{Boolean}</span>
535
+ <b>eof</b>()
536
+
537
+ </div>
538
+ <div class="description">
539
+ See if the position indicator is already at the end of the stream.
540
+
541
+
542
+ </div>
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+ <dl class="detailList">
552
+ <dt class="heading">Returns:</dt>
553
+
554
+ <dd><span class="light fixedFont">{Boolean}</span> true if the position indicator is at the end of the stream; false if not.</dd>
555
+
556
+ </dl>
557
+
558
+
559
+
560
+
561
+ <hr />
562
+
563
+ <a name="readBytes"> </a>
564
+ <div class="fixedFont">
565
+
566
+ <span class="light">{Number}</span>
567
+ <b>readBytes</b>(buffer, bytesToRead)
568
+
569
+ </div>
570
+ <div class="description">
571
+ Read a piece of the stream into a given buffer.
572
+
573
+
574
+ </div>
575
+
576
+
577
+
578
+
579
+ <dl class="detailList">
580
+ <dt class="heading">Parameters:</dt>
581
+
582
+ <dt>
583
+ <span class="light fixedFont">{Array}</span> <b>buffer</b>
584
+
585
+ </dt>
586
+ <dd>the buffer to receive the result.</dd>
587
+
588
+ <dt>
589
+ <span class="light fixedFont">{Number}</span> <b>bytesToRead</b>
590
+
591
+ </dt>
592
+ <dd>length of the piece to be read, in bytes.</dd>
593
+
594
+ </dl>
595
+
596
+
597
+
598
+
599
+
600
+ <dl class="detailList">
601
+ <dt class="heading">Returns:</dt>
602
+
603
+ <dd><span class="light fixedFont">{Number}</span> the total number of bytes that are successfully read.</dd>
604
+
605
+ </dl>
606
+
607
+
608
+
609
+
610
+ <hr />
611
+
612
+ <a name="readFloat32"> </a>
613
+ <div class="fixedFont">
614
+
615
+ <span class="light">{Number}</span>
616
+ <b>readFloat32</b>()
617
+
618
+ </div>
619
+ <div class="description">
620
+ Read a 32-bits' (IEEE 754) floating point number.
621
+
622
+
623
+ </div>
624
+
625
+
626
+
627
+
628
+
629
+
630
+
631
+
632
+ <dl class="detailList">
633
+ <dt class="heading">Returns:</dt>
634
+
635
+ <dd><span class="light fixedFont">{Number}</span> a 32-bits' floating point number, or NaN if any error occured.</dd>
636
+
637
+ </dl>
638
+
639
+
640
+
641
+
642
+ <hr />
643
+
644
+ <a name="readFloat64"> </a>
645
+ <div class="fixedFont">
646
+
647
+ <span class="light">{Number}</span>
648
+ <b>readFloat64</b>()
649
+
650
+ </div>
651
+ <div class="description">
652
+ Read a 64-bits' (IEEE 754) floating point number.
653
+
654
+
655
+ </div>
656
+
657
+
658
+
659
+
660
+
661
+
662
+
663
+
664
+ <dl class="detailList">
665
+ <dt class="heading">Returns:</dt>
666
+
667
+ <dd><span class="light fixedFont">{Number}</span> a 64-bits' floating point number, or NaN if any error occured.</dd>
668
+
669
+ </dl>
670
+
671
+
672
+
673
+
674
+ <hr />
675
+
676
+ <a name="readInt16"> </a>
677
+ <div class="fixedFont">
678
+
679
+ <span class="light">{Number}</span>
680
+ <b>readInt16</b>()
681
+
682
+ </div>
683
+ <div class="description">
684
+ Read a 16-bits' signed int number.
685
+
686
+
687
+ </div>
688
+
689
+
690
+
691
+
692
+
693
+
694
+
695
+
696
+ <dl class="detailList">
697
+ <dt class="heading">Returns:</dt>
698
+
699
+ <dd><span class="light fixedFont">{Number}</span> a 16-bits' signed int number, or NaN if any error occured.</dd>
700
+
701
+ </dl>
702
+
703
+
704
+
705
+
706
+ <hr />
707
+
708
+ <a name="readInt32"> </a>
709
+ <div class="fixedFont">
710
+
711
+ <span class="light">{Number}</span>
712
+ <b>readInt32</b>()
713
+
714
+ </div>
715
+ <div class="description">
716
+ Read a 32-bits' signed int number.
717
+
718
+
719
+ </div>
720
+
721
+
722
+
723
+
724
+
725
+
726
+
727
+
728
+ <dl class="detailList">
729
+ <dt class="heading">Returns:</dt>
730
+
731
+ <dd><span class="light fixedFont">{Number}</span> a 32-bits' signed int number, or NaN if any error occured.</dd>
732
+
733
+ </dl>
734
+
735
+
736
+
737
+
738
+ <hr />
739
+
740
+ <a name="readInt8"> </a>
741
+ <div class="fixedFont">
742
+
743
+ <span class="light">{Number}</span>
744
+ <b>readInt8</b>()
745
+
746
+ </div>
747
+ <div class="description">
748
+ Read an 8-bits' signed int number.
749
+
750
+
751
+ </div>
752
+
753
+
754
+
755
+
756
+
757
+
758
+
759
+
760
+ <dl class="detailList">
761
+ <dt class="heading">Returns:</dt>
762
+
763
+ <dd><span class="light fixedFont">{Number}</span> an 8-bits' signed int number, or NaN if any error occured.</dd>
764
+
765
+ </dl>
766
+
767
+
768
+
769
+
770
+ <hr />
771
+
772
+ <a name="readUInt16"> </a>
773
+ <div class="fixedFont">
774
+
775
+ <span class="light">{Number}</span>
776
+ <b>readUInt16</b>()
777
+
778
+ </div>
779
+ <div class="description">
780
+ Read a 16-bits' unsigned int number.
781
+
782
+
783
+ </div>
784
+
785
+
786
+
787
+
788
+
789
+
790
+
791
+
792
+ <dl class="detailList">
793
+ <dt class="heading">Returns:</dt>
794
+
795
+ <dd><span class="light fixedFont">{Number}</span> a 16-bits' unsigned int number, or NaN if any error occured.</dd>
796
+
797
+ </dl>
798
+
799
+
800
+
801
+
802
+ <hr />
803
+
804
+ <a name="readUInt32"> </a>
805
+ <div class="fixedFont">
806
+
807
+ <span class="light">{Number}</span>
808
+ <b>readUInt32</b>()
809
+
810
+ </div>
811
+ <div class="description">
812
+ Read a 32-bits' unsigned int number.
813
+
814
+
815
+ </div>
816
+
817
+
818
+
819
+
820
+
821
+
822
+
823
+
824
+ <dl class="detailList">
825
+ <dt class="heading">Returns:</dt>
826
+
827
+ <dd><span class="light fixedFont">{Number}</span> a 32-bits' unsigned int number, or NaN if any error occured.</dd>
828
+
829
+ </dl>
830
+
831
+
832
+
833
+
834
+ <hr />
835
+
836
+ <a name="readUInt8"> </a>
837
+ <div class="fixedFont">
838
+
839
+ <span class="light">{Number}</span>
840
+ <b>readUInt8</b>()
841
+
842
+ </div>
843
+ <div class="description">
844
+ Read an 8-bits' unsigned int number.
845
+
846
+
847
+ </div>
848
+
849
+
850
+
851
+
852
+
853
+
854
+
855
+
856
+ <dl class="detailList">
857
+ <dt class="heading">Returns:</dt>
858
+
859
+ <dd><span class="light fixedFont">{Number}</span> an 8-bits' unsigned int number, or NaN if any error occured.</dd>
860
+
861
+ </dl>
862
+
863
+
864
+
865
+
866
+ <hr />
867
+
868
+ <a name="reset"> </a>
869
+ <div class="fixedFont">
870
+
871
+
872
+ <b>reset</b>()
873
+
874
+ </div>
875
+ <div class="description">
876
+ Reset the position indicator to the beginning of the stream.
877
+
878
+
879
+ </div>
880
+
881
+
882
+
883
+
884
+
885
+
886
+
887
+
888
+
889
+
890
+
891
+ <hr />
892
+
893
+ <a name="seek"> </a>
894
+ <div class="fixedFont">
895
+
896
+ <span class="light">{Boolean}</span>
897
+ <b>seek</b>(position)
898
+
899
+ </div>
900
+ <div class="description">
901
+ Set the position indicator of the stream to a new position.
902
+
903
+
904
+ </div>
905
+
906
+
907
+
908
+
909
+ <dl class="detailList">
910
+ <dt class="heading">Parameters:</dt>
911
+
912
+ <dt>
913
+ <span class="light fixedFont">{Number}</span> <b>position</b>
914
+
915
+ </dt>
916
+ <dd>the new position.</dd>
917
+
918
+ </dl>
919
+
920
+
921
+
922
+
923
+
924
+ <dl class="detailList">
925
+ <dt class="heading">Returns:</dt>
926
+
927
+ <dd><span class="light fixedFont">{Boolean}</span> true if succeeded; false if the given position is out of range.</dd>
928
+
929
+ </dl>
930
+
931
+
932
+
933
+
934
+ <hr />
935
+
936
+ <a name="size"> </a>
937
+ <div class="fixedFont">
938
+
939
+ <span class="light">{Number}</span>
940
+ <b>size</b>()
941
+
942
+ </div>
943
+ <div class="description">
944
+ Get the full length (in bytes) of the stream.
945
+
946
+
947
+ </div>
948
+
949
+
950
+
951
+
952
+
953
+
954
+
955
+
956
+ <dl class="detailList">
957
+ <dt class="heading">Returns:</dt>
958
+
959
+ <dd><span class="light fixedFont">{Number}</span> the length of the stream.</dd>
960
+
961
+ </dl>
962
+
963
+
964
+
965
+
966
+ <hr />
967
+
968
+ <a name="skip"> </a>
969
+ <div class="fixedFont">
970
+
971
+
972
+ <b>skip</b>(bytesToSkip)
973
+
974
+ </div>
975
+ <div class="description">
976
+ Advance the position indicator to skip a given number of bytes.
977
+
978
+
979
+ </div>
980
+
981
+
982
+
983
+
984
+ <dl class="detailList">
985
+ <dt class="heading">Parameters:</dt>
986
+
987
+ <dt>
988
+ <span class="light fixedFont">{Number}</span> <b>bytesToSkip</b>
989
+
990
+ </dt>
991
+ <dd>the number of bytes to skip.</dd>
992
+
993
+ </dl>
994
+
995
+
996
+
997
+
998
+
999
+
1000
+
1001
+
1002
+ <hr />
1003
+
1004
+ <a name="tell"> </a>
1005
+ <div class="fixedFont">
1006
+
1007
+ <span class="light">{Number}</span>
1008
+ <b>tell</b>()
1009
+
1010
+ </div>
1011
+ <div class="description">
1012
+ Get the current position indicator of the stream.
1013
+
1014
+
1015
+ </div>
1016
+
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+
1023
+
1024
+ <dl class="detailList">
1025
+ <dt class="heading">Returns:</dt>
1026
+
1027
+ <dd><span class="light fixedFont">{Number}</span> current position in stream.</dd>
1028
+
1029
+ </dl>
1030
+
1031
+
1032
+
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+ <!-- ============================== event details ========================= -->
1039
+
1040
+
1041
+ <hr />
1042
+ </div>
1043
+
1044
+
1045
+ <!-- ============================== footer ================================= -->
1046
+ <div class="fineprint" style="clear:both">
1047
+
1048
+ Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sat Oct 13 2012 19:21:53 GMT+0800 (CST)
1049
+ </div>
1050
+ </body>
1051
+ </html>