Class AbstractEmbeddedRegionPlaneSubset

java.lang.Object
org.apache.commons.geometry.euclidean.threed.AbstractPlaneSubset
org.apache.commons.geometry.euclidean.threed.AbstractEmbeddedRegionPlaneSubset
All Implemented Interfaces:
Embedding<Vector3D,Vector2D>, HyperplaneSubset<Vector3D>, Splittable<Vector3D, HyperplaneSubset<Vector3D>>, RegionEmbedding<Vector3D,Vector2D>, Sized, PlaneSubset, PlaneSubset.Embedded
Direct Known Subclasses:
EmbeddedAreaPlaneConvexSubset, EmbeddedTreePlaneSubset
abstract class AbstractEmbeddedRegionPlaneSubset extends AbstractPlaneSubset implements PlaneSubset.Embedded
Base class for PlaneSubset implementations that use an embedded subspace region to define their plane subsets.

  • Field Details

    • plane

      private final EmbeddingPlane plane
      The plane containing the embedded region.

  • Constructor Details

    • AbstractEmbeddedRegionPlaneSubset

      AbstractEmbeddedRegionPlaneSubset(EmbeddingPlane plane)
      Construct a new instance in the given plane.
      Parameters:
      plane - plane containing the subset

  • Method Details

    • getPlane

      public EmbeddingPlane getPlane()
      Get the plane containing this subset. This is equivalent to PlaneSubset.getHyperplane().
      Specified by:
      getPlane in interface PlaneSubset
      Specified by:
      getPlane in interface PlaneSubset.Embedded
      Returns:
      the plane containing this subset
      See Also:

    • getHyperplane

      public EmbeddingPlane getHyperplane()
      Get the hyperplane containing this instance.
      Specified by:
      getHyperplane in interface HyperplaneSubset<Vector3D>
      Specified by:
      getHyperplane in interface PlaneSubset
      Overrides:
      getHyperplane in class AbstractPlaneSubset
      Returns:
      the hyperplane containing this instance

    • isFull

      public boolean isFull()
      Return true if this instance contains all points in the hyperplane.
      Specified by:
      isFull in interface HyperplaneSubset<Vector3D>
      Returns:
      true if this instance contains all points in the hyperplane

    • isEmpty

      public boolean isEmpty()
      Return true if this instance does not contain any points.
      Specified by:
      isEmpty in interface HyperplaneSubset<Vector3D>
      Returns:
      true if this instance does not contain any points

    • getSize

      public double getSize()
      Get the size of the instance.
      Specified by:
      getSize in interface Sized
      Returns:
      the size of the instance

    • getCentroid

      public Vector3D getCentroid()
      Get the centroid, or geometric center, of the hyperplane subset or null if no centroid exists or one exists but is not unique. A centroid will not exist for empty or infinite subsets.

      The centroid of a geometric object is defined as the mean position of all points in the object, including interior points, vertices, and other points lying on the boundary. If a physical object has a uniform density, then its center of mass is the same as its geometric centroid.

      Specified by:
      getCentroid in interface HyperplaneSubset<Vector3D>
      Returns:
      the centroid of the hyperplane subset or null if no unique centroid exists
      See Also:

    • toSpace

      public Vector3D toSpace(Vector2D pt)
      Transform a subspace point into a space point.
      Specified by:
      toSpace in interface Embedding<Vector3D,Vector2D>
      Parameters:
      pt - lower-dimension point of the subspace
      Returns:
      n-dimension point of the space corresponding to the specified subspace point
      See Also:

    • toSubspace

      public Vector2D toSubspace(Vector3D pt)
      Transform a space point into a subspace point.
      Specified by:
      toSubspace in interface Embedding<Vector3D,Vector2D>
      Parameters:
      pt - n-dimension point of the space
      Returns:
      lower-dimension point of the subspace corresponding to the specified space point
      See Also:

    • classify

      public RegionLocation classify(Vector3D pt)
      Classify a point with respect to the subset region. The point is classified as follows:
      • INSIDE - The point lies on the hyperplane and inside of the subset region.
      • BOUNDARY - The point lies on the hyperplane and is on the boundary of the subset region.
      • OUTSIDE - The point does not lie on the hyperplane or it does lie on the hyperplane but is outside of the subset region.
      Specified by:
      classify in interface HyperplaneSubset<Vector3D>
      Parameters:
      pt - the point to classify
      Returns:
      classification of the point with respect to the hyperplane and subspace region

    • closest

      public Vector3D closest(Vector3D pt)
      Return the closest point to the argument that is contained in the subset (ie, not classified as outside), or null if no such point exists.
      Specified by:
      closest in interface HyperplaneSubset<Vector3D>
      Parameters:
      pt - the reference point
      Returns:
      the closest point to the reference point that is contained in the subset, or null if no such point exists

    • 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