- java.lang.Object
-
- org.apache.lucene.spatial3d.geom.BasePlanetObject
-
- org.apache.lucene.spatial3d.geom.GeoBaseBounds
-
- org.apache.lucene.spatial3d.geom.GeoBaseShape
-
- org.apache.lucene.spatial3d.geom.GeoBaseMembershipShape
-
- org.apache.lucene.spatial3d.geom.GeoBaseAreaShape
-
- org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
-
- org.apache.lucene.spatial3d.geom.GeoBasePath
-
- org.apache.lucene.spatial3d.geom.GeoDegeneratePath
-
- All Implemented Interfaces:
Bounded
,GeoArea
,GeoAreaShape
,GeoBounds
,GeoDistance
,GeoDistanceShape
,GeoMembershipShape
,GeoOutsideDistance
,GeoPath
,GeoShape
,Membership
,PlanetObject
,SerializableObject
class GeoDegeneratePath extends GeoBasePath
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 Classes Modifier and Type Class Description private static class
GeoDegeneratePath.PathSegment
This is the pre-calculated data for a path segment.private static class
GeoDegeneratePath.SegmentEndpoint
This is precalculated data for segment endpoint.
-
Field Summary
Fields Modifier and Type Field Description protected GeoPoint[]
edgePoints
A point on the edgeprotected java.util.List<GeoDegeneratePath.SegmentEndpoint>
endPoints
A list of SegmentEndpointsprotected boolean
isDone
Set to true if path has been completely constructedprotected java.util.List<GeoPoint>
points
The original list of path pointsprotected java.util.List<GeoDegeneratePath.PathSegment>
segments
A list of PathSegments-
Fields 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
Constructors Constructor Description GeoDegeneratePath(PlanetModel planetModel)
Piece-wise constructor.GeoDegeneratePath(PlanetModel planetModel, java.io.InputStream inputStream)
Constructor for deserialization.GeoDegeneratePath(PlanetModel planetModel, GeoPoint[] pathPoints)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
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
equals(java.lang.Object o)
void
getBounds(Bounds bounds)
Compute bounds for the shape.GeoPoint[]
getEdgePoints()
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.java.lang.String
toString()
void
write(java.io.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 Detail
-
points
protected final java.util.List<GeoPoint> points
The original list of path points
-
endPoints
protected java.util.List<GeoDegeneratePath.SegmentEndpoint> endPoints
A list of SegmentEndpoints
-
segments
protected java.util.List<GeoDegeneratePath.PathSegment> segments
A list of PathSegments
-
edgePoints
protected GeoPoint[] edgePoints
A point on the edge
-
isDone
protected boolean isDone
Set to true if path has been completely constructed
-
-
Constructor Detail
-
GeoDegeneratePath
public GeoDegeneratePath(PlanetModel planetModel, GeoPoint[] pathPoints)
Constructor.- Parameters:
planetModel
- is the planet model.pathPoints
- are the points in the path.
-
GeoDegeneratePath
public GeoDegeneratePath(PlanetModel planetModel)
Piece-wise constructor. Use in conjunction with addPoint() and done().- Parameters:
planetModel
- is the planet model.
-
GeoDegeneratePath
public GeoDegeneratePath(PlanetModel planetModel, java.io.InputStream inputStream) throws java.io.IOException
Constructor for deserialization.- Parameters:
planetModel
- is the planet model.inputStream
- is the input stream.- Throws:
java.io.IOException
-
-
Method Detail
-
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
public void write(java.io.OutputStream outputStream) throws java.io.IOException
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:
java.io.IOException
-
computePathCenterDistance
public double computePathCenterDistance(DistanceStyle distanceStyle, double x, double y, double z)
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
public double computeNearestDistance(DistanceStyle distanceStyle, double x, double y, double z)
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.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
protected double distance(DistanceStyle distanceStyle, double x, double y, double z)
Description copied from class:GeoBaseDistanceShape
Called by acomputeDistance
method if X/Y/Z is within this shape.- Specified by:
distance
in classGeoBaseDistanceShape
-
deltaDistance
protected double deltaDistance(DistanceStyle distanceStyle, double x, double y, double z)
Description copied from class:GeoBaseDistanceShape
Called by acomputeDeltaDistance
method if X/Y/Z is within this shape.- Overrides:
deltaDistance
in classGeoBaseDistanceShape
-
distanceBounds
protected void distanceBounds(Bounds bounds, DistanceStyle distanceStyle, double distanceValue)
Description copied from class:GeoBaseDistanceShape
Called by agetDistanceBounds
method if distanceValue is not Double.POSITIVE_INFINITY.- Specified by:
distanceBounds
in classGeoBaseDistanceShape
-
outsideDistance
protected double outsideDistance(DistanceStyle distanceStyle, double x, double y, double z)
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
public GeoPoint[] 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
public boolean intersects(Plane plane, GeoPoint[] notablePoints, Membership... bounds)
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
public boolean intersects(GeoShape geoShape)
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
public void getBounds(Bounds bounds)
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
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classBasePlanetObject
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classBasePlanetObject
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-