forked from mrdoob/three.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathVector3.html
More file actions
474 lines (393 loc) · 13.5 KB
/
Vector3.html
File metadata and controls
474 lines (393 loc) · 13.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../" />
<script src="list.js"></script>
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
<h1>[name]</h1>
<div class="desc">3D vector.</div>
<h2>Example</h2>
<code>var a = new THREE.Vector3( 1, 0, 0 );
var b = new THREE.Vector3( 0, 1, 0 );
var c = new THREE.Vector3();
c.crossVectors( a, b );
</code>
<h2>Constructor</h2>
<h3>[name]( [page:Float x], [page:Float y], [page:Float z] )</h3>
<div>
x -- [page:Float] the vector's x value <br />
y -- [page:Float] the vector's y value <br />
z -- [page:Float] the vector's z value
</div>
<div>
A 3 dimensional vector
</div>
<h2>Properties</h2>
<h3>[property:Float x]</h3>
<h3>[property:Float y]</h3>
<h3>[property:Float z]</h3>
<h2>Methods</h2>
<h3>[method:Vector3 set]( [page:Float x], [page:Float y], [page:Float z] ) [page:Vector3 this]</h3>
<div>
Sets value of this vector.
</div>
<h3>[method:Vector3 setX]( [page:Float x] ) [page:Vector3 this]</h3>
<div>
Sets x value of this vector.
</div>
<h3>[method:Vector3 setY]( [page:Float y] ) [page:Vector3 this]</h3>
<div>
Sets y value of this vector.
</div>
<h3>[method:Vector3 setZ]( [page:Float z] ) [page:Vector3 this]</h3>
<div>
Sets z value of this vector.
</div>
<h3>[method:Vector3 copy]( [page:Vector3 v] ) [page:Vector3 this]</h3>
<div>
Copies value of *v* to this vector.
</div>
<h3>[method:Vector3 fromArray]( [page:Array array], [page:Integer offset] ) [page:Vector3 this]</h3>
<div>
array -- The source array in the form [x, y, z].<br />
offset -- An optional offset into the array.
</div>
<div>
Sets the vector's components based on an array formatted like [x, y, z]
</div>
<h3>[method:Vector3 add]( [page:Vector3 v] ) [page:Vector3 this]</h3>
<div>
Adds *v* to this vector.
</div>
<h3>[method:Vector3 addVectors]( [page:Vector3 a], [page:Vector3 b] ) [page:Vector3 this]</h3>
<div>
Sets this vector to *a + b*.
</div>
<h3>[method:Vector3 addScaledVector]( [page:Vector3 v], [page:Float s] ) [page:Vector3 this]</h3>
<div>
Adds the multiple of v and s to this vector.
</div>
<h3>[method:Vector3 sub]( [page:Vector3 v] ) [page:Vector3 this]</h3>
<div>
Subtracts *v* from this vector.
</div>
<h3>[method:Vector3 subVectors]( [page:Vector3 a], [page:Vector3 b] ) [page:Vector3 this]</h3>
<div>
Sets this vector to *a - b*.
</div>
<h3>[method:Vector3 multiplyScalar]( [page:Float s] ) [page:Vector3 this]</h3>
<div>
Multiplies this vector by scalar *s*.
</div>
<h3>[method:Vector3 divideScalar]( [page:Float s] ) [page:Vector3 this]</h3>
<div>
Divides this vector by scalar *s*.<br />
Set vector to *( 0, 0, 0 )* if *s == 0*.
</div>
<h3>[method:Vector3 negate]() [page:Vector3 this]</h3>
<div>
Inverts this vector.
</div>
<h3>[method:Float dot]( [page:Vector3 v] ) [page:Vector3 this]</h3>
<div>
Computes dot product of this vector and *v*.
</div>
<h3>[method:Float lengthSq]() [page:Vector3 this]</h3>
<div>
Computes the squared length of this vector.
</div>
<h3>[method:Float length]() [page:Vector3 this]</h3>
<div>
Computes the length of this vector.
</div>
<h3>[method:Float lengthManhattan]() [page:Vector3 this]</h3>
<div>
Computes the Manhattan length of this vector.<br />
[link:http://en.wikipedia.org/wiki/Taxicab_geometry]
</div>
<h3>[method:Vector3 normalize]() [page:Vector3 this]</h3>
<div>
Normalizes this vector. Transforms this Vector into a Unit vector by dividing the vector by its length.
</div>
<h3>[method:Float distanceTo]( [page:Vector3 v] )</h3>
<div>
Computes the distance from this vector to *v*.
</div>
<h3>[method:Float distanceToSquared]( [page:Vector3 v] )</h3>
<div>
Computes the squared distance from this vector to *v*.
</div>
<h3>[method:Float distanceToManhattan]( [page:Vector3 v] )</h3>
<div>
Computes the Manhattan distance from this vector to *v*.
</div>
<h3>[method:Vector3 setLength]( [page:Float l] ) [page:Vector3 this]</h3>
<div>
Normalizes this vector and multiplies it by *l*.
</div>
<h3>[method:Vector3 cross]( [page:Vector3 v] ) [page:Vector3 this]</h3>
<div>
Sets this vector to cross product of itself and *v*.
</div>
<h3>[method:Vector3 crossVectors]( [page:Vector3 a], [page:Vector3 b] ) [page:Vector3 this]</h3>
<div>
Sets this vector to cross product of *a* and *b*.
</div>
<h3>[method:Vector3 setFromMatrixPosition]( [page:Matrix4 m] ) [page:Vector3 this]</h3>
<div>
Sets this vector extracting position from matrix transform.
</div>
<h3>[method:Vector3 setFromMatrixScale]( [page:Matrix4 m] ) [page:Vector3 this]</h3>
<div>
Sets this vector extracting scale from matrix transform.
</div>
<h3>[method:Vector3 clamp]( [page:Vector3 min], [page:Vector3 max] ) [page:Vector3 this]</h3>
<div>
min -- [page:Vector3] <br />
max -- [page:Vector3]
</div>
<div>
If this vector's x, y or z value is greater than the max vector's x, y or z value, it is replaced by the corresponding value. <br /><br />
If this vector's x, y or z value is less than the min vector's x, y or z value, it is replaced by the corresponding value.
</div>
<h3>[method:Vector3 clampScalar]( [page:Float min], [page:Float max] ) [page:Vector3 this]</h3>
<div>
min -- [page:Float] the minimum value the components will be clamped to <br />
max -- [page:Float] the maximum value the components will be clamped to
</div>
<div>
If this vector's x, y or z values are greater than the max value, they are replaced by the max value. <br /><br />
If this vector's x, y or z values are less than the min value, they are replaced by the min value.
</div>
<h3>[method:Vector3 clampLength]( [page:Float min], [page:Float max] ) [page:Vector3 this]</h3>
<div>
min -- [page:Float] the minimum value the length will be clamped to <br />
max -- [page:Float] the maximum value the length will be clamped to
</div>
<div>
If this vector's length is greater than the max value, it is replaced by the max value. <br /><br />
If this vector's length is less than the min value, it is replaced by the min value.
</div>
<h3>[method:Vector3 floor]() [page:Vector3 this]</h3>
<div>
The components of the vector are rounded downwards (towards negative infinity) to an integer value.
</div>
<h3>[method:Vector3 ceil]() [page:Vector3 this]</h3>
<div>
The components of the vector are rounded upwards (towards positive infinity) to an integer value.
</div>
<h3>[method:Vector3 round]() [page:Vector3 this]</h3>
<div>
The components of the vector are rounded towards the nearest integer value.
</div>
<h3>[method:Vector3 roundToZero]() [page:Vector3 this]</h3>
<div>
The components of the vector are rounded towards zero (up if negative, down if positive) to an integer value.
</div>
<h3>[method:Vector3 applyMatrix3]( [page:Matrix3 m] ) [page:Vector3 this]</h3>
<div>
m -- [page:Matrix3]
</div>
<div>
Multiplies this vector times a 3 x 3 matrix.
</div>
<h3>[method:Vector3 applyMatrix4]( [page:Matrix3 m] ) [page:Vector3 this]</h3>
<div>
m -- [page:Matrix4]
</div>
<div>
Multiplies this vector by 4 x 3 subset of a Matrix4.
</div>
<h3>[method:Vector3 projectOnPlane]( [page:Vector3 planeNormal] ) [page:Vector3 this]</h3>
<div>
planeNormal -- [page:Vector3 planeNormal] A vector representing a plane normal.
</div>
<div>
Projects this vector onto a plane by subtracting this vector projected onto the plane's normal from this vector.
</div>
<h3>[method:Vector3 projectOnVector]( [page:Vector3] ) [page:Vector3 this]</h3>
<div>
vector -- [page:Vector3]
</div>
<div>
Projects this vector onto another vector.
</div>
<h3>[method:Vector3 addScalar]( [page:Float] ) [page:Vector3 this]</h3>
<div>
s -- [page:Float]
</div>
<div>
Adds a s to this vector.
</div>
<h3>[method:Vector3 divide]( [page:Vector3 v] ) [page:Vector3 this]</h3>
<div>
v -- [page:Vector3]
</div>
<div>
Divides this vector by vector v.
</div>
<h3>[method:Vector3 min]( [page:Vector3 v] ) [page:Vector3 this]</h3>
<div>
v -- [page:Vector3]
</div>
<div>
If this vector's x, y, or z value is greater than vector v's x, y, or z value, that value is replaced by the corresponding vector v value.
</div>
<h3>[method:Vector3 max]( [page:Vector3 v] ) [page:Vector3 this]</h3>
<div>
v -- [page:Vector3]
</div>
<div>
If this vector's x, y, or z value is less than vector v's x, y, or z value, that value is replaced by the corresponding vector v value.
</div>
<h3>[method:null setComponent]( [page:Integer index], [page:Float value] ) [page:Vector3 this]</h3>
<div>
index -- 0, 1, or 2 <br />
value -- [page:Float]
</div>
<div>
If index equals 0 the method sets this vector's x value to value <br />
If index equals 1 the method sets this vector's y value to value <br />
If index equals 2 the method sets this vector's z value to value
</div>
<h3>[method:Vector3 transformDirection]( [page:Matrix4 m] ) [page:Vector3 this]</h3>
<div>
m -- [page:Matrix4]
</div>
<div>
Transforms the direction of this vector by a matrix (a 3 x 3 subset of a Matrix4) and then normalizes the result.
</div>
<h3>[method:Vector3 multiplyVectors]( [page:Vector3 a], [page:Vector3 b] ) [page:Vector3 this]</h3>
<div>
a -- [page:Vector3] <br />
b -- [page:Vector3]
</div>
<div>
Sets this vector equal to the result of multiplying vector a by vector b.
</div>
<h3>[method:Float getComponent]( [page:Integer index] ) [page:Vector3 this]</h3>
<div>
index -- [page:Integer] 0, 1, or 2
</div>
<div>
Returns the value of the vector component x, y, or z by an index. <br /><br />
Index 0: x <br />
Index 1: y <br />
Index 2: z <br />
</div>
<h3>[method:Vector3 applyAxisAngle]( [page:Vector3 axis], [page:Float angle] ) [page:Vector3 this]</h3>
<div>
axis -- A normalized [page:Vector3] <br />
angle -- An angle in radians
</div>
<div>
Applies a rotation specified by an axis and an angle to this vector.
</div>
<h3>[method:Vector3 lerp]( [page:Vector3 v], [page:Float alpha] ) [page:Vector3 this]</h3>
<div>
v -- [page:Vector3] <br />
alpha -- [page:Float] between 0 and 1.
</div>
<div>
Linear Interpolation between this vector and vector v, where alpha is the percent along the line.
</div>
<h3>[method:Vector3 lerpVectors]( [page:Vector3 v1], [page:Vector3 v2], [page:Float alpha] ) [page:Vector3 this]</h3>
<div>
v1 -- [page:Vector3] <br />
v2 -- [page:Vector3] <br />
alpha -- [page:Float] between 0 and 1.
</div>
<div>
Sets this vector to be the vector linearly interpolated between *v1* and *v2* with *alpha* factor.
</div>
<h3>[method:Float angleTo]( [page:Vector3 v] ) [page:Vector3 this]</h3>
<div>
v -- [page:Vector3]
</div>
<div>
Returns the angle between this vector and vector v in radians.
</div>
<h3>[method:Vector3 setFromMatrixColumn]( [page:Integer index], [page:Matrix4 matrix] ) [page:Vector3 this]</h3>
<div>
index -- 0, 1, 2, or 3 <br />
matrix -- [page:Matrix4]
</div>
<div>
Sets this vector's x, y, and z equal to the column of the matrix specified by the index.
</div>
<h3>[method:Vector3 reflect]( [page:Vector3 normal] ) [page:Vector3 this]</h3>
<div>
normal -- [page:Vector3] the normal to the reflecting plane
</div>
<div>
Reflect incident vector off of plane orthogonal to normal. Normal is assumed to have unit length.
</div>
<h3>[method:Vector3 multiply]( [page:Vector3 v] ) [page:Vector3 this]</h3>
<div>
v -- [page:Vector3] <br />
</div>
<div>
Multiplies this vector by vector v.
</div>
<h3>[method:Vector3 applyProjection]( [page:Matrix4 m] ) [page:Vector3 this]</h3>
<div>
m -- [page:Matrix4] projection matrix.
</div>
<div>
Multiplies this vector and m, and divides by perspective.
</div>
<h3>[method:Vector3 applyEuler]( [page:Euler euler] ) [page:Vector3 this]</h3>
<div>
euler -- [page:Euler]
</div>
<div>
Applies euler transform to this vector by converting the [page:Euler] object to a [page:Quaternion] and applying.
</div>
<h3>[method:Vector3 applyQuaternion]( [page:Quaternion quaternion] ) [page:Vector3 this]</h3>
<div>
quaternion -- [page:Quaternion]
</div>
<div>
Applies a [page:Quaternion] transform to this vector.
</div>
<h3>[method:Vector3 project]( [page:Camera camera] ) [page:Vector3 this]</h3>
<div>
[page:Camera camera] — camera to use in the projection.<br />
</div>
<div>
Projects the vector with the camera.
</div>
<h3>[method:Vector3 unproject]( [page:Camera camera] ) [page:Vector3 this]</h3>
<div>
[page:Camera camera] — camera to use in the projection.<br />
</div>
<div>
Unprojects the vector with the camera.
</div>
<h3>[method:Boolean equals]( [page:Vector3 v] ) [page:Vector3 this]</h3>
<div>
Checks for strict equality of this vector and *v*.
</div>
<h3>[method:Vector3 clone]() [page:Vector3 this]</h3>
<div>
Clones this vector.
</div>
<h3>[method:Array toArray]( [page:Array array], [page:Integer offset] ) [page:Vector3 this]</h3>
<div>
array -- An optional array to store the vector to. <br />
offset -- An optional offset into the array.
</div>
<div>
Assigns this vector's x value to array[0]. <br />
Assigns this vector's y value to array[1]. <br />
Assigns this vector's z value to array[2]. <br />
Returns the created array.
</div>
<h2>Source</h2>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</body>
</html>