org.apache.commons.geometry.euclidean.threed

Interface PlaneConvexSubset

All Superinterfaces:

HyperplaneConvexSubset<Vector3D>, HyperplaneSubset<Vector3D>, PlaneSubset, Sized, Splittable<Vector3D,HyperplaneSubset<Vector3D>>

All Known Subinterfaces:

ConvexPolygon3D, Triangle3D

public interface PlaneConvexSubset
extends PlaneSubset, HyperplaneConvexSubset<Vector3D>

Interface representing a finite or infinite convex subset of points in a plane in Euclidean 3D space.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
PlaneConvexSubset.Embedded	getEmbedded() Return an object containing the plane subset as an embedded 2D subspace region.
List<Vector3D>	getVertices() Get the vertices for the convex subset in a counter-clockwise order as viewed looking down the plane normal.
PlaneConvexSubset	reverse()
Split<PlaneConvexSubset>	split(Hyperplane<Vector3D> splitter)
default List<PlaneConvexSubset>	toConvex()
PlaneConvexSubset	transform(Transform<Vector3D> transform)

Methods inherited from interface org.apache.commons.geometry.euclidean.threed.PlaneSubset

getBounds, getHyperplane, getPlane, intersection, intersection, toTriangles

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

classify, closest, contains, getCentroid, isEmpty, isFull

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

getSize, isFinite, isInfinite

Method Detail

reverse

PlaneConvexSubset reverse()

Specified by:

reverse in interface HyperplaneConvexSubset<Vector3D>

transform

PlaneConvexSubset transform(Transform<Vector3D> transform)

Specified by:

transform in interface HyperplaneConvexSubset<Vector3D>

Specified by:

transform in interface HyperplaneSubset<Vector3D>

split

Split<PlaneConvexSubset> split(Hyperplane<Vector3D> splitter)

Specified by:

split in interface HyperplaneConvexSubset<Vector3D>

Specified by:

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

getEmbedded

PlaneConvexSubset.Embedded getEmbedded()

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

Specified by:

getEmbedded in interface PlaneSubset

Returns:

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

getVertices

List<Vector3D> getVertices()

Get the vertices for the convex subset in a counter-clockwise order as viewed looking down the plane normal. Each vertex in the returned list is unique. If the boundary of the subset is closed, the start vertex is not repeated at the end of the list.

It is important to note that, in general, the list of vertices returned by this method is not sufficient to completely characterize the subset. For example, a simple triangle has 3 vertices, but an infinite area constructed from two parallel lines and two lines that intersect between them will also have 3 vertices. It is also possible for non-empty subsets to contain no vertices at all. For example, a subset with no boundaries (representing the full plane), a subset with a single boundary (ie, a half-plane), or a subset with two parallel boundaries will not contain any vertices.

Returns:

the list of vertices for the plane convex subset in a counter-clockwise order as viewed looking down the plane normal

toConvex

default List<PlaneConvexSubset> toConvex()

This method simply returns a singleton list containing this object.

Specified by:

toConvex in interface HyperplaneSubset<Vector3D>

Specified by:

toConvex in interface PlaneSubset