Class vec3

constructor

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

  Creates a new instance of a vec3.

  Parameters

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

  Returns vec3

b

g

length

lengthSquared

r

x

y

z

add

• add(vec: vec3): vec3

  Returns the vector plus vec.

  Parameters

  • vec: vec3

  Returns vec3

angleTo

• angleTo(vec: vec3): number

  Returns the angle in radians between the vector and vec.

  Parameters

  • vec: vec3

  Returns number

Staticback

• back(): vec3

  Returns the vector (0, 0, -1).

  Returns vec3

clampLength

• clampLength(length: number): vec3

  Returns a copy of the vector with its length clamped to length.

  Parameters

  • length: number

  Returns vec3

cross

• cross(vec: vec3): vec3

  Returns the cross product of the vector and vec

  Parameters

  • vec: vec3

  Returns vec3

distance

• distance(vec: vec3): number

  Returns the distance between the vector and the vector vec.

  Parameters

  • vec: vec3

  Returns number

distanceSquared

• distanceSquared(vec: vec3): number

  Like distance(), but returns the squared distance between vectors.

  Parameters

  • vec: vec3

  Returns number

div

• div(vec: vec3): vec3

  Returns the division of the vector by the vector vec.

  Parameters

  • vec: vec3

  Returns vec3

dot

• dot(vec: vec3): number

  Returns the dot product of the vector and vec.

  Parameters

  • vec: vec3

  Returns number

Staticdown

• down(): vec3

  Returns the vector (0, -1, 0).

  Returns vec3

equal

• equal(vec: vec3): boolean

  Returns whether this is equal to vec.

  Parameters

  • vec: vec3

  Returns boolean

Staticforward

• forward(): vec3

  Returns the vector (0, 0, 1).

  Returns vec3

Staticleft

• left(): vec3

  Returns the vector (-1, 0, 0).

  Returns vec3

Staticlerp

• lerp(vecA: vec3, vecB: vec3, t: number): vec3

  Linearly interpolates between the two vectors vecA and vecB by the factor t.

  Parameters

  • vecA: vec3
  • vecB: vec3
  • t: number

  Returns vec3

Staticmax

• max(vecA: vec3, vecB: vec3): vec3

  Returns a new vector containing the largest value of each component in the two vectors.

  Parameters

  • vecA: vec3
  • vecB: vec3

  Returns vec3

Staticmin

• min(vecA: vec3, vecB: vec3): vec3

  Returns a new vector containing the smallest value of each component in the two vectors.

  Parameters

  • vecA: vec3
  • vecB: vec3

  Returns vec3

moveTowards

• moveTowards(point: vec3, magnitude: number): vec3

  Returns a copy of the vector moved towards the point point by the amount magnitude.

  Parameters

  • point: vec3
  • magnitude: number

  Returns vec3

mult

• mult(vec: vec3): vec3

  Returns the component-wise multiplication product of the vector and vec.

  Parameters

  • vec: vec3

  Returns vec3

normalize

• normalize(): vec3

  Returns a copy of the vector with its length scaled to 1.

  Returns vec3

Staticone

• one(): vec3

  Returns the vector (1, 1, 1).

  Returns vec3

Staticorthonormalize

• orthonormalize(vecA: vec3, vecB: vec3): void

  Makes the vectors vecA and vecB normalized and orthogonal to each other.

  Parameters

  • vecA: vec3
  • vecB: vec3

  Returns void

project

• project(vec: vec3): vec3

  Returns a copy of the vector projected onto the vector vec.

  Parameters

  • vec: vec3

  Returns vec3

projectOnPlane

• projectOnPlane(normal: vec3): vec3

  Projects the vector onto the plane represented by the normal normal.

  Parameters

  • normal: vec3

  Returns vec3

StaticrandomDirection

• randomDirection(): vec3

  Generate random 3D direction vector. This is equivalent to a random point on a unit-radius sphere.

  Returns vec3

reflect

• reflect(vec: vec3): vec3

  Returns a copy of the vector reflected across the plane defined by the normal vec.

  Parameters

  • vec: vec3

  Returns vec3

Staticright

• right(): vec3

  Returns the vector (1, 0, 0).

  Returns vec3

rotateTowards

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

  Returns a copy of the vector rotated towards the target vector by step radians.

  The vectors may be non-normalized. The function always returns a vector with the source vector's magnitude. This prevents overshoot. If step exceeds the angle between vectors, it stops at the target direction. If step is negative, this rotates the source vector away from target. It stops when the direction is precisely opposite to target. If the vectors are in opposite directions, the result is rotated along an arbitrary (but consistent) axis. If either vector is zero magnitude, it returns the source vector.

  Parameters

  • target: vec3
  • step: number

  Returns vec3

scale

• scale(vec: vec3): vec3

  Returns the component-wise multiplication product of the vector and vec.

  Parameters

  • vec: vec3

  Returns vec3

Staticslerp

• slerp(vecA: vec3, vecB: vec3, t: number): vec3

  Spherically interpolates between the two vectors vecA and vecB by the factor t.

  Parameters

  • vecA: vec3
  • vecB: vec3
  • t: number

  Returns vec3

sub

• sub(vec: vec3): vec3

  Returns the vector minus vec.

  Parameters

  • vec: vec3

  Returns vec3

toString

• toString(): string

  Returns a string representation of the vector.

  Returns string

uniformScale

• uniformScale(scale: number): vec3

  Multiplies the components by the number scale.

  Parameters

  • scale: number

  Returns vec3

Staticup

• up(): vec3

  Returns the vector (0, 1, 0).

  Returns vec3

Staticzero

• zero(): vec3

  Returns the vector (0, 0, 0).

  Returns vec3