Class Vec3
Hierarchy
- Float32Array
- Vec3
Indexable
- [index: number]: number
Index
Accessors
Color Components
Constructor
Methods
Other
Static
Vector Components
Accessors
mag
- get mag(): number
Alias for Vec3.magnitude
Returns number
magnitude
- get magnitude(): number
The magnitude (length) of this. Equivalent to
Vec3.magnitude(this);
Magnitude is used because the
length
attribute is already defined by TypedArrays to mean the number of elements in the array.Returns number
sqrMag
- get sqrMag(): number
Alias for Vec3.squaredMagnitude
Returns number
squaredMagnitude
- get squaredMagnitude(): number
The squared magnitude (length) of
this
. Equivalent toVec3.squaredMagnitude(this);
Returns number
str
- get str(): string
A string representation of
this
Equivalent toVec3.str(this);
Returns string
Color Components
b
- get b(): number
The b component of the vector. Equivalent to
this[2];
Returns number
- set b(value: number): void
Parameters
- value: number
Returns void
g
- get g(): number
The g component of the vector. Equivalent to
this[1];
Returns number
- set g(value: number): void
Parameters
- value: number
Returns void
r
- get r(): number
The r component of the vector. Equivalent to
this[0];
Returns number
- set r(value: number): void
Parameters
- value: number
Returns void
Constructor
constructor
Create a Vec3.
Parameters
- ...values: number[] | [ArrayBufferLike | Readonly<Vec3Like>, number?]
Returns Vec3
Methods
abs
Sets each component of
this
to its absolute value. Equivalent toVec3.abs(this, this);
Returns this
this
add
copy
dist
distance
div
divide
dot
invert
Inverts the components of
this
. Equivalent toVec3.inverse(this, this);
Returns this
this
mul
multiply
negate
Negates the components of
this
. Equivalent toVec3.negate(this, this);
Returns this
this
normalize
Normalize
this
. Equivalent toVec3.normalize(this, this);
Returns this
this
scale
Scales
this
by a scalar number. Equivalent toVec3.scale(this, this, b);
Parameters
- b: number
Amount to scale
this
by
Returns this
this
- b: number
scaleAndAdd
sqrDist
squaredDistance
sub
subtract
Other
Readonly
[toStringTag]
Readonly
buffer
The ArrayBuffer instance referenced by the array.
Readonly
byteLength
The length in bytes of the array.
Readonly
byteOffset
The offset in bytes of the array.
Readonly
BYTES_PER_ELEMENT
The size in bytes of each element in the array.
Readonly
length
The length of the array.
Static
Readonly
BYTES_PER_ELEMENT
The size in bytes of each element in the array.
[iterator]
Returns ArrayIterator<number>
at
Returns the item located at the specified index.
Parameters
- index: number
The zero-based index of the desired code unit. A negative index will count back from the last item.
Returns number
- index: number
copyWithin
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
Parameters
- target: number
If target is negative, it is treated as length+target where length is the length of the array.
- start: number
If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional
end: numberIf not specified, length of the this object is used as its default value.
Returns this
- target: number
entries
Returns an array of key, value pairs for every entry in the array
Returns ArrayIterator<[number, number]>
every
Determines whether all the members of an array satisfy the specified test.
Parameters
- predicate: (value: number, index: number, array: this) => unknown
A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns boolean
- predicate: (value: number, index: number, array: this) => unknown
fill
Changes all array elements from
start
toend
index to a staticvalue
and returns the modified arrayParameters
- value: number
value to fill array section with
Optional
start: numberindex to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
Optional
end: numberindex to stop filling the array at. If end is negative, it is treated as length+end.
Returns this
- value: number
filter
- filter(
predicate: (value: number, index: number, array: this) => any,
thisArg?: any,
): Float32Array<ArrayBuffer>Returns the elements of an array that meet the condition specified in a callback function.
Parameters
- predicate: (value: number, index: number, array: this) => any
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns Float32Array<ArrayBuffer>
- predicate: (value: number, index: number, array: this) => any
find
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
Parameters
- predicate: (value: number, index: number, obj: this) => boolean
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number
- predicate: (value: number, index: number, obj: this) => boolean
findIndex
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
Parameters
- predicate: (value: number, index: number, obj: this) => boolean
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
Optional
thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number
- predicate: (value: number, index: number, obj: this) => boolean
forEach
Performs the specified action for each element in an array.
Parameters
- callbackfn: (value: number, index: number, array: this) => void
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void
- callbackfn: (value: number, index: number, array: this) => void
includes
Determines whether an array includes a certain element, returning true or false as appropriate.
Parameters
- searchElement: number
The element to search for.
Optional
fromIndex: numberThe position in this array at which to begin searching for searchElement.
Returns boolean
- searchElement: number
indexOf
Returns the index of the first occurrence of a value in an array.
Parameters
- searchElement: number
The value to locate in the array.
Optional
fromIndex: numberThe array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number
- searchElement: number
join
Adds all the elements of an array separated by the specified separator string.
Parameters
Optional
separator: stringA string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string
keys
Returns an list of keys in the array
Returns ArrayIterator<number>
lastIndexOf
Returns the index of the last occurrence of a value in an array.
Parameters
- searchElement: number
The value to locate in the array.
Optional
fromIndex: numberThe array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number
- searchElement: number
map
- map(
callbackfn: (value: number, index: number, array: this) => number,
thisArg?: any,
): Float32Array<ArrayBuffer>Calls a defined callback function on each element of an array, and returns an array that contains the results.
Parameters
- callbackfn: (value: number, index: number, array: this) => number
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Float32Array<ArrayBuffer>
- callbackfn: (value: number, index: number, array: this) => number
reduce
- reduce(
callbackfn: (
previousValue: number,
currentValue: number,
currentIndex: number,
array: this,
) => number,
): numberCalls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
- callbackfn: (
previousValue: number,
currentValue: number,
currentIndex: number,
array: this,
) => numberA function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Returns number
- callbackfn: (
- reduce(
callbackfn: (
previousValue: number,
currentValue: number,
currentIndex: number,
array: this,
) => number,
initialValue: number,
): numberParameters
- callbackfn: (
previousValue: number,
currentValue: number,
currentIndex: number,
array: this,
) => number - initialValue: number
Returns number
- callbackfn: (
- reduce<U>(
callbackfn: (
previousValue: U,
currentValue: number,
currentIndex: number,
array: this,
) => U,
initialValue: U,
): UCalls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type Parameters
- U
Parameters
- callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
- initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
reduceRight
- reduceRight(
callbackfn: (
previousValue: number,
currentValue: number,
currentIndex: number,
array: this,
) => number,
): numberCalls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Parameters
- callbackfn: (
previousValue: number,
currentValue: number,
currentIndex: number,
array: this,
) => numberA function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Returns number
- callbackfn: (
- reduceRight(
callbackfn: (
previousValue: number,
currentValue: number,
currentIndex: number,
array: this,
) => number,
initialValue: number,
): numberParameters
- callbackfn: (
previousValue: number,
currentValue: number,
currentIndex: number,
array: this,
) => number - initialValue: number
Returns number
- callbackfn: (
- reduceRight<U>(
callbackfn: (
previousValue: U,
currentValue: number,
currentIndex: number,
array: this,
) => U,
initialValue: U,
): UCalls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type Parameters
- U
Parameters
- callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
- initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
reverse
Reverses the elements in an Array.
Returns this
set
Sets a value or an array of values.
Parameters
- array: ArrayLike<number>
A typed or untyped array of values to set.
Optional
offset: numberThe index in the current array at which the values are to be written.
Returns void
- array: ArrayLike<number>
slice
Returns a section of an array.
Parameters
Optional
start: numberThe beginning of the specified portion of the array.
Optional
end: numberThe end of the specified portion of the array. This is exclusive of the element at the index 'end'.
Returns Float32Array<ArrayBuffer>
some
Determines whether the specified callback function returns true for any element of an array.
Parameters
- predicate: (value: number, index: number, array: this) => unknown
A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.
Optional
thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns boolean
- predicate: (value: number, index: number, array: this) => unknown
sort
Sorts an array.
Parameters
Optional
compareFn: (a: number, b: number) => numberFunction used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.
[11,2,22,1].sort((a, b) => a - b)
Returns this
subarray
Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.
Parameters
Optional
begin: numberThe index of the beginning of the array.
Optional
end: numberThe index of the end of the array.
Returns Float32Array<ArrayBuffer>
toLocaleString
Converts a number to a string by using the current locale.
Returns string
Parameters
- locales: string | string[]
Optional
options: NumberFormatOptions
Returns string
toString
Returns a string representation of an array.
Returns string
valueOf
Returns the primitive value of the specified object.
Returns this
values
Returns an list of values in the array
Returns ArrayIterator<number>
Static
from
Creates an array from an array-like or iterable object.
Parameters
- arrayLike: ArrayLike<number>
An array-like object to convert to an array.
Returns Float32Array<ArrayBuffer>
- arrayLike: ArrayLike<number>
- from<T>(
arrayLike: ArrayLike<T>,
mapfn: (v: T, k: number) => number,
thisArg?: any,
): Float32Array<ArrayBuffer>Creates an array from an array-like or iterable object.
Type Parameters
- T
Parameters
Returns Float32Array<ArrayBuffer>
Creates an array from an array-like or iterable object.
Parameters
- elements: Iterable<number>
An iterable object to convert to an array.
Returns Float32Array<ArrayBuffer>
- elements: Iterable<number>
- from<T>(
elements: Iterable<T>,
mapfn?: (v: T, k: number) => number,
thisArg?: any,
): Float32Array<ArrayBuffer>Creates an array from an array-like or iterable object.
Type Parameters
- T
Parameters
Returns Float32Array<ArrayBuffer>
Static
of
Returns a new array from a set of elements.
Parameters
- ...items: number[]
A set of elements to include in the new array object.
Returns Float32Array<ArrayBuffer>
- ...items: number[]
Static
Static
BYTE_LENGTH
- get BYTE_LENGTH(): number
Returns number
The number of bytes in a Vec3.
Static
abs
Static
add
Static
angle
Static
bezier
Static
ceil
Static
clone
Static
copy
Static
create
Static
cross
Static
dist
Static
distance
Static
div
Static
divide
Static
dot
Static
equals
Static
exactEquals
Static
floor
Static
fromValues
Creates a new vec3 initialized with the given values
Parameters
- x: number
X component
- y: number
Y component
- z: number
Z component
Returns Vec3
a new 3D vector
- x: number
Static
hermite
Static
inverse
Static
len
Static
length
Alias for Vec3.magnitude
Returns number
length of a
Deprecated
Use Vec3.magnitude to avoid conflicts with builtin
length
methods/attribs
Static
lerp
Static
mag
Static
magnitude
Static
max
Static
min
Static
mul
Static
multiply
Static
negate
Static
normalize
Static
rotateX
Static
rotateY
Static
rotateZ
Static
scale
Static
scaleAndAdd
Static
set
Static
slerp
Static
sqrDist
Static
sqrLen
Static
squaredDistance
Static
squaredLength
Static
str
Static
sub
Static
subtract
Static
transformMat3
Static
transformMat4
Static
transformQuat
Static
zero
Vector Components
x
- get x(): number
The x component of the vector. Equivalent to
this[0];
Returns number
- set x(value: number): void
Parameters
- value: number
Returns void
y
- get y(): number
The y component of the vector. Equivalent to
this[1];
Returns number
- set y(value: number): void
Parameters
- value: number
Returns void
z
- get z(): number
The z component of the vector. Equivalent to
this[2];
Returns number
- set z(value: number): void
Parameters
- value: number
Returns void
3 Dimensional Vector