org.apache.commons.geometry.euclidean.twod

Class LineConvexSubset

java.lang.Object

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

org.apache.commons.geometry.euclidean.twod.LineConvexSubset

All Implemented Interfaces:

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

Direct Known Subclasses:

Ray, ReverseRay, Segment

public abstract class LineConvexSubset
extends LineSubset
implements HyperplaneConvexSubset<Vector2D>

Class representing a convex subset of a line in 2D Euclidean space. Instances need not be finite, in which case the start or end point (or both) will be null. Line segments and rays are examples of convex line subsets.

See Also:

Lines

Method Summary

Modifier and Type	Method and Description
Vector2D	closest(Vector2D pt)
abstract Vector2D	getEndPoint() Get the end point for the subset.
Interval	getInterval() Get the 1D interval for the region.
abstract Vector2D	getStartPoint() Get the start point for the subset.
abstract double	getSubspaceEnd() Get the 1D end location of the subset or Double.POSITIVE_INFINITY if no end location exists.
Interval	getSubspaceRegion()
abstract double	getSubspaceStart() Get the 1D start location of the subset or Double.NEGATIVE_INFINITY if no start location exists.
boolean	isEmpty()
abstract LineConvexSubset	reverse()
Split<LineConvexSubset>	split(Hyperplane<Vector2D> splitter)
List<LineConvexSubset>	toConvex()
abstract LineConvexSubset	transform(Transform<Vector2D> transform)

Methods inherited from class org.apache.commons.geometry.euclidean.twod.LineSubset

classify, getBounds, getHyperplane, getLine, getPrecision, intersection, intersection, toSpace, toSubspace

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

classify, contains, getCentroid, getHyperplane, isFull

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

toConvex

public List<LineConvexSubset> toConvex()

Specified by:

toConvex in interface HyperplaneSubset<Vector2D>

Specified by:

toConvex in class LineSubset

isEmpty

public boolean isEmpty()

This method always returns false.

Specified by:

isEmpty in interface HyperplaneSubset<Vector2D>

getStartPoint

public abstract Vector2D getStartPoint()

Get the start point for the subset.

Returns:

the start point for the subset, or null if no start point exists

getSubspaceStart

public abstract double getSubspaceStart()

Get the 1D start location of the subset or Double.NEGATIVE_INFINITY if no start location exists.

Returns:

the 1D start location of the subset or Double.NEGATIVE_INFINITY if no start location exists.

getEndPoint

public abstract Vector2D getEndPoint()

Get the end point for the subset.

Returns:

the end point for the subset, or null if no end point exists.

getSubspaceEnd

public abstract double getSubspaceEnd()

Get the 1D end location of the subset or Double.POSITIVE_INFINITY if no end location exists.

Returns:

the 1D end location of the subset or Double.POSITIVE_INFINITY if no end location exists

getSubspaceRegion

public Interval getSubspaceRegion()

Specified by:

getSubspaceRegion in interface RegionEmbedding<Vector2D,Vector1D>

Specified by:

getSubspaceRegion in class LineSubset

getInterval

public Interval getInterval()

Get the 1D interval for the region. This method is an alias for getSubspaceRegion().

Returns:

the 1D interval for the region.

split

public Split<LineConvexSubset> split(Hyperplane<Vector2D> splitter)

Specified by:

split in interface HyperplaneConvexSubset<Vector2D>

Specified by:

split in interface Splittable<Vector2D,HyperplaneSubset<Vector2D>>

closest

public Vector2D closest(Vector2D pt)

Specified by:

closest in interface HyperplaneSubset<Vector2D>

transform

public abstract LineConvexSubset transform(Transform<Vector2D> transform)

Specified by:

transform in interface HyperplaneConvexSubset<Vector2D>

Specified by:

transform in interface HyperplaneSubset<Vector2D>

reverse

public abstract LineConvexSubset reverse()

Specified by:

reverse in interface HyperplaneConvexSubset<Vector2D>