Plane3 (CML Euclid 2.9 API)

java.lang.Object
- org.xmlcml.euclid.Plane3

All Implemented Interfaces:

EuclidConstants
```
public class Plane3
extends Object
implements EuclidConstants
```
3-dimensional plane class Plane3 represents a 3-dimensional plane. It is one of a set of primitives which can be combined to create and manipulate complex 3-dimensional objects. Planes can be transformed with rotation matrices or rotation-translation matrices (Transform3), can be calculated from other primitives or can be used to generate other primitives.
A plane is described by a unit vector (vector) and the perpendicular distance (dist) of the plane from the origin. The absolute direction of the plane (vector) IS important, giving the plane a direction (back and front faces).
The default plane is a Vector of (0.0, 0.0, 0.0) and a distance of 0.0. Operations on this default may lead to Exceptions such as ZeroLengthvector.

Author:

(C) P. Murray-Rust, 1996

Field Summary

Fields
Modifier and Type Field and Description

protected double dist
distance of plane from origin

protected Vector3 vect
vector of plane (normalised)
- Fields inherited from interface org.xmlcml.euclid.EuclidConstants
  C_AMP, C_APOS, C_ATSIGN, C_BACKSLASH, C_BACKSPACE, C_CARET, C_COLON, C_COMMA, C_DEL, C_DOLLAR, C_EQUALS, C_FORMFEED, C_HASH, C_LANGLE, C_LBRAK, C_LCURLY, C_LSQUARE, C_MINUS, C_NBSP, C_NEWLINE, C_NL, C_PERCENT, C_PERIOD, C_PIPE, C_PLUS, C_POUND, C_QUERY, C_QUOT, C_RANGLE, C_RBRAK, C_RCURLY, C_RETURN, C_RSQUARE, C_SEMICOLON, C_SHRIEK, C_SLASH, C_SPACE, C_STAR, C_TAB, C_TILDE, C_UNDER, EPS, F_S, NONWHITEPUNC, NONWHITEPUNC0, NONWHITEPUNC0REGEX, ONE_THIRD, PUNC, S_AMP, S_APOS, S_ATSIGN, S_BACKSLASH, S_CARET, S_COLON, S_COMMA, S_DOLLAR, S_EMPTY, S_EQUALS, S_FORMFEED, S_HASH, S_LANGLE, S_LBRAK, S_LCURLY, S_LSQUARE, S_MINUS, S_NEWLINE, S_NL, S_PERCENT, S_PERIOD, S_PIPE, S_PLUS, S_POUND, S_QUERY, S_QUOT, S_RANGLE, S_RBRAK, S_RCURLY, S_RETURN, S_RSQUARE, S_SEMICOLON, S_SHRIEK, S_SLASH, S_SPACE, S_STAR, S_TAB, S_TILDE, S_UNDER, S_WHITEREGEX, TWO_THIRDS, U_S, WHITESPACE

Fields
Modifier and Type	Field and Description
`protected double`	`dist` distance of plane from origin
`protected Vector3`	`vect` vector of plane (normalised)

Constructor Summary

Constructors
Constructor and Description
`Plane3()` default constructor.
`Plane3(double[] array)` construct from array.
`Plane3(double[] lmn, double d)` formed from components.
`Plane3(double l, double m, double n, double d)` formed from components.
`Plane3(Line3 l, Point3 p)` make a plane from a line and a point not on the line.
`Plane3(Plane3 pl)` copy constructor:
`Plane3(Point3 p1, Point3 p2, Point3 p3)` make a plane from three points.
`Plane3(Vector3 v, double d)` formed from plane and distance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsPoint(Point3 p)` is a point on the plane.
`Angle`	`getAngleMadeWith(Plane3 pl2)` the angle between 2 planes.
`double[]`	`getArray()` get return contents as an array.
`Point3`	`getClosestPointTo(Point3 p2)` point on plane closest to another point.
`double`	`getDistance()` get distance from origin.
`double`	`getDistanceFromPoint(Point3 p)` distance of point from plane.
`Point3`	`getIntersectionWith(Line3 l)` point of intersection of plane and line.
`Line3`	`getIntersectionWith(Plane3 pl2)` get line as intersection of two planes.
`Point3`	`getIntersectionWith(Plane3 pl2, Plane3 pl3)` point where three planes intersect
`Vector3`	`getVector()` get vector.
`boolean`	`isAntiparallelTo(Plane3 pl2)` are two planes antiparallel.
`boolean`	`isEqualTo(Plane3 pl2)` are two planes coincident and parallel.
`boolean`	`isParallelTo(Plane3 pl2)` are two planes parallel.
`void`	`negative()` reverse direction of plane.
`Plane3`	`subtract()` form coincident antiparallel plane.
`String`	`toString()` string representation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - vect
```
protected Vector3 vect
```
    vector of plane (normalised)
  - dist
```
protected double dist
```
    distance of plane from origin
- Constructor Detail
  - Plane3
```
public Plane3()
```
    default constructor. uses default vector3
  - Plane3
```
public Plane3(double l,
              double m,
              double n,
              double d)
       throws EuclidRuntimeException
```
    formed from components. vector is normalised
    
    Parameters:
    
    l - component
    
    m - component
    
    n - component
    
    d - distance
    
    Throws:
    
    EuclidRuntimeException
  - Plane3
```
public Plane3(double[] lmn,
              double d)
       throws EuclidRuntimeException
```
    formed from components. vector is normalised
    
    Parameters:
    
    lmn - component
    
    d - distance
    
    Throws:
    
    EuclidRuntimeException
  - Plane3
```
public Plane3(double[] array)
       throws EuclidRuntimeException
```
    construct from array.
    
    Parameters:
    
    array - 4-components
    
    Throws:
    
    EuclidRuntimeException
  - Plane3
```
public Plane3(Vector3 v,
              double d)
       throws EuclidRuntimeException
```
    formed from plane and distance. vector is copied and normalised
    
    Parameters:
    
    v - vector
    
    d - distance
    
    Throws:
    
    EuclidRuntimeException
  - Plane3
```
public Plane3(Plane3 pl)
```
    copy constructor:
    
    Parameters:
    
    pl - place
  - Plane3
```
public Plane3(Point3 p1,
              Point3 p2,
              Point3 p3)
       throws EuclidRuntimeException
```
    make a plane from three points.
    
    Parameters:
    
    p1 - point
    
    p2 - point
    
    p3 - point
    
    Throws:
    
    EuclidRuntimeException
  - Plane3
```
public Plane3(Line3 l,
              Point3 p)
       throws EuclidRuntimeException
```
    make a plane from a line and a point not on the line.
    
    Parameters:
    
    l - point
    
    p - point
    
    Throws:
    
    EuclidRuntimeException
- Method Detail
  - getArray
```
public double[] getArray()
```
    get return contents as an array.
    
    Returns:
    
    the array (l,m,n,d)
  - getVector
```
public Vector3 getVector()
```
    get vector.
    
    Returns:
    
    the vector
  - getDistance
```
public double getDistance()
```
    get distance from origin.
    
    Returns:
    
    the distance
  - negative
```
public void negative()
```
    reverse direction of plane.
  - isEqualTo
```
public boolean isEqualTo(Plane3 pl2)
```
    are two planes coincident and parallel.
    
    Parameters:
    
    pl2 - plane to compare
    
    Returns:
    
    true if equal within Real.isEqual()
  - subtract
```
public Plane3 subtract()
```
    form coincident antiparallel plane.
    
    Returns:
    
    antiparallel plane
  - getDistanceFromPoint
```
public double getDistanceFromPoint(Point3 p)
```
    distance of point from plane. will be a signed quantity
    
    Parameters:
    
    p - the point
    
    Returns:
    
    the distance
  - isParallelTo
```
public boolean isParallelTo(Plane3 pl2)
```
    are two planes parallel. not antiparallel
    
    Parameters:
    
    pl2 - the plane
    
    Returns:
    
    true if parallel within Real.isEqual()
  - isAntiparallelTo
```
public boolean isAntiparallelTo(Plane3 pl2)
```
    are two planes antiparallel. not parallel
    
    Parameters:
    
    pl2 - the plane
    
    Returns:
    
    true if antiparallel within Real.isEqual()
  - containsPoint
```
public boolean containsPoint(Point3 p)
```
    is a point on the plane.
    
    Parameters:
    
    p - the point
    
    Returns:
    
    true if within Real.isEqual()
  - getClosestPointTo
```
public Point3 getClosestPointTo(Point3 p2)
```
    point on plane closest to another point. if p2 is on plane then result will coincide
    
    Parameters:
    
    p2 - other point
    
    Returns:
    
    the closest point
  - getIntersectionWith
```
public Point3 getIntersectionWith(Line3 l)
```
    point of intersection of plane and line.
    
    Parameters:
    
    l - line
    
    Returns:
    
    intersection point (null if line parallel to plane)
  - getIntersectionWith
```
public Line3 getIntersectionWith(Plane3 pl2)
```
    get line as intersection of two planes.
    
    Parameters:
    
    pl2 - plane
    
    Returns:
    
    intersection line (null if parallel)
  - getIntersectionWith
```
public Point3 getIntersectionWith(Plane3 pl2,
                                  Plane3 pl3)
```
    point where three planes intersect
    
    Parameters:
    
    pl2 - plane
    
    pl3 - plane
    
    Returns:
    
    intersection point (null if any planes parallel)
  - getAngleMadeWith
```
public Angle getAngleMadeWith(Plane3 pl2)
```
    the angle between 2 planes.
    
    Parameters:
    
    pl2 - plane
    
    Returns:
    
    the angle (unsigned)
  - toString
```
public String toString()
```
    string representation.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string

Class Plane3

Field Summary

Fields inherited from interface org.xmlcml.euclid.EuclidConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

vect

dist

Constructor Detail

Plane3

Plane3

Plane3

Plane3

Plane3

Plane3

Plane3

Plane3

Method Detail

getArray

getVector

getDistance

negative

isEqualTo

subtract

getDistanceFromPoint

isParallelTo

isAntiparallelTo

containsPoint

getClosestPointTo

getIntersectionWith

getIntersectionWith

getIntersectionWith

getAngleMadeWith

toString