MathUtils.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>MathUtils - 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">MathUtils</h1>
  13. <section>
  14. <header>
  15. <div class="class-description"><p>A collection of math utility functions.</p></div>
  16. </header>
  17. <article>
  18. <div class="container-overview">
  19. <div class="method">
  20. </div>
  21. </div>
  22. <h2 class="subsection-title">Static Methods</h2>
  23. <h3 class="name name-method" id=".ceilPowerOfTwo" translate="no">.<a href="#.ceilPowerOfTwo">ceilPowerOfTwo</a><span class="signature">( value : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  24. <div class="method">
  25. <div class="description">
  26. <p>Returns the smallest power of two that is greater than or equal to the given number.</p>
  27. </div>
  28. <table class="params">
  29. <tbody>
  30. <tr>
  31. <td class="name">
  32. <strong>value</strong>
  33. </td>
  34. <td class="description last">
  35. <p>The value to find a POT for.</p>
  36. </td>
  37. </tr>
  38. </tbody>
  39. </table>
  40. <dl class="details">
  41. <dt class="tag-returns"><strong>Returns:</strong> The smallest power of two that is greater than or equal to the given number.</dt>
  42. </dl>
  43. </div>
  44. <h3 class="name name-method" id=".clamp" translate="no">.<a href="#.clamp">clamp</a><span class="signature">( value : <span class="param-type">number</span>, min : <span class="param-type">number</span>, max : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  45. <div class="method">
  46. <div class="description">
  47. <p>Clamps the given value between min and max.</p>
  48. </div>
  49. <table class="params">
  50. <tbody>
  51. <tr>
  52. <td class="name">
  53. <strong>value</strong>
  54. </td>
  55. <td class="description last">
  56. <p>The value to clamp.</p>
  57. </td>
  58. </tr>
  59. <tr>
  60. <td class="name">
  61. <strong>min</strong>
  62. </td>
  63. <td class="description last">
  64. <p>The min value.</p>
  65. </td>
  66. </tr>
  67. <tr>
  68. <td class="name">
  69. <strong>max</strong>
  70. </td>
  71. <td class="description last">
  72. <p>The max value.</p>
  73. </td>
  74. </tr>
  75. </tbody>
  76. </table>
  77. <dl class="details">
  78. <dt class="tag-returns"><strong>Returns:</strong> The clamped value.</dt>
  79. </dl>
  80. </div>
  81. <h3 class="name name-method" id=".damp" translate="no">.<a href="#.damp">damp</a><span class="signature">( x : <span class="param-type">number</span>, y : <span class="param-type">number</span>, lambda : <span class="param-type">number</span>, dt : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  82. <div class="method">
  83. <div class="description">
  84. <p>Smoothly interpolate a number from <code>x</code> to <code>y</code> in a spring-like manner using a delta
  85. time to maintain frame rate independent movement. For details, see
  86. <a href="http://www.rorydriscoll.com/2016/03/07/frame-rate-independent-damping-using-lerp/" target="_blank" rel="noopener">Frame rate independent damping using lerp</a>.</p>
  87. </div>
  88. <table class="params">
  89. <tbody>
  90. <tr>
  91. <td class="name">
  92. <strong>x</strong>
  93. </td>
  94. <td class="description last">
  95. <p>The current point.</p>
  96. </td>
  97. </tr>
  98. <tr>
  99. <td class="name">
  100. <strong>y</strong>
  101. </td>
  102. <td class="description last">
  103. <p>The target point.</p>
  104. </td>
  105. </tr>
  106. <tr>
  107. <td class="name">
  108. <strong>lambda</strong>
  109. </td>
  110. <td class="description last">
  111. <p>A higher lambda value will make the movement more sudden,
  112. and a lower value will make the movement more gradual.</p>
  113. </td>
  114. </tr>
  115. <tr>
  116. <td class="name">
  117. <strong>dt</strong>
  118. </td>
  119. <td class="description last">
  120. <p>Delta time in seconds.</p>
  121. </td>
  122. </tr>
  123. </tbody>
  124. </table>
  125. <dl class="details">
  126. <dt class="tag-returns"><strong>Returns:</strong> The interpolated value.</dt>
  127. </dl>
  128. </div>
  129. <h3 class="name name-method" id=".degToRad" translate="no">.<a href="#.degToRad">degToRad</a><span class="signature">( degrees : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  130. <div class="method">
  131. <div class="description">
  132. <p>Converts degrees to radians.</p>
  133. </div>
  134. <table class="params">
  135. <tbody>
  136. <tr>
  137. <td class="name">
  138. <strong>degrees</strong>
  139. </td>
  140. <td class="description last">
  141. <p>A value in degrees.</p>
  142. </td>
  143. </tr>
  144. </tbody>
  145. </table>
  146. <dl class="details">
  147. <dt class="tag-returns"><strong>Returns:</strong> The converted value in radians.</dt>
  148. </dl>
  149. </div>
  150. <h3 class="name name-method" id=".denormalize" translate="no">.<a href="#.denormalize">denormalize</a><span class="signature">( value : <span class="param-type">number</span>, array : <span class="param-type">TypedArray</span> )</span><span class="type-signature"> : number</span> </h3>
  151. <div class="method">
  152. <div class="description">
  153. <p>Denormalizes the given value according to the given typed array.</p>
  154. </div>
  155. <table class="params">
  156. <tbody>
  157. <tr>
  158. <td class="name">
  159. <strong>value</strong>
  160. </td>
  161. <td class="description last">
  162. <p>The value to denormalize.</p>
  163. </td>
  164. </tr>
  165. <tr>
  166. <td class="name">
  167. <strong>array</strong>
  168. </td>
  169. <td class="description last">
  170. <p>The typed array that defines the data type of the value.</p>
  171. </td>
  172. </tr>
  173. </tbody>
  174. </table>
  175. <dl class="details">
  176. <dt class="tag-returns"><strong>Returns:</strong> The denormalize (float) value in the range <code>[0,1]</code>.</dt>
  177. </dl>
  178. </div>
  179. <h3 class="name name-method" id=".euclideanModulo" translate="no">.<a href="#.euclideanModulo">euclideanModulo</a><span class="signature">( n : <span class="param-type">number</span>, m : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  180. <div class="method">
  181. <div class="description">
  182. <p>Computes the Euclidean modulo of the given parameters that
  183. is <code>( ( n % m ) + m ) % m</code>.</p>
  184. </div>
  185. <table class="params">
  186. <tbody>
  187. <tr>
  188. <td class="name">
  189. <strong>n</strong>
  190. </td>
  191. <td class="description last">
  192. <p>The first parameter.</p>
  193. </td>
  194. </tr>
  195. <tr>
  196. <td class="name">
  197. <strong>m</strong>
  198. </td>
  199. <td class="description last">
  200. <p>The second parameter.</p>
  201. </td>
  202. </tr>
  203. </tbody>
  204. </table>
  205. <dl class="details">
  206. <dt class="tag-returns"><strong>Returns:</strong> The Euclidean modulo.</dt>
  207. </dl>
  208. </div>
  209. <h3 class="name name-method" id=".floorPowerOfTwo" translate="no">.<a href="#.floorPowerOfTwo">floorPowerOfTwo</a><span class="signature">( value : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  210. <div class="method">
  211. <div class="description">
  212. <p>Returns the largest power of two that is less than or equal to the given number.</p>
  213. </div>
  214. <table class="params">
  215. <tbody>
  216. <tr>
  217. <td class="name">
  218. <strong>value</strong>
  219. </td>
  220. <td class="description last">
  221. <p>The value to find a POT for.</p>
  222. </td>
  223. </tr>
  224. </tbody>
  225. </table>
  226. <dl class="details">
  227. <dt class="tag-returns"><strong>Returns:</strong> The largest power of two that is less than or equal to the given number.</dt>
  228. </dl>
  229. </div>
  230. <h3 class="name name-method" id=".generateUUID" translate="no">.<a href="#.generateUUID">generateUUID</a><span class="signature">()</span><span class="type-signature"> : string</span> </h3>
  231. <div class="method">
  232. <div class="description">
  233. <p>Generate a <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier" target="_blank" rel="noopener">UUID</a>
  234. (universally unique identifier).</p>
  235. </div>
  236. <dl class="details">
  237. <dt class="tag-returns"><strong>Returns:</strong> The UUID.</dt>
  238. </dl>
  239. </div>
  240. <h3 class="name name-method" id=".inverseLerp" translate="no">.<a href="#.inverseLerp">inverseLerp</a><span class="signature">( x : <span class="param-type">number</span>, y : <span class="param-type">number</span>, value : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  241. <div class="method">
  242. <div class="description">
  243. <p>Returns the percentage in the closed interval <code>[0, 1]</code> of the given value
  244. between the start and end point.</p>
  245. </div>
  246. <table class="params">
  247. <tbody>
  248. <tr>
  249. <td class="name">
  250. <strong>x</strong>
  251. </td>
  252. <td class="description last">
  253. <p>The start point</p>
  254. </td>
  255. </tr>
  256. <tr>
  257. <td class="name">
  258. <strong>y</strong>
  259. </td>
  260. <td class="description last">
  261. <p>The end point.</p>
  262. </td>
  263. </tr>
  264. <tr>
  265. <td class="name">
  266. <strong>value</strong>
  267. </td>
  268. <td class="description last">
  269. <p>A value between start and end.</p>
  270. </td>
  271. </tr>
  272. </tbody>
  273. </table>
  274. <dl class="details">
  275. <dt class="tag-returns"><strong>Returns:</strong> The interpolation factor.</dt>
  276. </dl>
  277. </div>
  278. <h3 class="name name-method" id=".isPowerOfTwo" translate="no">.<a href="#.isPowerOfTwo">isPowerOfTwo</a><span class="signature">( value : <span class="param-type">number</span> )</span><span class="type-signature"> : boolean</span> </h3>
  279. <div class="method">
  280. <div class="description">
  281. <p>Returns <code>true</code> if the given number is a power of two.</p>
  282. </div>
  283. <table class="params">
  284. <tbody>
  285. <tr>
  286. <td class="name">
  287. <strong>value</strong>
  288. </td>
  289. <td class="description last">
  290. <p>The value to check.</p>
  291. </td>
  292. </tr>
  293. </tbody>
  294. </table>
  295. <dl class="details">
  296. <dt class="tag-returns"><strong>Returns:</strong> Whether the given number is a power of two or not.</dt>
  297. </dl>
  298. </div>
  299. <h3 class="name name-method" id=".lerp" translate="no">.<a href="#.lerp">lerp</a><span class="signature">( x : <span class="param-type">number</span>, y : <span class="param-type">number</span>, t : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  300. <div class="method">
  301. <div class="description">
  302. <p>Returns a value linearly interpolated from two known points based on the given interval -
  303. <code>t = 0</code> will return <code>x</code> and <code>t = 1</code> will return <code>y</code>.</p>
  304. </div>
  305. <table class="params">
  306. <tbody>
  307. <tr>
  308. <td class="name">
  309. <strong>x</strong>
  310. </td>
  311. <td class="description last">
  312. <p>The start point</p>
  313. </td>
  314. </tr>
  315. <tr>
  316. <td class="name">
  317. <strong>y</strong>
  318. </td>
  319. <td class="description last">
  320. <p>The end point.</p>
  321. </td>
  322. </tr>
  323. <tr>
  324. <td class="name">
  325. <strong>t</strong>
  326. </td>
  327. <td class="description last">
  328. <p>The interpolation factor in the closed interval <code>[0, 1]</code>.</p>
  329. </td>
  330. </tr>
  331. </tbody>
  332. </table>
  333. <dl class="details">
  334. <dt class="tag-returns"><strong>Returns:</strong> The interpolated value.</dt>
  335. </dl>
  336. </div>
  337. <h3 class="name name-method" id=".mapLinear" translate="no">.<a href="#.mapLinear">mapLinear</a><span class="signature">( x : <span class="param-type">number</span>, a1 : <span class="param-type">number</span>, a2 : <span class="param-type">number</span>, b1 : <span class="param-type">number</span>, b2 : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  338. <div class="method">
  339. <div class="description">
  340. <p>Performs a linear mapping from range <code>&lt;a1, a2&gt;</code> to range <code>&lt;b1, b2&gt;</code>
  341. for the given value.</p>
  342. </div>
  343. <table class="params">
  344. <tbody>
  345. <tr>
  346. <td class="name">
  347. <strong>x</strong>
  348. </td>
  349. <td class="description last">
  350. <p>The value to be mapped.</p>
  351. </td>
  352. </tr>
  353. <tr>
  354. <td class="name">
  355. <strong>a1</strong>
  356. </td>
  357. <td class="description last">
  358. <p>Minimum value for range A.</p>
  359. </td>
  360. </tr>
  361. <tr>
  362. <td class="name">
  363. <strong>a2</strong>
  364. </td>
  365. <td class="description last">
  366. <p>Maximum value for range A.</p>
  367. </td>
  368. </tr>
  369. <tr>
  370. <td class="name">
  371. <strong>b1</strong>
  372. </td>
  373. <td class="description last">
  374. <p>Minimum value for range B.</p>
  375. </td>
  376. </tr>
  377. <tr>
  378. <td class="name">
  379. <strong>b2</strong>
  380. </td>
  381. <td class="description last">
  382. <p>Maximum value for range B.</p>
  383. </td>
  384. </tr>
  385. </tbody>
  386. </table>
  387. <dl class="details">
  388. <dt class="tag-returns"><strong>Returns:</strong> The mapped value.</dt>
  389. </dl>
  390. </div>
  391. <h3 class="name name-method" id=".normalize" translate="no">.<a href="#.normalize">normalize</a><span class="signature">( value : <span class="param-type">number</span>, array : <span class="param-type">TypedArray</span> )</span><span class="type-signature"> : number</span> </h3>
  392. <div class="method">
  393. <div class="description">
  394. <p>Normalizes the given value according to the given typed array.</p>
  395. </div>
  396. <table class="params">
  397. <tbody>
  398. <tr>
  399. <td class="name">
  400. <strong>value</strong>
  401. </td>
  402. <td class="description last">
  403. <p>The float value in the range <code>[0,1]</code> to normalize.</p>
  404. </td>
  405. </tr>
  406. <tr>
  407. <td class="name">
  408. <strong>array</strong>
  409. </td>
  410. <td class="description last">
  411. <p>The typed array that defines the data type of the value.</p>
  412. </td>
  413. </tr>
  414. </tbody>
  415. </table>
  416. <dl class="details">
  417. <dt class="tag-returns"><strong>Returns:</strong> The normalize value.</dt>
  418. </dl>
  419. </div>
  420. <h3 class="name name-method" id=".pingpong" translate="no">.<a href="#.pingpong">pingpong</a><span class="signature">( x : <span class="param-type">number</span>, length : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  421. <div class="method">
  422. <div class="description">
  423. <p>Returns a value that alternates between <code>0</code> and the given <code>length</code> parameter.</p>
  424. </div>
  425. <table class="params">
  426. <tbody>
  427. <tr>
  428. <td class="name">
  429. <strong>x</strong>
  430. </td>
  431. <td class="description last">
  432. <p>The value to pingpong.</p>
  433. </td>
  434. </tr>
  435. <tr>
  436. <td class="name">
  437. <strong>length</strong>
  438. </td>
  439. <td class="description last">
  440. <p>The positive value the function will pingpong to.</p>
  441. <p>Default is <code>1</code>.</p>
  442. </td>
  443. </tr>
  444. </tbody>
  445. </table>
  446. <dl class="details">
  447. <dt class="tag-returns"><strong>Returns:</strong> The alternated value.</dt>
  448. </dl>
  449. </div>
  450. <h3 class="name name-method" id=".radToDeg" translate="no">.<a href="#.radToDeg">radToDeg</a><span class="signature">( radians : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  451. <div class="method">
  452. <div class="description">
  453. <p>Converts radians to degrees.</p>
  454. </div>
  455. <table class="params">
  456. <tbody>
  457. <tr>
  458. <td class="name">
  459. <strong>radians</strong>
  460. </td>
  461. <td class="description last">
  462. <p>A value in radians.</p>
  463. </td>
  464. </tr>
  465. </tbody>
  466. </table>
  467. <dl class="details">
  468. <dt class="tag-returns"><strong>Returns:</strong> The converted value in degrees.</dt>
  469. </dl>
  470. </div>
  471. <h3 class="name name-method" id=".randFloat" translate="no">.<a href="#.randFloat">randFloat</a><span class="signature">( low : <span class="param-type">number</span>, high : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  472. <div class="method">
  473. <div class="description">
  474. <p>Returns a random float from <code>&lt;low, high&gt;</code> interval.</p>
  475. </div>
  476. <table class="params">
  477. <tbody>
  478. <tr>
  479. <td class="name">
  480. <strong>low</strong>
  481. </td>
  482. <td class="description last">
  483. <p>The lower value boundary.</p>
  484. </td>
  485. </tr>
  486. <tr>
  487. <td class="name">
  488. <strong>high</strong>
  489. </td>
  490. <td class="description last">
  491. <p>The upper value boundary</p>
  492. </td>
  493. </tr>
  494. </tbody>
  495. </table>
  496. <dl class="details">
  497. <dt class="tag-returns"><strong>Returns:</strong> A random float.</dt>
  498. </dl>
  499. </div>
  500. <h3 class="name name-method" id=".randFloatSpread" translate="no">.<a href="#.randFloatSpread">randFloatSpread</a><span class="signature">( range : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  501. <div class="method">
  502. <div class="description">
  503. <p>Returns a random integer from <code>&lt;-range/2, range/2&gt;</code> interval.</p>
  504. </div>
  505. <table class="params">
  506. <tbody>
  507. <tr>
  508. <td class="name">
  509. <strong>range</strong>
  510. </td>
  511. <td class="description last">
  512. <p>Defines the value range.</p>
  513. </td>
  514. </tr>
  515. </tbody>
  516. </table>
  517. <dl class="details">
  518. <dt class="tag-returns"><strong>Returns:</strong> A random float.</dt>
  519. </dl>
  520. </div>
  521. <h3 class="name name-method" id=".randInt" translate="no">.<a href="#.randInt">randInt</a><span class="signature">( low : <span class="param-type">number</span>, high : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  522. <div class="method">
  523. <div class="description">
  524. <p>Returns a random integer from <code>&lt;low, high&gt;</code> interval.</p>
  525. </div>
  526. <table class="params">
  527. <tbody>
  528. <tr>
  529. <td class="name">
  530. <strong>low</strong>
  531. </td>
  532. <td class="description last">
  533. <p>The lower value boundary.</p>
  534. </td>
  535. </tr>
  536. <tr>
  537. <td class="name">
  538. <strong>high</strong>
  539. </td>
  540. <td class="description last">
  541. <p>The upper value boundary</p>
  542. </td>
  543. </tr>
  544. </tbody>
  545. </table>
  546. <dl class="details">
  547. <dt class="tag-returns"><strong>Returns:</strong> A random integer.</dt>
  548. </dl>
  549. </div>
  550. <h3 class="name name-method" id=".seededRandom" translate="no">.<a href="#.seededRandom">seededRandom</a><span class="signature">( s : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  551. <div class="method">
  552. <div class="description">
  553. <p>Returns a deterministic pseudo-random float in the interval <code>[0, 1]</code>.</p>
  554. </div>
  555. <table class="params">
  556. <tbody>
  557. <tr>
  558. <td class="name">
  559. <strong>s</strong>
  560. </td>
  561. <td class="description last">
  562. <p>The integer seed.</p>
  563. </td>
  564. </tr>
  565. </tbody>
  566. </table>
  567. <dl class="details">
  568. <dt class="tag-returns"><strong>Returns:</strong> A random float.</dt>
  569. </dl>
  570. </div>
  571. <h3 class="name name-method" id=".setQuaternionFromProperEuler" translate="no">.<a href="#.setQuaternionFromProperEuler">setQuaternionFromProperEuler</a><span class="signature">( q : <span class="param-type"><a href="Quaternion.html">Quaternion</a></span>, a : <span class="param-type">number</span>, b : <span class="param-type">number</span>, c : <span class="param-type">number</span>, order : <span class="param-type">'XYX' | 'XZX' | 'YXY' | 'YZY' | 'ZXZ' | 'ZYZ'</span> )</span> </h3>
  572. <div class="method">
  573. <div class="description">
  574. <p>Sets the given quaternion from the <a href="https://en.wikipedia.org/wiki/Euler_angles" target="_blank" rel="noopener">Intrinsic Proper Euler Angles</a>
  575. defined by the given angles and order.</p>
  576. <p>Rotations are applied to the axes in the order specified by order:
  577. rotation by angle <code>a</code> is applied first, then by angle <code>b</code>, then by angle <code>c</code>.</p>
  578. </div>
  579. <table class="params">
  580. <tbody>
  581. <tr>
  582. <td class="name">
  583. <strong>q</strong>
  584. </td>
  585. <td class="description last">
  586. <p>The quaternion to set.</p>
  587. </td>
  588. </tr>
  589. <tr>
  590. <td class="name">
  591. <strong>a</strong>
  592. </td>
  593. <td class="description last">
  594. <p>The rotation applied to the first axis, in radians.</p>
  595. </td>
  596. </tr>
  597. <tr>
  598. <td class="name">
  599. <strong>b</strong>
  600. </td>
  601. <td class="description last">
  602. <p>The rotation applied to the second axis, in radians.</p>
  603. </td>
  604. </tr>
  605. <tr>
  606. <td class="name">
  607. <strong>c</strong>
  608. </td>
  609. <td class="description last">
  610. <p>The rotation applied to the third axis, in radians.</p>
  611. </td>
  612. </tr>
  613. <tr>
  614. <td class="name">
  615. <strong>order</strong>
  616. </td>
  617. <td class="description last">
  618. <p>A string specifying the axes order.</p>
  619. </td>
  620. </tr>
  621. </tbody>
  622. </table>
  623. </div>
  624. <h3 class="name name-method" id=".smootherstep" translate="no">.<a href="#.smootherstep">smootherstep</a><span class="signature">( x : <span class="param-type">number</span>, min : <span class="param-type">number</span>, max : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  625. <div class="method">
  626. <div class="description">
  627. <p>A <a href="https://en.wikipedia.org/wiki/Smoothstep#Variations" target="_blank" rel="noopener">variation on smoothstep</a>
  628. that has zero 1st and 2nd order derivatives at x=0 and x=1.</p>
  629. </div>
  630. <table class="params">
  631. <tbody>
  632. <tr>
  633. <td class="name">
  634. <strong>x</strong>
  635. </td>
  636. <td class="description last">
  637. <p>The value to evaluate based on its position between min and max.</p>
  638. </td>
  639. </tr>
  640. <tr>
  641. <td class="name">
  642. <strong>min</strong>
  643. </td>
  644. <td class="description last">
  645. <p>The min value. Any x value below min will be <code>0</code>.</p>
  646. </td>
  647. </tr>
  648. <tr>
  649. <td class="name">
  650. <strong>max</strong>
  651. </td>
  652. <td class="description last">
  653. <p>The max value. Any x value above max will be <code>1</code>.</p>
  654. </td>
  655. </tr>
  656. </tbody>
  657. </table>
  658. <dl class="details">
  659. <dt class="tag-returns"><strong>Returns:</strong> The alternated value.</dt>
  660. </dl>
  661. </div>
  662. <h3 class="name name-method" id=".smoothstep" translate="no">.<a href="#.smoothstep">smoothstep</a><span class="signature">( x : <span class="param-type">number</span>, min : <span class="param-type">number</span>, max : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
  663. <div class="method">
  664. <div class="description">
  665. <p>Returns a value in the range <code>[0,1]</code> that represents the percentage that <code>x</code> has
  666. moved between <code>min</code> and <code>max</code>, but smoothed or slowed down the closer <code>x</code> is to
  667. the <code>min</code> and <code>max</code>.</p>
  668. <p>See <a href="http://en.wikipedia.org/wiki/Smoothstep" target="_blank" rel="noopener">Smoothstep</a> for more details.</p>
  669. </div>
  670. <table class="params">
  671. <tbody>
  672. <tr>
  673. <td class="name">
  674. <strong>x</strong>
  675. </td>
  676. <td class="description last">
  677. <p>The value to evaluate based on its position between min and max.</p>
  678. </td>
  679. </tr>
  680. <tr>
  681. <td class="name">
  682. <strong>min</strong>
  683. </td>
  684. <td class="description last">
  685. <p>The min value. Any x value below min will be <code>0</code>.</p>
  686. </td>
  687. </tr>
  688. <tr>
  689. <td class="name">
  690. <strong>max</strong>
  691. </td>
  692. <td class="description last">
  693. <p>The max value. Any x value above max will be <code>1</code>.</p>
  694. </td>
  695. </tr>
  696. </tbody>
  697. </table>
  698. <dl class="details">
  699. <dt class="tag-returns"><strong>Returns:</strong> The alternated value.</dt>
  700. </dl>
  701. </div>
  702. <h2 class="subsection-title">Source</h2>
  703. <p>
  704. <a href="https://github.com/mrdoob/three.js/blob/master/src/math/MathUtils.js" translate="no" target="_blank" rel="noopener">src/math/MathUtils.js</a>
  705. </p>
  706. </article>
  707. </section>
  708. <script src="../scripts/linenumber.js"></script>
  709. <script src="../scripts/page.js"></script>
  710. </body>
  711. </html>
粤ICP备19079148号