Class: Rectangle

Tiny. 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 Tiny.Rectangle(x, y, width, height)

Name Type Default Description
x number 0 optional

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

y number 0 optional

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

width number 0 optional

The overall width of this rectangle

height number 0 optional

The overall height of this rectangle

Members

static,constantTiny.Rectangle.EMPTY

A constant empty rectangle.

bottomnumber

returns the bottom edge of the rectangle

heightnumber

Default Value:
  • 0

leftnumber

returns the left edge of the rectangle

returns the right edge of the rectangle

topnumber

returns the top edge of the rectangle

readonlytypenumber

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

Default Value:
  • Tiny.SHAPES.RECT
See:

widthnumber

Default Value:
  • 0

xnumber

Default Value:
  • 0

ynumber

Default Value:
  • 0

Methods

Creates a clone of this Rectangle

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

contains(x, y){boolean}

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

Copies another rectangle to this one.

Name Type Description
rectangle Tiny.Rectangle

The rectangle to copy.

Returns:
Type Description
Tiny.Rectangle Returns itself.

Enlarges this rectangle to include the passed rectangle.

Name Type Description
rectangle Tiny.Rectangle

The rectangle to include.

Fits this rectangle around the passed one.

Name Type Description
rectangle Tiny.Rectangle

The rectangle to fit.

pad(paddingX, paddingY)

Pads the rectangle making it grow in all directions.

Name Type Description
paddingX number

The horizontal padding amount.

paddingY number optional

The vertical padding amount.

Documentation generated by JSDoc 3.4.3 on Mon Dec 03 2018 17:48:52 GMT+0800 (CST)