Class Rectangle

constructor

• new Rectangle(
      x?: string | number,
      y?: string | number,
      width?: string | number,
      height?: string | number,
  ): Rectangle

  Parameters

  • Optionalx: string | number

    The X coordinate of the upper-left corner of the rectangle

  • Optionaly: string | number

    The Y coordinate of the upper-left corner of the rectangle

  • Optionalwidth: string | number

    The overall width of the rectangle

  • Optionalheight: string | number

    The overall height of the rectangle

  Returns Rectangle

height

0
Copy

Readonlytype

PIXI.SHAPES.RECT
Copy

width

0
Copy

x

0
Copy

y

0
Copy

bottom

• get bottom(): number

  Returns the bottom edge of the rectangle.

  Returns number

left

• get left(): number

  Returns the left edge of the rectangle.

  Returns number

right

• get right(): number

  Returns the right edge of the rectangle.

  Returns number

top

• get top(): number

  Returns the top edge of the rectangle.

  Returns number

StaticEMPTY

• get EMPTY(): Rectangle

  A constant empty rectangle.

  Returns Rectangle

ceil

• ceil(resolution?: number, eps?: number): this

  Enlarges rectangle that way its corners lie on grid

  Parameters

  • Optionalresolution: number

    resolution

  • Optionaleps: number

    precision

  Returns this

  Returns itself.

clone

• clone(): Rectangle

  Creates a clone of this Rectangle

  Returns Rectangle

  a copy of the rectangle

contains

• contains(x: number, y: number): boolean

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

  Parameters

  • x: number

    The X coordinate of the point to test

  • y: number

    The Y coordinate of the point to test

  Returns boolean

  Whether the x/y coordinates are within this Rectangle

copyFrom

• copyFrom(rectangle: Rectangle): Rectangle

  Copies another rectangle to this one.

  Parameters

  • rectangle: Rectangle

    The rectangle to copy from.

  Returns Rectangle

  Returns itself.

copyTo

• copyTo(rectangle: Rectangle): Rectangle

  Copies this rectangle to another one.

  Parameters

  • rectangle: Rectangle

    The rectangle to copy to.

  Returns Rectangle

  Returns given parameter.

enlarge

• enlarge(rectangle: Rectangle): this

  Enlarges this rectangle to include the passed rectangle.

  Parameters

  • rectangle: Rectangle

    The rectangle to include.

  Returns this

  Returns itself.

fit

• fit(rectangle: Rectangle): this

  Fits this rectangle around the passed one.

  Parameters

  • rectangle: Rectangle

    The rectangle to fit.

  Returns this

  Returns itself.

intersects

• intersects(other: Rectangle, transform?: Matrix): boolean

  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.

  Parameters

  • other: Rectangle

    The Rectangle to intersect with this.

  • Optionaltransform: Matrix

    The transformation matrix of other.

  Returns boolean

  A value of true if the transformed other Rectangle intersects with this; otherwise false.

pad

• pad(paddingX?: number, paddingY?: number): this

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

  Parameters

  • OptionalpaddingX: number

    The horizontal padding amount.

  • OptionalpaddingY: number

    The vertical padding amount.

  Returns this

  Returns itself.