Threepp.Vector2¶
2D vector class
Represents a two-dimensional vector. It can also be converted from an array [x, y] or a dictionary %[x:, y:].
Members¶
Constructors¶
Properties¶
Methods¶
- set
- setScalar
- copy
- add
- addScalar
- sub
- subScalar
- multiplyScalar
- divideScalar
- negate
- dot
- cross
- lengthSq
- length
- normalize
- distanceTo
- distanceToSquared
- lerp
- equals
- floor
- ceil
- round
Vector2¶
Constructor
Arguments
| Arguments | Default | Description |
|---|---|---|
x |
0 |
X component. |
y |
0 |
Y component. |
Description
Constructor
x¶
Property \ Access: r/w
Description
X component
y¶
Property \ Access: r/w
Description
Y component
set¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
x |
|
|
y |
|
Description
Sets the values
setScalar¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
value |
|
Description
Sets all components to the same value
copy¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
v |
|
Description
Copies another vector
add¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
v |
|
Description
Adds a vector
addScalar¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
s |
|
Description
Adds a scalar
sub¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
v |
|
Description
Subtracts a vector
subScalar¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
s |
|
Description
Subtracts a scalar
multiplyScalar¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
s |
|
Description
Multiplies by a scalar
divideScalar¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
s |
|
Description
Divides by a scalar
negate¶
Method
Description
Negates the vector
dot¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
v |
|
Description
Dot product
cross¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
v |
|
Description
Cross product (returns a scalar)
lengthSq¶
Method
Description
Squared length
length¶
Method
Description
Length
normalize¶
Method
Description
Normalizes the vector
distanceTo¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
v |
|
Description
Distance to another vector
distanceToSquared¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
v |
|
Description
Squared distance
lerp¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
v |
|
|
alpha |
|
Description
Linear interpolation
equals¶
Method
Arguments
| Arguments | Default | Description |
|---|---|---|
v |
|
Description
Equality test
floor¶
Method
Description
Rounds each component down
ceil¶
Method
Description
Rounds each component up
round¶
Method
Description
Rounds each component to the nearest integer