PolarGridHelper.html 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="list.js"></script>
  7. <script src="page.js"></script>
  8. <link type="text/css" rel="stylesheet" href="page.css" />
  9. </head>
  10. <body>
  11. [page:Object3D] &rarr; [page:Line] &rarr;
  12. <h1>[name]</h1>
  13. <p class="desc">The PolarGridHelper is an object to define polar grids. Grids are two-dimensional arrays of lines.</p>
  14. <h2>Example</h2>
  15. <p>
  16. [example:webgl_helpers WebGL / helpers]
  17. </p>
  18. <code>var radius = 10;
  19. var radials = 16;
  20. var circles = 8;
  21. var divisions = 64;
  22. var helper = new THREE.PolarGridHelper( radius, radials, circles, divisions );
  23. scene.add( helper );
  24. </code>
  25. <h2>Constructor</h2>
  26. <h3>[name]( [param:Number radius], [param:Number radials], [param:Number circles], [param:Number divisions], [param:Color color1], [param:Color color2] )</h3>
  27. <p>
  28. radius -- The radius of the polar grid. This can be any positive number. Default is 10.<br />
  29. radials -- The number of radial lines. This can be any positive integer. Default is 16.<br />
  30. circles -- The number of circles. This can be any positive integer. Default is 8.<br />
  31. divisions -- The number of line segments used for each circle. This can be any positive integer that is 3 or greater. Default is 64.<br />
  32. color1 -- The first color used for grid elements. This can be a [page:Color], a hexadecimal value and an CSS-Color name. Default is 0x444444 <br />
  33. color2 -- The second color used for grid elements. This can be a [page:Color], a hexadecimal value and an CSS-Color name. Default is 0x888888
  34. </p>
  35. <p>
  36. Creates a new [name] of radius 'radius' with 'radials' number of radials and 'circles' number of circles, where each circle is smoothed into 'divisions' number of line segments. Colors are optional.
  37. </p>
  38. <h2>Source</h2>
  39. <p>
  40. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  41. </p>
  42. </body>
  43. </html>