java.lang.Object
- All Implemented Interfaces:
Bounded
,GeoArea
,GeoAreaShape
,GeoBounds
,GeoDistance
,GeoDistanceShape
,GeoMembershipShape
,GeoOutsideDistance
,GeoPath
,GeoShape
,Membership
,PlanetObject
,SerializableObject
GeoShape representing a path across the surface of the globe, with a specified half-width. Path
is described by a series of points. Distances are measured from the starting point along the
path, and then at right angles to the path.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
Base implementation of SegmentEndpointprivate static class
Endpoint that's a simple circle.private static class
Endpoint that's a dual circle with cutoff(s).private static class
Endpoint that's a single circle with cutoff(s).private static class
private static interface
Path components consist of both path segments and segment endpoints.private static class
private static class
This is the pre-calculated data for a path segment.private static interface
Internal interface describing segment endpoint implementations.private static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final double
Cosine of cutoff angleprotected final double
The cutoff angle (width)protected GeoPoint[]
A point on the edgeprotected boolean
Set to true if path has been completely constructedThe original list of path pointsprotected GeoStandardPath.PathComponent
The b-tree of PathComponentsprotected final double
Sine of cutoff angleFields inherited from class org.apache.lucene.spatial3d.geom.GeoBaseAreaShape
ALL_INSIDE, NONE_INSIDE, SOME_INSIDE
Fields inherited from class org.apache.lucene.spatial3d.geom.BasePlanetObject
planetModel
-
Constructor Summary
ConstructorsConstructorDescriptionGeoStandardPath
(PlanetModel planetModel, double maxCutoffAngle) Piece-wise constructor.GeoStandardPath
(PlanetModel planetModel, double maxCutoffAngle, GeoPoint[] pathPoints) Constructor.GeoStandardPath
(PlanetModel planetModel, InputStream inputStream) Constructor for deserialization. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addPoint
(double lat, double lon) Add a point to the path.double
computeNearestDistance
(DistanceStyle distanceStyle, double x, double y, double z) Compute the nearest path distance to the GeoPoint.double
computePathCenterDistance
(DistanceStyle distanceStyle, double x, double y, double z) Compute the shortest distance from the path center to the GeoPoint.protected double
deltaDistance
(DistanceStyle distanceStyle, double x, double y, double z) Called by acomputeDeltaDistance
method if X/Y/Z is within this shape.protected double
distance
(DistanceStyle distanceStyle, double x, double y, double z) Called by acomputeDistance
method if X/Y/Z is within this shape.protected void
distanceBounds
(Bounds bounds, DistanceStyle distanceStyle, double distanceValue) Called by agetDistanceBounds
method if distanceValue is not Double.POSITIVE_INFINITY.void
done()
Complete the path.boolean
void
Compute bounds for the shape.GeoPoint[]
Return a sample point that is on the outside edge/boundary of the shape.int
hashCode()
boolean
intersects
(GeoShape geoShape) Assess whether a shape intersects with any of the edges of this shape.boolean
intersects
(Plane plane, GeoPoint[] notablePoints, Membership... bounds) Assess whether a plane, within the provided bounds, intersects with the shape's edges.boolean
isWithin
(double x, double y, double z) Check if a point is within this shape.protected double
outsideDistance
(DistanceStyle distanceStyle, double x, double y, double z) Called by acomputeOutsideDistance
method if X/Y/Z is not within this shape.toString()
void
write
(OutputStream outputStream) Serialize to output stream.Methods inherited from class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
computeDeltaDistance, computeDeltaDistance, computeDistance, computeDistance, getDistanceBounds, isWithin
Methods inherited from class org.apache.lucene.spatial3d.geom.GeoBaseAreaShape
getRelationship, isGeoAreaShapeInsideShape, isShapeInsideGeoAreaShape
Methods inherited from class org.apache.lucene.spatial3d.geom.GeoBaseMembershipShape
computeOutsideDistance, computeOutsideDistance
Methods inherited from class org.apache.lucene.spatial3d.geom.BasePlanetObject
getPlanetModel
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.lucene.spatial3d.geom.GeoArea
getRelationship
Methods inherited from interface org.apache.lucene.spatial3d.geom.GeoDistance
computeDeltaDistance, computeDeltaDistance, computeDistance, computeDistance
Methods inherited from interface org.apache.lucene.spatial3d.geom.GeoDistanceShape
getDistanceBounds
Methods inherited from interface org.apache.lucene.spatial3d.geom.GeoOutsideDistance
computeOutsideDistance, computeOutsideDistance
Methods inherited from interface org.apache.lucene.spatial3d.geom.GeoPath
computeNearestDistance, computePathCenterDistance
Methods inherited from interface org.apache.lucene.spatial3d.geom.Membership
isWithin
Methods inherited from interface org.apache.lucene.spatial3d.geom.PlanetObject
getPlanetModel
-
Field Details
-
cutoffAngle
protected final double cutoffAngleThe cutoff angle (width) -
sinAngle
protected final double sinAngleSine of cutoff angle -
cosAngle
protected final double cosAngleCosine of cutoff angle -
points
The original list of path points -
rootComponent
The b-tree of PathComponents -
edgePoints
A point on the edge -
isDone
protected boolean isDoneSet to true if path has been completely constructed
-
-
Constructor Details
-
GeoStandardPath
Constructor.- Parameters:
planetModel
- is the planet model.maxCutoffAngle
- is the width of the path, measured as an angle.pathPoints
- are the points in the path.
-
GeoStandardPath
Piece-wise constructor. Use in conjunction with addPoint() and done().- Parameters:
planetModel
- is the planet model.maxCutoffAngle
- is the width of the path, measured as an angle.
-
GeoStandardPath
Constructor for deserialization.- Parameters:
planetModel
- is the planet model.inputStream
- is the input stream.- Throws:
IOException
-
-
Method Details
-
addPoint
public void addPoint(double lat, double lon) Add a point to the path.- Parameters:
lat
- is the latitude of the point.lon
- is the longitude of the point.
-
done
public void done()Complete the path. -
write
Description copied from interface:SerializableObject
Serialize to output stream.- Specified by:
write
in interfaceSerializableObject
- Overrides:
write
in classBasePlanetObject
- Parameters:
outputStream
- is the output stream to write to.- Throws:
IOException
-
computePathCenterDistance
Description copied from interface:GeoPath
Compute the shortest distance from the path center to the GeoPoint. The distance is meant to allow comparisons between different paths to find the one that goes closest to a point.- Parameters:
distanceStyle
- is the distance style.x
- is the point's unit x coordinate (using U.S. convention).y
- is the point's unit y coordinate (using U.S. convention).z
- is the point's unit z coordinate (using U.S. convention).- Returns:
- the shortest distance from the path center to the point.
-
computeNearestDistance
Description copied from interface:GeoPath
Compute the nearest path distance to the GeoPoint. The path distance will not include the distance from the path itself to the point, but just the distance along the path to the nearest point on the path.- Parameters:
x
- is the point's unit x coordinate (using U.S. convention).y
- is the point's unit y coordinate (using U.S. convention).z
- is the point's unit z coordinate (using U.S. convention).- Returns:
- the distance to the nearest path point.
-
distance
Description copied from class:GeoBaseDistanceShape
Called by acomputeDistance
method if X/Y/Z is within this shape.- Specified by:
distance
in classGeoBaseDistanceShape
-
deltaDistance
Description copied from class:GeoBaseDistanceShape
Called by acomputeDeltaDistance
method if X/Y/Z is within this shape.- Overrides:
deltaDistance
in classGeoBaseDistanceShape
-
distanceBounds
Description copied from class:GeoBaseDistanceShape
Called by agetDistanceBounds
method if distanceValue is not Double.POSITIVE_INFINITY.- Specified by:
distanceBounds
in classGeoBaseDistanceShape
-
outsideDistance
Description copied from class:GeoBaseMembershipShape
Called by acomputeOutsideDistance
method if X/Y/Z is not within this shape.- Specified by:
outsideDistance
in classGeoBaseMembershipShape
-
isWithin
public boolean isWithin(double x, double y, double z) Description copied from interface:Membership
Check if a point is within this shape.- Parameters:
x
- is x coordinate of point to check.y
- is y coordinate of point to check.z
- is z coordinate of point to check.- Returns:
- true if the point is within this shape
-
getEdgePoints
Description copied from interface:GeoShape
Return a sample point that is on the outside edge/boundary of the shape.- Returns:
- samples of all edge points from distinct edge sections. Typically one point is returned, but zero or two are also possible.
-
intersects
Description copied from interface:GeoShape
Assess whether a plane, within the provided bounds, intersects with the shape's edges. Any overlap, even a single point, is considered to be an intersection. Note well that this method is allowed to return "true" if there are internal edges of a composite shape which intersect the plane. Doing this can cause getRelationship() for most GeoBBox shapes to return OVERLAPS rather than the more correct CONTAINS, but that cannot be helped for some complex shapes that are built out of overlapping parts.- Parameters:
plane
- is the plane to assess for intersection with the shape's edges or bounding curves.notablePoints
- represents the intersections of the plane with the supplied bounds. These are used to disambiguate when two planes are identical and it needs to be determined whether any points exist that fulfill all the bounds.bounds
- are a set of bounds that define an area that an intersection must be within in order to qualify (provided by a GeoArea).- Returns:
- true if there's such an intersection, false if not.
-
intersects
Description copied from interface:GeoAreaShape
Assess whether a shape intersects with any of the edges of this shape. Note well that this method must return false if the shape contains or is disjoint with the given shape. It is permissible to return true if the shape is within the specified shape, if it is difficult to compute intersection with edges.- Parameters:
geoShape
- is the shape to assess for intersection with this shape's edges.- Returns:
- true if there's such an intersection, false if not.
-
getBounds
Description copied from interface:Bounded
Compute bounds for the shape.- Specified by:
getBounds
in interfaceBounded
- Overrides:
getBounds
in classGeoBaseBounds
- Parameters:
bounds
- is the input bounds object. The input object will be modified.
-
equals
- Overrides:
equals
in classBasePlanetObject
-
hashCode
public int hashCode()- Overrides:
hashCode
in classBasePlanetObject
-
toString
-