com.tomtom.speedtools.geometry

Class GeoPolyLine

java.lang.Object

com.tomtom.speedtools.geometry.GeoObject

com.tomtom.speedtools.geometry.GeoPolyLine

All Implemented Interfaces:

JsonRenderable

@Immutable
public final class GeoPolyLine
extends GeoObject

Geometric line between a number of points. Constructor: GeoPolyLine()

Constructor Summary

Constructors

Constructor and Description
GeoPolyLine(List<GeoPoint> points) Create a polyline.

Method Summary

Modifier and Type	Method and Description
List<GeoLine>	asLines() Get the polyline as a series of connected lines.
boolean	canEqual(Object obj)
boolean	equals(Object obj)
GeoPoint	get(int i) Get point.
GeoPoint	getCenter() Return center == Mid point of bounding box of polyline.
double	getLengthMeters() Return length of line in meters (approximation).
GeoLine	getLine(int i) Get a single line segment.
GeoPoint	getOrigin() Return origin == first point.
GeoPoint	getPointAtOffset(double offsetInMeters) Return an (interpolated) point on a polyline, given an offset in meters.
int	hashCode()
GeoPolyLine	moveTo(GeoPoint origin) Move a geo object to specific origin.
int	size() Get number of points in polyline.
GeoPolyLine	translate(GeoVector vector) Translate a geo object with an Easting and Northing value.

Methods inherited from class com.tomtom.speedtools.geometry.GeoObject

hashCodeSuper, toJson, toString, translate, translate

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoPolyLine

public GeoPolyLine(@Nonnull
                   List<GeoPoint> points)

Create a polyline. A polyline is defined as a series of (shortest) lines between consecutive points. Either all points in the polyline have an elevation, or none have. If at least one point has an elevation, points with missing elevations will have an elevation added to them, which is the same elevation as one of their neighbors.

Parameters:

points - Points, to be connected by polyline, via shortest line (so not across the long side of the Earth). Must contain at least 2 points.

Method Detail

getOrigin

@Nonnull
public GeoPoint getOrigin()

Return origin == first point.

Specified by:

getOrigin in class GeoObject

Returns:

Origin.

getCenter

@Nonnull
public GeoPoint getCenter()

Return center == Mid point of bounding box of polyline. The elevation of the center point is defined as the average of all elevations of its points. if any of the elevations is undefined, this one will be too.

Specified by:

getCenter in class GeoObject

Returns:

Center.

getPointAtOffset

@Nonnull
public GeoPoint getPointAtOffset(double offsetInMeters)

Return an (interpolated) point on a polyline, given an offset in meters. The interpolated point is capped to the polyline bounds. A negative offset interpolates the point from the end rather than the start of the polyline.

Parameters:

offsetInMeters - Offset in meters, if positive (or 0.0) from the start of the polyline, if negative, from the end of the polyline.

Returns:

Interpolated point on polyline, capped to the end points of the polyline.

size

public int size()

Get number of points in polyline.

Returns:

Number of points, always > 2.

get

@Nonnull
public GeoPoint get(int i)

Get point.

Parameters:

i - Index, must be in [0, size - 1].

Returns:

Point.

asLines

@Nonnull
public List<GeoLine> asLines()

Get the polyline as a series of connected lines.

Returns:

Line segments.

getLine

@Nonnull
public GeoLine getLine(int i)

Get a single line segment.

Parameters:

i - Index, must be in [0, size - 2].

Returns:

Line segment from index to next point.

translate

@Nonnull
public GeoPolyLine translate(@Nonnull
                                      GeoVector vector)

Description copied from class: GeoObject

Translate a geo object with an Easting and Northing value.

Specified by:

translate in class GeoObject

Parameters:

vector - Translation vector (along latitude and longitude).

Returns:

Translated object.

moveTo

@Nonnull
public GeoPolyLine moveTo(@Nonnull
                                   GeoPoint origin)

Description copied from class: GeoObject

Move a geo object to specific origin. Note that the definition of the origin of an object is defined in derived classes.

Specified by:

moveTo in class GeoObject

Parameters:

origin - New origin of object.

Returns:

Translated object.

getLengthMeters

public double getLengthMeters()

Return length of line in meters (approximation).

Returns:

Length in meters.

canEqual

public boolean canEqual(@Nonnull
                        Object obj)

Overrides:

canEqual in class GeoObject

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object