Methods
add(other)
Construct a new vector from this vector plus another via vector addition.
Parameters:
| Name | Type | Description |
|---|---|---|
other |
Vector3 | another vector |
- Source:
Returns:
this + other
divideScalar(scalar) → {Vector3}
Construct a new vector from this vector divided by a scalar value.
Parameters:
| Name | Type | Description |
|---|---|---|
scalar |
- Source:
Returns:
- Type
- Vector3
length() → {number}
Get the length of this vector.
- Source:
Returns:
- Type
- number
lengthSquared() → {number}
Get the length of this vector, squared.
May be used for length comparisons without needing to calculate the actual length using square root.
- Source:
Returns:
- Type
- number
map(f) → {Vector3}
Construct a vector with the values of this vector passed through the specified function.
Parameters:
| Name | Type | Description |
|---|---|---|
f |
function | a function accepting a number and returning the mapped number. Will be applied to all coordinates. |
- Source:
Returns:
- Type
- Vector3
multiplyScalar(scalar) → {Vector3}
Construct a new vector from this vector multiplied by a scalar value.
Parameters:
| Name | Type | Description |
|---|---|---|
scalar |
- Source:
Returns:
- Type
- Vector3
normalize() → {Vector3}
Construct a new normalized vector based on this one.
That is, scales this vector by a scalar so that its length equals one.
If the original vector's length is zero, then the normalized vector will be the zero vector.
- Source:
Returns:
the normalized vector.
- Type
- Vector3
round() → {Vector3}
Construct a vector with the values of this vector rounded to the nearest integer (that is, floor of the 0.5 + the value).
- Source:
Returns:
- Type
- Vector3
subtract(other)
Construct a new vector from this vector minus another via vector subtraction.
Parameters:
| Name | Type | Description |
|---|---|---|
other |
Vector3 | another vector |
- Source:
Returns:
this - other