uk.co.ordnancesurvey.android.maps

Class GridRect

java.lang.Object

uk.co.ordnancesurvey.android.maps.GridRect

public final class GridRect
extends Object

Represents a rectangular region on the OS Map.

Field Summary

Fields

Modifier and Type	Field and Description
double	maxX Right-most coordinate in metres
double	maxY
double	minX Left-most coordinate, in metres
double	minY

Constructor Summary

Constructors

Constructor and Description
GridRect(double x0, double y0, double x1, double y1) Construct a GridRect

Method Summary

Methods

Modifier and Type	Method and Description
GridPoint	center() Returns a GridPoint corresponding to the approximate center (may allocate an object).
static GridRect	fromCentreXYWH(double cX, double cY, double w, double h) Construct a GridRect with a centre coordinate and a width/height in metres.
GridPoint	ne() Returns a GridPoint corresponding to the NE corner (may allocate an object).
GridPoint	nw() Returns a GridPoint corresponding to the NW corner (may allocate an object).
GridPoint	se() Returns a GridPoint corresponding to the SE corner (may allocate an object).
GridPoint	sw() Returns a GridPoint corresponding to the SW corner (may allocate an object).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

minX

public final double minX

Left-most coordinate, in metres

maxX

public final double maxX

Right-most coordinate in metres

minY

public final double minY

maxY

public final double maxY

Constructor Detail

GridRect

public GridRect(double x0,
        double y0,
        double x1,
        double y1)

Construct a GridRect

Parameters:

x0 - South-West Eastings

y0 - South-West Northings

x1 - North-East Eastings

y1 - North-East Northings

Method Detail

fromCentreXYWH

public static GridRect fromCentreXYWH(double cX,
                      double cY,
                      double w,
                      double h)

Construct a GridRect with a centre coordinate and a width/height in metres.

Parameters:

cX - Centre Eastings

cY - Centre Northings

w - Width in metres

h - Height in metres

Returns:

new GridRect

sw

public GridPoint sw()

Returns a GridPoint corresponding to the SW corner (may allocate an object).

Returns:

GridPoint for the SW corner

ne

public GridPoint ne()

Returns a GridPoint corresponding to the NE corner (may allocate an object).

Returns:

GridPoint for the NE corner

nw

public GridPoint nw()

Returns a GridPoint corresponding to the NW corner (may allocate an object).

Returns:

GridPoint for the NW corner

se

public GridPoint se()

Returns a GridPoint corresponding to the SE corner (may allocate an object).

Returns:

GridPoint for the SE corner

center

public GridPoint center()

Returns a GridPoint corresponding to the approximate center (may allocate an object).

Returns:

GridPoint for the center