Cylindrical.html 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="page.css" />
  8. </head>
  9. <body>
  10. <h1>[name]</h1>
  11. <p class="desc">
  12. A point's
  13. [link:https://en.wikipedia.org/wiki/Cylindrical_coordinate_system cylindrical coordinates].
  14. </p>
  15. <h2>Constructor</h2>
  16. <h3>
  17. [name]( [param:Float radius], [param:Float theta], [param:Float y] )
  18. </h3>
  19. <p>
  20. [page:Float radius] - distance from the origin to a point in the x-z
  21. plane. Default is `1.0`.<br />
  22. [page:Float theta] - counterclockwise angle in the x-z plane measured in
  23. radians from the positive z-axis. Default is `0`.<br />
  24. [page:Float y] - height above the x-z plane. Default is `0`.
  25. </p>
  26. <h2>Properties</h2>
  27. <h3>[property:Float radius]</h3>
  28. <h3>[property:Float theta]</h3>
  29. <h3>[property:Float y]</h3>
  30. <h2>Methods</h2>
  31. <h3>[method:Cylindrical clone]()</h3>
  32. <p>
  33. Returns a new cylindrical with the same [page:.radius radius],
  34. [page:.theta theta] and [page:.y y] properties as this one.
  35. </p>
  36. <h3>[method:this copy]( [param:Cylindrical other] )</h3>
  37. <p>
  38. Copies the values of the passed Cylindrical's [page:.radius radius],
  39. [page:.theta theta] and [page:.y y] properties to this cylindrical.
  40. </p>
  41. <h3>
  42. [method:this set]( [param:Float radius], [param:Float theta], [param:Float y] )
  43. </h3>
  44. <p>
  45. Sets values of this cylindrical's [page:.radius radius], [page:.theta theta] and [page:.y y] properties.
  46. </p>
  47. <h3>[method:this setFromVector3]( [param:Vector3 vec3] )</h3>
  48. <p>
  49. Sets values of this cylindrical's [page:.radius radius], [page:.theta theta]
  50. and [page:.y y] properties from the [page:Vector3 Vector3].
  51. </p>
  52. <h3>
  53. [method:this setFromCartesianCoords]( [param:Float x], [param:Float y], [param:Float z] )
  54. </h3>
  55. <p>
  56. Sets values of this cylindrical's [page:.radius radius], [page:.theta theta] and
  57. [page:.y y] properties from Cartesian coordinates.
  58. </p>
  59. <h2>Source</h2>
  60. <p>
  61. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  62. </p>
  63. </body>
  64. </html>