API Docs for: 0.0.2
Show:

Atlantis.Rectangle Class

Defined in: Framework\Rectangle.js:11
Module: Framework
Parent Module: Atlantis

Create a rectangle structure.

Constructor

Atlantis.Rectangle

(
  • x
  • y
  • width
  • height
)

Defined in Framework\Rectangle.js:11

Parameters:

  • x Number

    A value for X coordinate.

  • y Number

    A value for Y coordinate.

  • width Number

    A value for the width of the rectangle.

  • height Number

    A value for the height of the rectangle

Methods

add

(
  • rectangle
)

Defined in Framework\Rectangle.js:35

Add a rectangle to this rectangle.

Parameters:

contains

(
  • X
  • Y
)

Defined in Framework\Rectangle.js:83

Determine if a Rectangle, Point or coordinates are contains in rectangle

Parameters:

  • X Number | Point | Rectangle

    coordinate or an instance of Point or an instance of Rectangle.

  • Y Number

    coordinate.

contains

()

Defined in Framework\Rectangle.js:98

divide

(
  • rectangle
)

Defined in Framework\Rectangle.js:47

Divide a rectangle to this rectangle.

Parameters:

getBottom

() Number

Defined in Framework\Rectangle.js:139

Gets the bottom value.

Returns:

Number:

Bottom coordinate (y + height)

getCenter

() Atlantis.Point

Defined in Framework\Rectangle.js:166

Gets the center of the rectangle.

Returns:

Atlantis.Point:

A point of the center of the rectangle.

getLeft

() Number

Defined in Framework\Rectangle.js:148

Gets the left value.

Returns:

Number:

Left coordinate (x)

getRight

() Number

Defined in Framework\Rectangle.js:157

Gets the right value.

Returns:

Number:

Right value (x + width)

getTop

() Number

Defined in Framework\Rectangle.js:130

Gets the top value.

Returns:

Number:

Top coordinate (y)

multiply

(
  • rectangle
)

Defined in Framework\Rectangle.js:59

Multiply a rectangle to this rectangle.

Parameters:

subtract

(
  • rectangle
)

Defined in Framework\Rectangle.js:71

Subtract a rectangle to this rectangle.

Parameters:

toString

() String

Defined in Framework\Rectangle.js:266

Gets a string from this object.

Returns:

String: