Class Acceleration2D

This is a 2D vector class.

Hierarchy (View Summary)

Vector2
- Acceleration2D

Constructors

constructor

new Acceleration2D(x?: number, y?: number): Acceleration2D
Parameters
- Optionalx: number = 0
  The x coordinate of the vector.
- Optionaly: number = 0
  The y coordinate of the vector.
Returns Acceleration2D
Inherited from Vector2.constructor
- Defined in src/math/core/vectors/float/vector2.js:14

Properties

x

x: number

y

y: number

`Static` `Readonly`NegX

NegX: Vector2 = ...

A unit vector pointing in the negative x-axis.

`Static` `Readonly`NegY

NegY: Vector2 = ...

A unit vector pointing in the nega y-axis.

`Static` `Readonly`X

X: Vector2 = ...

A unit vector pointing in the x-axis.

`Static` `Readonly`Y

Y: Vector2 = ...

A unit vector pointing in the y-axis.

`Static` `Readonly`Zero

Zero: Vector2 = ...

A vector whose x and y values will remain 0.

Methods

[iterator]

"[iterator]"(): Generator<number, void, unknown>
Allows for iteration of components.

Returns Generator<number, void, unknown>
Yields
Inherited from Vector2.[iterator]
- Defined in src/math/core/vectors/float/vector2.js:635

add

add(v: Vector2): Acceleration2D
Adds a given vector into this.
Parameters
- v: Vector2
Returns Acceleration2D
Inherited from Vector2.add
- Defined in src/math/core/vectors/float/vector2.js:125

addScalar

addScalar(n: number): Acceleration2D
Adds a scalar value into this vector's component values.
Parameters
- n: number
Returns Acceleration2D
Inherited from Vector2.addScalar
- Defined in src/math/core/vectors/float/vector2.js:136

clone

clone(): Vector2
Returns a copy of this.

Returns Vector2
Inherited from Vector2.clone
- Defined in src/math/core/vectors/float/vector2.js:47

copy

copy(v: Vector2): Acceleration2D
Copies values of another vector to this vector.
Parameters
- v: Vector2
Returns Acceleration2D
Inherited from Vector2.copy
- Defined in src/math/core/vectors/float/vector2.js:37

cross

cross(v: Vector2): number
Calculates the cross product of this with another vector.
Parameters
- v: Vector2
Returns number
Inherited from Vector2.cross
- Defined in src/math/core/vectors/float/vector2.js:226

distanceTo

distanceTo(v: Vector2): number
Returns the distance between this vector and another vector.
Parameters
- v: Vector2
  The other vector.
Returns number
Inherited from Vector2.distanceTo
- Defined in src/math/core/vectors/float/vector2.js:84

distanceToSquared

distanceToSquared(v: Vector2): number
Returns the squared distance between this vector and another vector.
Parameters
- v: Vector2
  The other vector.
Returns number
Inherited from Vector2.distanceToSquared
- Defined in src/math/core/vectors/float/vector2.js:94

divide

divide(v: Vector2): Acceleration2D
Divides this vector with a scalar.
Parameters
- v: Vector2
Returns Acceleration2D
Inherited from Vector2.divide
- Defined in src/math/core/vectors/float/vector2.js:194

divideScalar

divideScalar(s: number): Acceleration2D
Parameters
- s: number
Returns Acceleration2D
Inherited from Vector2.divideScalar
- Defined in src/math/core/vectors/float/vector2.js:204

dot

dot(v: Vector2): number
Calculates the dot product of this with another vector.
Parameters
- v: Vector2
Returns number
Inherited from Vector2.dot
- Defined in src/math/core/vectors/float/vector2.js:216

equals

equals(v: Vector2): boolean
Checks to see if this vector is equal to another vector.
Parameters
- v: Vector2
Returns boolean
Inherited from Vector2.equals
- Defined in src/math/core/vectors/float/vector2.js:256

invert

invert(): Acceleration2D
Returns Acceleration2D
Inherited from Vector2.invert
- Defined in src/math/core/vectors/float/vector2.js:244

magnitude

magnitude(): number
Returns length of this vector.

Returns number
Inherited from Vector2.magnitude
- Defined in src/math/core/vectors/float/vector2.js:75

magnitudeSquared

magnitudeSquared(): number
Returns the length squared of this vector.

Returns number
Inherited from Vector2.magnitudeSquared
- Defined in src/math/core/vectors/float/vector2.js:66

multiply

multiply(v: Vector2): Acceleration2D
Multiplies this vector with a given vector.
Parameters
- v: Vector2
Returns Acceleration2D
Inherited from Vector2.multiply
- Defined in src/math/core/vectors/float/vector2.js:171

multiplyScalar

multiplyScalar(s: number): Acceleration2D
Multiplies a scalar value with this vector's component values.
Parameters
- s: number
Returns Acceleration2D
Inherited from Vector2.multiplyScalar
- Defined in src/math/core/vectors/float/vector2.js:182

normalize

normalize(): Acceleration2D
Makes this a unit vector.

Returns Acceleration2D
Inherited from Vector2.normalize
- Defined in src/math/core/vectors/float/vector2.js:102

reverse

reverse(): Acceleration2D
Negates the values of this vector.

Returns Acceleration2D
Inherited from Vector2.reverse
- Defined in src/math/core/vectors/float/vector2.js:235

set

set(x: number, y: number): Acceleration2D
Sets values of this vector.
Parameters
- x: number
- y: number
Returns Acceleration2D
Inherited from Vector2.set
- Defined in src/math/core/vectors/float/vector2.js:25

setMagnitude

setMagnitude(length: number): Acceleration2D
Sets this vector to have the given length.
Parameters
- length: number
Returns Acceleration2D
Inherited from Vector2.setMagnitude
- Defined in src/math/core/vectors/float/vector2.js:113

splat

splat(scalar: number): Acceleration2D
Parameters
- scalar: number
Returns Acceleration2D
Inherited from Vector2.splat
- Defined in src/math/core/vectors/float/vector2.js:55

subtract

subtract(v: Vector2): Acceleration2D
Subtracts a given vector from this vector.
Parameters
- v: Vector2
Returns Acceleration2D
Inherited from Vector2.subtract
- Defined in src/math/core/vectors/float/vector2.js:148

subtractScalar

subtractScalar(n: number): Acceleration2D
Subtracts a scalar value from this vector's component values.
Parameters
- n: number
Returns Acceleration2D
Inherited from Vector2.subtractScalar
- Defined in src/math/core/vectors/float/vector2.js:160

`Static`add

add(v1: Vector2, v2: Vector2, out?: Vector2): Vector2
Parameters
- v1: Vector2
- v2: Vector2
- Optionalout: Vector2 = ...
Returns Vector2
Inherited from Vector2.add
- Defined in src/math/core/vectors/float/vector2.js:377

`Static`addScalar

addScalar(v1: Vector2, n: number, out?: Vector2): Vector2
Parameters
- v1: Vector2
- n: number
- Optionalout: Vector2 = ...
Returns Vector2
Inherited from Vector2.addScalar
- Defined in src/math/core/vectors/float/vector2.js:389

`Static`angleBetween

angleBetween(v1: Vector2, v2: Vector2): number
Gets the angle (in radians) between two vectors in the shortest direction from v1 to v2 in the range of 0 to Math.PI.
Parameters
- v1: Vector2
  Start of the angle.
- v2: Vector2
  End of the angle.
Returns number
Inherited from Vector2.angleBetween
- Defined in src/math/core/vectors/float/vector2.js:590

`Static`clampMagnitude

clampMagnitude(v: Vector2, min: number, max: number, out: Vector2): Vector2
Parameters
- v: Vector2
- min: number
- max: number
- out: Vector2
Returns Vector2
Inherited from Vector2.clampMagnitude
- Defined in src/math/core/vectors/float/vector2.js:361

`Static`copy

copy(v: Vector2, out?: Vector2): Vector2
Parameters
- v: Vector2
- Optionalout: Vector2 = ...
Returns Vector2
Inherited from Vector2.copy
- Defined in src/math/core/vectors/float/vector2.js:276

`Static`cross

cross(v1: Vector2, v2: Vector2): number
Parameters
- v1: Vector2
- v2: Vector2
Returns number
Inherited from Vector2.cross
- Defined in src/math/core/vectors/float/vector2.js:496

`Static`crossScalar

crossScalar(v1: Vector2, n: number, out?: Vector2): Vector2
Parameters
- v1: Vector2
- n: number
- out: Vector2 = ...
Returns Vector2
Inherited from Vector2.crossScalar
- Defined in src/math/core/vectors/float/vector2.js:505

`Static`distanceTo

distanceTo(v1: Vector2, v2: Vector2): number
Parameters
- v1: Vector2
- v2: Vector2
Returns number
Inherited from Vector2.distanceTo
- Defined in src/math/core/vectors/float/vector2.js:322

`Static`distanceToSquared

distanceToSquared(v1: Vector2, v2: Vector2): number
Calculates length squared of this vector to another vector.
Parameters
- v1: Vector2
- v2: Vector2
Returns number
Inherited from Vector2.distanceToSquared
- Defined in src/math/core/vectors/float/vector2.js:312

`Static`divide

divide(v1: Vector2, v2: Vector2, out?: Vector2): Vector2
Parameters
- v1: Vector2
- v2: Vector2
- Optionalout: Vector2 = ...
Returns Vector2
Inherited from Vector2.divide
- Defined in src/math/core/vectors/float/vector2.js:449

`Static`divideScalar

divideScalar(v1: Vector2, n: number, out?: Vector2): Vector2
Parameters
- v1: Vector2
- n: number
- Optionalout: Vector2 = ...
Returns Vector2
Inherited from Vector2.divideScalar
- Defined in src/math/core/vectors/float/vector2.js:461

`Static`dot

dot(v1: Vector2, v2: Vector2): number
Parameters
- v1: Vector2
- v2: Vector2
Returns number
Inherited from Vector2.dot
- Defined in src/math/core/vectors/float/vector2.js:488

`Static`equal

equal(v1: Vector2, v2: Vector2): boolean
Parameters
- v1: Vector2
- v2: Vector2
Returns boolean
Inherited from Vector2.equal
- Defined in src/math/core/vectors/float/vector2.js:546

`Static`fromAngle

fromAngle(angle: number, out?: Vector2): Vector2
Returns a unit vector pointing in the given angle starting from the positive x axis.
Parameters
- angle: number
  Angle in radians from 0 to Math.PI * 2.
- Optionalout: Vector2 = ...
  Vector2 to store results in.
Returns Vector2
Inherited from Vector2.fromAngle
- Defined in src/math/core/vectors/float/vector2.js:602

`Static`invert

invert(v: Vector2, out?: Vector2): Vector2
Parameters
- v: Vector2
- out: Vector2 = ...
Returns Vector2
Inherited from Vector2.invert
- Defined in src/math/core/vectors/float/vector2.js:477

`Static`lerp

lerp(from: Vector2, to: Vector2, t: number, out?: Vector2): Vector2
Returns a Vector2 that has been lerped between v1 and v2.
Parameters
- from: Vector2
  The vector to lerp from.
- to: Vector2
  The vector to lerp from.
- t: number
  A value from 0 to 1 to scale the new Vector2 between v1 and v2.
- Optionalout: Vector2 = ...
  The vector to store results into.
Returns Vector2
Inherited from Vector2.lerp
- Defined in src/math/core/vectors/float/vector2.js:521

`Static`magnitude

magnitude(v: Vector2): number
Parameters
- v: Vector2
Returns number
Inherited from Vector2.magnitude
- Defined in src/math/core/vectors/float/vector2.js:302

`Static`magnitudeSquared

magnitudeSquared(v: Vector2): number
Parameters
- v: Vector2
Returns number
Inherited from Vector2.magnitudeSquared
- Defined in src/math/core/vectors/float/vector2.js:295

`Static`multiply

multiply(v1: Vector2, v2: Vector2, out?: Vector2): Vector2
Parameters
- v1: Vector2
- v2: Vector2
- Optionalout: Vector2 = ...
Returns Vector2
Inherited from Vector2.multiply
- Defined in src/math/core/vectors/float/vector2.js:425

`Static`multiplyScalar

multiplyScalar(v1: Vector2, n: number, out?: Vector2): Vector2
Parameters
- v1: Vector2
- n: number
- Optionalout: Vector2 = ...
Returns Vector2
Inherited from Vector2.multiplyScalar
- Defined in src/math/core/vectors/float/vector2.js:437

`Static`normal

normal(v: Vector2, out?: Vector2): Vector2
Parameters
- v: Vector2
- out: Vector2 = ...
Returns Vector2
Inherited from Vector2.normal
- Defined in src/math/core/vectors/float/vector2.js:554

`Static`normalize

normalize(v: Vector2, out?: Vector2): Vector2
Parameters
- v: Vector2
- Optionalout: Vector2 = ...
Returns Vector2
Inherited from Vector2.normalize
- Defined in src/math/core/vectors/float/vector2.js:332

`Static`random

random(out?: Vector2): Vector2
Generates a new unit Vector2 in a random direction.
Parameters
- Optionalout: Vector2
Returns Vector2
Inherited from Vector2.random
- Defined in src/math/core/vectors/float/vector2.js:626

`Static`reflect

reflect(v: Vector2, normal: Vector2, out?: Vector2): Vector2
Parameters
- v: Vector2
- normal: Vector2
- Optionalout: Vector2 = ...
Returns Vector2
Inherited from Vector2.reflect
- Defined in src/math/core/vectors/float/vector2.js:533

`Static`reverse

reverse(v: Vector2, out?: Vector2): Vector2
Parameters
- v: Vector2
- Optionalout: Vector2 = ...
Returns Vector2
Inherited from Vector2.reverse
- Defined in src/math/core/vectors/float/vector2.js:469

`Static`rotate

rotate(v: Vector2, angle: number, out?: Vector2): Vector2
Parameters
- v: Vector2
- angle: number
- out: Vector2 = ...
Returns Vector2
Inherited from Vector2.rotate
- Defined in src/math/core/vectors/float/vector2.js:563

`Static`rotateFast

rotateFast(v: Vector2, cos: number, sin: number, out?: Vector2): Vector2
Parameters
- v: Vector2
- cos: number
- sin: number
- out: Vector2 = ...
Returns Vector2
Inherited from Vector2.rotateFast
- Defined in src/math/core/vectors/float/vector2.js:573

`Static`set

set(x: number, y: number, out?: Vector2): Vector2
Parameters
- x: number
- y: number
- out: Vector2 = ...
Returns Vector2
Inherited from Vector2.set
- Defined in src/math/core/vectors/float/vector2.js:265

`Static`setMagnitude

setMagnitude(v: Vector2, length: number, out?: Vector2): Vector2
Parameters
- v: Vector2
- length: number
- Optionalout: Vector2 = ...
Returns Vector2
Inherited from Vector2.setMagnitude
- Defined in src/math/core/vectors/float/vector2.js:348

`Static`splat

splat(scalar: number, out?: Vector2): Vector2
Parameters
- scalar: number
- out: Vector2 = ...
Returns Vector2
Inherited from Vector2.splat
- Defined in src/math/core/vectors/float/vector2.js:288

`Static`subtract

subtract(from: Vector2, to: Vector2, out?: Vector2): Vector2
Parameters
- from: Vector2
- to: Vector2
- Optionalout: Vector2 = ...
Returns Vector2
Inherited from Vector2.subtract
- Defined in src/math/core/vectors/float/vector2.js:401

`Static`subtractScalar

subtractScalar(v1: Vector2, n: number, out?: Vector2): Vector2
Parameters
- v1: Vector2
- n: number
- Optionalout: Vector2 = ...
Returns Vector2
Inherited from Vector2.subtractScalar
- Defined in src/math/core/vectors/float/vector2.js:413

`Static`toAngle

toAngle(v: Vector2): number
Returns the angle in radians between the positive x-axis and the vector.
Parameters
- v: Vector2
Returns number
Inherited from Vector2.toAngle
- Defined in src/math/core/vectors/float/vector2.js:614

Class Acceleration2D

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Acceleration2D

Properties

x

y

Static ReadonlyNegX

Static ReadonlyNegY

Static ReadonlyX

Static ReadonlyY

Static ReadonlyZero

Methods

[iterator]

Returns Generator<number, void, unknown>

Yields

add

Parameters

Returns Acceleration2D

addScalar

Parameters

Returns Acceleration2D

clone

Returns Vector2

copy

Parameters

Returns Acceleration2D

cross

Parameters

Returns number

distanceTo

Parameters

Returns number

distanceToSquared

Parameters

Returns number

divide

Parameters

Returns Acceleration2D

divideScalar

Parameters

Returns Acceleration2D

dot

Parameters

Returns number

equals

Parameters

Returns boolean

invert

Returns Acceleration2D

magnitude

Returns number

magnitudeSquared

Returns number

multiply

Parameters

Returns Acceleration2D

multiplyScalar

Parameters

Returns Acceleration2D

normalize

Returns Acceleration2D

reverse

Returns Acceleration2D

set

Parameters

Returns Acceleration2D

setMagnitude

Parameters

Returns Acceleration2D

splat

Parameters

Returns Acceleration2D

subtract

`Static` `Readonly`NegX

`Static` `Readonly`NegY

`Static` `Readonly`X

`Static` `Readonly`Y

`Static` `Readonly`Zero

`Static`add

`Static`addScalar

`Static`angleBetween

`Static`clampMagnitude

`Static`copy

`Static`cross

`Static`crossScalar

`Static`distanceTo

`Static`distanceToSquared

`Static`divide

`Static`divideScalar

`Static`dot

`Static`equal

`Static`fromAngle

`Static`invert

`Static`lerp

`Static`magnitude

`Static`magnitudeSquared

`Static`multiply

`Static`multiplyScalar

`Static`normal

`Static`normalize