Rect

This object represents a rectangle in a 2D space.

Constructor function.

var myObject = new Rect();

var myObject = new Rect(otherRect);

var myObject = new Rect(left, top, width, height);

1. otherRect - (Rect) other Rect to copy
2. left - (integer) left position of the Rect
3. top - (integer) top position of the Rect
4. width - (integer) width of the Rect
5. height - (integer) height of the Rect

• (ParameterTypeError) incorrect parameter type
• (ParameterCountError) incorrect parameter count

Create a Rect representing an empty rectangle.

var myObject = new Rect();

Create a Rect representing a copy of otherRect.

var myObject = new Rect(otherRect);

Create a Rect representing a rectangle.

var myObject = new Rect(50, 75, 100, 100);

Returns a copy of this Rect.

myObject.clone();

• (Rect) a copy of this Rect

var copyOfMyObject = myObject.clone();

Returns true if this Rect and another are referencing the same rectangle.

myObject.equals(other);

1. other - (Rect) another Rect

• (bool) true if other is referencing the same rectangle

if(myFirstObject.equals(mySecondObject))
	//Do something

Returns a string representing this Rect.

myObject.toString();

• (string) a string representing this Rect

Console.print(myObject.toString());

This method is automatically called when trying to convert a Rect to a string.

Normalizes this Rect; sets it to a Rect that has a non-negative width and height.

myObject.normalize();

• (Rect) this Rect

Sets the top value of this Rect.

myObject.setTop(top);

1. top - (integer) the top value

• (Rect) this Rect

Sets the bottom value of this Rect.

myObject.setBottom(bottom);

1. bottom - (integer) the bottom value

• (Rect) this Rect

Sets the left value of this Rect.

myObject.setLeft(left);

1. left - (integer) the left value

• (Rect) this Rect

Sets the right value of this Rect.

myObject.setRight(right);

1. right - (integer) the right value

• (Rect) this Rect

Sets the x value of this Rect.

myObject.setX(x);

1. x - (integer) the x value

• (Rect) this Rect

Sets the y value of this Rect.

myObject.setY(y);

1. y - (integer) the y value

• (Rect) this Rect

Sets the width of this Rect.

myObject.setWidth(width);

1. width - (integer) the width

• (Rect) this Rect

Sets the height of this Rect.

myObject.setHeight(height);

1. height - (integer) the height

• (Rect) this Rect

Sets the size of this Rect.

myObject.setSize(size);

1. size - (Size) the new size

• (Rect) this Rect

Sets the coordinates of the rectangle's top-left corner to (x1, y1) and the coordinates of its bottom-right corner to (x2, y2).

myObject.setCoords(x1, y1, x2, y2);

1. x1 - (integer) the x coordinate of the top-left corner
2. x2 - (integer) the x coordinate of the bottom-right corner
3. y1 - (integer) the y coordinate of the top-left corner
4. y2 - (integer) the y coordinate of the bottom-right corner

• (Rect) this Rect

Sets the rectangle of this Rect.

myObject.setRect(x, y, width, height);

1. x - (integer) the x coordinate of the top-left corner
2. y - (integer) the y coordinate of the top-left corner
3. width - (integer) the width of this Rect
4. height - (integer) the height of this Rect

• (Rect) this Rect

Translates this Rect using a Point.

myObject.translate(point);

1. point - (Point) the translate distance

• (Rect) this Rect

Returns true if a Point or a Rect is contained within this Rect.

myObject.contains(point);

myObject.contains(rect);

myObject.contains(x, y);

myObject.contains(left, top, width, height);

1. point - (Point) the point to check
2. rect - (Rect) the rectangle to check
3. x - (integer) the x coordinate of the point to check
4. y - (integer) the y coordinate of the point to check
5. left - (integer) left position of the rectangle to check
6. top - (integer) top position of the rectangle to check
7. width - (integer) width of the rectangle to check
8. height - (integer) height of the rectangle to check

• (Rect) this Rect

Returns the bounding rectangle of this Rect united with another Rect.

myObject.united(rect);

1. rect - (Rect) the rectangle to unite

• (Rect) a new Rect

Returns the bounding rectangle of this Rect intersected with another Rect.

myObject.intersected(rect);

1. rect - (Rect) the rectangle to intersect

• (Rect) a new Rect

Returns true if this Rect intersects another.

myObject.intersects(rect);

1. rect - (Rect) the rectangle to check

• (boolean) true if this Rect intersects another

Returns true if this Rect is empty.

myObject.isEmpty();

• (boolean) true if this Rect is empty

Returns a Point representing the center of this Rect.

myObject.center();

• (Point) the center of this Rect

Returns a Size representing the size of this Rect.

myObject.size();

• (Size) the size of this Rect

Returns the width of this Rect.

myObject.width();

• (integer) the width of this Rect

Returns the height of this Rect.

myObject.height();

• (integer) the height of this Rect

Returns the x coordinate of this Rect.

myObject.x();

• (integer) the x coordinate of this Rect

Returns the y coordinate of this Rect.

myObject.y();

• (integer) the y coordinate of this Rect

Returns the left coordinate of this Rect.

myObject.left();

• (integer) the left coordinate of this Rect

Returns the right coordinate of this Rect.

myObject.right();

• (integer) the top coordinate of this Rect

Returns the top coordinate of this Rect.

myObject.top();

• (integer) the top coordinate of this Rect

Returns the bottom coordinate of this Rect.

myObject.bottom();

• (integer) the bottom coordinate of this Rect

The width of this Point. (integer)

The height of this Point. (integer)

The x coordinate of this Point. (integer)

The y coordinate of this Point. (integer)

The left coordinate of this Point. (integer)

The right coordinate of this Point. (integer)

The top coordinate of this Point. (integer)

The bottom coordinate of this Point. (integer)