Class Vec3

constructor

• new Vec3(x, y?, z?): Vec3

• Parameters

  • x: number | number[] | Vector3 | Direction | Vec3

  • Optional y: number

  • Optional z: number

  Returns Vec3

x

y

z

add

• add(v): Vec3

• Adds another vector to the current vector.

  Parameters

  • v: Vector3

    The vector to be added.

  Returns Vec3

  The updated vector after addition.

angleBetween

• angleBetween(v): number

• Computes the angle (in radians) between the current vector and another vector.

  Parameters

  • v: Vector3

    The other vector.

  Returns number

  The angle in radians between the two vectors. To convert to degrees, use: angleInDegrees = angleInRadians * (180 / Math.PI).

copy

• copy(): Vec3

• Creates a copy of the current vector.

  Returns Vec3

  A new vector with the same values as the current vector.

cross

• cross(v): Vec3

• Computes the cross product of the current vector with another vector.

  A cross product is a vector that is perpendicular to both vectors.

  Parameters

  • v: Vector3

    The other vector.

  Returns Vec3

  A new vector representing the cross product.

distance

• distance(v): number

• Computes the distance between the current vector and another vector.

  Parameters

  • v: Vector3

    The other vector.

  Returns number

  The distance between the two vectors.

distanceSquared

• distanceSquared(v): number

• Computes the squared distance between the current vector and another vector. This is faster than computing the actual distance and can be useful for comparison purposes.

  Parameters

  • v: Vector3

    The other vector.

  Returns number

  The squared distance between the two vectors.

distanceToLineSegment

• distanceToLineSegment(start, end): number

• Calculates the shortest distance between a point (represented by this Vector3 instance) and a line segment.

  This method finds the perpendicular projection of the point onto the line defined by the segment. If this projection lies outside the line segment, then the method calculates the distance from the point to the nearest segment endpoint.

  Parameters

  • start: Vector3

    The starting point of the line segment.

  • end: Vector3

    The ending point of the line segment.

  Returns number

  The shortest distance between the point and the line segment.

divide

• divide(v): Vec3

• Divides the current vector by another vector or scalar.

  Parameters

  • v: number | Vector3

    The vector or scalar to divide by.

  Returns Vec3

  The updated vector after division.

dot

• dot(v): number

• Computes the dot product of the current vector with another vector.

  Parameters

  • v: Vector3

    The other vector.

  Returns number

  The dot product of the two vectors.

equals

• equals(other): boolean

• Parameters

  • other: Vector3

  Returns boolean

length

• length(): number

• Computes the length (magnitude) of the vector.

  Returns number

  The length of the vector.

lengthSquared

• lengthSquared(): number

• Computes the squared length of the vector. This is faster than computing the actual length and can be useful for comparison purposes.

  Returns number

  The squared length of the vector.

lerp

• lerp(v, t): Vec3

• Computes the linear interpolation between the current vector and another vector.

  Parameters

  • v: Vector3

    The other vector.

  • t: number

    The interpolation factor (0 <= t <= 1).

  Returns Vec3

  A new vector after performing the lerp operation.

multiply

• multiply(v): Vec3

• Multiplies the current vector by another vector or scalar.

  Parameters

  • v: number | Vector3

    The vector or scalar to multiply with.

  Returns Vec3

  The updated vector after multiplication.

normalize

• normalize(): Vec3

• Normalizes the vector to have a length (magnitude) of 1. Normalized vectors are often used as a direction vectors.

  Returns Vec3

  The normalized vector.

projectOnto

• projectOnto(v): Vec3

• Computes the projection of the current vector onto another vector. This method finds how much of the current vector lies in the direction of vector v.

  Parameters

  • v: Vector3

    The vector onto which the current vector will be projected.

  Returns Vec3

  A new vector representing the projection of the current vector onto v.

reflect

• reflect(normal): Vec3

• Computes the reflection of the current vector against a normal vector. Useful for simulating light reflections or bouncing objects.

  Parameters

  • normal: Vector3

    The normal vector against which the current vector will be reflected.

  Returns Vec3

  A new vector representing the reflection of the current vector.

setX

• setX(x): Vec3

• Sets the X component of the vector.

  Parameters

  • x: number

  Returns Vec3

  The updated vector with the new X value.

setY

• setY(y): Vec3

• Sets the Y component of the vector.

  Parameters

  • y: number

  Returns Vec3

  The updated vector with the new Y value.

setZ

• setZ(z): Vec3

• Sets the Z component of the vector.

  Parameters

  • z: number

  Returns Vec3

  The updated vector with the new Z value.

slerp

• slerp(v, t): Vec3

• Computes the spherical linear interpolation between the current vector and another vector.

  Parameters

  • v: Vector3

    The other vector.

  • t: number

    The interpolation factor (0 <= t <= 1).

  Returns Vec3

  A new vector after performing the slerp operation.

subtract

• subtract(v): Vec3

• Subtracts another vector from the current vector.

  Parameters

  • v: Vector3

    The vector to be subtracted.

  Returns Vec3

  The updated vector after subtraction.

toVector

• toVector(): any

• Returns any

Static from

• from(x, y?, z?): Vec3

• Creates a new vector from the given values.

  Parameters

  • x: number | number[] | Vector3 | Direction | Vec3

  • Optional y: number

  • Optional z: number

  Returns Vec3

Static fromYawPitch

• fromYawPitch(yaw, pitch): Vec3

• Creates a new direction vector from yaw and pitch values.

  Parameters

  • yaw: number

    The yaw value in degrees.

  • pitch: number

    The pitch value in degrees.

  Returns Vec3

  A new vector representing the direction.