package org.djutils.draw.bounds;
   
   import java.io.Serializable;
   import java.util.Arrays;
   import java.util.Collection;
   import java.util.Iterator;
   import java.util.Locale;
   
   import org.djutils.draw.Drawable3d;
  import org.djutils.draw.point.Point3d;
  import org.djutils.exceptions.Throw;
  
  /**
   * Bounds3d is the generic class for the 3D extent of an object. It is an immutable object.
   * <p>
   * Copyright (c) 2020-2025 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
   * BSD-style license. See <a href="https://djutils.org/docs/current/djutils/licenses.html">DJUTILS License</a>.
   * </p>
   * @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
   * @author <a href="https://github.com/peter-knoppers">Peter Knoppers</a>
   * @author <a href="https://github.com/wjschakel">Wouter Schakel</a>
   */
  public class Bounds3d implements Serializable, Drawable3d, Bounds<Bounds3d, Point3d>
  {
      /** */
      private static final long serialVersionUID = 2020829L;
  
      /** The lower bound for x. */
      private final double minX;
  
      /** The lower bound for y. */
      private final double minY;
  
      /** The lower bound for z. */
      private final double minZ;
  
      /** The upper bound for x. */
      private final double maxX;
  
      /** The upper bound for y. */
      private final double maxY;
  
      /** The upper bound for z. */
      private final double maxZ;
  
      /**
       * Construct a Bounds3d by providing all lower and upper bounds.
       * @param minX the lower bound for x
       * @param maxX the upper bound for x
       * @param minY the lower bound for y
       * @param maxY the upper bound for y
       * @param minZ the lower bound for z
       * @param maxZ the upper bound for z
       * @throws ArithmeticException when <code>minX</code>, <code>maxX</code>, <code>minY</code>,
       *             <code>maxY</code>,<code>minZ</code>, or <code>maxZ</code> is <code>NaN</code>
       * @throws IllegalArgumentException when <code>minX</code> &gt; <code>maxX</code>, <code>minY</code> &gt; <code>maxY</code>,
       *             or <code>minZ</code> &gt; <code>maxZ</code>
       */
      public Bounds3d(final double minX, final double maxX, final double minY, final double maxY, final double minZ,
              final double maxZ)
      {
          Throw.whenNaN(minX, "minX");
          Throw.whenNaN(maxX, "maxX");
          Throw.whenNaN(minY, "minY");
          Throw.whenNaN(maxY, "maxY");
          Throw.whenNaN(minZ, "minZ");
          Throw.whenNaN(maxZ, "maxZ");
          Throw.when(minX > maxX || minY > maxY || minZ > maxZ, IllegalArgumentException.class,
                  "lower bound for each dimension should be less than or equal to its upper bound");
          this.minX = minX;
          this.minY = minY;
          this.minZ = minZ;
          this.maxX = maxX;
          this.maxY = maxY;
          this.maxZ = maxZ;
      }
  
      /**
       * Constructs a new Bounds3d around the origin (0, 0, 0).
       * @param deltaX the deltaX value around the origin
       * @param deltaY the deltaY value around the origin
       * @param deltaZ the deltaZ value around the origin
       * @throws ArithmeticException when <code>deltaX</code>, <code>deltaY</code>, or <code>deltaZ</code> is <code>NaN</code>
       * @throws IllegalArgumentException when <code>deltaX &lt; 0.0</code>, <code>deltaY &lt; 0.0</code>, or <code>deltaZ &lt;
       *             0.0</code>
       */
      public Bounds3d(final double deltaX, final double deltaY, final double deltaZ)
      {
          this(-0.5 * deltaX, 0.5 * deltaX, -0.5 * deltaY, 0.5 * deltaY, -0.5 * deltaZ, 0.5 * deltaZ);
      }
  
      /**
       * Construct a Bounds3d from some collection of points, finding the lowest and highest x and y coordinates.
       * @param points the array of points to construct a Bounds3d from
       * @throws NullPointerException when <code>points</code> is <code>null</code>
       * @throws IllegalArgumentException when the <code>points</code> iterator provides zero points
       */
      public Bounds3d(final Iterator<? extends Point3d> points)
      {
         Throw.whenNull(points, "points");
         Throw.when(!points.hasNext(), IllegalArgumentException.class, "need at least one point");
         Point3d point = points.next();
         double tempMinX = point.x;
         double tempMaxX = point.x;
         double tempMinY = point.y;
         double tempMaxY = point.y;
         double tempMinZ = point.z;
         double tempMaxZ = point.z;
         while (points.hasNext())
         {
             point = points.next();
             tempMinX = Math.min(tempMinX, point.x);
             tempMaxX = Math.max(tempMaxX, point.x);
             tempMinY = Math.min(tempMinY, point.y);
             tempMaxY = Math.max(tempMaxY, point.y);
             tempMinZ = Math.min(tempMinZ, point.z);
             tempMaxZ = Math.max(tempMaxZ, point.z);
         }
         this.minX = tempMinX;
         this.maxX = tempMaxX;
         this.minY = tempMinY;
         this.maxY = tempMaxY;
         this.minZ = tempMinZ;
         this.maxZ = tempMaxZ;
     }
 
     /**
      * Construct a Bounds3d from an array of Point3d, finding the lowest and highest x, y and z coordinates.
      * @param points the points to construct a Bounds3d from
      * @throws NullPointerException when <code>points</code> is <code>null</code>
      * @throws IllegalArgumentException when zero points are provided
      */
     public Bounds3d(final Point3d[] points)
     {
         this(Arrays.stream(Throw.whenNull(points, "points")).iterator());
     }
 
     /**
      * Construct a Bounds3d for a Drawable3d.
      * @param drawable3d any object that implements the Drawable2d interface
      * @throws NullPointerException when <code>drawable3d</code> is <code>null</code>
      */
     public Bounds3d(final Drawable3d drawable3d) throws NullPointerException
     {
         this(Throw.whenNull(drawable3d, "drawable3d").iterator());
     }
 
     /**
      * Construct a Bounds3d for several Drawable2d objects.
      * @param drawable3d the Drawable2d objects
      * @throws NullPointerException when the <code>drawable3d</code> array is <code>null</code>, or contains a <code>null</code>
      *             value
      * @throws IllegalArgumentException when the length of the <code>drawable3d</code> array is 0
      */
     public Bounds3d(final Drawable3d... drawable3d)
     {
         this(pointsOf(drawable3d));
     }
 
     /**
      * Return an iterator that will return all points of one or more Drawable objects.
      * @param drawable3d the Drawable objects
      * @return iterator that will return all points of the Drawable objects
      * @throws NullPointerException when <code>drawable3darray</code> is <code>null</code>
      * @throws IllegalArgumentException when the <code>drawable3dArray</code> contains 0 elements
      */
     public static Iterator<Point3d> pointsOf(final Drawable3d... drawable3d)
     {
         return new Iterator<Point3d>()
         {
             /** Index in the argument array. */
             private int nextArgument = 0;
 
             /** Iterator over the Point2d objects in the current Drawable2d. */
             private Iterator<? extends Point3d> currentIterator = ensureHasOne(drawable3d)[0].iterator();
 
             @Override
             public boolean hasNext()
             {
                 return this.nextArgument < drawable3d.length - 1 || this.currentIterator.hasNext();
             }
 
             @Override
             public Point3d next()
             {
                 if (this.currentIterator.hasNext())
                 {
                     return this.currentIterator.next();
                 }
                 // Move to next Drawable2d
                 this.nextArgument++;
                 this.currentIterator = drawable3d[this.nextArgument].iterator();
                 return this.currentIterator.next(); // Cannot fail because every Drawable has at least one point
             }
         };
     }
 
     /**
      * Verify that the array contains at least one entry.
      * @param drawable3dArray array of Drawable2d objects
      * @return the array
      * @throws NullPointerException when the <code>drawable3dArray</code> is <code>null</code>
      * @throws IllegalArgumentException when the <code>drawable3dArray</code> contains 0 elements
      */
     static Drawable3d[] ensureHasOne(final Drawable3d[] drawable3dArray)
     {
         Throw.whenNull(drawable3dArray, "drawable3dArray");
         Throw.when(drawable3dArray.length == 0, IllegalArgumentException.class, "Array must contain at least one value");
         return drawable3dArray;
     }
 
     /**
      * Construct a Bounds3d for a Collection of Drawable2d objects.
      * @param drawableCollection the collection
      * @throws NullPointerException when the <code>drawableCollection</code> is <code>null</code>, or contains <code>null</code>
      *             values
      * @throws IllegalArgumentException when the <code>drawableCollection</code> is empty
      */
     public Bounds3d(final Collection<Drawable3d> drawableCollection)
     {
         this(pointsOf(drawableCollection));
     }
 
     /**
      * Return an iterator that will return all points of one or more Drawable3d objects.
      * @param drawableCollection the collection of Drawable2d objects
      * @return iterator that will return all points of the Drawable objects
      * @throws NullPointerException when the <code>drawableCollection</code> is <code>null</code>, or contains a
      *             <code>null</code> value
      * @throws IllegalArgumentException when the <code>drawableCollection</code> is empty
      */
     public static Iterator<Point3d> pointsOf(final Collection<Drawable3d> drawableCollection)
     {
         return new Iterator<Point3d>()
         {
             /** Iterator that iterates over the collection. */
             private Iterator<Drawable3d> collectionIterator = ensureHasOne(drawableCollection.iterator());
 
             /** Iterator that generates Point2d objects for the currently selected element of the collection. */
             private Iterator<? extends Point3d> currentIterator = this.collectionIterator.next().iterator();
 
             @Override
             public boolean hasNext()
             {
                 if (this.currentIterator == null)
                 {
                     return false;
                 }
                 return this.currentIterator.hasNext();
             }
 
             @Override
             public Point3d next()
             {
                 Point3d result = this.currentIterator.next();
                 if (!this.currentIterator.hasNext())
                 {
                     if (this.collectionIterator.hasNext())
                     {
                         this.currentIterator = this.collectionIterator.next().iterator();
                     }
                     else
                     {
                         this.currentIterator = null;
                     }
                 }
                 return result;
             }
         };
     }
 
     /**
      * Verify that the iterator has something to return.
      * @param iterator the iterator
      * @return the iterator
      * @throws NullPointerException when the <code>iterator</code> is <code>null</code>
      * @throws IllegalArgumentException when the <code>hasNext</code> method of the <code>iterator</code> returns
      *             <code>false</code> before even one <code>Drawable2d</code> was delivered
      */
     static Iterator<Drawable3d> ensureHasOne(final Iterator<Drawable3d> iterator)
     {
         Throw.when(!iterator.hasNext(), IllegalArgumentException.class, "Collection may not be empty");
         return iterator;
     }
 
     @Override
     public Iterator<Point3d> iterator()
     {
         Point3d[] array =
                 new Point3d[] {new Point3d(this.minX, this.minY, this.minZ), new Point3d(this.minX, this.minY, this.maxZ),
                         new Point3d(this.minX, this.maxY, this.minZ), new Point3d(this.minX, this.maxY, this.maxZ),
                         new Point3d(this.maxX, this.minY, this.minZ), new Point3d(this.maxX, this.minY, this.maxZ),
                         new Point3d(this.maxX, this.maxY, this.minZ), new Point3d(this.maxX, this.maxY, this.maxZ)};
         return Arrays.stream(array).iterator();
     }
 
     @Override
     public int size()
     {
         return 8;
     }
 
     /**
      * Check if this Bounds3d contains a point. Contains returns false when the point is on the surface of this Bounds3d.
      * @param x the x-coordinate of the point
      * @param y the y-coordinate of the point
      * @param z the z-coordinate of the point
      * @return whether this Bounds3d contains the point
      * @throws ArithmeticException when <code>x</code>, or <code>y</code> is <code>NaN</code>
      */
     public boolean contains(final double x, final double y, final double z)
     {
         Throw.whenNaN(x, "x");
         Throw.whenNaN(y, "y");
         Throw.whenNaN(z, "z");
         return x > this.minX && x < this.maxX && y > this.minY && y < this.maxY && z > this.minZ && z < this.maxZ;
     }
 
     @Override
     public boolean contains(final Point3d point)
     {
         Throw.whenNull(point, "point");
         return contains(point.x, point.y, point.z);
     }
 
     @Override
     public boolean contains(final Bounds3d otherBounds) throws NullPointerException
     {
         Throw.whenNull(otherBounds, "otherBounds");
         return contains(otherBounds.minX, otherBounds.minY, otherBounds.minZ)
                 && contains(otherBounds.maxX, otherBounds.maxY, otherBounds.maxZ);
     }
 
     /**
      * Check if this Bounds3d contains a point. Covers returns <code>true</code> when the point is on a face of this Bounds3d.
      * @param x the x-coordinate of the point
      * @param y the y-coordinate of the point
      * @param z the z-coordinate of the point
      * @return whether the bounding box contains the point, including the faces
      * @throws ArithmeticException when <code>x</code>, <code>y</code>, or <code>z</code> is <code>NaN</code>
      */
     public boolean covers(final double x, final double y, final double z)
     {
         Throw.whenNaN(x, "x");
         Throw.whenNaN(y, "y");
         Throw.whenNaN(z, "z");
         return x >= this.minX && x <= this.maxX && y >= this.minY && y <= this.maxY && z >= this.minZ && z <= this.maxZ;
     }
 
     @Override
     public boolean covers(final Point3d point)
     {
         Throw.whenNull(point, "point");
         return covers(point.x, point.y, point.z);
     }
 
     @Override
     public boolean covers(final Bounds3d otherBounds)
     {
         Throw.whenNull(otherBounds, "otherBounds");
         return covers(otherBounds.minX, otherBounds.minY, otherBounds.minZ)
                 && covers(otherBounds.maxX, otherBounds.maxY, otherBounds.maxZ);
     }
 
     @Override
     public boolean disjoint(final Bounds3d otherBounds)
     {
         Throw.whenNull(otherBounds, "otherBounds");
         return otherBounds.minX > this.maxX || otherBounds.maxX < this.minX || otherBounds.minY > this.maxY
                 || otherBounds.maxY < this.minY || otherBounds.minZ > this.maxZ || otherBounds.maxZ < this.minZ;
     }
 
     @Override
     public boolean intersects(final Bounds3d otherBounds3d)
     {
         return !disjoint(otherBounds3d);
     }
 
     @Override
     public Bounds3d intersection(final Bounds3d otherBounds3d)
     {
         Throw.whenNull(otherBounds3d, "otherBounds3d");
         if (disjoint(otherBounds3d))
         {
             return null;
         }
         return new Bounds3d(Math.max(this.minX, otherBounds3d.minX), Math.min(this.maxX, otherBounds3d.maxX),
                 Math.max(this.minY, otherBounds3d.minY), Math.min(this.maxY, otherBounds3d.maxY),
                 Math.max(this.minZ, otherBounds3d.minZ), Math.min(this.maxZ, otherBounds3d.maxZ));
     }
 
     @Override
     public Bounds2d project()
     {
         return new Bounds2d(this.minX, this.maxX, this.minY, this.maxY);
     }
 
     /**
      * Return the extent of this Bounds3d in the z-direction.
      * @return the extent of this Bounds3d in the z-direction
      */
     public double getDeltaZ()
     {
         return getMaxZ() - getMinZ();
     }
 
     /**
      * Return the volume of this Bounds3d.
      * @return the volume of this Bounds3d
      */
     public double getVolume()
     {
         return getDeltaX() * getDeltaY() * getDeltaZ();
     }
 
     @Override
     public double getMinX()
     {
         return this.minX;
     }
 
     @Override
     public double getMaxX()
     {
         return this.maxX;
     }
 
     @Override
     public double getMinY()
     {
         return this.minY;
     }
 
     @Override
     public double getMaxY()
     {
         return this.maxY;
     }
 
     /**
      * Return the lower bound for z.
      * @return the lower bound for z
      */
     public double getMinZ()
     {
         return this.minZ;
     }
 
     /**
      * Return the upper bound for z.
      * @return the upper bound for z
      */
     public double getMaxZ()
     {
         return this.maxZ;
     }
 
     @Override
     public Point3d midPoint()
     {
         return new Point3d((this.minX + this.maxX) / 2, (this.minY + this.maxY) / 2, (this.minZ + this.maxZ) / 2);
     }
 
     @Override
     public Bounds3d getBounds()
     {
         return this;
     }
 
     @Override
     public String toString()
     {
         return toString("%f", false);
     }
 
     @Override
     public String toString(final String doubleFormat, final boolean doNotIncludeClassName)
     {
         String format = String.format("%1$s[x[%2$s : %2$s], y[%2$s : %2$s, z[%2$s : %2$s]]",
                 doNotIncludeClassName ? "" : "Bounds3d ", doubleFormat);
         return String.format(Locale.US, format, this.minX, this.maxX, this.minY, this.maxY, this.minZ, this.maxZ);
     }
 
     @Override
     public int hashCode()
     {
         final int prime = 31;
         int result = 1;
         long temp;
         temp = Double.doubleToLongBits(this.maxX);
         result = prime * result + (int) (temp ^ (temp >>> 32));
         temp = Double.doubleToLongBits(this.maxY);
         result = prime * result + (int) (temp ^ (temp >>> 32));
         temp = Double.doubleToLongBits(this.maxZ);
         result = prime * result + (int) (temp ^ (temp >>> 32));
         temp = Double.doubleToLongBits(this.minX);
         result = prime * result + (int) (temp ^ (temp >>> 32));
         temp = Double.doubleToLongBits(this.minY);
         result = prime * result + (int) (temp ^ (temp >>> 32));
         temp = Double.doubleToLongBits(this.minZ);
         result = prime * result + (int) (temp ^ (temp >>> 32));
         return result;
     }
 
     @SuppressWarnings("checkstyle:needbraces")
     @Override
     public boolean equals(final Object obj)
     {
         if (this == obj)
             return true;
         if (obj == null)
             return false;
         if (getClass() != obj.getClass())
             return false;
         Bounds3d other = (Bounds3d) obj;
         if (Double.doubleToLongBits(this.maxX) != Double.doubleToLongBits(other.maxX))
             return false;
         if (Double.doubleToLongBits(this.maxY) != Double.doubleToLongBits(other.maxY))
             return false;
         if (Double.doubleToLongBits(this.maxZ) != Double.doubleToLongBits(other.maxZ))
             return false;
         if (Double.doubleToLongBits(this.minX) != Double.doubleToLongBits(other.minX))
             return false;
         if (Double.doubleToLongBits(this.minY) != Double.doubleToLongBits(other.minY))
             return false;
         if (Double.doubleToLongBits(this.minZ) != Double.doubleToLongBits(other.minZ))
             return false;
         return true;
     }
 
 }