Home Explore Help
Register Sign In
samien
/
three.js
mirror of https://github.com/mrdoob/three.js.git
1
0
Fork 0
Files Issues 0 Wiki
Tree: 6618a69400
Branches Tags
three.js
/
docs
/
pages
/
MathUtils.html

MathUtils.html 24 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4. 	<meta charset="utf-8">
    5. 

  5. 	<title>MathUtils - Three.js Docs</title>
    6. 

  6. 	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
    7. 

  7. 	<script src="../scripts/highlight.min.js"></script>
    8. 

  8. 	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
    9. 

  9. 	<link type="text/css" rel="stylesheet" href="../styles/page.css">
    10. 

  10. </head>
    11. 

  11. <body>
    12. 

  12. 	<h1 translate="no">MathUtils</h1>
    13. 

  13. 		<section>
    14. 

  14. 			<header>
    15. 

  15. 				<div class="class-description"><p>A collection of math utility functions.</p></div>
    16. 

  16. 			</header>
    17. 

  17. 			<article>
    18. 

  18. 				<div class="container-overview">
    19. 

  19. 					<div class="method">
    20. 

  20. 					</div>
    21. 

  21. 				</div>
    22. 

  22. 				<h2 class="subsection-title">Static Methods</h2>
    23. 

  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. 

  24. 					<div class="method">
    25. 

  25. 						<div class="description">
    26. 

  26. 							<p>Returns the smallest power of two that is greater than or equal to the given number.</p>
    27. 

  27. 						</div>
    28. 

  28. 						<table class="params">
    29. 

  29. 							<tbody>
    30. 

  30. 								<tr>
    31. 

  31. 									<td class="name"><code>value</code></td>
    32. 

  32. 									<td class="description last"><p>The value to find a POT for.</p></td>
    33. 

  33. 								</tr>
    34. 

  34. 							</tbody>
    35. 

  35. 						</table>
    36. 

  36. 						<dl class="details">
    37. 

  37. 							<dt class="tag-returns"><strong>Returns:</strong> The smallest power of two that is greater than or equal to the given number.</dt>
    38. 

  38. 						</dl>
    39. 

  39. 					</div>
    40. 

  40. 					<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>
    41. 

  41. 					<div class="method">
    42. 

  42. 						<div class="description">
    43. 

  43. 							<p>Clamps the given value between min and max.</p>
    44. 

  44. 						</div>
    45. 

  45. 						<table class="params">
    46. 

  46. 							<tbody>
    47. 

  47. 								<tr>
    48. 

  48. 									<td class="name"><code>value</code></td>
    49. 

  49. 									<td class="description last"><p>The value to clamp.</p></td>
    50. 

  50. 								</tr>
    51. 

  51. 								<tr>
    52. 

  52. 									<td class="name"><code>min</code></td>
    53. 

  53. 									<td class="description last"><p>The min value.</p></td>
    54. 

  54. 								</tr>
    55. 

  55. 								<tr>
    56. 

  56. 									<td class="name"><code>max</code></td>
    57. 

  57. 									<td class="description last"><p>The max value.</p></td>
    58. 

  58. 								</tr>
    59. 

  59. 							</tbody>
    60. 

  60. 						</table>
    61. 

  61. 						<dl class="details">
    62. 

  62. 							<dt class="tag-returns"><strong>Returns:</strong> The clamped value.</dt>
    63. 

  63. 						</dl>
    64. 

  64. 					</div>
    65. 

  65. 					<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>
    66. 

  66. 					<div class="method">
    67. 

  67. 						<div class="description">
    68. 

  68. 							<p>Smoothly interpolate a number from <code>x</code> to <code>y</code> in  a spring-like manner using a delta
    69. 

  69. time to maintain frame rate independent movement. For details, see
    70. 

  70. <a href="http://www.rorydriscoll.com/2016/03/07/frame-rate-independent-damping-using-lerp/">Frame rate independent damping using lerp</a>.</p>
    71. 

  71. 						</div>
    72. 

  72. 						<table class="params">
    73. 

  73. 							<tbody>
    74. 

  74. 								<tr>
    75. 

  75. 									<td class="name"><code>x</code></td>
    76. 

  76. 									<td class="description last"><p>The current point.</p></td>
    77. 

  77. 								</tr>
    78. 

  78. 								<tr>
    79. 

  79. 									<td class="name"><code>y</code></td>
    80. 

  80. 									<td class="description last"><p>The target point.</p></td>
    81. 

  81. 								</tr>
    82. 

  82. 								<tr>
    83. 

  83. 									<td class="name"><code>lambda</code></td>
    84. 

  84. 									<td class="description last"><p>A higher lambda value will make the movement more sudden,
    85. 

  85. and a lower value will make the movement more gradual.</p></td>
    86. 

  86. 								</tr>
    87. 

  87. 								<tr>
    88. 

  88. 									<td class="name"><code>dt</code></td>
    89. 

  89. 									<td class="description last"><p>Delta time in seconds.</p></td>
    90. 

  90. 								</tr>
    91. 

  91. 							</tbody>
    92. 

  92. 						</table>
    93. 

  93. 						<dl class="details">
    94. 

  94. 							<dt class="tag-returns"><strong>Returns:</strong> The interpolated value.</dt>
    95. 

  95. 						</dl>
    96. 

  96. 					</div>
    97. 

  97. 					<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>
    98. 

  98. 					<div class="method">
    99. 

  99. 						<div class="description">
    100. 

  100. 							<p>Converts degrees to radians.</p>
    101. 

  101. 						</div>
    102. 

  102. 						<table class="params">
    103. 

  103. 							<tbody>
    104. 

  104. 								<tr>
    105. 

  105. 									<td class="name"><code>degrees</code></td>
    106. 

  106. 									<td class="description last"><p>A value in degrees.</p></td>
    107. 

  107. 								</tr>
    108. 

  108. 							</tbody>
    109. 

  109. 						</table>
    110. 

  110. 						<dl class="details">
    111. 

  111. 							<dt class="tag-returns"><strong>Returns:</strong> The converted value in radians.</dt>
    112. 

  112. 						</dl>
    113. 

  113. 					</div>
    114. 

  114. 					<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>
    115. 

  115. 					<div class="method">
    116. 

  116. 						<div class="description">
    117. 

  117. 							<p>Denormalizes the given value according to the given typed array.</p>
    118. 

  118. 						</div>
    119. 

  119. 						<table class="params">
    120. 

  120. 							<tbody>
    121. 

  121. 								<tr>
    122. 

  122. 									<td class="name"><code>value</code></td>
    123. 

  123. 									<td class="description last"><p>The value to denormalize.</p></td>
    124. 

  124. 								</tr>
    125. 

  125. 								<tr>
    126. 

  126. 									<td class="name"><code>array</code></td>
    127. 

  127. 									<td class="description last"><p>The typed array that defines the data type of the value.</p></td>
    128. 

  128. 								</tr>
    129. 

  129. 							</tbody>
    130. 

  130. 						</table>
    131. 

  131. 						<dl class="details">
    132. 

  132. 							<dt class="tag-returns"><strong>Returns:</strong> The denormalize (float) value in the range <code>[0,1]</code>.</dt>
    133. 

  133. 						</dl>
    134. 

  134. 					</div>
    135. 

  135. 					<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>
    136. 

  136. 					<div class="method">
    137. 

  137. 						<div class="description">
    138. 

  138. 							<p>Computes the Euclidean modulo of the given parameters that
    139. 

  139. is <code>( ( n % m ) + m ) % m</code>.</p>
    140. 

  140. 						</div>
    141. 

  141. 						<table class="params">
    142. 

  142. 							<tbody>
    143. 

  143. 								<tr>
    144. 

  144. 									<td class="name"><code>n</code></td>
    145. 

  145. 									<td class="description last"><p>The first parameter.</p></td>
    146. 

  146. 								</tr>
    147. 

  147. 								<tr>
    148. 

  148. 									<td class="name"><code>m</code></td>
    149. 

  149. 									<td class="description last"><p>The second parameter.</p></td>
    150. 

  150. 								</tr>
    151. 

  151. 							</tbody>
    152. 

  152. 						</table>
    153. 

  153. 						<dl class="details">
    154. 

  154. 							<dt class="tag-returns"><strong>Returns:</strong> The Euclidean modulo.</dt>
    155. 

  155. 						</dl>
    156. 

  156. 					</div>
    157. 

  157. 					<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>
    158. 

  158. 					<div class="method">
    159. 

  159. 						<div class="description">
    160. 

  160. 							<p>Returns the largest power of two that is less than or equal to the given number.</p>
    161. 

  161. 						</div>
    162. 

  162. 						<table class="params">
    163. 

  163. 							<tbody>
    164. 

  164. 								<tr>
    165. 

  165. 									<td class="name"><code>value</code></td>
    166. 

  166. 									<td class="description last"><p>The value to find a POT for.</p></td>
    167. 

  167. 								</tr>
    168. 

  168. 							</tbody>
    169. 

  169. 						</table>
    170. 

  170. 						<dl class="details">
    171. 

  171. 							<dt class="tag-returns"><strong>Returns:</strong> The largest power of two that is less than or equal to the given number.</dt>
    172. 

  172. 						</dl>
    173. 

  173. 					</div>
    174. 

  174. 					<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>
    175. 

  175. 					<div class="method">
    176. 

  176. 						<div class="description">
    177. 

  177. 							<p>Generate a <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a>
    178. 

  178. (universally unique identifier).</p>
    179. 

  179. 						</div>
    180. 

  180. 						<dl class="details">
    181. 

  181. 							<dt class="tag-returns"><strong>Returns:</strong> The UUID.</dt>
    182. 

  182. 						</dl>
    183. 

  183. 					</div>
    184. 

  184. 					<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>
    185. 

  185. 					<div class="method">
    186. 

  186. 						<div class="description">
    187. 

  187. 							<p>Returns the percentage in the closed interval <code>[0, 1]</code> of the given value
    188. 

  188. between the start and end point.</p>
    189. 

  189. 						</div>
    190. 

  190. 						<table class="params">
    191. 

  191. 							<tbody>
    192. 

  192. 								<tr>
    193. 

  193. 									<td class="name"><code>x</code></td>
    194. 

  194. 									<td class="description last"><p>The start point</p></td>
    195. 

  195. 								</tr>
    196. 

  196. 								<tr>
    197. 

  197. 									<td class="name"><code>y</code></td>
    198. 

  198. 									<td class="description last"><p>The end point.</p></td>
    199. 

  199. 								</tr>
    200. 

  200. 								<tr>
    201. 

  201. 									<td class="name"><code>value</code></td>
    202. 

  202. 									<td class="description last"><p>A value between start and end.</p></td>
    203. 

  203. 								</tr>
    204. 

  204. 							</tbody>
    205. 

  205. 						</table>
    206. 

  206. 						<dl class="details">
    207. 

  207. 							<dt class="tag-returns"><strong>Returns:</strong> The interpolation factor.</dt>
    208. 

  208. 						</dl>
    209. 

  209. 					</div>
    210. 

  210. 					<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>
    211. 

  211. 					<div class="method">
    212. 

  212. 						<div class="description">
    213. 

  213. 							<p>Returns <code>true</code> if the given number is a power of two.</p>
    214. 

  214. 						</div>
    215. 

  215. 						<table class="params">
    216. 

  216. 							<tbody>
    217. 

  217. 								<tr>
    218. 

  218. 									<td class="name"><code>value</code></td>
    219. 

  219. 									<td class="description last"><p>The value to check.</p></td>
    220. 

  220. 								</tr>
    221. 

  221. 							</tbody>
    222. 

  222. 						</table>
    223. 

  223. 						<dl class="details">
    224. 

  224. 							<dt class="tag-returns"><strong>Returns:</strong> Whether the given number is a power of two or not.</dt>
    225. 

  225. 						</dl>
    226. 

  226. 					</div>
    227. 

  227. 					<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>
    228. 

  228. 					<div class="method">
    229. 

  229. 						<div class="description">
    230. 

  230. 							<p>Returns a value linearly interpolated from two known points based on the given interval -
    231. 

  231. <code>t = 0</code> will return <code>x</code> and <code>t = 1</code> will return <code>y</code>.</p>
    232. 

  232. 						</div>
    233. 

  233. 						<table class="params">
    234. 

  234. 							<tbody>
    235. 

  235. 								<tr>
    236. 

  236. 									<td class="name"><code>x</code></td>
    237. 

  237. 									<td class="description last"><p>The start point</p></td>
    238. 

  238. 								</tr>
    239. 

  239. 								<tr>
    240. 

  240. 									<td class="name"><code>y</code></td>
    241. 

  241. 									<td class="description last"><p>The end point.</p></td>
    242. 

  242. 								</tr>
    243. 

  243. 								<tr>
    244. 

  244. 									<td class="name"><code>t</code></td>
    245. 

  245. 									<td class="description last"><p>The interpolation factor in the closed interval <code>[0, 1]</code>.</p></td>
    246. 

  246. 								</tr>
    247. 

  247. 							</tbody>
    248. 

  248. 						</table>
    249. 

  249. 						<dl class="details">
    250. 

  250. 							<dt class="tag-returns"><strong>Returns:</strong> The interpolated value.</dt>
    251. 

  251. 						</dl>
    252. 

  252. 					</div>
    253. 

  253. 					<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>
    254. 

  254. 					<div class="method">
    255. 

  255. 						<div class="description">
    256. 

  256. 							<p>Performs a linear mapping from range <code>&lt;a1, a2&gt;</code> to range <code>&lt;b1, b2&gt;</code>
    257. 

  257. for the given value.</p>
    258. 

  258. 						</div>
    259. 

  259. 						<table class="params">
    260. 

  260. 							<tbody>
    261. 

  261. 								<tr>
    262. 

  262. 									<td class="name"><code>x</code></td>
    263. 

  263. 									<td class="description last"><p>The value to be mapped.</p></td>
    264. 

  264. 								</tr>
    265. 

  265. 								<tr>
    266. 

  266. 									<td class="name"><code>a1</code></td>
    267. 

  267. 									<td class="description last"><p>Minimum value for range A.</p></td>
    268. 

  268. 								</tr>
    269. 

  269. 								<tr>
    270. 

  270. 									<td class="name"><code>a2</code></td>
    271. 

  271. 									<td class="description last"><p>Maximum value for range A.</p></td>
    272. 

  272. 								</tr>
    273. 

  273. 								<tr>
    274. 

  274. 									<td class="name"><code>b1</code></td>
    275. 

  275. 									<td class="description last"><p>Minimum value for range B.</p></td>
    276. 

  276. 								</tr>
    277. 

  277. 								<tr>
    278. 

  278. 									<td class="name"><code>b2</code></td>
    279. 

  279. 									<td class="description last"><p>Maximum value for range B.</p></td>
    280. 

  280. 								</tr>
    281. 

  281. 							</tbody>
    282. 

  282. 						</table>
    283. 

  283. 						<dl class="details">
    284. 

  284. 							<dt class="tag-returns"><strong>Returns:</strong> The mapped value.</dt>
    285. 

  285. 						</dl>
    286. 

  286. 					</div>
    287. 

  287. 					<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>
    288. 

  288. 					<div class="method">
    289. 

  289. 						<div class="description">
    290. 

  290. 							<p>Normalizes the given value according to the given typed array.</p>
    291. 

  291. 						</div>
    292. 

  292. 						<table class="params">
    293. 

  293. 							<tbody>
    294. 

  294. 								<tr>
    295. 

  295. 									<td class="name"><code>value</code></td>
    296. 

  296. 									<td class="description last"><p>The float value in the range <code>[0,1]</code> to normalize.</p></td>
    297. 

  297. 								</tr>
    298. 

  298. 								<tr>
    299. 

  299. 									<td class="name"><code>array</code></td>
    300. 

  300. 									<td class="description last"><p>The typed array that defines the data type of the value.</p></td>
    301. 

  301. 								</tr>
    302. 

  302. 							</tbody>
    303. 

  303. 						</table>
    304. 

  304. 						<dl class="details">
    305. 

  305. 							<dt class="tag-returns"><strong>Returns:</strong> The normalize value.</dt>
    306. 

  306. 						</dl>
    307. 

  307. 					</div>
    308. 

  308. 					<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>
    309. 

  309. 					<div class="method">
    310. 

  310. 						<div class="description">
    311. 

  311. 							<p>Returns a value that alternates between <code>0</code> and the given <code>length</code> parameter.</p>
    312. 

  312. 						</div>
    313. 

  313. 						<table class="params">
    314. 

  314. 							<tbody>
    315. 

  315. 								<tr>
    316. 

  316. 									<td class="name"><code>x</code></td>
    317. 

  317. 									<td class="description last"><p>The value to pingpong.</p></td>
    318. 

  318. 								</tr>
    319. 

  319. 								<tr>
    320. 

  320. 									<td class="name"><code>length</code></td>
    321. 

  321. 									<td class="description last"><p>The positive value the function will pingpong to.<br/>Default is <code>1</code>.</p></td>
    322. 

  322. 								</tr>
    323. 

  323. 							</tbody>
    324. 

  324. 						</table>
    325. 

  325. 						<dl class="details">
    326. 

  326. 							<dt class="tag-returns"><strong>Returns:</strong> The alternated value.</dt>
    327. 

  327. 						</dl>
    328. 

  328. 					</div>
    329. 

  329. 					<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>
    330. 

  330. 					<div class="method">
    331. 

  331. 						<div class="description">
    332. 

  332. 							<p>Converts radians to degrees.</p>
    333. 

  333. 						</div>
    334. 

  334. 						<table class="params">
    335. 

  335. 							<tbody>
    336. 

  336. 								<tr>
    337. 

  337. 									<td class="name"><code>radians</code></td>
    338. 

  338. 									<td class="description last"><p>A value in radians.</p></td>
    339. 

  339. 								</tr>
    340. 

  340. 							</tbody>
    341. 

  341. 						</table>
    342. 

  342. 						<dl class="details">
    343. 

  343. 							<dt class="tag-returns"><strong>Returns:</strong> The converted value in degrees.</dt>
    344. 

  344. 						</dl>
    345. 

  345. 					</div>
    346. 

  346. 					<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>
    347. 

  347. 					<div class="method">
    348. 

  348. 						<div class="description">
    349. 

  349. 							<p>Returns a random float from <code>&lt;low, high&gt;</code> interval.</p>
    350. 

  350. 						</div>
    351. 

  351. 						<table class="params">
    352. 

  352. 							<tbody>
    353. 

  353. 								<tr>
    354. 

  354. 									<td class="name"><code>low</code></td>
    355. 

  355. 									<td class="description last"><p>The lower value boundary.</p></td>
    356. 

  356. 								</tr>
    357. 

  357. 								<tr>
    358. 

  358. 									<td class="name"><code>high</code></td>
    359. 

  359. 									<td class="description last"><p>The upper value boundary</p></td>
    360. 

  360. 								</tr>
    361. 

  361. 							</tbody>
    362. 

  362. 						</table>
    363. 

  363. 						<dl class="details">
    364. 

  364. 							<dt class="tag-returns"><strong>Returns:</strong> A random float.</dt>
    365. 

  365. 						</dl>
    366. 

  366. 					</div>
    367. 

  367. 					<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>
    368. 

  368. 					<div class="method">
    369. 

  369. 						<div class="description">
    370. 

  370. 							<p>Returns a random integer from <code>&lt;-range/2, range/2&gt;</code> interval.</p>
    371. 

  371. 						</div>
    372. 

  372. 						<table class="params">
    373. 

  373. 							<tbody>
    374. 

  374. 								<tr>
    375. 

  375. 									<td class="name"><code>range</code></td>
    376. 

  376. 									<td class="description last"><p>Defines the value range.</p></td>
    377. 

  377. 								</tr>
    378. 

  378. 							</tbody>
    379. 

  379. 						</table>
    380. 

  380. 						<dl class="details">
    381. 

  381. 							<dt class="tag-returns"><strong>Returns:</strong> A random float.</dt>
    382. 

  382. 						</dl>
    383. 

  383. 					</div>
    384. 

  384. 					<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>
    385. 

  385. 					<div class="method">
    386. 

  386. 						<div class="description">
    387. 

  387. 							<p>Returns a random integer from <code>&lt;low, high&gt;</code> interval.</p>
    388. 

  388. 						</div>
    389. 

  389. 						<table class="params">
    390. 

  390. 							<tbody>
    391. 

  391. 								<tr>
    392. 

  392. 									<td class="name"><code>low</code></td>
    393. 

  393. 									<td class="description last"><p>The lower value boundary.</p></td>
    394. 

  394. 								</tr>
    395. 

  395. 								<tr>
    396. 

  396. 									<td class="name"><code>high</code></td>
    397. 

  397. 									<td class="description last"><p>The upper value boundary</p></td>
    398. 

  398. 								</tr>
    399. 

  399. 							</tbody>
    400. 

  400. 						</table>
    401. 

  401. 						<dl class="details">
    402. 

  402. 							<dt class="tag-returns"><strong>Returns:</strong> A random integer.</dt>
    403. 

  403. 						</dl>
    404. 

  404. 					</div>
    405. 

  405. 					<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>
    406. 

  406. 					<div class="method">
    407. 

  407. 						<div class="description">
    408. 

  408. 							<p>Returns a deterministic pseudo-random float in the interval <code>[0, 1]</code>.</p>
    409. 

  409. 						</div>
    410. 

  410. 						<table class="params">
    411. 

  411. 							<tbody>
    412. 

  412. 								<tr>
    413. 

  413. 									<td class="name"><code>s</code></td>
    414. 

  414. 									<td class="description last"><p>The integer seed.</p></td>
    415. 

  415. 								</tr>
    416. 

  416. 							</tbody>
    417. 

  417. 						</table>
    418. 

  418. 						<dl class="details">
    419. 

  419. 							<dt class="tag-returns"><strong>Returns:</strong> A random float.</dt>
    420. 

  420. 						</dl>
    421. 

  421. 					</div>
    422. 

  422. 					<h3 class="name name-method" id=".setQuaternionFromProperEuler" translate="no">.<a href="#.setQuaternionFromProperEuler">setQuaternionFromProperEuler</a><span class="signature">( q : <span class="param-type">Quaternion</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>
    423. 

  423. 					<div class="method">
    424. 

  424. 						<div class="description">
    425. 

  425. 							<p>Sets the given quaternion from the <a href="https://en.wikipedia.org/wiki/Euler_angles">Intrinsic Proper Euler Angles</a>
    426. 

  426. defined by the given angles and order.</p>
    427. 

  427. <p>Rotations are applied to the axes in the order specified by order:
    428. 

  428. rotation by angle <code>a</code> is applied first, then by angle <code>b</code>, then by angle <code>c</code>.</p>
    429. 

  429. 						</div>
    430. 

  430. 						<table class="params">
    431. 

  431. 							<tbody>
    432. 

  432. 								<tr>
    433. 

  433. 									<td class="name"><code>q</code></td>
    434. 

  434. 									<td class="description last"><p>The quaternion to set.</p></td>
    435. 

  435. 								</tr>
    436. 

  436. 								<tr>
    437. 

  437. 									<td class="name"><code>a</code></td>
    438. 

  438. 									<td class="description last"><p>The rotation applied to the first axis, in radians.</p></td>
    439. 

  439. 								</tr>
    440. 

  440. 								<tr>
    441. 

  441. 									<td class="name"><code>b</code></td>
    442. 

  442. 									<td class="description last"><p>The rotation applied to the second axis, in radians.</p></td>
    443. 

  443. 								</tr>
    444. 

  444. 								<tr>
    445. 

  445. 									<td class="name"><code>c</code></td>
    446. 

  446. 									<td class="description last"><p>The rotation applied to the third axis, in radians.</p></td>
    447. 

  447. 								</tr>
    448. 

  448. 								<tr>
    449. 

  449. 									<td class="name"><code>order</code></td>
    450. 

  450. 									<td class="description last"><p>A string specifying the axes order.</p></td>
    451. 

  451. 								</tr>
    452. 

  452. 							</tbody>
    453. 

  453. 						</table>
    454. 

  454. 					</div>
    455. 

  455. 					<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>
    456. 

  456. 					<div class="method">
    457. 

  457. 						<div class="description">
    458. 

  458. 							<p>A <a href="https://en.wikipedia.org/wiki/Smoothstep#Variations">variation on smoothstep</a>
    459. 

  459. that has zero 1st and 2nd order derivatives at x=0 and x=1.</p>
    460. 

  460. 						</div>
    461. 

  461. 						<table class="params">
    462. 

  462. 							<tbody>
    463. 

  463. 								<tr>
    464. 

  464. 									<td class="name"><code>x</code></td>
    465. 

  465. 									<td class="description last"><p>The value to evaluate based on its position between min and max.</p></td>
    466. 

  466. 								</tr>
    467. 

  467. 								<tr>
    468. 

  468. 									<td class="name"><code>min</code></td>
    469. 

  469. 									<td class="description last"><p>The min value. Any x value below min will be <code>0</code>.</p></td>
    470. 

  470. 								</tr>
    471. 

  471. 								<tr>
    472. 

  472. 									<td class="name"><code>max</code></td>
    473. 

  473. 									<td class="description last"><p>The max value. Any x value above max will be <code>1</code>.</p></td>
    474. 

  474. 								</tr>
    475. 

  475. 							</tbody>
    476. 

  476. 						</table>
    477. 

  477. 						<dl class="details">
    478. 

  478. 							<dt class="tag-returns"><strong>Returns:</strong> The alternated value.</dt>
    479. 

  479. 						</dl>
    480. 

  480. 					</div>
    481. 

  481. 					<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>
    482. 

  482. 					<div class="method">
    483. 

  483. 						<div class="description">
    484. 

  484. 							<p>Returns a value in the range <code>[0,1]</code> that represents the percentage that <code>x</code> has
    485. 

  485. moved between <code>min</code> and <code>max</code>, but smoothed or slowed down the closer <code>x</code> is to
    486. 

  486. the <code>min</code> and <code>max</code>.</p>
    487. 

  487. <p>See <a href="http://en.wikipedia.org/wiki/Smoothstep">Smoothstep</a> for more details.</p>
    488. 

  488. 						</div>
    489. 

  489. 						<table class="params">
    490. 

  490. 							<tbody>
    491. 

  491. 								<tr>
    492. 

  492. 									<td class="name"><code>x</code></td>
    493. 

  493. 									<td class="description last"><p>The value to evaluate based on its position between min and max.</p></td>
    494. 

  494. 								</tr>
    495. 

  495. 								<tr>
    496. 

  496. 									<td class="name"><code>min</code></td>
    497. 

  497. 									<td class="description last"><p>The min value. Any x value below min will be <code>0</code>.</p></td>
    498. 

  498. 								</tr>
    499. 

  499. 								<tr>
    500. 

  500. 									<td class="name"><code>max</code></td>
    501. 

  501. 									<td class="description last"><p>The max value. Any x value above max will be <code>1</code>.</p></td>
    502. 

  502. 								</tr>
    503. 

  503. 							</tbody>
    504. 

  504. 						</table>
    505. 

  505. 						<dl class="details">
    506. 

  506. 							<dt class="tag-returns"><strong>Returns:</strong> The alternated value.</dt>
    507. 

  507. 						</dl>
    508. 

  508. 					</div>
    509. 

  509. 				<h2 class="subsection-title">Source</h2>
    510. 

  510. 				<p>
    511. 

  511. 					<a href="https://github.com/mrdoob/three.js/blob/master/src/math/MathUtils.js" target="_blank" rel="noopener" translate="no">src/math/MathUtils.js</a>
    512. 

  512. 				</p>
    513. 

  513. 			</article>
    514. 

  514. 		</section>
    515. 

  515. <script src="../scripts/linenumber.js"></script>
    516. 

  516. <script src="../scripts/page.js"></script>
    517. 

  517. </body>
    518. 

  518. </html>
    519.
粤ICP备19079148号