org.apache.lucene.spatial3d.geom.GeoWideLongitudeSlice Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lucene-spatial3d Show documentation
Show all versions of lucene-spatial3d Show documentation
Apache Lucene (module: spatial3d)
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.lucene.spatial3d.geom;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
/**
* Bounding box wider than PI but limited on left and right sides ( left lon, right lon).
*
* @lucene.internal
*/
class GeoWideLongitudeSlice extends GeoBaseBBox {
/** The left longitude */
protected final double leftLon;
/** The right longitude */
protected final double rightLon;
/** The left plane */
protected final SidedPlane leftPlane;
/** The right plane */
protected final SidedPlane rightPlane;
/** Notable points for the shape */
protected final GeoPoint[] planePoints;
/** Center point for the shape */
protected final GeoPoint centerPoint;
/** A point on the edge of the shape */
protected final GeoPoint[] edgePoints;
/**
* Accepts only values in the following ranges: lon: {@code -PI -> PI}. Horizantal angle must be
* greater than or equal to PI.
*
* @param planetModel is the planet model.
* @param leftLon is the left longitude.
* @param rightLon is the right longitude.
*/
public GeoWideLongitudeSlice(
final PlanetModel planetModel, final double leftLon, double rightLon) {
super(planetModel);
// Argument checking
if (leftLon < -Math.PI || leftLon > Math.PI) {
throw new IllegalArgumentException("Left longitude out of range");
}
if (rightLon < -Math.PI || rightLon > Math.PI) {
throw new IllegalArgumentException("Right longitude out of range");
}
double extent = rightLon - leftLon;
if (extent < 0.0) {
extent += 2.0 * Math.PI;
}
if (extent < GeoWideRectangle.MIN_WIDE_EXTENT) {
throw new IllegalArgumentException("Width of rectangle too small");
}
this.leftLon = leftLon;
this.rightLon = rightLon;
final double sinLeftLon = Math.sin(leftLon);
final double cosLeftLon = Math.cos(leftLon);
final double sinRightLon = Math.sin(rightLon);
final double cosRightLon = Math.cos(rightLon);
// Normalize
while (leftLon > rightLon) {
rightLon += Math.PI * 2.0;
}
double middleLon = (leftLon + rightLon) * 0.5;
while (middleLon > Math.PI) {
middleLon -= Math.PI * 2.0;
}
while (middleLon < -Math.PI) {
middleLon += Math.PI * 2.0;
}
this.centerPoint = new GeoPoint(planetModel, 0.0, middleLon);
this.leftPlane = new SidedPlane(centerPoint, cosLeftLon, sinLeftLon);
this.rightPlane = new SidedPlane(centerPoint, cosRightLon, sinRightLon);
this.planePoints = new GeoPoint[] {planetModel.NORTH_POLE, planetModel.SOUTH_POLE};
this.edgePoints = new GeoPoint[] {planetModel.NORTH_POLE};
}
/**
* Constructor for deserialization.
*
* @param planetModel is the planet model.
* @param inputStream is the input stream.
*/
public GeoWideLongitudeSlice(final PlanetModel planetModel, final InputStream inputStream)
throws IOException {
this(
planetModel,
SerializableObject.readDouble(inputStream),
SerializableObject.readDouble(inputStream));
}
@Override
public void write(final OutputStream outputStream) throws IOException {
SerializableObject.writeDouble(outputStream, leftLon);
SerializableObject.writeDouble(outputStream, rightLon);
}
@Override
public GeoBBox expand(final double angle) {
// Figuring out when we escalate to a special case requires some prefiguring
double currentLonSpan = rightLon - leftLon;
if (currentLonSpan < 0.0) {
currentLonSpan += Math.PI * 2.0;
}
double newLeftLon = leftLon - angle;
double newRightLon = rightLon + angle;
if (currentLonSpan + 2.0 * angle >= Math.PI * 2.0) {
newLeftLon = -Math.PI;
newRightLon = Math.PI;
}
return GeoBBoxFactory.makeGeoBBox(
planetModel, Math.PI * 0.5, -Math.PI * 0.5, newLeftLon, newRightLon);
}
@Override
public boolean isWithin(final double x, final double y, final double z) {
return leftPlane.isWithin(x, y, z) || rightPlane.isWithin(x, y, z);
}
@Override
public double getRadius() {
// Compute the extent and divide by two
double extent = rightLon - leftLon;
if (extent < 0.0) {
extent += Math.PI * 2.0;
}
return Math.max(Math.PI * 0.5, extent * 0.5);
}
@Override
public GeoPoint getCenter() {
return centerPoint;
}
@Override
public GeoPoint[] getEdgePoints() {
return edgePoints;
}
@Override
public boolean intersects(
final Plane p, final GeoPoint[] notablePoints, final Membership... bounds) {
// Right and left bounds are essentially independent hemispheres; crossing into the wrong part
// of one requires crossing into the right part of the other. So intersection can ignore the
// left/right bounds.
return p.intersects(planetModel, leftPlane, notablePoints, planePoints, bounds)
|| p.intersects(planetModel, rightPlane, notablePoints, planePoints, bounds);
}
@Override
public boolean intersects(final GeoShape geoShape) {
// Right and left bounds are essentially independent hemispheres; crossing into the wrong part
// of one requires crossing into the right part of the other. So intersection can ignore the
// left/right bounds.
return geoShape.intersects(leftPlane, planePoints)
|| geoShape.intersects(rightPlane, planePoints);
}
@Override
public void getBounds(Bounds bounds) {
super.getBounds(bounds);
bounds
.isWide()
.addVerticalPlane(planetModel, leftLon, leftPlane)
.addVerticalPlane(planetModel, rightLon, rightPlane)
.addIntersection(planetModel, leftPlane, rightPlane)
.addPoint(planetModel.NORTH_POLE)
.addPoint(planetModel.SOUTH_POLE);
}
@Override
protected double outsideDistance(
final DistanceStyle distanceStyle, final double x, final double y, final double z) {
// Because the rectangle exceeds 180 degrees, it is safe to compute the horizontally
// unbounded distance to both the left and the right and only take the minimum of the two.
final double leftDistance = distanceStyle.computeDistance(planetModel, leftPlane, x, y, z);
final double rightDistance = distanceStyle.computeDistance(planetModel, rightPlane, x, y, z);
final double northDistance = distanceStyle.computeDistance(planetModel.NORTH_POLE, x, y, z);
final double southDistance = distanceStyle.computeDistance(planetModel.SOUTH_POLE, x, y, z);
return Math.min(Math.min(leftDistance, rightDistance), Math.min(northDistance, southDistance));
}
@Override
public boolean equals(Object o) {
if (!(o instanceof GeoWideLongitudeSlice)) {
return false;
}
GeoWideLongitudeSlice other = (GeoWideLongitudeSlice) o;
return super.equals(other) && other.leftLon == leftLon && other.rightLon == rightLon;
}
@Override
public int hashCode() {
int result = super.hashCode();
long temp = Double.doubleToLongBits(leftLon);
result = 31 * result + (int) (temp ^ (temp >>> 32));
temp = Double.doubleToLongBits(rightLon);
result = 31 * result + (int) (temp ^ (temp >>> 32));
return result;
}
@Override
public String toString() {
return "GeoWideLongitudeSlice: {planetmodel="
+ planetModel
+ ", leftlon="
+ leftLon
+ "("
+ leftLon * 180.0 / Math.PI
+ "), rightlon="
+ rightLon
+ "("
+ rightLon * 180.0 / Math.PI
+ ")}";
}
}