Cylindrical.html 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Cylindrical - Three.js Docs</title>
  6. <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
  7. <script src="../scripts/highlight.min.js"></script>
  8. <link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
  9. <link type="text/css" rel="stylesheet" href="../styles/page.css">
  10. </head>
  11. <body>
  12. <h1 translate="no">Cylindrical</h1>
  13. <section>
  14. <header>
  15. <div class="class-description"><p>This class can be used to represent points in 3D space as
  16. <a href="https://en.wikipedia.org/wiki/Cylindrical_coordinate_system">Cylindrical coordinates</a>.</p></div>
  17. </header>
  18. <article>
  19. <div class="container-overview">
  20. <h2>Constructor</h2>
  21. <h3 class="name name-method" id="Cylindrical" translate="no">new <a href="#Cylindrical">Cylindrical</a><span class="signature">( radius : <span class="param-type">number</span>, theta : <span class="param-type">number</span>, y : <span class="param-type">number</span> )</span> </h3>
  22. <div class="method">
  23. <div class="description">
  24. <p>Constructs a new cylindrical.</p>
  25. </div>
  26. <table class="params">
  27. <tbody>
  28. <tr>
  29. <td class="name"><code>radius</code></td>
  30. <td class="description last"><p>The distance from the origin to a point in the x-z plane.<br/>Default is <code>1</code>.</p></td>
  31. </tr>
  32. <tr>
  33. <td class="name"><code>theta</code></td>
  34. <td class="description last"><p>A counterclockwise angle in the x-z plane measured in radians from the positive z-axis.<br/>Default is <code>0</code>.</p></td>
  35. </tr>
  36. <tr>
  37. <td class="name"><code>y</code></td>
  38. <td class="description last"><p>The height above the x-z plane.<br/>Default is <code>0</code>.</p></td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. </div>
  44. <h2 class="subsection-title">Properties</h2>
  45. <div class="member">
  46. <h3 class="name" id="radius" translate="no">.<a href="#radius">radius</a><span class="type-signature"> : number</span> </h3>
  47. <div class="description">
  48. <p>The distance from the origin to a point in the x-z plane.<br/>Default is <code>1</code>.</p>
  49. </div>
  50. </div>
  51. <div class="member">
  52. <h3 class="name" id="theta" translate="no">.<a href="#theta">theta</a><span class="type-signature"> : number</span> </h3>
  53. <div class="description">
  54. <p>A counterclockwise angle in the x-z plane measured in radians from the positive z-axis.<br/>Default is <code>0</code>.</p>
  55. </div>
  56. </div>
  57. <div class="member">
  58. <h3 class="name" id="y" translate="no">.<a href="#y">y</a><span class="type-signature"> : number</span> </h3>
  59. <div class="description">
  60. <p>The height above the x-z plane.<br/>Default is <code>0</code>.</p>
  61. </div>
  62. </div>
  63. <h2 class="subsection-title">Methods</h2>
  64. <h3 class="name name-method" id="clone" translate="no">.<a href="#clone">clone</a><span class="signature">()</span><span class="type-signature"> : <a href="Cylindrical.html">Cylindrical</a></span> </h3>
  65. <div class="method">
  66. <div class="description">
  67. <p>Returns a new cylindrical with copied values from this instance.</p>
  68. </div>
  69. <dl class="details">
  70. <dt class="tag-returns"><strong>Returns:</strong> A clone of this instance.</dt>
  71. </dl>
  72. </div>
  73. <h3 class="name name-method" id="copy" translate="no">.<a href="#copy">copy</a><span class="signature">( other : <span class="param-type">Cylindrical</span> )</span><span class="type-signature"> : <a href="Cylindrical.html">Cylindrical</a></span> </h3>
  74. <div class="method">
  75. <div class="description">
  76. <p>Copies the values of the given cylindrical to this instance.</p>
  77. </div>
  78. <table class="params">
  79. <tbody>
  80. <tr>
  81. <td class="name"><code>other</code></td>
  82. <td class="description last"><p>The cylindrical to copy.</p></td>
  83. </tr>
  84. </tbody>
  85. </table>
  86. <dl class="details">
  87. <dt class="tag-returns"><strong>Returns:</strong> A reference to this cylindrical.</dt>
  88. </dl>
  89. </div>
  90. <h3 class="name name-method" id="set" translate="no">.<a href="#set">set</a><span class="signature">( radius : <span class="param-type">number</span>, theta : <span class="param-type">number</span>, y : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Cylindrical.html">Cylindrical</a></span> </h3>
  91. <div class="method">
  92. <div class="description">
  93. <p>Sets the cylindrical components by copying the given values.</p>
  94. </div>
  95. <table class="params">
  96. <tbody>
  97. <tr>
  98. <td class="name"><code>radius</code></td>
  99. <td class="description last"><p>The radius.</p></td>
  100. </tr>
  101. <tr>
  102. <td class="name"><code>theta</code></td>
  103. <td class="description last"><p>The theta angle.</p></td>
  104. </tr>
  105. <tr>
  106. <td class="name"><code>y</code></td>
  107. <td class="description last"><p>The height value.</p></td>
  108. </tr>
  109. </tbody>
  110. </table>
  111. <dl class="details">
  112. <dt class="tag-returns"><strong>Returns:</strong> A reference to this cylindrical.</dt>
  113. </dl>
  114. </div>
  115. <h3 class="name name-method" id="setFromCartesianCoords" translate="no">.<a href="#setFromCartesianCoords">setFromCartesianCoords</a><span class="signature">( x : <span class="param-type">number</span>, y : <span class="param-type">number</span>, z : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Cylindrical.html">Cylindrical</a></span> </h3>
  116. <div class="method">
  117. <div class="description">
  118. <p>Sets the cylindrical components from the given Cartesian coordinates.</p>
  119. </div>
  120. <table class="params">
  121. <tbody>
  122. <tr>
  123. <td class="name"><code>x</code></td>
  124. <td class="description last"><p>The x value.</p></td>
  125. </tr>
  126. <tr>
  127. <td class="name"><code>y</code></td>
  128. <td class="description last"><p>The x value.</p></td>
  129. </tr>
  130. <tr>
  131. <td class="name"><code>z</code></td>
  132. <td class="description last"><p>The x value.</p></td>
  133. </tr>
  134. </tbody>
  135. </table>
  136. <dl class="details">
  137. <dt class="tag-returns"><strong>Returns:</strong> A reference to this cylindrical.</dt>
  138. </dl>
  139. </div>
  140. <h3 class="name name-method" id="setFromVector3" translate="no">.<a href="#setFromVector3">setFromVector3</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Cylindrical.html">Cylindrical</a></span> </h3>
  141. <div class="method">
  142. <div class="description">
  143. <p>Sets the cylindrical components from the given vector which is assumed to hold
  144. Cartesian coordinates.</p>
  145. </div>
  146. <table class="params">
  147. <tbody>
  148. <tr>
  149. <td class="name"><code>v</code></td>
  150. <td class="description last"><p>The vector to set.</p></td>
  151. </tr>
  152. </tbody>
  153. </table>
  154. <dl class="details">
  155. <dt class="tag-returns"><strong>Returns:</strong> A reference to this cylindrical.</dt>
  156. </dl>
  157. </div>
  158. <h2 class="subsection-title">Source</h2>
  159. <p>
  160. <a href="https://github.com/mrdoob/three.js/blob/master/src/math/Cylindrical.js" target="_blank" rel="noopener" translate="no">src/math/Cylindrical.js</a>
  161. </p>
  162. </article>
  163. </section>
  164. <script src="../scripts/linenumber.js"></script>
  165. <script src="../scripts/page.js"></script>
  166. </body>
  167. </html>
粤ICP备19079148号