net.agmodel.physical
Interface GeographicalArea

All Known Implementing Classes:

GeographicalBox, GeographicalPolygon, RegionImpl

public interface GeographicalArea

Represents a portion of the globe in 3 dimensions

Author:

Matthew Laurenson

Field Summary

static double	EVEREST Height of Mt Everest in metres (Highest point on earth, climbed by New Zealand Sir Edmund Hillary in 1953)
static double	METRESPERDEGREEOFLATITUDE
static double	METRESPERDEGREEOFLONGATEQUATOR
static double	METRESPERPIXEL

Method Summary

boolean	contains(GeographicalArea anotherArea) Indicate whether the area passed falls entirely within this area
boolean	contains(Location2D point) Indicate whether a point is within the area
GeographicalBox	getBoundingBox() Return a box which bounds the area.
boolean	isUnknown() Indicates whether the bounds of this area are unknown.
boolean	overlapsWith(GeographicalArea area) Indicate whether the supplied area overlaps with this area.

Field Detail

EVEREST

public static final double EVEREST

Height of Mt Everest in metres (Highest point on earth, climbed by New Zealand Sir Edmund Hillary in 1953)

See Also:

Constant Field Values

METRESPERPIXEL

public static final double METRESPERPIXEL

See Also:

Constant Field Values

METRESPERDEGREEOFLATITUDE

public static final double METRESPERDEGREEOFLATITUDE

See Also:

Constant Field Values

METRESPERDEGREEOFLONGATEQUATOR

public static final double METRESPERDEGREEOFLONGATEQUATOR

See Also:

Constant Field Values

Method Detail

contains

public boolean contains(Location2D point)

Indicate whether a point is within the area

Parameters:

point - the point of interest

Returns:

true if it is, and false if it isn't

contains

public boolean contains(GeographicalArea anotherArea)

Indicate whether the area passed falls entirely within this area

Parameters:

anotherArea - the area of interest

Returns:

true if both areas are known, and the other area is entirely within the bounds of this area, false otherwise

getBoundingBox

public GeographicalBox getBoundingBox()

Return a box which bounds the area. This can be used as the basis of approximate implementations of overlapsWith for arbitrary shapes. If isUnknown() returns true for the area, then returns GeographicalBox.UNKNOWN

Returns:

a 3 dimensional bounding box

overlapsWith

public boolean overlapsWith(GeographicalArea area)

Indicate whether the supplied area overlaps with this area. See getBoundingBox for a way of approximately implementing this for arbitrary shapes. Suggestions for improvement welcome. If isUnknown() returns true for either or both areas, the result is false;

Parameters:

area - the area of interest

isUnknown

public boolean isUnknown()

Indicates whether the bounds of this area are unknown.

Returns:

true if the bounds are unknown.