com.here.android.mpa.common

Class GeoPolyline

java.lang.Object

com.here.android.mpa.common.GeoPolyline

Direct Known Subclasses:

GeoPolygon

public class GeoPolyline
extends java.lang.Object

Interface representing a GeoPolyline. A GeoPolyline consists of 2 or more points. This class can be used with MapPolyline to render a polyline.

Constructor Summary

Constructors

Constructor and Description
GeoPolyline() Public Constructor
GeoPolyline(java.util.List<GeoCoordinate> points) Creates a GeoPolyline from a list of points.

Method Summary

Modifier and Type	Method and Description
void	add(GeoCoordinate point) Adds a new point into the GeoPolyline.
void	add(java.util.List<GeoCoordinate> points) Adds a list of new points into the GeoPolyline.
void	clear() Removes all points from the GeoPolyline
boolean	contains(GeoCoordinate point) Checks to see if a GeoCoordinate resides within this GeoPolyline.
boolean	equals(java.lang.Object other)
java.util.List<GeoCoordinate>	getAllPoints() Gets all points in the GeoPolyline.
GeoBoundingBox	getBoundingBox() Gets the geographic bounding box that contains this GeoPolyline.
GeoCoordinate	getNearest(GeoCoordinate point) Gets the GeoCoordinate along the path of the MapPolyline that is closest to the specified GeoCoordinate.
int	getNearestIndex(GeoCoordinate point) Gets the index of the point that is closest to the specified GeoCoordinate.
int	getNumberOfPoints() Gets the total number of points currently in the GeoPolyline.
GeoCoordinate	getPoint(int index) Gets a point in the GeoPolyline.
int	hashCode()
void	insert(GeoCoordinate point, int index) Inserts a point into the GeoPolyline at index.
double	length() The geographical length of this GeoPolyline.
void	remove(int index) Removes a specific point from the GeoPolyline at the given index.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoPolyline

public GeoPolyline()

Public Constructor

GeoPolyline

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

Creates a GeoPolyline from a list of points.

Parameters:

points - A list of points to form the GeoPolyline

See Also:

MapPolyline

Method Detail

getNumberOfPoints

public final int getNumberOfPoints()

Gets the total number of points currently in the GeoPolyline.

Returns:

int total number of points

getPoint

public final GeoCoordinate getPoint(int index)

Gets a point in the GeoPolyline.

Parameters:

index - index of the point to get.

Returns:

GeoCoordinate. Returns null if the index is out of bound.

getAllPoints

public final java.util.List<GeoCoordinate> getAllPoints()

Gets all points in the GeoPolyline.

Returns:

A list of GeoCoordinate.

add

public void add(java.util.List<GeoCoordinate> points)

Adds a list of new points into the GeoPolyline.

Parameters:

points - A list of {code GeoCoordinate}s to be added

add

public void add(GeoCoordinate point)

Adds a new point into the GeoPolyline.

Parameters:

point - Point to be added

insert

public void insert(GeoCoordinate point,
                   int index)

Inserts a point into the GeoPolyline at index.

Parameters:

point - Point to be added

index - Index to add the point into the list. index must be within the bounds of 0 and current count of points.

remove

public void remove(int index)

Removes a specific point from the GeoPolyline at the given index.

Parameters:

index - index of the point to be removed.

clear

public void clear()

Removes all points from the GeoPolyline

length

public double length()

The geographical length of this GeoPolyline.

Returns:

Length in meters.

getNearestIndex

public int getNearestIndex(GeoCoordinate point)

Gets the index of the point that is closest to the specified GeoCoordinate.

Parameters:

point - A GeoCoordinate reference point for finding the nearest point's list index

Returns:

The list index of the point that is closest to the specified GeoCoordinate

See Also:

GeoPolyline.getNearest(GeoCoordinate)

getNearest

public GeoCoordinate getNearest(GeoCoordinate point)

Gets the GeoCoordinate along the path of the MapPolyline that is closest to the specified GeoCoordinate.

Parameters:

point - A GeoCoordinate reference point for finding the nearest GeoCoordinate along the MapPolyline path

Returns:

The GeoCoordinate along the MapPolyline path that is closest to the specified GeoCoordinate

See Also:

GeoPolyline.getNearestIndex(GeoCoordinate)

contains

public boolean contains(GeoCoordinate point)

Checks to see if a GeoCoordinate resides within this GeoPolyline.

Parameters:

point - The coordinate that will be used to match against the points in this GeoPolyline

Returns:

boolean true if the point is in this GeoPolyline

getBoundingBox

public GeoBoundingBox getBoundingBox()

Gets the geographic bounding box that contains this GeoPolyline.

Returns:

GeoBoundingBox that contains this GeoPolyline. Can be null if the line has fewer than 2 points.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

Override:

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Override: