org.apache.lucene.spatial.spatial4j.geo3d

Class GeoBaseExtendedShape

java.lang.Object

org.apache.lucene.spatial.spatial4j.geo3d.GeoBaseExtendedShape

All Implemented Interfaces:

GeoShape, Membership

Direct Known Subclasses:

GeoCircle, GeoConvexPolygon, GeoPath

public abstract class GeoBaseExtendedShape
extends Object
implements GeoShape

Base extended shape object.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static GeoPoint	NORTH_POLE
protected static GeoPoint	SOUTH_POLE

Constructor Summary

Constructors

Constructor and Description
GeoBaseExtendedShape()

Method Summary

Methods

Modifier and Type	Method and Description
Bounds	getBounds(Bounds bounds) Compute longitude/latitude bounds for the shape.
abstract GeoPoint[]	getEdgePoints() Return a sample point that is on the edge of the shape.
abstract boolean	intersects(Plane plane, GeoPoint[] notablePoints, Membership... bounds) Assess whether a plane, within the provided bounds, intersects with the shape.
abstract boolean	isWithin(double x, double y, double z) Check if a point is within this shape.
abstract boolean	isWithin(Vector point) Check if a point is within this shape.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.lucene.spatial.spatial4j.geo3d.GeoShape

equals

Field Detail

NORTH_POLE

protected static final GeoPoint NORTH_POLE

SOUTH_POLE

protected static final GeoPoint SOUTH_POLE

Constructor Detail

GeoBaseExtendedShape

public GeoBaseExtendedShape()

Method Detail

isWithin

public abstract boolean isWithin(Vector point)

Check if a point is within this shape.

Specified by:

isWithin in interface Membership

Parameters:

point - is the point to check.

Returns:

true if the point is within this shape

isWithin

public abstract boolean isWithin(double x,
               double y,
               double z)

Check if a point is within this shape.

Specified by:

isWithin in interface Membership

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 abstract GeoPoint[] getEdgePoints()

Return a sample point that is on the edge of the shape.

Specified by:

getEdgePoints in interface GeoShape

Returns:

a number of edge points, one for each disconnected edge.

intersects

public abstract boolean intersects(Plane plane,
                 GeoPoint[] notablePoints,
                 Membership... bounds)

Assess whether a plane, within the provided bounds, intersects with the shape.

Specified by:

intersects in interface GeoShape

Parameters:

plane - is the plane to assess for intersection with the shape's edges or bounding curves.

bounds - are a set of bounds that define an area that an intersection must be within in order to qualify (provided by a GeoArea).

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.

Returns:

true if there's such an intersection, false if not.

getBounds

public Bounds getBounds(Bounds bounds)

Compute longitude/latitude bounds for the shape.

Specified by:

getBounds in interface GeoShape

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.