# Class: Rectangle

## Phaser. Rectangle

#### new Rectangle(x, y, width, height)

Creates a new Rectangle object with the top-left corner specified by the x and y parameters and with the specified width and height parameters. If you call this function without parameters, a Rectangle with x, y, width, and height properties set to 0 is created.

##### Parameters:
Name Type Description
`x` number

The x coordinate of the top-left corner of the Rectangle.

`y` number

The y coordinate of the top-left corner of the Rectangle.

`width` number

The width of the Rectangle. Should always be either zero or a positive value.

`height` number

The height of the Rectangle. Should always be either zero or a positive value.

Source:
src/geom/Rectangle.js line 18

### Members

#### bottom : number

The sum of the y and height properties. Changing the bottom property of a Rectangle object has no effect on the x, y and width properties, but does change the height property.

##### Type:
• number
Source:
src/geom/Rectangle.js line 559

#### bottomLeft : Phaser.Point

The location of the Rectangles bottom left corner as a Point object. Gets or sets the location of the Rectangles bottom left corner as a Point object.

##### Type:
Source:
src/geom/Rectangle.js line 587

#### bottomRight : Phaser.Point

The location of the Rectangles bottom right corner as a Point object. Gets or sets the location of the Rectangles bottom right corner as a Point object.

##### Type:
Source:
src/geom/Rectangle.js line 607

#### centerX : number

The x coordinate of the center of the Rectangle.

##### Type:
• number
Source:
src/geom/Rectangle.js line 710

#### centerY : number

The y coordinate of the center of the Rectangle.

##### Type:
• number
Source:
src/geom/Rectangle.js line 729

#### empty : boolean

Determines whether or not this Rectangle object is empty. A Rectangle object is empty if its width or height is less than or equal to 0. If set to true then all of the Rectangle properties are set to 0. Gets or sets the Rectangles empty state.

##### Type:
• boolean
Source:
src/geom/Rectangle.js line 850

#### <readonly> halfHeight : number

Half of the height of the Rectangle.

##### Type:
• number
Source:
src/geom/Rectangle.js line 545

#### <readonly> halfWidth : number

Half of the width of the Rectangle.

##### Type:
• number
Source:
src/geom/Rectangle.js line 531

#### height : number

The height of the Rectangle. This value should never be set to a negative.

##### Type:
• number
Source:
src/geom/Rectangle.js line 44

#### left : number

The x coordinate of the left of the Rectangle. Changing the left property of a Rectangle object has no effect on the y and height properties. However it does affect the width property, whereas changing the x value does not affect the width property.

##### Type:
• number
Source:
src/geom/Rectangle.js line 627

#### <readonly> perimeter : number

The perimeter size of the Rectangle. This is the sum of all 4 sides.

##### Type:
• number
Source:
src/geom/Rectangle.js line 695

#### randomX : number

A random value between the left and right values (inclusive) of the Rectangle.

##### Type:
• number
Source:
src/geom/Rectangle.js line 748

#### randomY : number

A random value between the top and bottom values (inclusive) of the Rectangle.

##### Type:
• number
Source:
src/geom/Rectangle.js line 765

The sum of the x and width properties. Changing the right property of a Rectangle object has no effect on the x, y and height properties, however it does affect the width property.

##### Type:
• number
Source:
src/geom/Rectangle.js line 654

#### top : number

The y coordinate of the top of the Rectangle. Changing the top property of a Rectangle object has no effect on the x and width properties. However it does affect the height property, whereas changing the y value does not affect the height property.

##### Type:
• number
Source:
src/geom/Rectangle.js line 782

#### topLeft : Phaser.Point

The location of the Rectangles top left corner as a Point object.

##### Type:
Source:
src/geom/Rectangle.js line 810

#### topRight : Phaser.Point

The location of the Rectangles top right corner as a Point object. The location of the Rectangles top left corner as a Point object.

##### Type:
Source:
src/geom/Rectangle.js line 830

#### <readonly> type : number

The const type of this object.

##### Type:
• number
Source:
src/geom/Rectangle.js line 50

#### <readonly> volume : number

The volume of the Rectangle derived from width * height.

##### Type:
• number
Source:
src/geom/Rectangle.js line 680

#### width : number

The width of the Rectangle. This value should never be set to a negative.

##### Type:
• number
Source:
src/geom/Rectangle.js line 39

#### x : number

The x coordinate of the top-left corner of the Rectangle.

##### Type:
• number
Source:
src/geom/Rectangle.js line 29

#### y : number

The y coordinate of the top-left corner of the Rectangle.

##### Type:
• number
Source:
src/geom/Rectangle.js line 34

### Methods

#### <static> aabb(points [, out])

Calculates the Axis Aligned Bounding Box (or aabb) from an array of points.

##### Parameters:
Name Type Argument Description
`points` Array.<Phaser.Point>

The array of one or more points.

`out` Phaser.Rectangle <optional>

Optional Rectangle to store the value in, if not supplied a new Rectangle object will be created.

Source:
src/geom/Rectangle.js line 1165
##### Returns:

The new Rectangle object.

Type
Phaser.Rectangle

#### <static> clone(a [, output])

Returns a new Rectangle object with the same values for the x, y, width, and height properties as the original Rectangle object.

##### Parameters:
Name Type Argument Description
`a` Phaser.Rectangle

The Rectangle object.

`output` Phaser.Rectangle <optional>

Optional Rectangle object. If given the values will be set into the object, otherwise a brand new Rectangle object will be created and returned.

Source:
src/geom/Rectangle.js line 934
Type
Phaser.Rectangle

#### <static> contains(a, x, y)

Determines whether the specified coordinates are contained within the region defined by this Rectangle object.

##### Parameters:
Name Type Description
`a` Phaser.Rectangle

The Rectangle object.

`x` number

The x coordinate of the point to test.

`y` number

The y coordinate of the point to test.

Source:
src/geom/Rectangle.js line 976
##### Returns:

A value of true if the Rectangle object contains the specified point; otherwise false.

Type
boolean

#### <static> containsPoint(a, point)

Determines whether the specified point is contained within the rectangular region defined by this Rectangle object. This method is similar to the Rectangle.contains() method, except that it takes a Point object as a parameter.

##### Parameters:
Name Type Description
`a` Phaser.Rectangle

The Rectangle object.

`point` Phaser.Point

The point object being checked. Can be Point or any object with .x and .y values.

Source:
src/geom/Rectangle.js line 1014
##### Returns:

A value of true if the Rectangle object contains the specified point; otherwise false.

Type
boolean

#### <static> containsRaw(rx, ry, rw, rh, x, y)

Determines whether the specified coordinates are contained within the region defined by the given raw values.

##### Parameters:
Name Type Description
`rx` number

The x coordinate of the top left of the area.

`ry` number

The y coordinate of the top left of the area.

`rw` number

The width of the area.

`rh` number

The height of the area.

`x` number

The x coordinate of the point to test.

`y` number

The y coordinate of the point to test.

Source:
src/geom/Rectangle.js line 996
##### Returns:

A value of true if the Rectangle object contains the specified point; otherwise false.

Type
boolean

#### <static> containsRect(a, b)

Determines whether the first Rectangle object is fully contained within the second Rectangle object. A Rectangle object is said to contain another if the second Rectangle object falls entirely within the boundaries of the first.

##### Parameters:
Name Type Description
`a` Phaser.Rectangle

The first Rectangle object.

`b` Phaser.Rectangle

The second Rectangle object.

Source:
src/geom/Rectangle.js line 1028
##### Returns:

A value of true if the Rectangle object contains the specified point; otherwise false.

Type
boolean

#### <static> createFromBounds(a [, output])

Returns a new Rectangle object with the same values for the left, top, width, and height properties as the original object.

##### Parameters:
Name Type Argument Description
`a` any

An object with `left`, `top`, `width`, and `height` properties.

`output` Phaser.Rectangle <optional>

Optional Rectangle object. If given the values will be set into the object, otherwise a brand new Rectangle object will be created and returned.

Source:
src/geom/Rectangle.js line 957
Type
Phaser.Rectangle

#### <static> equals(a, b)

Determines whether the two Rectangles are equal. This method compares the x, y, width and height properties of each Rectangle.

##### Parameters:
Name Type Description
`a` Phaser.Rectangle

The first Rectangle object.

`b` Phaser.Rectangle

The second Rectangle object.

Source:
src/geom/Rectangle.js line 1049
##### Returns:

A value of true if the two Rectangles have exactly the same values for the x, y, width and height properties; otherwise false.

Type
boolean

#### <static> inflate(a, dx, dy)

Increases the size of the Rectangle object by the specified amounts. The center point of the Rectangle object stays the same, and its size increases to the left and right by the dx value, and to the top and the bottom by the dy value.

##### Parameters:
Name Type Description
`a` Phaser.Rectangle

The Rectangle object.

`dx` number

The amount to be added to the left side of the Rectangle.

`dy` number

The amount to be added to the bottom side of the Rectangle.

Source:
src/geom/Rectangle.js line 877
##### Returns:

This Rectangle object.

Type
Phaser.Rectangle

#### <static> inflatePoint(a, point)

Increases the size of the Rectangle object. This method is similar to the Rectangle.inflate() method except it takes a Point object as a parameter.

##### Parameters:
Name Type Description
`a` Phaser.Rectangle

The Rectangle object.

`point` Phaser.Point

The x property of this Point object is used to increase the horizontal dimension of the Rectangle object. The y property is used to increase the vertical dimension of the Rectangle object.

Source:
src/geom/Rectangle.js line 897
##### Returns:

The Rectangle object.

Type
Phaser.Rectangle

#### <static> intersection(a, b [, output])

If the Rectangle object specified in the toIntersect parameter intersects with this Rectangle object, returns the area of intersection as a Rectangle object. If the Rectangles do not intersect, this method returns an empty Rectangle object with its properties set to 0.

##### Parameters:
Name Type Argument Description
`a` Phaser.Rectangle

The first Rectangle object.

`b` Phaser.Rectangle

The second Rectangle object.

`output` Phaser.Rectangle <optional>

Optional Rectangle object. If given the intersection values will be set into this object, otherwise a brand new Rectangle object will be created and returned.

Source:
src/geom/Rectangle.js line 1078
##### Returns:

A Rectangle object that equals the area of intersection. If the Rectangles do not intersect, this method returns an empty Rectangle object; that is, a Rectangle with its x, y, width, and height properties set to 0.

Type
Phaser.Rectangle

#### <static> intersects(a, b)

Determines whether the two Rectangles intersect with each other. This method checks the x, y, width, and height properties of the Rectangles.

##### Parameters:
Name Type Description
`a` Phaser.Rectangle

The first Rectangle object.

`b` Phaser.Rectangle

The second Rectangle object.

Source:
src/geom/Rectangle.js line 1106
##### Returns:

A value of true if the specified object intersects with this Rectangle object; otherwise false.

Type
boolean

#### <static> intersectsRaw(left, right, top, bottom, tolerance)

Determines whether the object specified intersects (overlaps) with the given values.

##### Parameters:
Name Type Description
`left` number

The x coordinate of the left of the area.

`right` number

The right coordinate of the area.

`top` number

The y coordinate of the area.

`bottom` number

The bottom coordinate of the area.

`tolerance` number

A tolerance value to allow for an intersection test with padding, default to 0

Source:
src/geom/Rectangle.js line 1126
##### Returns:

A value of true if the specified object intersects with the Rectangle; otherwise false.

Type
boolean

#### <static> sameDimensions(a, b)

Determines if the two objects (either Rectangles or Rectangle-like) have the same width and height values under strict equality.

##### Parameters:
Name Type Description
`a` Rectangle-like

The first Rectangle object.

`b` Rectangle-like

The second Rectangle object.

Source:
src/geom/Rectangle.js line 1064
##### Returns:

True if the object have equivalent values for the width and height properties.

Type
boolean

#### <static> size(a [, output])

The size of the Rectangle object, expressed as a Point object with the values of the width and height properties.

##### Parameters:
Name Type Argument Description
`a` Phaser.Rectangle

The Rectangle object.

`output` Phaser.Point <optional>

Optional Point object. If given the values will be set into the object, otherwise a brand new Point object will be created and returned.

Source:
src/geom/Rectangle.js line 911
##### Returns:

The size of the Rectangle object

Type
Phaser.Point

#### <static> union(a, b [, output])

Adds two Rectangles together to create a new Rectangle object, by filling in the horizontal and vertical space between the two Rectangles.

##### Parameters:
Name Type Argument Description
`a` Phaser.Rectangle

The first Rectangle object.

`b` Phaser.Rectangle

The second Rectangle object.

`output` Phaser.Rectangle <optional>

Optional Rectangle object. If given the new values will be set into this object, otherwise a brand new Rectangle object will be created and returned.

Source:
src/geom/Rectangle.js line 1145
##### Returns:

A Rectangle object that is the union of the two Rectangles.

Type
Phaser.Rectangle

#### ceil()

Runs Math.ceil() on both the x and y values of this Rectangle.

Source:
src/geom/Rectangle.js line 171

#### ceilAll()

Runs Math.ceil() on the x, y, width and height values of this Rectangle.

Source:
src/geom/Rectangle.js line 183

#### centerOn(x, y)

Centers this Rectangle so that the center coordinates match the given x and y values.

##### Parameters:
Name Type Description
`x` number

The x coordinate to place the center of the Rectangle at.

`y` number

The y coordinate to place the center of the Rectangle at.

Source:
src/geom/Rectangle.js line 127
##### Returns:

This Rectangle object

Type
Phaser.Rectangle

#### clone( [output])

Returns a new Rectangle object with the same values for the x, y, width, and height properties as the original Rectangle object.

##### Parameters:
Name Type Argument Description
`output` Phaser.Rectangle <optional>

Optional Rectangle object. If given the values will be set into the object, otherwise a brand new Rectangle object will be created and returned.

Source:
src/geom/Rectangle.js line 287
Type
Phaser.Rectangle

#### contains(x, y)

Determines whether the specified coordinates are contained within the region defined by this Rectangle object.

##### Parameters:
Name Type Description
`x` number

The x coordinate of the point to test.

`y` number

The y coordinate of the point to test.

Source:
src/geom/Rectangle.js line 300
##### Returns:

A value of true if the Rectangle object contains the specified point; otherwise false.

Type
boolean

#### containsRect(b)

Determines whether the first Rectangle object is fully contained within the second Rectangle object. A Rectangle object is said to contain another if the second Rectangle object falls entirely within the boundaries of the first.

##### Parameters:
Name Type Description
`b` Phaser.Rectangle

The second Rectangle object.

Source:
src/geom/Rectangle.js line 314
##### Returns:

A value of true if the Rectangle object contains the specified point; otherwise false.

Type
boolean

#### copyFrom(source)

Copies the x, y, width and height properties from any given object to this Rectangle.

##### Parameters:
Name Type Description
`source` any

The object to copy from.

Source:
src/geom/Rectangle.js line 197
##### Returns:

This Rectangle object.

Type
Phaser.Rectangle

#### copyFromBounds(source)

Copies the left, top, width and height properties from any given object to this Rectangle.

##### Parameters:
Name Type Description
`source` any

The object to copy from.

Source:
src/geom/Rectangle.js line 210
##### Returns:

This Rectangle object.

Type
Phaser.Rectangle

#### copyTo(source)

Copies the x, y, width and height properties from this Rectangle to any given object.

##### Parameters:
Name Type Description
`source` any

The object to copy to.

Source:
src/geom/Rectangle.js line 223

This object.

Type
object

#### equals(b)

Determines whether the two Rectangles are equal. This method compares the x, y, width and height properties of each Rectangle.

##### Parameters:
Name Type Description
`b` Phaser.Rectangle

The second Rectangle object.

Source:
src/geom/Rectangle.js line 328
##### Returns:

A value of true if the two Rectangles have exactly the same values for the x, y, width and height properties; otherwise false.

Type
boolean

#### floor()

Runs Math.floor() on both the x and y values of this Rectangle.

Source:
src/geom/Rectangle.js line 145

#### floorAll()

Runs Math.floor() on the x, y, width and height values of this Rectangle.

Source:
src/geom/Rectangle.js line 157

#### getPoint( [position] [, out])

Returns a point based on the given position constant, which can be one of:

`Phaser.TOP_LEFT`, `Phaser.TOP_CENTER`, `Phaser.TOP_RIGHT`, `Phaser.LEFT_CENTER`, `Phaser.CENTER`, `Phaser.RIGHT_CENTER`, `Phaser.BOTTOM_LEFT`, `Phaser.BOTTOM_CENTER` and `Phaser.BOTTOM_RIGHT`.

This method returns the same values as calling Rectangle.bottomLeft, etc, but those calls always create a new Point object, where-as this one allows you to use your own.

##### Parameters:
Name Type Argument Description
`position` integer <optional>

One of the Phaser position constants, such as `Phaser.TOP_RIGHT`.

`out` Phaser.Point <optional>

A Phaser.Point that the values will be set in. If no object is provided a new Phaser.Point object will be created. In high performance areas avoid this by re-using an existing object.

Source:
src/geom/Rectangle.js line 423
##### Returns:

An object containing the point in its `x` and `y` properties.

Type
Phaser.Point

#### inflate(dx, dy)

Increases the size of the Rectangle object by the specified amounts. The center point of the Rectangle object stays the same, and its size increases to the left and right by the dx value, and to the top and the bottom by the dy value.

##### Parameters:
Name Type Description
`dx` number

The amount to be added to the left side of the Rectangle.

`dy` number

The amount to be added to the bottom side of the Rectangle.

Source:
src/geom/Rectangle.js line 241
##### Returns:

This Rectangle object.

Type
Phaser.Rectangle

#### intersection(b, out)

If the Rectangle object specified in the toIntersect parameter intersects with this Rectangle object, returns the area of intersection as a Rectangle object. If the Rectangles do not intersect, this method returns an empty Rectangle object with its properties set to 0.

##### Parameters:
Name Type Description
`b` Phaser.Rectangle

The second Rectangle object.

`out` Phaser.Rectangle

Optional Rectangle object. If given the intersection values will be set into this object, otherwise a brand new Rectangle object will be created and returned.

Source:
src/geom/Rectangle.js line 342
##### Returns:

A Rectangle object that equals the area of intersection. If the Rectangles do not intersect, this method returns an empty Rectangle object; that is, a Rectangle with its x, y, width, and height properties set to 0.

Type
Phaser.Rectangle

#### intersects(b)

Determines whether this Rectangle and another given Rectangle intersect with each other. This method checks the x, y, width, and height properties of the two Rectangles.

##### Parameters:
Name Type Description
`b` Phaser.Rectangle

The second Rectangle object.

Source:
src/geom/Rectangle.js line 356
##### Returns:

A value of true if the specified object intersects with this Rectangle object; otherwise false.

Type
boolean

#### intersectsRaw(left, right, top, bottom, tolerance)

Determines whether the coordinates given intersects (overlaps) with this Rectangle.

##### Parameters:
Name Type Description
`left` number

The x coordinate of the left of the area.

`right` number

The right coordinate of the area.

`top` number

The y coordinate of the area.

`bottom` number

The bottom coordinate of the area.

`tolerance` number

A tolerance value to allow for an intersection test with padding, default to 0

Source:
src/geom/Rectangle.js line 371
##### Returns:

A value of true if the specified object intersects with the Rectangle; otherwise false.

Type
boolean

#### offset(dx, dy)

Adjusts the location of the Rectangle object, as determined by its top-left corner, by the specified amounts.

##### Parameters:
Name Type Description
`dx` number

Moves the x value of the Rectangle object by this amount.

`dy` number

Moves the y value of the Rectangle object by this amount.

Source:
src/geom/Rectangle.js line 56
##### Returns:

This Rectangle object.

Type
Phaser.Rectangle

#### offsetPoint(point)

Adjusts the location of the Rectangle object using a Point object as a parameter. This method is similar to the Rectangle.offset() method, except that it takes a Point object as a parameter.

##### Parameters:
Name Type Description
`point` Phaser.Point

A Point object to use to offset this Rectangle object.

Source:
src/geom/Rectangle.js line 73
##### Returns:

This Rectangle object.

Type
Phaser.Rectangle

#### random( [out])

Returns a uniformly distributed random point from anywhere within this Rectangle.

##### Parameters:
Name Type Argument Description
`out` Phaser.Point | object <optional>

A Phaser.Point, or any object with public x/y properties, that the values will be set in. If no object is provided a new Phaser.Point object will be created. In high performance areas avoid this by re-using an existing object.

Source:
src/geom/Rectangle.js line 403
##### Returns:

An object containing the random point in its `x` and `y` properties.

Type
Phaser.Point

#### resize(width, height)

Resize the Rectangle by providing a new width and height. The x and y positions remain unchanged.

##### Parameters:
Name Type Description
`width` number

The width of the Rectangle. Should always be either zero or a positive value.

`height` number

The height of the Rectangle. Should always be either zero or a positive value.

Source:
src/geom/Rectangle.js line 268
##### Returns:

This Rectangle object

Type
Phaser.Rectangle

#### scale(x [, y])

Scales the width and height of this Rectangle by the given amounts.

##### Parameters:
Name Type Argument Description
`x` number

The amount to scale the width of the Rectangle by. A value of 0.5 would reduce by half, a value of 2 would double the width, etc.

`y` number <optional>

The amount to scale the height of the Rectangle by. A value of 0.5 would reduce by half, a value of 2 would double the height, etc.

Source:
src/geom/Rectangle.js line 107
##### Returns:

This Rectangle object

Type
Phaser.Rectangle

#### setTo(x, y, width, height)

Sets the members of Rectangle to the specified values.

##### Parameters:
Name Type Description
`x` number

The x coordinate of the top-left corner of the Rectangle.

`y` number

The y coordinate of the top-left corner of the Rectangle.

`width` number

The width of the Rectangle. Should always be either zero or a positive value.

`height` number

The height of the Rectangle. Should always be either zero or a positive value.

Source:
src/geom/Rectangle.js line 86
##### Returns:

This Rectangle object

Type
Phaser.Rectangle

#### sides( [top] [, right] [, bottom] [, left])

Creates or positions four Phaser.Line lines representing the Rectangle's sides.

##### Parameters:
Name Type Argument Description
`top` Phaser.Line <optional>
`right` Phaser.Line <optional>
`bottom` Phaser.Line <optional>
`left` Phaser.Line <optional>
Source:
src/geom/Rectangle.js line 477
##### Returns:
• An array containing four lines (if no arguments were given), or null.
Type
Array.<Phaser.Line>

#### size( [output])

The size of the Rectangle object, expressed as a Point object with the values of the width and height properties.

##### Parameters:
Name Type Argument Description
`output` Phaser.Point <optional>

Optional Point object. If given the values will be set into the object, otherwise a brand new Point object will be created and returned.

Source:
src/geom/Rectangle.js line 255
##### Returns:

The size of the Rectangle object.

Type
Phaser.Point

#### toString()

Returns a string representation of this object.

Source:
src/geom/Rectangle.js line 517
##### Returns:

A string representation of the instance.

Type
string

#### union(b [, out])

Adds two Rectangles together to create a new Rectangle object, by filling in the horizontal and vertical space between the two Rectangles.

##### Parameters:
Name Type Argument Description
`b` Phaser.Rectangle

The second Rectangle object.

`out` Phaser.Rectangle <optional>

Optional Rectangle object. If given the new values will be set into this object, otherwise a brand new Rectangle object will be created and returned.

Source:
src/geom/Rectangle.js line 389
##### Returns:

A Rectangle object that is the union of the two Rectangles.

Type
Phaser.Rectangle