Class Vector4

Constructors

constructor

new Vector4(x?: number, y?: number, z?: number, w?: number): Vector4
Parameters
- x: number = 0
- y: number = 0
- z: number = 0
- w: number = 0
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:31

Properties

w

w: number

x

x: number

y

y: number

z

z: number

`Static` `Readonly`NegW

NegW: Vector4 = ...

Unit vector pointing in the negative w-axis.

`Static` `Readonly`NegX

NegX: Vector4 = ...

Unit vector pointing in the negative x-axis.

`Static` `Readonly`NegY

NegY: Vector4 = ...

Unit vector pointing in the negative y-axis.

`Static` `Readonly`NegZ

NegZ: Vector4 = ...

Unit vector pointing in the negative z-axis.

`Static` `Readonly`W

W: Vector4 = ...

Unit vector pointing in the negative w-axis.

`Static` `Readonly`X

X: Vector4 = ...

Unit vector pointing in the x-axis.

`Static` `Readonly`Y

Y: Vector4 = ...

Unit vector pointing in the y-axis.

`Static` `Readonly`Z

Z: Vector4 = ...

Unit vector pointing in the z-axis.

`Static` `Readonly`Zero

Zero: Vector4 = ...

A vector whose components values will remain 0.

Methods

[iterator]

"[iterator]"(): Generator<number, void, unknown>
Returns Generator<number, void, unknown>
Yields
- Defined in src/math/core/vectors/float/vector4.js:586

add

add(v: Vector4): Vector4
Adds a given vector into this.
Parameters
- v: Vector4
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:146

addScalar

addScalar(n: number): Vector4
Adds a scalar value into this vector's component values.
Parameters
- n: number
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:157

clone

clone(): Vector4
Returns a copy of this.

Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:68

copy

copy(v: Vector4): Vector4
Copies values of another vector to this vector.
Parameters
- v: Vector4
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:58

distanceTo

distanceTo(v: Vector4): number
Returns the distance between this vector and another vector.
Parameters
- v: Vector4
  The other vector.
Returns number
- Defined in src/math/core/vectors/float/vector4.js:105

distanceToSquared

distanceToSquared(v: Vector4): number
Returns the squared distance between this vector and another vector.
Parameters
- v: Vector4
  The other vector.
Returns number
- Defined in src/math/core/vectors/float/vector4.js:115

divide

divide(v: Vector4): Vector4
Divides this vector with a scalar.
Parameters
- v: Vector4
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:215

divideScalar

divideScalar(s: number): Vector4
Parameters
- s: number
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:225

dot

dot(v: Vector4): number
Calculates the dot product of this with another vector.
Parameters
- v: Vector4
Returns number
- Defined in src/math/core/vectors/float/vector4.js:237

equals

equals(v: Vector4): boolean
Checks to see if this vector is equal to another vector.
Parameters
- v: Vector4
Returns boolean
- Defined in src/math/core/vectors/float/vector4.js:267

invert

invert(): Vector4
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:255

magnitude

magnitude(): number
Returns length of this vector.

Returns number
- Defined in src/math/core/vectors/float/vector4.js:96

magnitudeSquared

magnitudeSquared(): number
Returns the length squared of this vector.

Returns number
- Defined in src/math/core/vectors/float/vector4.js:87

multiply

multiply(v: Vector4): Vector4
Multiplies this vector with a given vector.
Parameters
- v: Vector4
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:192

multiplyScalar

multiplyScalar(s: number): Vector4
Multiplies a scalar value with this vector's component values.
Parameters
- s: number
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:203

normalize

normalize(): Vector4
Makes this a unit vector.

Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:123

reverse

reverse(): Vector4
Negates the values of this vector.

Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:246

set

set(x: number, y: number, z: number, w: number): Vector4
Sets x,y and z values of this vector to the given parameter.
Parameters
- x: number
- y: number
- z: number
- w: number
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:46

setMagnitude

setMagnitude(length: number): Vector4
Sets this vector to have the given length.
Parameters
- length: number
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:134

splat

splat(scalar: number): Vector4
Parameters
- scalar: number
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:76

subtract

subtract(v: Vector4): Vector4
Subtracts a given vector from this vector.
Parameters
- v: Vector4
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:169

subtractScalar

subtractScalar(n: number): Vector4
Subtracts a scalar value from this vector's component values.
Parameters
- n: number
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:181

`Static`add

add(a: Vector4, b: Vector4, out?: Vector4): Vector4
Parameters
- a: Vector4
- b: Vector4
- out: Vector4 = ...
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:391

`Static`addScalar

addScalar(v: Vector4, s: number, out?: Vector4): Vector4
Parameters
- v: Vector4
- s: number
- out: Vector4 = ...
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:406

`Static`clampMagnitude

clampMagnitude(v: Vector4, min: number, max: number, out?: Vector4): Vector4
Parameters
- v: Vector4
- min: number
- max: number
- out: Vector4 = ...
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:377

`Static`copy

copy(v: Vector4, out?: Vector4): Vector4
Parameters
- v: Vector4
- out: Vector4 = ...
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:292

`Static`distanceTo

distanceTo(v1: Vector4, v2: Vector4): number
Parameters
- v1: Vector4
- v2: Vector4
Returns number
- Defined in src/math/core/vectors/float/vector4.js:345

`Static`distanceToSquared

distanceToSquared(v1: Vector4, v2: Vector4): number
Parameters
- v1: Vector4
- v2: Vector4
Returns number
- Defined in src/math/core/vectors/float/vector4.js:332

`Static`divide

divide(a: Vector4, b: Vector4, out?: Vector4): Vector4
Parameters
- a: Vector4
- b: Vector4
- out: Vector4 = ...
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:477

`Static`divideScalar

divideScalar(v: Vector4, scalar: number, out?: Vector4): Vector4
Parameters
- v: Vector4
- scalar: number
- out: Vector4 = ...
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:491

`Static`dot

dot(a: Vector4, b: Vector4): number
Parameters
- a: Vector4
- b: Vector4
Returns number
- Defined in src/math/core/vectors/float/vector4.js:526

`Static`equal

equal(a: Vector4, b: Vector4): boolean
Parameters
- a: Vector4
- b: Vector4
Returns boolean
- Defined in src/math/core/vectors/float/vector4.js:565

`Static`invert

invert(v: Vector4, out?: Vector4): Vector4
Parameters
- v: Vector4
- out: Vector4 = ...
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:512

`Static`lerp

lerp(from: Vector4, to: Vector4, t: number, out?: Vector4): Vector4
Parameters
- from: Vector4
- to: Vector4
- t: number
- out: Vector4 = ...
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:536

`Static`magnitude

magnitude(v: Vector4): number
Parameters
- v: Vector4
Returns number
- Defined in src/math/core/vectors/float/vector4.js:324

`Static`magnitudeSquared

magnitudeSquared(v: Vector4): number
Parameters
- v: Vector4
Returns number
- Defined in src/math/core/vectors/float/vector4.js:317

`Static`multiply

multiply(a: Vector4, b: Vector4, out?: Vector4): Vector4
Parameters
- a: Vector4
- b: Vector4
- out: Vector4 = ...
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:449

`Static`multiplyScalar

multiplyScalar(v: Vector4, s: number, out?: Vector4): Vector4
Parameters
- v: Vector4
- s: number
- out: Vector4 = ...
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:463

`Static`set

set(x: number, y: number, z: number, w: number, out?: Vector4): Vector4
Parameters
- x: number
- y: number
- z: number
- w: number
- out: Vector4 = ...
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:278

`Static`setMagnitude

setMagnitude(v: Vector4, length: number, out?: Vector4): Vector4
Parameters
- v: Vector4
- length: number
- out: Vector4 = ...
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:364

`Static`splat

splat(scalar: number, out?: Vector4): Vector4
Parameters
- scalar: number
- out: Vector4 = ...
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:305

`Static`subtract

subtract(a: Vector4, b: Vector4, out?: Vector4): Vector4
Parameters
- a: Vector4
- b: Vector4
- out: Vector4 = ...
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:421

`Static`subtractScalar

subtractScalar(v: Vector4, s: number, out?: Vector4): Vector4
Parameters
- v: Vector4
- s: number
- out: Vector4 = ...
Returns Vector4
- Defined in src/math/core/vectors/float/vector4.js:435

Class Vector4

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Vector4

Properties

w

x

y

z

Static ReadonlyNegW

Static ReadonlyNegX

Static ReadonlyNegY

Static ReadonlyNegZ

Static ReadonlyW

Static ReadonlyX

Static ReadonlyY

Static ReadonlyZ

Static ReadonlyZero

Methods

[iterator]

Returns Generator<number, void, unknown>

Yields

add

Parameters

Returns Vector4

addScalar

Parameters

Returns Vector4

clone

Returns Vector4

copy

Parameters

Returns Vector4

distanceTo

Parameters

Returns number

distanceToSquared

Parameters

Returns number

divide

Parameters

Returns Vector4

divideScalar

Parameters

Returns Vector4

dot

Parameters

Returns number

equals

Parameters

Returns boolean

invert

Returns Vector4

magnitude

Returns number

magnitudeSquared

Returns number

multiply

Parameters

Returns Vector4

multiplyScalar

Parameters

Returns Vector4

normalize

Returns Vector4

reverse

Returns Vector4

set

Parameters

Returns Vector4

setMagnitude

Parameters

Returns Vector4

splat

Parameters

`Static` `Readonly`NegW

`Static` `Readonly`NegX

`Static` `Readonly`NegY

`Static` `Readonly`NegZ

`Static` `Readonly`W

`Static` `Readonly`X

`Static` `Readonly`Y

`Static` `Readonly`Z

`Static` `Readonly`Zero

`Static`add

`Static`addScalar

`Static`clampMagnitude

`Static`copy

`Static`distanceTo

`Static`distanceToSquared

`Static`divide

`Static`divideScalar

`Static`dot

`Static`equal

`Static`invert

`Static`lerp

`Static`magnitude

`Static`magnitudeSquared

`Static`multiply

`Static`multiplyScalar

`Static`normalize

`Static`random

`Static`reflect

`Static`reverse

`Static`set