com.here.android.mpa.common

Class GeoPolygon

java.lang.Object

com.here.android.mpa.common.GeoPolyline

com.here.android.mpa.common.GeoPolygon

public final class GeoPolygon
extends GeoPolyline

Represents a GeoPolygon a polygon object defined in terms of the geographic coordinates of its vertices.

The only difference between a GeoPolygon and a GeoPolyline is that the polygon represents a closed loop of points. The minimum number of points in a GeoPolygon must be three.

This class can be used with MapPolygon to render a polygon.

Constructor Summary

Constructors

Constructor and Description
GeoPolygon() Default Constructor
GeoPolygon(java.util.List<GeoCoordinate> points) Constructor that creates a new instance of GeoPolygon from a list of points.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other) Checks whether the given GeoPolygon object is equal to that supplied by the caller.
int	hashCode() Obtains the hash code for the given object.

Methods inherited from class com.here.android.mpa.common.GeoPolyline

add, add, clear, contains, getBoundingBox, getNearest, getNearestIndex, getNumberOfPoints, getPoint, insert, length, remove

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoPolygon

public GeoPolygon()

Default Constructor

GeoPolygon

public GeoPolygon(java.util.List<GeoCoordinate> points)

Constructor that creates a new instance of GeoPolygon from a list of points.

Parameters:

points - A list of points to form the GeoPolygon.

See Also:

MapPolygon

Method Detail

hashCode

public int hashCode()

Obtains the hash code for the given object.

Overrides:

hashCode in class GeoPolyline

Returns:

A value representing the hash code.

equals

public boolean equals(java.lang.Object other)

Checks whether the given GeoPolygon object is equal to that supplied by the caller. Two objects are equal if they are both instances of GeoPolygon and the coordinates of their vertices are the same.

Overrides:

equals in class GeoPolyline

Parameters:

other - A polygon object to compare to the given polygon.

Returns:

true if the polygons are equal, otherwise false.