Class Vector2

A point in 2D space using a cartesian coordinate system. Includes extra methods for math and utility.

-X is left. +X is right. -Y is up. +Y is down.

Hierarchy

Vector2

Implements

Point

Index

Constructors

Properties

x y

Accessors

abs copy deg dist distSquared neg normalizationFactor normalized polar rad raw string down left random right up zero

Constructors

constructor

new Vector2(x?: number, y?: number): Vector2
Parameters
- x: number = 0
- y: number = 0
Returns Vector2
- Defined in lib/math/Vector2.ts:41

Properties

x

x: number

The x coordinate of a 2D point.

y

y: number

The y coordinate of a 2D point.

Accessors

abs

get abs(): Vector2
Takes the absolute value of the x and y of the Vector2. Creates a new Vector2 and does not modify the original Vector2.

Returns Vector2
- Defined in lib/math/Vector2.ts:297

copy

get copy(): Vector2
Returns a copy of the Vector2.

Returns Vector2
- Defined in lib/math/Vector2.ts:47

deg

get deg(): number
Returns the clockwise angle in degrees from the x-axis to the Vector2.

Returns number
- Defined in lib/math/Vector2.ts:67

dist

get dist(): number
Returns the distance from the origin to the Vector2.

Returns number
- Defined in lib/math/Vector2.ts:57

distSquared

get distSquared(): number
Returns the square of the distance from the origin to the Vector2. Faster than dist().

Returns number
- Defined in lib/math/Vector2.ts:52

neg

get neg(): Vector2
Negates the x and y of the Vector2. Creates a new Vector2 and does not modify the original Vector2.

Returns Vector2
- Defined in lib/math/Vector2.ts:287

normalizationFactor

get normalizationFactor(): number
The scale factor required to normalize the Vector2. Returns 1 if the distance from the origin is 0.

Returns number
- Defined in lib/math/Vector2.ts:170

normalized

get normalized(): Vector2
Normalizes the Vector2. Creates a new Vector2 and does not modify the original Vector2.

Returns Vector2
- Defined in lib/math/Vector2.ts:175

polar

get polar(): PolarCoordinate
Converts the Vector2 to a PolarCoordinate.

Returns PolarCoordinate
- Defined in lib/math/Vector2.ts:72

rad

get rad(): number
Returns the clockwise angle in radians from the x-axis to the Vector2.

Returns number
- Defined in lib/math/Vector2.ts:62

raw

get raw(): Point
Converts the Vector2 to just x and y coordinates.

Returns Point
- Defined in lib/math/Vector2.ts:227

string

get string(): string
Returns the string form of a Vector2 in the form (x, y). Same as toString().

Returns string
- Defined in lib/math/Vector2.ts:240

`Static` down

get down(): Vector2
Returns a new Vector2 at (0, 1)

Returns Vector2
- Defined in lib/math/Vector2.ts:272

`Static` left

get left(): Vector2
Returns a new Vector2 at (-1, 0)

Returns Vector2
- Defined in lib/math/Vector2.ts:277

`Static` random

get random(): Vector2
Returns a random Vector2 between (0, 0) (inclusive) and (1, 1) (exclusive).

Returns Vector2
- Defined in lib/math/Vector2.ts:222

`Static` right

get right(): Vector2
Returns a new Vector2 at (1, 0)

Returns Vector2
- Defined in lib/math/Vector2.ts:282

`Static` up

get up(): Vector2
Returns a new Vector2 at (0, -1)

Returns Vector2
- Defined in lib/math/Vector2.ts:267

`Static` zero

get zero(): Vector2
Returns a new Vector2 at (0, 0)

Returns Vector2
- Defined in lib/math/Vector2.ts:262

Methods

absAssign

absAssign(): Vector2
Takes the absolute value of the x and y of the Vector2. Modifies the original Vector2.

Returns Vector2
- Defined in lib/math/Vector2.ts:302

add

add(v: Point): Vector2
Adds a point to the Vector2. Creates a new Vector2 and does not modify the original Vector2.
Parameters
- v: Point
Returns Vector2
- Defined in lib/math/Vector2.ts:92

addAssign

addAssign(v: Point): Vector2
Adds a point to the Vector2. Modifies the original Vector2.
Parameters
- v: Point
Returns Vector2
- Defined in lib/math/Vector2.ts:97

degTo

degTo(v: Point): number
Returns the clockwise angle in degrees from the Vector2 to a point.
Parameters
- v: Point
Returns number
- Defined in lib/math/Vector2.ts:195

directionTo

directionTo(v: Point): Vector2
Returns a normalized Vector2 representing the direction from the Vector2 to a point.
Parameters
- v: Point
Returns Vector2
- Defined in lib/math/Vector2.ts:185

distSquaredTo

distSquaredTo(v: Point): number
Returns the square of the distance from the Vector2 to a point. Faster than distTo().
Parameters
- v: Point
Returns number
- Defined in lib/math/Vector2.ts:200

distTo

distTo(v: Point): number
Returns the distance from the Vector2 to a point.
Parameters
- v: Point
Returns number
- Defined in lib/math/Vector2.ts:207

dot

dot(v: Point): number
Returns the dot product of the Vector2 and a point.
Parameters
- v: Point
Returns number
- Defined in lib/math/Vector2.ts:250

negAssign

negAssign(): Vector2
Negates the x and y of the Vector2. Modifies the original Vector2.

Returns Vector2
- Defined in lib/math/Vector2.ts:292

normalize

normalize(): Vector2
Normalizes the Vector2. Modifies the original Vector2.

Returns Vector2
- Defined in lib/math/Vector2.ts:180

radTo

radTo(v: Point): number
Returns the clockwise angle in radians from the Vector2 to a point.
Parameters
- v: Point
Returns number
- Defined in lib/math/Vector2.ts:190

reset

reset(): Vector2
Sets the x and y coordinates of the Vector2 to 0.

Returns Vector2
- Defined in lib/math/Vector2.ts:255

rotate

rotate(rad: number): Vector2
Rotates the Vector2 around the origin by a clockwise angle in radians. Creates a new Vector2 and does not modify the original Vector2.
Parameters
- rad: number
Returns Vector2
- Defined in lib/math/Vector2.ts:128

rotateAround

rotateAround(p: Point, rad: number): Vector2
Rotates the Vector2 around another point by a clockwise angle in radians. Creates a new Vector2 and does not modify the original Vector2.
Parameters
- p: Point
- rad: number
Returns Vector2
- Defined in lib/math/Vector2.ts:150

rotateAroundAssign

rotateAroundAssign(p: Point, rad: number): Vector2
Rotates the Vector2 around another point by a clockwise angle in radians. Modifies the original Vector2.
Parameters
- p: Point
- rad: number
Returns Vector2
- Defined in lib/math/Vector2.ts:155

rotateAroundDeg

rotateAroundDeg(p: Point, deg: number): Vector2
Rotates the Vector2 around another point by a clockwise angle in degrees. Creates a new Vector2 and does not modify the original Vector2.
Parameters
- p: Point
- deg: number
Returns Vector2
- Defined in lib/math/Vector2.ts:160

rotateAroundDegAssign

rotateAroundDegAssign(p: Point, deg: number): Vector2
Rotates the Vector2 around another point by a clockwise angle in degrees. Modifies the original Vector2.
Parameters
- p: Point
- deg: number
Returns Vector2
- Defined in lib/math/Vector2.ts:165

rotateAssign

rotateAssign(rad: number): Vector2
Rotates the Vector2 around the origin by a clockwise angle in radians. Modifies the original Vector2.
Parameters
- rad: number
Returns Vector2
- Defined in lib/math/Vector2.ts:135

rotateDeg

rotateDeg(deg: number): Vector2
Rotates the Vector2 around the origin by a clockwise angle in degrees. Creates a new Vector2 and does not modify the original Vector2.
Parameters
- deg: number
Returns Vector2
- Defined in lib/math/Vector2.ts:140

rotateDegAssign

rotateDegAssign(deg: number): Vector2
Rotates the Vector2 around the origin by a clockwise angle in degrees. Modifies the original Vector2.
Parameters
- deg: number
Returns Vector2
- Defined in lib/math/Vector2.ts:145

scale

scale(f: number): Vector2
Scales the Vector2 by a scale factor. Creates a new Vector2 and does not modify the original Vector2.
Parameters
- f: number
Returns Vector2
- Defined in lib/math/Vector2.ts:116

scaleAssign

scaleAssign(f: number): Vector2
Scales the Vector2 by a scale factor. Modifies the original Vector2.
Parameters
- f: number
Returns Vector2
- Defined in lib/math/Vector2.ts:121

set

set(v: Point): Vector2
Sets the position of the Vector2 to another Vector2.
Parameters
- v: Point
Returns Vector2
- Defined in lib/math/Vector2.ts:85

sub

sub(v: Point): Vector2
Subtracts a point from the Vector2. Creates a new Vector2 and does not modify the original Vector2.
Parameters
- v: Point
Returns Vector2
- Defined in lib/math/Vector2.ts:104

subAssign

subAssign(v: Point): Vector2
Subtracts a point from the Vector2. Modifies the original Vector2.
Parameters
- v: Point
Returns Vector2
- Defined in lib/math/Vector2.ts:109

toString

toString(): string
Returns the string form of a Vector2 in the form (x, y). Same as the string property.

Returns string
- Defined in lib/math/Vector2.ts:245

towards

towards(dist: number, v: Point): Vector2
Moves the Vector2 towards another point by a specified distance. Creates a new Vector2 and does not modify the original Vector2.
Parameters
- dist: number
- v: Point
Returns Vector2
- Defined in lib/math/Vector2.ts:212

towardsAssign

towardsAssign(dist: number, v: Point): Vector2
Moves the Vector2 towards another point by a specified distance. Modifies the original Vector2.
Parameters
- dist: number
- v: Point
Returns Vector2
- Defined in lib/math/Vector2.ts:217

`Static` fromPolar

fromPolar(__namedParameters: PolarCoordinate): Vector2
Converts a PolarCoordinate into a Vector2.
Parameters
- __namedParameters: PolarCoordinate
Returns Vector2
- Defined in lib/math/Vector2.ts:80

`Static` fromRaw

fromRaw(__namedParameters: Point): Vector2
Converts a point to a Vector2.
Parameters
- __namedParameters: Point
Returns Vector2
- Defined in lib/math/Vector2.ts:235

Generated using TypeDoc