Class Vector2

A 2D vector class orthogonal to the x and y axis Note that when something return this, the reference is the same as the original object and not copied. Use clone() to get a new instance.

Index

Constructors

Properties

x y

Accessors

Methods

add angleBetween clone dotProduct normalize rotate scale scaleAxis sub toVector3 zero

Constructors

constructor

new Vector2(x: number, y: number): Vector2
Parameters
- x: number
- y: number
Returns Vector2
- Defined in Core/MathStructures/Vector2.ts:11

Properties

x

x: number

y

y: number

Accessors

length

get length(): number
Get the computed length/magnitude/norm/intensity of the vector

Returns number
- Defined in Core/MathStructures/Vector2.ts:19

Methods

add

add(vector: Vector2): Vector2
Add another vector to this vector
Parameters
- vector: Vector2
Returns Vector2
- Defined in Core/MathStructures/Vector2.ts:43

angleBetween

angleBetween(vector: Vector2): number
Get the computed angle between the vector and another vector
Parameters
- vector: Vector2
Returns number
- Defined in Core/MathStructures/Vector2.ts:35

clone

clone(): Vector2
Get a cloned/duplicated instance of this vector

Returns Vector2
- Defined in Core/MathStructures/Vector2.ts:106

dotProduct

dotProduct(vector: Vector2): number
Get the computed dotProduct of the vector with another vector
Parameters
- vector: Vector2
Returns number
- Defined in Core/MathStructures/Vector2.ts:27

normalize

normalize(): Vector2
Normalize the vector

Returns Vector2
- Defined in Core/MathStructures/Vector2.ts:95

rotate

rotate(angle: number): Vector2
Rotate the vector by an angle in radians
Parameters
- angle: number
Returns Vector2
- Defined in Core/MathStructures/Vector2.ts:63

scale

scale(scalar: number): Vector2
Scale the vector by a scalar
Parameters
- scalar: number
Returns Vector2
- Defined in Core/MathStructures/Vector2.ts:76

scaleAxis

scaleAxis(vector: Vector2): Vector2
Scale axis independently by a vector
Parameters
- vector: Vector2
Returns Vector2
- Defined in Core/MathStructures/Vector2.ts:86

sub

sub(vector: Vector2): Vector2
Subtract another vector from this vector
Parameters
- vector: Vector2
Returns Vector2
- Defined in Core/MathStructures/Vector2.ts:53

toVector3

toVector3(z?: number): Vector3
Convert a vector2 to a vector 3. Return a new instance.
Parameters
- z: number = 0
  The z axis (default is 0)
Returns Vector3
- Defined in Core/MathStructures/Vector2.ts:114

`Static`zero

zero(): Vector2
Return a new vector 2 zeroed.

Returns Vector2
- Defined in Core/MathStructures/Vector2.ts:121