Class Vector3

constructor

• new Vector3(x?: number, y?: number, z?: number): Vector3

  Parameters

  • Optionalx: number

    The x component.

  • Optionaly: number

    The y component.

  • Optionalz: number

    The z component.

  Returns Vector3

x

y

z

Static ReadonlyBACK

Static ReadonlyDOWN

Static ReadonlyFORWARD

Static ReadonlyLEFT

Static ReadonlyONE

Static ReadonlyRIGHT

Static ReadonlyUP

Static ReadonlyZERO

add

• add(v: Vector2 | Vector3): Vector3

  Add a given Vector to this Vector. Addition is component-wise.

  Parameters

  • v: Vector2 | Vector3

    The Vector to add to this Vector.

  Returns Vector3

addScalar

• addScalar(s: number): Vector3

  Add the given value to each component of this Vector.

  Parameters

  • s: number

    The amount to add to this Vector.

  Returns Vector3

addScale

• addScale(v: Vector2 | Vector3, scale: number): Vector3

  Add and scale a given Vector to this Vector. Addition is component-wise.

  Parameters

  • v: Vector2 | Vector3

    The Vector to add to this Vector.

  • scale: number

    The amount to scale v by.

  Returns Vector3

addVectors

• addVectors(a: Vector3, b: Vector3): Vector3

  Adds the two given Vector3s and sets the results into this Vector3.

  Parameters

  • a: Vector3

    The first Vector to add.

  • b: Vector3

    The second Vector to add.

  Returns Vector3

applyMatrix3

• applyMatrix3(mat3: Matrix3): Vector3

  Takes a Matrix3 and applies it to this Vector3.

  Parameters

  • mat3: Matrix3

    The Matrix3 to apply to this Vector3.

  Returns Vector3

applyMatrix4

• applyMatrix4(mat4: Matrix4): Vector3

  Takes a Matrix4 and applies it to this Vector3.

  Parameters

  • mat4: Matrix4

    The Matrix4 to apply to this Vector3.

  Returns Vector3

clone

• clone(): Vector3

  Make a clone of this Vector3.

  Returns Vector3

copy

• copy(src: Vector2 | Vector3): Vector3

  Copy the components of a given Vector into this Vector.

  Parameters

  • src: Vector2 | Vector3

    The Vector to copy the components from.

  Returns Vector3

cross

• cross(v: Vector3): Vector3

  Calculate the cross (vector) product of this Vector (which will be modified) and the given Vector.

  Parameters

  • v: Vector3

    The Vector to cross product with.

  Returns Vector3

crossVectors

• crossVectors(a: Vector3, b: Vector3): Vector3

  Calculate the cross (vector) product of two given Vectors.

  Parameters

  • a: Vector3

    The first Vector to multiply.

  • b: Vector3

    The second Vector to multiply.

  Returns Vector3

distance

• distance(v: Vector2 | Vector3): number

  Calculate the distance between this Vector and the given Vector.

  Parameters

  • v: Vector2 | Vector3

    The Vector to calculate the distance to.

  Returns number

distanceSq

• distanceSq(v: Vector2 | Vector3): number

  Calculate the distance between this Vector and the given Vector, squared.

  Parameters

  • v: Vector2 | Vector3

    The Vector to calculate the distance to.

  Returns number

divide

• divide(v: Vector2 | Vector3): Vector3

  Perform a component-wise division between this Vector and the given Vector.

  Divides this Vector by the given Vector.

  Parameters

  • v: Vector2 | Vector3

    The Vector to divide this Vector by.

  Returns Vector3

dot

• dot(v: Vector3): number

  Calculate the dot product of this Vector and the given Vector.

  Parameters

  • v: Vector3

    The Vector3 to dot product with this Vector3.

  Returns number

equals

• equals(v: Vector3): boolean

  Check whether this Vector is equal to a given Vector.

  Performs a strict equality check against each Vector's components.

  Parameters

  • v: Vector3

    The Vector3 to compare against.

  Returns boolean

fromArray

• fromArray(array: number[], offset?: number): Vector3

  Sets the components of this Vector3 from the given array, based on the offset.

  Vector3.x = array[offset] Vector3.y = array[offset + 1] Vector3.z = array[offset + 2]

  Parameters

  • array: number[]

    The array of values to get this Vector from.

  • Optionaloffset: number

    The offset index into the array. Default 0.

  Returns Vector3

length

• length(): number

  Calculate the length (or magnitude) of this Vector.

  Returns number

lengthSq

• lengthSq(): number

  Calculate the length of this Vector squared.

  Returns number

lerp

• lerp(v: Vector3, t?: number): Vector3

  Linearly interpolate between this Vector and the given Vector.

  Interpolates this Vector towards the given Vector.

  Parameters

  • v: Vector3

    The Vector3 to interpolate towards.

  • Optionalt: number

    The interpolation percentage, between 0 and 1. Default 0.

  Returns Vector3

max

• max(v: Vector3): Vector3

  Sets the components of this Vector to be the Math.max result from the given vector.

  Parameters

  • v: Vector3

    The Vector3 to check the maximum values against.

  Returns Vector3

min

• min(v: Vector3): Vector3

  Sets the components of this Vector to be the Math.min result from the given vector.

  Parameters

  • v: Vector3

    The Vector3 to check the minimum values against.

  Returns Vector3

multiply

• multiply(v: Vector2 | Vector3): Vector3

  Perform a component-wise multiplication between this Vector and the given Vector.

  Multiplies this Vector by the given Vector.

  Parameters

  • v: Vector2 | Vector3

    The Vector to multiply this Vector by.

  Returns Vector3

negate

• negate(): Vector3

  Negate the x, y and z components of this Vector.

  Returns Vector3

normalize

• normalize(): Vector3

  Normalize this Vector.

  Makes the vector a unit length vector (magnitude of 1) in the same direction.

  Returns Vector3

project

• project(mat: Matrix4): Vector3

  Multiplies this Vector3 by the specified matrix, applying a W divide. This is useful for projection, e.g. unprojecting a 2D point into 3D space.

  Parameters

  • mat: Matrix4

    The Matrix4 to multiply this Vector3 with.

  Returns Vector3

projectViewMatrix

• projectViewMatrix(viewMatrix: Matrix4, projectionMatrix: Matrix4): Vector3

  Multiplies this Vector3 by the given view and projection matrices.

  Parameters

  • viewMatrix: Matrix4

    A View Matrix.

  • projectionMatrix: Matrix4

    A Projection Matrix.

  Returns Vector3

reset

• reset(): Vector3

  Make this Vector the zero vector (0, 0, 0).

  Returns Vector3

scale

• scale(scale: number): Vector3

  Scale this Vector by the given value.

  Parameters

  • scale: number

    The value to scale this Vector by.

  Returns Vector3

set

• set(x: number | object, y?: number, z?: number): Vector3

  Set the x, y, and z components of this Vector to the given x, y, and z values.

  Parameters

  • x: number | object

    The x value to set for this Vector, or an object containing x, y and z components.

  • Optionaly: number

    The y value to set for this Vector.

  • Optionalz: number

    The z value to set for this Vector.

  Returns Vector3

setFromMatrixColumn

• setFromMatrixColumn(mat4: Matrix4, index: number): Vector3

  Sets the components of this Vector3 from the Matrix4 column specified.

  Parameters

  • mat4: Matrix4

    The Matrix4 to get the column from.

  • index: number

    The column index.

  Returns Vector3

setFromMatrixPosition

• setFromMatrixPosition(mat4: Matrix4): Vector3

  Sets the components of this Vector3 from the position of the given Matrix4.

  Parameters

  • mat4: Matrix4

    The Matrix4 to get the position from.

  Returns Vector3

subtract

• subtract(v: Vector2 | Vector3): Vector3

  Subtract the given Vector from this Vector. Subtraction is component-wise.

  Parameters

  • v: Vector2 | Vector3

    The Vector to subtract from this Vector.

  Returns Vector3

subVectors

• subVectors(a: Vector3, b: Vector3): Vector3

  Subtracts the two given Vector3s and sets the results into this Vector3.

  Parameters

  • a: Vector3

    The first Vector to sub.

  • b: Vector3

    The second Vector to sub.

  Returns Vector3

transformCoordinates

• transformCoordinates(mat: Matrix4): Vector3

  Transforms the coordinates of this Vector3 with the given Matrix4.

  Parameters

  • mat: Matrix4

    The Matrix4 to transform this Vector3 with.

  Returns Vector3

transformMat3

• transformMat3(mat: Matrix3): Vector3

  Transform this Vector with the given Matrix.

  Parameters

  • mat: Matrix3

    The Matrix3 to transform this Vector3 with.

  Returns Vector3

transformMat4

• transformMat4(mat: Matrix4): Vector3

  Transform this Vector with the given Matrix4.

  Parameters

  • mat: Matrix4

    The Matrix4 to transform this Vector3 with.

  Returns Vector3

transformQuat

• transformQuat(q: Quaternion): Vector3

  Transform this Vector with the given Quaternion.

  Parameters

  • q: Quaternion

    The Quaternion to transform this Vector with.

  Returns Vector3

unproject

• unproject(viewport: Vector4, invProjectionView: Matrix4): Vector3

  Unproject this point from 2D space to 3D space. The point should have its x and y properties set to 2D screen space, and the z either at 0 (near plane) or 1 (far plane). The provided matrix is assumed to already be combined, i.e. projection * view * model.

  After this operation, this vector's (x, y, z) components will represent the unprojected 3D coordinate.

  Parameters

  • viewport: Vector4

    Screen x, y, width and height in pixels.

  • invProjectionView: Matrix4

    Combined projection and view matrix.

  Returns Vector3

unprojectViewMatrix

• unprojectViewMatrix(projectionMatrix: Matrix4, worldMatrix: Matrix4): Vector3

  Multiplies this Vector3 by the given inversed projection matrix and world matrix.

  Parameters

  • projectionMatrix: Matrix4

    An inversed Projection Matrix.

  • worldMatrix: Matrix4

    A World View Matrix.

  Returns Vector3

up

• up(): Vector3

  Set this Vector to point up.

  Sets the y component of the vector to 1, and the others to 0.

  Returns Vector3