org.monospark.geometrix.plane

Class PlaneHelper

java.lang.Object

org.monospark.geometrix.plane.PlaneHelper

public final class PlaneHelper
extends java.lang.Object

A class which contains only static helper methods for Plane objects.

See Also:

Plane

Method Summary

Modifier and Type	Method and Description
static <D extends ThreeMin> java.util.Optional<Vec<Three>>	calculateIntersectionPoint(Plane p, Line<Three> l) Calculates the intersection point of a plane and a line.
static <D extends ThreeMin> boolean	isLineOnPlane(Plane p, Line<Three> l) Checks if a line lies completely on a plane
static <D extends ThreeMin> boolean	isLineParallelToPlane(Plane p, Line<Three> l) Checks if a line is parallel to a plane.
static <D extends ThreeMin> boolean	isPointOnPlane(Plane plane, Vec<Three> point) Checks if a given point lies on a plane.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isPointOnPlane

public static <D extends ThreeMin> boolean isPointOnPlane(Plane plane,
                                                          Vec<Three> point)

Checks if a given point lies on a plane.

Parameters:

plane - the plane

point - the point

Returns:

true if the point lies on the plane, false if not

Throws:

java.lang.NullPointerException - if plane or point is null

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

calculateIntersectionPoint

public static <D extends ThreeMin> java.util.Optional<Vec<Three>> calculateIntersectionPoint(Plane p,
                                                                                             Line<Three> l)

Calculates the intersection point of a plane and a line.

Parameters:

p - the plane

l - the line

Returns:

the intersection point of the plane and the line. If there is no intersection point, an empty Optional will be returned.

Throws:

java.lang.NullPointerException - if p or l is null

isLineParallelToPlane

public static <D extends ThreeMin> boolean isLineParallelToPlane(Plane p,
                                                                 Line<Three> l)

Checks if a line is parallel to a plane.

Parameters:

p - the plane

l - the line

Returns:

true if the line is parallel to the plane, false if not

Throws:

java.lang.NullPointerException - if p or l is null

isLineOnPlane

public static <D extends ThreeMin> boolean isLineOnPlane(Plane p,
                                                         Line<Three> l)

Checks if a line lies completely on a plane

Parameters:

p - the plane

l - the line

Returns:

true if the line is lying the plane, false if not

Throws:

java.lang.NullPointerException - if p or l is null