Class Vector3

constructor

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

• Constructs a new Vector3.

  Parameters

  • x: number = 0

    The X component.
  • y: number = 0

    The Y component.
  • z: number = 0

    The Z component.

  Returns Vector3

x

y

z

add

• add(vector: Readonly<Vector3>): this

• Adds another vector to this vector.

  Parameters

  • vector: Readonly<Vector3>

    The vector to add to this vector.

  Returns this

  This instance.

addMultiply

• addMultiply(vector: Readonly<Vector3>, scale: number): this

• Scales another vector and adds it to this vector.

  Parameters

  • vector: Readonly<Vector3>

    The vector to add to this vector.
  • scale: number

    The scaling to apply to the input vector.

  Returns this

  This instance.

addMultiplyXYZ

• addMultiplyXYZ(x: number, y: number, z: number, scale: number): this

• Scales another vector and adds it to this vector.

  Parameters

  • x: number

    The value to add to the X component.
  • y: number

    The value to add to the Y component.
  • z: number

    The value to add to the Z component.
  • scale: number

    The scaling to apply to the input vector.

  Returns this

  This instance.

addXYZ

• addXYZ(x: number, y: number, z: number): this

• Adds another vector to this vector.

  Parameters

  • x: number

    The value to add to the X component.
  • y: number

    The value to add to the Y component.
  • z: number

    The value to add to the Z component.

  Returns this

  This instance.

asArray

• asArray(): [number, number, number]

• Return the components of this vector as an array.

  Returns [number, number, number]

  The components of this vector as an array.

clamp

• clamp(floor: number, ceil: number): this

• Clamps the components of the vector at the given boundary.

  Parameters

  • floor: number

    The lowest value to allow.
  • ceil: number

    The largest value to allow.

  Returns this

  This instance.

compare

• compare(vector: Readonly<Vector3>): boolean

• Compares two vectors.

  Parameters

  • vector: Readonly<Vector3>

    The vector to compare this vector to.

  Returns boolean

  true if the vectors are idently, false otherwise.

cross

• cross(vector: Readonly<Vector3>): this

• Calculates the dot product of this vector and another vector, and then sets this vector to the result.

  Parameters

  • vector: Readonly<Vector3>

    The other vector.

  Returns this

  This instance.

divide

• divide(vector: Readonly<Vector3>): this

• Divides this vector by another vector.

  Parameters

  • vector: Readonly<Vector3>

    The vector to divide this vector with.

  Returns this

  This instance.

divideScale

• divideScale(scale: number): this

• Divides the vector by the given scale.

  Parameters

  • scale: number

    The scaling to apply to the vector.

  Returns this

  This instance.

divideXYZ

• divideXYZ(x: number, y: number, z: number): this

• Divides this vector by another vector.

  Parameters

  • x: number

    The value to divide the X component with.
  • y: number

    The value to divide the Y component with.
  • z: number

    The value to divide the Z component with.

  Returns this

  This instance.

dot

• dot(vector: Readonly<Vector3>): number

• Returns the dot product between two vectors.

  Parameters

  • vector: Readonly<Vector3>

    The other vector.

  Returns number

  The dot product between the two vectors.

dotXYZ

• dotXYZ(x: number, y: number, z: number): number

• Returns the dot product between two vectors.

  Parameters

  • x: number

    The X component of the other vector.
  • y: number

    The Y component of the other vector.
  • z: number

    The Z component of the other vector.

  Returns number

  The dot product between the two vectors.

fraction

• fraction(normal: Readonly<Vector3>, index: number): this

• Calculates the reflection of this vector, based on the angle of incident into a material with the given refractive index, according to Snell's law. This vector is then set to the result.

  Parameters

  • normal: Readonly<Vector3>

    The normal against which to reflect.
  • index: number

    The refractive index of the material.

  Returns this

  This instance.

invertAdd

• invertAdd(): this

• Inverts the direction of the vector.

  Returns this

  This instance.

invertMultiply

• invertMultiply(): this

• Inverts the vectors scale.

  Returns this

  This instance.

length

• length(): number

• Calculates the length of the vector.

  Returns number

  The length of the vector.

lerp

• lerp(vector: Readonly<Vector3>, t: number): this

• Linearly moves this vector towards a target vector.

  Parameters

  • vector: Readonly<Vector3>

    The target vector.
  • t: number

    The location on the scale, from 0 to 1.

  Returns this

  This instance.

multiply

• multiply(vector: Readonly<Vector3>): this

• Multiplies this vector by another vector.

  Parameters

  • vector: Readonly<Vector3>

    The vector to multiply with this vector.

  Returns this

  This instance.

multiplyScale

• multiplyScale(scale: number): this

• Multiplies the vector by the given scale.

  Parameters

  • scale: number

    The scaling to apply to the vector.

  Returns this

  This instance.

multiplyXYZ

• multiplyXYZ(x: number, y: number, z: number): this

• Multiplies this vector by another vector.

  Parameters

  • x: number

    The value to multiply with the X component.
  • y: number

    The value to multiply with the Y component.
  • z: number

    The value to multiply with the Z component.

  Returns this

  This instance.

normalize

• normalize(): this

• Normalizes the vector.

  Returns this

  This instance.

perpendicular

• perpendicular(
      vector0: Readonly<Vector3>,
      vector1: Readonly<Vector3>,
      vector2: Readonly<Vector3>,
  ): this

• Makes this vector perpendicular to the other 3 vectors.

  Parameters

  • vector0: Readonly<Vector3>

    The first vector.
  • vector1: Readonly<Vector3>

    The second vector.
  • vector2: Readonly<Vector3>

    The third vector.

  Returns this

  This instance.

reflect

• reflect(normal: Readonly<Vector3>): this

• Reflects this vector against the given normal and sets this vector to the result.

  Parameters

  • normal: Readonly<Vector3>

    The normal against which to reflect.

  Returns this

  This instance.

rotate

• rotate(matrix: Readonly<Matrix3>): this

• Rotates the vector by the given rotation matrix.

  Parameters

  • matrix: Readonly<Matrix3>

    The rotation matrix to apply to the vector.

  Returns this

  This instance.

rotateAround

• rotateAround(center: Readonly<Vector3>, matrix: Readonly<Matrix3>): this

• Rotates the vector by the given rotation matrix around the given center.

  Parameters

  • center: Readonly<Vector3>

    The center around which to rotate the vector.
  • matrix: Readonly<Matrix3>

    The rotation matrix to apply to the vector.

  Returns this

  This instance.

rotateAroundInverse

• rotateAroundInverse(center: Readonly<Vector3>, matrix: Readonly<Matrix3>): this

• Inversely rotates the vector by the given rotation matrix around the given center.

  Parameters

  • center: Readonly<Vector3>

    The center around which to rotate the vector.
  • matrix: Readonly<Matrix3>

    The rotation matrix to apply to the vector.

  Returns this

  This instance.

rotateInverse

• rotateInverse(matrix: Readonly<Matrix3>): this

• Inversely rotates the vector by the given rotation matrix.

  Parameters

  • matrix: Readonly<Matrix3>

    The rotation matrix to apply to the vector.

  Returns this

  This instance.

set

• set(vector: Readonly<Vector3>): this

• Sets the vector to new coordinates.

  Parameters

  • vector: Readonly<Vector3>

    The coordinates to set the vector to.

  Returns this

  This instance.

setXYZ

• setXYZ(x: number, y: number, z: number): this

• Sets the vector to new coordinates.

  Parameters

  • x: number

    The new X component for the vector.
  • y: number

    The new Y component for the vector.
  • z: number

    The new Z component for the vector.

  Returns this

  This instance.

subtract

• subtract(vector: Vector3): this

• Subtracts another vector from this vector.

  Parameters

  • vector: Vector3

    The vector to subtract from this vector.

  Returns this

  This instance.

subtractXYZ

• subtractXYZ(x: number, y: number, z: number): this

• Subtracts another vector from this vector.

  Parameters

  • x: number

    The value to subtract from the X component.
  • y: number

    The value to subtract from the Y component.
  • z: number

    The value to subtract from the Z component.

  Returns this

  This instance.

transform

• transform(transformation: Readonly<Transformation>): this

• Transform the vector with a Transformation.

  Parameters

  • transformation: Readonly<Transformation>

    The transformation to apply.

  Returns this

  This instance.

transformInverse

• transformInverse(transformation: Readonly<Transformation>): this

• Inversely transform the vector with a Transformation.

  Parameters

  • transformation: Readonly<Transformation>

    The transformation to apply.

  Returns this

  This instance.

StaticfromVector3

• fromVector3(vector: Readonly<Vector3>): Vector3

• Creates a copy of another Vector3.

  Parameters

  • vector: Readonly<Vector3>

    The vector to copy.

  Returns Vector3

  A new vector.