org.apache.lucene.geo3d

Interface Membership

All Known Subinterfaces:

GeoArea, GeoBBox, GeoCircle, GeoDistance, GeoDistanceShape, GeoMembershipShape, GeoOutsideDistance, GeoPolygon, GeoShape, XYZSolid

All Known Implementing Classes:

BaseXYZSolid, dXdYdZSolid, dXdYZSolid, dXYdZSolid, dXYZSolid, GeoBaseBBox, GeoBaseCircle, GeoBaseDistanceShape, GeoBaseMembershipShape, GeoBasePolygon, GeoBaseShape, GeoCompositeMembershipShape, GeoCompositePolygon, GeoConvexPolygon, GeoDegenerateHorizontalLine, GeoDegenerateLatitudeZone, GeoDegenerateLongitudeSlice, GeoDegeneratePoint, GeoDegenerateVerticalLine, GeoLatitudeZone, GeoLongitudeSlice, GeoNorthLatitudeZone, GeoNorthRectangle, GeoPath, GeoRectangle, GeoSouthLatitudeZone, GeoSouthRectangle, GeoStandardCircle, GeoWideDegenerateHorizontalLine, GeoWideDegenerateHorizontalLine.EitherBound, GeoWideLongitudeSlice, GeoWideNorthRectangle, GeoWideNorthRectangle.EitherBound, GeoWideRectangle, GeoWideRectangle.EitherBound, GeoWideSouthRectangle, GeoWideSouthRectangle.EitherBound, GeoWorld, SidedPlane, StandardXYZSolid, XdYdZSolid, XdYZSolid, XYdZSolid

public interface Membership

Implemented by Geo3D shapes that can calculate if a point is within it or not.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isWithin(double x, double y, double z) Check if a point is within this shape.
boolean	isWithin(Vector point) Check if a point is within this shape.

Method Detail

isWithin

boolean isWithin(Vector point)

Check if a point is within this shape.

Parameters:

point - is the point to check.

Returns:

true if the point is within this shape

isWithin

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

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