org.apache.commons.geometry.euclidean.twod

Class Segment

java.lang.Object

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

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

org.apache.commons.geometry.euclidean.twod.Segment

All Implemented Interfaces:

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

public final class Segment
extends LineConvexSubset

Class representing a line segment in 2D Euclidean space. A line segment is a portion of a line with finite start and end points.

Instances of this class are guaranteed to be immutable.

See Also:

Lines, Line Segment

Method Summary

Modifier and Type	Method and Description
Bounds2D	getBounds() Get a Bounds2D object defining an axis-aligned bounding box containing all vertices for this subset.
Vector2D	getCentroid()
Vector2D	getEndPoint() Get the end point for the subset.
double	getSize()
Vector2D	getStartPoint() Get the start point for the subset.
double	getSubspaceEnd() Get the 1D end location of the subset or Double.POSITIVE_INFINITY if no end location exists.
double	getSubspaceStart() Get the 1D start location of the subset or Double.NEGATIVE_INFINITY if no start location exists.
boolean	isFinite()
boolean	isFull()
boolean	isInfinite()
Segment	reverse()
String	toString()
Segment	transform(Transform<Vector2D> transform)

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

closest, getInterval, getSubspaceRegion, isEmpty, split, toConvex

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

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

Methods inherited from class java.lang.Object

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

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

classify, contains, getHyperplane

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

toSpace, toSubspace

Method Detail

isFull

public boolean isFull()

This method always returns false.

isInfinite

public boolean isInfinite()

This method always returns false.

isFinite

public boolean isFinite()

This method always returns true.

getSize

public double getSize()

getCentroid

public Vector2D getCentroid()

getStartPoint

public Vector2D getStartPoint()

Get the start point for the subset.

Specified by:

getStartPoint in class LineConvexSubset

Returns:

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

getSubspaceStart

public double getSubspaceStart()

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

Specified by:

getSubspaceStart in class LineConvexSubset

Returns:

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

getEndPoint

public Vector2D getEndPoint()

Get the end point for the subset.

Specified by:

getEndPoint in class LineConvexSubset

Returns:

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

getSubspaceEnd

public double getSubspaceEnd()

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

Specified by:

getSubspaceEnd in class LineConvexSubset

Returns:

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

getBounds

public 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.

Specified by:

getBounds in class LineSubset

Returns:

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

transform

public Segment transform(Transform<Vector2D> transform)

Specified by:

transform in interface HyperplaneConvexSubset<Vector2D>

Specified by:

transform in interface HyperplaneSubset<Vector2D>

Specified by:

transform in class LineConvexSubset

reverse

public Segment reverse()

Specified by:

reverse in interface HyperplaneConvexSubset<Vector2D>

Specified by:

reverse in class LineConvexSubset

toString

public String toString()

Overrides:

toString in class Object