Class Vector3

Hierarchy (View Summary)

Vector3

Constructors

constructor

new Vector3(x?: number, y?: number, z?: number): Vector3
Parameters
- x: number = 0
- y: number = 0
- z: number = 0
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:4

Properties

x

x: number

y

y: number

z

z: number

`Static` `Readonly`NegX

NegX: Vector3 = ...

Unit vector pointing in the negative x-axis.

`Static` `Readonly`NegY

NegY: Vector3 = ...

Unit vector pointing in the negative y-axis.

`Static` `Readonly`NegZ

NegZ: Vector3 = ...

Unit vector pointing in the negative z-axis.

`Static` `Readonly`X

X: Vector3 = ...

Unit vector pointing in the x-axis.

`Static` `Readonly`Y

Y: Vector3 = ...

Unit vector pointing in the y-axis.

`Static` `Readonly`Z

Z: Vector3 = ...

Unit vector pointing in the z-axis.

`Static` `Readonly`Zero

Zero: Vector3 = ...

A vector whose x and y values will remain 0.

Methods

[iterator]

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

add

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

addScalar

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

clone

clone(): Vector3
Returns a copy of this.

Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:39

copy

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

cross

cross(v: Vector3): Vector3
Calculates the cross product of this with another vector.
Parameters
- v: Vector3
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:218

distanceTo

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

distanceToSquared

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

divide

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

divideScalar

divideScalar(s: number): Vector3
Parameters
- s: number
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:196

dot

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

equals

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

invert

invert(): Vector3
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:238

magnitude

magnitude(): number
Returns length of this vector.

Returns number
- Defined in src/math/core/vectors/float/vector3.js:67

magnitudeSquared

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

Returns number
- Defined in src/math/core/vectors/float/vector3.js:58

multiply

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

multiplyScalar

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

normalize

normalize(): Vector3
Makes this a unit vector.

Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:94

reverse

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

Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:229

set

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

setMagnitude

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

splat

splat(scalar: number): Vector3
Parameters
- scalar: number
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:47

subtract

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

subtractScalar

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

`Static`add

add(v1: Vector3, v2: Vector3, out?: Vector3): Vector3
Parameters
- v1: Vector3
- v2: Vector3
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:370

`Static`addScalar

addScalar(v1: Vector3, scalar: number, out?: Vector3): Vector3
Parameters
- v1: Vector3
- scalar: number
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:383

`Static`angleBetween

angleBetween(v1: Vector3, v2: Vector3): number
Parameters
- v1: Vector3
- v2: Vector3
Returns number
- Defined in src/math/core/vectors/float/vector3.js:550

`Static`clampMagnitude

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

`Static`copy

copy(v1: Vector3, out?: Vector3): Vector3
Parameters
- v1: Vector3
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:272

`Static`cross

cross(a: Vector3, b: Vector3, out?: Vector3): Vector3
Parameters
- a: Vector3
- b: Vector3
- Optionalout: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:502

`Static`distanceTo

distanceTo(v1: Vector3, v2: Vector3): number
Parameters
- v1: Vector3
- v2: Vector3
Returns number
- Defined in src/math/core/vectors/float/vector3.js:322

`Static`distanceToSquared

distanceToSquared(v1: Vector3, v2: Vector3): number
Parameters
- v1: Vector3
- v2: Vector3
Returns number
- Defined in src/math/core/vectors/float/vector3.js:310

`Static`divide

divide(v1: Vector3, v2: Vector3, out?: Vector3): Vector3
Parameters
- v1: Vector3
- v2: Vector3
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:448

`Static`divideScalar

divideScalar(v1: Vector3, scalar: number, out?: Vector3): Vector3
Parameters
- v1: Vector3
- scalar: number
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:461

`Static`dot

dot(v1: Vector3, v2: Vector3): number
Parameters
- v1: Vector3
- v2: Vector3
Returns number
- Defined in src/math/core/vectors/float/vector3.js:493

`Static`equal

equal(v1: Vector3, v2: Vector3): boolean
Parameters
- v1: Vector3
- v2: Vector3
Returns boolean
- Defined in src/math/core/vectors/float/vector3.js:558

`Static`invert

invert(v: Vector3, out?: Vector3): Vector3
Parameters
- v: Vector3
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:481

`Static`lerp

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

`Static`magnitude

magnitude(v: Vector3): number
Parameters
- v: Vector3
Returns number
- Defined in src/math/core/vectors/float/vector3.js:302

`Static`magnitudeSquared

magnitudeSquared(v: Vector3): number
Parameters
- v: Vector3
Returns number
- Defined in src/math/core/vectors/float/vector3.js:295

`Static`multiply

multiply(v1: Vector3, v2: Vector3, out?: Vector3): Vector3
Parameters
- v1: Vector3
- v2: Vector3
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:422

`Static`multiplyScalar

multiplyScalar(v1: Vector3, scalar: number, out?: Vector3): Vector3
Parameters
- v1: Vector3
- scalar: number
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:435

`Static`normalize

normalize(v: Vector3, out?: Vector3): Vector3
Parameters
- v: Vector3
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:330

`Static`random

random(out: Vector3): Vector3
Parameters
- out: Vector3
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:566

`Static`reflect

reflect(v: Vector3, normal: Vector3, out?: Vector3): Vector3
Parameters
- v: Vector3
- normal: Vector3
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:536

`Static`reverse

reverse(v: Vector3, out?: Vector3): Vector3
Parameters
- v: Vector3
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:469

`Static`set

set(x: number, y: number, z: number, out?: Vector3): Vector3
Parameters
- x: number
- y: number
- z: number
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:260

`Static`setMagnitude

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

`Static`splat

splat(scalar: number, out?: Vector3): Vector3
Parameters
- scalar: number
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:284

`Static`subtract

subtract(from: Vector3, to: Vector3, out?: Vector3): Vector3
Parameters
- from: Vector3
- to: Vector3
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:396

`Static`subtractScalar

subtractScalar(v1: Vector3, scalar: number, out?: Vector3): Vector3
Parameters
- v1: Vector3
- scalar: number
- out: Vector3 = ...
Returns Vector3
- Defined in src/math/core/vectors/float/vector3.js:409