Class MMBounds

Object
   |
   +--MMBounds

class MMBounds

Defined in MultimapAPI

Constructor Detail

MMBounds

MMBounds( <Object> south_west, <Object> north_east )

An object for storing information about a rectangular bounding box on a map. Arguments can be passed in two ways. Either you may pass in an array of MMLocation, MMLatLon and MMMarkerOverlay objects, or you can pass in a MMLocation or MMLatLon object for the south west and north east of the rectangle.

Parameters:
south_west - South-west point of the rectangle.
north_east - North-east point of the rectangle.

contains

boolean contains( <Object> point )

Returns true if the rectangle bounds contain the given point.

Parameters:
point - Point to check for.

Returns:
True if the point is within the bounds, false otherwise.

containsBounds

boolean containsBounds( <MMBounds> other )

Returns true if this bounds rectangle contains the given bounds rectangle.

Parameters:
other - The other rectangle to check.

Returns:
Returns true if this bounds rectange contains the given bounds rectangle.

copy

MMLocation copy()

Function to return a copy of the object in a new object.

Returns:
A new object containing the same data as this object.

extend

void extend( <Object> point )

Extends the bounds to contain the given point. Extends the bounds by the smallest amount possible.

Parameters:
point - Point to extend the bounds by.

getCenter

MMLatLon getCenter()

Retrieves the center point of the bounded rectangle.

Returns:
The center point of the bounded rectangle.

getNorthEast

MMLatLon getNorthEast()

Gets the point at the north-east of the rectangle.

Returns:
The point at the north-east corner of the rectangle.

getNorthWest

Object getNorthWest()

getSouthEast

Object getSouthEast()

getSouthWest

MMLatLon getSouthWest()

Gets the point at the south-west of the rectangle.

Returns:
The point at the south-west corner of the rectangle.

intersects

boolean intersects( <MMBounds> other )

Returns true if this bounds rectangle intersects the given bounds rectangle.

Parameters:
other - The other rectangle to check.

Returns:
Returns true if this bounds rectange intersects the given bounds rectangle.

toString

String toString()

Function to return a simple string representation of the object.

Returns:
Formatted version of the object as "[(swlat,swlon), (nelat,nelon)]".