PolyhedronsSet (Apache Commons Math 3.6.1 API)

org.apache.commons.math3.geometry.euclidean.threed

## Class PolyhedronsSet

- java.lang.Object
- - org.apache.commons.math3.geometry.partitioning.AbstractRegion<Euclidean3D,Euclidean2D>
  - - org.apache.commons.math3.geometry.euclidean.threed.PolyhedronsSet

- All Implemented Interfaces:
    Region<Euclidean3D>

      public class PolyhedronsSet
      extends AbstractRegion<Euclidean3D,Euclidean2D>

  This class represents a 3D region: a set of polyhedrons.
  Since:
    3.0

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from interface org.apache.commons.math3.geometry.partitioning.Region

      `Region.Location`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `PolyhedronsSet()` Deprecated. as of 3.3, replaced with `PolyhedronsSet(double)`
    `PolyhedronsSet(BSPTree<Euclidean3D> tree)` Deprecated. as of 3.3, replaced with `PolyhedronsSet(BSPTree, double)`
    `PolyhedronsSet(BSPTree<Euclidean3D> tree, double tolerance)` Build a polyhedrons set from a BSP tree.
    `PolyhedronsSet(Collection<SubHyperplane<Euclidean3D>> boundary)` Deprecated. as of 3.3, replaced with `PolyhedronsSet(Collection, double)`
    `PolyhedronsSet(Collection<SubHyperplane<Euclidean3D>> boundary, double tolerance)` Build a polyhedrons set from a Boundary REPresentation (B-rep) specified by sub-hyperplanes.
    `PolyhedronsSet(double tolerance)` Build a polyhedrons set representing the whole real line.
    `PolyhedronsSet(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)` Deprecated. as of 3.3, replaced with `PolyhedronsSet(double, double, double, double, double, double, double)`
    `PolyhedronsSet(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax, double tolerance)` Build a parallellepipedic box.
    `PolyhedronsSet(List<Vector3D> vertices, List<int[]> facets, double tolerance)` Build a polyhedrons set from a Boundary REPresentation (B-rep) specified by connected vertices.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `PolyhedronsSet` | `buildNew(BSPTree<Euclidean3D> tree)` Build a region using the instance as a prototype.
    `protected void` | `computeGeometricalProperties()` Compute some geometrical properties.
    `SubHyperplane<Euclidean3D>` | `firstIntersection(Vector3D point, Line line)` Get the first sub-hyperplane crossed by a semi-infinite line.
    `PolyhedronsSet` | `rotate(Vector3D center, Rotation rotation)` Rotate the region around the specified point.
    `PolyhedronsSet` | `translate(Vector3D translation)` Translate the region by the specified amount.

    - ### Methods inherited from class org.apache.commons.math3.geometry.partitioning.AbstractRegion

      `applyTransform, checkPoint, checkPoint, checkPoint, checkPoint, contains, copySelf, getBarycenter, getBoundarySize, getSize, getTolerance, getTree, intersection, isEmpty, isEmpty, isFull, isFull, projectToBoundary, setBarycenter, setBarycenter, setSize, side`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### PolyhedronsSet

          public PolyhedronsSet(double tolerance)

      Build a polyhedrons set representing the whole real line.
      Parameters:
        `tolerance` - tolerance below which points are considered identical
      Since:
        3.3

    - #### PolyhedronsSet

          public PolyhedronsSet(BSPTree<Euclidean3D> tree,
                        double tolerance)

      Build a polyhedrons set from a BSP tree.

      The leaf nodes of the BSP tree must have a `Boolean` attribute representing the inside status of the corresponding cell (true for inside cells, false for outside cells). In order to avoid building too many small objects, it is recommended to use the predefined constants `Boolean.TRUE` and `Boolean.FALSE`

      This constructor is aimed at expert use, as building the tree may be a difficult task. It is not intended for general use and for performances reasons does not check thoroughly its input, as this would require walking the full tree each time. Failing to provide a tree with the proper attributes, will therefore generate problems like `NullPointerException` or `ClassCastException` only later on. This limitation is known and explains why this constructor is for expert use only. The caller does have the responsibility to provided correct arguments.

      Parameters:
        `tree` - inside/outside BSP tree representing the region
        `tolerance` - tolerance below which points are considered identical
      Since:
        3.3

    - #### PolyhedronsSet

          public PolyhedronsSet(Collection<SubHyperplane<Euclidean3D>> boundary,
                        double tolerance)

      Build a polyhedrons set from a Boundary REPresentation (B-rep) specified by sub-hyperplanes.

      The boundary is provided as a collection of `sub-hyperplanes`. Each sub-hyperplane has the interior part of the region on its minus side and the exterior on its plus side.

      The boundary elements can be in any order, and can form several non-connected sets (like for example polyhedrons with holes or a set of disjoint polyhedrons considered as a whole). In fact, the elements do not even need to be connected together (their topological connections are not used here). However, if the boundary does not really separate an inside open from an outside open (open having here its topological meaning), then subsequent calls to the `checkPoint` method will not be meaningful anymore.

      If the boundary is empty, the region will represent the whole space.

      Parameters:
        `boundary` - collection of boundary elements, as a collection of `SubHyperplane` objects
        `tolerance` - tolerance below which points are considered identical
      Since:
        3.3

    - #### PolyhedronsSet

          public PolyhedronsSet(List<Vector3D> vertices,
                        List<int[]> facets,
                        double tolerance)

      Build a polyhedrons set from a Boundary REPresentation (B-rep) specified by connected vertices.

      The boundary is provided as a list of vertices and a list of facets. Each facet is specified as an integer array containing the arrays vertices indices in the vertices list. Each facet normal is oriented by right hand rule to the facet vertices list.

      Some basic sanity checks are performed but not everything is thoroughly assessed, so it remains under caller responsibility to ensure the vertices and facets are consistent and properly define a polyhedrons set.

      Parameters:
        `vertices` - list of polyhedrons set vertices
        `facets` - list of facets, as vertices indices in the vertices list
        `tolerance` - tolerance below which points are considered identical
      Throws:
        `MathIllegalArgumentException` - if some basic sanity checks fail
      Since:
        3.5

    - #### PolyhedronsSet

          public PolyhedronsSet(double xMin,
                        double xMax,
                        double yMin,
                        double yMax,
                        double zMin,
                        double zMax,
                        double tolerance)

      Build a parallellepipedic box.
      Parameters:
        `xMin` - low bound along the x direction
        `xMax` - high bound along the x direction
        `yMin` - low bound along the y direction
        `yMax` - high bound along the y direction
        `zMin` - low bound along the z direction
        `zMax` - high bound along the z direction
        `tolerance` - tolerance below which points are considered identical
      Since:
        3.3

    - #### PolyhedronsSet

          @Deprecated
          public PolyhedronsSet()

      Deprecated. as of 3.3, replaced with `PolyhedronsSet(double)`
      Build a polyhedrons set representing the whole real line.

    - #### PolyhedronsSet

          @Deprecated
          public PolyhedronsSet(BSPTree<Euclidean3D> tree)

      Deprecated. as of 3.3, replaced with `PolyhedronsSet(BSPTree, double)`
      Build a polyhedrons set from a BSP tree.

      The leaf nodes of the BSP tree must have a `Boolean` attribute representing the inside status of the corresponding cell (true for inside cells, false for outside cells). In order to avoid building too many small objects, it is recommended to use the predefined constants `Boolean.TRUE` and `Boolean.FALSE`

      Parameters:
        `tree` - inside/outside BSP tree representing the region

    - #### PolyhedronsSet

          @Deprecated
          public PolyhedronsSet(Collection<SubHyperplane<Euclidean3D>> boundary)

      Deprecated. as of 3.3, replaced with `PolyhedronsSet(Collection, double)`
      Build a polyhedrons set from a Boundary REPresentation (B-rep).

      The boundary is provided as a collection of `sub-hyperplanes`. Each sub-hyperplane has the interior part of the region on its minus side and the exterior on its plus side.

      The boundary elements can be in any order, and can form several non-connected sets (like for example polyhedrons with holes or a set of disjoint polyhedrons considered as a whole). In fact, the elements do not even need to be connected together (their topological connections are not used here). However, if the boundary does not really separate an inside open from an outside open (open having here its topological meaning), then subsequent calls to the `checkPoint` method will not be meaningful anymore.

      If the boundary is empty, the region will represent the whole space.

      Parameters:
        `boundary` - collection of boundary elements, as a collection of `SubHyperplane` objects

    - #### PolyhedronsSet

          @Deprecated
          public PolyhedronsSet(double xMin,
                                   double xMax,
                                   double yMin,
                                   double yMax,
                                   double zMin,
                                   double zMax)

      Deprecated. as of 3.3, replaced with `PolyhedronsSet(double, double, double, double, double, double, double)`
      Build a parallellepipedic box.
      Parameters:
        `xMin` - low bound along the x direction
        `xMax` - high bound along the x direction
        `yMin` - low bound along the y direction
        `yMax` - high bound along the y direction
        `zMin` - low bound along the z direction
        `zMax` - high bound along the z direction

  - ### Method Detail

    - #### buildNew

          public PolyhedronsSet buildNew(BSPTree<Euclidean3D> tree)

      Build a region using the instance as a prototype.

      This method allow to create new instances without knowing exactly the type of the region. It is an application of the prototype design pattern.

      The leaf nodes of the BSP tree must have a `Boolean` attribute representing the inside status of the corresponding cell (true for inside cells, false for outside cells). In order to avoid building too many small objects, it is recommended to use the predefined constants `Boolean.TRUE` and `Boolean.FALSE`. The tree also must have either null internal nodes or internal nodes representing the boundary as specified in the `getTree` method).

      Specified by:
        `buildNew` in interface `Region<Euclidean3D>`
      Specified by:
        `buildNew` in class `AbstractRegion<Euclidean3D,Euclidean2D>`
      Parameters:
        `tree` - inside/outside BSP tree representing the new region
      Returns:
        the built region

    - #### computeGeometricalProperties

          protected void computeGeometricalProperties()

      Compute some geometrical properties.

      The properties to compute are the barycenter and the size.

      Specified by:
        `computeGeometricalProperties` in class `AbstractRegion<Euclidean3D,Euclidean2D>`

    - #### firstIntersection

          public SubHyperplane<Euclidean3D> firstIntersection(Vector3D point,
                                                     Line line)

      Get the first sub-hyperplane crossed by a semi-infinite line.
      Parameters:
        `point` - start point of the part of the line considered
        `line` - line to consider (contains point)
      Returns:
        the first sub-hyperplane crossed by the line after the given point, or null if the line does not intersect any sub-hyperplane

    - #### rotate

          public PolyhedronsSet rotate(Vector3D center,
                              Rotation rotation)

      Rotate the region around the specified point.

      The instance is not modified, a new instance is created.

      Parameters:
        `center` - rotation center
        `rotation` - vectorial rotation operator
      Returns:
        a new instance representing the rotated region

    - #### translate

          public PolyhedronsSet translate(Vector3D translation)

      Translate the region by the specified amount.

      The instance is not modified, a new instance is created.

      Parameters:
        `translation` - translation to apply
      Returns:
        a new instance representing the translated region

Copyright © 2003–2016 The Apache Software Foundation. All rights reserved.