org.apache.commons.geometry.euclidean.threed

Class EmbeddedTreePlaneSubset

java.lang.Object

org.apache.commons.geometry.euclidean.threed.EmbeddedTreePlaneSubset

All Implemented Interfaces:

Embedding<Vector3D,Vector2D>, HyperplaneSubset<Vector3D>, Splittable<Vector3D,HyperplaneSubset<Vector3D>>, RegionEmbedding<Vector3D,Vector2D>, Sized, PlaneSubset, PlaneSubset.Embedded

public final class EmbeddedTreePlaneSubset
extends Object

Class representing an arbitrary subset of a plane using a RegionBSPTree2D. This class can represent convex, non-convex, finite, infinite, and empty regions.

This class is mutable and not thread safe.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.commons.geometry.euclidean.threed.PlaneSubset

PlaneSubset.Embedded

Constructor Summary

Constructors

Constructor and Description
EmbeddedTreePlaneSubset(EmbeddingPlane plane) Construct a new, empty plane subset for the given plane.
EmbeddedTreePlaneSubset(EmbeddingPlane plane, boolean full) Construct a new subset for the given plane.
EmbeddedTreePlaneSubset(EmbeddingPlane plane, RegionBSPTree2D region) Construct a new instance from its defining plane and subspace region.

Method Summary

Modifier and Type	Method and Description
void	add(EmbeddedTreePlaneSubset subset) Add a plane subset to this instance.
void	add(PlaneConvexSubset subset) Add a plane convex subset to this instance.
RegionLocation	classify(Vector3D pt)
Vector3D	closest(Vector3D pt)
Bounds3D	getBounds() Get a Bounds3D object defining an axis-aligned bounding box containing all vertices for this subset.
protected Bounds3D	getBoundsFromSubspace(BoundarySource2D src) Compute 3D bounds from a subspace boundary source.
Vector3D	getCentroid()
PlaneSubset.Embedded	getEmbedded() Return an object containing the plane subset as an embedded 2D subspace region.
EmbeddingPlane	getHyperplane()
EmbeddingPlane	getPlane() Get the plane embedding the subspace region.
double	getSize()
RegionBSPTree2D	getSubspaceRegion()
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.
boolean	isEmpty()
boolean	isFull()
Split<EmbeddedTreePlaneSubset>	split(Hyperplane<Vector3D> splitter)
List<PlaneConvexSubset>	toConvex()
Vector3D	toSpace(Vector2D pt)
String	toString()
Vector2D	toSubspace(Vector3D pt)
List<Triangle3D>	toTriangles() Return a list of triangles representing the same subset region as this instance.
EmbeddedTreePlaneSubset	transform(Transform<Vector3D> transform)

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

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

contains

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

isFinite, isInfinite

Constructor Detail

EmbeddedTreePlaneSubset

public EmbeddedTreePlaneSubset(EmbeddingPlane plane)

Construct a new, empty plane subset for the given plane.

Parameters:

plane - plane containing the subset

EmbeddedTreePlaneSubset

public EmbeddedTreePlaneSubset(EmbeddingPlane plane,
                               boolean full)

Construct a new subset for the given plane. If full is true, then the subset will cover the entire plane; otherwise, it will be empty.

Parameters:

plane - plane containing the subset

full - if true, the subset will cover the entire space; otherwise it will be empty

EmbeddedTreePlaneSubset

public EmbeddedTreePlaneSubset(EmbeddingPlane plane,
                               RegionBSPTree2D region)

Construct a new instance from its defining plane and subspace region.

Parameters:

plane - plane containing the subset

region - subspace region for the plane subset

Method Detail

getEmbedded

public 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

getSubspaceRegion

public RegionBSPTree2D getSubspaceRegion()

toConvex

public List<PlaneConvexSubset> toConvex()

toTriangles

public 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

getBounds

public 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

split

public Split<EmbeddedTreePlaneSubset> split(Hyperplane<Vector3D> splitter)

In all cases, the current instance is not modified. However, In order to avoid unnecessary copying, this method will use the current instance as the split value when the instance lies entirely on the plus or minus side of the splitter. For example, if this instance lies entirely on the minus side of the splitter, the plane subset returned by Split.getMinus() will be this instance. Similarly, Split.getPlus() will return the current instance if it lies entirely on the plus side. Callers need to make special note of this, since this class is mutable.

transform

public EmbeddedTreePlaneSubset transform(Transform<Vector3D> transform)

add

public void add(PlaneConvexSubset subset)

Add a plane convex subset to this instance.

Parameters:

subset - plane convex subset to add

Throws:

IllegalArgumentException - if the given plane subset is not from a plane equivalent to this instance

add

public void add(EmbeddedTreePlaneSubset subset)

Add a plane subset to this instance.

Parameters:

subset - plane subset to add

Throws:

IllegalArgumentException - if the given plane subset is not from a plane equivalent to this instance

getPlane

public EmbeddingPlane getPlane()

Get the plane embedding the subspace region.

Specified by:

getPlane in interface PlaneSubset

Specified by:

getPlane in interface PlaneSubset.Embedded

Returns:

the plane embedding the subspace region

See Also:

PlaneSubset.getHyperplane()

getHyperplane

public EmbeddingPlane getHyperplane()

Specified by:

getHyperplane in interface HyperplaneSubset<Vector3D>

Specified by:

getHyperplane in interface PlaneSubset

isFull

public boolean isFull()

Specified by:

isFull in interface HyperplaneSubset<Vector3D>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface HyperplaneSubset<Vector3D>

getSize

public double getSize()

Specified by:

getSize in interface Sized

getCentroid

public Vector3D getCentroid()

Specified by:

getCentroid in interface HyperplaneSubset<Vector3D>

toSpace

public Vector3D toSpace(Vector2D pt)

Specified by:

toSpace in interface Embedding<Vector3D,Vector2D>

toSubspace

public Vector2D toSubspace(Vector3D pt)

Specified by:

toSubspace in interface Embedding<Vector3D,Vector2D>

classify

public RegionLocation classify(Vector3D pt)

Specified by:

classify in interface HyperplaneSubset<Vector3D>

closest

public Vector3D closest(Vector3D pt)

Specified by:

closest in interface HyperplaneSubset<Vector3D>

toString

public String toString()

Overrides:

toString in class Object

getBoundsFromSubspace

protected Bounds3D getBoundsFromSubspace(BoundarySource2D src)

Compute 3D bounds from a subspace boundary source.

Parameters:

src - subspace boundary source

Returns:

3D bounds from the given embedded subspace boundary source or null if no valid bounds could be determined

intersection

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

Specified by:

intersection in interface PlaneSubset

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

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

Specified by:

intersection in interface PlaneSubset

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)