Vector2 | CoSpaces API

Represents 2D points and vectors.

Hierarchy

Vector2

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

- Defined in api.ts:1060
Returns Vector2
- Defined in api.ts:1062
Parameters
- x: number
- y: number
Returns Vector2

Properties

Readonly length

length: number

Returns the length of this vector.

The length is calculated by the square root of (x * x + y * y)

returns: length of this vector.

Readonly normalized

normalized: Vector2

Returns a copy of this vector with length 1.

Readonly sqrLength

sqrLength: number

Returns the squared length of this vector.

If you use vector lengths to compare distances, squared lengths are more performant and preferred to use.

returns: squared length of this vector

Readonly x

x: number

Readonly y

y: number

Static Readonly axisX

axisX: Vector2

Shorthand for writing new Vector2(1,0).

Static Readonly axisY

axisY: Vector2

Shorthand for writing new Vector2(0,1).

Static Readonly one

one: Vector2

Shorthand for writing new Vector2(1,1).

Static Readonly zero

zero: Vector2

Shorthand for writing new Vector2(0,0).

Methods

add

add(v: Vector2): Vector2

- Defined in api.ts:1064
Parameters
- v: Vector2
Returns Vector2

angle

angle(v: Vector2): number

- Defined in api.ts:1076
Parameters
- v: Vector2
Returns number

dist

dist(v: Vector2): number

- Defined in api.ts:1080
Parameters
- v: Vector2
Returns number

div

div(w: number): Vector2

- Defined in api.ts:1070
Parameters
- w: number
Returns Vector2

dot

dot(v: Vector2): number

- Defined in api.ts:1078
Parameters
- v: Vector2
Returns number

equals

equals(v: Vector2): boolean

- Defined in api.ts:1093
Returns true if this vector components equal v.

Parameters
- v: Vector2
  
  vector to compare this vector against.
Returns boolean

lerp

lerp(v: Vector2, t: number): Vector2

- Defined in api.ts:1082
Parameters
- v: Vector2
- t: number
Returns Vector2

max

max(v: Vector2): Vector2

- Defined in api.ts:1072
Parameters
- v: Vector2
Returns Vector2

min

min(v: Vector2): Vector2

- Defined in api.ts:1074
Parameters
- v: Vector2
Returns Vector2

mult

mult(w: number): Vector2

- Defined in api.ts:1068
Parameters
- w: number
Returns Vector2

sub

sub(v: Vector2): Vector2

- Defined in api.ts:1066
Parameters
- v: Vector2
Returns Vector2

Static add

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

- Defined in api.ts:1123
Adds vector a and vector b together by their corresponding components.

Parameters
- a: Vector2
- b: Vector2
Returns Vector2
combined result

Static angle

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

- Defined in api.ts:1195
Returns the angle in radians from vector a to vector b.

Parameters
- a: Vector2
- b: Vector2
Returns number
angle in radians.

Static dist

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

- Defined in api.ts:1147
Returns the distance between vector a and vector b.

Parameters
- a: Vector2
- b: Vector2
Returns number
distance between vectors.

Static div

div(v: Vector2, d: number): Vector2

- Defined in api.ts:1178
Divides all components of vector v by divisor d.

Parameters
- v: Vector2
  
  vector components to multiply.
- d: number
  
  divisor.
Returns Vector2
new vector of the divided result.

Static dot

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

- Defined in api.ts:1140
Calculates the dot product of this vector a and vector b.

The dot product is a number equal to the length of two vectors multiplied together and then multiplied by the cosine of the angle between them.

Parameters
- a: Vector2
- b: Vector2
Returns number
dot product.

Static lerp

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

- Defined in api.ts:1158
Interpolates between vector a and b over interpolant t.

Used to find a point between endpoints a and b.

Example: If t = 0.5, the target point is in the middle of the path from a to b.

Parameters
- a: Vector2
- b: Vector2
- t: number
Returns Vector2
point between a and b.

Static max

max(a: Vector2, b: Vector2): Vector2

- Defined in api.ts:1183
Returns a new vector made from the largest components of vector a and vector b.

Parameters
- a: Vector2
- b: Vector2
Returns Vector2

Static min

min(a: Vector2, b: Vector2): Vector2

- Defined in api.ts:1188
Returns a new vector made from the smallest components of vector a and vector b.

Parameters
- a: Vector2
- b: Vector2
Returns Vector2

Static mult

mult(v: Vector2, m: number): Vector2

- Defined in api.ts:1167
Multiplies each component of vector v by m.

Parameters
- v: Vector2
  
  vector components to multiply.
- m: number
Returns Vector2
new vector of the multiplied result.

Static sub

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

- Defined in api.ts:1130
Subtracts each component of vector b from a.

Parameters
- a: Vector2
- b: Vector2
Returns Vector2
new vector of the subtraction result.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Vector2

Parameters

x: number

y: number

Returns Vector2

Properties

Readonly length

Readonly normalized

Readonly sqrLength

Readonly x

Readonly y

Static Readonly axisX

Static Readonly axisY

Static Readonly one

Static Readonly zero

Methods

add

Parameters

v: Vector2

Returns Vector2

angle

Parameters

v: Vector2

Returns number

dist

Parameters

v: Vector2

Returns number

div

Parameters

w: number

Returns Vector2

dot

Parameters

v: Vector2

Returns number

equals

Parameters

v: Vector2

Returns boolean

lerp

Parameters

v: Vector2

t: number

Returns Vector2

max

Parameters

v: Vector2

Returns Vector2

min

Parameters

v: Vector2

Returns Vector2

mult

Parameters

w: number

Returns Vector2

sub

Parameters

v: Vector2

Returns Vector2

Static add

Parameters

a: Vector2

b: Vector2

Returns Vector2

Static angle

Parameters

a: Vector2

b: Vector2

Returns number

Static dist

Parameters