org.apache.commons.geometry.euclidean.threed

Interface PlaneSubset

All Superinterfaces:

HyperplaneSubset<Vector3D>, Sized, Splittable<Vector3D,HyperplaneSubset<Vector3D>>

All Known Subinterfaces:

ConvexPolygon3D, PlaneConvexSubset, Triangle3D

All Known Implementing Classes:

EmbeddedTreePlaneSubset

public interface PlaneSubset
extends HyperplaneSubset<Vector3D>

Interface representing a subset of points in a plane in Euclidean 3D space. Instances may represent finite, infinite, convex, non-convex, and/or disjoint regions of the plane.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PlaneSubset.Embedded Interface used to represent plane subsets as embedded 2D subspace regions.

Method Summary

Modifier and Type	Method and Description
Bounds3D	getBounds() Get a Bounds3D object defining an axis-aligned bounding box containing all vertices for this subset.
PlaneSubset.Embedded	getEmbedded() Return an object containing the plane subset as an embedded 2D subspace region.
Plane	getHyperplane()
Plane	getPlane() Get the plane containing this subset.
Vector3D	intersection(Line3D line) Get the unique intersection of this plane subset with the given line.
Vector3D	intersection(LineConvexSubset3D lineSubset) Get the unique intersection of this plane subset with the given line subset.
List<PlaneConvexSubset>	toConvex()
List<Triangle3D>	toTriangles() Return a list of triangles representing the same subset region as this instance.

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

classify, 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

Method Detail

getPlane

Plane getPlane()

Get the plane containing this subset. This is equivalent to getHyperplane().

Returns:

the plane containing this subset

See Also:

getHyperplane()

getHyperplane

Plane getHyperplane()

Specified by:

getHyperplane in interface HyperplaneSubset<Vector3D>

toConvex

List<PlaneConvexSubset> toConvex()

Specified by:

toConvex in interface HyperplaneSubset<Vector3D>

toTriangles

List<Triangle3D> toTriangles()

Return a list of triangles representing the same subset region as this instance. An IllegalStateException is thrown if the subset has infinite size and therefore cannot be converted to triangles. If the subset has zero size (is empty), an empty list is returned.

Returns:

a list of triangles representing the same subset region as this instance

Throws:

IllegalStateException - if the subset has infinite size and therefore cannot be converted to triangles

getBounds

Bounds3D getBounds()

Get a Bounds3D 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

getEmbedded

PlaneSubset.Embedded getEmbedded()

Return an object containing the plane subset as an embedded 2D subspace region.

Returns:

an object containing the plane subset as an embedded 2D subspace region

intersection

Vector3D intersection(Line3D line)

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

Parameters:

line - line to intersect with this plane subset

Returns:

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

See Also:

Plane.intersection(Line3D)

intersection

Vector3D intersection(LineConvexSubset3D lineSubset)

Get the unique intersection of this plane subset with the given line subset. Null is returned if the underlying line and plane 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 the line subset and plane subset.

Parameters:

lineSubset - line subset to intersect with

Returns:

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

See Also:

Plane.intersection(Line3D)