Class Vec4

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

Vec4
- Quat

Implements

V4Q

Constructors

constructor

new Vec4(...args: number[]): Vec4
The Vector Class constructor
Parameters
- ...args: number[]
Returns Vec4
- Defined in Vec4.ts:115

Accessors

area

get area(): number
(getter) Vector area.

Returns number
Implementation of V4Q.area
- Defined in Vec4.ts:886

array

get array(): number[]
(getter) Returns the basic array representation of this vector.

Returns number[]
Implementation of V4Q.array
- Defined in Vec4.ts:896

depth

get depth(): number
Returns number
Implementation of V4Q.depth
- Defined in Vec4.ts:876
set depth(h: number): void
(getter/setter) Vector height. Alias of Vector#x x
Parameters
- h: number
Returns void
Implementation of V4Q.depth
- Defined in Vec4.ts:873

height

get height(): number
Returns number
Implementation of V4Q.height
- Defined in Vec4.ts:863
set height(h: number): void
(getter/setter) Vector height. Alias of Vector#x x
Parameters
- h: number
Returns void
Implementation of V4Q.height
- Defined in Vec4.ts:860

length

get length(): number
Returns number
Implementation of V4Q.length
- Defined in Vec4.ts:837
set length(length: number): void
(getter/setter) The length of the vector
Parameters
- length: number
Returns void
Default
```
0
```
Implementation of V4Q.length
- Defined in Vec4.ts:828

lengthSquared

get lengthSquared(): number
Returns number
Implementation of V4Q.lengthSquared
- Defined in Vec4.ts:816
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
Default
```
0
```
Implementation of V4Q.lengthSquared
- Defined in Vec4.ts:807

w

get w(): number
Returns number
Implementation of V4Q.w
- Defined in Vec4.ts:796
set w(w: number): void
Parameters
- w: number
Returns void
Implementation of V4Q.w
- Defined in Vec4.ts:789

width

get width(): number
Returns number
Implementation of V4Q.width
- Defined in Vec4.ts:850
set width(w: number): void
(getter/setter) Vector width. Alias of Vector#x x
Parameters
- w: number
Returns void
Implementation of V4Q.width
- Defined in Vec4.ts:847

ww

get ww(): Vec2
(getter/sette) Swizzle WW

Returns Vec2
Implementation of V4Q.ww
- Defined in Vec4.ts:1238
set ww(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.ww
- Defined in Vec4.ts:1241

wx

get wx(): Vec2
(getter/sette) Swizzle wx

Returns Vec2
Implementation of V4Q.wx
- Defined in Vec4.ts:1196
set wx(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.wx
- Defined in Vec4.ts:1199

wxyz

get wxyz(): Vec4
(getter/sette) Swizzle WXYZ

Returns Vec4
Implementation of V4Q.wxyz
- Defined in Vec4.ts:953
set wxyz(v: Vec4Like): void
Parameters
- v: Vec4Like
Returns void
Implementation of V4Q.wxyz
- Defined in Vec4.ts:956

wy

get wy(): Vec2
(getter/sette) Swizzle WY

Returns Vec2
Implementation of V4Q.wy
- Defined in Vec4.ts:1210
set wy(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.wy
- Defined in Vec4.ts:1213

wz

get wz(): Vec2
(getter/sette) Swizzle WZ

Returns Vec2
Implementation of V4Q.wz
- Defined in Vec4.ts:1224
set wz(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.wz
- Defined in Vec4.ts:1227

x

get x(): number
Returns number
Implementation of V4Q.x
- Defined in Vec4.ts:742
set x(x: number): void
Parameters
- x: number
Returns void
Implementation of V4Q.x
- Defined in Vec4.ts:735

xw

get xw(): Vec2
(getter/sette) Swizzle XY

Returns Vec2
Implementation of V4Q.xw
- Defined in Vec4.ts:1072
set xw(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.xw
- Defined in Vec4.ts:1075

xx

get xx(): Vec2
(getter/sette) Swizzle XX

Returns Vec2
Implementation of V4Q.xx
- Defined in Vec4.ts:1031
set xx(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.xx
- Defined in Vec4.ts:1034

xy

get xy(): Vec2
(getter/sette) Swizzle XY

Returns Vec2
Implementation of V4Q.xy
- Defined in Vec4.ts:1044
set xy(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.xy
- Defined in Vec4.ts:1047

xyz

get xyz(): Vec3
(getter/sette) Swizzle YZX

Returns Vec3
Implementation of V4Q.xyz
- Defined in Vec4.ts:971
set xyz(v: Vec3Like): void
Parameters
- v: Vec3Like
Returns void
Implementation of V4Q.xyz
- Defined in Vec4.ts:974

xyzw

get xyzw(): Vec4
(getter/sette) Swizzle XYZW

Returns Vec4
Implementation of V4Q.xyzw
- Defined in Vec4.ts:905
set xyzw(v: Vec4Like): void
Parameters
- v: Vec4Like
Returns void
Implementation of V4Q.xyzw
- Defined in Vec4.ts:908

xz

get xz(): Vec2
(getter/sette) Swizzle XY

Returns Vec2
Implementation of V4Q.xz
- Defined in Vec4.ts:1058
set xz(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.xz
- Defined in Vec4.ts:1061

y

get y(): number
Returns number
Implementation of V4Q.y
- Defined in Vec4.ts:760
set y(y: number): void
Parameters
- y: number
Returns void
Implementation of V4Q.y
- Defined in Vec4.ts:753

yw

get yw(): Vec2
(getter/sette) Swizzle YZ

Returns Vec2
Implementation of V4Q.yw
- Defined in Vec4.ts:1127
set yw(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.yw
- Defined in Vec4.ts:1130

yx

get yx(): Vec2
(getter/sette) Swizzle YX

Returns Vec2
Implementation of V4Q.yx
- Defined in Vec4.ts:1086
set yx(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.yx
- Defined in Vec4.ts:1089

yy

get yy(): Vec2
(getter/sette) Swizzle YY

Returns Vec2
Implementation of V4Q.yy
- Defined in Vec4.ts:1100
set yy(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.yy
- Defined in Vec4.ts:1103

yz

get yz(): Vec2
(getter/sette) Swizzle YZ

Returns Vec2
Implementation of V4Q.yz
- Defined in Vec4.ts:1113
set yz(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.yz
- Defined in Vec4.ts:1116

yzwx

get yzwx(): Vec4
(getter/sette) Swizzle YZWX

Returns Vec4
Implementation of V4Q.yzwx
- Defined in Vec4.ts:921
set yzwx(v: Vec4Like): void
Parameters
- v: Vec4Like
Returns void
Implementation of V4Q.yzwx
- Defined in Vec4.ts:924

yzx

get yzx(): Vec3
(getter/sette) Swizzle YZX

Returns Vec3
Implementation of V4Q.yzx
- Defined in Vec4.ts:991
set yzx(v: Vec3Like): void
Parameters
- v: Vec3Like
Returns void
Implementation of V4Q.yzx
- Defined in Vec4.ts:994

z

get z(): number
Returns number
Implementation of V4Q.z
- Defined in Vec4.ts:778
set z(z: number): void
Parameters
- z: number
Returns void
Implementation of V4Q.z
- Defined in Vec4.ts:771

zw

get zw(): Vec2
(getter/sette) Swizzle XY

Returns Vec2
Implementation of V4Q.zw
- Defined in Vec4.ts:1182
set zw(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.zw
- Defined in Vec4.ts:1185

zwxy

get zwxy(): Vec4
(getter/sette) Swizzle ZWXY

Returns Vec4
Implementation of V4Q.zwxy
- Defined in Vec4.ts:937
set zwxy(v: Vec4Like): void
Parameters
- v: Vec4Like
Returns void
Implementation of V4Q.zwxy
- Defined in Vec4.ts:940

zx

get zx(): Vec2
(getter/sette) Swizzle zx

Returns Vec2
Implementation of V4Q.zx
- Defined in Vec4.ts:1141
set zx(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.zx
- Defined in Vec4.ts:1144

zxy

get zxy(): Vec3
(getter/sette) Swizzle ZXY

Returns Vec3
Implementation of V4Q.zxy
- Defined in Vec4.ts:1011
set zxy(v: Vec3Like): void
Parameters
- v: Vec3Like
Returns void
Implementation of V4Q.zxy
- Defined in Vec4.ts:1014

zy

get zy(): Vec2
(getter/sette) Swizzle ZY

Returns Vec2
Implementation of V4Q.zy
- Defined in Vec4.ts:1155
set zy(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.zy
- Defined in Vec4.ts:1158

zz

get zz(): Vec2
(getter/sette) Swizzle ZZ

Returns Vec2
Implementation of V4Q.zz
- Defined in Vec4.ts:1169
set zz(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
Implementation of V4Q.zz
- Defined in Vec4.ts:1172

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 };
}
- Defined in Vec4.ts:1306

add

add(vector: V4Q): V4Q
Adds one vector to another.
Parameters
- vector: V4Q
  The vector to add to this one
Returns V4Q
Returns itself, modified

Chainable
Implementation of V4Q.add
- Defined in Vec4.ts:177

addNew

addNew(vector: V4Q): 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
Implementation of V4Q.addNew
- Defined in Vec4.ts:192

addScalar

addScalar(scalar: number): 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
Implementation of V4Q.addScalar
- Defined in Vec4.ts:204

addScalarNew

addScalarNew(scalar: number): 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
Implementation of V4Q.addScalarNew
- Defined in Vec4.ts:215

ceil

ceil(): V4Q
Returns V4Q
Implementation of V4Q.ceil
- Defined in Vec4.ts:676

ceilNew

ceilNew(): V4Q
Returns V4Q
Implementation of V4Q.ceilNew
- Defined in Vec4.ts:684

clone

clone(): V4Q
Clones the vector

Returns V4Q
The cloned vector
Implementation of V4Q.clone
- Defined in Vec4.ts:165

cross

cross(v: V4Q, w: V4Q): 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))
```
Implementation of V4Q.cross
- Defined in Vec4.ts:650

crossNew

crossNew(v: V4Q, w: V4Q): V4Q
Parameters
- v: V4Q
- w: V4Q
Returns V4Q
Implementation of V4Q.crossNew
- Defined in Vec4.ts:672

distance

distance(vector: V4Q): 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
Implementation of V4Q.distance
- Defined in Vec4.ts:572

distanceW

distanceW(vector: V4Q): 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
Implementation of V4Q.distanceW
- Defined in Vec4.ts:612

distanceX

distanceX(vector: V4Q): 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
Implementation of V4Q.distanceX
- Defined in Vec4.ts:582

distanceY

distanceY(vector: V4Q): 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
Implementation of V4Q.distanceY
- Defined in Vec4.ts:592

distanceZ

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

divide

divide(vector: V4Q): V4Q
Divides one vector by another.
Parameters
- vector: V4Q
  The vector to divide this by
Returns V4Q
Returns itself, modified

Chainable
Implementation of V4Q.divide
- Defined in Vec4.ts:277

divideNew

divideNew(vector: V4Q): 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
Implementation of V4Q.divideNew
- Defined in Vec4.ts:308

divideScalar

divideScalar(scalar: number): 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
Implementation of V4Q.divideScalar
- Defined in Vec4.ts:320

divideScalarNew

divideScalarNew(scalar: number): 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
Implementation of V4Q.divideScalarNew
- Defined in Vec4.ts:332

dot

dot(vector: V4Q): 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))
```
Implementation of V4Q.dot
- Defined in Vec4.ts:628

floor

floor(): V4Q
Returns V4Q
Implementation of V4Q.floor
- Defined in Vec4.ts:688

floorNew

floorNew(): V4Q
Returns V4Q
Implementation of V4Q.floorNew
- Defined in Vec4.ts:696

fract

fract(): V4Q
Returns V4Q
Implementation of V4Q.fract
- Defined in Vec4.ts:712

fractNew

fractNew(): V4Q
Returns V4Q
Implementation of V4Q.fractNew
- Defined in Vec4.ts:720

inverse

inverse(): V4Q
Inverses the vector.

Returns V4Q
Returns itself, modified

Chainable
Implementation of V4Q.inverse
- Defined in Vec4.ts:512

inverseNew

inverseNew(): V4Q
Clones the vector and then inverses it.

Returns V4Q
Returns itself, modified

Chainable
Implementation of V4Q.inverseNew
- Defined in Vec4.ts:527

multiply

multiply(vector: V4Q): V4Q
Multiplies one vector by another.
Parameters
- vector: V4Q
  The vector to multiply this by
Returns V4Q
Returns itself, modified

Chainable
Implementation of V4Q.multiply
- Defined in Vec4.ts:344

multiplyNew

multiplyNew(q: V4Q): V4Q
Clones the vector and multiplies it by the vector instead
Parameters
- q: V4Q
Returns V4Q
Returns the clone of itself, modified

Chainable
Implementation of V4Q.multiplyNew
- Defined in Vec4.ts:359

multiplyScalar

multiplyScalar(scalar: number): 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
Implementation of V4Q.multiplyScalar
- Defined in Vec4.ts:371

multiplyScalarNew

multiplyScalarNew(scalar: number): 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
Implementation of V4Q.multiplyScalarNew
- Defined in Vec4.ts:383

negate

negate(): V4Q
Negates the vector.

Returns V4Q
Returns itself, modified

Chainable
Implementation of V4Q.negate
- Defined in Vec4.ts:490

negateNew

negateNew(): V4Q
Clones the vector and negates it.

Returns V4Q
Returns itself, modified

Chainable
Implementation of V4Q.negateNew
- Defined in Vec4.ts:501

normalise

normalise(): V4Q
Normalises the vector down to a length of 1 unit

Returns V4Q
Returns itself, modified

Chainable
Implementation of V4Q.normalise
- Defined in Vec4.ts:543

normaliseNew

normaliseNew(): V4Q
Clones the vector and normalises it

Returns V4Q
Returns a clone of itself, modified

Chainable
Implementation of V4Q.normaliseNew
- Defined in Vec4.ts:562

reset

reset(...args: number[]): V4Q
Resets the vector coordinates
Parameters
- ...args: number[]
Returns V4Q
Chainable
Implementation of V4Q.reset
- Defined in Vec4.ts:129

resetToVector

resetToVector(v: V4Q): V4Q
Resets the vector coordinates to another vector object
Parameters
- v: V4Q
  The vector object to use to reset the coordinates
Returns V4Q
Chainable
Implementation of V4Q.resetToVector
- Defined in Vec4.ts:149

rotateX

rotateX(origin: V4Q, radian: number): V4Q
Parameters
- origin: V4Q
- radian: number
Returns V4Q
Implementation of V4Q.rotateX
- Defined in Vec4.ts:400

rotateXNew

rotateXNew(origin: V4Q, radian: number): V4Q
Parameters
- origin: V4Q
- radian: number
Returns V4Q
Implementation of V4Q.rotateXNew
- Defined in Vec4.ts:413

rotateY

rotateY(origin: V4Q, radian: number): V4Q
Parameters
- origin: V4Q
- radian: number
Returns V4Q
Implementation of V4Q.rotateY
- Defined in Vec4.ts:417

rotateYNew

rotateYNew(origin: V4Q, radian: number): V4Q
Parameters
- origin: V4Q
- radian: number
Returns V4Q
Implementation of V4Q.rotateYNew
- Defined in Vec4.ts:430

rotateZ

rotateZ(origin: V4Q, radian: number): V4Q
Parameters
- origin: V4Q
- radian: number
Returns V4Q
Implementation of V4Q.rotateZ
- Defined in Vec4.ts:434

rotateZNew

rotateZNew(origin: V4Q, radian: number): V4Q
Parameters
- origin: V4Q
- radian: number
Returns V4Q
Implementation of V4Q.rotateZNew
- Defined in Vec4.ts:447

round

round(): V4Q
Returns V4Q
Implementation of V4Q.round
- Defined in Vec4.ts:700

roundNew

roundNew(): V4Q
Returns V4Q
Implementation of V4Q.roundNew
- Defined in Vec4.ts:708

scale

scale(scalar: number): V4Q
Alias of Vector#multiplyScalar__anchor multiplyScalar
Parameters
- scalar: number
Returns V4Q
Implementation of V4Q.scale
- Defined in Vec4.ts:390

scaleNew

scaleNew(scalar: number): V4Q
Alias of Vector#multiplyScalarNew__anchor multiplyScalarNew
Parameters
- scalar: number
Returns V4Q
Implementation of V4Q.scaleNew
- Defined in Vec4.ts:396

subtract

subtract(vector: V4Q): V4Q
Subtracts one vector from another.
Parameters
- vector: V4Q
  The vector to subtract from this one
Returns V4Q
Returns itself, modified

Chainable
Implementation of V4Q.subtract
- Defined in Vec4.ts:227

subtractNew

subtractNew(vector: V4Q): 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
Implementation of V4Q.subtractNew
- Defined in Vec4.ts:242

subtractScalar

subtractScalar(scalar: number): 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
Implementation of V4Q.subtractScalar
- Defined in Vec4.ts:254

subtractScalarNew

subtractScalarNew(scalar: number): 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
Implementation of V4Q.subtractScalarNew
- Defined in Vec4.ts:265

transformByMat4

transformByMat4(m: Mat4Like): V4Q
Parameters
- m: Mat4Like
Returns V4Q
Implementation of V4Q.transformByMat4
- Defined in Vec4.ts:451

transformByMat4New

transformByMat4New(m: Mat4Like): V4Q
Parameters
- m: Mat4Like
Returns V4Q
Implementation of V4Q.transformByMat4New
- Defined in Vec4.ts:461

transformByQuat

transformByQuat(q: Vec4Like): V4Q
Parameters
- q: Vec4Like
Returns V4Q
Implementation of V4Q.transformByQuat
- Defined in Vec4.ts:465

transformByQuatNew

transformByQuatNew(q: Vec4Like): V4Q
Parameters
- q: Vec4Like
Returns V4Q
Implementation of V4Q.transformByQuatNew
- Defined in Vec4.ts:479

`Static`getAngle

getAngle(a: Vec4, b: Vec4): number
Parameters
- a: Vec4
- b: Vec4
Returns number
- Defined in Vec4.ts:1295

`Static`interpolate

interpolate(v: string | number | Vec4Like): Vec4
Iterpolates a provided anonymous value into a vew Vec4
Parameters
- v: string | number | Vec4Like
  The value to interpolate
Returns Vec4
out
- Defined in Vec4.ts:1256

`Static`lerp

lerp(v1: Vec4, v2: Vec4, d: number): Vec4
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
- Defined in Vec4.ts:1286