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

Author

Liam Egan liam@wethecollective.com

Version

1.0.0

Created

Jan 07, 2020

Hierarchy (view full)

Implements

  • V4Q

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 cross crossNew distance distanceW distanceX distanceY distanceZ divide divideNew divideScalar divideScalarNew dot floor floorNew fract fractNew inverse inverseNew 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 interpolate lerp

Constructors

constructor

  • new Quat(...args): Quat

  • Parameters

    • Rest...args: number[]

    Returns Quat

Accessors

area

  • get area(): number

  • (getter) Vector area.

    Returns number

array

  • get array(): number[]

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

    Returns number[]

depth

  • get depth(): number

  • Returns number

  • set depth(h): void

  • (getter/setter) Vector height. Alias of Vector#x x

    Parameters

    • h: number

    Returns void

height

  • get height(): number

  • Returns number

  • set height(h): void

  • (getter/setter) Vector height. Alias of Vector#x x

    Parameters

    • h: number

    Returns void

length

  • get length(): number

  • Returns number

  • set length(length): void

  • (getter/setter) The length of the vector

    Parameters

    • length: number

    Returns void

    Default

    0

lengthSquared

  • get lengthSquared(): number

  • Returns number

  • set lengthSquared(length): 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

    Default

    0

normalW

  • get normalW(): number

  • Getters and setters

    Returns number

w

  • get w(): number

  • Returns number

  • set w(w): void

  • Parameters

    • w: number

    Returns void

width

  • get width(): number

  • Returns number

  • set width(w): void

  • (getter/setter) Vector width. Alias of Vector#x x

    Parameters

    • w: number

    Returns void

ww

  • get ww(): any

  • (getter/sette) Swizzle WW

    Returns any

  • set ww(v): void

  • Parameters

    • v: any

    Returns void

wx

  • get wx(): any

  • (getter/sette) Swizzle wx

    Returns any

  • set wx(v): void

  • Parameters

    • v: any

    Returns void

wxyz

  • get wxyz(): any

  • (getter/sette) Swizzle XYZW

    Returns any

  • set wxyz(v): void

  • Parameters

    • v: any

    Returns void

wy

  • get wy(): any

  • (getter/sette) Swizzle WY

    Returns any

  • set wy(v): void

  • Parameters

    • v: any

    Returns void

wz

  • get wz(): any

  • (getter/sette) Swizzle WZ

    Returns any

  • set wz(v): void

  • Parameters

    • v: any

    Returns void

x

  • get x(): number

  • Returns number

  • set x(x): void

  • Parameters

    • x: number

    Returns void

xw

  • get xw(): any

  • (getter/sette) Swizzle XY

    Returns any

  • set xw(v): void

  • Parameters

    • v: any

    Returns void

xx

  • get xx(): any

  • (getter/sette) Swizzle XX

    Returns any

  • set xx(v): void

  • Parameters

    • v: any

    Returns void

xy

  • get xy(): any

  • (getter/sette) Swizzle XY

    Returns any

  • set xy(v): void

  • Parameters

    • v: any

    Returns void

xyz

  • get xyz(): any

  • (getter/sette) Swizzle YZX

    Returns any

  • set xyz(v): void

  • Parameters

    • v: any

    Returns void

xyzw

  • get xyzw(): any

  • (getter/sette) Swizzle XYZW

    Returns any

  • set xyzw(v): void

  • Parameters

    • v: any

    Returns void

xz

  • get xz(): any

  • (getter/sette) Swizzle XY

    Returns any

  • set xz(v): void

  • Parameters

    • v: any

    Returns void

y

  • get y(): number

  • Returns number

  • set y(y): void

  • Parameters

    • y: number

    Returns void

yw

  • get yw(): any

  • (getter/sette) Swizzle YZ

    Returns any

  • set yw(v): void

  • Parameters

    • v: any

    Returns void

yx

  • get yx(): any

  • (getter/sette) Swizzle YX

    Returns any

  • set yx(v): void

  • Parameters

    • v: any

    Returns void

yy

  • get yy(): any

  • (getter/sette) Swizzle YY

    Returns any

  • set yy(v): void

  • Parameters

    • v: any

    Returns void

yz

  • get yz(): any

  • (getter/sette) Swizzle YZ

    Returns any

  • set yz(v): void

  • Parameters

    • v: any

    Returns void

yzwx

  • get yzwx(): any

  • (getter/sette) Swizzle XYZW

    Returns any

  • set yzwx(v): void

  • Parameters

    • v: any

    Returns void

yzx

  • get yzx(): any

  • (getter/sette) Swizzle YZX

    Returns any

  • set yzx(v): void

  • Parameters

    • v: any

    Returns void

z

  • get z(): number

  • Returns number

  • set z(z): void

  • Parameters

    • z: number

    Returns void

zw

  • get zw(): any

  • (getter/sette) Swizzle XY

    Returns any

  • set zw(v): void

  • Parameters

    • v: any

    Returns void

zwxy

  • get zwxy(): any

  • (getter/sette) Swizzle XYZW

    Returns any

  • set zwxy(v): void

  • Parameters

    • v: any

    Returns void

zx

  • get zx(): any

  • (getter/sette) Swizzle zx

    Returns any

  • set zx(v): void

  • Parameters

    • v: any

    Returns void

zxy

  • get zxy(): any

  • (getter/sette) Swizzle ZXY

    Returns any

  • set zxy(v): void

  • Parameters

    • v: any

    Returns void

zy

  • get zy(): any

  • (getter/sette) Swizzle ZY

    Returns any

  • set zy(v): void

  • Parameters

    • v: any

    Returns void

zz

  • get zz(): any

  • (getter/sette) Swizzle ZZ

    Returns any

  • set zz(v): void

  • Parameters

    • v: any

    Returns void

Methods

[iterator]

  • [iterator](): {
        next(): {
            done: boolean;
            value: number;
        } | {
            done: boolean;
            value?: undefined;
        };
    }

  • 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;
        };
    }

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

      • Returns {
            done: boolean;
            value: number;
        } | {
            done: boolean;
            value?: undefined;
        }

add

  • add(vector): V4Q

  • Adds one vector to another.

    Parameters

    • vector: V4Q

      The vector to add to this one

    Returns V4Q

    Returns itself, modified

    Chainable

addNew

  • addNew(vector): V4Q

  • 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

addScalar

  • addScalar(scalar): V4Q

  • 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

addScalarNew

  • addScalarNew(scalar): V4Q

  • 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

    Chainable

ceil

  • ceil(): V4Q

  • Returns V4Q

ceilNew

  • ceilNew(): V4Q

  • Returns V4Q

clone

  • clone(): V4Q

  • Clones the vector

    Returns V4Q

    The cloned vector

cross

  • cross(v, w): V4Q

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

    Parameters

    • v: V4Q
    • w: V4Q

    Returns V4Q

    The cross product of the two vectors

    Example

    // 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))

crossNew

  • crossNew(v, w): V4Q

  • Parameters

    • v: V4Q
    • w: V4Q

    Returns V4Q

distance

  • distance(vector): number

  • 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

distanceW

  • distanceW(vector): number

  • 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

distanceX

  • distanceX(vector): number

  • 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

distanceY

  • distanceY(vector): number

  • 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

distanceZ

  • distanceZ(vector): number

  • 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

divide

  • divide(vector): V4Q

  • Divides one vector by another.

    Parameters

    • vector: V4Q

      The vector to divide this by

    Returns V4Q

    Returns itself, modified

    Chainable

divideNew

  • divideNew(vector): V4Q

  • 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

divideScalar

  • divideScalar(scalar): V4Q

  • Divides the vector by a scalar.

    Parameters

    • scalar: number

      The scalar to divide both x and y by

    Returns V4Q

    Returns itself, modified

    Chainable

divideScalarNew

  • divideScalarNew(scalar): V4Q

  • 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

    Chainable

dot

  • dot(vector): number

  • Calculates the dot product between this and a supplied vector

    Parameters

    • vector: V4Q

      The vector object against which to calculate the dot product

    Returns number

    The dot product of the two vectors

    Example

    // 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))

floor

  • floor(): V4Q

  • Returns V4Q

floorNew

  • floorNew(): V4Q

  • Returns V4Q

fract

  • fract(): V4Q

  • Returns V4Q

fractNew

  • fractNew(): V4Q

  • Returns V4Q

inverse

  • inverse(): V4Q

  • Inverses the vector.

    Returns V4Q

    Returns itself, modified

    Chainable

inverseNew

  • inverseNew(): V4Q

  • Clones the vector and then inverses it.

    Returns V4Q

    Returns itself, modified

    Chainable

multiply

  • multiply(q): V4Q

  • Multiplies one vector by another.

    Parameters

    • q: V4Q

    Returns V4Q

    Returns itself, modified

    Chainable

multiplyNew

  • multiplyNew(q): V4Q

  • Clones the vector and multiplies it by the vector instead

    Parameters

    • q: V4Q

    Returns V4Q

    Returns the clone of itself, modified

    Chainable

multiplyScalar

  • multiplyScalar(scalar): V4Q

  • Multiplies the vector by a scalar.

    Parameters

    • scalar: number

      The scalar to multiply both x and y by

    Returns V4Q

    Returns itself, modified

    Chainable

multiplyScalarNew

  • multiplyScalarNew(scalar): V4Q

  • 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

negate

  • negate(): V4Q

  • Negates the vector.

    Returns V4Q

    Returns itself, modified

    Chainable

negateNew

  • negateNew(): V4Q

  • Clones the vector and negates it.

    Returns V4Q

    Returns itself, modified

    Chainable

normalise

  • normalise(): V4Q

  • Normalises the vector down to a length of 1 unit

    Returns V4Q

    Returns itself, modified

    Chainable

normaliseNew

  • normaliseNew(): V4Q

  • Clones the vector and normalises it

    Returns V4Q

    Returns a clone of itself, modified

    Chainable

reset

  • reset(...args): V4Q

  • Resets the vector coordinates

    Parameters

    • Rest...args: number[]

    Returns V4Q

    Chainable

resetToQuat

  • resetToQuat(q): Quat

  • Parameters

    • q: any

    Returns Quat

resetToVector

  • resetToVector(v): V4Q

  • Resets the vector coordinates to another vector object

    Parameters

    • v: V4Q

      The vector object to use to reset the coordinates

    Returns V4Q

    Chainable

rotateX

  • rotateX(origin, rad): V4Q

  • Parameters

    • origin: V4Q
    • rad: number

    Returns V4Q

rotateXNew

  • rotateXNew(origin, radian): V4Q

  • Parameters

    • origin: V4Q
    • radian: number

    Returns V4Q

rotateY

  • rotateY(origin, rad): V4Q

  • Parameters

    • origin: V4Q
    • rad: number

    Returns V4Q

rotateYNew

  • rotateYNew(origin, radian): V4Q

  • Parameters

    • origin: V4Q
    • radian: number

    Returns V4Q

rotateZ

  • rotateZ(origin, rad): V4Q

  • Parameters

    • origin: V4Q
    • rad: number

    Returns V4Q

rotateZNew

  • rotateZNew(origin, radian): V4Q

  • Parameters

    • origin: V4Q
    • radian: number

    Returns V4Q

round

  • round(): V4Q

  • Returns V4Q

roundNew

  • roundNew(): V4Q

  • Returns V4Q

scale

  • scale(scalar): V4Q

  • Alias of Vector#multiplyScalar__anchor multiplyScalar

    Parameters

    • scalar: number

    Returns V4Q

scaleNew

  • scaleNew(scalar): V4Q

  • Alias of Vector#multiplyScalarNew__anchor multiplyScalarNew

    Parameters

    • scalar: number

    Returns V4Q

subtract

  • subtract(vector): V4Q

  • Subtracts one vector from another.

    Parameters

    • vector: V4Q

      The vector to subtract from this one

    Returns V4Q

    Returns itself, modified

    Chainable

subtractNew

  • subtractNew(vector): V4Q

  • 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

subtractScalar

  • subtractScalar(scalar): V4Q

  • 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

subtractScalarNew

  • subtractScalarNew(scalar): V4Q

  • 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

    Chainable

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

transformByMat4

  • transformByMat4(m): V4Q

  • Parameters

    • m: any

    Returns V4Q

transformByMat4New

  • transformByMat4New(m): V4Q

  • Parameters

    • m: any

    Returns V4Q

transformByQuat

  • transformByQuat(q): V4Q

  • Parameters

    • q: any

    Returns V4Q

transformByQuatNew

  • transformByQuatNew(q): V4Q

  • Parameters

    • q: any

    Returns V4Q

StaticfromAxisAngle

  • fromAxisAngle(axis, rad): Quat

  • 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

    Static

StaticfromEuler

  • fromEuler(euler, order?): void | Quat

  • Parameters

    • euler: any
    • Optionalorder: string

    Returns void | Quat

StaticgetAngle

  • getAngle(a, b): number

  • Parameters

    • a: any
    • b: any

    Returns number

Staticinterpolate

  • interpolate(v): Vec4

  • Iterpolates a provided anonymous value into a vew Vec4

    Parameters

    • v: any

      The value to interpolate

    Returns Vec4

    out

Staticlerp

  • lerp(v1, v2, d): Vec4

  • Performs a linear interpolation between two Vec4's

    Parameters

    • v1: any

      the first operand

    • v2: any

      the second operand

    • d: any

      interpolation amount in the range of 0 - 1

    Returns Vec4

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods