Class BodyBounds

The Body Bounds class contains methods to help you extract the world coordinates from various points around the bounds of a Matter Body. Because Matter bodies are positioned based on their center of mass, and not a dimension based center, you often need to get the bounds coordinates in order to properly align them in the world.

You can access this class via the MatterPhysics class from a Scene, i.e.:

this.matter.bodyBounds.getTopLeft(body);

See also the MatterPhysics.alignBody method.

Index

Constructors

constructor

new BodyBounds(): BodyBounds
Returns BodyBounds

Properties

boundsCenter

boundsCenter: Math.Vector2

A Vector2 that stores the temporary bounds center value during calculations by methods in this class.

centerDiff

centerDiff: Math.Vector2

A Vector2 that stores the temporary center diff values during calculations by methods in this class.

Methods

getBottomCenter

getBottomCenter(body: MatterBody, x?: number, y?: number): false | Math.Vector2
Takes a Body and returns the world coordinates of the bottom-center of its bounds.

Body bounds are updated by Matter each step and factor in scale and rotation. This will return the world coordinate based on the bodies current position and bounds.
Parameters
- body: MatterBody
  The Body to get the position from.
- Optionalx: number
  Optional horizontal offset to add to the returned coordinates. Default 0.
- Optionaly: number
  Optional vertical offset to add to the returned coordinates. Default 0.
Returns false | Math.Vector2
- Defined in types/phaser.d.ts:90989

getBottomLeft

getBottomLeft(body: MatterBody, x?: number, y?: number): false | Math.Vector2
Takes a Body and returns the world coordinates of the bottom-left of its bounds.

Body bounds are updated by Matter each step and factor in scale and rotation. This will return the world coordinate based on the bodies current position and bounds.
Parameters
- body: MatterBody
  The Body to get the position from.
- Optionalx: number
  Optional horizontal offset to add to the returned coordinates. Default 0.
- Optionaly: number
  Optional vertical offset to add to the returned coordinates. Default 0.
Returns false | Math.Vector2
- Defined in types/phaser.d.ts:90978

getBottomRight

getBottomRight(body: MatterBody, x?: number, y?: number): false | Math.Vector2
Takes a Body and returns the world coordinates of the bottom-right of its bounds.

Body bounds are updated by Matter each step and factor in scale and rotation. This will return the world coordinate based on the bodies current position and bounds.
Parameters
- body: MatterBody
  The Body to get the position from.
- Optionalx: number
  Optional horizontal offset to add to the returned coordinates. Default 0.
- Optionaly: number
  Optional vertical offset to add to the returned coordinates. Default 0.
Returns false | Math.Vector2
- Defined in types/phaser.d.ts:91000

getCenter

getCenter(body: MatterBody, x?: number, y?: number): false | Math.Vector2
Takes a Body and returns the world coordinates of the center of its bounds.

Body bounds are updated by Matter each step and factor in scale and rotation. This will return the world coordinate based on the bodies current position and bounds.
Parameters
- body: MatterBody
  The Body to get the position from.
- Optionalx: number
  Optional horizontal offset to add to the returned coordinates. Default 0.
- Optionaly: number
  Optional vertical offset to add to the returned coordinates. Default 0.
Returns false | Math.Vector2
- Defined in types/phaser.d.ts:90956

getLeftCenter

getLeftCenter(body: MatterBody, x?: number, y?: number): false | Math.Vector2
Takes a Body and returns the world coordinates of the left-center of its bounds.

Body bounds are updated by Matter each step and factor in scale and rotation. This will return the world coordinate based on the bodies current position and bounds.
Parameters
- body: MatterBody
  The Body to get the position from.
- Optionalx: number
  Optional horizontal offset to add to the returned coordinates. Default 0.
- Optionaly: number
  Optional vertical offset to add to the returned coordinates. Default 0.
Returns false | Math.Vector2
- Defined in types/phaser.d.ts:90945

getRightCenter

getRightCenter(body: MatterBody, x?: number, y?: number): false | Math.Vector2
Takes a Body and returns the world coordinates of the right-center of its bounds.

Body bounds are updated by Matter each step and factor in scale and rotation. This will return the world coordinate based on the bodies current position and bounds.
Parameters
- body: MatterBody
  The Body to get the position from.
- Optionalx: number
  Optional horizontal offset to add to the returned coordinates. Default 0.
- Optionaly: number
  Optional vertical offset to add to the returned coordinates. Default 0.
Returns false | Math.Vector2
- Defined in types/phaser.d.ts:90967

getTopCenter

getTopCenter(body: MatterBody, x?: number, y?: number): false | Math.Vector2
Takes a Body and returns the world coordinates of the top-center of its bounds.

Body bounds are updated by Matter each step and factor in scale and rotation. This will return the world coordinate based on the bodies current position and bounds.
Parameters
- body: MatterBody
  The Body to get the position from.
- Optionalx: number
  Optional horizontal offset to add to the returned coordinates. Default 0.
- Optionaly: number
  Optional vertical offset to add to the returned coordinates. Default 0.
Returns false | Math.Vector2
- Defined in types/phaser.d.ts:90923

getTopLeft

getTopLeft(body: MatterBody, x?: number, y?: number): false | Math.Vector2
Takes a Body and returns the world coordinates of the top-left of its bounds.

Body bounds are updated by Matter each step and factor in scale and rotation. This will return the world coordinate based on the bodies current position and bounds.
Parameters
- body: MatterBody
  The Body to get the position from.
- Optionalx: number
  Optional horizontal offset to add to the returned coordinates. Default 0.
- Optionaly: number
  Optional vertical offset to add to the returned coordinates. Default 0.
Returns false | Math.Vector2
- Defined in types/phaser.d.ts:90912

getTopRight

getTopRight(body: MatterBody, x?: number, y?: number): false | Math.Vector2
Takes a Body and returns the world coordinates of the top-right of its bounds.

Body bounds are updated by Matter each step and factor in scale and rotation. This will return the world coordinate based on the bodies current position and bounds.
Parameters
- body: MatterBody
  The Body to get the position from.
- Optionalx: number
  Optional horizontal offset to add to the returned coordinates. Default 0.
- Optionaly: number
  Optional vertical offset to add to the returned coordinates. Default 0.
Returns false | Math.Vector2
- Defined in types/phaser.d.ts:90934

parseBody

parseBody(body: MatterBody): boolean
Parses the given body to get the bounds diff values from it.

They're stored in this class in the temporary properties boundsCenter and centerDiff.

This method is called automatically by all other methods in this class.
Parameters
- body: MatterBody
  The Body to get the bounds position from.
Returns boolean
- Defined in types/phaser.d.ts:90901

Class BodyBounds

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BodyBounds

Properties

boundsCenter

centerDiff

Methods

getBottomCenter

Parameters

Returns false | Math.Vector2

getBottomLeft

Parameters

Returns false | Math.Vector2

getBottomRight

Parameters

Returns false | Math.Vector2

getCenter

Parameters

Returns false | Math.Vector2

getLeftCenter

Parameters

Returns false | Math.Vector2

getRightCenter

Parameters

Returns false | Math.Vector2

getTopCenter

Parameters

Returns false | Math.Vector2

getTopLeft

Parameters

Returns false | Math.Vector2

getTopRight

Parameters

Returns false | Math.Vector2

parseBody

Parameters

Returns boolean

Settings

On This Page