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
/
Vector3.html

Vector3.html 63 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373 
  1. <!DOCTYPE html>
    2. 

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

  3. <head>
    4. 

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

  5. 	<title>Vector3 - 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">Vector3</h1>
    13. 

  13. 		<section>
    14. 

  14. 			<header>
    15. 

  15. 				<div class="class-description"><p>Class representing a 3D vector. A 3D vector is an ordered triplet of numbers
    16. 

  16. (labeled x, y and z), which can be used to represent a number of things, such as:</p>
    17. 

  17. <ul>
    18. 

  18. <li>A point in 3D space.</li>
    19. 

  19. <li>A direction and length in 3D space. In three.js the length will
    20. 

  20. always be the Euclidean distance(straight-line distance) from <code>(0, 0, 0)</code> to <code>(x, y, z)</code>
    21. 

  21. and the direction is also measured from <code>(0, 0, 0)</code> towards <code>(x, y, z)</code>.</li>
    22. 

  22. <li>Any arbitrary ordered triplet of numbers.</li>
    23. 

  23. </ul>
    24. 

  24. <p>There are other things a 3D vector can be used to represent, such as
    25. 

  25. momentum vectors and so on, however these are the most
    26. 

  26. common uses in three.js.</p>
    27. 

  27. <p>Iterating through a vector instance will yield its components <code>(x, y, z)</code> in
    28. 

  28. the corresponding order.</p></div>
    29. 

  29. 				<h2>Code Example</h2>
    30. 

  30. 				<div translate="no"><pre><code class="language-js">const a = new THREE.Vector3( 0, 1, 0 );
    31. 

  31. //no arguments; will be initialised to (0, 0, 0)
    32. 

  32. const b = new THREE.Vector3( );
    33. 

  33. const d = a.distanceTo( b );
    34. 

  34. </code></pre></div>
    35. 

  35. 			</header>
    36. 

  36. 			<article>
    37. 

  37. 				<div class="container-overview">
    38. 

  38. 					<h2>Constructor</h2>
    39. 

  39. 					<h3 class="name name-method" id="Vector3" translate="no">new <a href="#Vector3">Vector3</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> </h3>
    40. 

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

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

  42. 							<p>Constructs a new 3D vector.</p>
    43. 

  43. 						</div>
    44. 

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

  45. 							<tbody>
    46. 

  46. 								<tr>
    47. 

  47. 									<td class="name"><code>x</code></td>
    48. 

  48. 									<td class="description last"><p>The x value of this vector.<br/>Default is <code>0</code>.</p></td>
    49. 

  49. 								</tr>
    50. 

  50. 								<tr>
    51. 

  51. 									<td class="name"><code>y</code></td>
    52. 

  52. 									<td class="description last"><p>The y value of this vector.<br/>Default is <code>0</code>.</p></td>
    53. 

  53. 								</tr>
    54. 

  54. 								<tr>
    55. 

  55. 									<td class="name"><code>z</code></td>
    56. 

  56. 									<td class="description last"><p>The z value of this vector.<br/>Default is <code>0</code>.</p></td>
    57. 

  57. 								</tr>
    58. 

  58. 							</tbody>
    59. 

  59. 						</table>
    60. 

  60. 					</div>
    61. 

  61. 				</div>
    62. 

  62. 				<h2 class="subsection-title">Properties</h2>
    63. 

  63. 				<div class="member">
    64. 

  64. 					<h3 class="name" id="isVector3" translate="no">.<a href="#isVector3">isVector3</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
    65. 

  65. 					<div class="description">
    66. 

  66. 						<p>This flag can be used for type testing.<br/>Default is <code>true</code>.</p>
    67. 

  67. 					</div>
    68. 

  68. 				</div>
    69. 

  69. 				<div class="member">
    70. 

  70. 					<h3 class="name" id="x" translate="no">.<a href="#x">x</a><span class="type-signature"> : number</span> </h3>
    71. 

  71. 					<div class="description">
    72. 

  72. 						<p>The x value of this vector.</p>
    73. 

  73. 					</div>
    74. 

  74. 				</div>
    75. 

  75. 				<div class="member">
    76. 

  76. 					<h3 class="name" id="y" translate="no">.<a href="#y">y</a><span class="type-signature"> : number</span> </h3>
    77. 

  77. 					<div class="description">
    78. 

  78. 						<p>The y value of this vector.</p>
    79. 

  79. 					</div>
    80. 

  80. 				</div>
    81. 

  81. 				<div class="member">
    82. 

  82. 					<h3 class="name" id="z" translate="no">.<a href="#z">z</a><span class="type-signature"> : number</span> </h3>
    83. 

  83. 					<div class="description">
    84. 

  84. 						<p>The z value of this vector.</p>
    85. 

  85. 					</div>
    86. 

  86. 				</div>
    87. 

  87. 				<h2 class="subsection-title">Methods</h2>
    88. 

  88. 					<h3 class="name name-method" id="add" translate="no">.<a href="#add">add</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    89. 

  89. 					<div class="method">
    90. 

  90. 						<div class="description">
    91. 

  91. 							<p>Adds the given vector to this instance.</p>
    92. 

  92. 						</div>
    93. 

  93. 						<table class="params">
    94. 

  94. 							<tbody>
    95. 

  95. 								<tr>
    96. 

  96. 									<td class="name"><code>v</code></td>
    97. 

  97. 									<td class="description last"><p>The vector to add.</p></td>
    98. 

  98. 								</tr>
    99. 

  99. 							</tbody>
    100. 

  100. 						</table>
    101. 

  101. 						<dl class="details">
    102. 

  102. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    103. 

  103. 						</dl>
    104. 

  104. 					</div>
    105. 

  105. 					<h3 class="name name-method" id="addScalar" translate="no">.<a href="#addScalar">addScalar</a><span class="signature">( s : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    106. 

  106. 					<div class="method">
    107. 

  107. 						<div class="description">
    108. 

  108. 							<p>Adds the given scalar value to all components of this instance.</p>
    109. 

  109. 						</div>
    110. 

  110. 						<table class="params">
    111. 

  111. 							<tbody>
    112. 

  112. 								<tr>
    113. 

  113. 									<td class="name"><code>s</code></td>
    114. 

  114. 									<td class="description last"><p>The scalar to add.</p></td>
    115. 

  115. 								</tr>
    116. 

  116. 							</tbody>
    117. 

  117. 						</table>
    118. 

  118. 						<dl class="details">
    119. 

  119. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    120. 

  120. 						</dl>
    121. 

  121. 					</div>
    122. 

  122. 					<h3 class="name name-method" id="addScaledVector" translate="no">.<a href="#addScaledVector">addScaledVector</a><span class="signature">( v : <span class="param-type">Vector3 | Vector4</span>, s : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    123. 

  123. 					<div class="method">
    124. 

  124. 						<div class="description">
    125. 

  125. 							<p>Adds the given vector scaled by the given factor to this instance.</p>
    126. 

  126. 						</div>
    127. 

  127. 						<table class="params">
    128. 

  128. 							<tbody>
    129. 

  129. 								<tr>
    130. 

  130. 									<td class="name"><code>v</code></td>
    131. 

  131. 									<td class="description last"><p>The vector.</p></td>
    132. 

  132. 								</tr>
    133. 

  133. 								<tr>
    134. 

  134. 									<td class="name"><code>s</code></td>
    135. 

  135. 									<td class="description last"><p>The factor that scales <code>v</code>.</p></td>
    136. 

  136. 								</tr>
    137. 

  137. 							</tbody>
    138. 

  138. 						</table>
    139. 

  139. 						<dl class="details">
    140. 

  140. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    141. 

  141. 						</dl>
    142. 

  142. 					</div>
    143. 

  143. 					<h3 class="name name-method" id="addVectors" translate="no">.<a href="#addVectors">addVectors</a><span class="signature">( a : <span class="param-type">Vector3</span>, b : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    144. 

  144. 					<div class="method">
    145. 

  145. 						<div class="description">
    146. 

  146. 							<p>Adds the given vectors and stores the result in this instance.</p>
    147. 

  147. 						</div>
    148. 

  148. 						<table class="params">
    149. 

  149. 							<tbody>
    150. 

  150. 								<tr>
    151. 

  151. 									<td class="name"><code>a</code></td>
    152. 

  152. 									<td class="description last"><p>The first vector.</p></td>
    153. 

  153. 								</tr>
    154. 

  154. 								<tr>
    155. 

  155. 									<td class="name"><code>b</code></td>
    156. 

  156. 									<td class="description last"><p>The second vector.</p></td>
    157. 

  157. 								</tr>
    158. 

  158. 							</tbody>
    159. 

  159. 						</table>
    160. 

  160. 						<dl class="details">
    161. 

  161. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    162. 

  162. 						</dl>
    163. 

  163. 					</div>
    164. 

  164. 					<h3 class="name name-method" id="angleTo" translate="no">.<a href="#angleTo">angleTo</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : number</span> </h3>
    165. 

  165. 					<div class="method">
    166. 

  166. 						<div class="description">
    167. 

  167. 							<p>Returns the angle between the given vector and this instance in radians.</p>
    168. 

  168. 						</div>
    169. 

  169. 						<table class="params">
    170. 

  170. 							<tbody>
    171. 

  171. 								<tr>
    172. 

  172. 									<td class="name"><code>v</code></td>
    173. 

  173. 									<td class="description last"><p>The vector to compute the angle with.</p></td>
    174. 

  174. 								</tr>
    175. 

  175. 							</tbody>
    176. 

  176. 						</table>
    177. 

  177. 						<dl class="details">
    178. 

  178. 							<dt class="tag-returns"><strong>Returns:</strong> The angle in radians.</dt>
    179. 

  179. 						</dl>
    180. 

  180. 					</div>
    181. 

  181. 					<h3 class="name name-method" id="applyAxisAngle" translate="no">.<a href="#applyAxisAngle">applyAxisAngle</a><span class="signature">( axis : <span class="param-type">Vector3</span>, angle : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    182. 

  182. 					<div class="method">
    183. 

  183. 						<div class="description">
    184. 

  184. 							<p>Applies a rotation specified by an axis and an angle to this vector.</p>
    185. 

  185. 						</div>
    186. 

  186. 						<table class="params">
    187. 

  187. 							<tbody>
    188. 

  188. 								<tr>
    189. 

  189. 									<td class="name"><code>axis</code></td>
    190. 

  190. 									<td class="description last"><p>A normalized vector representing the rotation axis.</p></td>
    191. 

  191. 								</tr>
    192. 

  192. 								<tr>
    193. 

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

  194. 									<td class="description last"><p>The angle in radians.</p></td>
    195. 

  195. 								</tr>
    196. 

  196. 							</tbody>
    197. 

  197. 						</table>
    198. 

  198. 						<dl class="details">
    199. 

  199. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    200. 

  200. 						</dl>
    201. 

  201. 					</div>
    202. 

  202. 					<h3 class="name name-method" id="applyEuler" translate="no">.<a href="#applyEuler">applyEuler</a><span class="signature">( euler : <span class="param-type">Euler</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    203. 

  203. 					<div class="method">
    204. 

  204. 						<div class="description">
    205. 

  205. 							<p>Applies the given Euler rotation to this vector.</p>
    206. 

  206. 						</div>
    207. 

  207. 						<table class="params">
    208. 

  208. 							<tbody>
    209. 

  209. 								<tr>
    210. 

  210. 									<td class="name"><code>euler</code></td>
    211. 

  211. 									<td class="description last"><p>The Euler angles.</p></td>
    212. 

  212. 								</tr>
    213. 

  213. 							</tbody>
    214. 

  214. 						</table>
    215. 

  215. 						<dl class="details">
    216. 

  216. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    217. 

  217. 						</dl>
    218. 

  218. 					</div>
    219. 

  219. 					<h3 class="name name-method" id="applyMatrix3" translate="no">.<a href="#applyMatrix3">applyMatrix3</a><span class="signature">( m : <span class="param-type">Matrix3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    220. 

  220. 					<div class="method">
    221. 

  221. 						<div class="description">
    222. 

  222. 							<p>Multiplies this vector with the given 3x3 matrix.</p>
    223. 

  223. 						</div>
    224. 

  224. 						<table class="params">
    225. 

  225. 							<tbody>
    226. 

  226. 								<tr>
    227. 

  227. 									<td class="name"><code>m</code></td>
    228. 

  228. 									<td class="description last"><p>The 3x3 matrix.</p></td>
    229. 

  229. 								</tr>
    230. 

  230. 							</tbody>
    231. 

  231. 						</table>
    232. 

  232. 						<dl class="details">
    233. 

  233. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    234. 

  234. 						</dl>
    235. 

  235. 					</div>
    236. 

  236. 					<h3 class="name name-method" id="applyMatrix4" translate="no">.<a href="#applyMatrix4">applyMatrix4</a><span class="signature">( m : <span class="param-type">Matrix4</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    237. 

  237. 					<div class="method">
    238. 

  238. 						<div class="description">
    239. 

  239. 							<p>Multiplies this vector (with an implicit 1 in the 4th dimension) by m, and
    240. 

  240. divides by perspective.</p>
    241. 

  241. 						</div>
    242. 

  242. 						<table class="params">
    243. 

  243. 							<tbody>
    244. 

  244. 								<tr>
    245. 

  245. 									<td class="name"><code>m</code></td>
    246. 

  246. 									<td class="description last"><p>The matrix to apply.</p></td>
    247. 

  247. 								</tr>
    248. 

  248. 							</tbody>
    249. 

  249. 						</table>
    250. 

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

  251. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    252. 

  252. 						</dl>
    253. 

  253. 					</div>
    254. 

  254. 					<h3 class="name name-method" id="applyNormalMatrix" translate="no">.<a href="#applyNormalMatrix">applyNormalMatrix</a><span class="signature">( m : <span class="param-type">Matrix3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    255. 

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

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

  257. 							<p>Multiplies this vector by the given normal matrix and normalizes
    258. 

  258. the result.</p>
    259. 

  259. 						</div>
    260. 

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

  261. 							<tbody>
    262. 

  262. 								<tr>
    263. 

  263. 									<td class="name"><code>m</code></td>
    264. 

  264. 									<td class="description last"><p>The normal matrix.</p></td>
    265. 

  265. 								</tr>
    266. 

  266. 							</tbody>
    267. 

  267. 						</table>
    268. 

  268. 						<dl class="details">
    269. 

  269. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    270. 

  270. 						</dl>
    271. 

  271. 					</div>
    272. 

  272. 					<h3 class="name name-method" id="applyQuaternion" translate="no">.<a href="#applyQuaternion">applyQuaternion</a><span class="signature">( q : <span class="param-type">Quaternion</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    273. 

  273. 					<div class="method">
    274. 

  274. 						<div class="description">
    275. 

  275. 							<p>Applies the given Quaternion to this vector.</p>
    276. 

  276. 						</div>
    277. 

  277. 						<table class="params">
    278. 

  278. 							<tbody>
    279. 

  279. 								<tr>
    280. 

  280. 									<td class="name"><code>q</code></td>
    281. 

  281. 									<td class="description last"><p>The Quaternion.</p></td>
    282. 

  282. 								</tr>
    283. 

  283. 							</tbody>
    284. 

  284. 						</table>
    285. 

  285. 						<dl class="details">
    286. 

  286. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    287. 

  287. 						</dl>
    288. 

  288. 					</div>
    289. 

  289. 					<h3 class="name name-method" id="ceil" translate="no">.<a href="#ceil">ceil</a><span class="signature">()</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    290. 

  290. 					<div class="method">
    291. 

  291. 						<div class="description">
    292. 

  292. 							<p>The components of this vector are rounded up to the nearest integer value.</p>
    293. 

  293. 						</div>
    294. 

  294. 						<dl class="details">
    295. 

  295. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    296. 

  296. 						</dl>
    297. 

  297. 					</div>
    298. 

  298. 					<h3 class="name name-method" id="clamp" translate="no">.<a href="#clamp">clamp</a><span class="signature">( min : <span class="param-type">Vector3</span>, max : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    299. 

  299. 					<div class="method">
    300. 

  300. 						<div class="description">
    301. 

  301. 							<p>If this vector's x, y or z value is greater than the max vector's x, y or z
    302. 

  302. value, it is replaced by the corresponding value.
    303. 

  303. If this vector's x, y or z value is less than the min vector's x, y or z value,
    304. 

  304. it is replaced by the corresponding value.</p>
    305. 

  305. 						</div>
    306. 

  306. 						<table class="params">
    307. 

  307. 							<tbody>
    308. 

  308. 								<tr>
    309. 

  309. 									<td class="name"><code>min</code></td>
    310. 

  310. 									<td class="description last"><p>The minimum x, y and z values.</p></td>
    311. 

  311. 								</tr>
    312. 

  312. 								<tr>
    313. 

  313. 									<td class="name"><code>max</code></td>
    314. 

  314. 									<td class="description last"><p>The maximum x, y and z values in the desired range.</p></td>
    315. 

  315. 								</tr>
    316. 

  316. 							</tbody>
    317. 

  317. 						</table>
    318. 

  318. 						<dl class="details">
    319. 

  319. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    320. 

  320. 						</dl>
    321. 

  321. 					</div>
    322. 

  322. 					<h3 class="name name-method" id="clampLength" translate="no">.<a href="#clampLength">clampLength</a><span class="signature">( min : <span class="param-type">number</span>, max : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    323. 

  323. 					<div class="method">
    324. 

  324. 						<div class="description">
    325. 

  325. 							<p>If this vector's length is greater than the max value, it is replaced by
    326. 

  326. the max value.
    327. 

  327. If this vector's length is less than the min value, it is replaced by the
    328. 

  328. min value.</p>
    329. 

  329. 						</div>
    330. 

  330. 						<table class="params">
    331. 

  331. 							<tbody>
    332. 

  332. 								<tr>
    333. 

  333. 									<td class="name"><code>min</code></td>
    334. 

  334. 									<td class="description last"><p>The minimum value the vector length will be clamped to.</p></td>
    335. 

  335. 								</tr>
    336. 

  336. 								<tr>
    337. 

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

  338. 									<td class="description last"><p>The maximum value the vector length will be clamped to.</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> A reference to this vector.</dt>
    344. 

  344. 						</dl>
    345. 

  345. 					</div>
    346. 

  346. 					<h3 class="name name-method" id="clampScalar" translate="no">.<a href="#clampScalar">clampScalar</a><span class="signature">( minVal : <span class="param-type">number</span>, maxVal : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    347. 

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

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

  349. 							<p>If this vector's x, y or z values are greater than the max value, they are
    350. 

  350. replaced by the max value.
    351. 

  351. If this vector's x, y or z values are less than the min value, they are
    352. 

  352. replaced by the min value.</p>
    353. 

  353. 						</div>
    354. 

  354. 						<table class="params">
    355. 

  355. 							<tbody>
    356. 

  356. 								<tr>
    357. 

  357. 									<td class="name"><code>minVal</code></td>
    358. 

  358. 									<td class="description last"><p>The minimum value the components will be clamped to.</p></td>
    359. 

  359. 								</tr>
    360. 

  360. 								<tr>
    361. 

  361. 									<td class="name"><code>maxVal</code></td>
    362. 

  362. 									<td class="description last"><p>The maximum value the components will be clamped to.</p></td>
    363. 

  363. 								</tr>
    364. 

  364. 							</tbody>
    365. 

  365. 						</table>
    366. 

  366. 						<dl class="details">
    367. 

  367. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    368. 

  368. 						</dl>
    369. 

  369. 					</div>
    370. 

  370. 					<h3 class="name name-method" id="clone" translate="no">.<a href="#clone">clone</a><span class="signature">()</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    371. 

  371. 					<div class="method">
    372. 

  372. 						<div class="description">
    373. 

  373. 							<p>Returns a new vector with copied values from this instance.</p>
    374. 

  374. 						</div>
    375. 

  375. 						<dl class="details">
    376. 

  376. 							<dt class="tag-returns"><strong>Returns:</strong> A clone of this instance.</dt>
    377. 

  377. 						</dl>
    378. 

  378. 					</div>
    379. 

  379. 					<h3 class="name name-method" id="copy" translate="no">.<a href="#copy">copy</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    380. 

  380. 					<div class="method">
    381. 

  381. 						<div class="description">
    382. 

  382. 							<p>Copies the values of the given vector to this instance.</p>
    383. 

  383. 						</div>
    384. 

  384. 						<table class="params">
    385. 

  385. 							<tbody>
    386. 

  386. 								<tr>
    387. 

  387. 									<td class="name"><code>v</code></td>
    388. 

  388. 									<td class="description last"><p>The vector to copy.</p></td>
    389. 

  389. 								</tr>
    390. 

  390. 							</tbody>
    391. 

  391. 						</table>
    392. 

  392. 						<dl class="details">
    393. 

  393. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    394. 

  394. 						</dl>
    395. 

  395. 					</div>
    396. 

  396. 					<h3 class="name name-method" id="cross" translate="no">.<a href="#cross">cross</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    397. 

  397. 					<div class="method">
    398. 

  398. 						<div class="description">
    399. 

  399. 							<p>Calculates the cross product of the given vector with this instance.</p>
    400. 

  400. 						</div>
    401. 

  401. 						<table class="params">
    402. 

  402. 							<tbody>
    403. 

  403. 								<tr>
    404. 

  404. 									<td class="name"><code>v</code></td>
    405. 

  405. 									<td class="description last"><p>The vector to compute the cross product with.</p></td>
    406. 

  406. 								</tr>
    407. 

  407. 							</tbody>
    408. 

  408. 						</table>
    409. 

  409. 						<dl class="details">
    410. 

  410. 							<dt class="tag-returns"><strong>Returns:</strong> The result of the cross product.</dt>
    411. 

  411. 						</dl>
    412. 

  412. 					</div>
    413. 

  413. 					<h3 class="name name-method" id="crossVectors" translate="no">.<a href="#crossVectors">crossVectors</a><span class="signature">( a : <span class="param-type">Vector3</span>, b : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    414. 

  414. 					<div class="method">
    415. 

  415. 						<div class="description">
    416. 

  416. 							<p>Calculates the cross product of the given vectors and stores the result
    417. 

  417. in this instance.</p>
    418. 

  418. 						</div>
    419. 

  419. 						<table class="params">
    420. 

  420. 							<tbody>
    421. 

  421. 								<tr>
    422. 

  422. 									<td class="name"><code>a</code></td>
    423. 

  423. 									<td class="description last"><p>The first vector.</p></td>
    424. 

  424. 								</tr>
    425. 

  425. 								<tr>
    426. 

  426. 									<td class="name"><code>b</code></td>
    427. 

  427. 									<td class="description last"><p>The second vector.</p></td>
    428. 

  428. 								</tr>
    429. 

  429. 							</tbody>
    430. 

  430. 						</table>
    431. 

  431. 						<dl class="details">
    432. 

  432. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    433. 

  433. 						</dl>
    434. 

  434. 					</div>
    435. 

  435. 					<h3 class="name name-method" id="distanceTo" translate="no">.<a href="#distanceTo">distanceTo</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : number</span> </h3>
    436. 

  436. 					<div class="method">
    437. 

  437. 						<div class="description">
    438. 

  438. 							<p>Computes the distance from the given vector to this instance.</p>
    439. 

  439. 						</div>
    440. 

  440. 						<table class="params">
    441. 

  441. 							<tbody>
    442. 

  442. 								<tr>
    443. 

  443. 									<td class="name"><code>v</code></td>
    444. 

  444. 									<td class="description last"><p>The vector to compute the distance to.</p></td>
    445. 

  445. 								</tr>
    446. 

  446. 							</tbody>
    447. 

  447. 						</table>
    448. 

  448. 						<dl class="details">
    449. 

  449. 							<dt class="tag-returns"><strong>Returns:</strong> The distance.</dt>
    450. 

  450. 						</dl>
    451. 

  451. 					</div>
    452. 

  452. 					<h3 class="name name-method" id="distanceToSquared" translate="no">.<a href="#distanceToSquared">distanceToSquared</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : number</span> </h3>
    453. 

  453. 					<div class="method">
    454. 

  454. 						<div class="description">
    455. 

  455. 							<p>Computes the squared distance from the given vector to this instance.
    456. 

  456. If you are just comparing the distance with another distance, you should compare
    457. 

  457. the distance squared instead as it is slightly more efficient to calculate.</p>
    458. 

  458. 						</div>
    459. 

  459. 						<table class="params">
    460. 

  460. 							<tbody>
    461. 

  461. 								<tr>
    462. 

  462. 									<td class="name"><code>v</code></td>
    463. 

  463. 									<td class="description last"><p>The vector to compute the squared distance to.</p></td>
    464. 

  464. 								</tr>
    465. 

  465. 							</tbody>
    466. 

  466. 						</table>
    467. 

  467. 						<dl class="details">
    468. 

  468. 							<dt class="tag-returns"><strong>Returns:</strong> The squared distance.</dt>
    469. 

  469. 						</dl>
    470. 

  470. 					</div>
    471. 

  471. 					<h3 class="name name-method" id="divide" translate="no">.<a href="#divide">divide</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    472. 

  472. 					<div class="method">
    473. 

  473. 						<div class="description">
    474. 

  474. 							<p>Divides this instance by the given vector.</p>
    475. 

  475. 						</div>
    476. 

  476. 						<table class="params">
    477. 

  477. 							<tbody>
    478. 

  478. 								<tr>
    479. 

  479. 									<td class="name"><code>v</code></td>
    480. 

  480. 									<td class="description last"><p>The vector to divide.</p></td>
    481. 

  481. 								</tr>
    482. 

  482. 							</tbody>
    483. 

  483. 						</table>
    484. 

  484. 						<dl class="details">
    485. 

  485. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    486. 

  486. 						</dl>
    487. 

  487. 					</div>
    488. 

  488. 					<h3 class="name name-method" id="divideScalar" translate="no">.<a href="#divideScalar">divideScalar</a><span class="signature">( scalar : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    489. 

  489. 					<div class="method">
    490. 

  490. 						<div class="description">
    491. 

  491. 							<p>Divides this vector by the given scalar.</p>
    492. 

  492. 						</div>
    493. 

  493. 						<table class="params">
    494. 

  494. 							<tbody>
    495. 

  495. 								<tr>
    496. 

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

  497. 									<td class="description last"><p>The scalar to divide.</p></td>
    498. 

  498. 								</tr>
    499. 

  499. 							</tbody>
    500. 

  500. 						</table>
    501. 

  501. 						<dl class="details">
    502. 

  502. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    503. 

  503. 						</dl>
    504. 

  504. 					</div>
    505. 

  505. 					<h3 class="name name-method" id="dot" translate="no">.<a href="#dot">dot</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : number</span> </h3>
    506. 

  506. 					<div class="method">
    507. 

  507. 						<div class="description">
    508. 

  508. 							<p>Calculates the dot product of the given vector with this instance.</p>
    509. 

  509. 						</div>
    510. 

  510. 						<table class="params">
    511. 

  511. 							<tbody>
    512. 

  512. 								<tr>
    513. 

  513. 									<td class="name"><code>v</code></td>
    514. 

  514. 									<td class="description last"><p>The vector to compute the dot product with.</p></td>
    515. 

  515. 								</tr>
    516. 

  516. 							</tbody>
    517. 

  517. 						</table>
    518. 

  518. 						<dl class="details">
    519. 

  519. 							<dt class="tag-returns"><strong>Returns:</strong> The result of the dot product.</dt>
    520. 

  520. 						</dl>
    521. 

  521. 					</div>
    522. 

  522. 					<h3 class="name name-method" id="equals" translate="no">.<a href="#equals">equals</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : boolean</span> </h3>
    523. 

  523. 					<div class="method">
    524. 

  524. 						<div class="description">
    525. 

  525. 							<p>Returns <code>true</code> if this vector is equal with the given one.</p>
    526. 

  526. 						</div>
    527. 

  527. 						<table class="params">
    528. 

  528. 							<tbody>
    529. 

  529. 								<tr>
    530. 

  530. 									<td class="name"><code>v</code></td>
    531. 

  531. 									<td class="description last"><p>The vector to test for equality.</p></td>
    532. 

  532. 								</tr>
    533. 

  533. 							</tbody>
    534. 

  534. 						</table>
    535. 

  535. 						<dl class="details">
    536. 

  536. 							<dt class="tag-returns"><strong>Returns:</strong> Whether this vector is equal with the given one.</dt>
    537. 

  537. 						</dl>
    538. 

  538. 					</div>
    539. 

  539. 					<h3 class="name name-method" id="floor" translate="no">.<a href="#floor">floor</a><span class="signature">()</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    540. 

  540. 					<div class="method">
    541. 

  541. 						<div class="description">
    542. 

  542. 							<p>The components of this vector are rounded down to the nearest integer value.</p>
    543. 

  543. 						</div>
    544. 

  544. 						<dl class="details">
    545. 

  545. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    546. 

  546. 						</dl>
    547. 

  547. 					</div>
    548. 

  548. 					<h3 class="name name-method" id="fromArray" translate="no">.<a href="#fromArray">fromArray</a><span class="signature">( array : <span class="param-type">Array.&lt;number></span>, offset : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    549. 

  549. 					<div class="method">
    550. 

  550. 						<div class="description">
    551. 

  551. 							<p>Sets this vector's x value to be <code>array[ offset ]</code>, y value to be <code>array[ offset + 1 ]</code>
    552. 

  552. and z value to be <code>array[ offset + 2 ]</code>.</p>
    553. 

  553. 						</div>
    554. 

  554. 						<table class="params">
    555. 

  555. 							<tbody>
    556. 

  556. 								<tr>
    557. 

  557. 									<td class="name"><code>array</code></td>
    558. 

  558. 									<td class="description last"><p>An array holding the vector component values.</p></td>
    559. 

  559. 								</tr>
    560. 

  560. 								<tr>
    561. 

  561. 									<td class="name"><code>offset</code></td>
    562. 

  562. 									<td class="description last"><p>The offset into the array.<br/>Default is <code>0</code>.</p></td>
    563. 

  563. 								</tr>
    564. 

  564. 							</tbody>
    565. 

  565. 						</table>
    566. 

  566. 						<dl class="details">
    567. 

  567. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    568. 

  568. 						</dl>
    569. 

  569. 					</div>
    570. 

  570. 					<h3 class="name name-method" id="fromBufferAttribute" translate="no">.<a href="#fromBufferAttribute">fromBufferAttribute</a><span class="signature">( attribute : <span class="param-type">BufferAttribute</span>, index : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    571. 

  571. 					<div class="method">
    572. 

  572. 						<div class="description">
    573. 

  573. 							<p>Sets the components of this vector from the given buffer attribute.</p>
    574. 

  574. 						</div>
    575. 

  575. 						<table class="params">
    576. 

  576. 							<tbody>
    577. 

  577. 								<tr>
    578. 

  578. 									<td class="name"><code>attribute</code></td>
    579. 

  579. 									<td class="description last"><p>The buffer attribute holding vector data.</p></td>
    580. 

  580. 								</tr>
    581. 

  581. 								<tr>
    582. 

  582. 									<td class="name"><code>index</code></td>
    583. 

  583. 									<td class="description last"><p>The index into the attribute.</p></td>
    584. 

  584. 								</tr>
    585. 

  585. 							</tbody>
    586. 

  586. 						</table>
    587. 

  587. 						<dl class="details">
    588. 

  588. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    589. 

  589. 						</dl>
    590. 

  590. 					</div>
    591. 

  591. 					<h3 class="name name-method" id="getComponent" translate="no">.<a href="#getComponent">getComponent</a><span class="signature">( index : <span class="param-type">number</span> )</span><span class="type-signature"> : number</span> </h3>
    592. 

  592. 					<div class="method">
    593. 

  593. 						<div class="description">
    594. 

  594. 							<p>Returns the value of the vector component which matches the given index.</p>
    595. 

  595. 						</div>
    596. 

  596. 						<table class="params">
    597. 

  597. 							<tbody>
    598. 

  598. 								<tr>
    599. 

  599. 									<td class="name"><code>index</code></td>
    600. 

  600. 									<td class="description last"><p>The component index. <code>0</code> equals to x, <code>1</code> equals to y, <code>2</code> equals to z.</p></td>
    601. 

  601. 								</tr>
    602. 

  602. 							</tbody>
    603. 

  603. 						</table>
    604. 

  604. 						<dl class="details">
    605. 

  605. 							<dt class="tag-returns"><strong>Returns:</strong> A vector component value.</dt>
    606. 

  606. 						</dl>
    607. 

  607. 					</div>
    608. 

  608. 					<h3 class="name name-method" id="length" translate="no">.<a href="#length">length</a><span class="signature">()</span><span class="type-signature"> : number</span> </h3>
    609. 

  609. 					<div class="method">
    610. 

  610. 						<div class="description">
    611. 

  611. 							<p>Computes the  Euclidean length (straight-line length) from (0, 0, 0) to (x, y, z).</p>
    612. 

  612. 						</div>
    613. 

  613. 						<dl class="details">
    614. 

  614. 							<dt class="tag-returns"><strong>Returns:</strong> The length of this vector.</dt>
    615. 

  615. 						</dl>
    616. 

  616. 					</div>
    617. 

  617. 					<h3 class="name name-method" id="lengthSq" translate="no">.<a href="#lengthSq">lengthSq</a><span class="signature">()</span><span class="type-signature"> : number</span> </h3>
    618. 

  618. 					<div class="method">
    619. 

  619. 						<div class="description">
    620. 

  620. 							<p>Computes the square of the Euclidean length (straight-line length) from
    621. 

  621. (0, 0, 0) to (x, y, z). If you are comparing the lengths of vectors, you should
    622. 

  622. compare the length squared instead as it is slightly more efficient to calculate.</p>
    623. 

  623. 						</div>
    624. 

  624. 						<dl class="details">
    625. 

  625. 							<dt class="tag-returns"><strong>Returns:</strong> The square length of this vector.</dt>
    626. 

  626. 						</dl>
    627. 

  627. 					</div>
    628. 

  628. 					<h3 class="name name-method" id="lerp" translate="no">.<a href="#lerp">lerp</a><span class="signature">( v : <span class="param-type">Vector3</span>, alpha : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    629. 

  629. 					<div class="method">
    630. 

  630. 						<div class="description">
    631. 

  631. 							<p>Linearly interpolates between the given vector and this instance, where
    632. 

  632. alpha is the percent distance along the line - alpha = 0 will be this
    633. 

  633. vector, and alpha = 1 will be the given one.</p>
    634. 

  634. 						</div>
    635. 

  635. 						<table class="params">
    636. 

  636. 							<tbody>
    637. 

  637. 								<tr>
    638. 

  638. 									<td class="name"><code>v</code></td>
    639. 

  639. 									<td class="description last"><p>The vector to interpolate towards.</p></td>
    640. 

  640. 								</tr>
    641. 

  641. 								<tr>
    642. 

  642. 									<td class="name"><code>alpha</code></td>
    643. 

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

  644. 								</tr>
    645. 

  645. 							</tbody>
    646. 

  646. 						</table>
    647. 

  647. 						<dl class="details">
    648. 

  648. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    649. 

  649. 						</dl>
    650. 

  650. 					</div>
    651. 

  651. 					<h3 class="name name-method" id="lerpVectors" translate="no">.<a href="#lerpVectors">lerpVectors</a><span class="signature">( v1 : <span class="param-type">Vector3</span>, v2 : <span class="param-type">Vector3</span>, alpha : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    652. 

  652. 					<div class="method">
    653. 

  653. 						<div class="description">
    654. 

  654. 							<p>Linearly interpolates between the given vectors, where alpha is the percent
    655. 

  655. distance along the line - alpha = 0 will be first vector, and alpha = 1 will
    656. 

  656. be the second one. The result is stored in this instance.</p>
    657. 

  657. 						</div>
    658. 

  658. 						<table class="params">
    659. 

  659. 							<tbody>
    660. 

  660. 								<tr>
    661. 

  661. 									<td class="name"><code>v1</code></td>
    662. 

  662. 									<td class="description last"><p>The first vector.</p></td>
    663. 

  663. 								</tr>
    664. 

  664. 								<tr>
    665. 

  665. 									<td class="name"><code>v2</code></td>
    666. 

  666. 									<td class="description last"><p>The second vector.</p></td>
    667. 

  667. 								</tr>
    668. 

  668. 								<tr>
    669. 

  669. 									<td class="name"><code>alpha</code></td>
    670. 

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

  671. 								</tr>
    672. 

  672. 							</tbody>
    673. 

  673. 						</table>
    674. 

  674. 						<dl class="details">
    675. 

  675. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    676. 

  676. 						</dl>
    677. 

  677. 					</div>
    678. 

  678. 					<h3 class="name name-method" id="manhattanDistanceTo" translate="no">.<a href="#manhattanDistanceTo">manhattanDistanceTo</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : number</span> </h3>
    679. 

  679. 					<div class="method">
    680. 

  680. 						<div class="description">
    681. 

  681. 							<p>Computes the Manhattan distance from the given vector to this instance.</p>
    682. 

  682. 						</div>
    683. 

  683. 						<table class="params">
    684. 

  684. 							<tbody>
    685. 

  685. 								<tr>
    686. 

  686. 									<td class="name"><code>v</code></td>
    687. 

  687. 									<td class="description last"><p>The vector to compute the Manhattan distance to.</p></td>
    688. 

  688. 								</tr>
    689. 

  689. 							</tbody>
    690. 

  690. 						</table>
    691. 

  691. 						<dl class="details">
    692. 

  692. 							<dt class="tag-returns"><strong>Returns:</strong> The Manhattan distance.</dt>
    693. 

  693. 						</dl>
    694. 

  694. 					</div>
    695. 

  695. 					<h3 class="name name-method" id="manhattanLength" translate="no">.<a href="#manhattanLength">manhattanLength</a><span class="signature">()</span><span class="type-signature"> : number</span> </h3>
    696. 

  696. 					<div class="method">
    697. 

  697. 						<div class="description">
    698. 

  698. 							<p>Computes the Manhattan length of this vector.</p>
    699. 

  699. 						</div>
    700. 

  700. 						<dl class="details">
    701. 

  701. 							<dt class="tag-returns"><strong>Returns:</strong> The length of this vector.</dt>
    702. 

  702. 						</dl>
    703. 

  703. 					</div>
    704. 

  704. 					<h3 class="name name-method" id="max" translate="no">.<a href="#max">max</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    705. 

  705. 					<div class="method">
    706. 

  706. 						<div class="description">
    707. 

  707. 							<p>If this vector's x, y or z value is less than the given vector's x, y or z
    708. 

  708. value, replace that value with the corresponding max value.</p>
    709. 

  709. 						</div>
    710. 

  710. 						<table class="params">
    711. 

  711. 							<tbody>
    712. 

  712. 								<tr>
    713. 

  713. 									<td class="name"><code>v</code></td>
    714. 

  714. 									<td class="description last"><p>The vector.</p></td>
    715. 

  715. 								</tr>
    716. 

  716. 							</tbody>
    717. 

  717. 						</table>
    718. 

  718. 						<dl class="details">
    719. 

  719. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    720. 

  720. 						</dl>
    721. 

  721. 					</div>
    722. 

  722. 					<h3 class="name name-method" id="min" translate="no">.<a href="#min">min</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    723. 

  723. 					<div class="method">
    724. 

  724. 						<div class="description">
    725. 

  725. 							<p>If this vector's x, y or z value is greater than the given vector's x, y or z
    726. 

  726. value, replace that value with the corresponding min value.</p>
    727. 

  727. 						</div>
    728. 

  728. 						<table class="params">
    729. 

  729. 							<tbody>
    730. 

  730. 								<tr>
    731. 

  731. 									<td class="name"><code>v</code></td>
    732. 

  732. 									<td class="description last"><p>The vector.</p></td>
    733. 

  733. 								</tr>
    734. 

  734. 							</tbody>
    735. 

  735. 						</table>
    736. 

  736. 						<dl class="details">
    737. 

  737. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    738. 

  738. 						</dl>
    739. 

  739. 					</div>
    740. 

  740. 					<h3 class="name name-method" id="multiply" translate="no">.<a href="#multiply">multiply</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    741. 

  741. 					<div class="method">
    742. 

  742. 						<div class="description">
    743. 

  743. 							<p>Multiplies the given vector with this instance.</p>
    744. 

  744. 						</div>
    745. 

  745. 						<table class="params">
    746. 

  746. 							<tbody>
    747. 

  747. 								<tr>
    748. 

  748. 									<td class="name"><code>v</code></td>
    749. 

  749. 									<td class="description last"><p>The vector to multiply.</p></td>
    750. 

  750. 								</tr>
    751. 

  751. 							</tbody>
    752. 

  752. 						</table>
    753. 

  753. 						<dl class="details">
    754. 

  754. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    755. 

  755. 						</dl>
    756. 

  756. 					</div>
    757. 

  757. 					<h3 class="name name-method" id="multiplyScalar" translate="no">.<a href="#multiplyScalar">multiplyScalar</a><span class="signature">( scalar : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    758. 

  758. 					<div class="method">
    759. 

  759. 						<div class="description">
    760. 

  760. 							<p>Multiplies the given scalar value with all components of this instance.</p>
    761. 

  761. 						</div>
    762. 

  762. 						<table class="params">
    763. 

  763. 							<tbody>
    764. 

  764. 								<tr>
    765. 

  765. 									<td class="name"><code>scalar</code></td>
    766. 

  766. 									<td class="description last"><p>The scalar to multiply.</p></td>
    767. 

  767. 								</tr>
    768. 

  768. 							</tbody>
    769. 

  769. 						</table>
    770. 

  770. 						<dl class="details">
    771. 

  771. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    772. 

  772. 						</dl>
    773. 

  773. 					</div>
    774. 

  774. 					<h3 class="name name-method" id="multiplyVectors" translate="no">.<a href="#multiplyVectors">multiplyVectors</a><span class="signature">( a : <span class="param-type">Vector3</span>, b : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    775. 

  775. 					<div class="method">
    776. 

  776. 						<div class="description">
    777. 

  777. 							<p>Multiplies the given vectors and stores the result in this instance.</p>
    778. 

  778. 						</div>
    779. 

  779. 						<table class="params">
    780. 

  780. 							<tbody>
    781. 

  781. 								<tr>
    782. 

  782. 									<td class="name"><code>a</code></td>
    783. 

  783. 									<td class="description last"><p>The first vector.</p></td>
    784. 

  784. 								</tr>
    785. 

  785. 								<tr>
    786. 

  786. 									<td class="name"><code>b</code></td>
    787. 

  787. 									<td class="description last"><p>The second vector.</p></td>
    788. 

  788. 								</tr>
    789. 

  789. 							</tbody>
    790. 

  790. 						</table>
    791. 

  791. 						<dl class="details">
    792. 

  792. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    793. 

  793. 						</dl>
    794. 

  794. 					</div>
    795. 

  795. 					<h3 class="name name-method" id="negate" translate="no">.<a href="#negate">negate</a><span class="signature">()</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    796. 

  796. 					<div class="method">
    797. 

  797. 						<div class="description">
    798. 

  798. 							<p>Inverts this vector - i.e. sets x = -x, y = -y and z = -z.</p>
    799. 

  799. 						</div>
    800. 

  800. 						<dl class="details">
    801. 

  801. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    802. 

  802. 						</dl>
    803. 

  803. 					</div>
    804. 

  804. 					<h3 class="name name-method" id="normalize" translate="no">.<a href="#normalize">normalize</a><span class="signature">()</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    805. 

  805. 					<div class="method">
    806. 

  806. 						<div class="description">
    807. 

  807. 							<p>Converts this vector to a unit vector - that is, sets it equal to a vector
    808. 

  808. with the same direction as this one, but with a vector length of <code>1</code>.</p>
    809. 

  809. 						</div>
    810. 

  810. 						<dl class="details">
    811. 

  811. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    812. 

  812. 						</dl>
    813. 

  813. 					</div>
    814. 

  814. 					<h3 class="name name-method" id="project" translate="no">.<a href="#project">project</a><span class="signature">( camera : <span class="param-type">Camera</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    815. 

  815. 					<div class="method">
    816. 

  816. 						<div class="description">
    817. 

  817. 							<p>Projects this vector from world space into the camera's normalized
    818. 

  818. device coordinate (NDC) space.</p>
    819. 

  819. 						</div>
    820. 

  820. 						<table class="params">
    821. 

  821. 							<tbody>
    822. 

  822. 								<tr>
    823. 

  823. 									<td class="name"><code>camera</code></td>
    824. 

  824. 									<td class="description last"><p>The camera.</p></td>
    825. 

  825. 								</tr>
    826. 

  826. 							</tbody>
    827. 

  827. 						</table>
    828. 

  828. 						<dl class="details">
    829. 

  829. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    830. 

  830. 						</dl>
    831. 

  831. 					</div>
    832. 

  832. 					<h3 class="name name-method" id="projectOnPlane" translate="no">.<a href="#projectOnPlane">projectOnPlane</a><span class="signature">( planeNormal : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    833. 

  833. 					<div class="method">
    834. 

  834. 						<div class="description">
    835. 

  835. 							<p>Projects this vector onto a plane by subtracting this
    836. 

  836. vector projected onto the plane's normal from this vector.</p>
    837. 

  837. 						</div>
    838. 

  838. 						<table class="params">
    839. 

  839. 							<tbody>
    840. 

  840. 								<tr>
    841. 

  841. 									<td class="name"><code>planeNormal</code></td>
    842. 

  842. 									<td class="description last"><p>The plane normal.</p></td>
    843. 

  843. 								</tr>
    844. 

  844. 							</tbody>
    845. 

  845. 						</table>
    846. 

  846. 						<dl class="details">
    847. 

  847. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    848. 

  848. 						</dl>
    849. 

  849. 					</div>
    850. 

  850. 					<h3 class="name name-method" id="projectOnVector" translate="no">.<a href="#projectOnVector">projectOnVector</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    851. 

  851. 					<div class="method">
    852. 

  852. 						<div class="description">
    853. 

  853. 							<p>Projects this vector onto the given one.</p>
    854. 

  854. 						</div>
    855. 

  855. 						<table class="params">
    856. 

  856. 							<tbody>
    857. 

  857. 								<tr>
    858. 

  858. 									<td class="name"><code>v</code></td>
    859. 

  859. 									<td class="description last"><p>The vector to project to.</p></td>
    860. 

  860. 								</tr>
    861. 

  861. 							</tbody>
    862. 

  862. 						</table>
    863. 

  863. 						<dl class="details">
    864. 

  864. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    865. 

  865. 						</dl>
    866. 

  866. 					</div>
    867. 

  867. 					<h3 class="name name-method" id="random" translate="no">.<a href="#random">random</a><span class="signature">()</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    868. 

  868. 					<div class="method">
    869. 

  869. 						<div class="description">
    870. 

  870. 							<p>Sets each component of this vector to a pseudo-random value between <code>0</code> and
    871. 

  871. <code>1</code>, excluding <code>1</code>.</p>
    872. 

  872. 						</div>
    873. 

  873. 						<dl class="details">
    874. 

  874. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    875. 

  875. 						</dl>
    876. 

  876. 					</div>
    877. 

  877. 					<h3 class="name name-method" id="randomDirection" translate="no">.<a href="#randomDirection">randomDirection</a><span class="signature">()</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    878. 

  878. 					<div class="method">
    879. 

  879. 						<div class="description">
    880. 

  880. 							<p>Sets this vector to a uniformly random point on a unit sphere.</p>
    881. 

  881. 						</div>
    882. 

  882. 						<dl class="details">
    883. 

  883. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    884. 

  884. 						</dl>
    885. 

  885. 					</div>
    886. 

  886. 					<h3 class="name name-method" id="reflect" translate="no">.<a href="#reflect">reflect</a><span class="signature">( normal : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    887. 

  887. 					<div class="method">
    888. 

  888. 						<div class="description">
    889. 

  889. 							<p>Reflects this vector off a plane orthogonal to the given normal vector.</p>
    890. 

  890. 						</div>
    891. 

  891. 						<table class="params">
    892. 

  892. 							<tbody>
    893. 

  893. 								<tr>
    894. 

  894. 									<td class="name"><code>normal</code></td>
    895. 

  895. 									<td class="description last"><p>The (normalized) normal vector.</p></td>
    896. 

  896. 								</tr>
    897. 

  897. 							</tbody>
    898. 

  898. 						</table>
    899. 

  899. 						<dl class="details">
    900. 

  900. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    901. 

  901. 						</dl>
    902. 

  902. 					</div>
    903. 

  903. 					<h3 class="name name-method" id="round" translate="no">.<a href="#round">round</a><span class="signature">()</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    904. 

  904. 					<div class="method">
    905. 

  905. 						<div class="description">
    906. 

  906. 							<p>The components of this vector are rounded to the nearest integer value</p>
    907. 

  907. 						</div>
    908. 

  908. 						<dl class="details">
    909. 

  909. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    910. 

  910. 						</dl>
    911. 

  911. 					</div>
    912. 

  912. 					<h3 class="name name-method" id="roundToZero" translate="no">.<a href="#roundToZero">roundToZero</a><span class="signature">()</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    913. 

  913. 					<div class="method">
    914. 

  914. 						<div class="description">
    915. 

  915. 							<p>The components of this vector are rounded towards zero (up if negative,
    916. 

  916. down if positive) to an integer value.</p>
    917. 

  917. 						</div>
    918. 

  918. 						<dl class="details">
    919. 

  919. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    920. 

  920. 						</dl>
    921. 

  921. 					</div>
    922. 

  922. 					<h3 class="name name-method" id="set" translate="no">.<a href="#set">set</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="Vector3.html">Vector3</a></span> </h3>
    923. 

  923. 					<div class="method">
    924. 

  924. 						<div class="description">
    925. 

  925. 							<p>Sets the vector components.</p>
    926. 

  926. 						</div>
    927. 

  927. 						<table class="params">
    928. 

  928. 							<tbody>
    929. 

  929. 								<tr>
    930. 

  930. 									<td class="name"><code>x</code></td>
    931. 

  931. 									<td class="description last"><p>The value of the x component.</p></td>
    932. 

  932. 								</tr>
    933. 

  933. 								<tr>
    934. 

  934. 									<td class="name"><code>y</code></td>
    935. 

  935. 									<td class="description last"><p>The value of the y component.</p></td>
    936. 

  936. 								</tr>
    937. 

  937. 								<tr>
    938. 

  938. 									<td class="name"><code>z</code></td>
    939. 

  939. 									<td class="description last"><p>The value of the z component.</p></td>
    940. 

  940. 								</tr>
    941. 

  941. 							</tbody>
    942. 

  942. 						</table>
    943. 

  943. 						<dl class="details">
    944. 

  944. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    945. 

  945. 						</dl>
    946. 

  946. 					</div>
    947. 

  947. 					<h3 class="name name-method" id="setComponent" translate="no">.<a href="#setComponent">setComponent</a><span class="signature">( index : <span class="param-type">number</span>, value : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    948. 

  948. 					<div class="method">
    949. 

  949. 						<div class="description">
    950. 

  950. 							<p>Allows to set a vector component with an index.</p>
    951. 

  951. 						</div>
    952. 

  952. 						<table class="params">
    953. 

  953. 							<tbody>
    954. 

  954. 								<tr>
    955. 

  955. 									<td class="name"><code>index</code></td>
    956. 

  956. 									<td class="description last"><p>The component index. <code>0</code> equals to x, <code>1</code> equals to y, <code>2</code> equals to z.</p></td>
    957. 

  957. 								</tr>
    958. 

  958. 								<tr>
    959. 

  959. 									<td class="name"><code>value</code></td>
    960. 

  960. 									<td class="description last"><p>The value to set.</p></td>
    961. 

  961. 								</tr>
    962. 

  962. 							</tbody>
    963. 

  963. 						</table>
    964. 

  964. 						<dl class="details">
    965. 

  965. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    966. 

  966. 						</dl>
    967. 

  967. 					</div>
    968. 

  968. 					<h3 class="name name-method" id="setFromColor" translate="no">.<a href="#setFromColor">setFromColor</a><span class="signature">( c : <span class="param-type">Color</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    969. 

  969. 					<div class="method">
    970. 

  970. 						<div class="description">
    971. 

  971. 							<p>Sets the vector components from the RGB components of the
    972. 

  972. given color.</p>
    973. 

  973. 						</div>
    974. 

  974. 						<table class="params">
    975. 

  975. 							<tbody>
    976. 

  976. 								<tr>
    977. 

  977. 									<td class="name"><code>c</code></td>
    978. 

  978. 									<td class="description last"><p>The color to set.</p></td>
    979. 

  979. 								</tr>
    980. 

  980. 							</tbody>
    981. 

  981. 						</table>
    982. 

  982. 						<dl class="details">
    983. 

  983. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    984. 

  984. 						</dl>
    985. 

  985. 					</div>
    986. 

  986. 					<h3 class="name name-method" id="setFromCylindrical" translate="no">.<a href="#setFromCylindrical">setFromCylindrical</a><span class="signature">( c : <span class="param-type">Cylindrical</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    987. 

  987. 					<div class="method">
    988. 

  988. 						<div class="description">
    989. 

  989. 							<p>Sets the vector components from the given cylindrical coordinates.</p>
    990. 

  990. 						</div>
    991. 

  991. 						<table class="params">
    992. 

  992. 							<tbody>
    993. 

  993. 								<tr>
    994. 

  994. 									<td class="name"><code>c</code></td>
    995. 

  995. 									<td class="description last"><p>The cylindrical coordinates.</p></td>
    996. 

  996. 								</tr>
    997. 

  997. 							</tbody>
    998. 

  998. 						</table>
    999. 

  999. 						<dl class="details">
    1000. 

  1000. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1001. 

  1001. 						</dl>
    1002. 

  1002. 					</div>
    1003. 

  1003. 					<h3 class="name name-method" id="setFromCylindricalCoords" translate="no">.<a href="#setFromCylindricalCoords">setFromCylindricalCoords</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="Vector3.html">Vector3</a></span> </h3>
    1004. 

  1004. 					<div class="method">
    1005. 

  1005. 						<div class="description">
    1006. 

  1006. 							<p>Sets the vector components from the given cylindrical coordinates.</p>
    1007. 

  1007. 						</div>
    1008. 

  1008. 						<table class="params">
    1009. 

  1009. 							<tbody>
    1010. 

  1010. 								<tr>
    1011. 

  1011. 									<td class="name"><code>radius</code></td>
    1012. 

  1012. 									<td class="description last"><p>The radius.</p></td>
    1013. 

  1013. 								</tr>
    1014. 

  1014. 								<tr>
    1015. 

  1015. 									<td class="name"><code>theta</code></td>
    1016. 

  1016. 									<td class="description last"><p>The theta angle in radians.</p></td>
    1017. 

  1017. 								</tr>
    1018. 

  1018. 								<tr>
    1019. 

  1019. 									<td class="name"><code>y</code></td>
    1020. 

  1020. 									<td class="description last"><p>The y value.</p></td>
    1021. 

  1021. 								</tr>
    1022. 

  1022. 							</tbody>
    1023. 

  1023. 						</table>
    1024. 

  1024. 						<dl class="details">
    1025. 

  1025. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1026. 

  1026. 						</dl>
    1027. 

  1027. 					</div>
    1028. 

  1028. 					<h3 class="name name-method" id="setFromEuler" translate="no">.<a href="#setFromEuler">setFromEuler</a><span class="signature">( e : <span class="param-type">Euler</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1029. 

  1029. 					<div class="method">
    1030. 

  1030. 						<div class="description">
    1031. 

  1031. 							<p>Sets the vector components from the given Euler angles.</p>
    1032. 

  1032. 						</div>
    1033. 

  1033. 						<table class="params">
    1034. 

  1034. 							<tbody>
    1035. 

  1035. 								<tr>
    1036. 

  1036. 									<td class="name"><code>e</code></td>
    1037. 

  1037. 									<td class="description last"><p>The Euler angles to set.</p></td>
    1038. 

  1038. 								</tr>
    1039. 

  1039. 							</tbody>
    1040. 

  1040. 						</table>
    1041. 

  1041. 						<dl class="details">
    1042. 

  1042. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1043. 

  1043. 						</dl>
    1044. 

  1044. 					</div>
    1045. 

  1045. 					<h3 class="name name-method" id="setFromMatrix3Column" translate="no">.<a href="#setFromMatrix3Column">setFromMatrix3Column</a><span class="signature">( m : <span class="param-type">Matrix3</span>, index : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1046. 

  1046. 					<div class="method">
    1047. 

  1047. 						<div class="description">
    1048. 

  1048. 							<p>Sets the vector components from the specified matrix column.</p>
    1049. 

  1049. 						</div>
    1050. 

  1050. 						<table class="params">
    1051. 

  1051. 							<tbody>
    1052. 

  1052. 								<tr>
    1053. 

  1053. 									<td class="name"><code>m</code></td>
    1054. 

  1054. 									<td class="description last"><p>The 3x3 matrix.</p></td>
    1055. 

  1055. 								</tr>
    1056. 

  1056. 								<tr>
    1057. 

  1057. 									<td class="name"><code>index</code></td>
    1058. 

  1058. 									<td class="description last"><p>The column index.</p></td>
    1059. 

  1059. 								</tr>
    1060. 

  1060. 							</tbody>
    1061. 

  1061. 						</table>
    1062. 

  1062. 						<dl class="details">
    1063. 

  1063. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1064. 

  1064. 						</dl>
    1065. 

  1065. 					</div>
    1066. 

  1066. 					<h3 class="name name-method" id="setFromMatrixColumn" translate="no">.<a href="#setFromMatrixColumn">setFromMatrixColumn</a><span class="signature">( m : <span class="param-type">Matrix4</span>, index : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1067. 

  1067. 					<div class="method">
    1068. 

  1068. 						<div class="description">
    1069. 

  1069. 							<p>Sets the vector components from the specified matrix column.</p>
    1070. 

  1070. 						</div>
    1071. 

  1071. 						<table class="params">
    1072. 

  1072. 							<tbody>
    1073. 

  1073. 								<tr>
    1074. 

  1074. 									<td class="name"><code>m</code></td>
    1075. 

  1075. 									<td class="description last"><p>The 4x4 matrix.</p></td>
    1076. 

  1076. 								</tr>
    1077. 

  1077. 								<tr>
    1078. 

  1078. 									<td class="name"><code>index</code></td>
    1079. 

  1079. 									<td class="description last"><p>The column index.</p></td>
    1080. 

  1080. 								</tr>
    1081. 

  1081. 							</tbody>
    1082. 

  1082. 						</table>
    1083. 

  1083. 						<dl class="details">
    1084. 

  1084. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1085. 

  1085. 						</dl>
    1086. 

  1086. 					</div>
    1087. 

  1087. 					<h3 class="name name-method" id="setFromMatrixPosition" translate="no">.<a href="#setFromMatrixPosition">setFromMatrixPosition</a><span class="signature">( m : <span class="param-type">Matrix4</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1088. 

  1088. 					<div class="method">
    1089. 

  1089. 						<div class="description">
    1090. 

  1090. 							<p>Sets the vector components to the position elements of the
    1091. 

  1091. given transformation matrix.</p>
    1092. 

  1092. 						</div>
    1093. 

  1093. 						<table class="params">
    1094. 

  1094. 							<tbody>
    1095. 

  1095. 								<tr>
    1096. 

  1096. 									<td class="name"><code>m</code></td>
    1097. 

  1097. 									<td class="description last"><p>The 4x4 matrix.</p></td>
    1098. 

  1098. 								</tr>
    1099. 

  1099. 							</tbody>
    1100. 

  1100. 						</table>
    1101. 

  1101. 						<dl class="details">
    1102. 

  1102. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1103. 

  1103. 						</dl>
    1104. 

  1104. 					</div>
    1105. 

  1105. 					<h3 class="name name-method" id="setFromMatrixScale" translate="no">.<a href="#setFromMatrixScale">setFromMatrixScale</a><span class="signature">( m : <span class="param-type">Matrix4</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1106. 

  1106. 					<div class="method">
    1107. 

  1107. 						<div class="description">
    1108. 

  1108. 							<p>Sets the vector components to the scale elements of the
    1109. 

  1109. given transformation matrix.</p>
    1110. 

  1110. 						</div>
    1111. 

  1111. 						<table class="params">
    1112. 

  1112. 							<tbody>
    1113. 

  1113. 								<tr>
    1114. 

  1114. 									<td class="name"><code>m</code></td>
    1115. 

  1115. 									<td class="description last"><p>The 4x4 matrix.</p></td>
    1116. 

  1116. 								</tr>
    1117. 

  1117. 							</tbody>
    1118. 

  1118. 						</table>
    1119. 

  1119. 						<dl class="details">
    1120. 

  1120. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1121. 

  1121. 						</dl>
    1122. 

  1122. 					</div>
    1123. 

  1123. 					<h3 class="name name-method" id="setFromSpherical" translate="no">.<a href="#setFromSpherical">setFromSpherical</a><span class="signature">( s : <span class="param-type">Spherical</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1124. 

  1124. 					<div class="method">
    1125. 

  1125. 						<div class="description">
    1126. 

  1126. 							<p>Sets the vector components from the given spherical coordinates.</p>
    1127. 

  1127. 						</div>
    1128. 

  1128. 						<table class="params">
    1129. 

  1129. 							<tbody>
    1130. 

  1130. 								<tr>
    1131. 

  1131. 									<td class="name"><code>s</code></td>
    1132. 

  1132. 									<td class="description last"><p>The spherical coordinates.</p></td>
    1133. 

  1133. 								</tr>
    1134. 

  1134. 							</tbody>
    1135. 

  1135. 						</table>
    1136. 

  1136. 						<dl class="details">
    1137. 

  1137. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1138. 

  1138. 						</dl>
    1139. 

  1139. 					</div>
    1140. 

  1140. 					<h3 class="name name-method" id="setFromSphericalCoords" translate="no">.<a href="#setFromSphericalCoords">setFromSphericalCoords</a><span class="signature">( radius : <span class="param-type">number</span>, phi : <span class="param-type">number</span>, theta : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1141. 

  1141. 					<div class="method">
    1142. 

  1142. 						<div class="description">
    1143. 

  1143. 							<p>Sets the vector components from the given spherical coordinates.</p>
    1144. 

  1144. 						</div>
    1145. 

  1145. 						<table class="params">
    1146. 

  1146. 							<tbody>
    1147. 

  1147. 								<tr>
    1148. 

  1148. 									<td class="name"><code>radius</code></td>
    1149. 

  1149. 									<td class="description last"><p>The radius.</p></td>
    1150. 

  1150. 								</tr>
    1151. 

  1151. 								<tr>
    1152. 

  1152. 									<td class="name"><code>phi</code></td>
    1153. 

  1153. 									<td class="description last"><p>The phi angle in radians.</p></td>
    1154. 

  1154. 								</tr>
    1155. 

  1155. 								<tr>
    1156. 

  1156. 									<td class="name"><code>theta</code></td>
    1157. 

  1157. 									<td class="description last"><p>The theta angle in radians.</p></td>
    1158. 

  1158. 								</tr>
    1159. 

  1159. 							</tbody>
    1160. 

  1160. 						</table>
    1161. 

  1161. 						<dl class="details">
    1162. 

  1162. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1163. 

  1163. 						</dl>
    1164. 

  1164. 					</div>
    1165. 

  1165. 					<h3 class="name name-method" id="setLength" translate="no">.<a href="#setLength">setLength</a><span class="signature">( length : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1166. 

  1166. 					<div class="method">
    1167. 

  1167. 						<div class="description">
    1168. 

  1168. 							<p>Sets this vector to a vector with the same direction as this one, but
    1169. 

  1169. with the specified length.</p>
    1170. 

  1170. 						</div>
    1171. 

  1171. 						<table class="params">
    1172. 

  1172. 							<tbody>
    1173. 

  1173. 								<tr>
    1174. 

  1174. 									<td class="name"><code>length</code></td>
    1175. 

  1175. 									<td class="description last"><p>The new length of this vector.</p></td>
    1176. 

  1176. 								</tr>
    1177. 

  1177. 							</tbody>
    1178. 

  1178. 						</table>
    1179. 

  1179. 						<dl class="details">
    1180. 

  1180. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1181. 

  1181. 						</dl>
    1182. 

  1182. 					</div>
    1183. 

  1183. 					<h3 class="name name-method" id="setScalar" translate="no">.<a href="#setScalar">setScalar</a><span class="signature">( scalar : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1184. 

  1184. 					<div class="method">
    1185. 

  1185. 						<div class="description">
    1186. 

  1186. 							<p>Sets the vector components to the same value.</p>
    1187. 

  1187. 						</div>
    1188. 

  1188. 						<table class="params">
    1189. 

  1189. 							<tbody>
    1190. 

  1190. 								<tr>
    1191. 

  1191. 									<td class="name"><code>scalar</code></td>
    1192. 

  1192. 									<td class="description last"><p>The value to set for all vector components.</p></td>
    1193. 

  1193. 								</tr>
    1194. 

  1194. 							</tbody>
    1195. 

  1195. 						</table>
    1196. 

  1196. 						<dl class="details">
    1197. 

  1197. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1198. 

  1198. 						</dl>
    1199. 

  1199. 					</div>
    1200. 

  1200. 					<h3 class="name name-method" id="setX" translate="no">.<a href="#setX">setX</a><span class="signature">( x : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1201. 

  1201. 					<div class="method">
    1202. 

  1202. 						<div class="description">
    1203. 

  1203. 							<p>Sets the vector's x component to the given value</p>
    1204. 

  1204. 						</div>
    1205. 

  1205. 						<table class="params">
    1206. 

  1206. 							<tbody>
    1207. 

  1207. 								<tr>
    1208. 

  1208. 									<td class="name"><code>x</code></td>
    1209. 

  1209. 									<td class="description last"><p>The value to set.</p></td>
    1210. 

  1210. 								</tr>
    1211. 

  1211. 							</tbody>
    1212. 

  1212. 						</table>
    1213. 

  1213. 						<dl class="details">
    1214. 

  1214. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1215. 

  1215. 						</dl>
    1216. 

  1216. 					</div>
    1217. 

  1217. 					<h3 class="name name-method" id="setY" translate="no">.<a href="#setY">setY</a><span class="signature">( y : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1218. 

  1218. 					<div class="method">
    1219. 

  1219. 						<div class="description">
    1220. 

  1220. 							<p>Sets the vector's y component to the given value</p>
    1221. 

  1221. 						</div>
    1222. 

  1222. 						<table class="params">
    1223. 

  1223. 							<tbody>
    1224. 

  1224. 								<tr>
    1225. 

  1225. 									<td class="name"><code>y</code></td>
    1226. 

  1226. 									<td class="description last"><p>The value to set.</p></td>
    1227. 

  1227. 								</tr>
    1228. 

  1228. 							</tbody>
    1229. 

  1229. 						</table>
    1230. 

  1230. 						<dl class="details">
    1231. 

  1231. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1232. 

  1232. 						</dl>
    1233. 

  1233. 					</div>
    1234. 

  1234. 					<h3 class="name name-method" id="setZ" translate="no">.<a href="#setZ">setZ</a><span class="signature">( z : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1235. 

  1235. 					<div class="method">
    1236. 

  1236. 						<div class="description">
    1237. 

  1237. 							<p>Sets the vector's z component to the given value</p>
    1238. 

  1238. 						</div>
    1239. 

  1239. 						<table class="params">
    1240. 

  1240. 							<tbody>
    1241. 

  1241. 								<tr>
    1242. 

  1242. 									<td class="name"><code>z</code></td>
    1243. 

  1243. 									<td class="description last"><p>The value to set.</p></td>
    1244. 

  1244. 								</tr>
    1245. 

  1245. 							</tbody>
    1246. 

  1246. 						</table>
    1247. 

  1247. 						<dl class="details">
    1248. 

  1248. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1249. 

  1249. 						</dl>
    1250. 

  1250. 					</div>
    1251. 

  1251. 					<h3 class="name name-method" id="sub" translate="no">.<a href="#sub">sub</a><span class="signature">( v : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1252. 

  1252. 					<div class="method">
    1253. 

  1253. 						<div class="description">
    1254. 

  1254. 							<p>Subtracts the given vector from this instance.</p>
    1255. 

  1255. 						</div>
    1256. 

  1256. 						<table class="params">
    1257. 

  1257. 							<tbody>
    1258. 

  1258. 								<tr>
    1259. 

  1259. 									<td class="name"><code>v</code></td>
    1260. 

  1260. 									<td class="description last"><p>The vector to subtract.</p></td>
    1261. 

  1261. 								</tr>
    1262. 

  1262. 							</tbody>
    1263. 

  1263. 						</table>
    1264. 

  1264. 						<dl class="details">
    1265. 

  1265. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1266. 

  1266. 						</dl>
    1267. 

  1267. 					</div>
    1268. 

  1268. 					<h3 class="name name-method" id="subScalar" translate="no">.<a href="#subScalar">subScalar</a><span class="signature">( s : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1269. 

  1269. 					<div class="method">
    1270. 

  1270. 						<div class="description">
    1271. 

  1271. 							<p>Subtracts the given scalar value from all components of this instance.</p>
    1272. 

  1272. 						</div>
    1273. 

  1273. 						<table class="params">
    1274. 

  1274. 							<tbody>
    1275. 

  1275. 								<tr>
    1276. 

  1276. 									<td class="name"><code>s</code></td>
    1277. 

  1277. 									<td class="description last"><p>The scalar to subtract.</p></td>
    1278. 

  1278. 								</tr>
    1279. 

  1279. 							</tbody>
    1280. 

  1280. 						</table>
    1281. 

  1281. 						<dl class="details">
    1282. 

  1282. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1283. 

  1283. 						</dl>
    1284. 

  1284. 					</div>
    1285. 

  1285. 					<h3 class="name name-method" id="subVectors" translate="no">.<a href="#subVectors">subVectors</a><span class="signature">( a : <span class="param-type">Vector3</span>, b : <span class="param-type">Vector3</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1286. 

  1286. 					<div class="method">
    1287. 

  1287. 						<div class="description">
    1288. 

  1288. 							<p>Subtracts the given vectors and stores the result in this instance.</p>
    1289. 

  1289. 						</div>
    1290. 

  1290. 						<table class="params">
    1291. 

  1291. 							<tbody>
    1292. 

  1292. 								<tr>
    1293. 

  1293. 									<td class="name"><code>a</code></td>
    1294. 

  1294. 									<td class="description last"><p>The first vector.</p></td>
    1295. 

  1295. 								</tr>
    1296. 

  1296. 								<tr>
    1297. 

  1297. 									<td class="name"><code>b</code></td>
    1298. 

  1298. 									<td class="description last"><p>The second vector.</p></td>
    1299. 

  1299. 								</tr>
    1300. 

  1300. 							</tbody>
    1301. 

  1301. 						</table>
    1302. 

  1302. 						<dl class="details">
    1303. 

  1303. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1304. 

  1304. 						</dl>
    1305. 

  1305. 					</div>
    1306. 

  1306. 					<h3 class="name name-method" id="toArray" translate="no">.<a href="#toArray">toArray</a><span class="signature">( array : <span class="param-type">Array.&lt;number></span>, offset : <span class="param-type">number</span> )</span><span class="type-signature"> : Array.&lt;number></span> </h3>
    1307. 

  1307. 					<div class="method">
    1308. 

  1308. 						<div class="description">
    1309. 

  1309. 							<p>Writes the components of this vector to the given array. If no array is provided,
    1310. 

  1310. the method returns a new instance.</p>
    1311. 

  1311. 						</div>
    1312. 

  1312. 						<table class="params">
    1313. 

  1313. 							<tbody>
    1314. 

  1314. 								<tr>
    1315. 

  1315. 									<td class="name"><code>array</code></td>
    1316. 

  1316. 									<td class="description last"><p>The target array holding the vector components.<br/>Default is <code>[]</code>.</p></td>
    1317. 

  1317. 								</tr>
    1318. 

  1318. 								<tr>
    1319. 

  1319. 									<td class="name"><code>offset</code></td>
    1320. 

  1320. 									<td class="description last"><p>Index of the first element in the array.<br/>Default is <code>0</code>.</p></td>
    1321. 

  1321. 								</tr>
    1322. 

  1322. 							</tbody>
    1323. 

  1323. 						</table>
    1324. 

  1324. 						<dl class="details">
    1325. 

  1325. 							<dt class="tag-returns"><strong>Returns:</strong> The vector components.</dt>
    1326. 

  1326. 						</dl>
    1327. 

  1327. 					</div>
    1328. 

  1328. 					<h3 class="name name-method" id="transformDirection" translate="no">.<a href="#transformDirection">transformDirection</a><span class="signature">( m : <span class="param-type">Matrix4</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1329. 

  1329. 					<div class="method">
    1330. 

  1330. 						<div class="description">
    1331. 

  1331. 							<p>Transforms the direction of this vector by a matrix (the upper left 3 x 3
    1332. 

  1332. subset of the given 4x4 matrix and then normalizes the result.</p>
    1333. 

  1333. 						</div>
    1334. 

  1334. 						<table class="params">
    1335. 

  1335. 							<tbody>
    1336. 

  1336. 								<tr>
    1337. 

  1337. 									<td class="name"><code>m</code></td>
    1338. 

  1338. 									<td class="description last"><p>The matrix.</p></td>
    1339. 

  1339. 								</tr>
    1340. 

  1340. 							</tbody>
    1341. 

  1341. 						</table>
    1342. 

  1342. 						<dl class="details">
    1343. 

  1343. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1344. 

  1344. 						</dl>
    1345. 

  1345. 					</div>
    1346. 

  1346. 					<h3 class="name name-method" id="unproject" translate="no">.<a href="#unproject">unproject</a><span class="signature">( camera : <span class="param-type">Camera</span> )</span><span class="type-signature"> : <a href="Vector3.html">Vector3</a></span> </h3>
    1347. 

  1347. 					<div class="method">
    1348. 

  1348. 						<div class="description">
    1349. 

  1349. 							<p>Unprojects this vector from the camera's normalized device coordinate (NDC)
    1350. 

  1350. space into world space.</p>
    1351. 

  1351. 						</div>
    1352. 

  1352. 						<table class="params">
    1353. 

  1353. 							<tbody>
    1354. 

  1354. 								<tr>
    1355. 

  1355. 									<td class="name"><code>camera</code></td>
    1356. 

  1356. 									<td class="description last"><p>The camera.</p></td>
    1357. 

  1357. 								</tr>
    1358. 

  1358. 							</tbody>
    1359. 

  1359. 						</table>
    1360. 

  1360. 						<dl class="details">
    1361. 

  1361. 							<dt class="tag-returns"><strong>Returns:</strong> A reference to this vector.</dt>
    1362. 

  1362. 						</dl>
    1363. 

  1363. 					</div>
    1364. 

  1364. 				<h2 class="subsection-title">Source</h2>
    1365. 

  1365. 				<p>
    1366. 

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

  1367. 				</p>
    1368. 

  1368. 			</article>
    1369. 

  1369. 		</section>
    1370. 

  1370. <script src="../scripts/linenumber.js"></script>
    1371. 

  1371. <script src="../scripts/page.js"></script>
    1372. 

  1372. </body>
    1373. 

  1373. </html>
    1374.
粤ICP备19079148号