org.apache.lucene.spatial.spatial4j.geo3d

Class SidedPlane

java.lang.Object

org.apache.lucene.spatial.spatial4j.geo3d.Vector

org.apache.lucene.spatial.spatial4j.geo3d.Plane

org.apache.lucene.spatial.spatial4j.geo3d.SidedPlane

All Implemented Interfaces:

Membership

public class SidedPlane
extends Plane
implements Membership

Combination of a plane, and a sign value indicating what evaluation values are on the correct side of the plane.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
double	sigNum

Fields inherited from class org.apache.lucene.spatial.spatial4j.geo3d.Plane

D, NO_BOUNDS, NO_POINTS

Fields inherited from class org.apache.lucene.spatial.spatial4j.geo3d.Vector

MINIMUM_RESOLUTION, MINIMUM_RESOLUTION_CUBED, MINIMUM_RESOLUTION_SQUARED, x, y, z

Constructor Summary

Constructors

Constructor and Description
SidedPlane(SidedPlane sidedPlane) Construct a SidedPlane identical to an existing one, but reversed.
SidedPlane(Vector p, double height) Construct a sided plane from a point and a Z coordinate.
SidedPlane(Vector p, double x, double y) Construct a sided vertical plane from a point and specified x and y coordinates.
SidedPlane(Vector p, Vector v, double D) Construct a sided plane with a normal vector and offset.
SidedPlane(Vector p, Vector A, Vector B) Construct a sided plane from a pair of vectors describing points, and including origin, plus a point p which describes the side.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isWithin(double x, double y, double z) Check if a point is within this shape.
boolean	isWithin(Vector point) Check if a point is within this shape.
String	toString()

Methods inherited from class org.apache.lucene.spatial.spatial4j.geo3d.Plane

addPoint, equals, evaluate, evaluate, evaluateIsZero, evaluateIsZero, findIntersections, getSampleIntersectionPoint, hashCode, interpolate, intersects, isNumericallyIdentical, meetsAllBounds, modify, normalize, recordBounds, recordBounds, reverseModify

Methods inherited from class org.apache.lucene.spatial.spatial4j.geo3d.Vector

dotProduct, dotProduct, isWithin, linearDistance, linearDistance, linearDistanceSquared, linearDistanceSquared, magnitude, normalDistance, normalDistance, normalDistanceSquared, normalDistanceSquared, rotateXY, rotateXY, rotateXZ, rotateXZ, rotateZY, rotateZY, translate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

sigNum

public final double sigNum

Constructor Detail

SidedPlane

public SidedPlane(SidedPlane sidedPlane)

Construct a SidedPlane identical to an existing one, but reversed.

Parameters:

sidedPlane - is the existing plane.

SidedPlane

public SidedPlane(Vector p,
          Vector A,
          Vector B)

Construct a sided plane from a pair of vectors describing points, and including origin, plus a point p which describes the side.

Parameters:

p - point to evaluate

A - is the first in-plane point

B - is the second in-plane point

SidedPlane

public SidedPlane(Vector p,
          double height)

Construct a sided plane from a point and a Z coordinate.

Parameters:

p - point to evaluate.

height - is the Z coordinate of the plane.

SidedPlane

public SidedPlane(Vector p,
          double x,
          double y)

Construct a sided vertical plane from a point and specified x and y coordinates.

Parameters:

p - point to evaluate.

x - is the specified x.

y - is the specified y.

SidedPlane

public SidedPlane(Vector p,
          Vector v,
          double D)

Construct a sided plane with a normal vector and offset.

Parameters:

p - point to evaluate.

v - is the normal vector.

D - is the origin offset for the plan.

Method Detail

isWithin

public boolean isWithin(Vector point)

Check if a point is within this shape.

Specified by:

isWithin in interface Membership

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)

Check if a point is within this shape.

Specified by:

isWithin in interface Membership

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

toString

public String toString()

Overrides:

toString in class Plane