Class Vec3

3D vector with mutable x/y/z components and immutable arithmetic methods.

Index

Constructors

Properties

x y z ZERO ONE UP DOWN FORWARD BACKWARD RIGHT LEFT

Methods

set setArray scaleInPlace clone negate add sub scale mul dot cross lengthSq length normalize lerp toArray zero one up down forward backward right left fromArray

Constructors

constructor

new Vec3(x?: number, y?: number, z?: number): Vec3
Parameters
- x: number = 0
- y: number = 0
- z: number = 0
Returns Vec3
- Defined in src/math/vec3.ts:10

Properties

x

x: number

y

y: number

z

z: number

`Static` `Readonly`ZERO

ZERO: Vec3 = ...

`Static` `Readonly`ONE

ONE: Vec3 = ...

`Static` `Readonly`UP

UP: Vec3 = ...

`Static` `Readonly`DOWN

DOWN: Vec3 = ...

`Static` `Readonly`FORWARD

FORWARD: Vec3 = ...

`Static` `Readonly`BACKWARD

BACKWARD: Vec3 = ...

`Static` `Readonly`RIGHT

RIGHT: Vec3 = ...

`Static` `Readonly`LEFT

LEFT: Vec3 = ...

Methods

set

set(x: number, y: number, z: number): this
Sets x, y, z in place and returns this.
Parameters
- x: number
- y: number
- z: number
Returns this
- Defined in src/math/vec3.ts:17

setArray

setArray(a: ArrayLike<number>, offset?: number): this
Parameters
- a: ArrayLike<number>
- offset: number = 0
Returns this
- Defined in src/math/vec3.ts:24

scaleInPlace

scaleInPlace(s: number): this
Scales this vector in place by s.
Parameters
- s: number
Returns this
- Defined in src/math/vec3.ts:33

clone

clone(): Vec3
Returns a copy of this vector.

Returns Vec3
- Defined in src/math/vec3.ts:41

negate

negate(): Vec3
Returns the componentwise negation.

Returns Vec3
- Defined in src/math/vec3.ts:43

add

add(v: Vec3): Vec3
Returns this + v componentwise.
Parameters
- v: Vec3
Returns Vec3
- Defined in src/math/vec3.ts:46

sub

sub(v: Vec3): Vec3
Returns this - v componentwise.
Parameters
- v: Vec3
Returns Vec3
- Defined in src/math/vec3.ts:48

scale

scale(s: number): Vec3
Returns this scaled by s.
Parameters
- s: number
Returns Vec3
- Defined in src/math/vec3.ts:50

mul

mul(v: Vec3): Vec3
Returns the componentwise (Hadamard) product of this and v.
Parameters
- v: Vec3
Returns Vec3
- Defined in src/math/vec3.ts:52

dot

dot(v: Vec3): number
Returns the dot product of this and v.
Parameters
- v: Vec3
Returns number
- Defined in src/math/vec3.ts:55

cross

cross(v: Vec3): Vec3
Returns the right-handed cross product this x v.
Parameters
- v: Vec3
Returns Vec3
- Defined in src/math/vec3.ts:58

lengthSq

lengthSq(): number
Returns the squared length.

Returns number
- Defined in src/math/vec3.ts:67

length

length(): number
Returns the Euclidean length.

Returns number
- Defined in src/math/vec3.ts:69

normalize

normalize(): Vec3
Returns a unit-length copy, or the zero vector if length is 0.

Returns Vec3
- Defined in src/math/vec3.ts:72

lerp

lerp(v: Vec3, t: number): Vec3
Returns the linear interpolation from this to v at parameter t.
Parameters
- v: Vec3
- t: number
Returns Vec3
- Defined in src/math/vec3.ts:78

toArray

toArray(): [number, number, number]
Returns [x, y, z].

Returns [number, number, number]
- Defined in src/math/vec3.ts:87

`Static`zero

zero(): Vec3
Returns (0, 0, 0).

Returns Vec3
- Defined in src/math/vec3.ts:90

`Static`one

one(): Vec3
Returns (1, 1, 1).

Returns Vec3
- Defined in src/math/vec3.ts:94

`Static`up

up(): Vec3
Returns the world up direction (0, 1, 0).

Returns Vec3
- Defined in src/math/vec3.ts:98

`Static`down

down(): Vec3
Returns the world down direction (0, -1, 0).

Returns Vec3
- Defined in src/math/vec3.ts:102

`Static`forward

forward(): Vec3
Returns the world forward direction (0, 0, -1) for a right-handed -Z-forward coordinate system.

Returns Vec3
- Defined in src/math/vec3.ts:106

`Static`backward

backward(): Vec3
Returns the world backward direction (0, 0, 1) for a right-handed -Z-forward coordinate system.

Returns Vec3
- Defined in src/math/vec3.ts:110

`Static`right

right(): Vec3
Returns the world right direction (1, 0, 0).

Returns Vec3
- Defined in src/math/vec3.ts:114

`Static`left

left(): Vec3
Returns the world left direction (-1, 0, 0).

Returns Vec3
- Defined in src/math/vec3.ts:118

`Static`fromArray

fromArray(a: ArrayLike<number>, offset?: number): Vec3
Reads three consecutive components from a numeric array starting at offset.
Parameters
- a: ArrayLike<number>
- offset: number = 0
Returns Vec3
- Defined in src/math/vec3.ts:122