Package org.apache.lucene.spatial3d.geom
Class GeoBaseCompositeShape<T extends GeoShape>
java.lang.Object
org.apache.lucene.spatial3d.geom.BasePlanetObject
org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape<T>
- Type Parameters:
T- is the type of GeoShapes of the composite.
- All Implemented Interfaces:
Bounded,GeoBounds,GeoShape,Membership,PlanetObject,SerializableObject
- Direct Known Subclasses:
GeoCompositeAreaShape,GeoCompositeMembershipShape,GeoCompositePolygon
public abstract class GeoBaseCompositeShape<T extends GeoShape>
extends BasePlanetObject
implements GeoShape
Base class to create a composite of GeoShapes.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Field Summary
FieldsFields inherited from class org.apache.lucene.spatial3d.geom.BasePlanetObject
planetModel -
Constructor Summary
ConstructorsConstructorDescriptionGeoBaseCompositeShape(PlanetModel planetModel) Constructor.GeoBaseCompositeShape(PlanetModel planetModel, InputStream inputStream, Class<T> clazz) Constructor for deserialization. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd a shape to the composite.booleanvoidCompute bounds for the shape.GeoPoint[]Return a sample point that is on the outside edge/boundary of the shape.getShape(int index) Get shape at indexReturns an unmodifiable list of composed shapes.inthashCode()booleanintersects(Plane p, GeoPoint[] notablePoints, Membership... bounds) Assess whether a plane, within the provided bounds, intersects with the shape's edges.booleanisWithin(double x, double y, double z) Check if a point is within this shape.booleanCheck if a point is within this shape.intsize()Get the number of shapes in the compositevoidwrite(OutputStream outputStream) Serialize to output stream.Methods inherited from class org.apache.lucene.spatial3d.geom.BasePlanetObject
getPlanetModelMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.lucene.spatial3d.geom.PlanetObject
getPlanetModel
-
Field Details
-
shapes
Shape's container
-
-
Constructor Details
-
GeoBaseCompositeShape
Constructor. -
GeoBaseCompositeShape
public GeoBaseCompositeShape(PlanetModel planetModel, InputStream inputStream, Class<T> clazz) throws IOException Constructor for deserialization.- Parameters:
planetModel- is the planet model.inputStream- is the input stream.clazz- is the class of the generic.- Throws:
IOException
-
-
Method Details
-
addShape
Add a shape to the composite.- Parameters:
shape- is the shape to add.
-
size
public int size()Get the number of shapes in the composite- Returns:
- the number of shapes
-
getShape
Get shape at index- Returns:
- the shape at given index
-
write
Description copied from interface:SerializableObjectSerialize to output stream.- Specified by:
writein interfaceSerializableObject- Overrides:
writein classBasePlanetObject- Parameters:
outputStream- is the output stream to write to.- Throws:
IOException
-
isWithin
Description copied from interface:MembershipCheck if a point is within this shape.- Specified by:
isWithinin interfaceMembership- Parameters:
point- is the point to check.- Returns:
- true if the point is within this shape
-
isWithin
public boolean isWithin(double x, double y, double z) Description copied from interface:MembershipCheck if a point is within this shape.- Specified by:
isWithinin interfaceMembership- 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
-
getEdgePoints
Description copied from interface:GeoShapeReturn a sample point that is on the outside edge/boundary of the shape.- Specified by:
getEdgePointsin interfaceGeoShape- Returns:
- samples of all edge points from distinct edge sections. Typically one point is returned, but zero or two are also possible.
-
intersects
Description copied from interface:GeoShapeAssess whether a plane, within the provided bounds, intersects with the shape's edges. Any overlap, even a single point, is considered to be an intersection. Note well that this method is allowed to return "true" if there are internal edges of a composite shape which intersect the plane. Doing this can cause getRelationship() for most GeoBBox shapes to return OVERLAPS rather than the more correct CONTAINS, but that cannot be helped for some complex shapes that are built out of overlapping parts.- Specified by:
intersectsin interfaceGeoShape- Parameters:
p- is the plane to assess for intersection with the shape's edges or bounding curves.notablePoints- represents the intersections of the plane with the supplied bounds. These are used to disambiguate when two planes are identical and it needs to be determined whether any points exist that fulfill all the bounds.bounds- are a set of bounds that define an area that an intersection must be within in order to qualify (provided by a GeoArea).- Returns:
- true if there's such an intersection, false if not.
-
getBounds
Description copied from interface:BoundedCompute bounds for the shape. -
hashCode
public int hashCode()- Overrides:
hashCodein classBasePlanetObject
-
equals
- Overrides:
equalsin classBasePlanetObject
-
getShapes
Returns an unmodifiable list of composed shapes.
-