Class Vec2

Vec2 represents a 2D position or a 2D vector. It is used everywhere in Illuminated.

Vec2 is based on Box2D's Vec2 except that in Illuminated, a Vec2 vector is immutable. It means every method creates a new Vec2 instance and you can safely use a same Vec2 instance everywhere because the immutability guarantees that properties will not be modified.

Hierarchy

Vec2

Index

Constructors

constructor

new Vec2(x?, y?): Vec2
Parameters
- x: number = 0
  
  X coordinate for the vector.
- y: number = 0
  
  Y coordinate for the vector.
Returns Vec2
- Defined in Vec2.ts:14

Properties

x

x: number = 0

X coordinate for the vector.

y

y: number = 0

Y coordinate for the vector.

Methods

add

add(v): Vec2
Adds the given vector to the vector.
Parameters
- v: Vec2
  
  A vector to add to the vector.
Returns Vec2
A new vector that is the result of the addition.
- Defined in Vec2.ts:51

copy

copy(): Vec2
Returns a copy of the vector.

Returns Vec2
A new vector that is a copy of the vector.
- Defined in Vec2.ts:21

dist2

dist2(v): number
Calculates the squared distance between the vector and the given vector.
Parameters
- v: Vec2
  
  A vector with which the squared distance is calculated.
Returns number
The squared distance.
- Defined in Vec2.ts:80

dot

dot(v): number
Calculates the dot product of the vector and the given vector.
Parameters
- v: Vec2
  
  A vector with which to calculate the dot product.
Returns number
The result of the dot product.
- Defined in Vec2.ts:31

inBound

inBound(topLeft, bottomRight): boolean
Determines if the vector is within the bounds defined by the given vectors.
Parameters
- topLeft: Vec2
  
  A vector that is the top-left of the bounds.
- bottomRight: Vec2
  
  A vector that is the bottom-right of the bounds.
Returns boolean
true if the vector is within the given bounds.
- Defined in Vec2.ts:123

inv

inv(): Vec2
Returns the inverse of the vector.

Returns Vec2
A new vector that is the inverse of the vector.
- Defined in Vec2.ts:70

length2

length2(): number
Calculates the squared length of the vector.

Returns number
The squared length.
- Defined in Vec2.ts:103

mul

mul(n): Vec2
Multiplies the given vector with the vector.
Parameters
- n: number
  
  A number to multiply with the vector.
Returns Vec2
A new vector that is the result of the multiplication.
- Defined in Vec2.ts:61

normalize

normalize(): Vec2
Calculates the normalized form of the vector.

Returns Vec2
A new vector in normalized form.
- Defined in Vec2.ts:92

sub

sub(v): Vec2
Subtracts the given vector from the vector.
Parameters
- v: Vec2
  
  A vector to subtract from the vector.
Returns Vec2
A new vector that is the result of the subtraction.
- Defined in Vec2.ts:41

toString

toString(): string
Returns a string representing the vector.

Returns string
A string representing the vector.
- Defined in Vec2.ts:112

Class Vec2

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

x: number = 0

y: number = 0

Returns Vec2

Properties

x

y

Methods

add

Parameters

v: Vec2

Returns Vec2

copy

Returns Vec2

dist2

Parameters

v: Vec2

Returns number

dot

Parameters

v: Vec2

Returns number

inBound

Parameters

topLeft: Vec2

bottomRight: Vec2

Returns boolean

inv

Returns Vec2

length2

Returns number

mul

Parameters

n: number

Returns Vec2

normalize

Returns Vec2

sub

Parameters

v: Vec2

Returns Vec2

toString

Returns string

Settings

Member Visibility

Theme

On This Page