Vector2 | the-billeh

Representation of two dimensional vectors and points.

Hierarchy

Vector2

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

Constructs a new 2D vector.

example

let v = new Vector2();     // v = [0, 0]
let v = new Vector2(1);    // v = [1, 0]
let v = new Vector2(2, 3); // v = [2, 3]

Parameters

x: number = 0

X component.
y: number = 0

Y component.

Returns Vector2

Properties

x

x: number

X component.

y

y: number

Y component.

Static Readonly down

down: Vector2 = ...

Shorthand for typing new Vector(0, -1).

Static Readonly left

left: Vector2 = ...

Shorthand for typing new Vector(-1, 0).

Static Readonly one

one: Vector2 = ...

Shorthand for typing new Vector(1, 1).

Static Readonly right

right: Vector2 = ...

Shorthand for typing new Vector(1, 0).

Static Readonly up

up: Vector2 = ...

Shorthand for typing new Vector(0, 1).

Static Readonly zero

zero: Vector2 = ...

Shorthand for typing new Vector(0, 0).

Methods

magnitude

magnitude(): number

- Defined in math/vector.ts:115
Returns number
Length of this vector.

normalize

normalize(): Vector2

- Defined in math/vector.ts:122
Returns Vector2
This vector with a magnitude of 1.

sqrMagnitude

sqrMagnitude(): number

- Defined in math/vector.ts:108
Use of squared value is significantly faster, because the square root calculation is a expensive operation.
example
```
if (v.sqrMagnitude() > a * a) {...}
// vs slower equivalent
if (v.magnitude() > a) {...}
```
Returns number
Squared length of this vector.

Static add

add(a: Vector2, b: Vector2): Vector2

- Defined in math/vector.ts:52
Parameters
- a: Vector2
  
  First vector.
- b: Vector2
  
  Second vector.
Returns Vector2
Addition of two vectors.

Static div

div(a: Vector2, b: Vector2): Vector2

- Defined in math/vector.ts:88
Parameters
- a: Vector2
  
  First vector.
- b: Vector2
  
  Second vector.
Returns Vector2
Division of two vectors.

Static dot

dot(a: Vector2, b: Vector2): number

- Defined in math/vector.ts:135
Parameters
- a: Vector2
  
  Left-hand side vector.
- b: Vector2
  
  Right-hand side vector.
Returns number
Dot product between two given vectors.

Static lerp

lerp(a: Vector2, b: Vector2, t: number): Vector2

- Defined in math/vector.ts:155
Linearly interpolate this vector to vector b by t.
example
```
let a = new Vector2(-1, -1);
let b = new Vector2(1, 1);

let v = Vector2.lerp(a, b, 0.5); // v = [0, 0] 
```
Parameters
- a: Vector2
  
  Start position.
- b: Vector2
  
  End position.
- t: number
  
  Progress between 0 and 1.
Returns Vector2
Interpolated position between vectors.

Static mul

mul(a: Vector2, b: Vector2): Vector2

- Defined in math/vector.ts:76
Parameters
- a: Vector2
  
  First vector.
- b: Vector2
  
  Second vector.
Returns Vector2
Multiplication of two vectors.

Static sub

sub(a: Vector2, b: Vector2): Vector2

- Defined in math/vector.ts:64
Parameters
- a: Vector2
  
  First vector.
- b: Vector2
  
  Second vector.
Returns Vector2
Subtraction of two vectors.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

x: number = 0

y: number = 0

Returns Vector2

Properties

x

y

Static Readonly down

Static Readonly left

Static Readonly one

Static Readonly right

Static Readonly up

Static Readonly zero

Methods

magnitude

Returns number

normalize

Returns Vector2

sqrMagnitude

Returns number

Static add

Parameters

a: Vector2

b: Vector2

Returns Vector2

Static div

Parameters

a: Vector2

b: Vector2

Returns Vector2

Static dot

Parameters

a: Vector2

b: Vector2

Returns number

Static lerp

Parameters

a: Vector2

b: Vector2

t: number

Returns Vector2

Static mul

Parameters

a: Vector2

b: Vector2

Returns Vector2

Static sub

Parameters

a: Vector2

b: Vector2

Returns Vector2