wtc-math
    Preparing search index...

    Class Quat

    A basic 3D Vector class that provides simple algebraic functionality in the form of 3D Vectors.

    We use Getters/setters for both principle properties (x & y) as well as virtual properties (rotation, length etc.).

    Vec4

    Liam Egan liam@wethecollective.com

    1.0.0

    Jan 07, 2020

    Hierarchy (View Summary)

    Implements

    • V4Q
    Index

    Constructors

    constructor

    Accessors

    area array depth height length lengthSquared normalW w width ww wx wxyz wy wz x xw xx xy xyz xyzw xz y yw yx yy yz yzwx yzx z zw zwxy zx zxy zy zz

    Methods

    [iterator] add addNew addScalar addScalarNew ceil ceilNew clone conjugate conjugateNew cross crossNew distance distanceW distanceX distanceY distanceZ divide divideNew divideScalar divideScalarNew dot floor floorNew fract fractNew inverse inverseNew invert invertNew multiply multiplyNew multiplyScalar multiplyScalarNew negate negateNew normalise normaliseNew reset resetToQuat resetToVector rotateX rotateXNew rotateY rotateYNew rotateZ rotateZNew round roundNew scale scaleNew subtract subtractNew subtractScalar subtractScalarNew toString transformByMat4 transformByMat4New transformByQuat transformByQuatNew fromAxisAngle fromEuler getAngle identity interpolate lerp slerp

    Constructors

    Accessors

    • get area(): number

      (getter) Vector area.

      Returns number

    • get array(): number[]

      (getter) Returns the basic array representation of this vector.

      Returns number[]

    • get depth(): number

      Returns number

    • set depth(h: number): void

      (getter/setter) Vector depth. Alias of z

      Parameters

      • h: number

      Returns void

    • get height(): number

      Returns number

    • set height(h: number): void

      (getter/setter) Vector height. Alias of y

      Parameters

      • h: number

      Returns void

    • get length(): number

      Returns number

    • set length(length: number): void

      (getter/setter) The length of the vector

      Parameters

      • length: number

      Returns void

      0
    • get lengthSquared(): number

      Returns number

    • set lengthSquared(length: number): void

      (getter/setter) The length of the vector presented as a square. If you're using length for comparison, this is quicker.

      Parameters

      • length: number

      Returns void

      0
    • get normalW(): number

      Getters and setters

      Returns number

    • get w(): number

      Returns number

    • set w(w: number): void

      Parameters

      • w: number

      Returns void

    • get width(): number

      Returns number

    • set width(w: number): void

      (getter/setter) Vector width. Alias of x

      Parameters

      • w: number

      Returns void

    • get ww(): Vec2

      (getter/sette) Swizzle WW

      Returns Vec2

    • set ww(v: Vec2Like): void

      Parameters

      Returns void

    • get wx(): Vec2

      (getter/sette) Swizzle wx

      Returns Vec2

    • set wx(v: Vec2Like): void

      Parameters

      Returns void

    • get wxyz(): Vec4

      (getter/sette) Swizzle WXYZ

      Returns Vec4

    • set wxyz(v: Vec4Like): void

      Parameters

      Returns void

    • get wy(): Vec2

      (getter/sette) Swizzle WY

      Returns Vec2

    • set wy(v: Vec2Like): void

      Parameters

      Returns void

    • get wz(): Vec2

      (getter/sette) Swizzle WZ

      Returns Vec2

    • set wz(v: Vec2Like): void

      Parameters

      Returns void

    • get x(): number

      Returns number

    • set x(x: number): void

      Parameters

      • x: number

      Returns void

    • get xw(): Vec2

      (getter/sette) Swizzle XY

      Returns Vec2

    • set xw(v: Vec2Like): void

      Parameters

      Returns void

    • get xx(): Vec2

      (getter/sette) Swizzle XX

      Returns Vec2

    • set xx(v: Vec2Like): void

      Parameters

      Returns void

    • get xy(): Vec2

      (getter/sette) Swizzle XY

      Returns Vec2

    • set xy(v: Vec2Like): void

      Parameters

      Returns void

    • get xyz(): Vec3

      (getter/sette) Swizzle YZX

      Returns Vec3

    • set xyz(v: Vec3Like): void

      Parameters

      Returns void

    • get xyzw(): Vec4

      (getter/sette) Swizzle XYZW

      Returns Vec4

    • set xyzw(v: Vec4Like): void

      Parameters

      Returns void

    • get xz(): Vec2

      (getter/sette) Swizzle XY

      Returns Vec2

    • set xz(v: Vec2Like): void

      Parameters

      Returns void

    • get y(): number

      Returns number

    • set y(y: number): void

      Parameters

      • y: number

      Returns void

    • get yw(): Vec2

      (getter/sette) Swizzle YZ

      Returns Vec2

    • set yw(v: Vec2Like): void

      Parameters

      Returns void

    • get yx(): Vec2

      (getter/sette) Swizzle YX

      Returns Vec2

    • set yx(v: Vec2Like): void

      Parameters

      Returns void

    • get yy(): Vec2

      (getter/sette) Swizzle YY

      Returns Vec2

    • set yy(v: Vec2Like): void

      Parameters

      Returns void

    • get yz(): Vec2

      (getter/sette) Swizzle YZ

      Returns Vec2

    • set yz(v: Vec2Like): void

      Parameters

      Returns void

    • get yzwx(): Vec4

      (getter/sette) Swizzle YZWX

      Returns Vec4

    • set yzwx(v: Vec4Like): void

      Parameters

      Returns void

    • get yzx(): Vec3

      (getter/sette) Swizzle YZX

      Returns Vec3

    • set yzx(v: Vec3Like): void

      Parameters

      Returns void

    • get z(): number

      Returns number

    • set z(z: number): void

      Parameters

      • z: number

      Returns void

    • get zw(): Vec2

      (getter/sette) Swizzle XY

      Returns Vec2

    • set zw(v: Vec2Like): void

      Parameters

      Returns void

    • get zwxy(): Vec4

      (getter/sette) Swizzle ZWXY

      Returns Vec4

    • set zwxy(v: Vec4Like): void

      Parameters

      Returns void

    • get zx(): Vec2

      (getter/sette) Swizzle zx

      Returns Vec2

    • set zx(v: Vec2Like): void

      Parameters

      Returns void

    • get zxy(): Vec3

      (getter/sette) Swizzle ZXY

      Returns Vec3

    • set zxy(v: Vec3Like): void

      Parameters

      Returns void

    • get zy(): Vec2

      (getter/sette) Swizzle ZY

      Returns Vec2

    • set zy(v: Vec2Like): void

      Parameters

      Returns void

    • get zz(): Vec2

      (getter/sette) Swizzle ZZ

      Returns Vec2

    • set zz(v: Vec2Like): void

      Parameters

      Returns void

    Methods

    • Adds iteration to the object, allowing it to be destructured and iterated upon in various useful ways.

      Returns {
          next(): | { done: boolean; value: number }
          | { done: boolean; value?: undefined };
      }

    • Chainable

      Adds one vector to another.

      Parameters

      • vector: V4Q

        The vector to add to this one

      Returns V4Q

      Returns itself, modified

    • Chainable

      Clones the vector and adds the vector to it instead

      Parameters

      • vector: V4Q

        The vector to add to this one

      Returns V4Q

      Returns the clone of itself, modified

    • Chainable

      Adds a scalar to the vector, modifying both the x and y

      Parameters

      • scalar: number

        The scalar to add to the vector

      Returns V4Q

      Returns itself, modified

    • Chainable

      Clones the vector and adds the scalar to it instead

      Parameters

      • scalar: number

        The scalar to add to the vector

      Returns V4Q

      Returns the clone of itself, modified

    • Clones the vector

      Returns V4Q

      The cloned vector

    • Calculates the cross product between this and two other supplied vectors

      Parameters

      • v: V4Q

        The first other vector

      • w: V4Q

        The second other vector

      Returns V4Q

      The cross product of the two vectors

      // returns -2
      new Vector(2, -3).cross(new Vector(-4, 2))
      new Vector(-4, 2).cross(new Vector(2, -3))
      // returns 2
      new Vector(2, -4).cross(new Vector(-3, 2))

    • Parameters

      • v: V4Q
      • w: V4Q

      Returns V4Q

    • Calculates the distance between this and the supplied vector

      Parameters

      • vector: V4Q

        The vector to calculate the distance from

      Returns number

      The distance between this and the supplied vector

    • Calculated the distance on the W axis between this and the supplied vector

      Parameters

      • vector: V4Q

        The vector to calculate the distance from

      Returns number

      The distance, along the y axis, between this and the supplied vector

    • Calculates the distance on the X axis between this and the supplied vector

      Parameters

      • vector: V4Q

        The vector to calculate the distance from

      Returns number

      The distance, along the x axis, between this and the supplied vector

    • Calculated the distance on the Y axis between this and the supplied vector

      Parameters

      • vector: V4Q

        The vector to calculate the distance from

      Returns number

      The distance, along the y axis, between this and the supplied vector

    • Calculated the distance on the Z axis between this and the supplied vector

      Parameters

      • vector: V4Q

        The vector to calculate the distance from

      Returns number

      The distance, along the y axis, between this and the supplied vector

    • Chainable

      Divides one vector by another.

      Parameters

      • vector: V4Q

        The vector to divide this by

      Returns V4Q

      Returns itself, modified

    • Chainable

      Clones the vector and divides it by the vector instead

      Parameters

      • vector: V4Q

        The vector to divide the clone by

      Returns V4Q

      Returns the clone of itself, modified

    • Chainable

      Divides the vector by a scalar.

      Parameters

      • scalar: number

        The scalar to divide both x and y by

      Returns V4Q

      Returns itself, modified

    • Chainable

      Clones the vector and divides it by the provided scalar.

      Parameters

      • scalar: number

        The scalar to divide both x and y by

      Returns V4Q

      Returns the clone of itself, modified

    • Calculates the dot product between this and a supplied vector

      Parameters

      • q: V4Q

      Returns number

      The dot product of the two vectors

      // returns -14
      new Vector(2, -3).dot(new Vector(-4, 2))
      new Vector(-4, 2).dot(new Vector(2, -3))
      new Vector(2, -4).dot(new Vector(-3, 2))
    • Chainable

      Inverses the vector.

      Returns V4Q

      Returns itself, modified

    • Chainable

      Clones the vector and then inverses it.

      Returns V4Q

      Returns itself, modified

    • Chainable

      Multiplies one vector by another.

      Parameters

      • q: V4Q

      Returns V4Q

      Returns itself, modified

    • Chainable

      Clones the vector and multiplies it by the vector instead

      Parameters

      • q: V4Q

        The vector to multiply the clone by

      Returns V4Q

      Returns the clone of itself, modified

    • Chainable

      Multiplies the vector by a scalar.

      Parameters

      • scalar: number

        The scalar to multiply both x and y by

      Returns V4Q

      Returns itself, modified

    • Chainable

      Clones the vector and multiplies it by the provided scalar.

      Parameters

      • scalar: number

        The scalar to multiply both x and y by

      Returns V4Q

      Returns the clone of itself, modified

    • Chainable

      Negates the vector.

      Returns V4Q

      Returns itself, modified

    • Chainable

      Clones the vector and negates it.

      Returns V4Q

      Returns itself, modified

    • Chainable

      Normalises the vector down to a length of 1 unit

      Returns V4Q

      Returns itself, modified

    • Chainable

      Clones the vector and normalises it

      Returns V4Q

      Returns a clone of itself, modified

    • Chainable

      Resets the vector coordinates

      Parameters

      • ...args: number[]

        The x, y, z and w coordinates

      Returns V4Q

    • Chainable

      Resets the vector coordinates to another vector object

      Parameters

      • v: V4Q

        The vector object to use to reset the coordinates

      Returns V4Q

    • Parameters

      • origin: V4Q
      • rad: number

      Returns V4Q

    • Parameters

      • origin: V4Q
      • radian: number

      Returns V4Q

    • Parameters

      • origin: V4Q
      • rad: number

      Returns V4Q

    • Parameters

      • origin: V4Q
      • radian: number

      Returns V4Q

    • Parameters

      • origin: V4Q
      • rad: number

      Returns V4Q

    • Parameters

      • origin: V4Q
      • radian: number

      Returns V4Q

    • Chainable

      Subtracts one vector from another.

      Parameters

      • vector: V4Q

        The vector to subtract from this one

      Returns V4Q

      Returns itself, modified

    • Chainable

      Clones the vector and subtracts the vector from it instead

      Parameters

      • vector: V4Q

        The vector to subtract from this one

      Returns V4Q

      Returns the clone of itself, modified

    • Chainable

      Subtracts a scalar from the vector, modifying both the x and y

      Parameters

      • scalar: number

        The scalar to subtract from the vector

      Returns V4Q

      Returns itself, modified

    • Chainable

      Clones the vector and subtracts the scalar from it instead

      Parameters

      • scalar: number

        The scalar to add to the vector

      Returns V4Q

      Returns the clone of itself, modified

    • Returns a string representation of an object.

      Returns string

    • Static

      Creates a quaternion from a given axis and rotation

      Parameters

      • axis: Vec3

        the axis around which to rotate

      • rad: number

        the angle in radians

      Returns Quat

    • Performs a linear interpolation between two Vec4's

      Parameters

      • v1: Vec4

        the first operand

      • v2: Vec4

        the second operand

      • d: number

        interpolation amount in the range of 0 - 1

      Returns Vec4

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods