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

Class LineSubset3D

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

EmbeddedTreeLineSubset3D, LineConvexSubset3D

public abstract class LineSubset3D
extends Object
implements RegionEmbedding<Vector3D,Vector1D>, Sized

Class representing a subset of a line in 3D Euclidean space. For example, line segments, rays, and disjoint combinations of the two are line subsets. Line subsets may be finite or infinite.

Method Summary

Modifier and Type	Method and Description
abstract Bounds3D	getBounds() Get the 3D bounding box of the line subset or null if the subset is empty or infinite.
abstract Vector3D	getCentroid() Get the centroid, or geometric center, of the line subset or null if the subset is empty or infinite.
Line3D	getLine() Get the line containing this subset.
abstract HyperplaneBoundedRegion<Vector1D>	getSubspaceRegion() Get the subspace region for the instance.
Vector3D	toSpace(Vector1D pt)
Vector1D	toSubspace(Vector3D 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.Embedding

toSpace, toSubspace

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

getSize, isFinite, isInfinite

Method Detail

getLine

public Line3D getLine()

Get the line containing this subset.

Returns:

the line containing this subset

toSpace

public Vector3D toSpace(Vector1D pt)

Specified by:

toSpace in interface Embedding<Vector3D,Vector1D>

toSubspace

public Vector1D toSubspace(Vector3D pt)

Specified by:

toSubspace in interface Embedding<Vector3D,Vector1D>

getCentroid

public abstract Vector3D getCentroid()

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

Returns:

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

getBounds

public abstract Bounds3D getBounds()

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

Returns:

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

getSubspaceRegion

public abstract HyperplaneBoundedRegion<Vector1D> getSubspaceRegion()

Get the subspace region for the instance.

Specified by:

getSubspaceRegion in interface RegionEmbedding<Vector3D,Vector1D>

Returns:

the subspace region for the instance