PixiJS

Class: Rectangle

PIXI.Rectangle

Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height.

new PIXI.Rectangle (x, y, width, height)

Rectangle.ts:43
Name Type Default Description
x string | number 0

The X coordinate of the upper-left corner of the rectangle
y string | number 0

The Y coordinate of the upper-left corner of the rectangle
width string | number 0

The overall width of the rectangle
height string | number 0

The overall height of the rectangle

Members

PIXI.Rectangle.EMPTY PIXI.Rectangle static

A constant empty rectangle.

bottom number

Returns the bottom edge of the rectangle.

height number

Default Value:
  • 0

left number

Returns the left edge of the rectangle.

Returns the right edge of the rectangle.

top number

Returns the top edge of the rectangle.

type SHAPES.RECT readonly

The type of the object, mainly used to avoid instanceof checks

Default Value:
  • PIXI.SHAPES.RECT
See:

width number

Default Value:
  • 0

x number

Default Value:
  • 0

y number

Default Value:
  • 0

Methods

ceil (resolution, eps) this

Rectangle.ts:285

Enlarges rectangle that way its corners lie on grid

Name Type Default Description
resolution number 1

resolution
eps number 0.001

precision
Returns:
Type Description
this Returns itself.

clone () PIXI.Rectangle

Rectangle.ts:88

Creates a clone of this Rectangle

Returns:
Type Description
PIXI.Rectangle a copy of the rectangle

contains (x, y) boolean

Rectangle.ts:127

Checks whether the x and y coordinates given are contained within this Rectangle

Name Type Description
x number

The X coordinate of the point to test
y number

The Y coordinate of the point to test
Returns:
Type Description
boolean Whether the x/y coordinates are within this Rectangle

containsRect (other) boolean

rectangleExtras.ts:3

Determines whether the other Rectangle is contained within this Rectangle object. Rectangles that occupy the same space are considered to be containing each other. Rectangles without area (width or height equal to zero) can't contain anything, not even other arealess rectangles.

Note: Only available with @pixi/math-extras.

Name Type Description
other Rectangle

The Rectangle to fit inside this.
Returns:
Type Description
boolean A value of true if this Rectangle contains other; otherwise false.

copyFrom (rectangle) PIXI.Rectangle

Rectangle.ts:97

Copies another rectangle to this one.

Name Type Description
rectangle PIXI.Rectangle

The rectangle to copy from.
Returns:
Type Description
PIXI.Rectangle Returns itself.

copyTo (rectangle) PIXI.Rectangle

Rectangle.ts:112

Copies this rectangle to another one.

Name Type Description
rectangle PIXI.Rectangle

The rectangle to copy to.
Returns:
Type Description
PIXI.Rectangle Returns given parameter.

enlarge (rectangle) this

Rectangle.ts:305

Enlarges this rectangle to include the passed rectangle.

Name Type Description
rectangle PIXI.Rectangle

The rectangle to include.
Returns:
Type Description
this Returns itself.

equals (other) boolean

rectangleExtras.ts:25

Accepts other Rectangle and returns true if the given Rectangle is equal to this Rectangle.

Note: Only available with @pixi/math-extras.

Name Type Description
other Rectangle

The Rectangle to compare with this
Returns:
Type Description
boolean Returns true if all x, y, width, and height are equal.

fit (rectangle) this

Rectangle.ts:265

Fits this rectangle around the passed one.

Name Type Description
rectangle PIXI.Rectangle

The rectangle to fit.
Returns:
Type Description
this Returns itself.

intersection (other, outRect) Rectangle

rectangleExtras.ts:44

If the area of the intersection between the Rectangles other and this is not zero, returns the area of intersection as a Rectangle object. Otherwise, return an empty Rectangle with its properties set to zero. Rectangles without area (width or height equal to zero) can't intersect or be intersected and will always return an empty rectangle with its properties set to zero.

Note: Only available with @pixi/math-extras.

Name Type Attributes Description
other Rectangle

The Rectangle to intersect with this.
outRect Rectangle <optional>

A Rectangle object in which to store the value, optional (otherwise will create a new Rectangle).
Returns:
Type Description
Rectangle The intersection of this and other.

intersects (other, transform) boolean

Rectangle.ts:151

Determines whether the other Rectangle transformed by transform intersects with this Rectangle object. Returns true only if the area of the intersection is >0, this means that Rectangles sharing a side are not overlapping. Another side effect is that an arealess rectangle (width or height equal to zero) can't intersect any other rectangle.

Name Type Attributes Description
other Rectangle

The Rectangle to intersect with this.
transform Matrix <optional>

The transformation matrix of other.
Returns:
Type Description
boolean A value of true if the transformed other Rectangle intersects with this; otherwise false.

pad (paddingX, paddingY) this

Rectangle.ts:247

Pads the rectangle making it grow in all directions. If paddingY is omitted, both paddingX and paddingY will be set to paddingX.

Name Type Default Description
paddingX number 0

The horizontal padding amount.
paddingY

The vertical padding amount.
Returns:
Type Description
this Returns itself.

union (other, outRect) Rectangle

rectangleExtras.ts:94

Adds this and other Rectangles together to create a new Rectangle object filling the horizontal and vertical space between the two rectangles.

Note: Only available with @pixi/math-extras.

Name Type Attributes Description
other Rectangle

The Rectangle to unite with this.
outRect Rectangle <optional>

A Rectangle object in which to store the value, optional (otherwise will create a new Rectangle).
Returns:
Type Description
Rectangle The union of this and other.