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
-
rightnumber
-
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
-
ceil(resolution, eps)
-
Enlarges rectangle that way its corners lie on grid
Name Type Default Description resolution
number 1 optional resolution
eps
number 0.001 optional precision
- Version:
- 1.4.0
-
clone() ❯ {Tiny.Rectangle}
-
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 -
copy(rectangle) ❯ {Tiny.Rectangle}
-
Copies another rectangle to this one.
Name Type Description rectangle
Tiny.Rectangle The rectangle to copy.
Returns:
Type Description Tiny.Rectangle Returns itself. -
enlarge(rectangle)
-
Enlarges this rectangle to include the passed rectangle.
Name Type Description rectangle
Tiny.Rectangle The rectangle to include.
-
fit(rectangle)
-
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.