Class Vector2

Hierarchy

Vector2

Implements

Vec2

Index

Constructors

Properties

Accessors

Length normalize

Methods

add clone distance distanceSquared divide dotProduct multiply replace subtract toArray add clone create divide dotProduct fromArray fromArrays multiply normalize subtract

Constructors

constructor

new Vector2(x: number, y: number): Vector2
Parameters
- x: number
- y: number
Returns Vector2
- Defined in utils/Vector2.ts:67

Properties

type

type: string = "vec2"

x

x: number

y

y: number

Accessors

Length

get Length(): number
Returns number
- Defined in utils/Vector2.ts:127

normalize

get normalize(): Vector2
Returns Vector2
- Defined in utils/Vector2.ts:94

Methods

add

add(v: number | Vector2Type): Vector2
Parameters
- v: number | Vector2Type
Returns Vector2
- Defined in utils/Vector2.ts:102

clone

clone(): Vector2
Returns Vector2
- Defined in utils/Vector2.ts:69

distance

distance(v: Vector2Type): number
The distance between two Vectors.

Returns
Distance between this and another vector.
Parameters
- v: Vector2Type
  
  Vector2 to find distance between.
Returns number
- Defined in utils/Vector2.ts:90

distanceSquared

distanceSquared(v: Vector2Type): number
The product of the Euclidean magnitudes of this and another Vector2.

Returns
Euclidean magnitude with another vector.
Parameters
- v: Vector2Type
  
  Vector2 to find Euclidean magnitude between.
Returns number
- Defined in utils/Vector2.ts:79

divide

divide(v: number | Vector2Type): Vector2
Parameters
- v: number | Vector2Type
Returns Vector2
- Defined in utils/Vector2.ts:114

dotProduct

dotProduct(v: Vector2Type): number
Parameters
- v: Vector2Type
Returns number
- Defined in utils/Vector2.ts:98

multiply

multiply(v: number | Vector2Type): Vector2
Parameters
- v: number | Vector2Type
Returns Vector2
- Defined in utils/Vector2.ts:110

replace

replace(v: Vector2Type): void
Parameters
- v: Vector2Type
Returns void
- Defined in utils/Vector2.ts:122

subtract

subtract(v: Vector2Type): Vector2
Parameters
- v: Vector2Type
Returns Vector2
- Defined in utils/Vector2.ts:106

toArray

toArray(): [number, number]
Returns [number, number]
- Defined in utils/Vector2.ts:118

`Static` add

add(v1: Vector2Type, v2: number | Vector2Type): Vector2
Parameters
- v1: Vector2Type
- v2: number | Vector2Type
Returns Vector2
- Defined in utils/Vector2.ts:39

`Static` clone

clone(v1: Vec2): Vector2
Parameters
- v1: Vec2
Returns Vector2
- Defined in utils/Vector2.ts:35

`Static` create

create(v1: number | Vec2): Vector2
Parameters
- v1: number | Vec2
Returns Vector2
- Defined in utils/Vector2.ts:12

`Static` divide

divide(v1: Vector2Type, v2: number | Vector2Type): Vector2
Parameters
- v1: Vector2Type
- v2: number | Vector2Type
Returns Vector2
- Defined in utils/Vector2.ts:54

`Static` dotProduct

dotProduct(v1: Vector2Type, v2: Vector2Type): number
Parameters
- v1: Vector2Type
- v2: Vector2Type
Returns number
- Defined in utils/Vector2.ts:59

`Static` fromArray

fromArray(primitive: number[] | [number, number]): Vector2
Creates a vector from an array of numbers
Parameters
- primitive: number[] | [number, number]
  
  An array of numbers (usually returned by a native) ```
Returns Vector2
- Defined in utils/Vector2.ts:22

`Static` fromArrays

fromArrays(primitives: [number, number][] | number[][]): Vector2[]
Creates an array of vectors from an array number arrays
Parameters
- primitives: [number, number][] | number[][]
  
  A multi-dimensional array of number arrays ```
Returns Vector2[]
- Defined in utils/Vector2.ts:31

`Static` multiply

multiply(v1: Vector2Type, v2: number | Vector2Type): Vector2
Parameters
- v1: Vector2Type
- v2: number | Vector2Type
Returns Vector2
- Defined in utils/Vector2.ts:49

`Static` normalize

normalize(v: Vector2): Vector2
Parameters
- v: Vector2
Returns Vector2
- Defined in utils/Vector2.ts:63

`Static` subtract

subtract(v1: Vector2Type, v2: number | Vector2Type): Vector2
Parameters
- v1: Vector2Type
- v2: number | Vector2Type
Returns Vector2
- Defined in utils/Vector2.ts:44

Generated using TypeDoc