org.apache.commons.geometry.euclidean.threed.shape

Class Parallelepiped

java.lang.Object

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

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

org.apache.commons.geometry.euclidean.threed.shape.Parallelepiped

All Implemented Interfaces:

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

public final class Parallelepiped
extends ConvexVolume

Class representing parallelepipeds, i.e. 3 dimensional figures formed by six parallelograms. For example, cubes and rectangular prisms are parallelepipeds.

See Also:

Parallelepiped

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parallelepiped.Builder Class designed to aid construction of Parallelepiped instances.

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

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

Method Summary

Modifier and Type	Method and Description
static Parallelepiped	axisAligned(Vector3D a, Vector3D b, Precision.DoubleEquivalence precision) Return a new instance representing an axis-aligned parallelepiped, ie, a rectangular prism.
static Parallelepiped.Builder	builder(Precision.DoubleEquivalence precision) Return a new Parallelepiped.Builder instance to use for constructing parallelepipeds.
static Parallelepiped	fromTransformedUnitCube(Transform<Vector3D> transform, Precision.DoubleEquivalence precision) Construct a new instance by transforming a unit cube centered at the origin.
static Parallelepiped	unitCube(Precision.DoubleEquivalence precision) Construct a new instance representing a unit cube centered at the origin.

Methods inherited from class org.apache.commons.geometry.euclidean.threed.ConvexVolume

boundaryStream, fromBounds, fromBounds, full, getCentroid, getSize, split, toTree, transform, trim

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

Method Detail

unitCube

public static Parallelepiped unitCube(Precision.DoubleEquivalence precision)

Construct a new instance representing a unit cube centered at the origin. The vertices of this cube are:

 [
      (-0.5, -0.5, -0.5),
      (0.5, -0.5, -0.5),
      (0.5, 0.5, -0.5),
      (-0.5, 0.5, -0.5),

      (-0.5, -0.5, 0.5),
      (0.5, -0.5, 0.5),
      (0.5, 0.5, 0.5),
      (-0.5, 0.5, 0.5)
 ]
 

Parameters:

precision - precision context used to construct boundaries

Returns:

a new instance representing a unit cube centered at the origin

axisAligned

public static Parallelepiped axisAligned(Vector3D a,
                                         Vector3D b,
                                         Precision.DoubleEquivalence precision)

Return a new instance representing an axis-aligned parallelepiped, ie, a rectangular prism. The points a and b are taken to represent opposite corner points in the prism and may be specified in any order.

Parameters:

a - first corner point in the prism (opposite of b)

b - second corner point in the prism (opposite of a)

precision - precision context used to construct boundaries

Returns:

a new instance representing an axis-aligned rectangular prism

Throws:

IllegalArgumentException - if the width, height, or depth of the defined prism is zero as evaluated by the precision context.

fromTransformedUnitCube

public static Parallelepiped fromTransformedUnitCube(Transform<Vector3D> transform,
                                                     Precision.DoubleEquivalence precision)

Construct a new instance by transforming a unit cube centered at the origin. The vertices of this input cube are:

 [
      (-0.5, -0.5, -0.5),
      (0.5, -0.5, -0.5),
      (0.5, 0.5, -0.5),
      (-0.5, 0.5, -0.5),

      (-0.5, -0.5, 0.5),
      (0.5, -0.5, 0.5),
      (0.5, 0.5, 0.5),
      (-0.5, 0.5, 0.5)
 ]
 

Parameters:

transform - transform to apply to the vertices of the unit cube

precision - precision context used to construct boundaries

Returns:

a new instance created by transforming the vertices of a unit cube centered at the origin

Throws:

IllegalArgumentException - if the width, height, or depth of the defined shape is zero as evaluated by the precision context.

builder

public static Parallelepiped.Builder builder(Precision.DoubleEquivalence precision)

Return a new Parallelepiped.Builder instance to use for constructing parallelepipeds.

Parameters:

precision - precision context used to create boundaries

Returns:

a new Parallelepiped.Builder instance