# Uses of Class
org.apache.lucene.spatial3d.geom.Plane

Packages that use Plane
Package
Description
org.apache.lucene.spatial3d.geom
Shapes implemented using 3D planar geometry.

- ## Uses of Plane in org.apache.lucene.spatial3d.geom

  Subclasses of Plane in org.apache.lucene.spatial3d.geom
  Modifier and Type
  Class
  Description
  `class`
  `SidedPlane`
  Combination of a plane, and a sign value indicating what evaluation values are on the correct side of the plane.
  Fields in org.apache.lucene.spatial3d.geom declared as Plane
  Modifier and Type
  Field
  Description
  `static final Plane`
  Plane.`normalXPlane`
  A vertical plane normal to the X axis
  `static final Plane`
  Plane.`normalYPlane`
  A vertical plane normal to the Y axis
  `static final Plane`
  Plane.`normalZPlane`
  A vertical plane normal to the Z axis
  `protected final Plane`
  GeoDegenerateVerticalLine.`plane`
  The vertical line plane
  Methods in org.apache.lucene.spatial3d.geom that return Plane
  Modifier and Type
  Method
  Description
  `static Plane`
  Plane.`constructNormalizedXPlane(double y, double z, double DValue)`
  Construct a normalized plane through a y-z point and parallel to the X axis.
  `static Plane`
  Plane.`constructNormalizedXPlane(Vector... planePoints)`
  Construct the most accurate normalized plane through an y-z point and including the X axis.
  `static Plane`
  Plane.`constructNormalizedYPlane(double x, double z, double DValue)`
  Construct a normalized plane through an x-z point and parallel to the Y axis.
  `static Plane`
  Plane.`constructNormalizedYPlane(Vector... planePoints)`
  Construct the most accurate normalized plane through an x-z point and including the Y axis.
  `static Plane`
  Plane.`constructNormalizedZPlane(double x, double y)`
  Construct a normalized plane through an x-y point and including the Z axis.
  `static Plane`
  Plane.`constructNormalizedZPlane(Vector... planePoints)`
  Construct the most accurate normalized plane through an x-y point and including the Z axis.
  `static Plane`
  Plane.`constructPerpendicularCenterPlaneOnePoint(Plane plane, Vector M)`
  Given a plane and one point that is on that plane, find a perpendicular plane that goes through both the origin and the point.
  `static Plane`
  Plane.`constructPerpendicularCenterPlaneTwoPoints(Vector M, Vector N)`
  Given two points, construct a plane that goes through them and the origin.
  `Plane`
  Plane.`normalize()`
  Build a normalized plane, so that the vector is normalized.
  Methods in org.apache.lucene.spatial3d.geom with parameters of type Plane
  Modifier and Type
  Method
  Description
  `Bounds`
  Bounds.`addHorizontalPlane(PlanetModel planetModel, double latitude, Plane horizontalPlane, Membership... bounds)`
  Add a horizontal plane to the bounds description.
  `Bounds`
  LatLonBounds.`addHorizontalPlane(PlanetModel planetModel, double latitude, Plane horizontalPlane, Membership... bounds)`
  `Bounds`
  XYZBounds.`addHorizontalPlane(PlanetModel planetModel, double latitude, Plane horizontalPlane, Membership... bounds)`
  Add a horizontal plane to the bounds description.
  `Bounds`
  Bounds.`addIntersection(PlanetModel planetModel, Plane plane1, Plane plane2, Membership... bounds)`
  Add the intersection between two planes to the bounds description.
  `Bounds`
  LatLonBounds.`addIntersection(PlanetModel planetModel, Plane plane1, Plane plane2, Membership... bounds)`
  `Bounds`
  XYZBounds.`addIntersection(PlanetModel planetModel, Plane plane1, Plane plane2, Membership... bounds)`
  `Bounds`
  Bounds.`addPlane(PlanetModel planetModel, Plane plane, Membership... bounds)`
  Add a general plane to the bounds description.
  `Bounds`
  LatLonBounds.`addPlane(PlanetModel planetModel, Plane plane, Membership... bounds)`
  `Bounds`
  XYZBounds.`addPlane(PlanetModel planetModel, Plane plane, Membership... bounds)`
  `Bounds`
  Bounds.`addVerticalPlane(PlanetModel planetModel, double longitude, Plane verticalPlane, Membership... bounds)`
  Add a vertical plane to the bounds description.
  `Bounds`
  LatLonBounds.`addVerticalPlane(PlanetModel planetModel, double longitude, Plane verticalPlane, Membership... bounds)`
  `Bounds`
  XYZBounds.`addVerticalPlane(PlanetModel planetModel, double longitude, Plane verticalPlane, Membership... bounds)`
  Add a vertical plane to the bounds description.
  `double`
  ArcDistance.`computeDistance(PlanetModel planetModel, Plane plane, double x, double y, double z, Membership... bounds)`
  `double`
  ArcDistance.`computeDistance(PlanetModel planetModel, Plane plane, GeoPoint point, Membership... bounds)`
  `double`
  DistanceStyle.`computeDistance(PlanetModel planetModel, Plane plane, double x, double y, double z, Membership... bounds)`
  Compute the distance from a plane to a point.
  `default double`
  DistanceStyle.`computeDistance(PlanetModel planetModel, Plane plane, GeoPoint point, Membership... bounds)`
  Compute the distance from a plane to a point.
  `double`
  LinearDistance.`computeDistance(PlanetModel planetModel, Plane plane, double x, double y, double z, Membership... bounds)`
  `double`
  LinearDistance.`computeDistance(PlanetModel planetModel, Plane plane, GeoPoint point, Membership... bounds)`
  `double`
  LinearSquaredDistance.`computeDistance(PlanetModel planetModel, Plane plane, double x, double y, double z, Membership... bounds)`
  `double`
  LinearSquaredDistance.`computeDistance(PlanetModel planetModel, Plane plane, GeoPoint point, Membership... bounds)`
  `double`
  NormalDistance.`computeDistance(PlanetModel planetModel, Plane plane, double x, double y, double z, Membership... bounds)`
  `double`
  NormalDistance.`computeDistance(PlanetModel planetModel, Plane plane, GeoPoint point, Membership... bounds)`
  `double`
  NormalSquaredDistance.`computeDistance(PlanetModel planetModel, Plane plane, double x, double y, double z, Membership... bounds)`
  `double`
  NormalSquaredDistance.`computeDistance(PlanetModel planetModel, Plane plane, GeoPoint point, Membership... bounds)`
  `static Plane`
  Plane.`constructPerpendicularCenterPlaneOnePoint(Plane plane, Vector M)`
  Given a plane and one point that is on that plane, find a perpendicular plane that goes through both the origin and the point.
  `static SidedPlane`
  SidedPlane.`constructSidedPlaneFromOnePoint(Vector insidePoint, Plane plane, Vector intersectionPoint)`
  Construct sided plane from a plane and one point.
  `boolean`
  Plane.`crosses(PlanetModel planetModel, Plane q, GeoPoint[] notablePoints, GeoPoint[] moreNotablePoints, Membership[] bounds, Membership... moreBounds)`
  Determine whether the plane crosses another plane within the bounds provided.
  `GeoPoint[]`
  Plane.`findCrossings(PlanetModel planetModel, Plane q, Membership... bounds)`
  Find the points between two planes, where one plane crosses the other, given a set of bounds.
  `protected GeoPoint[]`
  Plane.`findCrossings(PlanetModel planetModel, Plane q, Membership[] bounds, Membership[] moreBounds)`
  Find the points between two planes, where one plane crosses the other, given a set of bounds.
  `GeoPoint[]`
  ArcDistance.`findDistancePoints(PlanetModel planetModel, double distanceValue, GeoPoint startPoint, Plane plane, Membership... bounds)`
  `GeoPoint[]`
  DistanceStyle.`findDistancePoints(PlanetModel planetModel, double distanceValue, GeoPoint startPoint, Plane plane, Membership... bounds)`
  Find a GeoPoint, at a specified distance from a starting point, within the specified bounds.
  `GeoPoint[]`
  LinearDistance.`findDistancePoints(PlanetModel planetModel, double distanceValue, GeoPoint startPoint, Plane plane, Membership... bounds)`
  `GeoPoint[]`
  LinearSquaredDistance.`findDistancePoints(PlanetModel planetModel, double distanceValue, GeoPoint startPoint, Plane plane, Membership... bounds)`
  `GeoPoint[]`
  NormalDistance.`findDistancePoints(PlanetModel planetModel, double distanceValue, GeoPoint startPoint, Plane plane, Membership... bounds)`
  `GeoPoint[]`
  NormalSquaredDistance.`findDistancePoints(PlanetModel planetModel, double distanceValue, GeoPoint startPoint, Plane plane, Membership... bounds)`
  `protected void`
  Plane.`findIntersectionBounds(PlanetModel planetModel, Bounds boundsInfo, Plane q, Membership... bounds)`
  Record intersection points for planes with error bounds.
  `GeoPoint[]`
  Plane.`findIntersections(PlanetModel planetModel, Plane q, Membership... bounds)`
  Find the intersection points between two planes, given a set of bounds.
  `protected GeoPoint[]`
  Plane.`findIntersections(PlanetModel planetModel, Plane q, Membership[] bounds, Membership[] moreBounds)`
  Find the intersection points between two planes, given a set of bounds.
  `GeoPoint`
  Plane.`getSampleIntersectionPoint(PlanetModel planetModel, Plane q)`
  Find a sample point on the intersection between two planes and the world.
  `boolean`
  GeoBaseCompositeShape.`intersects(Plane p, GeoPoint[] notablePoints, Membership... bounds)`
  `boolean`
  GeoDegenerateVerticalLine.`intersects(Plane p, GeoPoint[] notablePoints, Membership... bounds)`
  `boolean`
  GeoShape.`intersects(Plane plane, GeoPoint[] notablePoints, Membership... bounds)`
  Assess whether a plane, within the provided bounds, intersects with the shape's edges.
  `boolean`
  Plane.`intersects(PlanetModel planetModel, Plane q, GeoPoint[] notablePoints, GeoPoint[] moreNotablePoints, Membership[] bounds, Membership... moreBounds)`
  Determine whether the plane intersects another plane within the bounds provided.
  `boolean`
  Plane.`isFunctionallyIdentical(Plane p)`
  Returns true if this plane and the other plane are functionally identical within the margin of error.
  `boolean`
  Plane.`isNumericallyIdentical(Plane p)`
  Returns true if this plane and the other plane are identical within the margin of error.
  `void`
  Plane.`recordBounds(PlanetModel planetModel, LatLonBounds boundsInfo, Plane p, Membership... bounds)`
  Accumulate bounds information for this plane, intersected with another plane and the world.
  `void`
  Plane.`recordBounds(PlanetModel planetModel, XYZBounds boundsInfo, Plane p, Membership... bounds)`
  Accumulate (x,y,z) bounds information for this plane, intersected with another and the world.
  Constructors in org.apache.lucene.spatial3d.geom with parameters of type Plane
  Modifier
  Constructor
  Description
  ``
  `Plane(Plane basePlane, boolean above)`
  Construct a plane that is parallel to the one provided, but which is just barely numerically distinguishable from it, in the direction desired.