Package org.apache.lucene.spatial3d.geom
Class GeoDegenerateVerticalLine
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.GeoDegenerateVerticalLine
- All Implemented Interfaces:
Bounded,GeoArea,GeoAreaShape,GeoBBox,GeoBounds,GeoMembershipShape,GeoOutsideDistance,GeoShape,GeoSizeable,Membership,PlanetObject,SerializableObject
Degenerate bounding box limited on two sides (top lat, bottom lat).
- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final intAll edgepoints inside shapeprotected final doubleBottom latitude of the vertical lineprotected final SidedPlaneBottom end cutoff planeprotected final SidedPlaneBack-side cutoff planeprotected final GeoPointA computed center point for the lineprotected final GeoPoint[]A point that's on the lineprotected final GeoPointPoint at the lower end of the vertical lineprotected final doubleLongitude of the vertical lineprotected static final intNo edgepoints inside shapeprotected final PlaneThe vertical line planeprotected final GeoPoint[]Notable points for the line (end points)protected static final intSome edgepoints inside shapeprotected final doubleTop latitude of the vertical lineprotected final SidedPlaneTop end cutoff planeprotected final GeoPointPoint at the upper end of the vertical lineFields inherited from class org.apache.lucene.spatial3d.geom.BasePlanetObject
planetModel -
Constructor Summary
ConstructorsConstructorDescriptionGeoDegenerateVerticalLine(PlanetModel planetModel, double topLat, double bottomLat, double longitude) Accepts only values in the following ranges: lat:-PI/2 -> PI/2, longitude:-PI -> PIGeoDegenerateVerticalLine(PlanetModel planetModel, InputStream inputStream) Constructor for deserialization. -
Method Summary
Modifier and TypeMethodDescriptionbooleanexpand(double angle) Expand box by specified angle.voidCompute bounds for the shape.Returns the center of a circle into which the area will be inscribed.GeoPoint[]Return a sample point that is on the outside edge/boundary of the shape.doubleReturns the radius of a circle into which the GeoSizeable area can be inscribed.intgetRelationship(GeoShape path) Find the spatial relationship between a shape and the current geo area.inthashCode()booleanintersects(GeoShape geoShape) Assess whether a shape intersects with any of the edges of this shape.booleanintersects(Plane p, GeoPoint[] notablePoints, Membership... bounds) Assess whether a plane, within the provided bounds, intersects with the shape's edges.protected intisGeoAreaShapeInsideShape(GeoShape geoshape) Determine the relationship between the GeoAreaShape's edgepoints and the provided shape.protected intisShapeInsideGeoAreaShape(GeoShape geoShape) Determine the relationship between the GeoAreShape and the shape's edgepoints.booleanisWithin(double x, double y, double z) Check if a point is within this shape.protected doubleoutsideDistance(DistanceStyle distanceStyle, double x, double y, double z) Called by acomputeOutsideDistancemethod if X/Y/Z is not within this shape.toString()voidwrite(OutputStream outputStream) Serialize to output stream.Methods inherited from class org.apache.lucene.spatial3d.geom.GeoBaseMembershipShape
computeOutsideDistance, computeOutsideDistance, isWithinMethods inherited from class org.apache.lucene.spatial3d.geom.BasePlanetObject
getPlanetModelMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.lucene.spatial3d.geom.GeoOutsideDistance
computeOutsideDistance, computeOutsideDistanceMethods inherited from interface org.apache.lucene.spatial3d.geom.Membership
isWithinMethods inherited from interface org.apache.lucene.spatial3d.geom.PlanetObject
getPlanetModel
-
Field Details
-
topLat
protected final double topLatTop latitude of the vertical line -
bottomLat
protected final double bottomLatBottom latitude of the vertical line -
longitude
protected final double longitudeLongitude of the vertical line -
UHC
Point at the upper end of the vertical line -
LHC
Point at the lower end of the vertical line -
topPlane
Top end cutoff plane -
bottomPlane
Bottom end cutoff plane -
boundingPlane
Back-side cutoff plane -
plane
The vertical line plane -
planePoints
Notable points for the line (end points) -
centerPoint
A computed center point for the line -
edgePoints
A point that's on the line -
ALL_INSIDE
protected static final int ALL_INSIDEAll edgepoints inside shape- See Also:
-
SOME_INSIDE
protected static final int SOME_INSIDESome edgepoints inside shape- See Also:
-
NONE_INSIDE
protected static final int NONE_INSIDENo edgepoints inside shape- See Also:
-
-
Constructor Details
-
GeoDegenerateVerticalLine
public GeoDegenerateVerticalLine(PlanetModel planetModel, double topLat, double bottomLat, double longitude) Accepts only values in the following ranges: lat:-PI/2 -> PI/2, longitude:-PI -> PI -
GeoDegenerateVerticalLine
public GeoDegenerateVerticalLine(PlanetModel planetModel, InputStream inputStream) throws IOException Constructor for deserialization.- Parameters:
planetModel- is the planet model.inputStream- is the input stream.- Throws:
IOException
-
-
Method Details
-
write
Description copied from interface:SerializableObjectSerialize to output stream.- Specified by:
writein interfaceSerializableObject- Overrides:
writein classBasePlanetObject- Parameters:
outputStream- is the output stream to write to.- Throws:
IOException
-
expand
Description copied from interface:GeoBBoxExpand box by specified angle.- Parameters:
angle- is the angle amount to expand the GeoBBox by.- Returns:
- a new GeoBBox.
-
isWithin
public boolean isWithin(double x, double y, double z) Description copied from interface:MembershipCheck 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
-
getRadius
public double getRadius()Description copied from interface:GeoSizeableReturns the radius of a circle into which the GeoSizeable area can be inscribed.- Returns:
- the radius.
-
getCenter
Description copied from interface:GeoSizeableReturns the center of a circle into which the area will be inscribed.- Returns:
- the center.
-
getEdgePoints
Description copied from interface:GeoShapeReturn 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:GeoShapeAssess 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:
p- 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:GeoAreaShapeAssess 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:BoundedCompute bounds for the shape.- Specified by:
getBoundsin interfaceBounded- Overrides:
getBoundsin classGeoBaseBounds- Parameters:
bounds- is the input bounds object. The input object will be modified.
-
getRelationship
Description copied from interface:GeoAreaFind the spatial relationship between a shape and the current geo area. Note: return value is how the GeoShape relates to the GeoArea, not the other way around. For example, if this GeoArea is entirely within the shape, then CONTAINS should be returned. If the shape is entirely enclosed by this GeoArea, then WITHIN should be returned.It is permissible to return OVERLAPS instead of WITHIN if the shape intersects with the area at even a single point. So, a circle inscribed in a rectangle could return either OVERLAPS or WITHIN, depending on implementation. It is not permissible to return CONTAINS or DISJOINT in this circumstance, however.
Similarly, it is permissible to return OVERLAPS instead of CONTAINS under conditions where the shape consists of multiple independent overlapping subshapes, and the area overlaps one of the subshapes. It is not permissible to return WITHIN or DISJOINT in this circumstance, however.
- Specified by:
getRelationshipin interfaceGeoArea- Parameters:
path- is the shape to consider.- Returns:
- the relationship, from the perspective of the shape.
-
outsideDistance
Description copied from class:GeoBaseMembershipShapeCalled by acomputeOutsideDistancemethod if X/Y/Z is not within this shape.- Specified by:
outsideDistancein classGeoBaseMembershipShape
-
equals
- Overrides:
equalsin classBasePlanetObject
-
hashCode
public int hashCode()- Overrides:
hashCodein classBasePlanetObject
-
toString
-
isShapeInsideGeoAreaShape
Determine the relationship between the GeoAreShape and the shape's edgepoints.- Parameters:
geoShape- is the shape.- Returns:
- the relationship.
-
isGeoAreaShapeInsideShape
Determine the relationship between the GeoAreaShape's edgepoints and the provided shape.- Parameters:
geoshape- is the shape.- Returns:
- the relationship.
-