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
3D rectangle, bounded on six sides by X,Y,Z limits, degenerate in Z
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final GeoPoint[]
These are the edge points of the shape, which are defined to be at least one point on each surface area boundary.protected final double
Max-Xprotected final SidedPlane
Max-X planeprotected final double
Max-Yprotected final SidedPlane
Max-Y planeprotected final double
Min-Xprotected final SidedPlane
Min-X planeprotected final double
Min-Yprotected final SidedPlane
Min-Y planeprotected final GeoPoint[]
Notable points for ZPlaneprotected final double
Zprotected final Plane
Z planeFields inherited from class org.apache.lucene.spatial3d.geom.BaseXYZSolid
ALL_INSIDE, EMPTY_POINTS, NO_EDGEPOINTS, NONE_INSIDE, SOME_INSIDE, xUnitVector, xVerticalPlane, yUnitVector, yVerticalPlane, zUnitVector
Fields inherited from class org.apache.lucene.spatial3d.geom.BasePlanetObject
planetModel
-
Constructor Summary
ConstructorsConstructorDescriptionXYdZSolid
(PlanetModel planetModel, double minX, double maxX, double minY, double maxY, double Z) Sole constructorXYdZSolid
(PlanetModel planetModel, InputStream inputStream) Constructor for deserialization. -
Method Summary
Modifier and TypeMethodDescriptionboolean
protected GeoPoint[]
Get the edge points for this shape.int
getRelationship
(GeoShape path) Find the spatial relationship between a shape and the current geo area.int
hashCode()
boolean
isWithin
(double x, double y, double z) Check if a point is within this shape.toString()
void
write
(OutputStream outputStream) Serialize to output stream.Methods inherited from class org.apache.lucene.spatial3d.geom.BaseXYZSolid
glueTogether, isAreaInsideShape, isShapeInsideArea, isWithin
Methods inherited from class org.apache.lucene.spatial3d.geom.BasePlanetObject
getPlanetModel
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.lucene.spatial3d.geom.PlanetObject
getPlanetModel
-
Field Details
-
minX
protected final double minXMin-X -
maxX
protected final double maxXMax-X -
minY
protected final double minYMin-Y -
maxY
protected final double maxYMax-Y -
Z
protected final double ZZ -
minXPlane
Min-X plane -
maxXPlane
Max-X plane -
minYPlane
Min-Y plane -
maxYPlane
Max-Y plane -
zPlane
Z plane -
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
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
Constructor for deserialization.- Parameters:
planetModel
- is the planet model.inputStream
- is the input stream.- Throws:
IOException
-
-
Method Details
-
write
Description copied from interface:SerializableObject
Serialize to output stream.- Specified by:
write
in interfaceSerializableObject
- Overrides:
write
in classBasePlanetObject
- Parameters:
outputStream
- is the output stream to write to.- Throws:
IOException
-
getEdgePoints
Description copied from class:BaseXYZSolid
Get the edge points for this shape.- Specified by:
getEdgePoints
in classBaseXYZSolid
- 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 interfaceMembership
- Specified by:
isWithin
in classBaseXYZSolid
- 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
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
- Overrides:
equals
in classBaseXYZSolid
-
hashCode
public int hashCode()- Overrides:
hashCode
in classBaseXYZSolid
-
toString
-