jsc3d-rails 1.0

Sign up to get free protection for your applications and to get access to all the features.
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,1156 @@
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.Viewer</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.Viewer
235
+ </h1>
236
+
237
+ <!-- ============================== class summary ========================== -->
238
+ <p class="description">
239
+
240
+
241
+ Viewer
242
+
243
+ Viewer is the main class of JSC3D. It provides presentation of and interaction with a simple static 3D scene
244
+ which can either be given as the url of the scene file, or be manually constructed and passed in. It
245
+ also provides some settings to adjust the mode and quality of the rendering.<br /><br />
246
+
247
+ Viewer should be constructed with an existing canvas object where to perform the rendering.<br /><br />
248
+
249
+ Viewer provides 3 way to specify the scene:<br />
250
+ 1. Use setParameter() method before initilization and set 'SceneUrl' parameter with a valid url
251
+ that describes where to load the scene. <br />
252
+ 2. Use replaceSceneFromUrl() method, passing in a valid url to load/replace scene at runtime.<br />
253
+ 3. Use replaceScene() method, passing in a manually constructed scene object to replace the current one
254
+ at runtime.<br />
255
+
256
+
257
+ <br /><i>Defined in: </i> <a href="../symbols/src/jsc3d.js.html">jsc3d.js</a>.
258
+
259
+ </p>
260
+
261
+ <!-- ============================== constructor summary ==================== -->
262
+
263
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class JSC3D.Viewer.">
264
+ <caption>Class Summary</caption>
265
+ <thead>
266
+ <tr>
267
+ <th scope="col">Constructor Attributes</th>
268
+ <th scope="col">Constructor Name and Description</th>
269
+ </tr>
270
+ </thead>
271
+ <tbody>
272
+ <tr>
273
+ <td class="attributes">&nbsp;</td>
274
+ <td class="nameDescription" >
275
+ <div class="fixedFont">
276
+ <b><a href="../symbols/JSC3D.Viewer.html">JSC3D.Viewer</a></b>(canvas, parameters)
277
+ </div>
278
+ <div class="description"></div>
279
+ </td>
280
+ </tr>
281
+ </tbody>
282
+ </table>
283
+
284
+
285
+ <!-- ============================== properties summary ===================== -->
286
+
287
+
288
+ <!-- ============================== methods summary ======================== -->
289
+
290
+
291
+
292
+ <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class JSC3D.Viewer.">
293
+ <caption>Method Summary</caption>
294
+ <thead>
295
+ <tr>
296
+ <th scope="col">Method Attributes</th>
297
+ <th scope="col">Method Name and Description</th>
298
+ </tr>
299
+ </thead>
300
+ <tbody>
301
+
302
+ <tr>
303
+ <td class="attributes">&nbsp;</td>
304
+ <td class="nameDescription">
305
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#enableDefaultInputHandler">enableDefaultInputHandler</a></b>(enabled)
306
+ </div>
307
+ <div class="description">Enable/Disable the default mouse and key event handling routines.</div>
308
+ </td>
309
+ </tr>
310
+
311
+ <tr>
312
+ <td class="attributes">&nbsp;</td>
313
+ <td class="nameDescription">
314
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#getScene">getScene</a></b>()
315
+ </div>
316
+ <div class="description">Get the current scene.</div>
317
+ </td>
318
+ </tr>
319
+
320
+ <tr>
321
+ <td class="attributes">&nbsp;</td>
322
+ <td class="nameDescription">
323
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#init">init</a></b>()
324
+ </div>
325
+ <div class="description">Initialize viewer for rendering and interactions.</div>
326
+ </td>
327
+ </tr>
328
+
329
+ <tr>
330
+ <td class="attributes">&nbsp;</td>
331
+ <td class="nameDescription">
332
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#pick">pick</a></b>(clientX, clientY)
333
+ </div>
334
+ <div class="description">Query information at a given position on the canvas.</div>
335
+ </td>
336
+ </tr>
337
+
338
+ <tr>
339
+ <td class="attributes">&nbsp;</td>
340
+ <td class="nameDescription">
341
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#replaceScene">replaceScene</a></b>(scene)
342
+ </div>
343
+ <div class="description">Replace the current scene with a given scene.</div>
344
+ </td>
345
+ </tr>
346
+
347
+ <tr>
348
+ <td class="attributes">&nbsp;</td>
349
+ <td class="nameDescription">
350
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#replaceSceneFromUrl">replaceSceneFromUrl</a></b>(sceneUrl)
351
+ </div>
352
+ <div class="description">Load a new scene from the given url to replace the current scene.</div>
353
+ </td>
354
+ </tr>
355
+
356
+ <tr>
357
+ <td class="attributes">&nbsp;</td>
358
+ <td class="nameDescription">
359
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#reportError">reportError</a></b>(message)
360
+ </div>
361
+ <div class="description">Show informations about a fatal error.</div>
362
+ </td>
363
+ </tr>
364
+
365
+ <tr>
366
+ <td class="attributes">&nbsp;</td>
367
+ <td class="nameDescription">
368
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#reportProgress">reportProgress</a></b>(task, progress)
369
+ </div>
370
+ <div class="description">Show progress and some informations about current time-cosuming task.</div>
371
+ </td>
372
+ </tr>
373
+
374
+ <tr>
375
+ <td class="attributes">&nbsp;</td>
376
+ <td class="nameDescription">
377
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#rotate">rotate</a></b>(rotX, rotY, rotZ)
378
+ </div>
379
+ <div class="description">Rotate the scene with given angles around Cardinal axes.</div>
380
+ </td>
381
+ </tr>
382
+
383
+ <tr>
384
+ <td class="attributes">&nbsp;</td>
385
+ <td class="nameDescription">
386
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#setBackgroudImageFromUrl">setBackgroudImageFromUrl</a></b>(backgroundImageUrl)
387
+ </div>
388
+ <div class="description">Specify the url for the background image.</div>
389
+ </td>
390
+ </tr>
391
+
392
+ <tr>
393
+ <td class="attributes">&nbsp;</td>
394
+ <td class="nameDescription">
395
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#setDefinition">setDefinition</a></b>(definition)
396
+ </div>
397
+ <div class="description">Set quality level of rendering.</div>
398
+ </td>
399
+ </tr>
400
+
401
+ <tr>
402
+ <td class="attributes">&nbsp;</td>
403
+ <td class="nameDescription">
404
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#setMouseUsage">setMouseUsage</a></b>(usage)
405
+ </div>
406
+ <div class="description">Set control of mouse pointer.</div>
407
+ </td>
408
+ </tr>
409
+
410
+ <tr>
411
+ <td class="attributes">&nbsp;</td>
412
+ <td class="nameDescription">
413
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#setParameter">setParameter</a></b>(name, value)
414
+ </div>
415
+ <div class="description">Set the initial value for a parameter to parameterize the viewer.</div>
416
+ </td>
417
+ </tr>
418
+
419
+ <tr>
420
+ <td class="attributes">&nbsp;</td>
421
+ <td class="nameDescription">
422
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#setRenderMode">setRenderMode</a></b>(mode)
423
+ </div>
424
+ <div class="description">Set render mode.</div>
425
+ </td>
426
+ </tr>
427
+
428
+ <tr>
429
+ <td class="attributes">&nbsp;</td>
430
+ <td class="nameDescription">
431
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#setSphereMapFromUrl">setSphereMapFromUrl</a></b>(sphereMapUrl)
432
+ </div>
433
+ <div class="description">Specify a new image from the given url which will be used for applying sphere mapping.</div>
434
+ </td>
435
+ </tr>
436
+
437
+ <tr>
438
+ <td class="attributes">&nbsp;</td>
439
+ <td class="nameDescription">
440
+ <div class="fixedFont"><b><a href="../symbols/JSC3D.Viewer.html#update">update</a></b>(repaintOnly)
441
+ </div>
442
+ <div class="description">Ask viewer to render a new frame or just repaint last frame.</div>
443
+ </td>
444
+ </tr>
445
+
446
+ </tbody>
447
+ </table>
448
+
449
+
450
+
451
+
452
+ <!-- ============================== events summary ======================== -->
453
+
454
+
455
+ <!-- ============================== constructor details ==================== -->
456
+
457
+ <div class="details"><a name="constructor"> </a>
458
+ <div class="sectionTitle">
459
+ Class Detail
460
+ </div>
461
+
462
+ <div class="fixedFont">
463
+ <b>JSC3D.Viewer</b>(canvas, parameters)
464
+ </div>
465
+
466
+ <div class="description">
467
+
468
+
469
+ </div>
470
+
471
+
472
+
473
+
474
+
475
+ <dl class="detailList">
476
+ <dt class="heading">Parameters:</dt>
477
+
478
+ <dt>
479
+ <b>canvas</b>
480
+
481
+ </dt>
482
+ <dd></dd>
483
+
484
+ <dt>
485
+ <b>parameters</b>
486
+
487
+ </dt>
488
+ <dd></dd>
489
+
490
+ </dl>
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
+
499
+ </div>
500
+
501
+
502
+ <!-- ============================== field details ========================== -->
503
+
504
+
505
+ <!-- ============================== method details ========================= -->
506
+
507
+ <div class="sectionTitle">
508
+ Method Detail
509
+ </div>
510
+
511
+ <a name="enableDefaultInputHandler"> </a>
512
+ <div class="fixedFont">
513
+
514
+
515
+ <b>enableDefaultInputHandler</b>(enabled)
516
+
517
+ </div>
518
+ <div class="description">
519
+ Enable/Disable the default mouse and key event handling routines.
520
+
521
+
522
+ </div>
523
+
524
+
525
+
526
+
527
+ <dl class="detailList">
528
+ <dt class="heading">Parameters:</dt>
529
+
530
+ <dt>
531
+ <span class="light fixedFont">{Boolean}</span> <b>enabled</b>
532
+
533
+ </dt>
534
+ <dd>true to enable the default handler; false to disable them.</dd>
535
+
536
+ </dl>
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+ <hr />
546
+
547
+ <a name="getScene"> </a>
548
+ <div class="fixedFont">
549
+
550
+ <span class="light">{<a href="../symbols/JSC3D.Scene.html">JSC3D.Scene</a>}</span>
551
+ <b>getScene</b>()
552
+
553
+ </div>
554
+ <div class="description">
555
+ Get the current scene.
556
+
557
+
558
+ </div>
559
+
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+ <dl class="detailList">
568
+ <dt class="heading">Returns:</dt>
569
+
570
+ <dd><span class="light fixedFont">{<a href="../symbols/JSC3D.Scene.html">JSC3D.Scene</a>}</span> the current scene.</dd>
571
+
572
+ </dl>
573
+
574
+
575
+
576
+
577
+ <hr />
578
+
579
+ <a name="init"> </a>
580
+ <div class="fixedFont">
581
+
582
+
583
+ <b>init</b>()
584
+
585
+ </div>
586
+ <div class="description">
587
+ Initialize viewer for rendering and interactions.
588
+
589
+
590
+ </div>
591
+
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+
601
+
602
+ <hr />
603
+
604
+ <a name="pick"> </a>
605
+ <div class="fixedFont">
606
+
607
+ <span class="light">{<a href="../symbols/JSC3D.PickInfo.html">JSC3D.PickInfo</a>}</span>
608
+ <b>pick</b>(clientX, clientY)
609
+
610
+ </div>
611
+ <div class="description">
612
+ Query information at a given position on the canvas.
613
+
614
+
615
+ </div>
616
+
617
+
618
+
619
+
620
+ <dl class="detailList">
621
+ <dt class="heading">Parameters:</dt>
622
+
623
+ <dt>
624
+ <span class="light fixedFont">{Number}</span> <b>clientX</b>
625
+
626
+ </dt>
627
+ <dd>client x coordinate on the current page.</dd>
628
+
629
+ <dt>
630
+ <span class="light fixedFont">{Number}</span> <b>clientY</b>
631
+
632
+ </dt>
633
+ <dd>client y coordinate on the current page.</dd>
634
+
635
+ </dl>
636
+
637
+
638
+
639
+
640
+
641
+ <dl class="detailList">
642
+ <dt class="heading">Returns:</dt>
643
+
644
+ <dd><span class="light fixedFont">{<a href="../symbols/JSC3D.PickInfo.html">JSC3D.PickInfo</a>}</span> a PickInfo object which holds the result.</dd>
645
+
646
+ </dl>
647
+
648
+
649
+
650
+
651
+ <hr />
652
+
653
+ <a name="replaceScene"> </a>
654
+ <div class="fixedFont">
655
+
656
+
657
+ <b>replaceScene</b>(scene)
658
+
659
+ </div>
660
+ <div class="description">
661
+ Replace the current scene with a given scene.
662
+
663
+
664
+ </div>
665
+
666
+
667
+
668
+
669
+ <dl class="detailList">
670
+ <dt class="heading">Parameters:</dt>
671
+
672
+ <dt>
673
+ <span class="light fixedFont">{<a href="../symbols/JSC3D.Scene.html">JSC3D.Scene</a>}</span> <b>scene</b>
674
+
675
+ </dt>
676
+ <dd>the given scene.</dd>
677
+
678
+ </dl>
679
+
680
+
681
+
682
+
683
+
684
+
685
+
686
+
687
+ <hr />
688
+
689
+ <a name="replaceSceneFromUrl"> </a>
690
+ <div class="fixedFont">
691
+
692
+
693
+ <b>replaceSceneFromUrl</b>(sceneUrl)
694
+
695
+ </div>
696
+ <div class="description">
697
+ Load a new scene from the given url to replace the current scene.
698
+
699
+
700
+ </div>
701
+
702
+
703
+
704
+
705
+ <dl class="detailList">
706
+ <dt class="heading">Parameters:</dt>
707
+
708
+ <dt>
709
+ <span class="light fixedFont">{String}</span> <b>sceneUrl</b>
710
+
711
+ </dt>
712
+ <dd>url string that describes where to load the new scene.</dd>
713
+
714
+ </dl>
715
+
716
+
717
+
718
+
719
+
720
+
721
+
722
+
723
+ <hr />
724
+
725
+ <a name="reportError"> </a>
726
+ <div class="fixedFont">
727
+
728
+
729
+ <b>reportError</b>(message)
730
+
731
+ </div>
732
+ <div class="description">
733
+ Show informations about a fatal error.
734
+
735
+
736
+ </div>
737
+
738
+
739
+
740
+
741
+ <dl class="detailList">
742
+ <dt class="heading">Parameters:</dt>
743
+
744
+ <dt>
745
+ <span class="light fixedFont">{String}</span> <b>message</b>
746
+
747
+ </dt>
748
+ <dd>text information about this error.</dd>
749
+
750
+ </dl>
751
+
752
+
753
+
754
+
755
+
756
+
757
+
758
+
759
+ <hr />
760
+
761
+ <a name="reportProgress"> </a>
762
+ <div class="fixedFont">
763
+
764
+
765
+ <b>reportProgress</b>(task, progress)
766
+
767
+ </div>
768
+ <div class="description">
769
+ Show progress and some informations about current time-cosuming task.
770
+
771
+
772
+ </div>
773
+
774
+
775
+
776
+
777
+ <dl class="detailList">
778
+ <dt class="heading">Parameters:</dt>
779
+
780
+ <dt>
781
+ <span class="light fixedFont">{String}</span> <b>task</b>
782
+
783
+ </dt>
784
+ <dd>text information about current task.</dd>
785
+
786
+ <dt>
787
+ <span class="light fixedFont">{Number}</span> <b>progress</b>
788
+
789
+ </dt>
790
+ <dd>progress of current task. this should be a number between 0 and 1.</dd>
791
+
792
+ </dl>
793
+
794
+
795
+
796
+
797
+
798
+
799
+
800
+
801
+ <hr />
802
+
803
+ <a name="rotate"> </a>
804
+ <div class="fixedFont">
805
+
806
+
807
+ <b>rotate</b>(rotX, rotY, rotZ)
808
+
809
+ </div>
810
+ <div class="description">
811
+ Rotate the scene with given angles around Cardinal axes.
812
+
813
+
814
+ </div>
815
+
816
+
817
+
818
+
819
+ <dl class="detailList">
820
+ <dt class="heading">Parameters:</dt>
821
+
822
+ <dt>
823
+ <span class="light fixedFont">{Number}</span> <b>rotX</b>
824
+
825
+ </dt>
826
+ <dd>rotation angle around X-axis in degrees.</dd>
827
+
828
+ <dt>
829
+ <span class="light fixedFont">{Number}</span> <b>rotY</b>
830
+
831
+ </dt>
832
+ <dd>rotation angle around Y-axis in degrees.</dd>
833
+
834
+ <dt>
835
+ <span class="light fixedFont">{Number}</span> <b>rotZ</b>
836
+
837
+ </dt>
838
+ <dd>rotation angle around Z-axis in degrees.</dd>
839
+
840
+ </dl>
841
+
842
+
843
+
844
+
845
+
846
+
847
+
848
+
849
+ <hr />
850
+
851
+ <a name="setBackgroudImageFromUrl"> </a>
852
+ <div class="fixedFont">
853
+
854
+
855
+ <b>setBackgroudImageFromUrl</b>(backgroundImageUrl)
856
+
857
+ </div>
858
+ <div class="description">
859
+ Specify the url for the background image.
860
+
861
+
862
+ </div>
863
+
864
+
865
+
866
+
867
+ <dl class="detailList">
868
+ <dt class="heading">Parameters:</dt>
869
+
870
+ <dt>
871
+ <span class="light fixedFont">{String}</span> <b>backgroundImageUrl</b>
872
+
873
+ </dt>
874
+ <dd>url string for the background image.</dd>
875
+
876
+ </dl>
877
+
878
+
879
+
880
+
881
+
882
+
883
+
884
+
885
+ <hr />
886
+
887
+ <a name="setDefinition"> </a>
888
+ <div class="fixedFont">
889
+
890
+
891
+ <b>setDefinition</b>(definition)
892
+
893
+ </div>
894
+ <div class="description">
895
+ Set quality level of rendering.<br />
896
+ Available quality levels are:<br />
897
+ '<b>low</b>': low-quality rendering will be applied, with highest performance;<br />
898
+ '<b>standard</b>': normal-quality rendering will be applied, with modest performace;<br />
899
+ '<b>high</b>': high-quality rendering will be applied, with lowest performace.<br />
900
+
901
+
902
+ </div>
903
+
904
+
905
+
906
+
907
+ <dl class="detailList">
908
+ <dt class="heading">Parameters:</dt>
909
+
910
+ <dt>
911
+ <b>definition</b>
912
+
913
+ </dt>
914
+ <dd></dd>
915
+
916
+ </dl>
917
+
918
+
919
+
920
+
921
+
922
+
923
+
924
+
925
+ <hr />
926
+
927
+ <a name="setMouseUsage"> </a>
928
+ <div class="fixedFont">
929
+
930
+
931
+ <b>setMouseUsage</b>(usage)
932
+
933
+ </div>
934
+ <div class="description">
935
+ Set control of mouse pointer.
936
+ Available options are:<br />
937
+ '<b>default</b>': default mouse control will be used;<br />
938
+ '<b>free</b>': this tells {JSC3D.Viewer} a user-defined mouse control will be adopted.
939
+ This is often used together with viewer.enableDefaultInputHandler(false)
940
+ and viewer.onmousedown, viewer.onmouseup and/or viewer.onmousemove overridden.<br />
941
+ '<b>rotate</b>': mouse will be used to rotate the scene;<br />
942
+ '<b>zoom</b>': mouse will be used to do zooming.<br />
943
+
944
+
945
+ </div>
946
+
947
+
948
+
949
+
950
+ <dl class="detailList">
951
+ <dt class="heading">Parameters:</dt>
952
+
953
+ <dt>
954
+ <span class="light fixedFont">{String}</span> <b>usage</b>
955
+
956
+ </dt>
957
+ <dd>control of mouse pointer to be set.</dd>
958
+
959
+ </dl>
960
+
961
+
962
+
963
+
964
+
965
+
966
+
967
+
968
+ <hr />
969
+
970
+ <a name="setParameter"> </a>
971
+ <div class="fixedFont">
972
+
973
+
974
+ <b>setParameter</b>(name, value)
975
+
976
+ </div>
977
+ <div class="description">
978
+ Set the initial value for a parameter to parameterize the viewer.<br />
979
+ Available parameters are:<br />
980
+ '<b>SceneUrl</b>': url string that describes where to load the scene, default to '';<br />
981
+ '<b>InitRotationX</b>': initial rotation angle around x-axis for the whole scene, default to 0;<br />
982
+ '<b>InitRotationY</b>': initial rotation angle around y-axis for the whole scene, default to 0;<br />
983
+ '<b>InitRotationZ</b>': initial rotation angle around z-axis for the whole scene, default to 0;<br />
984
+ '<b>ModelColor</b>': fallback color for all meshes, default to '#caa618';<br />
985
+ '<b>BackgroundColor1</b>': color at the top of the background, default to '#ffffff';<br />
986
+ '<b>BackgroundColor2</b>': color at the bottom of the background, default to '#383840';<br />
987
+ '<b>BackgroundImageUrl</b>': url string that describes where to load the image used for background, default to '';<br />
988
+ '<b>RenderMode</b>': render mode, default to 'flat';<br />
989
+ '<b>Definition</b>': quality level of rendering, default to 'standard';<br />
990
+ '<b>MipMapping</b>': turn on/off mip-mapping, default to 'off';<br />
991
+ '<b>SphereMapUrl</b>': url string that describes where to load the image used for sphere mapping, default to ''.<br />
992
+
993
+
994
+ </div>
995
+
996
+
997
+
998
+
999
+ <dl class="detailList">
1000
+ <dt class="heading">Parameters:</dt>
1001
+
1002
+ <dt>
1003
+ <span class="light fixedFont">{String}</span> <b>name</b>
1004
+
1005
+ </dt>
1006
+ <dd>name of the parameter to set.</dd>
1007
+
1008
+ <dt>
1009
+ <b>value</b>
1010
+
1011
+ </dt>
1012
+ <dd>new value for the parameter.</dd>
1013
+
1014
+ </dl>
1015
+
1016
+
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+
1023
+ <hr />
1024
+
1025
+ <a name="setRenderMode"> </a>
1026
+ <div class="fixedFont">
1027
+
1028
+
1029
+ <b>setRenderMode</b>(mode)
1030
+
1031
+ </div>
1032
+ <div class="description">
1033
+ Set render mode.<br />
1034
+ Available render modes are:<br />
1035
+ '<b>point</b>': render meshes as point clouds;<br />
1036
+ '<b>wireframe</b>': render meshes as wireframe;<br />
1037
+ '<b>flat</b>': render meshes as solid objects using flat shading;<br />
1038
+ '<b>smooth</b>': render meshes as solid objects using smooth shading;<br />
1039
+ '<b>texture</b>': render meshes as solid textured objects, no lighting will be apllied;<br />
1040
+ '<b>textureflat</b>': render meshes as solid textured objects, lighting will be calculated per face;<br />
1041
+ '<b>texturesmooth</b>': render meshes as solid textured objects, lighting will be calculated per vertex and interpolated.<br />
1042
+
1043
+
1044
+ </div>
1045
+
1046
+
1047
+
1048
+
1049
+ <dl class="detailList">
1050
+ <dt class="heading">Parameters:</dt>
1051
+
1052
+ <dt>
1053
+ <span class="light fixedFont">{String}</span> <b>mode</b>
1054
+
1055
+ </dt>
1056
+ <dd>new render mode.</dd>
1057
+
1058
+ </dl>
1059
+
1060
+
1061
+
1062
+
1063
+
1064
+
1065
+
1066
+
1067
+ <hr />
1068
+
1069
+ <a name="setSphereMapFromUrl"> </a>
1070
+ <div class="fixedFont">
1071
+
1072
+
1073
+ <b>setSphereMapFromUrl</b>(sphereMapUrl)
1074
+
1075
+ </div>
1076
+ <div class="description">
1077
+ Specify a new image from the given url which will be used for applying sphere mapping.
1078
+
1079
+
1080
+ </div>
1081
+
1082
+
1083
+
1084
+
1085
+ <dl class="detailList">
1086
+ <dt class="heading">Parameters:</dt>
1087
+
1088
+ <dt>
1089
+ <span class="light fixedFont">{String}</span> <b>sphereMapUrl</b>
1090
+
1091
+ </dt>
1092
+ <dd>url string that describes where to load the image.</dd>
1093
+
1094
+ </dl>
1095
+
1096
+
1097
+
1098
+
1099
+
1100
+
1101
+
1102
+
1103
+ <hr />
1104
+
1105
+ <a name="update"> </a>
1106
+ <div class="fixedFont">
1107
+
1108
+
1109
+ <b>update</b>(repaintOnly)
1110
+
1111
+ </div>
1112
+ <div class="description">
1113
+ Ask viewer to render a new frame or just repaint last frame.
1114
+
1115
+
1116
+ </div>
1117
+
1118
+
1119
+
1120
+
1121
+ <dl class="detailList">
1122
+ <dt class="heading">Parameters:</dt>
1123
+
1124
+ <dt>
1125
+ <span class="light fixedFont">{Boolean}</span> <b>repaintOnly</b>
1126
+
1127
+ </dt>
1128
+ <dd>true to repaint last frame; false(default) to render a new frame.</dd>
1129
+
1130
+ </dl>
1131
+
1132
+
1133
+
1134
+
1135
+
1136
+
1137
+
1138
+
1139
+
1140
+
1141
+
1142
+
1143
+ <!-- ============================== event details ========================= -->
1144
+
1145
+
1146
+ <hr />
1147
+ </div>
1148
+
1149
+
1150
+ <!-- ============================== footer ================================= -->
1151
+ <div class="fineprint" style="clear:both">
1152
+
1153
+ 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)
1154
+ </div>
1155
+ </body>
1156
+ </html>