org.apache.lucene.geo3d

## Class GeoBaseBBox

- java.lang.Object
- - org.apache.lucene.geo3d.BasePlanetObject
  - - org.apache.lucene.geo3d.GeoBaseShape
    - - org.apache.lucene.geo3d.GeoBaseMembershipShape
      - - org.apache.lucene.geo3d.GeoBaseBBox

- All Implemented Interfaces:
    GeoArea, GeoBBox, GeoMembershipShape, GeoOutsideDistance, GeoShape, GeoSizeable, Membership
  Direct Known Subclasses:
    GeoDegenerateHorizontalLine, GeoDegenerateLatitudeZone, GeoDegenerateLongitudeSlice, GeoDegenerateVerticalLine, GeoLatitudeZone, GeoLongitudeSlice, GeoNorthLatitudeZone, GeoNorthRectangle, GeoRectangle, GeoSouthLatitudeZone, GeoSouthRectangle, GeoWideDegenerateHorizontalLine, GeoWideLongitudeSlice, GeoWideNorthRectangle, GeoWideRectangle, GeoWideSouthRectangle, GeoWorld

      public abstract class GeoBaseBBox
      extends GeoBaseMembershipShape
      implements GeoBBox

  All bounding box shapes can derive from this base class, which furnishes some common code
  NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected static int` | `ALL_INSIDE` All edgepoints inside shape
    `protected static int` | `NONE_INSIDE` No edgepoints inside shape
    `protected static int` | `SOME_INSIDE` Some edgepoints inside shape

    - ### Fields inherited from class org.apache.lucene.geo3d.BasePlanetObject

      `planetModel`

    - ### Fields inherited from interface org.apache.lucene.geo3d.GeoArea

      `CONTAINS, DISJOINT, OVERLAPS, WITHIN`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `GeoBaseBBox(PlanetModel planetModel)` Construct, given planet model.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected int` | `isShapeInsideBBox(GeoShape path)` Determine the relationship between this BBox and the provided shape's edgepoints.

    - ### Methods inherited from class org.apache.lucene.geo3d.GeoBaseMembershipShape

      `computeOutsideDistance, computeOutsideDistance, isWithin, outsideDistance`

    - ### Methods inherited from class org.apache.lucene.geo3d.GeoBaseShape

      `getBounds`

    - ### Methods inherited from class org.apache.lucene.geo3d.BasePlanetObject

      `equals, hashCode`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface org.apache.lucene.geo3d.GeoBBox

      `expand`

    - ### Methods inherited from interface org.apache.lucene.geo3d.GeoShape

      `getBounds, getEdgePoints, intersects`

    - ### Methods inherited from interface org.apache.lucene.geo3d.GeoOutsideDistance

      `computeOutsideDistance, computeOutsideDistance`

    - ### Methods inherited from interface org.apache.lucene.geo3d.Membership

      `isWithin, isWithin`

    - ### Methods inherited from interface org.apache.lucene.geo3d.GeoSizeable

      `getCenter, getRadius`

    - ### Methods inherited from interface org.apache.lucene.geo3d.GeoArea

      `getRelationship`

- - ### Field Detail

    - #### ALL_INSIDE

          protected static final int ALL_INSIDE

      All edgepoints inside shape
      See Also:
        Constant Field Values

    - #### SOME_INSIDE

          protected static final int SOME_INSIDE

      Some edgepoints inside shape
      See Also:
        Constant Field Values

    - #### NONE_INSIDE

          protected static final int NONE_INSIDE

      No edgepoints inside shape
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### GeoBaseBBox

          public GeoBaseBBox(PlanetModel planetModel)

      Construct, given planet model.
      Parameters:
        `planetModel` - is the planet model.

  - ### Method Detail

    - #### isShapeInsideBBox

          protected int isShapeInsideBBox(GeoShape path)

      Determine the relationship between this BBox and the provided shape's edgepoints.
      Parameters:
        `path` - is the shape.
      Returns:
        the relationship.

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