Package com.io7m.jregions.core.parameterized.volumes

Class PVolumeD<S>

java.lang.Object
com.io7m.jregions.core.parameterized.volumes.PVolumeD<S>
Type Parameters:
S - A phantom type parameter indicating the coordinate space of the volume
All Implemented Interfaces:
PVolumeDType<S>, VolumeSizeValuesDType, VolumeValuesDType
public final class PVolumeD<S>
extends java.lang.Object
implements PVolumeDType<S>

A volume with double coordinates.

The coordinates of the area are given in half-closed form. That is, minimumX() refers to the minimum inclusive value on the X axis, and maximumX() refers to the maximum exclusive value on the X axis. Likewise for the Y and Z axes.

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  PVolumeD.Builder<S>
    Builds instances of type PVolumeD.

  • Method Summary

    Modifier and Type Method Description
    static <S> PVolumeD.Builder<S> builder()
    Creates a builder for PVolumeD.
    static <S> PVolumeD<S> copyOf​(PVolumeDType<S> instance)
    Creates an immutable copy of a PVolumeDType value.
    boolean equals​(java.lang.Object another)
    This instance is equal to all instances of PVolumeD that have equal attribute values.
    int hashCode()
    Computes a hash code from attributes: minimumX, maximumX, minimumY, maximumY, minimumZ, maximumZ.
    double maximumX()  
    double maximumY()  
    double maximumZ()  
    double minimumX()  
    double minimumY()  
    double minimumZ()  
    static <S> PVolumeD<S> of​(double minimumX, double maximumX, double minimumY, double maximumY, double minimumZ, double maximumZ)
    Construct a new immutable PVolumeD instance.
    java.lang.String toString()
    Prints the immutable value PVolumeD with attribute values.
    PVolumeD<S> withMaximumX​(double value)
    Copy the current immutable object by setting a value for the maximumX attribute.
    PVolumeD<S> withMaximumY​(double value)
    Copy the current immutable object by setting a value for the maximumY attribute.
    PVolumeD<S> withMaximumZ​(double value)
    Copy the current immutable object by setting a value for the maximumZ attribute.
    PVolumeD<S> withMinimumX​(double value)
    Copy the current immutable object by setting a value for the minimumX attribute.
    PVolumeD<S> withMinimumY​(double value)
    Copy the current immutable object by setting a value for the minimumY attribute.
    PVolumeD<S> withMinimumZ​(double value)
    Copy the current immutable object by setting a value for the minimumZ attribute.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.io7m.jregions.core.parameterized.volumes.PVolumeDType

    checkPreconditions

    Methods inherited from interface com.io7m.jregions.core.unparameterized.volumes.VolumeValuesDType

    sizeX, sizeY, sizeZ

  • Method Details

    • minimumX

      public double minimumX()
      Specified by:
      minimumX in interface PVolumeDType<S>
      Specified by:
      minimumX in interface VolumeValuesDType
      Returns:
      The value of the minimumX attribute

    • maximumX

      public double maximumX()
      Specified by:
      maximumX in interface PVolumeDType<S>
      Specified by:
      maximumX in interface VolumeValuesDType
      Returns:
      The value of the maximumX attribute

    • minimumY

      public double minimumY()
      Specified by:
      minimumY in interface PVolumeDType<S>
      Specified by:
      minimumY in interface VolumeValuesDType
      Returns:
      The value of the minimumY attribute

    • maximumY

      public double maximumY()
      Specified by:
      maximumY in interface PVolumeDType<S>
      Specified by:
      maximumY in interface VolumeValuesDType
      Returns:
      The value of the maximumY attribute

    • minimumZ

      public double minimumZ()
      Specified by:
      minimumZ in interface PVolumeDType<S>
      Specified by:
      minimumZ in interface VolumeValuesDType
      Returns:
      The value of the minimumZ attribute

    • maximumZ

      public double maximumZ()
      Specified by:
      maximumZ in interface PVolumeDType<S>
      Specified by:
      maximumZ in interface VolumeValuesDType
      Returns:
      The value of the maximumZ attribute

    • withMinimumX

      public final PVolumeD<S> withMinimumX​(double value)
      Copy the current immutable object by setting a value for the minimumX attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for minimumX
      Returns:
      A modified copy of the this object

    • withMaximumX

      public final PVolumeD<S> withMaximumX​(double value)
      Copy the current immutable object by setting a value for the maximumX attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for maximumX
      Returns:
      A modified copy of the this object

    • withMinimumY

      public final PVolumeD<S> withMinimumY​(double value)
      Copy the current immutable object by setting a value for the minimumY attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for minimumY
      Returns:
      A modified copy of the this object

    • withMaximumY

      public final PVolumeD<S> withMaximumY​(double value)
      Copy the current immutable object by setting a value for the maximumY attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for maximumY
      Returns:
      A modified copy of the this object

    • withMinimumZ

      public final PVolumeD<S> withMinimumZ​(double value)
      Copy the current immutable object by setting a value for the minimumZ attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for minimumZ
      Returns:
      A modified copy of the this object

    • withMaximumZ

      public final PVolumeD<S> withMaximumZ​(double value)
      Copy the current immutable object by setting a value for the maximumZ attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for maximumZ
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals​(java.lang.Object another)
      This instance is equal to all instances of PVolumeD that have equal attribute values.
      Overrides:
      equals in class java.lang.Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: minimumX, maximumX, minimumY, maximumY, minimumZ, maximumZ.
      Overrides:
      hashCode in class java.lang.Object
      Returns:
      hashCode value

    • toString

      public java.lang.String toString()
      Prints the immutable value PVolumeD with attribute values.
      Overrides:
      toString in class java.lang.Object
      Returns:
      A string representation of the value

    • of

      public static <S> PVolumeD<S> of​(double minimumX, double maximumX, double minimumY, double maximumY, double minimumZ, double maximumZ)
      Construct a new immutable PVolumeD instance.
      Type Parameters:
      S - generic parameter S
      Parameters:
      minimumX - The value for the minimumX attribute
      maximumX - The value for the maximumX attribute
      minimumY - The value for the minimumY attribute
      maximumY - The value for the maximumY attribute
      minimumZ - The value for the minimumZ attribute
      maximumZ - The value for the maximumZ attribute
      Returns:
      An immutable PVolumeD instance

    • copyOf

      public static <S> PVolumeD<S> copyOf​(PVolumeDType<S> instance)
      Creates an immutable copy of a PVolumeDType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Type Parameters:
      S - generic parameter S
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable PVolumeD instance

    • builder

      public static <S> PVolumeD.Builder<S> builder()
      Creates a builder for PVolumeD. 
       PVolumeD.&lt;S&gt;builder()
    .setMinimumX(double) // required minimumX
    .setMaximumX(double) // required maximumX
    .setMinimumY(double) // required minimumY
    .setMaximumY(double) // required maximumY
    .setMinimumZ(double) // required minimumZ
    .setMaximumZ(double) // required maximumZ
    .build();
      Type Parameters:
      S - generic parameter S
      Returns:
      A new PVolumeD builder