Class Vec2

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

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

Vec2

Author

Liam Egan liam@wethecollective.com

Version

1.0.0

Created

Jan 07, 2020

Constructors

constructor

new Vec2(...args: number[]): Vec2
Chainable
The Vector Class constructor
Parameters
- ...args: number[]
  The x and y coordinates
Returns Vec2
- Defined in Vec2.ts:24

Accessors

angle

get angle(): number
Returns number
- Defined in Vec2.ts:716
set angle(radian: number): void
(getter/setter) The angle of the vector, in radians
Parameters
- radian: number
Returns void
Default
```
0
```
- Defined in Vec2.ts:709

angleInDegrees

get angleInDegrees(): number
Returns number
- Defined in Vec2.ts:733
set angleInDegrees(degrees: number): void
(getter/setter) The angle of the vector, in radians
Parameters
- degrees: number
Returns void
Default
```
0
```
- Defined in Vec2.ts:726

area

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

Returns number
- Defined in Vec2.ts:769

array

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

Returns number[]
- Defined in Vec2.ts:794

height

get height(): number
Returns number
- Defined in Vec2.ts:759
set height(h: number): void
(getter/setter) Vector height. Alias of y
Parameters
- h: number
Returns void
- Defined in Vec2.ts:756

length

get length(): number
Returns number
- Defined in Vec2.ts:699
set length(length: number): void
(getter/setter) The length of the vector
Parameters
- length: number
Returns void
Default
```
0
```
- Defined in Vec2.ts:690

lengthSquared

get lengthSquared(): number
Returns number
- Defined in Vec2.ts:680
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
```
- Defined in Vec2.ts:671

slope

get slope(): number
Returns number
- Defined in Vec2.ts:784
set slope(value: number): void
(getter/setter) Vector slope.
Parameters
- value: number
Returns void
- Defined in Vec2.ts:778

width

get width(): number
Returns number
- Defined in Vec2.ts:746
set width(w: number): void
(getter/setter) Vector width. Alias of x
Parameters
- w: number
Returns void
- Defined in Vec2.ts:743

x

get x(): number
Returns number
- Defined in Vec2.ts:642
set x(x: number): void
Parameters
- x: number
Returns void
- Defined in Vec2.ts:635

xx

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

Returns Vec2
- Defined in Vec2.ts:833
set xx(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
- Defined in Vec2.ts:836

xy

get xy(): number[] | Vec2
(getter/sette) Swizzle XY

Returns number[] | Vec2
- Defined in Vec2.ts:803
set xy(v: number[] | Vec2): void
Parameters
- v: number[] | Vec2
Returns void
- Defined in Vec2.ts:806

y

get y(): number
Returns number
- Defined in Vec2.ts:660
set y(y: number): void
Parameters
- y: number
Returns void
- Defined in Vec2.ts:653

yx

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

Returns Vec2
- Defined in Vec2.ts:821
set yx(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
- Defined in Vec2.ts:824

yy

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

Returns Vec2
- Defined in Vec2.ts:846
set yy(v: Vec2Like): void
Parameters
- v: Vec2Like
Returns void
- Defined in Vec2.ts:849

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 Vec2.ts:927

add

add(vector: Vec2): Vec2
Chainable
Adds one vector to another.
Parameters
- vector: Vec2
  The vector to add to this one
Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:76

addNew

addNew(vector: Vec2): Vec2
Chainable
Clones the vector and adds the vector to it instead
Parameters
- vector: Vec2
  The vector to add to this one
Returns Vec2
Returns the clone of itself, modified
- Defined in Vec2.ts:89

addScalar

addScalar(scalar: number): Vec2
Chainable
Adds a scalar to the vector, modifying both the x and y
Parameters
- scalar: number
  The scalar to add to the vector
Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:101

addScalarNew

addScalarNew(scalar: number): Vec2
Chainable
Clones the vector and adds the scalar to it instead
Parameters
- scalar: number
  The scalar to add to the vector
Returns Vec2
Returns the clone of itself, modified
- Defined in Vec2.ts:112

ceil

ceil(): Vec2
Returns Vec2
- Defined in Vec2.ts:550

ceilNew

ceilNew(): Vec2
Returns Vec2
- Defined in Vec2.ts:556

clone

clone(): Vec2
Chainable
Clones the vector

Returns Vec2
The cloned vector
- Defined in Vec2.ts:64

cross

cross(vector: Vec2): number
Calculates the cross product between this and the supplied vector.
Parameters
- vector: Vec2
  The vector object against which to calculate the cross product
Returns number
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))
```
- Defined in Vec2.ts:546

det

det(vector: Vec2): number
Parameters
- vector: Vec2
Returns number
- Defined in Vec2.ts:525

distance

distance(vector: Vec2): number
Calculates the distance between this and the supplied vector
Parameters
- vector: Vec2
  The vector to calculate the distance from
Returns number
The distance between this and the supplied vector
- Defined in Vec2.ts:485

distanceX

distanceX(vector: Vec2): number
Calculates the distance on the X axis between this and the supplied vector
Parameters
- vector: Vec2
  The vector to calculate the distance from
Returns number
The distance, along the x axis, between this and the supplied vector
- Defined in Vec2.ts:495

distanceY

distanceY(vector: Vec2): number
Calculated the distance on the Y axis between this and the supplied vector
Parameters
- vector: Vec2
  The vector to calculate the distance from
Returns number
The distance, along the y axis, between this and the supplied vector
- Defined in Vec2.ts:505

divide

divide(vector: Vec2): Vec2
Chainable
Divides one vector by another.
Parameters
- vector: Vec2
  The vector to divide this by
Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:172

divideNew

divideNew(vector: Vec2): Vec2
Chainable
Clones the vector and divides it by the vector instead
Parameters
- vector: Vec2
  The vector to divide the clone by
Returns Vec2
Returns the clone of itself, modified
- Defined in Vec2.ts:193

divideScalar

divideScalar(scalar: number): Vec2
Chainable
Divides the vector by a scalar.
Parameters
- scalar: number
  The scalar to divide both x and y by
Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:205

divideScalarNew

divideScalarNew(scalar: number): Vec2
Chainable
Clones the vector and divides it by the provided scalar.
Parameters
- scalar: number
  The scalar to divide both x and y by
Returns Vec2
Returns the clone of itself, modified
- Defined in Vec2.ts:217

dot

dot(vector: Vec2): number
Calculates the dot product between this and a supplied vectorT
Parameters
- vector: Vec2
  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))
```
- Defined in Vec2.ts:521

floor

floor(): Vec2
Returns Vec2
- Defined in Vec2.ts:560

floorNew

floorNew(): Vec2
Returns Vec2
- Defined in Vec2.ts:566

fract

fract(): Vec2
Returns Vec2
- Defined in Vec2.ts:590

fractNew

fractNew(): Vec2
Returns Vec2
- Defined in Vec2.ts:596

inverse

inverse(): Vec2
Chainable
Inverses the vector.

Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:438

inverseNew

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

Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:451

mod

mod(vector: Vec2): Vec2
Parameters
- vector: Vec2
Returns Vec2
- Defined in Vec2.ts:580

modNew

modNew(vector: Vec2): Vec2
Parameters
- vector: Vec2
Returns Vec2
- Defined in Vec2.ts:586

multiply

multiply(vector: Vec2): Vec2
Chainable
Multiplies one vector by another.
Parameters
- vector: Vec2
  The vector to multiply this by
Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:229

multiplyNew

multiplyNew(vector: Vec2): Vec2
Chainable
Clones the vector and multiplies it by the vector instead
Parameters
- vector: Vec2
  The vector to multiply the clone by
Returns Vec2
Returns the clone of itself, modified
- Defined in Vec2.ts:242

multiplyScalar

multiplyScalar(scalar: number): Vec2
Chainable
Multiplies the vector by a scalar.
Parameters
- scalar: number
  The scalar to multiply both x and y by
Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:254

multiplyScalarNew

multiplyScalarNew(scalar: number): Vec2
Chainable
Clones the vector and multiplies it by the provided scalar.
Parameters
- scalar: number
  The scalar to multiply both x and y by
Returns Vec2
Returns the clone of itself, modified
- Defined in Vec2.ts:266

negate

negate(): Vec2
Chainable
Negates the vector.

Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:416

negateNew

negateNew(): Vec2
Chainable
Clones the vector and negates it.

Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:427

normalise

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

Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:465

normaliseNew

normaliseNew(): Vec2
Chainable
Clones the vector and normalises it

Returns Vec2
Returns a clone of itself, modified
- Defined in Vec2.ts:475

reset

reset(...args: number[]): Vec2
Chainable
Resets the vector coordinates
Parameters
- ...args: number[]
  The x and y coordinates
Returns Vec2
- Defined in Vec2.ts:35

resetToVector

resetToVector(v: Vec2): Vec2
Chainable
Resets the vector coordinates to another vector object
Parameters
- v: Vec2
  The vector object to use to reset the coordinates
Returns Vec2
- Defined in Vec2.ts:51

rotate

rotate(radian: number): Vec2
Chainable
Rotates a vecor by a given amount, provided in radians.
Parameters
- radian: number
  The angle, in radians, to rotate the vector by
Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:291

rotateBy

rotateBy(radian: number): Vec2
Alias of rotate
Parameters
- radian: number
Returns Vec2
- Defined in Vec2.ts:339

rotateByNew

rotateByNew(radian: number): Vec2
Alias of rotateNew
Parameters
- radian: number
Returns Vec2
- Defined in Vec2.ts:345

rotateDeg

rotateDeg(degrees: number): Vec2
Chainable
Rotates a vecor by a given amount, provided in degrees. Converts the degree value to radians and runs the rotaet method.
Parameters
- degrees: number
  The angle, in degrees, to rotate the vector by
Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:321

rotateDegBy

rotateDegBy(degrees: number): Vec2
Alias of rotateDeg
Parameters
- degrees: number
Returns Vec2
- Defined in Vec2.ts:352

rotateDegByNew

rotateDegByNew(radian: number): Vec2
Alias of rotateDegNew
Parameters
- radian: number
Returns Vec2
- Defined in Vec2.ts:358

rotateDegNew

rotateDegNew(degrees: number): Vec2
Chainable
Clones the vector and rotates it by the supplied degree value
Parameters
- degrees: number
  The angle, in degrees, to rotate the vector by
Returns Vec2
Returns the clone of itself, modified
- Defined in Vec2.ts:332

rotateNew

rotateNew(radian: number): Vec2
Chainable
Clones the vector and rotates it by the supplied radian value
Parameters
- radian: number
  The angle, in radians, to rotate the vector by
Returns Vec2
Returns the clone of itself, modified
- Defined in Vec2.ts:308

rotateTo

rotateTo(radian: number): Vec2
Chainable
Rotates a vector to a specific angle
Parameters
- radian: number
  The angle, in radians, to rotate the vector to
Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:370

rotateToDeg

rotateToDeg(degrees: number): Vec2
Chainable
Rotates a vecor to a given amount, provided in degrees. Converts the degree value to radians and runs the rotateTo method.
Parameters
- degrees: number
  The angle, in degrees, to rotate the vector to
Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:394

rotateToDegNew

rotateToDegNew(degrees: number): Vec2
Chainable
Clones the vector and rotates it to the supplied degree value
Parameters
- degrees: number
  The angle, in degrees, to rotate the vector to
Returns Vec2
Returns the clone of itself, modified
- Defined in Vec2.ts:405

rotateToNew

rotateToNew(radian: number): Vec2
Chainable
Clones the vector and rotates it to the supplied radian value
Parameters
- radian: number
  The angle, in radians, to rotate the vector to
Returns Vec2
Returns the clone of itself, modified
- Defined in Vec2.ts:381

round

round(): Vec2
Returns Vec2
- Defined in Vec2.ts:570

roundNew

roundNew(): Vec2
Returns Vec2
- Defined in Vec2.ts:576

scale

scale(scalar: number): Vec2
Alias of multiplyScalar
Parameters
- scalar: number
Returns Vec2
- Defined in Vec2.ts:273

scaleNew

scaleNew(scalar: number): Vec2
Alias of multiplyScalarNew
Parameters
- scalar: number
Returns Vec2
- Defined in Vec2.ts:279

slopeBetween

slopeBetween(vector: Vec2): number
Parameters
- vector: Vec2
Returns number
- Defined in Vec2.ts:529

subtract

subtract(vector: Vec2): Vec2
Chainable
Subtracts one vector from another.
Parameters
- vector: Vec2
  The vector to subtract from this one
Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:124

subtractNew

subtractNew(vector: Vec2): Vec2
Chainable
Clones the vector and subtracts the vector from it instead
Parameters
- vector: Vec2
  The vector to subtract from this one
Returns Vec2
Returns the clone of itself, modified
- Defined in Vec2.ts:137

subtractScalar

subtractScalar(scalar: number): Vec2
Chainable
Subtracts a scalar from the vector, modifying both the x and y
Parameters
- scalar: number
  The scalar to subtract from the vector
Returns Vec2
Returns itself, modified
- Defined in Vec2.ts:149

subtractScalarNew

subtractScalarNew(scalar: number): Vec2
Chainable
Clones the vector and subtracts the scalar from it instead
Parameters
- scalar: number
  The scalar to add to the vector
Returns Vec2
Returns the clone of itself, modified
- Defined in Vec2.ts:160

transformByMat2

transformByMat2(m: Mat2Like): Vec2
Parameters
- m: Mat2Like
Returns Vec2
- Defined in Vec2.ts:600

transformByMat2New

transformByMat2New(m: Mat2Like): Vec2
Parameters
- m: Mat2Like
Returns Vec2
- Defined in Vec2.ts:608

transformByMat3

transformByMat3(m: Mat3Like): Vec2
Parameters
- m: Mat3Like
Returns Vec2
- Defined in Vec2.ts:612

transformByMat3New

transformByMat3New(m: Mat3Like): Vec2
Parameters
- m: Mat3Like
Returns Vec2
- Defined in Vec2.ts:620

`Static`getAngle

getAngle(a: Vec2, b: Vec2): number
Finds the angle between 2 vectors.
Parameters
- a: Vec2
  the first operand
- b: Vec2
  the second operand
Returns number
- Defined in Vec2.ts:903

`Static`interpolate

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

`Static`lerp

lerp(v1: Vec2, v2: Vec2, d: number): Vec2
Performs a linear interpolation between two vec2's
Parameters
- v1: Vec2
  the first operand
- v2: Vec2
  the second operand
- d: number
  interpolation amount in the range of 0 - 1
Returns Vec2
- Defined in Vec2.ts:892