Class Vec4
Hierarchy
- Float32Array
- Vec4
Indexable
- [index: number]: number
Index
Constructor
Static
Accessors
Methods
Color Components
Vector Components
Swizzle Accessors (Optional)
Inherited
Constructor
constructor
- new Vec4(
...values: number[] | [ArrayBufferLike | Readonly<Vec4Like>, number?],
): Vec4 Create a Vec4.
Parameters
- ...values: number[] | [ArrayBufferLike | Readonly<Vec4Like>, number?]
Returns Vec4
Static
Static
BYTE_LENGTH
- get BYTE_LENGTH(): number
Returns number
The number of bytes in a Vec4.
Static
abs
Static
add
Static
ceil
Static
clone
Static
copy
Static
create
Static
cross
Static
dist
- dist(a: Readonly<Vec4Like>, b: Readonly<Vec4Like>): number
Alias for Vec4.distance
Returns number
Static
distance
Static
div
Static
divide
Static
dot
Static
equals
Static
exactEquals
Static
floor
Static
fromValues
Static
inverse
Static
len
- len(a: Readonly<Vec4Like>): number
Alias for Vec4.magnitude
Returns number
Deprecated
Use Vec4.mag
Static
length
- length(a: Readonly<Vec4Like>): number
Alias for Vec4.magnitude
Returns number
Deprecated
Use Vec4.magnitude to avoid conflicts with builtin
length
methods/attribs
Static
lerp
Static
mag
- mag(a: Readonly<Vec4Like>): number
Alias for Vec4.magnitude
Returns number
Static
magnitude
Static
max
Static
min
Static
mul
Static
multiply
Static
negate
Static
normalize
Static
round
Static
scale
Static
scaleAndAdd
Static
set
Static
sqrDist
- sqrDist(a: Readonly<Vec4Like>, b: Readonly<Vec4Like>): number
Alias for Vec4.squaredDistance
Returns number
Static
sqrLen
- sqrLen(a: Readonly<Vec4Like>): number
Alias for Vec4.squaredLength
Returns number
Static
squaredDistance
Static
squaredLength
Static
str
Static
sub
Static
subtract
Static
transformMat4
Static
transformQuat
Static
zero
Accessors
mag
- get mag(): number
Alias for Vec4.magnitude
Returns number
magnitude
- get magnitude(): number
The magnitude (length) of this. Equivalent to
Vec4.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
str
- get str(): string
A string representation of
this
Equivalent toVec4.str(this);
Returns string
Methods
abs
add
copy
dist
- dist(b: Readonly<Vec4Like>): number
Alias for Vec4.distance
Returns number
distance
div
- div(b: Readonly<Vec4Like>): this
Alias for Vec4.divide
Returns this
divide
dot
invert
mul
- mul(b: Readonly<Vec4Like>): this
Alias for Vec4.multiply
Returns this
multiply
negate
normalize
scale
scaleAndAdd
sqrDist
- sqrDist(b: Readonly<Vec4Like>): number
Alias for Vec4.squaredDistance
Returns number
squaredDistance
sub
- sub(b: Readonly<Vec4Like>): this
Alias for Vec4.subtract
Returns this
subtract
Color Components
a
- get a(): number
The a component of the vector. Equivalent to
this[3];
Returns number
- set a(value: number): void
Parameters
- value: number
Returns void
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
Vector Components
w
- get w(): number
The w component of the vector. Equivalent to
this[3];
Returns number
- set w(value: number): void
Parameters
- value: number
Returns void
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
Swizzle Accessors (Optional)
aa
aaa
aaaa
aaab
aaag
aaar
aab
aaba
aabb
aabg
aabr
aag
aaga
aagb
aagg
aagr
aar
aara
aarb
aarg
aarr
ab
aba
abaa
abab
abag
abar
abb
abba
abbb
abbg
abbr
abg
abga
abgb
abgg
abgr
abr
abra
abrb
abrg
abrr
ag
aga
agaa
agab
agag
agar
agb
agba
agbb
agbg
agbr
agg
agga
aggb
aggg
aggr
agr
agra
agrb
agrg
agrr
ar
ara
araa
arab
arag
arar
arb
arba
arbb
arbg
arbr
arg
arga
argb
argg
argr
arr
arra
arrb
arrg
arrr
ba
baa
baaa
baab
baag
baar
bab
baba
babb
babg
babr
bag
baga
bagb
bagg
bagr
bar
bara
barb
barg
barr
bb
bba
bbaa
bbab
bbag
bbar
bbb
bbba
bbbb
bbbg
bbbr
bbg
bbga
bbgb
bbgg
bbgr
bbr
bbra
bbrb
bbrg
bbrr
bg
bga
bgaa
bgab
bgag
bgar
bgb
bgba
bgbb
bgbg
bgbr
bgg
bgga
bggb
bggg
bggr
bgr
bgra
bgrb
bgrg
bgrr
br
bra
braa
brab
brag
brar
brb
brba
brbb
brbg
brbr
brg
brga
brgb
brgg
brgr
brr
brra
brrb
brrg
brrr
ga
gaa
gaaa
gaab
gaag
gaar
gab
gaba
gabb
gabg
gabr
gag
gaga
gagb
gagg
gagr
gar
gara
garb
garg
garr
gb
gba
gbaa
gbab
gbag
gbar
gbb
gbba
gbbb
gbbg
gbbr
gbg
gbga
gbgb
gbgg
gbgr
gbr
gbra
gbrb
gbrg
gbrr
gg
gga
ggaa
ggab
ggag
ggar
ggb
ggba
ggbb
ggbg
ggbr
ggg
ggga
gggb
gggg
gggr
ggr
ggra
ggrb
ggrg
ggrr
gr
gra
graa
grab
grag
grar
grb
grba
grbb
grbg
grbr
grg
grga
grgb
grgg
grgr
grr
grra
grrb
grrg
grrr
ra
raa
raaa
raab
raag
raar
rab
raba
rabb
rabg
rabr
rag
raga
ragb
ragg
ragr
rar
rara
rarb
rarg
rarr
rb
rba
rbaa
rbab
rbag
rbar
rbb
rbba
rbbb
rbbg
rbbr
rbg
rbga
rbgb
rbgg
rbgr
rbr
rbra
rbrb
rbrg
rbrr
rg
rga
rgaa
rgab
rgag
rgar
rgb
rgba
rgbb
rgbg
rgbr
rgg
rgga
rggb
rggg
rggr
rgr
rgra
rgrb
rgrg
rgrr
rr
rra
rraa
rrab
rrag
rrar
rrb
rrba
rrbb
rrbg
rrbr
rrg
rrga
rrgb
rrgg
rrgr
rrr
rrra
rrrb
rrrg
rrrr
ww
www
wwww
wwwx
wwwy
wwwz
wwx
wwxw
wwxx
wwxy
wwxz
wwy
wwyw
wwyx
wwyy
wwyz
wwz
wwzw
wwzx
wwzy
wwzz
wx
wxw
wxww
wxwx
wxwy
wxwz
wxx
wxxw
wxxx
wxxy
wxxz
wxy
wxyw
wxyx
wxyy
wxyz
wxz
wxzw
wxzx
wxzy
wxzz
wy
wyw
wyww
wywx
wywy
wywz
wyx
wyxw
wyxx
wyxy
wyxz
wyy
wyyw
wyyx
wyyy
wyyz
wyz
wyzw
wyzx
wyzy
wyzz
wz
wzw
wzww
wzwx
wzwy
wzwz
wzx
wzxw
wzxx
wzxy
wzxz
wzy
wzyw
wzyx
wzyy
wzyz
wzz
wzzw
wzzx
wzzy
wzzz
xw
xww
xwww
xwwx
xwwy
xwwz
xwx
xwxw
xwxx
xwxy
xwxz
xwy
xwyw
xwyx
xwyy
xwyz
xwz
xwzw
xwzx
xwzy
xwzz
xx
xxw
xxww
xxwx
xxwy
xxwz
xxx
xxxw
xxxx
xxxy
xxxz
xxy
xxyw
xxyx
xxyy
xxyz
xxz
xxzw
xxzx
xxzy
xxzz
xy
xyw
xyww
xywx
xywy
xywz
xyx
xyxw
xyxx
xyxy
xyxz
xyy
xyyw
xyyx
xyyy
xyyz
xyz
xyzw
xyzx
xyzy
xyzz
xz
xzw
xzww
xzwx
xzwy
xzwz
xzx
xzxw
xzxx
xzxy
xzxz
xzy
xzyw
xzyx
xzyy
xzyz
xzz
xzzw
xzzx
xzzy
xzzz
yw
yww
ywww
ywwx
ywwy
ywwz
ywx
ywxw
ywxx
ywxy
ywxz
ywy
ywyw
ywyx
ywyy
ywyz
ywz
ywzw
ywzx
ywzy
ywzz
yx
yxw
yxww
yxwx
yxwy
yxwz
yxx
yxxw
yxxx
yxxy
yxxz
yxy
yxyw
yxyx
yxyy
yxyz
yxz
yxzw
yxzx
yxzy
yxzz
yy
yyw
yyww
yywx
yywy
yywz
yyx
yyxw
yyxx
yyxy
yyxz
yyy
yyyw
yyyx
yyyy
yyyz
yyz
yyzw
yyzx
yyzy
yyzz
yz
yzw
yzww
yzwx
yzwy
yzwz
yzx
yzxw
yzxx
yzxy
yzxz
yzy
yzyw
yzyx
yzyy
yzyz
yzz
yzzw
yzzx
yzzy
yzzz
zw
zww
zwww
zwwx
zwwy
zwwz
zwx
zwxw
zwxx
zwxy
zwxz
zwy
zwyw
zwyx
zwyy
zwyz
zwz
zwzw
zwzx
zwzy
zwzz
zx
zxw
zxww
zxwx
zxwy
zxwz
zxx
zxxw
zxxx
zxxy
zxxz
zxy
zxyw
zxyx
zxyy
zxyz
zxz
zxzw
zxzx
zxzy
zxzz
zy
zyw
zyww
zywx
zywy
zywz
zyx
zyxw
zyxx
zyxy
zyxz
zyy
zyyw
zyyx
zyyy
zyyz
zyz
zyzw
zyzx
zyzy
zyzz
zz
zzw
zzww
zzwx
zzwy
zzwz
zzx
zzxw
zzxx
zzxy
zzxz
zzy
zzyw
zzyx
zzyy
zzyz
zzz
zzzw
zzzx
zzzy
zzzz
Inherited
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]
- "[iterator]"(): ArrayIterator<number>
Returns ArrayIterator<number>
at
copyWithin
- copyWithin(target: number, start: number, end?: number): this
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
- entries(): ArrayIterator<[number, number]>
Returns an array of key, value pairs for every entry in the array
Returns ArrayIterator<[number, number]>
every
- every(
predicate: (value: number, index: number, array: this) => unknown,
thisArg?: any,
): boolean 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
- fill(value: number, start?: number, end?: number): this
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
- find(
predicate: (value: number, index: number, obj: this) => boolean,
thisArg?: any,
): number 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
- findIndex(
predicate: (value: number, index: number, obj: this) => boolean,
thisArg?: any,
): number 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
- forEach(
callbackfn: (value: number, index: number, array: this) => void,
thisArg?: any,
): void 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
- includes(searchElement: number, fromIndex?: number): boolean
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
- indexOf(searchElement: number, fromIndex?: number): number
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
- join(separator?: string): string
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
- keys(): ArrayIterator<number>
Returns an list of keys in the array
Returns ArrayIterator<number>
lastIndexOf
- lastIndexOf(searchElement: number, fromIndex?: number): number
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,
): number Calls 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,
): number Parameters
- 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,
): U Calls 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
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
- callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U
reduceRight
- reduceRight(
callbackfn: (
previousValue: number,
currentValue: number,
currentIndex: number,
array: this,
) => number,
): number Calls 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,
): number Parameters
- 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,
): U Calls 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
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
- callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: this) => U
reverse
set
slice
- slice(start?: number, end?: number): Float32Array<ArrayBuffer>
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
- some(
predicate: (value: number, index: number, array: this) => unknown,
thisArg?: any,
): boolean 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
- sort(compareFn?: (a: number, b: number) => number): this
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
- subarray(begin?: number, end?: number): Float32Array<ArrayBuffer>
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
- toLocaleString(): string
Converts a number to a string by using the current locale.
Returns string
- toLocaleString(
locales: string | string[],
options?: NumberFormatOptions,
): string Parameters
- locales: string | string[]
Optional
options: NumberFormatOptions
Returns string
toString
valueOf
values
- values(): ArrayIterator<number>
Returns an list of values in the array
Returns ArrayIterator<number>
Static
from
- from(arrayLike: ArrayLike<number>): Float32Array<ArrayBuffer>
Creates an array from an array-like or iterable object.
Parameters
- arrayLike: ArrayLike<number>
An array-like or iterable 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
Parameters
Returns Float32Array<ArrayBuffer>
- from(arrayLike: Iterable<number, any, any>): Float32Array<ArrayBuffer>
Creates an array from an array-like or iterable object.
Parameters
- arrayLike: Iterable<number, any, any>
An array-like or iterable object to convert to an array.
Returns Float32Array<ArrayBuffer>
- arrayLike: Iterable<number, any, any>
- from<T>(
arrayLike: Iterable<T, any, any>,
mapfn?: (v: T, k: number) => number,
thisArg?: any,
): Float32Array<ArrayBuffer> Creates an array from an array-like or iterable object.
Type Parameters
Parameters
Returns Float32Array<ArrayBuffer>
Static
of
- of(...items: number[]): Float32Array<ArrayBuffer>
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[]
4 Dimensional Vector