Index (Lucene 10.5.0 spatial3d API)

# Index

A B C D E F G H I L M N O P R S T U V W X Y Z
All Classes and Interfaces|All Packages|Constant Field Values

## A

a - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  Semi-major axis
addBounds(XYZBounds) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Add a fully-formed XYZBounds to the current one.
addHorizontalPlane(PlanetModel, double, Plane, Membership...) - Method in interface org.apache.lucene.spatial3d.geom.Bounds
  Add a horizontal plane to the bounds description.
addHorizontalPlane(PlanetModel, double, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
addHorizontalPlane(PlanetModel, double, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Add a horizontal plane to the bounds description.
addIntersection(PlanetModel, Plane, Plane, Membership...) - Method in interface org.apache.lucene.spatial3d.geom.Bounds
  Add the intersection between two planes to the bounds description.
addIntersection(PlanetModel, Plane, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
addIntersection(PlanetModel, Plane, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
addPlane(PlanetModel, Plane, Membership...) - Method in interface org.apache.lucene.spatial3d.geom.Bounds
  Add a general plane to the bounds description.
addPlane(PlanetModel, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
addPlane(PlanetModel, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
addPoint(GeoPoint) - Method in interface org.apache.lucene.spatial3d.geom.Bounds
  Add a single point.
addPoint(GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
addPoint(GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
addShape(T) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape
  Add a shape to the composite.
addVerticalPlane(PlanetModel, double, Plane, Membership...) - Method in interface org.apache.lucene.spatial3d.geom.Bounds
  Add a vertical plane to the bounds description.
addVerticalPlane(PlanetModel, double, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
addVerticalPlane(PlanetModel, double, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Add a vertical plane to the bounds description.
addXValue(double) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Add a specific X value.
addXValue(GeoPoint) - Method in interface org.apache.lucene.spatial3d.geom.Bounds
  Add an X value.
addXValue(GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
addXValue(GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
addYValue(double) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Add a specific Y value.
addYValue(GeoPoint) - Method in interface org.apache.lucene.spatial3d.geom.Bounds
  Add a Y value.
addYValue(GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
addYValue(GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
addZValue(double) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Add a specific Z value.
addZValue(GeoPoint) - Method in interface org.apache.lucene.spatial3d.geom.Bounds
  Add a Z value.
addZValue(GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
addZValue(GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
aggregateDistances(double...) - Method in interface org.apache.lucene.spatial3d.geom.DistanceStyle
  Aggregate two distances together to produce a "sum".
ALL_INSIDE - Static variable in class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
  All edgepoints inside shape
ALL_INSIDE - Static variable in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  All edgepoints inside shape
ALL_INSIDE - Static variable in class org.apache.lucene.spatial3d.geom.GeoCompositeAreaShape
  All edgepoints inside shape
ALL_INSIDE - Static variable in class org.apache.lucene.spatial3d.geom.GeoCompositePolygon
  All edgepoints inside shape
ARC - Static variable in interface org.apache.lucene.spatial3d.geom.DistanceStyle
  Arc distance calculator
arcDistance(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.GeoPoint
  Compute an arc distance between two points.
arcDistance(PlanetModel, double, double, double, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Compute arc distance from plane to a vector.
arcDistance(PlanetModel, GeoPoint, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Compute arc distance from plane to a vector expressed with a `GeoPoint`.
arcDistance(Vector) - Method in class org.apache.lucene.spatial3d.geom.GeoPoint
  Compute an arc distance between two points.
ArcDistance - Class in org.apache.lucene.spatial3d.geom
  Arc distance computation style.
ArcDistance() - Constructor for class org.apache.lucene.spatial3d.geom.ArcDistance
  Constructor.
arePointsCoplanar(GeoPoint, GeoPoint, GeoPoint) - Static method in class org.apache.lucene.spatial3d.geom.Plane
  Checks if three points are coplanar in any of the three planes they can describe.

## B

b - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  Semi-minor axis
BasePlanetObject - Class in org.apache.lucene.spatial3d.geom
  All Geo3D shapes can derive from this base class, which furnishes some common code
BasePlanetObject(PlanetModel) - Constructor for class org.apache.lucene.spatial3d.geom.BasePlanetObject
  Constructor creating class instance given a planet model.
bisection(GeoPoint, GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Compute a GeoPoint that's a bisection between two other GeoPoints.
bottomLat - Variable in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  Bottom latitude of the vertical line
bottomPlane - Variable in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  Bottom end cutoff plane
Bounded - Interface in org.apache.lucene.spatial3d.geom
  This interface describes methods that determine what the bounds are for a shape.
boundingPlane - Variable in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  Back-side cutoff plane
Bounds - Interface in org.apache.lucene.spatial3d.geom
  An interface for accumulating bounds information.

## C

centerPoint - Variable in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  A computed center point for the line
checkNoBottomLatitudeBound() - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
  Check if there's no bottom latitude bound.
checkNoLongitudeBound() - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
  Check if there's no longitude bound.
checkNoTopLatitudeBound() - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
  Check if there's no top latitude bound.
CLARKE_1866 - Static variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  Planet model corresponding to Clarke 1866 ellipsoid
computeDeltaDistance(DistanceStyle, double, double, double) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
computeDeltaDistance(DistanceStyle, double, double, double) - Method in interface org.apache.lucene.spatial3d.geom.GeoDistance
  Compute the shape's delta distance given a point.
computeDeltaDistance(DistanceStyle, GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
computeDeltaDistance(DistanceStyle, GeoPoint) - Method in interface org.apache.lucene.spatial3d.geom.GeoDistance
  Compute the shape's delta distance given a point.
computeDistance(DistanceStyle, double, double, double) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
computeDistance(DistanceStyle, double, double, double) - Method in interface org.apache.lucene.spatial3d.geom.GeoDistance
  Compute this shape's internal "distance" to the GeoPoint.
computeDistance(DistanceStyle, GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
computeDistance(DistanceStyle, GeoPoint) - Method in interface org.apache.lucene.spatial3d.geom.GeoDistance
  Compute this shape's internal "distance" to the GeoPoint.
computeDistance(GeoPoint, double, double, double) - Method in class org.apache.lucene.spatial3d.geom.ArcDistance
computeDistance(GeoPoint, double, double, double) - Method in interface org.apache.lucene.spatial3d.geom.DistanceStyle
  Compute the distance from a point to another point.
computeDistance(GeoPoint, double, double, double) - Method in class org.apache.lucene.spatial3d.geom.LinearDistance
computeDistance(GeoPoint, double, double, double) - Method in class org.apache.lucene.spatial3d.geom.LinearSquaredDistance
computeDistance(GeoPoint, double, double, double) - Method in class org.apache.lucene.spatial3d.geom.NormalDistance
computeDistance(GeoPoint, double, double, double) - Method in class org.apache.lucene.spatial3d.geom.NormalSquaredDistance
computeDistance(GeoPoint, GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.ArcDistance
computeDistance(GeoPoint, GeoPoint) - Method in interface org.apache.lucene.spatial3d.geom.DistanceStyle
  Compute the distance from a point to another point.
computeDistance(GeoPoint, GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.LinearDistance
computeDistance(GeoPoint, GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.LinearSquaredDistance
computeDistance(GeoPoint, GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.NormalDistance
computeDistance(GeoPoint, GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.NormalSquaredDistance
computeDistance(PlanetModel, Plane, double, double, double, Membership...) - Method in class org.apache.lucene.spatial3d.geom.ArcDistance
computeDistance(PlanetModel, Plane, double, double, double, Membership...) - Method in interface org.apache.lucene.spatial3d.geom.DistanceStyle
  Compute the distance from a plane to a point.
computeDistance(PlanetModel, Plane, double, double, double, Membership...) - Method in class org.apache.lucene.spatial3d.geom.LinearDistance
computeDistance(PlanetModel, Plane, double, double, double, Membership...) - Method in class org.apache.lucene.spatial3d.geom.LinearSquaredDistance
computeDistance(PlanetModel, Plane, double, double, double, Membership...) - Method in class org.apache.lucene.spatial3d.geom.NormalDistance
computeDistance(PlanetModel, Plane, double, double, double, Membership...) - Method in class org.apache.lucene.spatial3d.geom.NormalSquaredDistance
computeDistance(PlanetModel, Plane, GeoPoint, Membership...) - Method in class org.apache.lucene.spatial3d.geom.ArcDistance
computeDistance(PlanetModel, Plane, GeoPoint, Membership...) - Method in interface org.apache.lucene.spatial3d.geom.DistanceStyle
  Compute the distance from a plane to a point.
computeDistance(PlanetModel, Plane, GeoPoint, Membership...) - Method in class org.apache.lucene.spatial3d.geom.LinearDistance
computeDistance(PlanetModel, Plane, GeoPoint, Membership...) - Method in class org.apache.lucene.spatial3d.geom.LinearSquaredDistance
computeDistance(PlanetModel, Plane, GeoPoint, Membership...) - Method in class org.apache.lucene.spatial3d.geom.NormalDistance
computeDistance(PlanetModel, Plane, GeoPoint, Membership...) - Method in class org.apache.lucene.spatial3d.geom.NormalSquaredDistance
computeNearestDistance(DistanceStyle, double, double, double) - Method in interface org.apache.lucene.spatial3d.geom.GeoPath
  Compute the nearest path distance to the GeoPoint.
computeNearestDistance(DistanceStyle, GeoPoint) - Method in interface org.apache.lucene.spatial3d.geom.GeoPath
  Compute the nearest path distance to the GeoPoint.
computeOutsideDistance(DistanceStyle, double, double, double) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositeAreaShape
computeOutsideDistance(DistanceStyle, double, double, double) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositeMembershipShape
computeOutsideDistance(DistanceStyle, double, double, double) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositePolygon
computeOutsideDistance(DistanceStyle, double, double, double) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseMembershipShape
computeOutsideDistance(DistanceStyle, double, double, double) - Method in interface org.apache.lucene.spatial3d.geom.GeoOutsideDistance
  Compute this shape's distance to the GeoPoint.
computeOutsideDistance(DistanceStyle, GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositeAreaShape
computeOutsideDistance(DistanceStyle, GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositeMembershipShape
computeOutsideDistance(DistanceStyle, GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositePolygon
computeOutsideDistance(DistanceStyle, GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseMembershipShape
computeOutsideDistance(DistanceStyle, GeoPoint) - Method in interface org.apache.lucene.spatial3d.geom.GeoOutsideDistance
  Compute this shape's distance to the GeoPoint.
computePathCenterDistance(DistanceStyle, double, double, double) - Method in interface org.apache.lucene.spatial3d.geom.GeoPath
  Compute the shortest distance from the path center to the GeoPoint.
computePathCenterDistance(DistanceStyle, GeoPoint) - Method in interface org.apache.lucene.spatial3d.geom.GeoPath
  Compute the shortest distance from the path center to the GeoPoint.
constructNormalizedPerpendicularSidedPlane(Vector, Vector, Vector, Vector) - Static method in class org.apache.lucene.spatial3d.geom.SidedPlane
  Construct a sided plane from two points and a third normal vector.
constructNormalizedThreePointSidedPlane(Vector, Vector, Vector, Vector) - Static method in class org.apache.lucene.spatial3d.geom.SidedPlane
  Construct a sided plane from three points.
constructNormalizedXPlane(double, double, double) - Static method in class org.apache.lucene.spatial3d.geom.Plane
  Construct a normalized plane through a y-z point and parallel to the X axis.
constructNormalizedXPlane(Vector...) - Static method in class org.apache.lucene.spatial3d.geom.Plane
  Construct the most accurate normalized plane through an y-z point and including the X axis.
constructNormalizedYPlane(double, double, double) - Static method in class org.apache.lucene.spatial3d.geom.Plane
  Construct a normalized plane through an x-z point and parallel to the Y axis.
constructNormalizedYPlane(Vector...) - Static method in class org.apache.lucene.spatial3d.geom.Plane
  Construct the most accurate normalized plane through an x-z point and including the Y axis.
constructNormalizedZPlane(double, double) - Static method in class org.apache.lucene.spatial3d.geom.Plane
  Construct a normalized plane through an x-y point and including the Z axis.
constructNormalizedZPlane(Vector...) - Static method in class org.apache.lucene.spatial3d.geom.Plane
  Construct the most accurate normalized plane through an x-y point and including the Z axis.
constructPerpendicularCenterPlaneOnePoint(Plane, Vector) - Static method in class org.apache.lucene.spatial3d.geom.Plane
  Given a plane and one point that is on that plane, find a perpendicular plane that goes through both the origin and the point.
constructPerpendicularCenterPlaneTwoPoints(Vector, Vector) - Static method in class org.apache.lucene.spatial3d.geom.Plane
  Given two points, construct a plane that goes through them and the origin.
constructSidedPlaneFromOnePoint(Vector, Plane, Vector) - Static method in class org.apache.lucene.spatial3d.geom.SidedPlane
  Construct sided plane from a plane and one point.
constructSidedPlaneFromTwoPoints(Vector, Vector, Vector) - Static method in class org.apache.lucene.spatial3d.geom.SidedPlane
  Construct sided plane from two points.
CONTAINS - Static variable in interface org.apache.lucene.spatial3d.geom.GeoArea
  The referenced shape CONTAINS this area
createSurfacePoint(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Compute a GeoPoint that's based on (x,y,z) values, but is scaled to actually be on the planet surface.
createSurfacePoint(Vector) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Compute a GeoPoint that's scaled to actually be on the planet surface.
crosses(PlanetModel, Plane, GeoPoint[], GeoPoint[], Membership[], Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Determine whether the plane crosses another plane within the bounds provided.
crossProductEvaluateIsZero(Vector, Vector, Vector) - Static method in class org.apache.lucene.spatial3d.geom.Vector
  Evaluate the cross product of two vectors against a point.

## D

D - Variable in class org.apache.lucene.spatial3d.geom.Plane
  Ax + By + Cz + D = 0
DECODE - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  scalar value used to decode from integer back into double space
decodeDimension(byte[], int, PlanetModel) - Static method in class org.apache.lucene.spatial3d.Geo3DPoint
  Decode single dimension
decodePoint(long) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel.DocValueEncoder
  Decode GeoPoint value from long docvalues value.
decodeValue(int) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Decodes a given integer back into the radian value according to the defined planet model
decodeXValue(long) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel.DocValueEncoder
  Decode X value from long docvalues value.
decodeYValue(long) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel.DocValueEncoder
  Decode Y value from long docvalues value.
decodeZValue(long) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel.DocValueEncoder
  Decode Z value from long docvalues value.
deltaDistance(DistanceStyle, double, double, double) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
  Called by a `computeDeltaDistance` method if X/Y/Z is within this shape.
DISJOINT - Static variable in interface org.apache.lucene.spatial3d.geom.GeoArea
  The referenced shape has no relation to this area
distance(DistanceStyle, double, double, double) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
  Called by a `computeDistance` method if X/Y/Z is within this shape.
distanceBounds(Bounds, DistanceStyle, double) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
  Called by a `getDistanceBounds` method if distanceValue is not Double.POSITIVE_INFINITY.
DistanceStyle - Interface in org.apache.lucene.spatial3d.geom
  Distance computation styles, supporting various ways of computing distance to shapes.
docValueEncoder - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  utility class used to encode/decode from lat/lon (decimal degrees) into doc value integers
dotProduct(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Do a dot product.
dotProduct(Vector) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Do a dot product.

## E

edgePoints - Variable in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  A point that's on the line
encodeDimension(double, byte[], int, PlanetModel) - Static method in class org.apache.lucene.spatial3d.Geo3DPoint
  Encode single dimension
encodePoint(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel.DocValueEncoder
  Encode a point.
encodePoint(GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel.DocValueEncoder
  Encode a point.
encodeValue(double) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  encode the provided value from double to integer space
equals(Object) - Method in class org.apache.lucene.spatial3d.geom.BasePlanetObject
equals(Object) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape
equals(Object) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositeAreaShape
equals(Object) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositeMembershipShape
equals(Object) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositePolygon
equals(Object) - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
equals(Object) - Method in class org.apache.lucene.spatial3d.geom.Plane
equals(Object) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
equals(Object) - Method in class org.apache.lucene.spatial3d.geom.SidedPlane
equals(Object) - Method in class org.apache.lucene.spatial3d.geom.Vector
evaluate(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Evaluate the plane equation for a given point, as represented by a vector.
evaluate(Vector) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Evaluate the plane equation for a given point, as represented by a vector.
evaluateIsZero(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Evaluate the plane equation for a given point, as represented by a vector.
evaluateIsZero(Vector) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Evaluate the plane equation for a given point, as represented by a vector.
expand(double) - Method in interface org.apache.lucene.spatial3d.geom.GeoBBox
  Expand box by specified angle.
expand(double) - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine

## F

findArcDistancePoints(PlanetModel, double, GeoPoint, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Locate a point that is within the specified bounds and on the specified plane, that has an arcDistance as specified from the startPoint.
findCrossings(PlanetModel, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Find the points between two planes, where one plane crosses the other, given a set of bounds.
findCrossings(PlanetModel, Plane, Membership[], Membership[]) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Find the points between two planes, where one plane crosses the other, given a set of bounds.
findDistancePoints(PlanetModel, double, GeoPoint, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.ArcDistance
findDistancePoints(PlanetModel, double, GeoPoint, Plane, Membership...) - Method in interface org.apache.lucene.spatial3d.geom.DistanceStyle
  Find a GeoPoint, at a specified distance from a starting point, within the specified bounds.
findDistancePoints(PlanetModel, double, GeoPoint, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.LinearDistance
findDistancePoints(PlanetModel, double, GeoPoint, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.LinearSquaredDistance
findDistancePoints(PlanetModel, double, GeoPoint, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.NormalDistance
findDistancePoints(PlanetModel, double, GeoPoint, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.NormalSquaredDistance
findIntersectionBounds(PlanetModel, Bounds, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Record intersection points for planes with error bounds.
findIntersections(PlanetModel, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Find the intersection points between two planes, given a set of bounds.
findIntersections(PlanetModel, Plane, Membership[], Membership[]) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Find the intersection points between two planes, given a set of bounds.
findMaximumArcDistance(PlanetModel, double) - Method in class org.apache.lucene.spatial3d.geom.ArcDistance
findMaximumArcDistance(PlanetModel, double) - Method in interface org.apache.lucene.spatial3d.geom.DistanceStyle
  Given a distance metric, find the maximum arc distance represented by the distance metric.
findMaximumArcDistance(PlanetModel, double) - Method in class org.apache.lucene.spatial3d.geom.LinearDistance
findMaximumArcDistance(PlanetModel, double) - Method in class org.apache.lucene.spatial3d.geom.LinearSquaredDistance
findMaximumArcDistance(PlanetModel, double) - Method in class org.apache.lucene.spatial3d.geom.NormalDistance
findMaximumArcDistance(PlanetModel, double) - Method in class org.apache.lucene.spatial3d.geom.NormalSquaredDistance
findMinimumArcDistance(PlanetModel, double) - Method in class org.apache.lucene.spatial3d.geom.ArcDistance
findMinimumArcDistance(PlanetModel, double) - Method in interface org.apache.lucene.spatial3d.geom.DistanceStyle
  Given a distance metric, find the minimum arc distance represented by that distance metric.
findMinimumArcDistance(PlanetModel, double) - Method in class org.apache.lucene.spatial3d.geom.LinearDistance
findMinimumArcDistance(PlanetModel, double) - Method in class org.apache.lucene.spatial3d.geom.LinearSquaredDistance
findMinimumArcDistance(PlanetModel, double) - Method in class org.apache.lucene.spatial3d.geom.NormalDistance
findMinimumArcDistance(PlanetModel, double) - Method in class org.apache.lucene.spatial3d.geom.NormalSquaredDistance
fromAggregationForm(double) - Method in interface org.apache.lucene.spatial3d.geom.DistanceStyle
  Convert an aggregation form distance value back to an actual distance.
fromAggregationForm(double) - Method in class org.apache.lucene.spatial3d.geom.LinearSquaredDistance
fromAggregationForm(double) - Method in class org.apache.lucene.spatial3d.geom.NormalSquaredDistance

## G

Geo3DDocValuesField - Class in org.apache.lucene.spatial3d
  An per-document 3D location field.
Geo3DDocValuesField(String, double, double, double, PlanetModel) - Constructor for class org.apache.lucene.spatial3d.Geo3DDocValuesField
  Creates a new Geo3DDocValuesField with the specified x, y, and z
Geo3DDocValuesField(String, GeoPoint, PlanetModel) - Constructor for class org.apache.lucene.spatial3d.Geo3DDocValuesField
  Creates a new Geo3DDocValuesField with the specified x, y, and z
Geo3DPoint - Class in org.apache.lucene.spatial3d
  Add this to a document to index lat/lon or x/y/z point, indexed as a 3D point.
Geo3DPoint(String, double, double) - Constructor for class org.apache.lucene.spatial3d.Geo3DPoint
  Creates a new Geo3DPoint field with the specified latitude, longitude (in degrees), with default WGS84 PlanetModel.
Geo3DPoint(String, double, double, double) - Constructor for class org.apache.lucene.spatial3d.Geo3DPoint
  Creates a new Geo3DPoint field with the specified x,y,z, using default WGS84 planet model.
Geo3DPoint(String, PlanetModel, double, double) - Constructor for class org.apache.lucene.spatial3d.Geo3DPoint
  Creates a new Geo3DPoint field with the specified latitude, longitude (in degrees), given a planet model.
Geo3DPoint(String, PlanetModel, double, double, double) - Constructor for class org.apache.lucene.spatial3d.Geo3DPoint
  Creates a new Geo3DPoint field with the specified x,y,z, and given planet model.
GeoArea - Interface in org.apache.lucene.spatial3d.geom
  A GeoArea represents a standard 2-D breakdown of a part of sphere.
GeoAreaFactory - Class in org.apache.lucene.spatial3d.geom
  Factory for `GeoArea`.
GeoAreaShape - Interface in org.apache.lucene.spatial3d.geom
  Shape that implements GeoArea.
GeoBaseBounds - Class in org.apache.lucene.spatial3d.geom
  Base object that supports bounds operations.
GeoBaseBounds(PlanetModel) - Constructor for class org.apache.lucene.spatial3d.geom.GeoBaseBounds
  Constructor.
GeoBaseCompositeShape<T> - Class in org.apache.lucene.spatial3d.geom
  Base class to create a composite of GeoShapes.
GeoBaseCompositeShape(PlanetModel) - Constructor for class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape
  Constructor.
GeoBaseCompositeShape(PlanetModel, InputStream, Class<T>) - Constructor for class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape
  Constructor for deserialization.
GeoBaseDistanceShape - Class in org.apache.lucene.spatial3d.geom
  Distance shapes have capabilities of both geohashing and distance computation (which also includes point membership determination).
GeoBaseDistanceShape(PlanetModel) - Constructor for class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
  Constructor.
GeoBaseMembershipShape - Class in org.apache.lucene.spatial3d.geom
  Membership shapes have capabilities of both geohashing and membership determination.
GeoBaseMembershipShape(PlanetModel) - Constructor for class org.apache.lucene.spatial3d.geom.GeoBaseMembershipShape
  Constructor.
GeoBaseShape - Class in org.apache.lucene.spatial3d.geom
  Base extended shape object.
GeoBaseShape(PlanetModel) - Constructor for class org.apache.lucene.spatial3d.geom.GeoBaseShape
  Constructor.
GeoBBox - Interface in org.apache.lucene.spatial3d.geom
  All bounding box shapes have this interface in common.
GeoBBoxFactory - Class in org.apache.lucene.spatial3d.geom
  Factory for `GeoBBox`.
GeoBounds - Interface in org.apache.lucene.spatial3d.geom
  Generic shape that supports bounds.
GeoCircle - Interface in org.apache.lucene.spatial3d.geom
  Interface describing circular area with a center and radius.
GeoCircleFactory - Class in org.apache.lucene.spatial3d.geom
  Class which constructs a GeoCircle representing an arbitrary circle.
GeoCompositeAreaShape - Class in org.apache.lucene.spatial3d.geom
  GeoCompositeAreaShape is a set of GeoAreaShape's, treated as a unit.
GeoCompositeAreaShape(PlanetModel) - Constructor for class org.apache.lucene.spatial3d.geom.GeoCompositeAreaShape
  Constructor.
GeoCompositeAreaShape(PlanetModel, InputStream) - Constructor for class org.apache.lucene.spatial3d.geom.GeoCompositeAreaShape
  Constructor for deserialization.
GeoCompositeMembershipShape - Class in org.apache.lucene.spatial3d.geom
  GeoCompositeMembershipShape is a set of GeoMembershipShape's, treated as a unit.
GeoCompositeMembershipShape(PlanetModel) - Constructor for class org.apache.lucene.spatial3d.geom.GeoCompositeMembershipShape
  Constructor.
GeoCompositeMembershipShape(PlanetModel, InputStream) - Constructor for class org.apache.lucene.spatial3d.geom.GeoCompositeMembershipShape
  Constructor for deserialization.
GeoCompositePolygon - Class in org.apache.lucene.spatial3d.geom
  GeoCompositePolygon is a specific implementation of GeoCompositeAreaShape, which implements GeoPolygon explicitly.
GeoCompositePolygon(PlanetModel) - Constructor for class org.apache.lucene.spatial3d.geom.GeoCompositePolygon
  Constructor.
GeoCompositePolygon(PlanetModel, InputStream) - Constructor for class org.apache.lucene.spatial3d.geom.GeoCompositePolygon
  Constructor for deserialization.
GeoDegenerateVerticalLine - Class in org.apache.lucene.spatial3d.geom
  Degenerate bounding box limited on two sides (top lat, bottom lat).
GeoDegenerateVerticalLine(PlanetModel, double, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  Accepts only values in the following ranges: lat: `-PI/2 -> PI/2`, longitude: `-PI -> PI`
GeoDegenerateVerticalLine(PlanetModel, InputStream) - Constructor for class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  Constructor for deserialization.
GeoDistance - Interface in org.apache.lucene.spatial3d.geom
  An implementer of this interface is capable of computing the described "distance" values, which are meant to provide both actual distance values, as well as distance estimates that can be computed more cheaply.
GeoDistanceShape - Interface in org.apache.lucene.spatial3d.geom
  Distance shapes have capabilities of both geohashing and distance computation (which also includes point membership determination).
GeoMembershipShape - Interface in org.apache.lucene.spatial3d.geom
  Membership shapes have capabilities of both geohashing and membership determination.
GeoOutsideDistance - Interface in org.apache.lucene.spatial3d.geom
  Implemented by Geo3D shapes that can compute the distance from a point to the closest outside edge.
GeoPath - Interface in org.apache.lucene.spatial3d.geom
  Interface describing a path.
GeoPathFactory - Class in org.apache.lucene.spatial3d.geom
  Class which constructs a GeoPath representing an arbitrary path.
GeoPoint - Class in org.apache.lucene.spatial3d.geom
  This class represents a point on the surface of a sphere or ellipsoid.
GeoPoint(double, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.GeoPoint
  Construct a GeoPoint from an (x,y,z) value.
GeoPoint(double, double, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.GeoPoint
  Construct a GeoPoint from a unit (x,y,z) vector and a magnitude.
GeoPoint(double, double, double, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.GeoPoint
  Construct a GeoPoint from five unchecked parameters: lat, lon, x, y, z.
GeoPoint(double, double, double, double, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.GeoPoint
  Construct a GeoPoint from a unit (x,y,z) vector and a magnitude.
GeoPoint(InputStream) - Constructor for class org.apache.lucene.spatial3d.geom.GeoPoint
  Construct a GeoPoint from an input stream with no planet model.
GeoPoint(PlanetModel, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.GeoPoint
  Construct a GeoPoint from a latitude/longitude pair.
GeoPoint(PlanetModel, double, double, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.GeoPoint
  Construct a GeoPoint from the trig functions of a lat and lon pair.
GeoPoint(PlanetModel, double, double, double, double, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.GeoPoint
  Construct a GeoPoint from the trig functions of a lat and lon pair.
GeoPoint(PlanetModel, InputStream) - Constructor for class org.apache.lucene.spatial3d.geom.GeoPoint
  Construct a GeoPoint from an input stream.
GeoPointShape - Interface in org.apache.lucene.spatial3d.geom
  Interface describing a GeoPointShape shape.It may represents a degenerated bounding box or a degenerated circle, hence it extends such interfaces.
GeoPointShapeFactory - Class in org.apache.lucene.spatial3d.geom
  Class which constructs a GeoPointShape.
GeoPolygon - Interface in org.apache.lucene.spatial3d.geom
  GeoPolygon interface description.
GeoPolygonFactory - Class in org.apache.lucene.spatial3d.geom
  Class which constructs a GeoMembershipShape representing an arbitrary polygon.
GeoPolygonFactory.PolygonDescription - Class in org.apache.lucene.spatial3d.geom
  Use this class to specify a polygon with associated holes.
GeoS2ShapeFactory - Class in org.apache.lucene.spatial3d.geom
  Class which constructs a GeoPolygon representing S2 google pixel.
GeoShape - Interface in org.apache.lucene.spatial3d.geom
  Generic shape.
GeoSizeable - Interface in org.apache.lucene.spatial3d.geom
  Some shapes can compute radii of a geocircle in which they are inscribed.
getBounds(Bounds) - Method in interface org.apache.lucene.spatial3d.geom.Bounded
  Compute bounds for the shape.
getBounds(Bounds) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseBounds
getBounds(Bounds) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape
getBounds(Bounds) - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
getCenter() - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
getCenter() - Method in interface org.apache.lucene.spatial3d.geom.GeoSizeable
  Returns the center of a circle into which the area will be inscribed.
getDistanceBounds(Bounds, DistanceStyle, double) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
getDistanceBounds(Bounds, DistanceStyle, double) - Method in interface org.apache.lucene.spatial3d.geom.GeoDistanceShape
  Compute a bound based on a provided distance measure.
getDocValueEncoder() - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  return reference to the DocValueEncoder used to encode/decode Geo3DDocValues
getEdgePoints() - Method in class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape
getEdgePoints() - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
getEdgePoints() - Method in interface org.apache.lucene.spatial3d.geom.GeoShape
  Return a sample point that is on the outside edge/boundary of the shape.
getLatitude() - Method in class org.apache.lucene.spatial3d.geom.GeoPoint
  Compute the latitude for the point.
getLeftLongitude() - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
  Get left longitude, if any.
getLongitude() - Method in class org.apache.lucene.spatial3d.geom.GeoPoint
  Compute the longitude for the point.
getMaximumMagnitude() - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Find the maximum magnitude of all points on the ellipsoid.
getMaximumX() - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Return the maximum X value.
getMaximumXValue() - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Find the maximum x value.
getMaximumY() - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Return the maximum Y value.
getMaximumYValue() - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Find the maximum y value.
getMaximumZ() - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Return the maximum Z value.
getMaximumZValue() - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Find the maximum z value.
getMaxLatitude() - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
  Get maximum latitude, if any.
getMeanRadius() - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  return the calculated mean radius (in units provided by ab and c)
getMinimumMagnitude() - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Find the minimum magnitude of all points on the ellipsoid.
getMinimumX() - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Return the minimum X value.
getMinimumXValue() - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Find the minimum x value.
getMinimumY() - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Return the minimum Y value.
getMinimumYValue() - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Find the minimum y value.
getMinimumZ() - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Return the minimum Z value.
getMinimumZValue() - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Find the minimum z value.
getMinLatitude() - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
  Get minimum latitude, if any.
getPlanetModel() - Method in class org.apache.lucene.spatial3d.geom.BasePlanetObject
getPlanetModel() - Method in interface org.apache.lucene.spatial3d.geom.PlanetObject
  Returns the `PlanetModel` provided when this shape was created.
getRadius() - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
getRadius() - Method in interface org.apache.lucene.spatial3d.geom.GeoSizeable
  Returns the radius of a circle into which the GeoSizeable area can be inscribed.
getRelationship(GeoShape) - Method in interface org.apache.lucene.spatial3d.geom.GeoArea
  Find the spatial relationship between a shape and the current geo area.
getRelationship(GeoShape) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
getRelationship(GeoShape) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositeAreaShape
getRelationship(GeoShape) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositePolygon
getRelationship(GeoShape) - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
getRightLongitude() - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
  Get right longitude, if any.
getSampleIntersectionPoint(PlanetModel, Plane) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Find a sample point on the intersection between two planes and the world.
getShape(int) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape
  Get shape at index
getShapes() - Method in class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape
  Returns an unmodifiable list of composed shapes.

## H

hashCode() - Method in class org.apache.lucene.spatial3d.geom.BasePlanetObject
hashCode() - Method in class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape
hashCode() - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
hashCode() - Method in class org.apache.lucene.spatial3d.geom.Plane
hashCode() - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
hashCode() - Method in class org.apache.lucene.spatial3d.geom.SidedPlane
hashCode() - Method in class org.apache.lucene.spatial3d.geom.Vector
holes - Variable in class org.apache.lucene.spatial3d.geom.GeoPolygonFactory.PolygonDescription
  The list of holes

## I

INSTANCE - Static variable in class org.apache.lucene.spatial3d.geom.ArcDistance
  An instance of the ArcDistance DistanceStyle.
INSTANCE - Static variable in class org.apache.lucene.spatial3d.geom.LinearDistance
  A convenient instance
INSTANCE - Static variable in class org.apache.lucene.spatial3d.geom.LinearSquaredDistance
  A convenient instance
INSTANCE - Static variable in class org.apache.lucene.spatial3d.geom.NormalDistance
  A convenient instance
INSTANCE - Static variable in class org.apache.lucene.spatial3d.geom.NormalSquaredDistance
  A convenient instance
interpolate(PlanetModel, GeoPoint, GeoPoint, double[]) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Find points on the boundary of the intersection of a plane and the unit sphere, given a starting point, and ending point, and a list of proportions of the arc (e.g.
intersects(GeoShape) - Method in interface org.apache.lucene.spatial3d.geom.GeoAreaShape
  Assess whether a shape intersects with any of the edges of this shape.
intersects(GeoShape) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositeAreaShape
intersects(GeoShape) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositePolygon
intersects(GeoShape) - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
intersects(Plane, GeoPoint[], Membership...) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape
intersects(Plane, GeoPoint[], Membership...) - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
intersects(Plane, GeoPoint[], Membership...) - Method in interface org.apache.lucene.spatial3d.geom.GeoShape
  Assess whether a plane, within the provided bounds, intersects with the shape's edges.
intersects(PlanetModel, Plane, GeoPoint[], GeoPoint[], Membership[], Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Determine whether the plane intersects another plane within the bounds provided.
inverseScale - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  The inverse of scale
inverseXYScaling - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  The inverse of xyScaling
inverseXYScalingSquared - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  The square of the inverse of xyScaling
inverseZScaling - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  The inverse of zScaling
inverseZScalingSquared - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  The square of the inverse of zScaling
isFunctionallyIdentical(Plane) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Returns true if this plane and the other plane are functionally identical within the margin of error.
isGeoAreaShapeInsideShape(GeoShape) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
  Determine the relationship between the GeoAreaShape's edgepoints and the provided shape.
isGeoAreaShapeInsideShape(GeoShape) - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  Determine the relationship between the GeoAreaShape's edgepoints and the provided shape.
isGeoAreaShapeInsideShape(GeoShape) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositeAreaShape
  Determine the relationship between the GeoAreShape's edgepoints and the provided shape.
isGeoAreaShapeInsideShape(GeoShape) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositePolygon
  Determine the relationship between the GeoAreShape's edgepoints and the provided shape.
isIdentical(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.GeoPoint
  Compute whether point matches another.
isIdentical(GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.GeoPoint
  Compute whether point matches another.
isLargestMaxX(PlanetModel) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Return true if maxX is as large as the planet model allows.
isLargestMaxY(PlanetModel) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Return true if maxY is as large as the planet model allows.
isLargestMaxZ(PlanetModel) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Return true if maxZ is as large as the planet model allows.
isNumericallyIdentical(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Compute whether two vectors are numerically identical.
isNumericallyIdentical(Plane) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Returns true if this plane and the other plane are identical within the margin of error.
isNumericallyIdentical(Vector) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Compute whether two vectors are numerically identical.
isParallel(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Compute whether two vectors are parallel.
isParallel(Vector) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Compute whether two vectors are numerically identical.
isShapeInsideGeoAreaShape(GeoShape) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
  Determine the relationship between the GeoAreShape and the shape's edgepoints.
isShapeInsideGeoAreaShape(GeoShape) - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  Determine the relationship between the GeoAreShape and the shape's edgepoints.
isShapeInsideGeoAreaShape(GeoShape) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositeAreaShape
  Determine the relationship between the GeoAreShape and the shape's edgepoints.
isShapeInsideGeoAreaShape(GeoShape) - Method in class org.apache.lucene.spatial3d.geom.GeoCompositePolygon
  Determine the relationship between the GeoAreShape and the shape's edgepoints.
isSmallestMinX(PlanetModel) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Return true if minX is as small as the planet model allows.
isSmallestMinY(PlanetModel) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Return true if minY is as small as the planet model allows.
isSmallestMinZ(PlanetModel) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Return true if minZ is as small as the planet model allows.
isSphere() - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Does this planet model describe a sphere?
isWide() - Method in interface org.apache.lucene.spatial3d.geom.Bounds
  Signal that the shape exceeds Math.PI in longitude.
isWide() - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
isWide() - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
isWithin(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape
isWithin(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
isWithin(double, double, double) - Method in interface org.apache.lucene.spatial3d.geom.Membership
  Check if a point is within this shape.
isWithin(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.SidedPlane
isWithin(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Courtesy method to see if a point is within the bounds.
isWithin(Membership[], Membership...) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Determine if this vector, taken from the origin, describes a point within a set of planes.
isWithin(Vector) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape
isWithin(Vector) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
isWithin(Vector) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseMembershipShape
isWithin(Vector) - Method in interface org.apache.lucene.spatial3d.geom.Membership
  Check if a point is within this shape.
isWithin(Vector) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Courtesy method to see if a point is within the bounds.

## L

latitude - Variable in class org.apache.lucene.spatial3d.geom.GeoPoint
  Lazily-evaluated latitude.
LatLonBounds - Class in org.apache.lucene.spatial3d.geom
  An object for accumulating latitude/longitude bounds information.
LatLonBounds() - Constructor for class org.apache.lucene.spatial3d.geom.LatLonBounds
  Construct an empty bounds object
LHC - Variable in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  Point at the lower end of the vertical line
LINEAR - Static variable in interface org.apache.lucene.spatial3d.geom.DistanceStyle
  Linear distance calculator
LINEAR_SQUARED - Static variable in interface org.apache.lucene.spatial3d.geom.DistanceStyle
  Linear distance squared calculator
linearDistance(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Compute the straight-line distance to a point described by the vector taken from the origin.
linearDistance(PlanetModel, double, double, double, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Compute linear distance from plane to a vector.
linearDistance(PlanetModel, GeoPoint, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Compute linear distance from plane to a vector.
linearDistance(Vector) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Compute the straight-line distance to a point described by the vector taken from the origin.
LinearDistance - Class in org.apache.lucene.spatial3d.geom
  Linear distance computation style.
LinearDistance() - Constructor for class org.apache.lucene.spatial3d.geom.LinearDistance
  Constructor.
linearDistanceSquared(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Compute the square of a straight-line distance to a point described by the vector taken from the origin.
linearDistanceSquared(PlanetModel, double, double, double, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Compute linear distance squared from plane to a vector.
linearDistanceSquared(PlanetModel, GeoPoint, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Compute linear distance squared from plane to a vector.
linearDistanceSquared(Vector) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Compute the square of a straight-line distance to a point described by the vector taken from the origin.
LinearSquaredDistance - Class in org.apache.lucene.spatial3d.geom
  Linear squared distance computation style.
LinearSquaredDistance() - Constructor for class org.apache.lucene.spatial3d.geom.LinearSquaredDistance
  Constructor.
longitude - Variable in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  Longitude of the vertical line
longitude - Variable in class org.apache.lucene.spatial3d.geom.GeoPoint
  Lazily-evaluated longitude.

## M

magnitude - Variable in class org.apache.lucene.spatial3d.geom.GeoPoint
  This is the lazily-evaluated magnitude.
magnitude() - Method in class org.apache.lucene.spatial3d.geom.GeoPoint
  Compute the linear magnitude of the point.
magnitude() - Method in class org.apache.lucene.spatial3d.geom.Vector
  Compute the magnitude of this vector.
magnitude(double, double, double) - Static method in class org.apache.lucene.spatial3d.geom.Vector
  Compute a magnitude of an x,y,z value.
makeExactGeoCircle(PlanetModel, double, double, double, double) - Static method in class org.apache.lucene.spatial3d.geom.GeoCircleFactory
  Create an GeoCircle from a center, a radius and a desired accuracy.
makeGeoArea(PlanetModel, double, double, double, double) - Static method in class org.apache.lucene.spatial3d.geom.GeoAreaFactory
  Create a GeoArea of the right kind given the specified bounds.
makeGeoArea(PlanetModel, double, double, double, double, double, double) - Static method in class org.apache.lucene.spatial3d.geom.GeoAreaFactory
  Create a GeoArea of the right kind given (x,y,z) bounds.
makeGeoBBox(PlanetModel, double, double, double, double) - Static method in class org.apache.lucene.spatial3d.geom.GeoBBoxFactory
  Create a geobbox of the right kind given the specified bounds.
makeGeoBBox(PlanetModel, LatLonBounds) - Static method in class org.apache.lucene.spatial3d.geom.GeoBBoxFactory
  Create a geobbox of the right kind given the specified `LatLonBounds`.
makeGeoCircle(PlanetModel, double, double, double) - Static method in class org.apache.lucene.spatial3d.geom.GeoCircleFactory
  Create a GeoCircle from a center and a cutoff angle.
makeGeoConcavePolygon(PlanetModel, List<GeoPoint>) - Static method in class org.apache.lucene.spatial3d.geom.GeoPolygonFactory
  Create a GeoConcavePolygon using the specified points.
makeGeoConcavePolygon(PlanetModel, List<GeoPoint>, List<GeoPolygon>) - Static method in class org.apache.lucene.spatial3d.geom.GeoPolygonFactory
  Create a GeoConcavePolygon using the specified points and holes.
makeGeoConvexPolygon(PlanetModel, List<GeoPoint>) - Static method in class org.apache.lucene.spatial3d.geom.GeoPolygonFactory
  Create a GeoConvexPolygon using the specified points.
makeGeoConvexPolygon(PlanetModel, List<GeoPoint>, List<GeoPolygon>) - Static method in class org.apache.lucene.spatial3d.geom.GeoPolygonFactory
  Create a GeoConvexPolygon using the specified points and holes.
makeGeoPath(PlanetModel, double, GeoPoint[]) - Static method in class org.apache.lucene.spatial3d.geom.GeoPathFactory
  Create a GeoPath of the right kind given the specified information.
makeGeoPointShape(PlanetModel, double, double) - Static method in class org.apache.lucene.spatial3d.geom.GeoPointShapeFactory
  Create a GeoPointShape with the provided information.
makeGeoPolygon(PlanetModel, List<GeoPoint>) - Static method in class org.apache.lucene.spatial3d.geom.GeoPolygonFactory
  Create a GeoPolygon using the specified points and holes, using order to determine siding of the polygon.
makeGeoPolygon(PlanetModel, List<GeoPoint>, List<GeoPolygon>) - Static method in class org.apache.lucene.spatial3d.geom.GeoPolygonFactory
  Create a GeoPolygon using the specified points and holes, using order to determine siding of the polygon.
makeGeoPolygon(PlanetModel, List<GeoPoint>, List<GeoPolygon>, double) - Static method in class org.apache.lucene.spatial3d.geom.GeoPolygonFactory
  Create a GeoPolygon using the specified points and holes, using order to determine siding of the polygon.
makeGeoPolygon(PlanetModel, GeoPolygonFactory.PolygonDescription) - Static method in class org.apache.lucene.spatial3d.geom.GeoPolygonFactory
  Create a GeoPolygon using the specified points and holes, using order to determine siding of the polygon.
makeGeoPolygon(PlanetModel, GeoPolygonFactory.PolygonDescription, double) - Static method in class org.apache.lucene.spatial3d.geom.GeoPolygonFactory
  Create a GeoPolygon using the specified points and holes, using order to determine siding of the polygon.
makeGeoS2Shape(PlanetModel, GeoPoint, GeoPoint, GeoPoint, GeoPoint) - Static method in class org.apache.lucene.spatial3d.geom.GeoS2ShapeFactory
  Creates a convex polygon with 4 planes by providing 4 points in CCW.
makeLargeGeoPolygon(PlanetModel, List<GeoPolygonFactory.PolygonDescription>) - Static method in class org.apache.lucene.spatial3d.geom.GeoPolygonFactory
  Create a large GeoPolygon.
makeXYZSolid(PlanetModel, double, double, double, double, double, double) - Static method in class org.apache.lucene.spatial3d.geom.XYZSolidFactory
  Create a XYZSolid of the right kind given (x,y,z) bounds.
makeXYZSolid(PlanetModel, XYZBounds) - Static method in class org.apache.lucene.spatial3d.geom.XYZSolidFactory
  Create a XYZSolid of the right kind given (x,y,z) bounds.
MAX_ENCODED_VALUE - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  Max encoded value
MAX_VALUE - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  maximum magnitude value for *this* planet model
MAX_X_POLE - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  Max X pole
MAX_Y_POLE - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  Max Y pole
meanRadius - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  The mean radius of the planet
Membership - Interface in org.apache.lucene.spatial3d.geom
  Implemented by Geo3D shapes that can calculate if a point is within it or not.
MIN_ENCODED_VALUE - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  Min encoded value
MIN_X_POLE - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  Min X pole
MIN_Y_POLE - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  Min Y pole
MINIMUM_ANGULAR_RESOLUTION - Static variable in class org.apache.lucene.spatial3d.geom.Vector
  Angular version of minimum resolution.
MINIMUM_RESOLUTION - Static variable in class org.apache.lucene.spatial3d.geom.Vector
  Values that are all considered to be essentially zero have a magnitude less than this.
MINIMUM_RESOLUTION_CUBED - Static variable in class org.apache.lucene.spatial3d.geom.Vector
  For cubed quantities, cube the bound.
MINIMUM_RESOLUTION_SQUARED - Static variable in class org.apache.lucene.spatial3d.geom.Vector
  For squared quantities, the bound is squared too.
minimumPoleDistance - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  Minimum surface distance between poles
modify(GeoPoint, double, double, double, double, double, double, double) - Static method in class org.apache.lucene.spatial3d.geom.Plane
  Modify a point to produce a vector in translated/rotated space.

## N

newBoxQuery(String, PlanetModel, double, double, double, double) - Static method in class org.apache.lucene.spatial3d.Geo3DPoint
  Create a query for matching a box.
newDistanceQuery(String, PlanetModel, double, double, double) - Static method in class org.apache.lucene.spatial3d.Geo3DPoint
  Create a query for matching points within the specified distance of the supplied location.
newDistanceSort(String, double, double, double, PlanetModel) - Static method in class org.apache.lucene.spatial3d.Geo3DDocValuesField
  Creates a SortField for sorting by distance within a circle.
newLargePolygonQuery(String, PlanetModel, Polygon...) - Static method in class org.apache.lucene.spatial3d.Geo3DPoint
  Create a query for matching a large polygon.
newOutsideBoxSort(String, double, double, double, double, PlanetModel) - Static method in class org.apache.lucene.spatial3d.Geo3DDocValuesField
  Creates a SortField for sorting by outside distance from a box.
newOutsideDistanceSort(String, double, double, double, PlanetModel) - Static method in class org.apache.lucene.spatial3d.Geo3DDocValuesField
  Creates a SortField for sorting by outside distance from a circle.
newOutsideLargePolygonSort(String, PlanetModel, Polygon...) - Static method in class org.apache.lucene.spatial3d.Geo3DDocValuesField
  Creates a SortField for sorting by outside distance from a large polygon.
newOutsidePathSort(String, double[], double[], double, PlanetModel) - Static method in class org.apache.lucene.spatial3d.Geo3DDocValuesField
  Creates a SortField for sorting by outside distance from a path.
newOutsidePolygonSort(String, PlanetModel, Polygon...) - Static method in class org.apache.lucene.spatial3d.Geo3DDocValuesField
  Creates a SortField for sorting by outside distance from a polygon.
newPathQuery(String, double[], double[], double, PlanetModel) - Static method in class org.apache.lucene.spatial3d.Geo3DPoint
  Create a query for matching a path.
newPathSort(String, double[], double[], double, PlanetModel) - Static method in class org.apache.lucene.spatial3d.Geo3DDocValuesField
  Creates a SortField for sorting by distance along a path.
newPolygonQuery(String, PlanetModel, Polygon...) - Static method in class org.apache.lucene.spatial3d.Geo3DPoint
  Create a query for matching a polygon.
newShapeQuery(String, GeoShape) - Static method in class org.apache.lucene.spatial3d.Geo3DPoint
  Returns a query matching all points inside the provided shape.
NO_BOUNDS - Static variable in class org.apache.lucene.spatial3d.geom.Plane
  An array with no bounds in it
NO_POINTS - Static variable in class org.apache.lucene.spatial3d.geom.Plane
  An array with no points in it
noBottomLatitudeBound() - Method in interface org.apache.lucene.spatial3d.geom.Bounds
  Signal that there is no bottom latitude bound.
noBottomLatitudeBound() - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
noBottomLatitudeBound() - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
noBound(PlanetModel) - Method in interface org.apache.lucene.spatial3d.geom.Bounds
  Signal that there is no bound whatsoever.
noBound(PlanetModel) - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
noBound(PlanetModel) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
noLongitudeBound() - Method in interface org.apache.lucene.spatial3d.geom.Bounds
  Signal that there is no longitude bound.
noLongitudeBound() - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
noLongitudeBound() - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
NONE_INSIDE - Static variable in class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
  No edgepoints inside shape
NONE_INSIDE - Static variable in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  No edgepoints inside shape
NONE_INSIDE - Static variable in class org.apache.lucene.spatial3d.geom.GeoCompositeAreaShape
  No edgepoints inside shape
NONE_INSIDE - Static variable in class org.apache.lucene.spatial3d.geom.GeoCompositePolygon
  No edgepoints inside shape
NORMAL - Static variable in interface org.apache.lucene.spatial3d.geom.DistanceStyle
  Normal distance calculator
NORMAL_SQUARED - Static variable in interface org.apache.lucene.spatial3d.geom.DistanceStyle
  Normal distance squared calculator
normalDistance(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Compute the normal (perpendicular) distance to a vector described by a vector taken from the origin.
normalDistance(double, double, double, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Compute normal distance from plane to a vector.
normalDistance(Vector) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Compute the normal (perpendicular) distance to a vector described by a vector taken from the origin.
normalDistance(Vector, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Compute normal distance from plane to a vector.
NormalDistance - Class in org.apache.lucene.spatial3d.geom
  Normal distance computation style.
NormalDistance() - Constructor for class org.apache.lucene.spatial3d.geom.NormalDistance
  Constructor.
normalDistanceSquared(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Compute the square of the normal distance to a vector described by a vector taken from the origin.
normalDistanceSquared(double, double, double, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Compute normal distance squared from plane to a vector.
normalDistanceSquared(Vector) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Compute the square of the normal distance to a vector described by a vector taken from the origin.
normalDistanceSquared(Vector, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Compute normal distance squared from plane to a vector.
normalize() - Method in class org.apache.lucene.spatial3d.geom.Plane
  Build a normalized plane, so that the vector is normalized.
normalize() - Method in class org.apache.lucene.spatial3d.geom.Vector
  Compute a normalized unit vector based on the current vector.
NormalSquaredDistance - Class in org.apache.lucene.spatial3d.geom
  Normal squared distance computation style.
NormalSquaredDistance() - Constructor for class org.apache.lucene.spatial3d.geom.NormalSquaredDistance
  Constructor.
normalXPlane - Static variable in class org.apache.lucene.spatial3d.geom.Plane
  A vertical plane normal to the X axis
normalYPlane - Static variable in class org.apache.lucene.spatial3d.geom.Plane
  A vertical plane normal to the Y axis
normalZPlane - Static variable in class org.apache.lucene.spatial3d.geom.Plane
  A vertical plane normal to the Z axis
NORTH_POLE - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  North pole
noTopLatitudeBound() - Method in interface org.apache.lucene.spatial3d.geom.Bounds
  Signal that there is no top latitude bound.
noTopLatitudeBound() - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
noTopLatitudeBound() - Method in class org.apache.lucene.spatial3d.geom.XYZBounds

## O

org.apache.lucene.spatial3d - package org.apache.lucene.spatial3d
  Lucene field & query support for the spatial geometry implemented in `org.apache.lucene.spatial3d.geom`.
org.apache.lucene.spatial3d.geom - package org.apache.lucene.spatial3d.geom
  Shapes implemented using 3D planar geometry.
outsideDistance(DistanceStyle, double, double, double) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseMembershipShape
  Called by a `computeOutsideDistance` method if X/Y/Z is not within this shape.
outsideDistance(DistanceStyle, double, double, double) - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
overlaps(XYZBounds) - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
  Check if another XYZBounds object overlaps this one.
OVERLAPS - Static variable in interface org.apache.lucene.spatial3d.geom.GeoArea
  The referenced shape OVERLAPS this area

## P

plane - Variable in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  The vertical line plane
Plane - Class in org.apache.lucene.spatial3d.geom
  We know about three kinds of planes.
Plane(double, double) - Constructor for class org.apache.lucene.spatial3d.geom.Plane
  Construct a vertical plane through a specified x, y and origin.
Plane(double, double, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.Plane
  Construct a plane with all four coefficients defined.
Plane(Plane, boolean) - Constructor for class org.apache.lucene.spatial3d.geom.Plane
  Construct a plane that is parallel to the one provided, but which is just barely numerically distinguishable from it, in the direction desired.
Plane(PlanetModel, double) - Constructor for class org.apache.lucene.spatial3d.geom.Plane
  Construct a horizontal plane at a specified Z.
Plane(Vector, double) - Constructor for class org.apache.lucene.spatial3d.geom.Plane
  Construct a plane with a specific vector, and D offset from origin.
Plane(Vector, double, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.Plane
  Construct a plane through two points and origin.
Plane(Vector, Vector) - Constructor for class org.apache.lucene.spatial3d.geom.Plane
  Construct a plane through two points and origin.
planePoints - Variable in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  Notable points for the line (end points)
planetModel - Variable in class org.apache.lucene.spatial3d.Geo3DPoint
  Planet Model for this Geo3DPoint
planetModel - Variable in class org.apache.lucene.spatial3d.geom.BasePlanetObject
  This is the planet model embedded in all objects derived from this class.
PlanetModel - Class in org.apache.lucene.spatial3d.geom
  Holds mathematical constants associated with the model of a planet.
PlanetModel(double, double) - Constructor for class org.apache.lucene.spatial3d.geom.PlanetModel
  * Construct a Planet Model from the semi major axis, semi minor axis=.
PlanetModel(InputStream) - Constructor for class org.apache.lucene.spatial3d.geom.PlanetModel
  Deserialization constructor.
PlanetModel.DocValueEncoder - Class in org.apache.lucene.spatial3d.geom
  Utility class for encoding / decoding from lat/lon (decimal degrees) into sortable doc value numerics (integers)
PlanetObject - Interface in org.apache.lucene.spatial3d.geom
  Relates all Geo3d shape with a specific `PlanetModel`.
pointOnSurface(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Check if point is on surface.
pointOnSurface(Vector) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Check if point is on surface.
pointOutside(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Check if point is outside surface.
pointOutside(Vector) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Check if point is outside surface.
points - Variable in class org.apache.lucene.spatial3d.geom.GeoPolygonFactory.PolygonDescription
  The list of points
PolygonDescription(List<? extends GeoPoint>) - Constructor for class org.apache.lucene.spatial3d.geom.GeoPolygonFactory.PolygonDescription
  Instantiate the polygon description.
PolygonDescription(List<? extends GeoPoint>, List<? extends GeoPolygonFactory.PolygonDescription>) - Constructor for class org.apache.lucene.spatial3d.geom.GeoPolygonFactory.PolygonDescription
  Instantiate the polygon description.

## R

readBitSet(InputStream) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Read a bitset from a stream.
readBoolean(InputStream) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Read a boolean from a stream.
readByteArray(InputStream) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Read byte array.
readDouble(InputStream) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Read a double from a stream.
readHeterogeneousArray(PlanetModel, InputStream, Class<T>) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Read an array.
readHomogeneousArray(PlanetModel, InputStream, Class<T>) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Read an array.
readInt(InputStream) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Read an int from a stream.
readLong(InputStream) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Read a long from a stream.
readObject(InputStream) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Read an object from a stream (for objects that do not need a PlanetModel).
readObject(InputStream, Class<? extends SerializableObject>) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Instantiate a serializable object from a stream without a planet model.
readObject(PlanetModel, InputStream) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Read an object from a stream (for objects that need a PlanetModel).
readObject(PlanetModel, InputStream, Class<? extends SerializableObject>) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Instantiate a serializable object from a stream.
readPlanetObject(InputStream) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Read a PlanetObject from a stream.
readPointArray(PlanetModel, InputStream) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Read a point array.
readPolygonArray(PlanetModel, InputStream) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Read a polygon array.
readString(InputStream) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Read a string from a stream.
recordBounds(PlanetModel, LatLonBounds, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Accumulate bounds information for this plane, intersected with the unit sphere.
recordBounds(PlanetModel, LatLonBounds, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Accumulate bounds information for this plane, intersected with another plane and the world.
recordBounds(PlanetModel, XYZBounds, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Accumulate (x,y,z) bounds information for this plane, intersected with the unit sphere.
recordBounds(PlanetModel, XYZBounds, Plane, Membership...) - Method in class org.apache.lucene.spatial3d.geom.Plane
  Accumulate (x,y,z) bounds information for this plane, intersected with another and the world.
reverseModify(PlanetModel, Vector, double, double, double, double, double, double, double) - Static method in class org.apache.lucene.spatial3d.geom.Plane
  Reverse modify a point to produce a GeoPoint in normal space.
rotateXY(double) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Rotate vector counter-clockwise in x-y by an angle.
rotateXY(double, double) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Rotate vector counter-clockwise in x-y by an angle, expressed as sin and cos.
rotateXZ(double) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Rotate vector counter-clockwise in x-z by an angle.
rotateXZ(double, double) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Rotate vector counter-clockwise in x-z by an angle, expressed as sin and cos.
rotateZY(double) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Rotate vector counter-clockwise in z-y by an angle.
rotateZY(double, double) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Rotate vector counter-clockwise in z-y by an angle, expressed as sin and cos.
roundDownX(double) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel.DocValueEncoder
  Round the provided X value down, by encoding it, decrementing it, and unencoding it.
roundDownY(double) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel.DocValueEncoder
  Round the provided Y value down, by encoding it, decrementing it, and unencoding it.
roundDownZ(double) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel.DocValueEncoder
  Round the provided Z value down, by encoding it, decrementing it, and unencoding it.
roundUpX(double) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel.DocValueEncoder
  Round the provided X value up, by encoding it, incrementing it, and unencoding it.
roundUpY(double) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel.DocValueEncoder
  Round the provided Y value up, by encoding it, incrementing it, and unencoding it.
roundUpZ(double) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel.DocValueEncoder
  Round the provided Z value up, by encoding it, incrementing it, and unencoding it.

## S

safeAcos(double) - Static method in class org.apache.lucene.spatial3d.geom.Tools
  Java acos yields a NAN if you take an arc-cos of an angle that's just a tiny bit greater than 1.0, so here's a more resilient version.
scale - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  The scale of the planet
scaledFlattening - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  The scaled flattening value
SerializableObject - Interface in org.apache.lucene.spatial3d.geom
  Indicates that a geo3d object can be serialized and deserialized.
setLocationValue(double, double, double) - Method in class org.apache.lucene.spatial3d.Geo3DDocValuesField
  Change the values of this field
setLocationValue(GeoPoint) - Method in class org.apache.lucene.spatial3d.Geo3DDocValuesField
  Change the values of this field
shapes - Variable in class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape
  Shape's container
SidedPlane - Class in org.apache.lucene.spatial3d.geom
  Combination of a plane, and a sign value indicating what evaluation values are on the correct side of the plane.
SidedPlane(double, double, double, Vector, double) - Constructor for class org.apache.lucene.spatial3d.geom.SidedPlane
  Construct a sided plane with a normal vector and offset.
SidedPlane(double, double, double, Vector, Vector) - Constructor for class org.apache.lucene.spatial3d.geom.SidedPlane
  Construct a sided plane from a pair of vectors describing points, and including origin, plus a point p which describes the side.
SidedPlane(SidedPlane) - Constructor for class org.apache.lucene.spatial3d.geom.SidedPlane
  Construct a SidedPlane identical to an existing one, but reversed.
SidedPlane(Vector, boolean, Vector, Vector) - Constructor for class org.apache.lucene.spatial3d.geom.SidedPlane
  Construct a sided plane from a pair of vectors describing points, and including origin, plus a point p which describes the side.
SidedPlane(Vector, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.SidedPlane
  Construct a sided vertical plane from a point and specified x and y coordinates.
SidedPlane(Vector, double, double, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.SidedPlane
  Construct a sided plane with a normal vector and offset.
SidedPlane(Vector, PlanetModel, double) - Constructor for class org.apache.lucene.spatial3d.geom.SidedPlane
  Construct a sided plane from a point and a Z coordinate.
SidedPlane(Vector, Vector) - Constructor for class org.apache.lucene.spatial3d.geom.SidedPlane
  Construct a sided plane from a pair of vectors describing points, and including origin.
SidedPlane(Vector, Vector, double) - Constructor for class org.apache.lucene.spatial3d.geom.SidedPlane
  Construct a sided plane with a normal vector and offset.
SidedPlane(Vector, Vector, double, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.SidedPlane
  Construct a sided plane from a pair of vectors describing points, and including origin, plus a point p which describes the side.
SidedPlane(Vector, Vector, Vector) - Constructor for class org.apache.lucene.spatial3d.geom.SidedPlane
  Construct a sided plane from a pair of vectors describing points, and including origin, plus a point p which describes the side.
sigNum - Variable in class org.apache.lucene.spatial3d.geom.SidedPlane
  The sign value for evaluation of a point on the correct side of the plane
size() - Method in class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape
  Get the number of shapes in the composite
SOME_INSIDE - Static variable in class org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
  Some edgepoints inside shape
SOME_INSIDE - Static variable in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  Some edgepoints inside shape
SOME_INSIDE - Static variable in class org.apache.lucene.spatial3d.geom.GeoCompositeAreaShape
  Some edgepoints inside shape
SOME_INSIDE - Static variable in class org.apache.lucene.spatial3d.geom.GeoCompositePolygon
  Some edgepoints inside shape
SOUTH_POLE - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  South pole
SPHERE - Static variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  Planet model corresponding to sphere.
squareRatio - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  The square ratio
strictlyWithin(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.SidedPlane
  Check whether a point is strictly within a plane.
strictlyWithin(Vector) - Method in class org.apache.lucene.spatial3d.geom.SidedPlane
  Check whether a point is strictly within a plane.
surfaceDistance(GeoPoint, GeoPoint) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Compute surface distance between two points.
surfacePointOnBearing(GeoPoint, double, double) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
  Compute new point given original point, a bearing direction, and an adjusted angle (as would be computed by the surfaceDistance() method above).

## T

The Spatial3D Module for Apache Lucene - Search tag in Overview
  Section
toAggregationForm(double) - Method in interface org.apache.lucene.spatial3d.geom.DistanceStyle
  Convert a distance to a form meant for aggregation.
toAggregationForm(double) - Method in class org.apache.lucene.spatial3d.geom.LinearSquaredDistance
toAggregationForm(double) - Method in class org.apache.lucene.spatial3d.geom.NormalSquaredDistance
Tools - Class in org.apache.lucene.spatial3d.geom
  Static methods globally useful for 3d geometric work.
topLat - Variable in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  Top latitude of the vertical line
topPlane - Variable in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  Top end cutoff plane
toString() - Method in class org.apache.lucene.spatial3d.Geo3DDocValuesField
toString() - Method in class org.apache.lucene.spatial3d.Geo3DPoint
toString() - Method in class org.apache.lucene.spatial3d.geom.GeoCompositeAreaShape
toString() - Method in class org.apache.lucene.spatial3d.geom.GeoCompositeMembershipShape
toString() - Method in class org.apache.lucene.spatial3d.geom.GeoCompositePolygon
toString() - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
toString() - Method in class org.apache.lucene.spatial3d.geom.GeoPoint
toString() - Method in class org.apache.lucene.spatial3d.geom.LatLonBounds
toString() - Method in class org.apache.lucene.spatial3d.geom.Plane
toString() - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
toString() - Method in class org.apache.lucene.spatial3d.geom.SidedPlane
toString() - Method in class org.apache.lucene.spatial3d.geom.Vector
toString() - Method in class org.apache.lucene.spatial3d.geom.XYZBounds
translate(double, double, double) - Method in class org.apache.lucene.spatial3d.geom.Vector
  Translate vector.
TYPE - Static variable in class org.apache.lucene.spatial3d.Geo3DDocValuesField
  Type for a Geo3DDocValuesField
TYPE - Static variable in class org.apache.lucene.spatial3d.Geo3DPoint
  Indexing `FieldType`.

## U

UHC - Variable in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
  Point at the upper end of the vertical line

## V

Vector - Class in org.apache.lucene.spatial3d.geom
  A 3d vector in space, not necessarily going through the origin.
Vector(double, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.Vector
  Construct from (U.S.) x,y,z coordinates.
Vector(double, double, double, double, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.Vector
  Construct a vector that is perpendicular to two other (non-zero) vectors.
Vector(Vector, double, double, double) - Constructor for class org.apache.lucene.spatial3d.geom.Vector
  Construct a vector that is perpendicular to two other (non-zero) vectors.
Vector(Vector, Vector) - Constructor for class org.apache.lucene.spatial3d.geom.Vector
  Construct a vector that is perpendicular to two other (non-zero) vectors.

## W

WGS84 - Static variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  Planet model corresponding to WGS84 ellipsoid
WITHIN - Static variable in interface org.apache.lucene.spatial3d.geom.GeoArea
  The referenced shape IS WITHIN this area
write(OutputStream) - Method in class org.apache.lucene.spatial3d.geom.BasePlanetObject
write(OutputStream) - Method in class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape
write(OutputStream) - Method in class org.apache.lucene.spatial3d.geom.GeoDegenerateVerticalLine
write(OutputStream) - Method in class org.apache.lucene.spatial3d.geom.GeoPoint
write(OutputStream) - Method in class org.apache.lucene.spatial3d.geom.PlanetModel
write(OutputStream) - Method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Serialize to output stream.
writeBitSet(OutputStream, BitSet) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write a bitset to a stream.
writeBoolean(OutputStream, boolean) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write a boolean to a stream.
writeByteArray(OutputStream, byte[]) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write byte array.
writeClass(OutputStream, Class<? extends SerializableObject>) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write a class to a stream.
writeDouble(OutputStream, double) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write a double to a stream.
writeHeterogeneousArray(OutputStream, List<? extends SerializableObject>) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write an array.
writeHeterogeneousArray(OutputStream, SerializableObject[]) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write an array.
writeHomogeneousArray(OutputStream, List<? extends SerializableObject>) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write an array.
writeHomogeneousArray(OutputStream, SerializableObject[]) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write an array.
writeInt(OutputStream, int) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write an int to a stream.
writeLong(OutputStream, long) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write a long to a stream.
writeObject(OutputStream, SerializableObject) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write an object to a stream.
writePlanetObject(OutputStream, PlanetObject) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write a PlanetObject to a stream.
writePointArray(OutputStream, List<GeoPoint>) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write a point array.
writePointArray(OutputStream, GeoPoint[]) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write a point array.
writePolygonArray(OutputStream, List<GeoPolygon>) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write a polygon array.
writePolygonArray(OutputStream, GeoPolygon[]) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write a polgon array.
writeString(OutputStream, String) - Static method in interface org.apache.lucene.spatial3d.geom.SerializableObject
  Write a string to a stream.

## X

x - Variable in class org.apache.lucene.spatial3d.geom.Vector
  The x value
xyScaling - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  The x/y scaling factor
XYZBounds - Class in org.apache.lucene.spatial3d.geom
  An object for accumulating XYZ bounds information.
XYZBounds() - Constructor for class org.apache.lucene.spatial3d.geom.XYZBounds
  Construct an empty bounds object
XYZSolid - Interface in org.apache.lucene.spatial3d.geom
  Interface for a family of 3D rectangles, bounded on six sides by X,Y,Z limits
XYZSolidFactory - Class in org.apache.lucene.spatial3d.geom
  Factory for `XYZSolid`.

## Y

y - Variable in class org.apache.lucene.spatial3d.geom.Vector
  The y value

## Z

z - Variable in class org.apache.lucene.spatial3d.geom.Vector
  The z value
zScaling - Variable in class org.apache.lucene.spatial3d.geom.PlanetModel
  The z scaling factor

A B C D E F G H I L M N O P R S T U V W X Y Z
All Classes and Interfaces|All Packages|Constant Field Values