Module org.apache.lucene.spatial3d
Package org.apache.lucene.spatial3d.geom
Shapes implemented using 3D planar geometry. This package has no dependencies aside from Java.
This code was contributed under the name "Geo3D".
-
Interface Summary Interface Description Bounded This interface describes methods that determine what the bounds are for a shape.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.GeoAreaShape Shape that implements GeoArea.GeoBBox All bounding box shapes have this interface in common.GeoBounds Generic shape that supports bounds.GeoCircle Interface describing circular area with a center and radius.GeoComplexPolygon.CountingEdgeIterator Iterator execution interface, for tree traversal, plus count retrieval.GeoComplexPolygon.EdgeIterator Iterator execution interface, for tree traversal.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.GeoPath Interface describing a path.GeoPointShape Interface describing a GeoPointShape shape.It may represents a degenerated bounding box or a degenerated circle, hence it extends such interfaces.GeoPolygon GeoPolygon interface description.GeoShape Generic shape.GeoSizeable Some shapes can compute radii of a geocircle in which they are inscribed.GeoStandardPath.PathComponent Path components consist of both path segments and segment endpoints.GeoStandardPath.SegmentEndpoint Internal interface describing segment endpoint implementations.Membership Implemented by Geo3D shapes that can calculate if a point is within it or not.PlanetObject Relates all Geo3d shape with a specificPlanetModel
.SerializableObject Indicates that a geo3d object can be serialized and deserialized.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 codeBaseXYZSolid Base class of a family of 3D rectangles, bounded on six sides by X,Y,Z limitsdXdYdZSolid 3D rectangle, bounded on six sides by X,Y,Z limits, degenerate in all dimensionsdXdYZSolid 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 forGeoArea
.GeoBaseAreaShape Base extended areaShape object.GeoBaseBBox All bounding box shapes can derive from this base class, which furnishes some common codeGeoBaseBounds Base object that supports bounds operations.GeoBaseCircle GeoCircles have all the characteristics of GeoBaseDistanceShapes, plus GeoSizeable.GeoBaseCompositeAreaShape<T extends GeoAreaShape> Base class to create a composite of GeoAreaShapesGeoBaseCompositeMembershipShape<T extends GeoMembershipShape> Base class to create a composite of GeoMembershipShapesGeoBaseCompositeShape<T extends GeoShape> Base class to create a composite of GeoShapes.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.GeoBasePath GeoPaths have all the characteristics of GeoBaseDistanceShapes.GeoBasePolygon GeoBasePolygon objects are the base class of most GeoPolygon objects.GeoBaseShape Base extended shape object.GeoBBoxFactory Factory forGeoBBox
.GeoCircleFactory Class which constructs a GeoCircle representing an arbitrary circle.GeoComplexPolygon GeoComplexPolygon objects are structures designed to handle very large numbers of edges.GeoComplexPolygon.Edge An instance of this class describes a single edge, and includes what is necessary to reliably determine intersection in the context of the even/odd algorithm used.GeoComplexPolygon.Node An instance of this class represents a node in a tree.GeoComplexPolygon.Tree An interface describing a tree.GeoComplexPolygon.XTree This is the x-tree.GeoComplexPolygon.YTree This is the y-tree.GeoComplexPolygon.ZTree This is the z-tree.GeoCompositeAreaShape GeoCompositeAreaShape is a set of GeoAreaShape's, treated as a unit.GeoCompositeMembershipShape GeoCompositeMembershipShape is a set of GeoMembershipShape's, treated as a unit.GeoCompositePolygon GeoCompositePolygon is a specific implementation of GeoCompositeAreaShape, which implements GeoPolygon explicitly.GeoConcavePolygon GeoConcavePolygon objects are generic building blocks of more complex structures.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.GeoDegeneratePath GeoShape representing a path across the surface of the globe, with a specified half-width.GeoDegeneratePath.PathSegment This is the pre-calculated data for a path segment.GeoDegeneratePath.SegmentEndpoint This is precalculated data for segment endpoint.GeoDegeneratePoint This class represents a degenerate point bounding box.GeoDegenerateVerticalLine Degenerate bounding box limited on two sides (top lat, bottom lat).GeoExactCircle Circular area with a center and a radius that represents the surface distance to the center.GeoExactCircle.ApproximationSlice A temporary description of a section of circle.GeoExactCircle.CircleSlice A description of a section of circle.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.GeoPathFactory Class which constructs a GeoPath representing an arbitrary path.GeoPoint This class represents a point on the surface of a sphere or ellipsoid.GeoPointShapeFactory Class which constructs a GeoPointShape.GeoPolygonFactory Class which constructs a GeoMembershipShape representing an arbitrary polygon.GeoPolygonFactory.BestShape Class for tracking the best shape for finding a pole, and whether or not the pole must be inside or outside of the shape.GeoPolygonFactory.Edge Class representing a single (unused) edge.GeoPolygonFactory.EdgeBuffer Class representing a pool of unused edges, all linked together by vertices.GeoPolygonFactory.EdgeBufferIterator Class representing an iterator over an EdgeBuffer.GeoPolygonFactory.MutableBoolean GeoPolygonFactory.PolygonDescription Use this class to specify a polygon with associated holes.GeoPolygonFactory.SafePath An instance of this class represents a known-good path of nodes that contains no coplanar points , no matter how assessed.GeoRectangle Bounding box limited on four sides (top lat, bottom lat, left lon, right lon).GeoS2Shape Fast implementation of a polygon representing S2 geometry cell.GeoS2ShapeFactory Class which constructs a GeoPolygon representing S2 google pixel.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 cutoff angle that represents the latitude and longitude distance from the center where the planet will be cut.GeoStandardPath GeoShape representing a path across the surface of the globe, with a specified half-width.GeoStandardPath.BaseSegmentEndpoint Base implementation of SegmentEndpointGeoStandardPath.CircleSegmentEndpoint Endpoint that's a simple circle.GeoStandardPath.CutoffDualCircleSegmentEndpoint Endpoint that's a dual circle with cutoff(s).GeoStandardPath.CutoffSingleCircleSegmentEndpoint Endpoint that's a single circle with cutoff(s).GeoStandardPath.DistancePair GeoStandardPath.PathNode GeoStandardPath.PathSegment This is the pre-calculated data for a path segment.GeoStandardPath.TreeBuilder 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.PlanetModel.DocValueEncoder Utility class for encoding / decoding from lat/lon (decimal degrees) into sortable doc value numerics (integers)SidedPlane Combination of a plane, and a sign value indicating what evaluation values are on the correct side of the plane.StandardObjects Lookup tables for classes that can be serialized using a code.StandardXYZSolid 3D rectangle, bounded on six sides by X,Y,Z limitsTools 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 YXYdZSolid 3D rectangle, bounded on six sides by X,Y,Z limits, degenerate in ZXYZBounds An object for accumulating XYZ bounds information.XYZSolidFactory Factory forXYZSolid
. -
Exception Summary Exception Description GeoPolygonFactory.TileException Exception we throw when we can't tile a polygon due to numerical precision issues.