Plane3D (java-geom 3.8.1-SNAPSHOT API)

java.lang.Object
- math.geom3d.plane.Plane3D

All Implemented Interfaces:

Serializable, Shape3D
```
public class Plane3D
extends Object
implements Shape3D
```
Plane in 3D space Plane in 3D space defined by origin and two linearly independent vectors "vector1" and "vector2". Defines internal 2D coordinate system. Vector1 is the X Axis. The Y axis is computed by orthogonalization of vector2 against vector1.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface math.geom3d.Shape3D
  Shape3D.EmptySet3D

Field Summary

Fields
Modifier and Type	Field and Description
`protected Plane3DCoordinateSubsystem`	`coordinateSubsystem`
`protected Vector3D`	`normal`
`protected Point3D`	`origin`
`protected Vector3D`	`vector1`
`protected Vector3D`	`vector2`
`static Plane3D`	`xyPlane`
`static Plane3D`	`xzPlane`
`static Plane3D`	`yzPlane`

Fields inherited from interface math.geom3d.Shape3D
ACCURACY, ACCURACY_INVERSE, EMPTY_SET

Constructor Summary

Constructors
Constructor and Description

Plane3D(Point3D origin, Vector3D vector1, Vector3D vector2)
Construct from origin and vectors

Constructors
Constructor and Description
`Plane3D(Point3D origin, Vector3D vector1, Vector3D vector2)` Construct from origin and vectors

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Shape3D`	`clip(Box3D box)`
`boolean`	`contains(Point3D point)`
`static Plane3D`	`createPlaneDefinedByPoints(Collection<Point3D> pointsInPlane)` Construct from points in plane Picks 3 anchors from provided list of points, see `pickAnchors(Collection)`
`boolean`	`equals(Object obj)`
`Box3D`	`getBoundingBox()`
`Plane3DCoordinateSubsystem`	`getCoordinateSubsystem()` Get coordinate subsystem.
`double`	`getDistance(Point3D point)` Gets the distance of the shape to the given point, or the distance of point to the frontier of the shape in the case of a plain shape.
`Vector3D`	`getNormalVector()` Get the normal vector Normal is normalized.
`Point3D`	`getOrigin()` Get origin
`double`	`getSignedDistance(Point3D point)` Get signed distance determined by normal vector
`Vector3D`	`getVector1()` Get vector1
`Vector3D`	`getVector2()` Get vector2
`boolean`	`isBounded()` Returns true if the shape is bounded, that is if we can draw a finite rectangle enclosing the shape.
`boolean`	`isEmpty()`
`static Point3D[]`	`pickAnchors(Collection<Point3D> pointsInPlane)` Pick anchors of a plane Picks 3 anchors that define the plane well (see `rateAnchors(Point3D, Point3D, Point3D)`)..
`Point3D`	`project(Point3D point)` Project a point onto plane
`Vector3D`	`project(Vector3D vector)` Project a vector onto plane See `project(Point3D)`.
`protected static double`	`rateAnchors(Point3D a, Point3D b, Point3D c)` Rate the ability of points to define a plane Anchors need to be distant from each other (to avoid floating point math inaccuracies) and must be linearly independent.
`String`	`toString()`
`Shape3D`	`transform(AffineTransform3D trans)`

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

- Field Detail
  - origin
```
protected Point3D origin
```
  - vector1
```
protected Vector3D vector1
```
  - vector2
```
protected Vector3D vector2
```
  - coordinateSubsystem
```
protected transient Plane3DCoordinateSubsystem coordinateSubsystem
```
  - normal
```
protected transient Vector3D normal
```
  - xyPlane
```
public static final Plane3D xyPlane
```
  - xzPlane
```
public static final Plane3D xzPlane
```
  - yzPlane
```
public static final Plane3D yzPlane
```
- Constructor Detail
  - Plane3D
```
public Plane3D(Point3D origin,
               Vector3D vector1,
               Vector3D vector2)
```
    Construct from origin and vectors
    
    Parameters:
    
    origin - point within the plane
    
    vector1 - first vector must be linearly independent of vector2
    
    vector2 - second vector must be linearly independent of vector1
- Method Detail
  - createPlaneDefinedByPoints
```
public static Plane3D createPlaneDefinedByPoints(Collection<Point3D> pointsInPlane)
```
    Construct from points in plane Picks 3 anchors from provided list of points, see pickAnchors(Collection)
    
    Parameters:
    
    pointsInPlane - points that lie in the constructed plane, must contain at least 3 linearly independent points
  - getOrigin
```
public Point3D getOrigin()
```
    Get origin
    
    Returns:
    
    origin, point within the plane that is also origin of its internal coordinate system
  - getVector1
```
public Vector3D getVector1()
```
    Get vector1
    
    Returns:
    
    the first original vector used to define the plane
  - getVector2
```
public Vector3D getVector2()
```
    Get vector2
    
    Returns:
    
    the second original vector used to define the plane
  - getNormalVector
```
public Vector3D getNormalVector()
```
    Get the normal vector
    Normal is normalized.
  - project
```
public Point3D project(Point3D point)
```
    Project a point onto plane
    
    Parameters:
    
    point - point to project
    
    Returns:
    
    point within plane that lies in direction of normal vector from input point
  - project
```
public Vector3D project(Vector3D vector)
```
    Project a vector onto plane See project(Point3D).
  - getCoordinateSubsystem
```
public Plane3DCoordinateSubsystem getCoordinateSubsystem()
```
    Get coordinate subsystem.
    
    See Also:
    
    Plane3DCoordinateSubsystem}
  - clip
```
public Shape3D clip(Box3D box)
```
    Specified by:
    
    clip in interface Shape3D
  - contains
```
public boolean contains(Point3D point)
```
    Specified by:
    
    contains in interface Shape3D
  - getBoundingBox
```
public Box3D getBoundingBox()
```
    Specified by:
    
    getBoundingBox in interface Shape3D
  - getSignedDistance
```
public double getSignedDistance(Point3D point)
```
    Get signed distance determined by normal vector
    
    Parameters:
    
    point - point to get signed distance of
    
    Returns:
    
    positive distance if point is in direction of the normal vector
  - getDistance
```
public double getDistance(Point3D point)
```
    Description copied from interface: Shape3D
    
    Gets the distance of the shape to the given point, or the distance of point to the frontier of the shape in the case of a plain shape.
    
    Specified by:
    
    getDistance in interface Shape3D
  - isBounded
```
public boolean isBounded()
```
    Description copied from interface: Shape3D
    
    Returns true if the shape is bounded, that is if we can draw a finite rectangle enclosing the shape. For example, a straight line or a parabola are not bounded.
    
    Specified by:
    
    isBounded in interface Shape3D
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Shape3D
  - transform
```
public Shape3D transform(AffineTransform3D trans)
```
    Specified by:
    
    transform in interface Shape3D
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - pickAnchors
```
public static Point3D[] pickAnchors(Collection<Point3D> pointsInPlane)
```
    Pick anchors of a plane Picks 3 anchors that define the plane well (see rateAnchors(Point3D, Point3D, Point3D))..
    
    Parameters:
    
    pointsInPlane - points in a plane
    
    Returns:
    
    array of 3 anchors
  - rateAnchors
```
protected static double rateAnchors(Point3D a,
                                    Point3D b,
                                    Point3D c)
```
    Rate the ability of points to define a plane Anchors need to be distant from each other (to avoid floating point math inaccuracies) and must be linearly independent.

Class Plane3D

Nested Class Summary

Nested classes/interfaces inherited from interface math.geom3d.Shape3D

Field Summary

Fields inherited from interface math.geom3d.Shape3D

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

origin

vector1

vector2

coordinateSubsystem

normal

xyPlane

xzPlane

yzPlane

Constructor Detail

Plane3D

Method Detail

createPlaneDefinedByPoints

getOrigin

getVector1

getVector2

getNormalVector

project

project

getCoordinateSubsystem

clip

contains

getBoundingBox

getSignedDistance

getDistance

isBounded

isEmpty

transform

equals

toString

pickAnchors

rateAnchors