org.apache.commons.geometry.euclidean.threed

Class ConvexVolume

java.lang.Object

org.apache.commons.geometry.core.partitioning.AbstractConvexHyperplaneBoundedRegion<Vector3D,PlaneConvexSubset>

org.apache.commons.geometry.euclidean.threed.ConvexVolume

All Implemented Interfaces:

BoundarySource<PlaneConvexSubset>, HyperplaneBoundedRegion<Vector3D>, Splittable<Vector3D,HyperplaneBoundedRegion<Vector3D>>, Region<Vector3D>, Sized, BoundarySource3D, Linecastable3D

Direct Known Subclasses:

Parallelepiped

public class ConvexVolume
extends AbstractConvexHyperplaneBoundedRegion<Vector3D,PlaneConvexSubset>
implements BoundarySource3D

Class representing a finite or infinite convex volume in Euclidean 3D space. The boundaries of this area, if any, are composed of plane convex subsets.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.geometry.core.partitioning.AbstractConvexHyperplaneBoundedRegion

AbstractConvexHyperplaneBoundedRegion.ConvexRegionBoundaryBuilder<P extends Point<P>,S extends HyperplaneConvexSubset<P>>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConvexVolume(List<PlaneConvexSubset> boundaries) Simple constructor.

Method Summary

Modifier and Type	Method and Description
Stream<PlaneConvexSubset>	boundaryStream()
static ConvexVolume	fromBounds(Iterable<? extends Plane> boundingPlanes) Create a convex volume formed by the intersection of the negative half-spaces of the given bounding planes.
static ConvexVolume	fromBounds(Plane... planes) Create a convex volume formed by the intersection of the negative half-spaces of the given bounding planes.
static ConvexVolume	full() Return an instance representing the full 3D volume.
Vector3D	getCentroid()
double	getSize()
Split<ConvexVolume>	split(Hyperplane<Vector3D> splitter)
RegionBSPTree3D	toTree() Return a BSP tree constructed from the boundaries contained in this instance.
ConvexVolume	transform(Transform<Vector3D> transform) Return a new instance transformed by the argument.
PlaneConvexSubset	trim(HyperplaneConvexSubset<Vector3D> convexSubset)

Methods inherited from class org.apache.commons.geometry.core.partitioning.AbstractConvexHyperplaneBoundedRegion

classify, getBoundaries, getBoundarySize, isEmpty, isFull, project, splitInternal, swapsInsideOutside, toString, transformInternal

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.euclidean.threed.BoundarySource3D

getBounds, linecast, linecastFirst, of, of, toList, toTriangleMesh, triangleStream

Methods inherited from interface org.apache.commons.geometry.euclidean.threed.line.Linecastable3D

linecast, linecastFirst

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

contains

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

isFinite, isInfinite

Constructor Detail

ConvexVolume

protected ConvexVolume(List<PlaneConvexSubset> boundaries)

Simple constructor. Callers are responsible for ensuring that the given path represents the boundary of a convex area. No validation is performed.

Parameters:

boundaries - the boundaries of the convex area

Method Detail

boundaryStream

public Stream<PlaneConvexSubset> boundaryStream()

Specified by:

boundaryStream in interface BoundarySource<PlaneConvexSubset>

getSize

public double getSize()

Specified by:

getSize in interface Sized

getCentroid

public Vector3D getCentroid()

Specified by:

getCentroid in interface Region<Vector3D>

split

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

Specified by:

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

toTree

public RegionBSPTree3D toTree()

Return a BSP tree constructed from the boundaries contained in this instance. This is a convenience method for quickly constructing BSP trees and may produce unbalanced trees with unacceptable performance characteristics when used with large numbers of boundaries. In these cases, alternate tree construction approaches should be used, such as RegionBSPTree3D.PartitionedRegionBuilder3D.

Specified by:

toTree in interface BoundarySource3D

Returns:

a BSP tree constructed from the boundaries in this instance

See Also:

RegionBSPTree3D.partitionedRegionBuilder()

trim

public PlaneConvexSubset trim(HyperplaneConvexSubset<Vector3D> convexSubset)

Overrides:

trim in class AbstractConvexHyperplaneBoundedRegion<Vector3D,PlaneConvexSubset>

transform

public ConvexVolume transform(Transform<Vector3D> transform)

Return a new instance transformed by the argument.

Parameters:

transform - transform to apply

Returns:

a new instance transformed by the argument

full

public static ConvexVolume full()

Return an instance representing the full 3D volume.

Returns:

an instance representing the full 3D volume.

fromBounds

public static ConvexVolume fromBounds(Plane... planes)

Create a convex volume formed by the intersection of the negative half-spaces of the given bounding planes. The returned instance represents the volume that is on the minus side of all of the given plane. Note that this method does not support volumes of zero size (ie, infinitely thin volumes or points.)

Parameters:

planes - planes used to define the convex area

Returns:

a new convex volume instance representing the volume on the minus side of all of the bounding plane or an instance representing the full space if the collection is empty

Throws:

IllegalArgumentException - if the given set of bounding planes do not form a convex volume, meaning that there is no region that is on the minus side of all of the bounding planes.

fromBounds

public static ConvexVolume fromBounds(Iterable<? extends Plane> boundingPlanes)

Create a convex volume formed by the intersection of the negative half-spaces of the given bounding planes. The returned instance represents the volume that is on the minus side of all of the given plane. Note that this method does not support volumes of zero size (ie, infinitely thin volumes or points.)

Parameters:

boundingPlanes - planes used to define the convex area

Returns:

a new convex volume instance representing the volume on the minus side of all of the bounding plane or an instance representing the full space if the collection is empty

Throws:

IllegalArgumentException - if the given set of bounding planes do not form a convex volume, meaning that there is no region that is on the minus side of all of the bounding planes.