Vec4 | wtc-math

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

author: Liam Egan liam@wethecollective.com
version: 1.0.0
created: Jan 07, 2020

Hierarchy

Vec4
- Quat

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Vec4(...args: number[]): Vec4

- Defined in Vec4.ts:106
The Vector Class constructor

Parameters
- Rest ...args: number[]
Returns Vec4

Properties

Private _w

_w: number = 0

(getter/setter) The y value of the vector.

default: 0

Private _x

_x: number = 0

(getter/setter) The x value of the vector.

default: 0

Private _y

_y: number = 0

(getter/setter) The y value of the vector.

default: 0

Private _z

_z: number = 0

(getter/setter) The y value of the vector.

default: 0

Accessors

area

get area(): number

- Defined in Vec4.ts:908
(getter) Vector area.

readonly

Returns number

array

get array(): number[]

- Defined in Vec4.ts:918
(getter) Returns the basic array representation of this vector.

readonly

Returns number[]

depth

get depth(): number
set depth(h: number): void

- Defined in Vec4.ts:898
(getter/setter) Vector height. Alias of {@link Vector#x x}

Returns number
- Defined in Vec4.ts:895
(getter/setter) Vector height. Alias of {@link Vector#x x}

Parameters
- h: number
Returns void

height

get height(): number
set height(h: number): void

- Defined in Vec4.ts:885
(getter/setter) Vector height. Alias of {@link Vector#x x}

Returns number
- Defined in Vec4.ts:882
(getter/setter) Vector height. Alias of {@link Vector#x x}

Parameters
- h: number
Returns void

length

get length(): number
set length(length: number): void

- Defined in Vec4.ts:859
(getter/setter) The length of the vector

Returns number
- Defined in Vec4.ts:850
(getter/setter) The length of the vector

default

0

Parameters
- length: number
Returns void

lengthSquared

get lengthSquared(): number
set lengthSquared(length: number): void

- Defined in Vec4.ts:838
(getter/setter) The length of the vector presented as a square. If you're using length for comparison, this is quicker.

Returns number
- Defined in Vec4.ts:829
(getter/setter) The length of the vector presented as a square. If you're using length for comparison, this is quicker.

default

0

Parameters
- length: number
Returns void

w

get w(): number
set w(w: number): void

- Defined in Vec4.ts:818
Returns number
- Defined in Vec4.ts:811
Parameters
- w: number
Returns void

width

get width(): number
set width(w: number): void

- Defined in Vec4.ts:872
(getter/setter) Vector width. Alias of {@link Vector#x x}

Returns number
- Defined in Vec4.ts:869
(getter/setter) Vector width. Alias of {@link Vector#x x}

Parameters
- w: number
Returns void

ww

get ww(): any
set ww(v: any): void

- Defined in Vec4.ts:1235
(getter/sette) Swizzle WW

Returns any
- Defined in Vec4.ts:1238
(getter/sette) Swizzle WW

Parameters
- v: any
Returns void

wx

get wx(): any
set wx(v: any): void

- Defined in Vec4.ts:1193
(getter/sette) Swizzle wx

Returns any
- Defined in Vec4.ts:1196
(getter/sette) Swizzle wx

Parameters
- v: any
Returns void

wxyz

get wxyz(): any
set wxyz(v: any): void

- Defined in Vec4.ts:969
(getter/sette) Swizzle XYZW

Returns any
- Defined in Vec4.ts:972
(getter/sette) Swizzle XYZW

Parameters
- v: any
Returns void

wy

get wy(): any
set wy(v: any): void

- Defined in Vec4.ts:1207
(getter/sette) Swizzle WY

Returns any
- Defined in Vec4.ts:1210
(getter/sette) Swizzle WY

Parameters
- v: any
Returns void

wz

get wz(): any
set wz(v: any): void

- Defined in Vec4.ts:1221
(getter/sette) Swizzle WZ

Returns any
- Defined in Vec4.ts:1224
(getter/sette) Swizzle WZ

Parameters
- v: any
Returns void

x

get x(): number
set x(x: number): void

- Defined in Vec4.ts:764
Returns number
- Defined in Vec4.ts:757
Parameters
- x: number
Returns void

xw

get xw(): any
set xw(v: any): void

- Defined in Vec4.ts:1069
(getter/sette) Swizzle XY

Returns any
- Defined in Vec4.ts:1072
(getter/sette) Swizzle XY

Parameters
- v: any
Returns void

xx

get xx(): any
set xx(v: any): void

- Defined in Vec4.ts:1028
(getter/sette) Swizzle XX

Returns any
- Defined in Vec4.ts:1031
(getter/sette) Swizzle XX

Parameters
- v: any
Returns void

xy

get xy(): any
set xy(v: any): void

- Defined in Vec4.ts:1041
(getter/sette) Swizzle XY

Returns any
- Defined in Vec4.ts:1044
(getter/sette) Swizzle XY

Parameters
- v: any
Returns void

xyz

get xyz(): any
set xyz(v: any): void

- Defined in Vec4.ts:983
(getter/sette) Swizzle YZX

Returns any
- Defined in Vec4.ts:986
(getter/sette) Swizzle YZX

Parameters
- v: any
Returns void

xyzw

get xyzw(): any
set xyzw(v: any): void

- Defined in Vec4.ts:927
(getter/sette) Swizzle XYZW

Returns any
- Defined in Vec4.ts:930
(getter/sette) Swizzle XYZW

Parameters
- v: any
Returns void

xz

get xz(): any
set xz(v: any): void

- Defined in Vec4.ts:1055
(getter/sette) Swizzle XY

Returns any
- Defined in Vec4.ts:1058
(getter/sette) Swizzle XY

Parameters
- v: any
Returns void

y

get y(): number
set y(y: number): void

- Defined in Vec4.ts:782
Returns number
- Defined in Vec4.ts:775
Parameters
- y: number
Returns void

yw

get yw(): any
set yw(v: any): void

- Defined in Vec4.ts:1124
(getter/sette) Swizzle YZ

Returns any
- Defined in Vec4.ts:1127
(getter/sette) Swizzle YZ

Parameters
- v: any
Returns void

yx

get yx(): any
set yx(v: any): void

- Defined in Vec4.ts:1083
(getter/sette) Swizzle YX

Returns any
- Defined in Vec4.ts:1086
(getter/sette) Swizzle YX

Parameters
- v: any
Returns void

yy

get yy(): any
set yy(v: any): void

- Defined in Vec4.ts:1097
(getter/sette) Swizzle YY

Returns any
- Defined in Vec4.ts:1100
(getter/sette) Swizzle YY

Parameters
- v: any
Returns void

yz

get yz(): any
set yz(v: any): void

- Defined in Vec4.ts:1110
(getter/sette) Swizzle YZ

Returns any
- Defined in Vec4.ts:1113
(getter/sette) Swizzle YZ

Parameters
- v: any
Returns void

yzwx

get yzwx(): any
set yzwx(v: any): void

- Defined in Vec4.ts:945
(getter/sette) Swizzle XYZW

Returns any
- Defined in Vec4.ts:948
(getter/sette) Swizzle XYZW

Parameters
- v: any
Returns void

yzx

get yzx(): any
set yzx(v: any): void

- Defined in Vec4.ts:998
(getter/sette) Swizzle YZX

Returns any
- Defined in Vec4.ts:1001
(getter/sette) Swizzle YZX

Parameters
- v: any
Returns void

z

get z(): number
set z(z: number): void

- Defined in Vec4.ts:800
Returns number
- Defined in Vec4.ts:793
Parameters
- z: number
Returns void

zw

get zw(): any
set zw(v: any): void

- Defined in Vec4.ts:1179
(getter/sette) Swizzle XY

Returns any
- Defined in Vec4.ts:1182
(getter/sette) Swizzle XY

Parameters
- v: any
Returns void

zwxy

get zwxy(): any
set zwxy(v: any): void

- Defined in Vec4.ts:957
(getter/sette) Swizzle XYZW

Returns any
- Defined in Vec4.ts:960
(getter/sette) Swizzle XYZW

Parameters
- v: any
Returns void

zx

get zx(): any
set zx(v: any): void

- Defined in Vec4.ts:1138
(getter/sette) Swizzle zx

Returns any
- Defined in Vec4.ts:1141
(getter/sette) Swizzle zx

Parameters
- v: any
Returns void

zxy

get zxy(): any
set zxy(v: any): void

- Defined in Vec4.ts:1013
(getter/sette) Swizzle ZXY

Returns any
- Defined in Vec4.ts:1016
(getter/sette) Swizzle ZXY

Parameters
- v: any
Returns void

zy

get zy(): any
set zy(v: any): void

- Defined in Vec4.ts:1152
(getter/sette) Swizzle ZY

Returns any
- Defined in Vec4.ts:1155
(getter/sette) Swizzle ZY

Parameters
- v: any
Returns void

zz

get zz(): any
set zz(v: any): void

- Defined in Vec4.ts:1166
(getter/sette) Swizzle ZZ

Returns any
- Defined in Vec4.ts:1169
(getter/sette) Swizzle ZZ

Parameters
- v: any
Returns void

Methods

[iterator]

[iterator](): { next: any }

- Defined in Vec4.ts:1302
Adds iteration to the object, allowing it to be destructured and iterated upon in various useful ways.

Returns { next: any }
- next: function
  - next(): { done: boolean; value: number } | { done: boolean; value: undefined }
  - - Defined in Vec4.ts:1306
    Returns { done: boolean; value: number } | { done: boolean; value: undefined }

add

add(vector: V4Q): V4Q

Implementation of V4Q.add
- Defined in Vec4.ts:176
Adds one vector to another.

chainable

Parameters
- vector: V4Q
  
  The vector to add to this one
Returns V4Q

Returns itself, modified

addNew

addNew(vector: V4Q): V4Q

Implementation of V4Q.addNew
- Defined in Vec4.ts:191
Clones the vector and adds the vector to it instead

chainable

Parameters
- vector: V4Q
  
  The vector to add to this one
Returns V4Q

Returns the clone of itself, modified

addScalar

addScalar(scalar: number): V4Q

Implementation of V4Q.addScalar
- Defined in Vec4.ts:203
Adds a scalar to the vector, modifying both the x and y

chainable

Parameters
- scalar: number
  
  The scalar to add to the vector
Returns V4Q

Returns itself, modified

addScalarNew

addScalarNew(scalar: number): V4Q

Implementation of V4Q.addScalarNew
- Defined in Vec4.ts:214
Clones the vector and adds the scalar to it instead

chainable

Parameters
- scalar: number
  
  The scalar to add to the vector
Returns V4Q

Returns the clone of itself, modified

ceil

ceil(): V4Q

Implementation of V4Q.ceil
- Defined in Vec4.ts:698
Returns V4Q

ceilNew

ceilNew(): V4Q

Implementation of V4Q.ceilNew
- Defined in Vec4.ts:706
Returns V4Q

clone

clone(): V4Q

Implementation of V4Q.clone
- Defined in Vec4.ts:164
Clones the vector

Returns V4Q

The cloned vector

cross

cross(v: V4Q, w: V4Q): V4Q

Implementation of V4Q.cross
- Defined in Vec4.ts:672
Calculates the cross product between this and two other supplied 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))

Parameters
- v: V4Q
- w: V4Q
Returns V4Q

The cross product of the two vectors

crossNew

crossNew(v: V4Q, w: V4Q): V4Q

Implementation of V4Q.crossNew
- Defined in Vec4.ts:694
Parameters
- v: V4Q
- w: V4Q
Returns V4Q

distance

distance(vector: V4Q): number

Implementation of V4Q.distance
- Defined in Vec4.ts:594
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: V4Q): number

Implementation of V4Q.distanceW
- Defined in Vec4.ts:634
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: V4Q): number

Implementation of V4Q.distanceX
- Defined in Vec4.ts:604
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: V4Q): number

Implementation of V4Q.distanceY
- Defined in Vec4.ts:614
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: V4Q): number

Implementation of V4Q.distanceZ
- Defined in Vec4.ts:624
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): V4Q

Implementation of V4Q.divide
- Defined in Vec4.ts:276
Divides one vector by another.

chainable

Parameters
- vector: V4Q
  
  The vector to divide this by
Returns V4Q

Returns itself, modified

divideNew

divideNew(vector: V4Q): V4Q

Implementation of V4Q.divideNew
- Defined in Vec4.ts:307
Clones the vector and divides it by the vector instead

chainable

Parameters
- vector: V4Q
  
  The vector to divide the clone by
Returns V4Q

Returns the clone of itself, modified

divideScalar

divideScalar(scalar: number): V4Q

Implementation of V4Q.divideScalar
- Defined in Vec4.ts:319
Divides the vector by a scalar.

chainable

Parameters
- scalar: number
  
  The scalar to divide both x and y by
Returns V4Q

Returns itself, modified

divideScalarNew

divideScalarNew(scalar: number): V4Q

Implementation of V4Q.divideScalarNew
- Defined in Vec4.ts:331
Clones the vector and divides it by the provided scalar.

chainable

Parameters
- scalar: number
  
  The scalar to divide both x and y by
Returns V4Q

Returns the clone of itself, modified

dot

dot(vector: V4Q): number

Implementation of V4Q.dot
- Defined in Vec4.ts:650
Calculates the dot product between this and a supplied vector

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

Parameters
- vector: V4Q
  
  The vector object against which to calculate the dot product
Returns number

The dot product of the two vectors

floor

floor(): V4Q

Implementation of V4Q.floor
- Defined in Vec4.ts:710
Returns V4Q

floorNew

floorNew(): V4Q

Implementation of V4Q.floorNew
- Defined in Vec4.ts:718
Returns V4Q

fract

fract(): V4Q

Implementation of V4Q.fract
- Defined in Vec4.ts:734
Returns V4Q

fractNew

fractNew(): V4Q

Implementation of V4Q.fractNew
- Defined in Vec4.ts:742
Returns V4Q

inverse

inverse(): V4Q

Implementation of V4Q.inverse
- Defined in Vec4.ts:534
Inverses the vector.

chainable

Returns V4Q

Returns itself, modified

inverseNew

inverseNew(): V4Q

Implementation of V4Q.inverseNew
- Defined in Vec4.ts:549
Clones the vector and then inverses it.

chainable

Returns V4Q

Returns itself, modified

multiply

multiply(vector: V4Q): V4Q

Implementation of V4Q.multiply
- Defined in Vec4.ts:343
Multiplies one vector by another.

chainable

Parameters
- vector: V4Q
  
  The vector to multiply this by
Returns V4Q

Returns itself, modified

multiplyNew

multiplyNew(q: V4Q): V4Q

Implementation of V4Q.multiplyNew
- Defined in Vec4.ts:358
Clones the vector and multiplies it by the vector instead

chainable

Parameters
- q: V4Q
Returns V4Q

Returns the clone of itself, modified

multiplyScalar

multiplyScalar(scalar: number): V4Q

Implementation of V4Q.multiplyScalar
- Defined in Vec4.ts:370
Multiplies the vector by a scalar.

chainable

Parameters
- scalar: number
  
  The scalar to multiply both x and y by
Returns V4Q

Returns itself, modified

multiplyScalarNew

multiplyScalarNew(scalar: number): V4Q

Implementation of V4Q.multiplyScalarNew
- Defined in Vec4.ts:382
Clones the vector and multiplies it by the provided scalar.

chainable

Parameters
- scalar: number
  
  The scalar to multiply both x and y by
Returns V4Q

Returns the clone of itself, modified

negate

negate(): V4Q

Implementation of V4Q.negate
- Defined in Vec4.ts:512
Negates the vector.

chainable

Returns V4Q

Returns itself, modified

negateNew

negateNew(): V4Q

Implementation of V4Q.negateNew
- Defined in Vec4.ts:523
Clones the vector and negates it.

chainable

Returns V4Q

Returns itself, modified

normalise

normalise(): V4Q

Implementation of V4Q.normalise
- Defined in Vec4.ts:565
Normalises the vector down to a length of 1 unit

chainable

Returns V4Q

Returns itself, modified

normaliseNew

normaliseNew(): V4Q

Implementation of V4Q.normaliseNew
- Defined in Vec4.ts:584
Clones the vector and normalises it

chainable

Returns V4Q

Returns a clone of itself, modified

reset

reset(...args: number[]): V4Q

Implementation of V4Q.reset
- Defined in Vec4.ts:128
Resets the vector coordinates

chainable

Parameters
- Rest ...args: number[]
Returns V4Q

resetToVector

resetToVector(v: V4Q): V4Q

Implementation of V4Q.resetToVector
- Defined in Vec4.ts:148
Resets the vector coordinates to another vector object

chainable

Parameters
- v: V4Q
  
  The vector object to use to reset the coordinates
Returns V4Q

rotateX

rotateX(origin: V4Q, radian: number): V4Q

Implementation of V4Q.rotateX
- Defined in Vec4.ts:399
Parameters
- origin: V4Q
- radian: number
Returns V4Q

rotateXNew

rotateXNew(origin: V4Q, radian: number): V4Q

Implementation of V4Q.rotateXNew
- Defined in Vec4.ts:418
Parameters
- origin: V4Q
- radian: number
Returns V4Q

rotateY

rotateY(origin: V4Q, radian: number): V4Q

Implementation of V4Q.rotateY
- Defined in Vec4.ts:422
Parameters
- origin: V4Q
- radian: number
Returns V4Q

rotateYNew

rotateYNew(origin: V4Q, radian: number): V4Q

Implementation of V4Q.rotateYNew
- Defined in Vec4.ts:441
Parameters
- origin: V4Q
- radian: number
Returns V4Q

rotateZ

rotateZ(origin: V4Q, radian: number): V4Q

Implementation of V4Q.rotateZ
- Defined in Vec4.ts:445
Parameters
- origin: V4Q
- radian: number
Returns V4Q

rotateZNew

rotateZNew(origin: V4Q, radian: number): V4Q

Implementation of V4Q.rotateZNew
- Defined in Vec4.ts:464
Parameters
- origin: V4Q
- radian: number
Returns V4Q

round

round(): V4Q

Implementation of V4Q.round
- Defined in Vec4.ts:722
Returns V4Q

roundNew

roundNew(): V4Q

Implementation of V4Q.roundNew
- Defined in Vec4.ts:730
Returns V4Q

scale

scale(scalar: number): V4Q

Implementation of V4Q.scale
- Defined in Vec4.ts:389
Alias of {@link Vector#multiplyScalar__anchor multiplyScalar}

Parameters
- scalar: number
Returns V4Q

scaleNew

scaleNew(scalar: number): V4Q

Implementation of V4Q.scaleNew
- Defined in Vec4.ts:395
Alias of {@link Vector#multiplyScalarNew__anchor multiplyScalarNew}

Parameters
- scalar: number
Returns V4Q

subtract

subtract(vector: V4Q): V4Q

Implementation of V4Q.subtract
- Defined in Vec4.ts:226
Subtracts one vector from another.

chainable

Parameters
- vector: V4Q
  
  The vector to subtract from this one
Returns V4Q

Returns itself, modified

subtractNew

subtractNew(vector: V4Q): V4Q

Implementation of V4Q.subtractNew
- Defined in Vec4.ts:241
Clones the vector and subtracts the vector from it instead

chainable

Parameters
- vector: V4Q
  
  The vector to subtract from this one
Returns V4Q

Returns the clone of itself, modified

subtractScalar

subtractScalar(scalar: number): V4Q

Implementation of V4Q.subtractScalar
- Defined in Vec4.ts:253
Subtracts a scalar from the vector, modifying both the x and y

chainable

Parameters
- scalar: number
  
  The scalar to subtract from the vector
Returns V4Q

Returns itself, modified

subtractScalarNew

subtractScalarNew(scalar: number): V4Q

Implementation of V4Q.subtractScalarNew
- Defined in Vec4.ts:264
Clones the vector and subtracts the scalar from it instead

chainable

Parameters
- scalar: number
  
  The scalar to add to the vector
Returns V4Q

Returns the clone of itself, modified

transformByMat4

transformByMat4(m: any): V4Q

Implementation of V4Q.transformByMat4
- Defined in Vec4.ts:468
Parameters
- m: any
Returns V4Q

transformByMat4New

transformByMat4New(m: any): V4Q

Implementation of V4Q.transformByMat4New
- Defined in Vec4.ts:480
Parameters
- m: any
Returns V4Q

transformByQuat

transformByQuat(q: any): V4Q

Implementation of V4Q.transformByQuat
- Defined in Vec4.ts:484
Parameters
- q: any
Returns V4Q

transformByQuatNew

transformByQuatNew(q: any): V4Q

Implementation of V4Q.transformByQuatNew
- Defined in Vec4.ts:501
Parameters
- q: any
Returns V4Q

Static getAngle

getAngle(a: any, b: any): number

- Defined in Vec4.ts:1291
Parameters
- a: any
- b: any
Returns number

Static interpolate

interpolate(v: any): Vec4

- Defined in Vec4.ts:1253
Iterpolates a provided anonymous value into a vew Vec4

Parameters
- v: any
  
  The value to interpolate
Returns Vec4

out

Static lerp

lerp(v1: any, v2: any, d: any): Vec4

- Defined in Vec4.ts:1282
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

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Rest ...args: number[]

Returns Vec4

Properties

Private _w

Private _x

Private _y

Private _z

Accessors

area

Returns number

array

Returns number[]

depth

Returns number

Parameters

h: number

Returns void

height

Returns number

Parameters

h: number

Returns void

length

Returns number

Parameters

length: number

Returns void

lengthSquared

Returns number

Parameters

length: number

Returns void

w

Returns number

Parameters

w: number

Returns void

width

Returns number

Parameters

w: number

Returns void

ww

Returns any

Parameters

v: any

Returns void

wx

Returns any

Parameters

v: any

Returns void

wxyz

Returns any

Parameters

v: any

Returns void

wy

Returns any

Parameters

v: any

Returns void

wz

Returns any

Parameters

v: any

Returns void

x

Returns number

Parameters