Class Vector2

classdesc: Creates a Vector2
description: The Vector2 Class. Represents a point
since: 2.0.0

Hierarchy

Vector2

Constructors

constructor

new Vector2(x?: number, y?: number): Vector2

- Defined in core/math/vector2.ts:19
description
Creates a Vector2 instance

since
2.0.0

Parameters
- x: number = 0
- y: number = 0
Returns Vector2

Properties

x

x: number = 0

y

y: number = 0

Accessors

Static DOWN

get DOWN(): Vector2

- Defined in core/math/vector2.ts:631
memberof
Vector2

static
description
Returns a Vector2 with 0 set as x and 1 set as y

since
2.0.0

Returns Vector2

Static LEFT

get LEFT(): Vector2

- Defined in core/math/vector2.ts:642
memberof
Vector2

static
description
Returns a Vector2 with -1 set as x and 0 set as y

since
2.0.0

Returns Vector2

Static RIGHT

get RIGHT(): Vector2

- Defined in core/math/vector2.ts:653
memberof
Vector2

static
description
Returns a Vector2 with 1 set as x and 0 set as y

since
2.0.0

Returns Vector2

Static UP

get UP(): Vector2

- Defined in core/math/vector2.ts:620
memberof
Vector2

static
description
Returns a Vector2 with 0 set as x and -1 set as y

since
2.0.0

Returns Vector2

Static ZERO

get ZERO(): Vector2

- Defined in core/math/vector2.ts:609
memberof
Vector2

static
description
Returns a Vector2 with 0 set as x and y

since
2.0.0

Returns Vector2

Methods

abs

abs(): Vector2

- Defined in core/math/vector2.ts:593
memberof
Vector2

description
Gets the absolute value of the vector

since
2.0.0

Returns Vector2

add

add(vector: Vector2): Vector2

- Defined in core/math/vector2.ts:55
memberof
Vector2

description
Adds a Vector2

since
2.0.0

Parameters
- vector: Vector2
  
  Vector2 to be added to
Returns Vector2

addNumber

addNumber(number: number): Vector2

- Defined in core/math/vector2.ts:68
memberof
Vector2

description
Adds a number to the x and y properties

since
2.0.0

Parameters
- number: number
  
  Number to add to x and y properties
Returns Vector2

angleBetween

angleBetween(vector: Vector2): number

- Defined in core/math/vector2.ts:171
memberof
Vector2

description
Gets the angle between two Vector2s

since
2.0.0

Parameters
- vector: Vector2
  
  A Vector2 to get the angle between from
Returns number

angleTo

angleTo(vector: Vector2): number

- Defined in core/math/vector2.ts:185
memberof
Vector2

description
Gets the angle to two Vector2s

since
2.0.0

Parameters
- vector: Vector2
  
  A Vector2 to get the angle to from
Returns number

clamp

clamp(min: number, max: number): Vector2

- Defined in core/math/vector2.ts:502
memberof
Vector2

description
Clamps the values to a min and max

since
2.0.0

Parameters
- min: number
  
  The min value
- max: number
  
  The max value
Returns Vector2

clampMax

clampMax(max: number): Vector2

- Defined in core/math/vector2.ts:534
memberof
Vector2

description
Clamps the values to a max

since
2.0.0

Parameters
- max: number
  
  The max value
Returns Vector2

clampMin

clampMin(min: number): Vector2

- Defined in core/math/vector2.ts:516
memberof
Vector2

description
Clamps the values to a min

since
2.0.0

Parameters
- min: number
  
  The min value
Returns Vector2

clone

clone(): Vector2

- Defined in core/math/vector2.ts:195
memberof
Vector2

description
Clones the current Vector2

since
2.0.0

Returns Vector2

crossProduct

crossProduct(vector: Vector2): number

- Defined in core/math/vector2.ts:245
memberof
Vector2

description
Gets the cross dot product with another Vector2

since
2.0.0

Parameters
- vector: Vector2
  
  A Vector2 to get the cross dot product from
Returns number

distance

distance(vector: Vector2): number

- Defined in core/math/vector2.ts:206
memberof
Vector2

description
Gets the distance from another Vector2

since
2.0.0

Parameters
- vector: Vector2
  
  A Vector2 to get the distance from
Returns number

distanceSqr

distanceSqr(vector: Vector2): number

- Defined in core/math/vector2.ts:220
memberof
Vector2

description
Gets the distance squared from another Vector2

since
2.0.0

Parameters
- vector: Vector2
  
  A Vector2 to get the distance from
Returns number

divide

divide(vector: Vector2): Vector2

- Defined in core/math/vector2.ts:133
memberof
Vector2

description
Divides a Vector2

since
2.0.0

Parameters
- vector: Vector2
  
  Vector2 to be divided to
Returns Vector2

divideNumber

divideNumber(number: number): Vector2

- Defined in core/math/vector2.ts:146
memberof
Vector2

description
Divides a number to the x and y properties

since
2.0.0

Parameters
- number: number
  
  Number to divide to x and y properties
Returns Vector2

dot

dot(vector: Vector2): number

- Defined in core/math/vector2.ts:234
memberof
Vector2

description
Gets the dot product with another Vector2

since
2.0.0

Parameters
- vector: Vector2
  
  A Vector2 to get the dot product from
Returns number

equals

equals(vector: Vector2): boolean

- Defined in core/math/vector2.ts:256
memberof
Vector2

description
Checks if another Vector2 is equal on both axises

since
2.0.0

Parameters
- vector: Vector2
  
  A Vector2 to compare with
Returns boolean

getNormal

getNormal(vector: Vector2, resultVector?: Vector2): Vector2

- Defined in core/math/vector2.ts:331
memberof
Vector2

description
Gets the normal value of the Vector2 and another Vector2

since
2.0.0

Parameters
- vector: Vector2
- Optional resultVector: Vector2
Returns Vector2

isZero

isZero(): boolean

- Defined in core/math/vector2.ts:344
memberof
Vector2

description
Determines if Vector2.x and Vector2.y are both equal to 0

since
2.0.0

Returns boolean

magnitude

magnitude(): number

- Defined in core/math/vector2.ts:381
memberof
Vector2

description
Returns the magnitude or length of the Vector2

since
2.0.0

Returns number

magnitudeSqr

magnitudeSqr(): number

- Defined in core/math/vector2.ts:391
memberof
Vector2

description
Returns the magnitude/lenth squared of the Vector2

since
2.0.0

Returns number

moveTowards

moveTowards(current: Vector2, target: Vector2, maxDistanceDelta: number): Vector2

- Defined in core/math/vector2.ts:281
memberof
Vector2

description
Gradually interpolates the Vector2 towards another Vector2 by an amount

since
2.0.0

Parameters
- current: Vector2
  
  The Current Vector
- target: Vector2
  
  The Target Vector2
- maxDistanceDelta: number
  
  The amount to increase by
Returns Vector2

multiply

multiply(vector: Vector2): Vector2

- Defined in core/math/vector2.ts:107
memberof
Vector2

description
Multiplies a Vector2

since
2.0.0

Parameters
- vector: Vector2
  
  Vector2 to be multiplied to
Returns Vector2

multiplyNumber

multiplyNumber(number: number): Vector2

- Defined in core/math/vector2.ts:120
memberof
Vector2

description
Multiplies a number to the x and y properties

since
2.0.0

Parameters
- number: number
  
  Number to multiply to x and y properties
Returns Vector2

negate

negate(): Vector2

- Defined in core/math/vector2.ts:368
memberof
Vector2

description
Sets Vector2.x and Vector2.y to their negative values

since
2.0.0

Returns Vector2

normalize

normalize(): Vector2

- Defined in core/math/vector2.ts:313
memberof
Vector2

description
Normalizes the Vector2

since
2.0.0

Returns Vector2

perpendicular

perpendicular(resultVector?: Vector2): Vector2

- Defined in core/math/vector2.ts:267
memberof
Vector2

description
Gets the perpendicular values of the Vector2

since
2.0.0

Parameters
- Optional resultVector: Vector2
Returns Vector2

reflect

reflect(): Vector2

- Defined in core/math/vector2.ts:580
memberof
Vector2

description
Reflects the Vector2, returns the opposite value on a number line

example
new Vector2(100, 50).reflect() // Vector2(-100, -50)

since
2.0.0

Returns Vector2

rotate

rotate(degrees: number, center?: Vector2): Vector2

- Defined in core/math/vector2.ts:553
memberof
Vector2

description
Rotates the Vector2 based on degrees

since
2.0.0

Parameters
- degrees: number
  
  The angle in degrees
- center: Vector2 = Vector2.ZERO
Returns Vector2

round

round(): Vector2

- Defined in core/math/vector2.ts:158
memberof
Vector2

description
Rounds the Vector2

since
2.0.0

Returns Vector2

scale

scale(scalar: Vector2): Vector2

- Defined in core/math/vector2.ts:355
memberof
Vector

description
Scales the Vector2 by a scalar Vector2

since
2.0.0

Parameters
- scalar: Vector2
  
  A Vector2 that is used to scale the current Vector2
Returns Vector2

scaleToMagnitude

scaleToMagnitude(magnitude: number): Vector2

- Defined in core/math/vector2.ts:402
memberof
Vector2

description
Scales the Vector2 by the magnitude or length

since
2.0.0

Parameters
- magnitude: number
  
  The magnitude or length of the Vector2
Returns Vector2

setValues

setValues(x: number, y: number): Vector2

- Defined in core/math/vector2.ts:29
memberof
Vector2

description
Sets the values of the Vector2

since
2.0.0

Parameters
- x: number
  
  X position to setValue of
- y: number
  
  Y position to setValue of
Returns Vector2

setValuesVec

setValuesVec(vector: Vector2): Vector2

- Defined in core/math/vector2.ts:42
memberof
Vector2

description
Sets the values of the Vector2 based on another Vector2

since
2.0.0

Parameters
- vector: Vector2
  
  Vector2 to use to set the position
Returns Vector2

subtract

subtract(vector: Vector2): Vector2

- Defined in core/math/vector2.ts:81
memberof
Vector2

description
Subtracts a Vector2

since
2.0.0

Parameters
- vector: Vector2
  
  Vector2 to be subtracted to
Returns Vector2

subtractNumber

subtractNumber(number: number): Vector2

- Defined in core/math/vector2.ts:94
memberof
Vector2

description
Subtracts a number from the x and y properties

since
2.0.0

Parameters
- number: number
  
  Number to subtract from x and y properties
Returns Vector2

toPrecision

toPrecision(precision: number): Vector2

- Defined in core/math/vector2.ts:427
memberof
Vector2

description
Sets the values to be precise by using Number.toPrecision

since
2.0.0

Parameters
- precision: number
  
  The precision
Returns Vector2

toString

toString(): string

- Defined in core/math/vector2.ts:416
memberof
Vector2

description
Returns the string version of the Vector2

example
console.log(new Vector2(0, 0).toString()) // Vector2(0, 0)

since
2.0.0

Returns string

translate

translate(dx: number, dy: number): Vector2

- Defined in core/math/vector2.ts:442
memberof
Vector2

description
Adds to the Vector2 by an amount

since
2.0.0

Parameters
- dx: number
  
  Delta x, the amount to increase the x value by
- dy: number
  
  Delta y, the amount to increase the y value by
Returns Vector2

translateX

translateX(dx: number): Vector2

- Defined in core/math/vector2.ts:455
memberof
Vector2

description
Adds to the Vector2.x by an amount

since
2.0.0

Parameters
- dx: number
  
  Delta x, the amount to increase the x value by
Returns Vector2

translateY

translateY(dy: number): Vector2

- Defined in core/math/vector2.ts:467
memberof
Vector2

description
Adds to the Vector2.y by an amount

since
2.0.0

Parameters
- dy: number
  
  Delta y, the amount to increase the y value by
Returns Vector2

tripleProduct

tripleProduct(a: Vector2, b: Vector2, c: Vector2, resultVector?: Vector2): Vector2

- Defined in core/math/vector2.ts:482
memberof
Vector2

description
Gets the dot product using three different Vector2s

since
2.0.0

Parameters
- a: Vector2
  
  A Vector2
- b: Vector2
  
  A Vector2
- c: Vector2
  
  A Vector2
- Optional resultVector: Vector2
Returns Vector2

Static CREATE

CREATE(x?: number, y?: number): Vector2

- Defined in core/math/vector2.ts:666
memberof
Vector2

static
description
Returns a Vector2 with passed parameters, if no parameters are passed, a Vector2.ZERO is returned

since
2.0.0

Parameters
- Optional x: number
- Optional y: number
Returns Vector2

Static fromVec

fromVec(vector: Vector2): Vector2

- Defined in core/math/vector2.ts:708
memberof
Vector2

static
description
Returns a Vector2 with values from a passed Vector2

since
2.0.0

Parameters
- vector: Vector2
  
  Vector2 to create a Vector2 from
Returns Vector2

Static fromVector2Like

fromVector2Like(vector2Like: Vector2Like): Vector2

- Defined in core/math/vector2.ts:681
memberof
Vector2

static
description
Returns a Vector2 with passed vector2Like object

since
2.0.0

Parameters
- vector2Like: Vector2Like
  
  An object with x and y properties
Returns Vector2

Static toVector2Like

toVector2Like(vector2: Vector2): { x: number; y: number }

- Defined in core/math/vector2.ts:693
memberof
Vector2

static
description
Returns a Vector2Like object with passed Vector2

since
2.0.0

Parameters
- vector2: Vector2
  
  A Vector2 to convert to Vector2Like object
Returns { x: number; y: number }
- x: number
- y: number

Generated using TypeDoc