org.monospark.geometrix.lineseg

Class LineSegHelper

java.lang.Object

org.monospark.geometrix.lineseg.LineSegHelper

public final class LineSegHelper
extends java.lang.Object

This class contains static helper methods for LineSeg objects.

See Also:

LineSeg

Method Summary

Modifier and Type	Method and Description
static <D extends TwoMin & ThreeMax> java.util.Optional<Vec<D>>	calculateIntersectionPoint(LineSeg<D> ls1, LineSeg<D> ls2) Calculates the intersection point of two line segments.
static <D extends TwoMin> double	calculateLength(LineSeg<D> ls) Calculates the length a line segment.
static <D extends TwoMin> Line<D>	calculateLine(LineSeg<D> ls) Calculates the line on which the line segment lies on.
static <D extends TwoMin> boolean	isPointOnLineSegment(LineSeg<D> ls, Vec<D> p) Checks if the point lies on the line segment.

Methods inherited from class java.lang.Object

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

Method Detail

calculateLength

public static <D extends TwoMin> double calculateLength(LineSeg<D> ls)

Calculates the length a line segment.

Parameters:

ls - the line segment

Returns:

the length of the line segment

Throws:

java.lang.NullPointerException - if the ls is null

calculateLine

public static <D extends TwoMin> Line<D> calculateLine(LineSeg<D> ls)

Calculates the line on which the line segment lies on.

Parameters:

ls - the line segment

Returns:

the line of which the line segment is a part of

Throws:

java.lang.NullPointerException - if the ls is null

isPointOnLineSegment

public static <D extends TwoMin> boolean isPointOnLineSegment(LineSeg<D> ls,
                                                              Vec<D> p)

Checks if the point lies on the line segment.

Parameters:

ls - the line segment

p - the point

Returns:

true if the point lies on the line segment, false if not

Throws:

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

calculateIntersectionPoint

public static <D extends TwoMin & ThreeMax> java.util.Optional<Vec<D>> calculateIntersectionPoint(LineSeg<D> ls1,
                                                                                                  LineSeg<D> ls2)

Calculates the intersection point of two line segments.

Parameters:

ls1 - the first line segment

ls2 - the second line segment

Returns:

the intersection point between the two lines. If there is no intersection point, an empty Optional will be returned.

Throws:

java.lang.NullPointerException - if ls1 or ls2 is null