Class Vec2

Really basic 2D vector class used for vector calculations

See

Index

Constructors

Properties

Accessors

x y

Methods

_onChangeCallback? onChange set add addScalar sub subScalar multiply multiplyScalar divide divideScalar copy clone max min clamp equals lengthSq length normalize dot lerp

Constructors

constructor

new Vec2(x?, y?): Vec2
Vec2 constructor
Parameters
- x: number = 0
  X component of our Vec2
- y: number = x
  Y component of our Vec2
Returns Vec2
- Defined in src/math/Vec2.ts:22

Properties

type

type: string

The type of the Vec2

`Private` _x

_x: number

X component of our Vec2

`Private` _y

_y: number

Y component of our Vec2

Accessors

x

get x(): number
Get the X component of the Vec2

Returns number
- Defined in src/math/Vec2.ts:32
set x(value): void
Set the X component of the Vec2 Can trigger onChange callback
Parameters
- value: number
  X component to set
Returns void
- Defined in src/math/Vec2.ts:41

y

get y(): number
Get the Y component of the Vec2

Returns number
- Defined in src/math/Vec2.ts:50
set y(value): void
Set the Y component of the Vec2 Can trigger onChange callback
Parameters
- value: number
  Y component to set
Returns void
- Defined in src/math/Vec2.ts:59

Methods

`Optional` _onChangeCallback

_onChangeCallback(): void
function assigned to the onChange callback

Returns void
- Defined in src/math/Vec2.ts:15

onChange

onChange(callback): Vec2
Called when at least one component of the Vec2 has changed
Parameters
- callback: (() => void)
  callback to run when at least one component of the Vec2 has changed
  - - (): void
    - Returns void
Returns Vec2
- our Vec2
- Defined in src/math/Vec2.ts:70

set

set(x?, y?): Vec2
Set the Vec2 from values
Parameters
- x: number = 0
  new X component to set
- y: number = x
  new Y component to set
Returns Vec2
- this Vec2 after being set
- Defined in src/math/Vec2.ts:84

add

add(vector?): Vec2
Add a Vec2 to this Vec2
Parameters
- vector: Vec2 = ...
  Vec2 to add
Returns Vec2
- this Vec2 after addition
- Defined in src/math/Vec2.ts:96

addScalar

addScalar(value?): Vec2
Add a scalar to all the components of this Vec2
Parameters
- value: number = 0
  number to add
Returns Vec2
- this Vec2 after addition
- Defined in src/math/Vec2.ts:108

sub

sub(vector?): Vec2
Subtract a Vec2 from this Vec2
Parameters
- vector: Vec2 = ...
  Vec2 to subtract
Returns Vec2
- this Vec2 after subtraction
- Defined in src/math/Vec2.ts:120

subScalar

subScalar(value?): Vec2
Subtract a scalar to all the components of this Vec2
Parameters
- value: number = 0
  number to subtract
Returns Vec2
- this Vec2 after subtraction
- Defined in src/math/Vec2.ts:132

multiply

multiply(vector?): Vec2
Multiply a Vec2 with this Vec2
Parameters
- vector: Vec2 = ...
  Vec2 to multiply with
Returns Vec2
- this Vec2 after multiplication
- Defined in src/math/Vec2.ts:144

multiplyScalar

multiplyScalar(value?): Vec2
Multiply all components of this Vec2 with a scalar
Parameters
- value: number = 1
  number to multiply with
Returns Vec2
- this Vec2 after multiplication
- Defined in src/math/Vec2.ts:156

divide

divide(vector?): Vec2
Divide a Vec2 with this Vec2
Parameters
- vector: Vec2 = ...
  Vec2 to divide with
Returns Vec2
- this Vec2 after division
- Defined in src/math/Vec2.ts:168

divideScalar

divideScalar(value?): Vec2
Divide all components of this Vec2 with a scalar
Parameters
- value: number = 1
  number to divide with
Returns Vec2
- this Vec2 after division
- Defined in src/math/Vec2.ts:180

copy

copy(vector?): Vec2
Copy a Vec2 into this Vec2
Parameters
- vector: Vec2 = ...
  Vec2 to copy
Returns Vec2
- this Vec2 after copy
- Defined in src/math/Vec2.ts:192

clone

clone(): Vec2
Clone this Vec2

Returns Vec2
- cloned Vec2
- Defined in src/math/Vec2.ts:203

max

max(vector?): Vec2
Apply max values to this Vec2 components
Parameters
- vector: Vec2 = ...
  Vec2 representing max values
Returns Vec2
- Vec2 with max values applied
- Defined in src/math/Vec2.ts:212

min

min(vector?): Vec2
Apply min values to this Vec2 components
Parameters
- vector: Vec2 = ...
  Vec2 representing min values
Returns Vec2
- Vec2 with min values applied
- Defined in src/math/Vec2.ts:224

clamp

clamp(min?, max?): Vec2
Clamp this Vec2 components by min and max Vec2 vectors
Parameters
- min: Vec2 = ...
  minimum Vec2 components to compare with
- max: Vec2 = ...
  maximum Vec2 components to compare with
Returns Vec2
- clamped Vec2
- Defined in src/math/Vec2.ts:237

equals

equals(vector?): boolean
Check if 2 Vec2 are equal
Parameters
- vector: Vec2 = ...
  Vec2 to compare
Returns boolean
- whether the Vec2 are equals or not
- Defined in src/math/Vec2.ts:249

lengthSq

lengthSq(): number
Get the square length of this Vec2

Returns number
- square length of this Vec2
- Defined in src/math/Vec2.ts:257

length

length(): number
Get the length of this Vec2

Returns number
- length of this Vec2
- Defined in src/math/Vec2.ts:265

normalize

normalize(): Vec2
Normalize this Vec2

Returns Vec2
- normalized Vec2
- Defined in src/math/Vec2.ts:273

dot

dot(vector?): number
Calculate the dot product of 2 Vec2
Parameters
- vector: Vec2 = ...
  Vec2 to use for dot product
Returns number
- dot product of the 2 Vec2
- Defined in src/math/Vec2.ts:290

lerp

lerp(vector?, alpha?): Vec2
Calculate the linear interpolation of this Vec2 by given Vec2 and alpha, where alpha is the percent distance along the line
Parameters
- vector: Vec2 = ...
  Vec2 to interpolate towards
- Optional alpha: number = 1
  interpolation factor in the [0, 1] interval
Returns Vec2
- this Vec2 after linear interpolation
- Defined in src/math/Vec2.ts:300