Class vec3

constructor

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

• Parameters

  • x: number

  • y: number

  • z: number

  Returns vec3

  Description

  Creates a new instance of a vec3.

b

g

length

lengthSquared

r

x

y

z

add

• add(vec): vec3

• Parameters

  • vec: vec3

  Returns vec3

  Description

  Returns the vector plus vec.

angleTo

• angleTo(vec): number

• Parameters

  • vec: vec3

  Returns number

  Description

  Returns the angle in radians between the vector and vec.

clampLength

• clampLength(length): vec3

• Parameters

  • length: number

  Returns vec3

  Description

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

cross

• cross(vec): vec3

• Parameters

  • vec: vec3

  Returns vec3

  Description

  Returns the cross product of the vector and vec

distance

• distance(vec): number

• Parameters

  • vec: vec3

  Returns number

  Description

  Returns the distance between the vector and the vector vec.

distanceSquared

• distanceSquared(vec): number

• Parameters

  • vec: vec3

  Returns number

  Description

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

div

• div(vec): vec3

• Parameters

  • vec: vec3

  Returns vec3

  Description

  Returns the division of the vector by the vector vec.

dot

• dot(vec): number

• Parameters

  • vec: vec3

  Returns number

  Description

  Returns the dot product of the vector and vec.

equal

• equal(vec): boolean

• Parameters

  • vec: vec3

  Returns boolean

  Description

  Returns whether this is equal to vec.

moveTowards

• moveTowards(point, magnitude): vec3

• Parameters

  • point: vec3

  • magnitude: number

  Returns vec3

  Description

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

mult

• mult(vec): vec3

• Parameters

  • vec: vec3

  Returns vec3

  Description

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

normalize

• normalize(): vec3

• Returns vec3

  Description

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

project

• project(vec): vec3

• Parameters

  • vec: vec3

  Returns vec3

  Description

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

projectOnPlane

• projectOnPlane(normal): vec3

• Parameters

  • normal: vec3

  Returns vec3

  Description

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

reflect

• reflect(vec): vec3

• Parameters

  • vec: vec3

  Returns vec3

  Description

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

rotateTowards

• rotateTowards(target, step): vec3

• Parameters

  • target: vec3

  • step: number

  Returns vec3

  Description

  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.

scale

• scale(vec): vec3

• Parameters

  • vec: vec3

  Returns vec3

  Description

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

sub

• sub(vec): vec3

• Parameters

  • vec: vec3

  Returns vec3

  Description

  Returns the vector minus vec.

toString

• toString(): string

• Returns string

  Description

  Returns a string representation of the vector.

uniformScale

• uniformScale(scale): vec3

• Parameters

  • scale: number

  Returns vec3

  Description

  Multiplies the components by the number scale.