Class vec3

constructor

• new vec3(x, y, z): 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

• Returns the vector plus vec.

  Parameters

  • vec: vec3

  Returns vec3

angleTo

• angleTo(vec): number

• Returns the angle in radians between the vector and vec.

  Parameters

  • vec: vec3

  Returns number

clampLength

• clampLength(length): vec3

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

  Parameters

  • length: number

  Returns vec3

cross

• cross(vec): vec3

• Returns the cross product of the vector and vec

  Parameters

  • vec: vec3

  Returns vec3

distance

• distance(vec): number

• Returns the distance between the vector and the vector vec.

  Parameters

  • vec: vec3

  Returns number

distanceSquared

• distanceSquared(vec): number

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

  Parameters

  • vec: vec3

  Returns number

div

• div(vec): vec3

• Returns the division of the vector by the vector vec.

  Parameters

  • vec: vec3

  Returns vec3

dot

• dot(vec): number

• Returns the dot product of the vector and vec.

  Parameters

  • vec: vec3

  Returns number

equal

• equal(vec): boolean

• Returns whether this is equal to vec.

  Parameters

  • vec: vec3

  Returns boolean

moveTowards

• moveTowards(point, magnitude): 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

• 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

project

• project(vec): vec3

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

  Parameters

  • vec: vec3

  Returns vec3

projectOnPlane

• projectOnPlane(normal): vec3

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

  Parameters

  • normal: vec3

  Returns vec3

reflect

• reflect(vec): vec3

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

  Parameters

  • vec: vec3

  Returns vec3

rotateTowards

• rotateTowards(target, step): 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

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

  Parameters

  • vec: vec3

  Returns vec3

sub

• sub(vec): 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): vec3

• Multiplies the components by the number scale.

  Parameters

  • scale: number

  Returns vec3