Variable vec3UtilsConst

Type declaration

• abs:function

  • abs(v: Point3D): Point3D

  • Get vector as absolute.

    Returns

    { x: Math.abs( v.x ), y: Math.abs( v.y ), z: Math.abs( v.z ) }

    Parameters

    • v: Point3D

      Vector to get absolute value of

    Returns Point3D

• add:function

  • add(v: Point3D, value: number): Point3D

  • Add a single value to all values of a 3-dimensional Vector.

    Returns

    Result as a new 3-dimensional Vector as 3D Point.

    Parameters

    • v: Point3D

      3-dimensional Vector to add to.

    • value: number

      Value to add to all 3-dimensional Vector's values.

    Returns Point3D

• addVec:function

  • addVec(v1: Point3D, ...v2: Point3D[]): Point3D

  • Add two or more 3-dimensional Vectors together.

    Returns

    New 3-dimensional Vector as 3D Point.

    Parameters

    • v1: Point3D

      First 3-dimensional Vector to add to.

    • Rest ...v2: Point3D[]

      One or multiple 3-dimensional Vectors to add.

    Returns Point3D

• angle:function

  • angle(v1: Point3D, v2: Point3D): number

  • Returns

    Radian angle between v1 and v2.

    Parameters

    • v1: Point3D

    • v2: Point3D

    Returns number

• cross:function

  • cross(v1: Point3D, v2: Point3D): Point3D

  • Get the cross product of two 3-dimensional Vectors.

    Parameters

    • v1: Point3D

      Vector to compare towards

    • v2: Point3D

      Vector to compare with

    Returns Point3D

• divide:function

  • divide(v: Point3D, divisor: number): Point3D

  • Divide values of a 3-dimensional Vector by a single value.

    Returns

    Result as a new 3-dimensional Vector as 3D Point.

    Parameters

    • v: Point3D

      3-dimensional Vector to divide.

    • divisor: number

      Number to divide the 3-dimensional Vectors values with.

    Returns Point3D

• divideVec:function

  • divideVec(v1: Point3D, ...v2: Point3D[]): Point3D

  • Divide one 3-dimensional Vector with one or more 3-dimensional Vectors in the order they were provided.

    Returns

    Result as a new 3-dimensional Vector as 3D Point.

    Parameters

    • v1: Point3D

      3-dimensional Vector to divide.

    • Rest ...v2: Point3D[]

      One or multiple 3-dimensional Vector to divide with.

    Returns Point3D

• dot:function

  • dot(v1: Point3D, v2: Point3D): number

  • Get the dot product of two 3-dimensional Vectors.

    Parameters

    • v1: Point3D

      3-dimensional Vector.

    • v2: Point3D

      3-dimensional Vector.

    Returns number

• equals:function

  • equals(a: Point3D, b: Point3D): boolean

  • Check two vectors are equal.

    Parameters

    • a: Point3D

      Vector a

    • b: Point3D

      Vector b

    Returns boolean

• length:function

  • length(v: Point3D): number

  • Get the length of a 3-dimensional Vector.

    Returns

    Length of a 3-dimensional Vector.

    Parameters

    • v: Point3D

      3-dimensional Vector.

    Returns number

• lerp:function

  • lerp(a: Point3D, b: Point3D, amount: number): Point3D

  • Linear interpolation between two vectors and an arbitrary amount as %. amount = 0 -> returns a amount = 1 -> returns b

    Parameters

    • a: Point3D

      Vector a for interpolation

    • b: Point3D

      Vector b for interpolation

    • amount: number

      Interpolation amount

    Returns Point3D

• multiply:function

  • multiply(v: Point3D, multiplier: number): Point3D

  • Multiply values of a 3-dimensional Vector by a single value.

    Returns

    Result as a new 3-dimensional Vector as 3D Point.

    Parameters

    • v: Point3D

      3-dimensional Vector to multiply.

    • multiplier: number

      Number to multiply the 3-dimensional Vectors values with.

    Returns Point3D

• multiplyVec:function

  • multiplyVec(v1: Point3D, ...v2: Point3D[]): Point3D

  • Multiply one 3-dimensional Vector with one or more 3-dimensional Vectors in the order they were provided.

    Returns

    Result as a new 3-dimensional Vector as 3D Point.

    Parameters

    • v1: Point3D

      3-dimensional Vector.

    • Rest ...v2: Point3D[]

      One or multiple 3-dimensional Vectors to multiply with.

    Returns Point3D

• normalize:function

  • normalize(v: Point3D): Point3D

  • Get the normal of a 3-dimensional Vector.

    Returns

    Normal as a 3-dimensional Vector.

    Parameters

    • v: Point3D

      3-dimensional Vector.

    Returns Point3D

• rotateAroundAxis:function

  • rotateAroundAxis(v: Point3D, axis: Point3D, theta: number): Point3D

  • Rotate vector around another arbitrary axis, by amount 'theta' in radians.

    Parameters

    • v: Point3D

      Vector to rotate

    • axis: Point3D

      Vector of arbitrary rotation axis

    • theta: number

      Rotation amount in radians

    Returns Point3D

• sign:function

  • sign(v: Point3D): Point3D

  • Sign of Vector.

    Returns

    { x: Math.sign( v.x ), y: Math.sign( v.y ), z: Math.sign( v.z ) }

    Parameters

    • v: Point3D

      Vector.

    Returns Point3D

• subtract:function

  • subtract(v: Point3D, value: number): Point3D

  • Subtract a single value from all values of a 3-dimensional Vector.

    Returns

    Result as a new 3-dimensional Vector as 3D Point.

    Parameters

    • v: Point3D

      3-dimensional Vector to subtract from.

    • value: number

      Value to subtract from all 3-dimensional Vector's values.

    Returns Point3D

• subtractVec:function

  • subtractVec(v1: Point3D, ...v2: Point3D[]): Point3D

  • Subtract one or more 3-dimensional Vector from another.

    Returns

    Result as a new 3-dimensional Vector as 3D Point.

    Parameters

    • v1: Point3D

      3-dimensional Vector to subtract from.

    • Rest ...v2: Point3D[]

      One or multiple 3-dimensional Vectors to subtract.

    Returns Point3D