org.ka2ddo.yaac.osm

Class WayPoint

java.lang.Object

org.ka2ddo.yaac.osm.WayPoint

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<WayPoint>

public class WayPoint
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable<WayPoint>

This class identifies a position along a Way as the last vertex passed plus a distance along the line segment to the next vertex, and can calculate a new position based on an amount of motion further forwards along the Way.

Since:

PROVIDER_API_VERSION == 45

Author:

Andrew Pavlin, KA2DDO

See Also:

Way.findNearestPositionOnWay(double, double, float, boolean)

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<WayPoint>	BEST_TO_WORST Comparator to compare two WayPoint objects to see which is closer to its associated Way.
float	distFromWay When fitting an arbitrary point to the nearest point on a Way, this is the distance for that nearest point in meters.
float	distFwdFromVertexFract Distance from current vertex to next in a fraction [0.0...1.0) of the span between the vertices.
int	vertexIndex The zero-based index into the Way of the last vertex before the position along the Way defined by this WayPoint.
Way	way The OpenStreetMap Way this WayPoint is associated with.

Constructor Summary

Constructors

Constructor and Description
WayPoint(Way way, int vertexIndex, float distFwdFromVertexFract) Create a positioned WayPoint for the specified Way.
WayPoint(Way way, int vertexIndex, float distFwdFromVertexFract, float distFromWay) Create a positioned WayPoint for the specified Way.

Method Summary

Modifier and Type	Method and Description
boolean	advance(float distInMeters, boolean doLaps) Advance the current position along the Way.
java.lang.Object	clone() Create a duplicate of this WayPoint.
int	compareTo(WayPoint wayPoint) Compare this WayPoint to another, ordering by increasing distance from their associated Ways.
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
int	getBearing(boolean doLaps) Calculate the bearing from the current vertex to the next vertex.
double	getDistanceTo(WayPoint other) Calculate the distance along the Way between this WayPoint and another specified WayPoint.
double	getLatitude() Get the latitude of the current WayPoint.
double	getLongitude() Get the longitude of the current WayPoint.
java.lang.String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

way

public final Way way

The OpenStreetMap Way this WayPoint is associated with.

vertexIndex

public int vertexIndex

The zero-based index into the Way of the last vertex before the position along the Way defined by this WayPoint.

distFwdFromVertexFract

public float distFwdFromVertexFract

Distance from current vertex to next in a fraction [0.0...1.0) of the span between the vertices.

distFromWay

public float distFromWay

When fitting an arbitrary point to the nearest point on a Way, this is the distance for that nearest point in meters.

BEST_TO_WORST

public static java.util.Comparator<WayPoint> BEST_TO_WORST

Comparator to compare two WayPoint objects to see which is closer to its associated Way.

Constructor Detail

WayPoint

public WayPoint(Way way,
                int vertexIndex,
                float distFwdFromVertexFract)

Create a positioned WayPoint for the specified Way.

Parameters:

way - Way this WayPoint is associated with

vertexIndex - zero-based index into the vertices of the Way

distFwdFromVertexFract - float fraction (from 0.0 to 1.0) of the proportional

Since:

PROVIDER_API_VERSION == 50

WayPoint

public WayPoint(Way way,
                int vertexIndex,
                float distFwdFromVertexFract,
                float distFromWay)

Create a positioned WayPoint for the specified Way.

Parameters:

way - Way this WayPoint is associated with

vertexIndex - zero-based index into the vertices of the Way

distFwdFromVertexFract - float fraction (from 0.0 to 1.0) of the proportional

distFromWay - float distance between calculation point and nearest point on Way

Since:

PROVIDER_API_VERSION == 45

Method Detail

getLatitude

public double getLatitude()

Get the latitude of the current WayPoint. This assumes that the Way segment is straight (otherwise there would be another vertex in the middle) and short enough that we can interpolate linearly in a Cartesian projection without worrying about Earth curvature.

Returns:

latitude in fractional degrees North

Since:

PROVIDER_API_VERSION == 45

getLongitude

public double getLongitude()

Get the longitude of the current WayPoint. This assumes that the Way segment is straight (otherwise there would be another vertex in the middle) and short enough that we can interpolate linearly in a Cartesian projection without worrying about Earth curvature.

Returns:

longitude in fractional degrees East

Since:

PROVIDER_API_VERSION == 45

getDistanceTo

public double getDistanceTo(WayPoint other)
                     throws java.lang.IllegalArgumentException

Calculate the distance along the Way between this WayPoint and another specified WayPoint.

Parameters:

other - WayPoint to compare to this WayPoint

Returns:

distance between WayPoints along Way in meters

Throws:

java.lang.IllegalArgumentException - if other WayPoint is not on the same Way

Since:

PROVIDER_API_VERSION == 45

getBearing

public int getBearing(boolean doLaps)

Calculate the bearing from the current vertex to the next vertex.

Parameters:

doLaps - boolean true if Way proceeds from last vertex back to first vertex

Returns:

the bearing in degrees from True North

Since:

PROVIDER_API_VERSION == 45

advance

public boolean advance(float distInMeters,
                       boolean doLaps)

Advance the current position along the Way.

Parameters:

distInMeters - distance to move (in meters) along the Way from the current position, positive moves forwards, negative moves backwards

doLaps - boolean true if advance should wrap from the end of course to the beginning (if forwards, or vice-versa for backwards), false if advance should stop at the end of the Way

Returns:

boolean true if full move was done, false if position reached the beginning or end of the Way before using up the distance and not asking for looping/lapping

Since:

PROVIDER_API_VERSION == 45

clone

public java.lang.Object clone()

Create a duplicate of this WayPoint.

Overrides:

clone in class java.lang.Object

Returns:

Object that is a shallow copy of this WayPoint object

Since:

PROVIDER_API_VERSION == 45

toString

public java.lang.String toString()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

Since:

PROVIDER_API_VERSION == 45

compareTo

public int compareTo(WayPoint wayPoint)

Compare this WayPoint to another, ordering by increasing distance from their associated Ways.

Specified by:

compareTo in interface java.lang.Comparable<WayPoint>

Parameters:

wayPoint - WayPoint whose distance should be compared to this WayPoint

Returns:

signum of compared distances

equals

public boolean equals(java.lang.Object obj)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

Since:

PROVIDER_API_VERSION == 45