Module org.apache.lucene.spatial3d
Package org.apache.lucene.spatial3d.geom

Class XYdZSolid

java.lang.Object
org.apache.lucene.spatial3d.geom.BasePlanetObject
org.apache.lucene.spatial3d.geom.BaseXYZSolid
org.apache.lucene.spatial3d.geom.XYdZSolid
All Implemented Interfaces:
GeoArea, Membership, PlanetObject, SerializableObject, XYZSolid
class XYdZSolid extends BaseXYZSolid
3D rectangle, bounded on six sides by X,Y,Z limits, degenerate in Z

  • Field Details

    • minX

      protected final double minX
      Min-X

    • maxX

      protected final double maxX
      Max-X

    • minY

      protected final double minY
      Min-Y

    • maxY

      protected final double maxY
      Max-Y

    • Z

      protected final double Z
      Z

    • minXPlane

      protected final SidedPlane minXPlane
      Min-X plane

    • maxXPlane

      protected final SidedPlane maxXPlane
      Max-X plane

    • minYPlane

      protected final SidedPlane minYPlane
      Min-Y plane

    • maxYPlane

      protected final SidedPlane maxYPlane
      Max-Y plane

    • zPlane

      protected final Plane zPlane
      Z plane

    • edgePoints

      protected final GeoPoint[] edgePoints
      These are the edge points of the shape, which are defined to be at least one point on each surface area boundary. In the case of a solid, this includes points which represent the intersection of XYZ bounding planes and the planet, as well as points representing the intersection of single bounding planes with the planet itself.

    • notableZPoints

      protected final GeoPoint[] notableZPoints
      Notable points for ZPlane

  • Constructor Details

    • XYdZSolid

      public XYdZSolid(PlanetModel planetModel, double minX, double maxX, double minY, double maxY, double Z)
      Sole constructor
      Parameters:
      planetModel - is the planet model.
      minX - is the minimum X value.
      maxX - is the maximum X value.
      minY - is the minimum Y value.
      maxY - is the maximum Y value.
      Z - is the Z value.

    • XYdZSolid

      public XYdZSolid(PlanetModel planetModel, InputStream inputStream) throws IOException
      Constructor for deserialization.
      Parameters:
      planetModel - is the planet model.
      inputStream - is the input stream.
      Throws:
      IOException

  • Method Details

    • write

      public void write(OutputStream outputStream) throws IOException
      Description copied from interface: SerializableObject
      Serialize to output stream.
      Specified by:
      write in interface SerializableObject
      Overrides:
      write in class BasePlanetObject
      Parameters:
      outputStream - is the output stream to write to.
      Throws:
      IOException

    • getEdgePoints

      protected GeoPoint[] getEdgePoints()
      Description copied from class: BaseXYZSolid
      Get the edge points for this shape.
      Specified by:
      getEdgePoints in class BaseXYZSolid
      Returns:
      the edge points.

    • isWithin

      public boolean isWithin(double x, double y, double z)
      Description copied from interface: Membership
      Check if a point is within this shape.
      Specified by:
      isWithin in interface Membership
      Specified by:
      isWithin in class BaseXYZSolid
      Parameters:
      x - is x coordinate of point to check.
      y - is y coordinate of point to check.
      z - is z coordinate of point to check.
      Returns:
      true if the point is within this shape

    • getRelationship

      public int getRelationship(GeoShape path)
      Description copied from interface: GeoArea
      Find the spatial relationship between a shape and the current geo area. Note: return value is how the GeoShape relates to the GeoArea, not the other way around. For example, if this GeoArea is entirely within the shape, then CONTAINS should be returned. If the shape is entirely enclosed by this GeoArea, then WITHIN should be returned.

      It is permissible to return OVERLAPS instead of WITHIN if the shape intersects with the area at even a single point. So, a circle inscribed in a rectangle could return either OVERLAPS or WITHIN, depending on implementation. It is not permissible to return CONTAINS or DISJOINT in this circumstance, however.

      Similarly, it is permissible to return OVERLAPS instead of CONTAINS under conditions where the shape consists of multiple independent overlapping subshapes, and the area overlaps one of the subshapes. It is not permissible to return WITHIN or DISJOINT in this circumstance, however.

      Parameters:
      path - is the shape to consider.
      Returns:
      the relationship, from the perspective of the shape.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class BaseXYZSolid

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class BaseXYZSolid

    • toString

      public String toString()
      Overrides:
      toString in class Object