com.graphhopper.storage.index

Class Snap

java.lang.Object

com.graphhopper.storage.index.Snap

public class Snap
extends Object

Result of LocationIndex lookup.

 X=query coordinates S=snapped coordinates: "snapping" real coords to road N=tower or pillar
 node T=closest tower node XS=distance
 X
 |
 T--S----N
 

Author:

Peter Karich

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Snap.Position Whether the query point is projected onto a tower node, pillar node or somewhere within the closest edge.

Field Summary

Fields

Modifier and Type	Field and Description
static int	INVALID_NODE

Constructor Summary

Constructors

Constructor and Description
Snap(double queryLat, double queryLon)

Method Summary

Modifier and Type	Method and Description
void	calcSnappedPoint(DistanceCalc distCalc) Calculates the closest point on the edge from the query point.
EdgeIteratorState	getClosestEdge()
int	getClosestNode() Returns the closest matching node.
double	getQueryDistance()
GHPoint	getQueryPoint()
GHPoint3D	getSnappedPoint() Calculates the position of the query point 'snapped' to a close road segment or node.
Snap.Position	getSnappedPosition()
int	getWayIndex()
boolean	isValid()
void	setClosestEdge(EdgeIteratorState edge)
void	setClosestNode(int node)
void	setQueryDistance(double dist)
void	setSnappedPosition(Snap.Position pos)
void	setWayIndex(int wayIndex)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INVALID_NODE

public static final int INVALID_NODE

See Also:

Constant Field Values

Constructor Detail

Snap

public Snap(double queryLat,
            double queryLon)

Method Detail

getClosestNode

public int getClosestNode()

Returns the closest matching node. This is either a tower node of the base graph or a virtual node (see also QueryGraph.create(BaseGraph, List)).

Returns:

INVALID_NODE if nothing found, this should be avoided via a call of 'isValid'

setClosestNode

public void setClosestNode(int node)

getQueryDistance

public double getQueryDistance()

Returns:

the distance of the query to the snapped coordinates. In meter

setQueryDistance

public void setQueryDistance(double dist)

getWayIndex

public int getWayIndex()

setWayIndex

public void setWayIndex(int wayIndex)

getSnappedPosition

public Snap.Position getSnappedPosition()

Returns:

0 if on edge. 1 if on pillar node and 2 if on tower node.

setSnappedPosition

public void setSnappedPosition(Snap.Position pos)

isValid

public boolean isValid()

Returns:

true if a closest node was found

getClosestEdge

public EdgeIteratorState getClosestEdge()

setClosestEdge

public void setClosestEdge(EdgeIteratorState edge)

getQueryPoint

public GHPoint getQueryPoint()

getSnappedPoint

public GHPoint3D getSnappedPoint()

Calculates the position of the query point 'snapped' to a close road segment or node. Call calcSnappedPoint before, if not, an IllegalStateException is thrown.

calcSnappedPoint

public void calcSnappedPoint(DistanceCalc distCalc)

Calculates the closest point on the edge from the query point.

toString

public String toString()

Overrides:

toString in class Object