org.apache.lucene.geo3d

Class GeoWideDegenerateHorizontalLine

java.lang.Object

org.apache.lucene.geo3d.BasePlanetObject

org.apache.lucene.geo3d.GeoBaseShape

org.apache.lucene.geo3d.GeoBaseMembershipShape

org.apache.lucene.geo3d.GeoBaseBBox

org.apache.lucene.geo3d.GeoWideDegenerateHorizontalLine

All Implemented Interfaces:

GeoArea, GeoBBox, GeoMembershipShape, GeoOutsideDistance, GeoShape, GeoSizeable, Membership

public class GeoWideDegenerateHorizontalLine
extends GeoBaseBBox

Degenerate bounding box wider than PI and limited on two sides (left lon, right lon).

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	GeoWideDegenerateHorizontalLine.EitherBound Membership implementation representing a wide cutoff (more than 180 degrees).

Field Summary

Fields

Modifier and Type	Field and Description
protected GeoPoint	centerPoint Center point for the line
protected GeoPoint[]	edgePoints A point on the line
protected GeoWideDegenerateHorizontalLine.EitherBound	eitherBound Left/right combination bound
protected double	latitude The latitude of the line
protected double	leftLon The left longitude cutoff of the line
protected SidedPlane	leftPlane The left cutoff plane
protected GeoPoint	LHC The left end of the line
protected Plane	plane The plane the line is in
protected GeoPoint[]	planePoints Notable points for the line
protected GeoPoint	RHC The right end of the line
protected double	rightLon The right longitude cutoff of the line
protected SidedPlane	rightPlane The right cutoff plane

Fields inherited from class org.apache.lucene.geo3d.GeoBaseBBox

ALL_INSIDE, NONE_INSIDE, SOME_INSIDE

Fields inherited from class org.apache.lucene.geo3d.BasePlanetObject

planetModel

Fields inherited from interface org.apache.lucene.geo3d.GeoArea

CONTAINS, DISJOINT, OVERLAPS, WITHIN

Constructor Summary

Constructors

Constructor and Description
GeoWideDegenerateHorizontalLine(PlanetModel planetModel, double latitude, double leftLon, double rightLon) Accepts only values in the following ranges: lat: -PI/2 -> PI/2, lon: -PI -> PI.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
GeoBBox	expand(double angle) Expand box by specified angle.
Bounds	getBounds(Bounds bounds) Compute longitude/latitude bounds for the shape.
GeoPoint	getCenter() Returns the center of a circle into which the area will be inscribed.
GeoPoint[]	getEdgePoints() Return a sample point that is on the outside edge/boundary of the shape.
double	getRadius() Returns the radius of a circle into which the GeoSizeable area can be inscribed.
int	getRelationship(GeoShape path) Find the spatial relationship between a shape and the current geo area.
int	hashCode()
boolean	intersects(Plane p, GeoPoint[] notablePoints, Membership... bounds) Assess whether a plane, within the provided bounds, intersects with the shape.
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 a computeOutsideDistance method if X/Y/Z is not within this shape.
String	toString()

Methods inherited from class org.apache.lucene.geo3d.GeoBaseBBox

isShapeInsideBBox

Methods inherited from class org.apache.lucene.geo3d.GeoBaseMembershipShape

computeOutsideDistance, computeOutsideDistance, isWithin

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.lucene.geo3d.GeoOutsideDistance

computeOutsideDistance, computeOutsideDistance

Methods inherited from interface org.apache.lucene.geo3d.Membership

isWithin

Field Detail

latitude

protected final double latitude

The latitude of the line

leftLon

protected final double leftLon

The left longitude cutoff of the line

rightLon

protected final double rightLon

The right longitude cutoff of the line

LHC

protected final GeoPoint LHC

The left end of the line

RHC

protected final GeoPoint RHC

The right end of the line

plane

protected final Plane plane

The plane the line is in

leftPlane

protected final SidedPlane leftPlane

The left cutoff plane

rightPlane

protected final SidedPlane rightPlane

The right cutoff plane

planePoints

protected final GeoPoint[] planePoints

Notable points for the line

centerPoint

protected final GeoPoint centerPoint

Center point for the line

eitherBound

protected final GeoWideDegenerateHorizontalLine.EitherBound eitherBound

Left/right combination bound

edgePoints

protected final GeoPoint[] edgePoints

A point on the line

Constructor Detail

GeoWideDegenerateHorizontalLine

public GeoWideDegenerateHorizontalLine(PlanetModel planetModel,
                               double latitude,
                               double leftLon,
                               double rightLon)

Accepts only values in the following ranges: lat: -PI/2 -> PI/2, lon: -PI -> PI. Horizontal angle must be greater than or equal to PI.

Parameters:

planetModel - is the planet model.

latitude - is the line latitude.

leftLon - is the left cutoff longitude.

rightLon - is the right cutoff longitude.

Method Detail

expand

public GeoBBox expand(double angle)

Description copied from interface: GeoBBox

Expand 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: 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

getRadius

public double getRadius()

Description copied from interface: GeoSizeable

Returns the radius of a circle into which the GeoSizeable area can be inscribed.

Returns:

the radius.

getCenter

public GeoPoint getCenter()

Description copied from interface: GeoSizeable

Returns the center of a circle into which the area will be inscribed.

Returns:

the center.

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 p,
                 GeoPoint[] notablePoints,
                 Membership... bounds)

Description copied from interface: GeoShape

Assess whether a plane, within the provided bounds, intersects with the shape. 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.

getBounds

public Bounds getBounds(Bounds bounds)

Description copied from interface: GeoShape

Compute longitude/latitude bounds for the shape.

Specified by:

getBounds in interface GeoShape

Overrides:

getBounds in class GeoBaseShape

Parameters:

bounds - is the optional input bounds object. If this is null, a bounds object will be created. Otherwise, the input object will be modified.

Returns:

a Bounds object describing the shape's bounds. If the bounds cannot be computed, then return a Bounds object with noLongitudeBound, noTopLatitudeBound, and noBottomLatitudeBound.

getRelationship

public int getRelationship(GeoShape path)

Description copied from interface: GeoArea

Find 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. Note well: When a shape consists of multiple independent overlapping subshapes, it is sometimes impossible to determine the distinction between OVERLAPS and CONTAINS. In that case, OVERLAPS may be returned even though the proper result would in fact be CONTAINS. Code accordingly.

Parameters:

path - is the shape to consider.

Returns:

the relationship, from the perspective of the shape.

outsideDistance

protected double outsideDistance(DistanceStyle distanceStyle,
                     double x,
                     double y,
                     double z)

Description copied from class: GeoBaseMembershipShape

Called by a computeOutsideDistance method if X/Y/Z is not within this shape.

Specified by:

outsideDistance in class GeoBaseMembershipShape

equals

public boolean equals(Object o)

Overrides:

equals in class BasePlanetObject

hashCode

public int hashCode()

Overrides:

hashCode in class BasePlanetObject

toString

public String toString()

Overrides:

toString in class Object