## Uses of Class
org.apache.lucene.geo3d.PlanetModel

- Packages that use PlanetModel
  Package | Description
  --- | ---
  org.apache.lucene.bkdtree3d | Fast "indexed point inside geo3d shape" query implementation.
  org.apache.lucene.geo3d | Shapes implemented using 3D planar geometry.

- - ### Uses of PlanetModel in org.apache.lucene.bkdtree3d

    Constructors in org.apache.lucene.bkdtree3d with parameters of type PlanetModel
    Constructor and Description
    `Geo3DDocValuesFormat(PlanetModel planetModel, int maxPointsInLeafNode, int maxPointsSortInHeap)` Deprecated. Creates this with custom configuration.
    `Geo3DPointField(String name, PlanetModel planetModel, double lat, double lon)` Deprecated. Creates a new Geo3DPointField field with the specified lat, lon (in radians), given a planet model.
    `Geo3DPointField(String name, PlanetModel planetModel, double x, double y, double z)` Deprecated. Creates a new Geo3DPointField field with the specified x,y,z.
    `PointInGeo3DShapeQuery(PlanetModel planetModel, String field, GeoShape shape)` Deprecated. The lats/lons must be clockwise or counter-clockwise.

  - ### Uses of PlanetModel in org.apache.lucene.geo3d

    Fields in org.apache.lucene.geo3d declared as PlanetModel
    Modifier and Type | Field and Description
    --- | ---
    `protected PlanetModel` | BasePlanetObject.`planetModel` This is the planet model embedded in all objects derived from this class.
    `protected PlanetModel` | GeoDegeneratePoint.`planetModel` Current planet model, since we don't extend BasePlanetObject
    `static PlanetModel` | PlanetModel.`SPHERE` Planet model corresponding to sphere.
    `static PlanetModel` | PlanetModel.`WGS84` Planet model corresponding to WGS84

    Methods in org.apache.lucene.geo3d with parameters of type PlanetModel
    Modifier and Type | Method and Description
    --- | ---
    `Bounds` | LatLonBounds.`addHorizontalPlane(PlanetModel planetModel, double latitude, Plane horizontalPlane, Membership... bounds)`
    `Bounds` | Bounds.`addHorizontalPlane(PlanetModel planetModel, double latitude, Plane horizontalPlane, Membership... bounds)` Add a horizontal plane to the bounds description.
    `Bounds` | XYZBounds.`addHorizontalPlane(PlanetModel planetModel, double latitude, Plane horizontalPlane, Membership... bounds)` Add a horizontal plane to the bounds description.
    `Bounds` | LatLonBounds.`addPlane(PlanetModel planetModel, Plane plane, Membership... bounds)`
    `Bounds` | Bounds.`addPlane(PlanetModel planetModel, Plane plane, Membership... bounds)` Add a general plane to the bounds description.
    `Bounds` | XYZBounds.`addPlane(PlanetModel planetModel, Plane plane, Membership... bounds)`
    `Bounds` | LatLonBounds.`addVerticalPlane(PlanetModel planetModel, double longitude, Plane verticalPlane, Membership... bounds)`
    `Bounds` | Bounds.`addVerticalPlane(PlanetModel planetModel, double longitude, Plane verticalPlane, Membership... bounds)` Add a vertical plane to the bounds description.
    `Bounds` | XYZBounds.`addVerticalPlane(PlanetModel planetModel, double longitude, Plane verticalPlane, Membership... bounds)` Add a vertical plane to the bounds description.
    `double` | Plane.`arcDistance(PlanetModel planetModel, double x, double y, double z, Membership... bounds)` Compute arc distance from plane to a vector.
    `double` | Plane.`arcDistance(PlanetModel planetModel, GeoPoint v, Membership... bounds)` Compute arc distance from plane to a vector expressed with a `GeoPoint`.
    `static GeoPolygon` | GeoPolygonFactory.`buildPolygonShape(PlanetModel planetModel, List<GeoPoint> pointsList, int startPointIndex, int endPointIndex, SidedPlane startingEdge, boolean isInternalEdge)` Build a GeoMembershipShape given points, starting edge, and whether starting edge is internal or not.
    `protected static double` | Vector.`computeDesiredEllipsoidMagnitude(PlanetModel planetModel, double z)` Compute the desired magnitude of a unit vector projected to a given planet model.
    `protected static double` | Vector.`computeDesiredEllipsoidMagnitude(PlanetModel planetModel, double x, double y, double z)` Compute the desired magnitude of a unit vector projected to a given planet model.
    `double` | LinearSquaredDistance.`computeDistance(PlanetModel planetModel, Plane plane, double x, double y, double z, Membership... bounds)`
    `double` | DistanceStyle.`computeDistance(PlanetModel planetModel, Plane plane, double x, double y, double z, Membership... bounds)` Compute the distance from a plane to a point.
    `double` | NormalDistance.`computeDistance(PlanetModel planetModel, Plane plane, double x, double y, double z, Membership... bounds)`
    `double` | NormalSquaredDistance.`computeDistance(PlanetModel planetModel, Plane plane, double x, double y, double z, Membership... bounds)`
    `double` | LinearDistance.`computeDistance(PlanetModel planetModel, Plane plane, double x, double y, double z, Membership... bounds)`
    `double` | ArcDistance.`computeDistance(PlanetModel planetModel, Plane plane, double x, double y, double z, Membership... bounds)`
    `double` | LinearSquaredDistance.`computeDistance(PlanetModel planetModel, Plane plane, GeoPoint point, Membership... bounds)`
    `double` | DistanceStyle.`computeDistance(PlanetModel planetModel, Plane plane, GeoPoint point, Membership... bounds)` Compute the distance from a plane to a point.
    `double` | NormalDistance.`computeDistance(PlanetModel planetModel, Plane plane, GeoPoint point, Membership... bounds)`
    `double` | NormalSquaredDistance.`computeDistance(PlanetModel planetModel, Plane plane, GeoPoint point, Membership... bounds)`
    `double` | LinearDistance.`computeDistance(PlanetModel planetModel, Plane plane, GeoPoint point, Membership... bounds)`
    `double` | ArcDistance.`computeDistance(PlanetModel planetModel, Plane plane, GeoPoint point, Membership... bounds)`
    `GeoPoint[]` | Plane.`findIntersections(PlanetModel planetModel, Plane q, Membership... bounds)` Public version of findIntersections.
    `protected GeoPoint[]` | Plane.`findIntersections(PlanetModel planetModel, Plane q, Membership[] bounds, Membership[] moreBounds)` Find the intersection points between two planes, given a set of bounds.
    `void` | GeoPath.SegmentEndpoint.`getBounds(PlanetModel planetModel, Bounds bounds)` Get the bounds for a segment endpoint.
    `void` | GeoPath.PathSegment.`getBounds(PlanetModel planetModel, Bounds bounds)` Get the bounds for a segment endpoint.
    `GeoPoint` | Plane.`getSampleIntersectionPoint(PlanetModel planetModel, Plane q)` Find a sample point on the intersection between two planes and the world.
    `boolean` | Plane.`intersects(PlanetModel planetModel, Plane q, GeoPoint[] notablePoints, GeoPoint[] moreNotablePoints, Membership[] bounds, Membership... moreBounds)` Determine whether the plane intersects another plane within the bounds provided.
    `boolean` | GeoPath.SegmentEndpoint.`intersects(PlanetModel planetModel, Plane p, GeoPoint[] notablePoints, Membership[] bounds)` Determine if this endpoint intersects a specified plane.
    `boolean` | GeoPath.PathSegment.`intersects(PlanetModel planetModel, Plane p, GeoPoint[] notablePoints, Membership[] bounds)` Determine if this endpoint intersects a specified plane.
    `boolean` | XYZBounds.`isLargestMaxX(PlanetModel planetModel)` Return true if maxX is as large as the planet model allows.
    `boolean` | XYZBounds.`isLargestMaxY(PlanetModel planetModel)` Return true if maxY is as large as the planet model allows.
    `boolean` | XYZBounds.`isLargestMaxZ(PlanetModel planetModel)` Return true if maxZ is as large as the planet model allows.
    `boolean` | XYZBounds.`isSmallestMinX(PlanetModel planetModel)` Return true if minX is as small as the planet model allows.
    `boolean` | XYZBounds.`isSmallestMinY(PlanetModel planetModel)` Return true if minY is as small as the planet model allows.
    `boolean` | XYZBounds.`isSmallestMinZ(PlanetModel planetModel)` Return true if minZ is as small as the planet model allows.
    `double` | Plane.`linearDistance(PlanetModel planetModel, double x, double y, double z, Membership... bounds)` Compute linear distance from plane to a vector.
    `double` | Plane.`linearDistance(PlanetModel planetModel, GeoPoint v, Membership... bounds)` Compute linear distance from plane to a vector.
    `double` | Plane.`linearDistanceSquared(PlanetModel planetModel, double x, double y, double z, Membership... bounds)` Compute linear distance squared from plane to a vector.
    `double` | Plane.`linearDistanceSquared(PlanetModel planetModel, GeoPoint v, Membership... bounds)` Compute linear distance squared from plane to a vector.
    `static GeoArea` | GeoAreaFactory.`makeGeoArea(PlanetModel planetModel, double topLat, double bottomLat, double leftLon, double rightLon)` Create a GeoArea of the right kind given the specified bounds.
    `static GeoArea` | GeoAreaFactory.`makeGeoArea(PlanetModel planetModel, double minX, double maxX, double minY, double maxY, double minZ, double maxZ)` Create a GeoArea of the right kind given (x,y,z) bounds.
    `static GeoBBox` | GeoBBoxFactory.`makeGeoBBox(PlanetModel planetModel, double topLat, double bottomLat, double leftLon, double rightLon)` Create a geobbox of the right kind given the specified bounds.
    `static GeoCircle` | GeoCircleFactory.`makeGeoCircle(PlanetModel planetModel, double latitude, double longitude, double radius)` Create a GeoCircle of the right kind given the specified bounds.
    `static GeoPolygon` | GeoPolygonFactory.`makeGeoPolygon(PlanetModel planetModel, List<GeoPoint> pointList, int convexPointIndex)` Create a GeoMembershipShape of the right kind given the specified bounds.
    `static XYZSolid` | XYZSolidFactory.`makeXYZSolid(PlanetModel planetModel, double minX, double maxX, double minY, double maxY, double minZ, double maxZ)` Create a XYZSolid of the right kind given (x,y,z) bounds.
    `double` | GeoPath.PathSegment.`outsideDistance(PlanetModel planetModel, DistanceStyle distanceStyle, double x, double y, double z)` Compute external distance.
    `double` | GeoPath.PathSegment.`pathDistance(PlanetModel planetModel, DistanceStyle distanceStyle, double x, double y, double z)` Compute interior path distance.
    `void` | Plane.`recordBounds(PlanetModel planetModel, LatLonBounds boundsInfo, Membership... bounds)` Accumulate bounds information for this plane, intersected with the unit sphere.
    `void` | Plane.`recordBounds(PlanetModel planetModel, XYZBounds boundsInfo, Membership... bounds)` Accumulate (x,y,z) bounds information for this plane, intersected with the unit sphere.

    Constructors in org.apache.lucene.geo3d with parameters of type PlanetModel
    Constructor and Description
    `BasePlanetObject(PlanetModel planetModel)` Constructor creating class instance given a planet model.
    `BaseXYZSolid(PlanetModel planetModel)` Base solid constructor.
    `dXdYdZSolid(PlanetModel planetModel, double X, double Y, double Z)` Sole constructor
    `dXdYZSolid(PlanetModel planetModel, double X, double Y, double minZ, double maxZ)` Sole constructor
    `dXYdZSolid(PlanetModel planetModel, double X, double minY, double maxY, double Z)` Sole constructor
    `dXYZSolid(PlanetModel planetModel, double X, double minY, double maxY, double minZ, double maxZ)` Sole constructor
    `GeoBaseBBox(PlanetModel planetModel)` Construct, given planet model.
    `GeoBaseCircle(PlanetModel planetModel)` Constructor.
    `GeoBaseDistanceShape(PlanetModel planetModel)` Constructor.
    `GeoBaseMembershipShape(PlanetModel planetModel)` Constructor.
    `GeoBasePolygon(PlanetModel planetModel)` Constructor.
    `GeoBaseShape(PlanetModel planetModel)` Constructor.
    `GeoConvexPolygon(PlanetModel planetModel, double startLatitude, double startLongitude)` Create a convex polygon, with a starting latitude and longitude.
    `GeoConvexPolygon(PlanetModel planetModel, List<GeoPoint> pointList)` Create a convex polygon from a list of points.
    `GeoConvexPolygon(PlanetModel planetModel, List<GeoPoint> pointList, BitSet internalEdgeFlags, boolean returnEdgeInternal)` Create a convex polygon from a list of points, keeping track of which boundaries are internal.
    `GeoDegenerateHorizontalLine(PlanetModel planetModel, double latitude, double leftLon, double rightLon)` Accepts only values in the following ranges: lat: `-PI/2 -> PI/2`, lon: `-PI -> PI`
    `GeoDegenerateLatitudeZone(PlanetModel planetModel, double latitude)` Constructor.
    `GeoDegenerateLongitudeSlice(PlanetModel planetModel, double longitude)` Accepts only values in the following ranges: lon: `-PI -> PI`
    `GeoDegeneratePoint(PlanetModel planetModel, double lat, double lon)` Constructor.
    `GeoDegenerateVerticalLine(PlanetModel planetModel, double topLat, double bottomLat, double longitude)` Accepts only values in the following ranges: lat: `-PI/2 -> PI/2`, longitude: `-PI -> PI`
    `GeoLatitudeZone(PlanetModel planetModel, double topLat, double bottomLat)` Constructor.
    `GeoLongitudeSlice(PlanetModel planetModel, double leftLon, double rightLon)` Accepts only values in the following ranges: lon: `-PI -> PI`
    `GeoNorthLatitudeZone(PlanetModel planetModel, double bottomLat)` Constructor.
    `GeoNorthRectangle(PlanetModel planetModel, double bottomLat, double leftLon, double rightLon)` Accepts only values in the following ranges: lat: `-PI/2 -> PI/2`, lon: `-PI -> PI`
    `GeoPath.PathSegment(PlanetModel planetModel, GeoPoint start, GeoPoint end, Plane normalizedConnectingPlane, double planeBoundingOffset)` Construct a path segment.
    `GeoPath(PlanetModel planetModel, double maxCutoffAngle)` Piece-wise constructor.
    `GeoPath(PlanetModel planetModel, double maxCutoffAngle, GeoPoint[] pathPoints)` Constructor.
    `GeoPoint(PlanetModel planetModel, double lat, double lon)` Construct a GeoPoint from a latitude/longitude pair.
    `GeoPoint(PlanetModel planetModel, double sinLat, double sinLon, double cosLat, double cosLon)` Construct a GeoPoint from the trig functions of a lat and lon pair.
    `GeoPoint(PlanetModel planetModel, double sinLat, double sinLon, double cosLat, double cosLon, double lat, double lon)` Construct a GeoPoint from the trig functions of a lat and lon pair.
    `GeoRectangle(PlanetModel planetModel, double topLat, double bottomLat, double leftLon, double rightLon)` Accepts only values in the following ranges: lat: `-PI/2 -> PI/2`, lon: `-PI -> PI`
    `GeoSouthLatitudeZone(PlanetModel planetModel, double topLat)` Constructor.
    `GeoSouthRectangle(PlanetModel planetModel, double topLat, double leftLon, double rightLon)` Accepts only values in the following ranges: lat: `-PI/2 -> PI/2`, lon: `-PI -> PI`
    `GeoStandardCircle(PlanetModel planetModel, double lat, double lon, double cutoffAngle)` Constructor.
    `GeoWideDegenerateHorizontalLine(PlanetModel planetModel, double latitude, double leftLon, double rightLon)` Accepts only values in the following ranges: lat: `-PI/2 -> PI/2`, lon: `-PI -> PI`.
    `GeoWideLongitudeSlice(PlanetModel planetModel, double leftLon, double rightLon)` Accepts only values in the following ranges: lon: `-PI -> PI`.
    `GeoWideNorthRectangle(PlanetModel planetModel, double bottomLat, double leftLon, double rightLon)` Accepts only values in the following ranges: lat: `-PI/2 -> PI/2`, lon: `-PI -> PI`.
    `GeoWideRectangle(PlanetModel planetModel, double topLat, double bottomLat, double leftLon, double rightLon)` Accepts only values in the following ranges: lat: `-PI/2 -> PI/2`, lon: `-PI -> PI`.
    `GeoWideSouthRectangle(PlanetModel planetModel, double topLat, double leftLon, double rightLon)` Accepts only values in the following ranges: lat: `-PI/2 -> PI/2`, lon: `-PI -> PI`.
    `GeoWorld(PlanetModel planetModel)` Constructor.
    `Plane(PlanetModel planetModel, double sinLat)` Construct a horizontal plane at a specified Z.
    `SidedPlane(Vector p, PlanetModel planetModel, double sinLat)` Construct a sided plane from a point and a Z coordinate.
    `StandardXYZSolid(PlanetModel planetModel, double minX, double maxX, double minY, double maxY, double minZ, double maxZ)` Sole constructor
    `XdYdZSolid(PlanetModel planetModel, double minX, double maxX, double Y, double Z)` Sole constructor
    `XdYZSolid(PlanetModel planetModel, double minX, double maxX, double Y, double minZ, double maxZ)` Sole constructor
    `XYdZSolid(PlanetModel planetModel, double minX, double maxX, double minY, double maxY, double Z)` Sole constructor

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