Class Vector2

Index

Constructors

Properties

x y

Accessors

Methods

add clone distance divide dot equals fadd fdistance fdivide fdot flength fnormalize fscale fsubtract length normalize scale subtract toString

Constructors

constructor

new Vector2(x, y?): Vector2
Creates a new instance of a Vector2.
Parameters
- x: number
  The X-position.
- Optional y: number
  The Y-position.
Returns Vector2
- Defined in src/Types/Vector2.ts:17

Properties

x

x: number

The X-position.

y

y: number

The Y-position.

Accessors

floatX

get floatX(): number
Returns number
- Defined in src/Types/Vector2.ts:22

floatY

get floatY(): number
Returns number
- Defined in src/Types/Vector2.ts:26

Methods

add

add(vec): Vector2
Adds a vector to the current and returns a new instance.
Parameters
- vec: Vector2
  Vector to add.
Returns Vector2
- Defined in src/Types/Vector2.ts:34

clone

clone(): Vector2
Clones the current vector.

Returns Vector2
A cloned vector.
- Defined in src/Types/Vector2.ts:211

distance

distance(vec): number
Returns a distance between two vectors.
Parameters
- vec: Vector2
  Second vector.
Returns number
- Defined in src/Types/Vector2.ts:160

divide

divide(divisor): Vector2
Divides the current vector and returns a new instance.
Parameters
- divisor: number
  Vector divisor.
Returns Vector2
- Defined in src/Types/Vector2.ts:96

dot

dot(vec): number
Returns a dot product of two vectors.
Parameters
- vec: Vector2
  Second vector.
Returns number
- Defined in src/Types/Vector2.ts:118

equals

equals(vec): boolean
Returns if two vectors are equal.
Parameters
- vec: Vector2
  Second vector.
Returns boolean
- Defined in src/Types/Vector2.ts:203

fadd

fadd(vec): Vector2
Adds a vector to the current and returns a new instance with single precision.
Parameters
- vec: Vector2
  Vector to add.
Returns Vector2
- Defined in src/Types/Vector2.ts:43

fdistance

fdistance(vec): number
Parameters
- vec: Vector2
Returns number
- Defined in src/Types/Vector2.ts:167

fdivide

fdivide(divisor): Vector2
Subtracts a vector from the current and returns a new instance with single precision.
Parameters
- divisor: number
Returns Vector2
- Defined in src/Types/Vector2.ts:105

fdot

fdot(vec): number
Returns a dot product of two vectors with single precision.
Parameters
- vec: Vector2
  Second vector.
Returns number
- Defined in src/Types/Vector2.ts:126

flength

flength(): number
Returns a single precision length of two points in a vector.

Returns number
- Defined in src/Types/Vector2.ts:145

fnormalize

fnormalize(): Vector2
Returns a normalized vector with single precision.

Returns Vector2
- Defined in src/Types/Vector2.ts:190

fscale

fscale(multiplier): Vector2
Scales the current vector and returns a new instance with single precision.
Parameters
- multiplier: number
Returns Vector2
- Defined in src/Types/Vector2.ts:83

fsubtract

fsubtract(vec): Vector2
Subtracts a vector from the current and returns a new instance with single precision.
Parameters
- vec: Vector2
  Vector to substract.
Returns Vector2
- Defined in src/Types/Vector2.ts:63

length

length(): number
Returns a length of two points in a vector.

Returns number
- Defined in src/Types/Vector2.ts:138

normalize

normalize(): Vector2
Returns a normalized vector.

Returns Vector2
- Defined in src/Types/Vector2.ts:181

scale

scale(multiplier): Vector2
Scales the current vector and returns a new instance.
Parameters
- multiplier: number
  Vector multiplier.
Returns Vector2
- Defined in src/Types/Vector2.ts:74

subtract

subtract(vec): Vector2
Subtracts a vector from the current and returns a new instance.
Parameters
- vec: Vector2
  Vector to substract.
Returns Vector2
- Defined in src/Types/Vector2.ts:54

toString

toString(): string
Returns string
A string representation of this vector.
- Defined in src/Types/Vector2.ts:218