# Package org.apache.lucene.geo3d

Shapes implemented using 3D planar geometry.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  Bounds | An interface for accumulating bounds information.
  DistanceStyle | Distance computation styles, supporting various ways of computing distance to shapes.
  GeoArea | A GeoArea represents a standard 2-D breakdown of a part of sphere.
  GeoBBox | All bounding box shapes have this interface in common.
  GeoCircle | Interface describing circular area with a center and radius.
  GeoDistance | 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 | Distance shapes have capabilities of both geohashing and distance computation (which also includes point membership determination).
  GeoMembershipShape | Membership shapes have capabilities of both geohashing and membership determination.
  GeoOutsideDistance | Implemented by Geo3D shapes that can compute the distance from a point to the closest outside edge.
  GeoPolygon | GeoPolygon interface description.
  GeoShape | Generic shape.
  GeoSizeable | Some shapes can compute radii of a geocircle in which they are inscribed.
  Membership | Implemented by Geo3D shapes that can calculate if a point is within it or not.
  XYZSolid | Interface for a family of 3D rectangles, bounded on six sides by X,Y,Z limits

- Class Summary
  Class | Description
  --- | ---
  ArcDistance | Arc distance computation style.
  BasePlanetObject | All Geo3D shapes can derive from this base class, which furnishes some common code
  BaseXYZSolid | Base class of a family of 3D rectangles, bounded on six sides by X,Y,Z limits
  dXdYdZSolid | 3D rectangle, bounded on six sides by X,Y,Z limits, degenerate in all dimensions
  dXdYZSolid | 3D rectangle, bounded on six sides by X,Y,Z limits, degenerate in X and Y.
  dXYdZSolid | 3D rectangle, bounded on six sides by X,Y,Z limits, degenerate in X and Z.
  dXYZSolid | 3D rectangle, bounded on six sides by X,Y,Z limits, degenerate in X.
  GeoAreaFactory | Factory for `GeoArea`.
  GeoBaseBBox | All bounding box shapes can derive from this base class, which furnishes some common code
  GeoBaseCircle | GeoCircles have all the characteristics of GeoBaseDistanceShapes, plus GeoSizeable.
  GeoBaseDistanceShape | Distance shapes have capabilities of both geohashing and distance computation (which also includes point membership determination).
  GeoBaseMembershipShape | Membership shapes have capabilities of both geohashing and membership determination.
  GeoBasePolygon | GeoBasePolygon objects are the base class of most GeoPolygon objects.
  GeoBaseShape | Base extended shape object.
  GeoBBoxFactory | Factory for `GeoBBox`.
  GeoCircleFactory | Class which constructs a GeoCircle representing an arbitrary circle.
  GeoCompositeMembershipShape | GeoComposite is a set of GeoMembershipShape's, treated as a unit.
  GeoCompositePolygon | GeoCompositePolygon is a specific implementation of GeoMembershipShape, which implements GeoPolygon explicitly.
  GeoConvexPolygon | GeoConvexPolygon objects are generic building blocks of more complex structures.
  GeoDegenerateHorizontalLine | Degenerate bounding box limited on two sides (left lon, right lon).
  GeoDegenerateLatitudeZone | This GeoBBox represents an area rectangle of one specific latitude with no longitude bounds.
  GeoDegenerateLongitudeSlice | Degenerate longitude slice.
  GeoDegeneratePoint | This class represents a degenerate point bounding box.
  GeoDegenerateVerticalLine | Degenerate bounding box limited on two sides (top lat, bottom lat).
  GeoLatitudeZone | This GeoBBox represents an area rectangle limited only in latitude.
  GeoLongitudeSlice | Bounding box limited on left and right.
  GeoNorthLatitudeZone | This GeoBBox represents an area rectangle limited only in south latitude.
  GeoNorthRectangle | Bounding box limited on three sides (bottom lat, left lon, right lon), including the north pole.
  GeoPath | GeoShape representing a path across the surface of the globe, with a specified half-width.
  GeoPath.PathSegment | This is the pre-calculated data for a path segment.
  GeoPath.SegmentEndpoint | This is precalculated data for segment endpoint.
  GeoPoint | This class represents a point on the surface of a sphere or ellipsoid.
  GeoPolygonFactory | Class which constructs a GeoMembershipShape representing an arbitrary polygon.
  GeoRectangle | Bounding box limited on four sides (top lat, bottom lat, left lon, right lon).
  GeoSouthLatitudeZone | This GeoBBox represents an area rectangle limited only in north latitude.
  GeoSouthRectangle | Bounding box limited on three sides (top lat, left lon, right lon).
  GeoStandardCircle | Circular area with a center and radius.
  GeoWideDegenerateHorizontalLine | Degenerate bounding box wider than PI and limited on two sides (left lon, right lon).
  GeoWideLongitudeSlice | Bounding box wider than PI but limited on left and right sides ( left lon, right lon).
  GeoWideNorthRectangle | Bounding box wider than PI but limited on three sides ( bottom lat, left lon, right lon).
  GeoWideRectangle | Bounding box wider than PI but limited on four sides (top lat, bottom lat, left lon, right lon).
  GeoWideSouthRectangle | Bounding box wider than PI but limited on three sides (top lat, left lon, right lon).
  GeoWorld | Bounding box including the entire world.
  LatLonBounds | An object for accumulating latitude/longitude bounds information.
  LinearDistance | Linear distance computation style.
  LinearSquaredDistance | Linear squared distance computation style.
  NormalDistance | Normal distance computation style.
  NormalSquaredDistance | Normal squared distance computation style.
  Plane | We know about three kinds of planes.
  PlanetModel | Holds mathematical constants associated with the model of a planet.
  SidedPlane | Combination of a plane, and a sign value indicating what evaluation values are on the correct side of the plane.
  StandardXYZSolid | 3D rectangle, bounded on six sides by X,Y,Z limits
  Tools | Static methods globally useful for 3d geometric work.
  Vector | A 3d vector in space, not necessarily going through the origin.
  XdYdZSolid | 3D rectangle, bounded on six sides by X,Y,Z limits, degenerate in Y and Z.
  XdYZSolid | 3D rectangle, bounded on six sides by X,Y,Z limits, degenerate in Y
  XYdZSolid | 3D rectangle, bounded on six sides by X,Y,Z limits, degenerate in Z
  XYZBounds | An object for accumulating XYZ bounds information.
  XYZSolidFactory | Factory for `XYZSolid`.

## Package org.apache.lucene.geo3d Description

Shapes implemented using 3D planar geometry.

Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.