Class Vector2

The Vector2 implements a fixed-size two-dimensional vector. The class follows the 'copy-on-write' pattern, which means that every operation such as Vector2#normalized or Vector2.add returns a copy of the vector with updates values. It also implies that the values of the vector cannot be directly modified.

The concept of immutability improves sharing of objects as all types in TypeScript are assigned by identity, instead of by-value (e.g. a copy) as in other programming languages like C.

Constructors

constructor

new Vector2(x?: number, y?: number): Vector2
Parameters
- Optionalx: number
- Optionaly: number
Returns Vector2

Inherited from Vector2Generated.constructor

Properties

`Protected`_x

_x: number

`Protected`_y

_y: number

`Static` `Readonly`one

one: Immutable<Vector2>

A Vector with all components set to one.

`Static` `Readonly`xAxis

xAxis: Immutable<Vector2>

A Vector with the X component set to one and the Y set to zero.

`Static` `Readonly`yAxis

yAxis: Immutable<Vector2>

A Vector with the Y component set to one and the X set to zero.

`Static` `Readonly`zero

zero: Immutable<Vector2>

A Vector with all components set to zero.

Accessors

elementCount

get elementCount(): number

Gets the number of elements in this vector.

Returns number

isZero

get isZero(): boolean

Determines all elements of the vector are zero.

Returns boolean

x

get x(): number

Returns number

Inherited from Vector2Generated.x
set x(value: number): void
Parameters
- value: number
Returns void

Inherited from Vector2Generated.x

y

get y(): number

Returns number

Inherited from Vector2Generated.y
set y(value: number): void
Parameters
- value: number
Returns void

Inherited from Vector2Generated.y

Methods

add

add(rhs: Immutable<Vector2>): Vector2
Returns a copy of the current vector added by the given one.
Parameters
- rhs: Immutable<Vector2>
Returns Vector2

addComponents

addComponents(x: number, y: number): Vector2
Returns a copy of the current vector with the given scalars added to the components.
Parameters
- x: number
- y: number
Returns Vector2

addScalar

addScalar(rhs: number): Vector2
Returns a copy of the current vector added by the given scalar.
Parameters
- rhs: number
Returns Vector2

assign

assign(other: Immutable<Vector2>): Vector2
Copies all properties defined by the prototype of Vector2 from other to this instance.
Parameters
- other: Immutable<Vector2>
Returns Vector2

Inherited from Vector2Generated.assign

clone

clone(): Vector2

Clones this instance and returns a new Vector2 with identical values.

Returns Vector2

Inherited from Vector2Generated.clone

cross

cross(other: Immutable<Vector2>): number
Calculates the cross product between this and the other vector.
Parameters
- other: Immutable<Vector2>
  Second two dimensional vector.
Returns number
Cross product between two vectors.

directionTo

directionTo(position: Immutable<Vector2>): Vector2
Returns a normalized direction vector from this instance to position.
Parameters
- position: Immutable<Vector2>
Returns Vector2

distanceTo

distanceTo(position: Immutable<Vector2>): number
Returns the distance to position.
Parameters
- position: Immutable<Vector2>
Returns number

divide

divide(rhs: Immutable<Vector2>): Vector2
Returns a copy of the current vector divided by another vector.
Parameters
- rhs: Immutable<Vector2>
Returns Vector2

divideScalar

divideScalar(factor: number): Vector2
Returns a copy of the current vector divided by a factor.
Parameters
- factor: number
Returns Vector2

doAdd

doAdd(rhs: Immutable<Vector2>): Vector2
Adds another vector to this instance and returns it.
Parameters
- rhs: Immutable<Vector2>
Returns Vector2

doAddComponents

doAddComponents(x: number, y: number): Vector2
Adds the given scalars to the components of this instance.
Parameters
- x: number
- y: number
Returns Vector2

doAddScalar

doAddScalar(value: number): Vector2
Adds a scalar from this instance and returns it.
Parameters
- value: number
Returns Vector2

doClear

doClear(): Vector2

Clears all elements of the vector to zero.

Returns Vector2

doDivide

doDivide(rhs: Immutable<Vector2>): Vector2
Divides this vector by another vector.
Parameters
- rhs: Immutable<Vector2>
Returns Vector2

doDivideScalar

doDivideScalar(factor: number): Vector2
Divides this vector by a factor.
Parameters
- factor: number
Returns Vector2

doMax

doMax(rhs: Immutable<Vector2>): Vector2
Selects the maximum element of both vectors and assigns it, performed element-wise.
Parameters
- rhs: Immutable<Vector2>
Returns Vector2

doMin

doMin(rhs: Immutable<Vector2>): Vector2
Selects the minimum element of both vectors and assigns it, performed element-wise.
Parameters
- rhs: Immutable<Vector2>
Returns Vector2

doMultiply

doMultiply(rhs: Immutable<Vector2>): Vector2
Performs component-wise multiplication with another vector.
Parameters
- rhs: Immutable<Vector2>
Returns Vector2

doMultiplyScalar

doMultiplyScalar(factor: number): Vector2
Performs scalar multiplication of this vector and returns it.
Parameters
- factor: number
Returns Vector2

doNormalize

doNormalize(): number

Normalizes the vector.

Returns number

doRoundToMultiple

doRoundToMultiple(multiple: number): Vector2
Rounds the vector to the nearest multiple.
Parameters
- multiple: number
  Multiple to round to.
Returns Vector2
This instance.

Note
This is a helpful utility to quickly snap an position to a specic grid size.

doSubtract

doSubtract(rhs: Immutable<Vector2>): Vector2
Subtracts another vector from this instance and returns it.
Parameters
- rhs: Immutable<Vector2>
Returns Vector2

doSubtractScalar

doSubtractScalar(value: number): Vector2
Subtracts a scalar from this instance and returns it.
Parameters
- value: number
Returns Vector2

dot

dot(other: Immutable<Vector2>): number
Calculates the inner product of this and the other vector.
Parameters
- other: Immutable<Vector2>
  Second two dimensional vector.
Returns number
Inner product between the two vectors.

eval

eval(fnExpression: () => number): Vector2
Evaluates the expression and assigns it to the vector.
Parameters
- fnExpression: () => number
  The expression to evaluate.
Returns Vector2
A reference to this vector

Note
Make sure to read up on how Vector expressions work in Typescript.

See
MathEx.eval for detailed documentation, limitations and considerations.

getAbsoluteMaximumElement

getAbsoluteMaximumElement(): number

Gets the maximum absolute element.

Returns number

getElementAtIndex

getElementAtIndex(index: number): number
Accesses a specific component of the vector.
Parameters
- index: number
  Index of the component.
Returns number
Value of the specific component.

getMaximumElement

getMaximumElement(): number

Gets the maximum element (non absolute).

Returns number

isAlmostEqual

isAlmostEqual(rhs: Immutable<Vector2>, epsilon?: number): boolean
Returns whether the provided vector, given a error margin, has the same vector components values as this one.
Parameters
- rhs: Immutable<Vector2>
  The other Vector2 to compare with.
- Optionalepsilon: number
  Optional. Error margin within which the numbers should be considered equal.
Returns boolean
True if equal, false otherwise.

isEqual

isEqual(rhs: Immutable<Vector2>): boolean
Returns whether the given vector contains the same vector components values as this one.
Parameters
- rhs: Immutable<Vector2>
Returns boolean

Overrides Vector2Generated.isEqual

length

length(): number

Returns the length of the vector.

Returns number

lengthSquared

lengthSquared(): number

Returns the squared length of the vector.

Returns number

multiply

multiply(rhs: Immutable<Vector2>): Vector2
Returns a copy of the current vector multiplied by the given vector.
Parameters
- rhs: Immutable<Vector2>
Returns Vector2

multiplyScalar

multiplyScalar(factor: number): Vector2
Returns a copy of this vector multiplied by the factor.
Parameters
- factor: number
Returns Vector2

normalized

normalized(): Vector2

Returns a normalized copy of the vector.

Returns Vector2

perpendicular

perpendicular(clockwise: boolean): Vector2
Returns an perpendicual vector rotated clockwise or counterclockwise.
Parameters
- clockwise: boolean
Returns Vector2

roundedToMultiple

roundedToMultiple(multiple: number): Vector2
Returns a copy of the vector rounded to the nearest multiple.
Parameters
- multiple: number
  Multiple to round to.
Returns Vector2
This instance.

Note
This is a helpful utility to quickly snap an position to a specic grid size.

setElementAtIndex

setElementAtIndex(index: number, value: number): void
Sets the value of the vector component at the given index.
Parameters
- index: number
- value: number
Returns void

setValues

setValues(x: number, y: number): void
Assigns the specified values.
Parameters
- x: number
- y: number
Returns void

subtract

subtract(rhs: Immutable<Vector2>): Vector2
Returns a copy of the current vector subtracted by the given vector.
Parameters
- rhs: Immutable<Vector2>
Returns Vector2

subtractScalar

subtractScalar(rhs: number): Vector2
Returns a copy of the current vector subtracted by the given scalar.
Parameters
- rhs: number
Returns Vector2

toArray

toArray(): [number, number]

Converts this instance to an array with 2 elements.

Returns [number, number]

toString

toString(): string

Returns a string representation of an object.

Returns string

`Static`add

add(lhs: Immutable<Vector2>, rhs: Immutable<Vector2>): Vector2
Adds two vectors together.
Parameters
- lhs: Immutable<Vector2>
- rhs: Immutable<Vector2>
Returns Vector2

`Static`addComponents

addComponents(vector: Vector2, x: number, y: number): Vector2
Adds the given scalars to the components of the vector.
Parameters
- vector: Vector2
- x: number
- y: number
Returns Vector2

`Static`addScalar

addScalar(lhs: Immutable<Vector2>, rhs: number): Vector2
Adds a scalar to each element of the vector.
Parameters
- lhs: Immutable<Vector2>
- rhs: number
Returns Vector2

`Static`cross

cross(lhs: Immutable<Vector2>, rhs: Immutable<Vector2>): number
Calculates the cross product of the two vectors.
Parameters
- lhs: Immutable<Vector2>
  First two dimensional vector.
- rhs: Immutable<Vector2>
  Second two dimensional vector.
Returns number
Cross product between the two vectors.

`Static`distance

distance(lhs: Immutable<Vector2>, rhs: Immutable<Vector2>): number
Calculates the distance between two points.
Parameters
- lhs: Immutable<Vector2>
  First two dimensional point.
- rhs: Immutable<Vector2>
  Second two dimensional point.
Returns number
Distance between the two points.

`Static`divide

divide(lhs: Immutable<Vector2>, rhs: Immutable<Vector2>): Vector2
Divides the first vector by the second.
Parameters
- lhs: Immutable<Vector2>
- rhs: Immutable<Vector2>
Returns Vector2

`Static`divideScalar

divideScalar(lhs: Immutable<Vector2>, factor: number): Vector2
Divides the given vector by a factor.
Parameters
- lhs: Immutable<Vector2>
- factor: number
Returns Vector2

`Static`dot

dot(lhs: Immutable<Vector2>, rhs: Immutable<Vector2>): number
Calculates the inner product of the two vectors.
Parameters
- lhs: Immutable<Vector2>
  First two dimensional vector.
- rhs: Immutable<Vector2>
  Second two dimensional vector.
Returns number
Inner product between the two vectors.

`Static`isAlmostEqual

isAlmostEqual(
    lhs: Immutable<Vector2>,
    rhs: Immutable<Vector2>,
    epsilon?: number,
): boolean
Compares two 2D vectors with an error margin.
Parameters
- lhs: Immutable<Vector2>
  First vector to compare.
- rhs: Immutable<Vector2>
  Second vector to compare.
- Optionalepsilon: number
  Optional. Error margin within which the numbers should be considered equal.
Returns boolean
True if equal, false otherwise.

`Static`isEqual

isEqual(lhs: Immutable<Vector2>, rhs: Immutable<Vector2>): boolean
Determines if both vectors are element-wise equal.
Parameters
- lhs: Immutable<Vector2>
- rhs: Immutable<Vector2>
Returns boolean

Overrides Vector2Generated.isEqual

`Static`lerp

lerp(a: Immutable<Vector2>, b: Immutable<Vector2>, t: number): Vector2
Linearly interpolates between two values.
Parameters
- a: Immutable<Vector2>
  Starting value to interpolate from.
- b: Immutable<Vector2>
  Ending value to interpolate towards.
- t: number
  Interpolation factor in specified range.
Returns Vector2
Interpolated vector.

`Static`manhattanDistance

manhattanDistance(lhs: Immutable<Vector2>, rhs: Immutable<Vector2>): number
Calculates the manhattan distance between two points.
Parameters
- lhs: Immutable<Vector2>
  First two dimensional point.
- rhs: Immutable<Vector2>
  Second two dimensional point.
Returns number
Manhattan distance between the two points.

`Static`max

max(lhs: Immutable<Vector2>, rhs: Immutable<Vector2>): Vector2
Returns the maximum of all the vector components as a new vector.
Parameters
- lhs: Immutable<Vector2>
  First vector.
- rhs: Immutable<Vector2>
  Second vector.
Returns Vector2
Vector consisting of maximum components of the first and second vector.

`Static`min

min(lhs: Immutable<Vector2>, rhs: Immutable<Vector2>): Vector2
Returns the minimum of all the vector components as a new vector.
Parameters
- lhs: Immutable<Vector2>
  First vector.
- rhs: Immutable<Vector2>
  Second vector.
Returns Vector2
Vector consisting of minimum components of the first and second vector.

`Static`multiply

multiply(lhs: Immutable<Vector2>, rhs: Immutable<Vector2>): Vector2
Multiplies both vectors.
Parameters
- lhs: Immutable<Vector2>
- rhs: Immutable<Vector2>
Returns Vector2

`Static`multiplyScalar

multiplyScalar(lhs: Immutable<Vector2>, factor: number): Vector2
Multiply the vector by the scalar.
Parameters
- lhs: Immutable<Vector2>
- factor: number
Returns Vector2

`Static`subtract

subtract(lhs: Immutable<Vector2>, rhs: Immutable<Vector2>): Vector2
Subtract both vectors.
Parameters
- lhs: Immutable<Vector2>
- rhs: Immutable<Vector2>
Returns Vector2

`Static`subtractScalar

subtractScalar(lhs: Immutable<Vector2>, rhs: number): Vector2
Subtracts a scalar from each element of the vector.
Parameters
- lhs: Immutable<Vector2>
- rhs: number
Returns Vector2

Class Vector2

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Vector2

Properties

Protected_x

Protected_y

Static Readonlyone

Static ReadonlyxAxis

Static ReadonlyyAxis

Static Readonlyzero

Accessors

elementCount

Returns number

isZero

Returns boolean

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

Methods

add

Parameters

Returns Vector2

addComponents

Parameters

Returns Vector2

addScalar

Parameters

Returns Vector2

assign

Parameters

Returns Vector2

clone

Returns Vector2

cross

Parameters

Returns number

directionTo

Parameters

Returns Vector2

distanceTo

Parameters

Returns number

divide

Parameters

Returns Vector2

divideScalar

Parameters

Returns Vector2

doAdd

Parameters

Returns Vector2

doAddComponents

Parameters

Returns Vector2

doAddScalar

Parameters

Returns Vector2

doClear

Returns Vector2

doDivide

Parameters

Returns Vector2

doDivideScalar

Parameters

Returns Vector2

doMax

Parameters

Returns Vector2

`Protected`_x

`Protected`_y

`Static` `Readonly`one

`Static` `Readonly`xAxis

`Static` `Readonly`yAxis

`Static` `Readonly`zero