Module org.apache.lucene.spatial3d
Package org.apache.lucene.spatial3d.geom
Class GeoStandardPath.PathNode
java.lang.Object
org.apache.lucene.spatial3d.geom.GeoStandardPath.PathNode
- All Implemented Interfaces:
GeoStandardPath.PathComponent
- Enclosing class:
GeoStandardPath
private static class GeoStandardPath.PathNode
extends Object
implements GeoStandardPath.PathComponent
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final XYZBounds
protected final GeoStandardPath.PathComponent
protected final GeoStandardPath.PathComponent
-
Constructor Summary
ConstructorsConstructorDescriptionPathNode
(GeoStandardPath.PathComponent child1, GeoStandardPath.PathComponent child2) -
Method Summary
Modifier and TypeMethodDescriptiondouble
distance
(DistanceStyle distanceStyle, double x, double y, double z) Compute distance measure starting from beginning of the path and including perpendicular dog-leg to a point within the corridor.double
fullPathDistance
(DistanceStyle distanceStyle) Compute the total distance this path component adds to the path.void
Get the bounds for a segment endpoint.double
getStartingDistance
(DistanceStyle distanceStyle) Retrieve the starting distance along the path for this path element.boolean
intersects
(GeoShape geoShape) Determine if this endpoint intersects a GeoShape.boolean
intersects
(Plane p, XYZBounds planeBounds, GeoPoint[] notablePoints, Membership[] bounds) Determine if this endpoint intersects a specified plane.boolean
isWithin
(double x, double y, double z) Check if point is within this endpoint.boolean
Check if point is within this endpoint.boolean
isWithinSection
(double x, double y, double z) Check if point is within this section (within cutoff planes).boolean
isWithinSection
(Vector point) Check if point is within this section (within cutoff planes).nearestDistance
(DistanceStyle distanceStyle, double x, double y, double z) Get the nearest distance for a point.double
nearestPathDistance
(DistanceStyle distanceStyle, double x, double y, double z) Compute nearest path distance (distance from start of segment to point adjacent the one specitied, if reachable by this segment).double
outsideDistance
(DistanceStyle distanceStyle, double x, double y, double z) Compute external distance.double
pathCenterDistance
(DistanceStyle distanceStyle, double x, double y, double z) Compute path center distance (distance from the point to center of the path, if reachable by this segment).double
pathDeltaDistance
(DistanceStyle distanceStyle, double x, double y, double z) Compute delta path distance.double
pathDistance
(DistanceStyle distanceStyle, double x, double y, double z) Compute path distance.toString()
-
Field Details
-
child1
-
child2
-
bounds
-
-
Constructor Details
-
PathNode
-
-
Method Details
-
isWithin
Description copied from interface:GeoStandardPath.PathComponent
Check if point is within this endpoint.- Specified by:
isWithin
in interfaceGeoStandardPath.PathComponent
- Parameters:
point
- is the point.- Returns:
- true of within.
-
isWithin
public boolean isWithin(double x, double y, double z) Description copied from interface:GeoStandardPath.PathComponent
Check if point is within this endpoint.- Specified by:
isWithin
in interfaceGeoStandardPath.PathComponent
- Parameters:
x
- is the point x.y
- is the point y.z
- is the point z.- Returns:
- true of within.
-
isWithinSection
Description copied from interface:GeoStandardPath.PathComponent
Check if point is within this section (within cutoff planes).- Specified by:
isWithinSection
in interfaceGeoStandardPath.PathComponent
-
isWithinSection
public boolean isWithinSection(double x, double y, double z) Description copied from interface:GeoStandardPath.PathComponent
Check if point is within this section (within cutoff planes).- Specified by:
isWithinSection
in interfaceGeoStandardPath.PathComponent
-
getStartingDistance
Description copied from interface:GeoStandardPath.PathComponent
Retrieve the starting distance along the path for this path element.- Specified by:
getStartingDistance
in interfaceGeoStandardPath.PathComponent
- Parameters:
distanceStyle
- is the distance style- Returns:
- the starting path distance in aggregation form
-
distance
Description copied from interface:GeoStandardPath.PathComponent
Compute distance measure starting from beginning of the path and including perpendicular dog-leg to a point within the corridor.- Specified by:
distance
in interfaceGeoStandardPath.PathComponent
- Parameters:
distanceStyle
- is the distance stylex
- is the x coordinate of the point we want to get the distance toy
- is the y coordinate of the point we want to get the distance toz
- is the z coordinate of the point we want to get the distance to- Returns:
- the distance from start of path
-
nearestDistance
public GeoStandardPath.DistancePair nearestDistance(DistanceStyle distanceStyle, double x, double y, double z) Description copied from interface:GeoStandardPath.PathComponent
Get the nearest distance for a point. This is the old "legacy" computation: We find the segment endpoint or path segment with the closest pathCenterDistance(), and keep track of the one where that's at a minimum. We then compute nearestPathDistance() if it's a segment and add that to fullPathDistance() computed along the entire path up to that point.So what we are minimizing is not what we are returning here. That is why this is tricky to modularize; we need to return two values: the best pathCenterDistance, and the corresponding nearestPathDistance + startingDistance.
- Specified by:
nearestDistance
in interfaceGeoStandardPath.PathComponent
- Parameters:
distanceStyle
- is the distance stylex
- is the x coordinate of the point we want to get the distance toy
- is the y coordinate of the point we want to get the distance toz
- is the z coordinate of the point we want to get the distance to- Returns:
- the DistancePair containing both distances described above
-
fullPathDistance
Description copied from interface:GeoStandardPath.PathComponent
Compute the total distance this path component adds to the path.- Specified by:
fullPathDistance
in interfaceGeoStandardPath.PathComponent
- Parameters:
distanceStyle
- is the distance style.- Returns:
- the full path distance.
-
pathDistance
Description copied from interface:GeoStandardPath.PathComponent
Compute path distance.- Specified by:
pathDistance
in interfaceGeoStandardPath.PathComponent
- Parameters:
distanceStyle
- is the distance style.x
- is the point x.y
- is the point y.z
- is the point z.- Returns:
- the distance
-
pathDeltaDistance
Description copied from interface:GeoStandardPath.PathComponent
Compute delta path distance.- Specified by:
pathDeltaDistance
in interfaceGeoStandardPath.PathComponent
- Parameters:
distanceStyle
- is the distance style.x
- is the point x.y
- is the point y.z
- is the point z.- Returns:
- the distance metric, in aggregation form.
-
nearestPathDistance
Description copied from interface:GeoStandardPath.PathComponent
Compute nearest path distance (distance from start of segment to point adjacent the one specitied, if reachable by this segment).- Specified by:
nearestPathDistance
in interfaceGeoStandardPath.PathComponent
- Parameters:
distanceStyle
- is the distance style.x
- is the point x.y
- is the point y.z
- is the point z.- Returns:
- the distance metric, in aggregation form.
-
pathCenterDistance
Description copied from interface:GeoStandardPath.PathComponent
Compute path center distance (distance from the point to center of the path, if reachable by this segment).- Specified by:
pathCenterDistance
in interfaceGeoStandardPath.PathComponent
- Parameters:
distanceStyle
- is the distance style.x
- is the point x.y
- is the point y.z
- is the point z.- Returns:
- the distance metric, or POSITIVE_INFINITY if the point is not within the bounds of the path segment.
-
outsideDistance
Description copied from interface:GeoStandardPath.PathComponent
Compute external distance.- Specified by:
outsideDistance
in interfaceGeoStandardPath.PathComponent
- Parameters:
distanceStyle
- is the distance style.x
- is the point x.y
- is the point y.z
- is the point z.- Returns:
- the distance metric.
-
intersects
public boolean intersects(Plane p, XYZBounds planeBounds, GeoPoint[] notablePoints, Membership[] bounds) Description copied from interface:GeoStandardPath.PathComponent
Determine if this endpoint intersects a specified plane.- Specified by:
intersects
in interfaceGeoStandardPath.PathComponent
- Parameters:
p
- is the plane.planeBounds
- are the XYZBounds of the plane we're looking for an intersection with.notablePoints
- are the points associated with the plane.bounds
- are any bounds which the intersection must lie within.- Returns:
- true if there is a matching intersection.
-
intersects
Description copied from interface:GeoStandardPath.PathComponent
Determine if this endpoint intersects a GeoShape.- Specified by:
intersects
in interfaceGeoStandardPath.PathComponent
- Parameters:
geoShape
- is the GeoShape.- Returns:
- true if there is shape intersect this endpoint.
-
getBounds
Description copied from interface:GeoStandardPath.PathComponent
Get the bounds for a segment endpoint.- Specified by:
getBounds
in interfaceGeoStandardPath.PathComponent
- Parameters:
bounds
- are the bounds to be modified.
-
toString
-