org.apache.commons.geometry.euclidean.threed.line

Class Segment3D

java.lang.Object

org.apache.commons.geometry.euclidean.threed.line.LineSubset3D

org.apache.commons.geometry.euclidean.threed.line.LineConvexSubset3D

org.apache.commons.geometry.euclidean.threed.line.Segment3D

All Implemented Interfaces:

Embedding<Vector3D,Vector1D>, RegionEmbedding<Vector3D,Vector1D>, Sized

public final class Segment3D
extends LineConvexSubset3D

Class representing a line segment in 3D 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:

Lines3D, Line Segment

Method Summary

Modifier and Type	Method and Description
Bounds3D	getBounds() Get the 3D bounding box of the line subset or null if the subset is empty or infinite.
Vector3D	getCentroid() Get the centroid, or geometric center, of the line subset or null if the subset is empty or infinite.
Vector3D	getEndPoint() Get the end point for the line subset.
double	getSize() Get the size (length) of the line subset.
Vector3D	getStartPoint() Get the start point for the line subset.
double	getSubspaceEnd() Get the 1D end location of the line subset or Double.POSITIVE_INFINITY if no end location exists.
double	getSubspaceStart() Get the 1D start location of the line subset or Double.NEGATIVE_INFINITY if no start location exists.
boolean	isFinite() Return true if the line subset is finite.
boolean	isInfinite() Return true if the line subset is infinite.
String	toString()
Segment3D	transform(Transform<Vector3D> transform) Transform this instance.

Methods inherited from class org.apache.commons.geometry.euclidean.threed.line.LineConvexSubset3D

contains, getInterval, getSubspaceRegion

Methods inherited from class org.apache.commons.geometry.euclidean.threed.line.LineSubset3D

getLine, 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.Embedding

toSpace, toSubspace

Method Detail

isInfinite

public boolean isInfinite()

Return true if the line subset is infinite.

This method always returns false.

Specified by:

isInfinite in interface Sized

Specified by:

isInfinite in class LineConvexSubset3D

Returns:

true if the line subset is infinite.

isFinite

public boolean isFinite()

Return true if the line subset is finite.

This method always returns true.

Specified by:

isFinite in interface Sized

Specified by:

isFinite in class LineConvexSubset3D

Returns:

true if the line subset is finite.

getStartPoint

public Vector3D getStartPoint()

Get the start point for the line subset.

Specified by:

getStartPoint in class LineConvexSubset3D

Returns:

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

getSubspaceStart

public double getSubspaceStart()

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

Specified by:

getSubspaceStart in class LineConvexSubset3D

Returns:

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

getEndPoint

public Vector3D getEndPoint()

Get the end point for the line subset.

Specified by:

getEndPoint in class LineConvexSubset3D

Returns:

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

getSubspaceEnd

public double getSubspaceEnd()

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

Specified by:

getSubspaceEnd in class LineConvexSubset3D

Returns:

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

getSize

public double getSize()

Get the size (length) of the line subset.

Specified by:

getSize in interface Sized

Specified by:

getSize in class LineConvexSubset3D

Returns:

the size of the line subset

getCentroid

public Vector3D getCentroid()

Get the centroid, or geometric center, of the line subset or null if the subset is empty or infinite.

Specified by:

getCentroid in class LineSubset3D

Returns:

the centroid of the line subset, or null if the subset is empty or infinite

getBounds

public Bounds3D getBounds()

Get the 3D bounding box of the line subset or null if the subset is empty or infinite.

Specified by:

getBounds in class LineSubset3D

Returns:

the 3D bounding box the line subset or null if the subset is empty or infinite

transform

public Segment3D transform(Transform<Vector3D> transform)

Transform this instance.

Specified by:

transform in class LineConvexSubset3D

Parameters:

transform - the transform to apply

Returns:

a new, transformed instance

toString

public String toString()

Overrides:

toString in class Object