org.monospark.geometrix.plane

Class Plane

java.lang.Object

org.monospark.geometrix.GeometrixObject

org.monospark.geometrix.plane.Plane

public final class Plane
extends GeometrixObject

A plane in three-dimensional space consisting out of an initial point and a normal vector.

See Also:

PlaneHelper

Method Summary

Modifier and Type	Method and Description
static Plane	create(Vec<Three> initialPoint, Vec<Three> normal) Constructs a plane using a given point on the plane and a normal vector.
boolean	equals(java.lang.Object o)
Vec<Three>	getInitialPoint()
Vec<Three>	getNormal()
int	hashCode()
boolean	resembles(java.lang.Object o)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Plane create(Vec<Three> initialPoint,
                           Vec<Three> normal)

Constructs a plane using a given point on the plane and a normal vector.

Parameters:

initialPoint - the initial point of the plane

normal - the normal vector of the plane

Returns:

the created plane

Throws:

java.lang.NullPointerException - if one of the arguments is null

java.lang.IllegalArgumentException - if normal is a zero vector

java.lang.IllegalArgumentException - if the initial point lies outside the object space

resembles

public boolean resembles(java.lang.Object o)

Specified by:

resembles in class GeometrixObject

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in class GeometrixObject

hashCode

public int hashCode()

Specified by:

hashCode in class GeometrixObject

toString

public java.lang.String toString()

Specified by:

toString in class GeometrixObject

getInitialPoint

public Vec<Three> getInitialPoint()

Returns:

the intial point of this plane

getNormal

public Vec<Three> getNormal()

Returns:

the normal of this plane