Class Vec3
Hierarchy
- Float64Array
- Vec3
Indexable
- [index: number]: number
Index
Constructor
Static
Accessors
Methods
Color Components
Vector Components
Swizzle Accessors (Optional)
Inherited
Constructor
constructor
- new Vec3(
...values: number[] | [ArrayBufferLike | Readonly<Vec3Like>, number?],
): Vec3 Create a Vec3.
Parameters
- ...values: number[] | [ArrayBufferLike | Readonly<Vec3Like>, number?]
Returns Vec3
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
- dist(a: Readonly<Vec3Like>, b: Readonly<Vec3Like>): number
Alias for Vec3.distance
Returns number
Static
distance
Static
div
Static
divide
Static
dot
Static
equals
Static
exactEquals
Static
floor
Static
fromValues
Static
hermite
Static
inverse
Static
len
- len(a: Readonly<Vec3Like>): number
Alias for Vec3.magnitude
Returns number
Deprecated
Use Vec3.mag
Static
length
- length(a: Readonly<Vec3Like>): number
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
- mag(a: Readonly<Vec3Like>): number
Alias for Vec3.magnitude
Returns number
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
- sqrDist(a: Readonly<Vec3Like>, b: Readonly<Vec3Like>): number
Alias for Vec3.squaredDistance
Returns number
Static
sqrLen
- sqrLen(a: Readonly<Vec3Like>, b: Readonly<Vec3Like>): number
Alias for Vec3.squaredLength
Returns number
Static
squaredDistance
Static
squaredLength
Static
str
Static
sub
Static
subtract
Static
transformMat3
Static
transformMat4
Static
transformQuat
Static
zero
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
Methods
abs
add
copy
dist
- dist(b: Readonly<Vec3Like>): number
Alias for Vec3.distance
Returns number
distance
div
- div(b: Readonly<Vec3Like>): this
Alias for Vec3.divide
Returns this
divide
dot
invert
mul
- mul(b: Readonly<Vec3Like>): this
Alias for Vec3.multiply
Returns this
multiply
negate
normalize
scale
scaleAndAdd
sqrDist
- sqrDist(b: Readonly<Vec3Like>): number
Alias for Vec3.squaredDistance
Returns number
squaredDistance
sub
- sub(b: Readonly<Vec3Like>): this
Alias for Vec3.subtract
Returns this
subtract
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
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
Swizzle Accessors (Optional)
bb
bbb
bbbb
bbbg
bbbr
bbg
bbgb
bbgg
bbgr
bbr
bbrb
bbrg
bbrr
bg
bgb
bgbb
bgbg
bgbr
bgg
bggb
bggg
bggr
bgr
bgrb
bgrg
bgrr
br
brb
brbb
brbg
brbr
brg
brgb
brgg
brgr
brr
brrb
brrg
brrr
gb
gbb
gbbb
gbbg
gbbr
gbg
gbgb
gbgg
gbgr
gbr
gbrb
gbrg
gbrr
gg
ggb
ggbb
ggbg
ggbr
ggg
gggb
gggg
gggr
ggr
ggrb
ggrg
ggrr
gr
grb
grbb
grbg
grbr
grg
grgb
grgg
grgr
grr
grrb
grrg
grrr
rb
rbb
rbbb
rbbg
rbbr
rbg
rbgb
rbgg
rbgr
rbr
rbrb
rbrg
rbrr
rg
rgb
rgbb
rgbg
rgbr
rgg
rggb
rggg
rggr
rgr
rgrb
rgrg
rgrr
rr
rrb
rrbb
rrbg
rrbr
rrg
rrgb
rrgg
rrgr
rrr
rrrb
rrrg
rrrr
xx
xxx
xxxx
xxxy
xxxz
xxy
xxyx
xxyy
xxyz
xxz
xxzx
xxzy
xxzz
xy
xyx
xyxx
xyxy
xyxz
xyy
xyyx
xyyy
xyyz
xyz
xyzx
xyzy
xyzz
xz
xzx
xzxx
xzxy
xzxz
xzy
xzyx
xzyy
xzyz
xzz
xzzx
xzzy
xzzz
yx
yxx
yxxx
yxxy
yxxz
yxy
yxyx
yxyy
yxyz
yxz
yxzx
yxzy
yxzz
yy
yyx
yyxx
yyxy
yyxz
yyy
yyyx
yyyy
yyyz
yyz
yyzx
yyzy
yyzz
yz
yzx
yzxx
yzxy
yzxz
yzy
yzyx
yzyy
yzyz
yzz
yzzx
yzzy
yzzz
zx
zxx
zxxx
zxxy
zxxz
zxy
zxyx
zxyy
zxyz
zxz
zxzx
zxzy
zxzz
zy
zyx
zyxx
zyxy
zyxz
zyy
zyyx
zyyy
zyyz
zyz
zyzx
zyzy
zyzz
zz
zzx
zzxx
zzxy
zzxz
zzy
zzyx
zzyy
zzyz
zzz
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,
): Float64Array<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 Float64Array<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,
): Float64Array<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 Float64Array<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): Float64Array<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 Float64Array<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): Float64Array<ArrayBuffer>
Gets a new Float64Array 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 Float64Array<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>): Float64Array<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 Float64Array<ArrayBuffer>
- arrayLike: ArrayLike<number>
- from<T>(
arrayLike: ArrayLike<T>,
mapfn: (v: T, k: number) => number,
thisArg?: any,
): Float64Array<ArrayBuffer> Creates an array from an array-like or iterable object.
Type Parameters
Parameters
Returns Float64Array<ArrayBuffer>
- from(arrayLike: Iterable<number, any, any>): Float64Array<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 Float64Array<ArrayBuffer>
- arrayLike: Iterable<number, any, any>
- from<T>(
arrayLike: Iterable<T, any, any>,
mapfn?: (v: T, k: number) => number,
thisArg?: any,
): Float64Array<ArrayBuffer> Creates an array from an array-like or iterable object.
Type Parameters
Parameters
Returns Float64Array<ArrayBuffer>
Static
of
- of(...items: number[]): Float64Array<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 Float64Array<ArrayBuffer>
- ...items: number[]
3 Dimensional Vector