org.apache.commons.geometry.euclidean.twod

Class LineSubset

java.lang.Object

org.apache.commons.geometry.euclidean.twod.LineSubset

All Implemented Interfaces:

Embedding<Vector2D,Vector1D>, HyperplaneSubset<Vector2D>, Splittable<Vector2D,HyperplaneSubset<Vector2D>>, RegionEmbedding<Vector2D,Vector1D>, Sized

Direct Known Subclasses:

EmbeddedTreeLineSubset, LineConvexSubset

public abstract class LineSubset
extends Object
implements HyperplaneSubset<Vector2D>, RegionEmbedding<Vector2D,Vector1D>

Class representing a subset of points on a line in 2D Euclidean space. For example, line segments and rays are line subsets. Line subsets may be finite or infinite.

Method Summary

Modifier and Type	Method and Description
RegionLocation	classify(Vector2D pt)
abstract Bounds2D	getBounds() Get a Bounds2D object defining an axis-aligned bounding box containing all vertices for this subset.
Line	getHyperplane()
Line	getLine() Get the line containing this subset.
Precision.DoubleEquivalence	getPrecision() Return the object used to perform floating point comparisons, which is the same object used by the underlying Line).
abstract HyperplaneBoundedRegion<Vector1D>	getSubspaceRegion()
Vector2D	intersection(Line inputLine) Get the unique intersection of this subset with the given line.
Vector2D	intersection(LineSubset subset) Get the unique intersection of this instance with the given line subset.
abstract List<LineConvexSubset>	toConvex()
Vector2D	toSpace(Vector1D pt)
Vector1D	toSubspace(Vector2D pt)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.geometry.core.partitioning.HyperplaneSubset

closest, contains, getCentroid, isEmpty, isFull, transform

Methods inherited from interface org.apache.commons.geometry.core.partitioning.Splittable

split

Methods inherited from interface org.apache.commons.geometry.core.Sized

getSize, isFinite, isInfinite

Methods inherited from interface org.apache.commons.geometry.core.Embedding

toSpace, toSubspace

Method Detail

getLine

public Line getLine()

Get the line containing this subset. This method is an alias for getHyperplane().

Returns:

the line containing this subset

See Also:

getHyperplane()

getHyperplane

public Line getHyperplane()

Specified by:

getHyperplane in interface HyperplaneSubset<Vector2D>

toSubspace

public Vector1D toSubspace(Vector2D pt)

Specified by:

toSubspace in interface Embedding<Vector2D,Vector1D>

getBounds

public abstract Bounds2D getBounds()

Get a Bounds2D object defining an axis-aligned bounding box containing all vertices for this subset. Null is returned if the subset is infinite or does not contain any vertices.

Returns:

the bounding box for this instance or null if no valid bounds could be determined

getSubspaceRegion

public abstract HyperplaneBoundedRegion<Vector1D> getSubspaceRegion()

Specified by:

getSubspaceRegion in interface RegionEmbedding<Vector2D,Vector1D>

toSpace

public Vector2D toSpace(Vector1D pt)

Specified by:

toSpace in interface Embedding<Vector2D,Vector1D>

toConvex

public abstract List<LineConvexSubset> toConvex()

Specified by:

toConvex in interface HyperplaneSubset<Vector2D>

classify

public RegionLocation classify(Vector2D pt)

Specified by:

classify in interface HyperplaneSubset<Vector2D>

intersection

public Vector2D intersection(Line inputLine)

Get the unique intersection of this subset with the given line. Null is returned if no unique intersection point exists (ie, the lines are parallel or coincident) or the line does not intersect this instance.

Parameters:

inputLine - line to intersect with this line subset

Returns:

the unique intersection point between the line and this line subset or null if no such point exists.

See Also:

Line.intersection(Line)

intersection

public Vector2D intersection(LineSubset subset)

Get the unique intersection of this instance with the given line subset. Null is returned if the lines containing the line subsets do not have a unique intersection point (ie, they are parallel or coincident) or the intersection point is unique but is not contained in both line subsets.

Parameters:

subset - line subset to intersect with

Returns:

the unique intersection point between this line subset and the argument or null if no such point exists.

See Also:

Line.intersection(Line)

getPrecision

public Precision.DoubleEquivalence getPrecision()

Return the object used to perform floating point comparisons, which is the same object used by the underlying Line).

Returns:

precision object used to perform floating point comparisons.