Class vec3

constructor

• new vec3(x: number, y: number, z: number): vec3

  Constructs a vec3 with the given x, y, z components.

  Parameters

  • x: number
  • y: number
  • z: number

  Returns vec3

b

g

length

lengthSquared

r

x

y

z

add

• add(vec: vec3): vec3

  Returns a new vec3 that is the sum of this vector and the given vector.

  Parameters

  • vec: vec3

  Returns vec3

addInPlace

• addInPlace(vec: vec3): void

  Adds the given vector to this vector in place.

  Parameters

  • vec: vec3

  Returns void

angleTo

• angleTo(vec: vec3): number

  Returns the angle in radians between this vector and the given vector.

  Parameters

  • vec: vec3

  Returns number

Staticback

• back(): vec3

  Static vec3 pointing in the negative Z direction (0, 0, -1).

  Returns vec3

clampLength

• clampLength(length: number): vec3

  Returns a new vec3 with its length clamped to the given maximum length.

  Parameters

  • length: number

  Returns vec3

clampLengthInPlace

• clampLengthInPlace(length: number): void

  Clamps the length of this vector to the given maximum length in place.

  Parameters

  • length: number

  Returns void

clone

• clone(): vec3

  Returns a new vec3 with the same component values as this vector.

  Returns vec3

copyFrom

• copyFrom(source: vec2 | vec3 | vec4): void

  Copies the component values from the given vector into this vector.

  Parameters

  • source: vec2 | vec3 | vec4

  Returns void

cross

• cross(vec: vec3): vec3

  Returns the cross product of this vector and the given vector.

  Parameters

  • vec: vec3

  Returns vec3

crossInPlace

• crossInPlace(vec: vec3): void

  Computes the cross product of this vector and the given vector, storing the result in this vector.

  Parameters

  • vec: vec3

  Returns void

distance

• distance(vec: vec3): number

  Returns the Euclidean distance between this vector and the given vector.

  Parameters

  • vec: vec3

  Returns number

distanceSquared

• distanceSquared(vec: vec3): number

  Returns the squared Euclidean distance between this vector and the given vector.

  Parameters

  • vec: vec3

  Returns number

div

• div(vec: vec3): vec3

  Returns a new vec3 that is this vector divided component-wise by the given vector.

  Parameters

  • vec: vec3

  Returns vec3

divInPlace

• divInPlace(vec: vec3): void

  Divides this vector component-wise by the given vector in place.

  Parameters

  • vec: vec3

  Returns void

dot

• dot(vec: vec3): number

  Returns the dot product of this vector and the given vector.

  Parameters

  • vec: vec3

  Returns number

Staticdown

• down(): vec3

  Static vec3 pointing in the negative Y direction (0, -1, 0).

  Returns vec3

equal

• equal(vec: vec3): boolean

  Returns true if this vector's components are equal to the given vector's components.

  Parameters

  • vec: vec3

  Returns boolean

fill

• fill(scalar: number): void

  Sets all components of this vector to the given value.

  Parameters

  • scalar: number

  Returns void

Staticforward

• forward(): vec3

  Static vec3 pointing in the positive Z direction (0, 0, 1).

  Returns vec3

Staticleft

• left(): vec3

  Static vec3 pointing in the negative X direction (-1, 0, 0).

  Returns vec3

Staticlerp

• lerp(from: vec3, to: vec3, t: number): vec3

  Returns a new vec3 linearly interpolated between two vectors by factor t.

  Parameters

  • from: vec3
  • to: vec3
  • t: number

  Returns vec3

lerpInPlace

• lerpInPlace(target: vec3, t: number): void

  Linearly interpolates this vector toward the given target vector by factor t, in place.

  Parameters

  • target: vec3
  • t: number

  Returns void

Staticmax

• max(a: vec3, b: vec3): vec3

  Returns a new vec3 with the component-wise maximum of two vectors.

  Parameters

  • a: vec3
  • b: vec3

  Returns vec3

Staticmin

• min(a: vec3, b: vec3): vec3

  Returns a new vec3 with the component-wise minimum of two vectors.

  Parameters

  • a: vec3
  • b: vec3

  Returns vec3

moveTowards

• moveTowards(target: vec3, step: number): vec3

  Returns a new vec3 moved from this vector toward the target by at most maxDelta distance.

  Parameters

  • target: vec3
  • step: number

  Returns vec3

moveTowardsInPlace

• moveTowardsInPlace(point: vec3, magnitude: number): void

  Moves this vector toward the target by at most maxDelta distance, in place.

  Parameters

  • point: vec3
  • magnitude: number

  Returns void

mult

• mult(vec: vec3): vec3

  Returns a new vec3 that is this vector multiplied component-wise by the given vector.

  Parameters

  • vec: vec3

  Returns vec3

multInPlace

• multInPlace(vec: vec3): void

  Multiplies this vector component-wise by the given vector in place.

  Parameters

  • vec: vec3

  Returns void

normalize

• normalize(): vec3

  Returns a new vec3 with the same direction as this vector but with length 1.

  Returns vec3

normalizeInPlace

• normalizeInPlace(): void

  Normalizes this vector to unit length in place.

  Returns void

Staticone

• one(): vec3

  Static vec3 with all components set to 1.

  Returns vec3

Staticorthonormalize

• orthonormalize(a: vec3, b: vec3): void

  Returns an orthonormalized version of the given vector relative to a reference vector.

  Parameters

  • a: vec3
  • b: vec3

  Returns void

project

• project(onto: vec3): vec3

  Returns the projection of this vector onto the given vector.

  Parameters

  • onto: vec3

  Returns vec3

projectInPlace

• projectInPlace(onto: vec3): void

  Projects this vector onto the given vector in place.

  Parameters

  • onto: vec3

  Returns void

projectOnPlane

• projectOnPlane(planeNormal: vec3): vec3

  Returns the projection of this vector onto the plane defined by the given normal.

  Parameters

  • planeNormal: vec3

  Returns vec3

projectOnPlaneInPlace

• projectOnPlaneInPlace(planeNormal: vec3): void

  Projects this vector onto the plane defined by the given normal, in place.

  Parameters

  • planeNormal: vec3

  Returns void

StaticrandomUnitVector

• randomUnitVector(): vec3

  Returns a new vec3 with a random unit direction.

  Returns vec3

reflect

• reflect(planeNormal: vec3): vec3

  Returns the reflection of this vector off a surface with the given normal.

  Parameters

  • planeNormal: vec3

  Returns vec3

reflectInPlace

• reflectInPlace(planeNormal: vec3): void

  Reflects this vector off a surface with the given normal, in place.

  Parameters

  • planeNormal: vec3

  Returns void

Staticright

• right(): vec3

  Static vec3 pointing in the positive X direction (1, 0, 0).

  Returns vec3

rotateTowards

• rotateTowards(target: vec3, step: number): vec3

  Returns a new vec3 rotated from this vector toward the target, by at most maxAngle radians.

  Parameters

  • target: vec3
  • step: number

  Returns vec3

rotateTowardsInPlace

• rotateTowardsInPlace(target: vec3, step: number): void

  Rotates this vector toward the target by at most maxAngle radians, in place.

  Parameters

  • target: vec3
  • step: number

  Returns void

scale

• scale(vec: vec3): vec3

  Returns a new vec3 that is this vector multiplied by the given scalar.

  Parameters

  • vec: vec3

  Returns vec3

scaleInPlace

• scaleInPlace(vec: vec3): void

  Multiplies this vector by the given scalar in place.

  Parameters

  • vec: vec3

  Returns void

setRandomUnitVector

• setRandomUnitVector(): void

  Sets this vector to a random unit vector in place.

  Returns void

setRGB

• setRGB(r?: number, g?: number, b?: number): void

  Sets the r, g, b components of this vector.

  Parameters

  • Optionalr: number
  • Optionalg: number
  • Optionalb: number

  Returns void

setXYZ

• setXYZ(x?: number, y?: number, z?: number): void

  Sets the x, y, z components of this vector.

  Parameters

  • Optionalx: number
  • Optionaly: number
  • Optionalz: number

  Returns void

Staticslerp

• slerp(from: vec3, to: vec3, t: number): vec3

  Returns a new vec3 spherically interpolated between two vectors by factor t.

  Parameters

  • from: vec3
  • to: vec3
  • t: number

  Returns vec3

slerpInPlace

• slerpInPlace(target: vec3, t: number): void

  Spherically interpolates this vector toward the given target vector by factor t, in place.

  Parameters

  • target: vec3
  • t: number

  Returns void

sub

• sub(vec: vec3): vec3

  Returns a new vec3 that is this vector minus the given vector.

  Parameters

  • vec: vec3

  Returns vec3

subInPlace

• subInPlace(vec: vec3): void

  Subtracts the given vector from this vector in place.

  Parameters

  • vec: vec3

  Returns void

toString

• toString(): string

  Returns a string representation of this vector's components.

  Returns string

uniformScale

• uniformScale(scale: number): vec3

  Returns a new vec3 with all components multiplied by the given scalar.

  Parameters

  • scale: number

  Returns vec3

uniformScaleInPlace

• uniformScaleInPlace(scale: number): void

  Multiplies all components of this vector by the given scalar in place.

  Parameters

  • scale: number

  Returns void

Staticup

• up(): vec3

  Static vec3 pointing in the positive Y direction (0, 1, 0).

  Returns vec3

Staticzero

• zero(): vec3

  Static vec3 with all components set to 0.

  Returns vec3