Class default

The Matter.Vector module contains methods for creating and manipulating vectors. Vectors are the basis of all the geometry related operations in the engine. A Matter.Vector object is of the form { x: 0, y: 0 }.

See the included usage examples.

Hierarchy

default

Index

Constructors

constructor

new default(): default
Returns default

Properties

`Protected` _temp

_temp: IVector[] = ...

Temporary vector pool (not thread-safe).

Methods

`Static` add

add(vectorA, vectorB, output?): IVector
Adds the two vectors.
Parameters
- vectorA: IVector
- vectorB: IVector
- output: IVector = ...
Returns IVector
A new vector of vectorA and vectorB added

Method
add
- Defined in src/geometry/Vector.ts:159

`Static` angle

angle(vectorA, vectorB): number
Returns the angle between the vector vectorB - vectorA and the x-axis in radians.
Parameters
- vectorA: IVector
- vectorB: IVector
Returns number
The angle in radians

Method
angle
- Defined in src/geometry/Vector.ts:237

`Static` clone

clone(vector): IVector
Returns a new vector with x and y copied from the given vector.
Parameters
- vector: IVector
Returns IVector
A new cloned vector

Method
clone
- Defined in src/geometry/Vector.ts:33

`Static` create

create(x?, y?): IVector
Creates a new vector.
Parameters
- Optional x: number
- Optional y: number
Returns IVector
A new vector

Method
create
- Defined in src/geometry/Vector.ts:23

`Static` cross

cross(vectorA, vectorB): number
Returns the cross-product of two vectors.
Parameters
- vectorA: IVector
- vectorB: IVector
Returns number
The cross product of the two vectors
- Defined in src/geometry/Vector.ts:133

`Static` cross3

cross3(vectorA, vectorB, vectorC): number
Returns the cross-product of three vectors.
Parameters
- vectorA: IVector
- vectorB: IVector
- vectorC: IVector
Returns number
The cross product of the three vectors
- Defined in src/geometry/Vector.ts:144

`Static` div

div(vector, scalar): IVector
Divides a vector and a scalar.
Parameters
- vector: IVector
- scalar: number
Returns IVector
A new vector divided by scalar

Method
div
- Defined in src/geometry/Vector.ts:204

`Static` dot

dot(vectorA, vectorB): number
Returns the dot-product of two vectors.
Parameters
- vectorA: IVector
- vectorB: IVector
Returns number
The dot product of the two vectors
- Defined in src/geometry/Vector.ts:123

`Static` magnitude

magnitude(vector): number
Returns the magnitude (length) of a vector.
Parameters
- vector: IVector
Returns number
The magnitude of the vector

Method
magnitude
- Defined in src/geometry/Vector.ts:43

`Static` magnitudeSquared

magnitudeSquared(vector): number
Returns the magnitude (length) of a vector (therefore saving a sqrt operation).
Parameters
- vector: IVector
Returns number
The squared magnitude of the vector

Method
magnitudeSquared
- Defined in src/geometry/Vector.ts:53

`Static` mult

mult(vector, scalar): IVector
Multiplies a vector and a scalar.
Parameters
- vector: IVector
- scalar: number
Returns IVector
A new vector multiplied by scalar

Method
mult
- Defined in src/geometry/Vector.ts:193

`Static` neg

neg(vector): IVector
Negates both components of a vector such that it points in the opposite direction.
Parameters
- vector: IVector
Returns IVector
The negated vector

Method
neg
- Defined in src/geometry/Vector.ts:226

`Static` normalise

normalise(vector): IVector
Normalises a vector (such that its magnitude is 1).
Parameters
- vector: IVector
Returns IVector
A new vector normalised

Method
normalise
- Defined in src/geometry/Vector.ts:109

`Static` perp

perp(vector, negate?): IVector
Returns the perpendicular vector. Set negate to true for the perpendicular in the opposite direction.
Parameters
- vector: IVector
- negate: boolean = false
Returns IVector
The perpendicular vector

Method
perp
- Defined in src/geometry/Vector.ts:215

`Static` rotate

rotate(vector, angle, output?): IVector
Rotates the vector about (0, 0) by specified angle.
Parameters
- vector: IVector
- angle: number
- output: IVector = ...
Returns IVector
The vector rotated about (0, 0)

Method
rotate
- Defined in src/geometry/Vector.ts:65

`Static` rotateAbout

rotateAbout(vector, angle, point, output?): IVector
Rotates the vector about a specified point by specified angle.
Parameters
- vector: IVector
- angle: number
- point: IVector
- output: IVector = ...
Returns IVector
A new vector rotated about the point

Method
rotateAbout
- Defined in src/geometry/Vector.ts:87

`Static` sub

sub(vectorA, vectorB, output?): IVector
Subtracts the two vectors.
Parameters
- vectorA: IVector
- vectorB: IVector
- output: IVector = ...
Returns IVector
A new vector of vectorA and vectorB subtracted
- Defined in src/geometry/Vector.ts:176

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

Protected _temp

Methods

Static add

Parameters

vectorA: IVector

vectorB: IVector

output: IVector = ...

Returns IVector

Method

Static angle

Parameters

vectorA: IVector

vectorB: IVector

Returns number

Method

Static clone

Parameters

vector: IVector

Returns IVector

Method

Static create

Parameters

Optional x: number

Optional y: number

Returns IVector

Method

Static cross

Parameters

vectorA: IVector

vectorB: IVector

Returns number

Static cross3

Parameters

vectorA: IVector

vectorB: IVector

vectorC: IVector

Returns number

Static div

Parameters

vector: IVector

scalar: number

Returns IVector

Method

Static dot

Parameters

vectorA: IVector

vectorB: IVector

Returns number

Static magnitude

Parameters

vector: IVector

Returns number

Method

Static magnitudeSquared

Parameters

vector: IVector

Returns number

Method

Static mult

Parameters

vector: IVector

scalar: number

Returns IVector

Method

Static neg

Parameters

vector: IVector

Returns IVector

Method

Static normalise

`Protected` _temp

`Static` add

`Static` angle

`Static` clone

`Static` create

`Optional` x: number

`Optional` y: number

`Static` cross

`Static` cross3

`Static` div

`Static` dot

`Static` magnitude

`Static` magnitudeSquared

`Static` mult

`Static` neg

`Static` normalise

`Static` perp

`Static` rotate

`Static` rotateAbout

`Static` sub