index.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>three.js - documentation</title>
  6. <style>
  7. body {
  8. margin: 0;
  9. padding: 0;
  10. color: #555;
  11. font-family: Arial, sans-serif;
  12. font-size: 15px;
  13. overflow: hidden;
  14. }
  15. a {
  16. color: #2194CE;
  17. }
  18. #panel {
  19. position: fixed;
  20. width: 260px;
  21. overflow: auto;
  22. }
  23. #panel h1 {
  24. color: #999;
  25. font-size: 16px;
  26. margin-top: 16px;
  27. margin-left: 20px;
  28. }
  29. #panel ul {
  30. list-style-type: none;
  31. padding: 0px;
  32. margin-left: 20px;
  33. }
  34. #viewer {
  35. overflow: auto;
  36. }
  37. #viewer h1 {
  38. color: #444;
  39. font-size: 25px;
  40. margin-top: 10px;
  41. }
  42. #viewer h2 {
  43. color: #8B2;
  44. font-size: 18px;
  45. margin-top: 40px;
  46. }
  47. #viewer h3 {
  48. color: #000;
  49. font-size: 16px;
  50. margin-top: 30px;
  51. font-weight: normal;
  52. }
  53. #viewer div {
  54. padding-left: 30px;
  55. margin-bottom: 20px;
  56. }
  57. #viewer div.desc {
  58. padding-left: 0px;
  59. }
  60. #viewer pre, code {
  61. margin-top: 20px;
  62. margin-bottom: 20px;
  63. }
  64. #viewer code {
  65. display: block;
  66. width: 90%;
  67. padding: 20px;
  68. white-space: pre;
  69. background-color: #f9f9f9;
  70. overflow: auto;
  71. }
  72. </style>
  73. </head>
  74. <body>
  75. <div id="panel"></div>
  76. <div id="viewer"></div>
  77. <script>
  78. var panel = document.getElementById( 'panel' );
  79. var viewer = document.getElementById( 'viewer' );
  80. var pages = {
  81. "Integer": "Integer",
  82. "Float": "Float",
  83. "Array": "Array"
  84. };
  85. var list = {
  86. "Cameras": [
  87. { name: "Camera", path: "cameras/Camera" },
  88. { name: "OrthographicCamera", path: "cameras/OrthographicCamera" },
  89. { name: "PerspectiveCamera", path: "cameras/PerspectiveCamera" }
  90. ],
  91. "Core": [
  92. { name: "Clock", path: "core/Clock" },
  93. { name: "Color", path: "core/Color" },
  94. { name: "Face3", path: "core/Face3" },
  95. { name: "Face4", path: "core/Face4" },
  96. { name: "Frustum", path: "core/Frustum" },
  97. { name: "Geometry", path: "core/Geometry" },
  98. { name: "Math", path: "core/Math" },
  99. { name: "Matrix3", path: "core/Matrix3" },
  100. { name: "Matrix4", path: "core/Matrix4" },
  101. { name: "Object3D", path: "core/Object3D" },
  102. { name: "Projector", path: "core/Projector" },
  103. { name: "Quaternion", path: "core/Quaternion" },
  104. { name: "Ray", path: "core/Ray" },
  105. { name: "Rectangle", path: "core/Rectangle" },
  106. { name: "Spline", path: "core/Spline" },
  107. { name: "UV", path: "core/UV" },
  108. { name: "Vector2", path: "core/Vector2" },
  109. { name: "Vector3", path: "core/Vector3" },
  110. { name: "Vector4", path: "core/Vector4" },
  111. { name: "Vertex", path: "core/Vertex" }
  112. ],
  113. "Lights": [
  114. { name: "AmbientLight", path: "lights/AmbientLight" },
  115. { name: "DirectionalLight", path: "lights/DirectionalLight" },
  116. { name: "Light", path: "lights/Light" },
  117. { name: "PointLight", path: "lights/PointLight" },
  118. { name: "SpotLight", path: "lights/SpotLight" }
  119. ],
  120. "Materials": [
  121. { name: "Material", path: "materials/Material" },
  122. { name: "LineBasicMaterial", path: "materials/LineBasicMaterial" },
  123. { name: "MeshBasicMaterial", path: "materials/MeshBasicMaterial" },
  124. { name: "MeshDepthMaterial", path: "materials/MeshDepthMaterial" },
  125. { name: "MeshFaceMaterial", path: "materials/MeshFaceMaterial" },
  126. { name: "MeshLambertMaterial", path: "materials/MeshLambertMaterial" },
  127. { name: "MeshNormalMaterial", path: "materials/MeshNormalMaterial" },
  128. { name: "MeshPhongMaterial", path: "materials/MeshPhongMaterial" },
  129. { name: "ParticleBasicMaterial", path: "materials/ParticleBasicMaterial" },
  130. { name: "ParticleCanvasMaterial", path: "materials/ParticleCanvasMaterial" },
  131. { name: "ParticleDOMMaterial", path: "materials/ParticleDOMMaterial" },
  132. { name: "ShaderMaterial", path: "materials/ShaderMaterial" }
  133. ],
  134. "Objects": [
  135. { name: "Bone", path: "objects/Bone" },
  136. { name: "Line", path: "objects/Line" },
  137. { name: "LOD", path: "objects/LOD" },
  138. { name: "Mesh", path: "objects/Mesh" },
  139. { name: "MorphAnimMesh", path: "objects/MorphAnimMesh" },
  140. { name: "Particle", path: "objects/Particle" },
  141. { name: "ParticleSystem", path: "objects/ParticleSystem" },
  142. { name: "Ribbon", path: "objects/Ribbon" },
  143. { name: "SkinnedMesh", path: "objects/SkinnedMesh" },
  144. { name: "Sprite", path: "objects/Sprite" }
  145. ],
  146. "Renderers": [
  147. { name: "CanvasRenderer", path: "renderers/CanvasRenderer" },
  148. { name: "DOMRenderer", path: "renderers/DOMRenderer" },
  149. { name: "SVGRenderer", path: "renderers/SVGRenderer" },
  150. { name: "WebGLRenderer", path: "renderers/WebGLRenderer" },
  151. { name: "WebGLRenderTarget", path: "renderers/WebGLRenderTarget" },
  152. { name: "WebGLRenderTargetCube", path: "renderers/WebGLRenderTargetCube" },
  153. { name: "WebGLShaders", path: "renderers/WebGLShaders" }
  154. ],
  155. "Renderers / Renderables": [
  156. { name: "RenderableFace3", path: "renderers/renderables/RenderableFace3" },
  157. { name: "RenderableFace4", path: "renderers/renderables/RenderableFace4" },
  158. { name: "RenderableLine", path: "renderers/renderables/RenderableLine" },
  159. { name: "RenderableObject", path: "renderers/renderables/RenderableObject" },
  160. { name: "RenderableParticle", path: "renderers/renderables/RenderableParticle" },
  161. { name: "RenderableVertex", path: "renderers/renderables/RenderableVertex" }
  162. ],
  163. "Scenes": [
  164. { name: "Fog", path: "scenes/Fog" },
  165. { name: "FogExp2", path: "scenes/FogExp2" },
  166. { name: "Scene", path: "scenes/Scene" }
  167. ],
  168. "Textures": [
  169. { name: "DataTexture", path: "textures/DataTexture" },
  170. { name: "Texture", path: "textures/Texture" }
  171. ],
  172. "Extras": [
  173. { name: "ColorUtils", path: "extras/ColorUtils" },
  174. { name: "GeometryUtils", path: "extras/GeometryUtils" },
  175. { name: "ImageUtils", path: "extras/ImageUtils" },
  176. { name: "SceneUtils", path: "extras/SceneUtils" },
  177. { name: "ShaderUtils", path: "extras/ShaderUtils" }
  178. ],
  179. "Extras / Animation": [
  180. { name: "Animation", path: "extras/animation/Animation" },
  181. { name: "AnimationHandler", path: "extras/animation/AnimationHandler" },
  182. { name: "AnimationMorphTarget", path: "extras/animation/AnimationMorphTarget" },
  183. { name: "KeyFrameAnimation", path: "extras/animation/KeyFrameAnimation" }
  184. ],
  185. "Extras / Cameras": [
  186. { name: "CombinedCamera", path: "extras/cameras/CombinedCamera" },
  187. { name: "CubeCamera", path: "extras/cameras/CubeCamera" }
  188. ],
  189. "Extras / Controls": [
  190. { name: "FirstPersonControls", path: "extras/controls/FirstPersonControls" },
  191. { name: "FlyControls", path: "extras/controls/FlyControls" },
  192. { name: "PathControls", path: "extras/controls/PathControls" },
  193. { name: "RollControls", path: "extras/controls/RollControls" },
  194. { name: "TrackballControls", path: "extras/controls/TrackballControls" }
  195. ],
  196. "Extras / Core": [
  197. { name: "BufferGeometry", path: "extras/core/BufferGeometry" },
  198. { name: "Curve", path: "extras/core/Curve" },
  199. { name: "CurvePath", path: "extras/core/CurvePath" },
  200. { name: "EventTarget", path: "extras/core/EventTarget" },
  201. { name: "Gyroscope", path: "extras/core/Gyroscope" },
  202. { name: "Path", path: "extras/core/Path" },
  203. { name: "Shape", path: "extras/core/Shape" },
  204. { name: "TextPath", path: "extras/core/TextPath" }
  205. ],
  206. "Extras / Geometries": [
  207. { name: "CubeGeometry", path: "extras/geometries/CubeGeometry" },
  208. { name: "CylinderGeometry", path: "extras/geometries/CylinderGeometry" },
  209. { name: "ExtrudeGeometry", path: "extras/geometries/ExtrudeGeometry" },
  210. { name: "IcosahedronGeometry", path: "extras/geometries/IcosahedronGeometry" },
  211. { name: "LatheGeometry", path: "extras/geometries/LatheGeometry" },
  212. { name: "OctahedronGeometry", path: "extras/geometries/OctahedronGeometry" },
  213. { name: "PlaneGeometry", path: "extras/geometries/PlaneGeometry" },
  214. { name: "PolyhedronGeometry", path: "extras/geometries/PolyhedronGeometry" },
  215. { name: "SphereGeometry", path: "extras/geometries/SphereGeometry" },
  216. { name: "TetrahedronGeometry", path: "extras/geometries/TetrahedronGeometry" },
  217. { name: "TextGeometry", path: "extras/geometries/TextGeometry" },
  218. { name: "TorusGeometry", path: "extras/geometries/TorusGeometry" },
  219. { name: "TorusKnotGeometry", path: "extras/geometries/TorusKnotGeometry" }
  220. ],
  221. "Extras / Helpers": [
  222. { name: "AxisHelper", path: "extras/helpers/AxisHelper" },
  223. { name: "CameraHelper", path: "extras/helpers/CameraHelper" }
  224. ],
  225. "Extras / Loaders": [
  226. { name: "BinaryLoader", path: "extras/loaders/BinaryLoader" },
  227. { name: "ColladaLoader", path: "extras/loaders/ColladaLoader" },
  228. { name: "JSONLoader", path: "extras/loaders/JSONLoader" },
  229. { name: "Loader", path: "extras/loaders/Loader" },
  230. { name: "SceneLoader", path: "extras/loaders/SceneLoader" },
  231. { name: "UTF8Loader", path: "extras/loaders/UTF8Loader" }
  232. ],
  233. "Extras / Modifiers": [
  234. { name: "SubdivisionModifier", path: "extras/modifiers/SubdivisionModifier" }
  235. ],
  236. "Extras / Objects": [
  237. { name: "LensFlare", path: "extras/objects/LensFlare" },
  238. { name: "MarchingCubes", path: "extras/objects/MarchingCubes" }
  239. ],
  240. "Extras / Renderers": [
  241. { name: "AnaglyphWebGLRenderer", path: "extras/renderers/AnaglyphWebGLRenderer" },
  242. { name: "CrosseyedWebGLRenderer", path: "extras/renderers/CrosseyedWebGLRenderer" },
  243. { name: "ParallaxBarrierWebGLRenderer", path: "extras/renderers/ParallaxBarrierWebGLRenderer" }
  244. ],
  245. "Extras / Renderers / Plugins": [
  246. { name: "LensFlarePlugin", path: "extras/renderers/plugins/LensFlarePlugin" },
  247. { name: "ShadowMapPlugin", path: "extras/renderers/plugins/ShadowMapPlugin" },
  248. { name: "SpritePlugin", path: "extras/renderers/plugins/SpritePlugin" }
  249. ],
  250. "Extras / Shaders": [
  251. { name: "ShaderFlares", path: "extras/shaders/ShaderFlares" },
  252. { name: "ShaderSprite", path: "extras/shaders/ShaderSprite" }
  253. ]
  254. };
  255. var html = '';
  256. for ( var category in list ) {
  257. html += '<h1>' + category + '</h1>';
  258. html += '<ul>';
  259. for ( var i = 0; i < list[ category ].length; i ++ ) {
  260. var page = list[ category ][ i ];
  261. pages[ page.name ] = page.path;
  262. html += '<li><a href="javascript:goTo(\'' + page.name + '\')">' + page.name + '</a></li>';
  263. }
  264. html += '</ul>';
  265. }
  266. panel.innerHTML += html;
  267. // Page loading
  268. function goTo( name ) {
  269. var path = pages[ name ];
  270. window.location.hash = name;
  271. viewer.innerHTML = '';
  272. var xhr = new XMLHttpRequest();
  273. xhr.open( 'GET', 'api/' + path + '.html', true );
  274. xhr.onreadystatechange = function () {
  275. if ( xhr.readyState == 4 && ( xhr.status == 200 || xhr.status == 0 ) ) {
  276. var text = xhr.responseText;
  277. text = text.replace(/\[name\]/gi, name);
  278. text = text.replace(/\[path\]/gi, path);
  279. text = text.replace(/\[page:(\w+)\]/gi, "<a href=\"javascript:goTo('$1')\" title=\"$1\">$1</a>" );
  280. text = text.replace(/\[page:(\w+) (\w+)\]/gi, "<a href=\"javascript:goTo('$1')\" title=\"$1\">$2</a>" );
  281. viewer.innerHTML = '<br>' + text + '<br><br>';
  282. }
  283. };
  284. xhr.send( null );
  285. }
  286. goTo( window.location.hash.substring(1) );
  287. // Layout
  288. var margin = 280;
  289. function updateLayout() {
  290. panel.style.height = window.innerHeight + 'px';
  291. viewer.style.marginLeft = margin + 'px';
  292. viewer.style.width = ( window.innerWidth - margin ) + 'px';
  293. viewer.style.height = window.innerHeight + 'px';
  294. }
  295. window.addEventListener( 'resize', updateLayout, false );
  296. updateLayout();
  297. </script>
  298. </body>
  299. </html>