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 an MMLocation or MMLatLon object for the southwest and northeast of the rectangle.

Parameters:
south_west - South-west point of the rectangle, or an array of points.
north_east - (optional) 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 rectangle 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 northeast of the rectangle.

Returns:
The point at the northeast corner of the rectangle.

getNorthWest

MMLatLon getNorthWest()

Gets the point at the northwest of the rectangle.

Returns:
The point at the northwest corner of the rectangle.

getSouthEast

MMLatLon getSouthEast()

Gets the point at the southeast of the rectangle.

Returns:
The point at the southeast corner of the rectangle.

getSouthWest

MMLatLon getSouthWest()

Gets the point at the southwest of the rectangle.

Returns:
The point at the southwest 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 rectangle intersects the given bounds rectangle.

reset

void reset( <Object> south_west, <Object> north_east )

A method to reset the contents of a bounds object, allows re-use. The object will be completely reset as if it was a new object called with the arguments given. It accepts a south_west and north_east point, or an array of points in the same way as the constructor.

Parameters:
south_west - South-west point of the rectangle, or an array of points.
north_east - (optional) North-east point of the 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)]".