Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Physics . Matter . BodyBounds

This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . Physics . Matter . 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.

Constructor:

new BodyBounds()
Since: 3.22.0

Members

boundsCenter: Phaser.Math.Vector2
Focus
Focus

Description:

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

Type:
Since: 3.22.0
Focus
Focus
centerDiff: Phaser.Math.Vector2
Focus
Focus

Description:

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

Type:
Since: 3.22.0
Focus
Focus

Methods

getBottomCenter(body, [x], [y])
Focus
Focus

Description:

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:

name type arguments description
body Phaser.Types.Physics.Matter.MatterBody

The Body to get the position from.

x number <optional>

Optional horizontal offset to add to the returned coordinates.

y number <optional>

Optional vertical offset to add to the returned coordinates.

Returns:
Description:

A Vector2 containing the coordinates, or false if it was unable to parse the body.

Type:
Examples:
Since: 3.22.0
Focus
Focus
getBottomLeft(body, [x], [y])
Focus
Focus

Description:

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:

name type arguments description
body Phaser.Types.Physics.Matter.MatterBody

The Body to get the position from.

x number <optional>

Optional horizontal offset to add to the returned coordinates.

y number <optional>

Optional vertical offset to add to the returned coordinates.

Returns:
Description:

A Vector2 containing the coordinates, or false if it was unable to parse the body.

Type:
Examples:
Since: 3.22.0
Focus
Focus
getBottomRight(body, [x], [y])
Focus
Focus

Description:

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:

name type arguments description
body Phaser.Types.Physics.Matter.MatterBody

The Body to get the position from.

x number <optional>

Optional horizontal offset to add to the returned coordinates.

y number <optional>

Optional vertical offset to add to the returned coordinates.

Returns:
Description:

A Vector2 containing the coordinates, or false if it was unable to parse the body.

Type:
Examples:
Since: 3.22.0
Focus
Focus
getCenter(body, [x], [y])
Focus
Focus

Description:

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:

name type arguments description
body Phaser.Types.Physics.Matter.MatterBody

The Body to get the position from.

x number <optional>

Optional horizontal offset to add to the returned coordinates.

y number <optional>

Optional vertical offset to add to the returned coordinates.

Returns:
Description:

A Vector2 containing the coordinates, or false if it was unable to parse the body.

Type:
Examples:
Since: 3.22.0
Focus
Focus
getLeftCenter(body, [x], [y])
Focus
Focus

Description:

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:

name type arguments description
body Phaser.Types.Physics.Matter.MatterBody

The Body to get the position from.

x number <optional>

Optional horizontal offset to add to the returned coordinates.

y number <optional>

Optional vertical offset to add to the returned coordinates.

Returns:
Description:

A Vector2 containing the coordinates, or false if it was unable to parse the body.

Type:
Examples:
Since: 3.22.0
Focus
Focus
getRightCenter(body, [x], [y])
Focus
Focus

Description:

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:

name type arguments description
body Phaser.Types.Physics.Matter.MatterBody

The Body to get the position from.

x number <optional>

Optional horizontal offset to add to the returned coordinates.

y number <optional>

Optional vertical offset to add to the returned coordinates.

Returns:
Description:

A Vector2 containing the coordinates, or false if it was unable to parse the body.

Type:
Examples:
Since: 3.22.0
Focus
Focus
getTopCenter(body, [x], [y])
Focus
Focus

Description:

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:

name type arguments description
body Phaser.Types.Physics.Matter.MatterBody

The Body to get the position from.

x number <optional>

Optional horizontal offset to add to the returned coordinates.

y number <optional>

Optional vertical offset to add to the returned coordinates.

Returns:
Description:

A Vector2 containing the coordinates, or false if it was unable to parse the body.

Type:
Examples:
Since: 3.22.0
Focus
Focus
getTopLeft(body, [x], [y])
Focus
Focus

Description:

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:

name type arguments description
body Phaser.Types.Physics.Matter.MatterBody

The Body to get the position from.

x number <optional>

Optional horizontal offset to add to the returned coordinates.

y number <optional>

Optional vertical offset to add to the returned coordinates.

Returns:
Description:

A Vector2 containing the coordinates, or false if it was unable to parse the body.

Type:
Examples:
Since: 3.22.0
Focus
Focus
getTopRight(body, [x], [y])
Focus
Focus

Description:

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:

name type arguments description
body Phaser.Types.Physics.Matter.MatterBody

The Body to get the position from.

x number <optional>

Optional horizontal offset to add to the returned coordinates.

y number <optional>

Optional vertical offset to add to the returned coordinates.

Returns:
Description:

A Vector2 containing the coordinates, or false if it was unable to parse the body.

Type:
Examples:
Since: 3.22.0
Focus
Focus
parseBody(body)
Focus
Focus

Description:

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:

name type description
body Phaser.Types.Physics.Matter.MatterBody

The Body to get the bounds position from.

Returns:
Description:

true if it was able to get the bounds, otherwise false.

Type:
  • boolean
Examples:
Since: 3.22.0
Focus
Focus