Package com.io7m.jregions.core.unparameterized.volumes

Interface VolumeBIType

All Superinterfaces:
VolumeSizeValuesBIType, VolumeValuesBIType
All Known Implementing Classes:
VolumeBI
@Immutable
public interface VolumeBIType
extends VolumeValuesBIType

A volume with BigInteger 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.

  • Method Summary

    Modifier and Type Method Description
    default void checkPreconditions()
    Check the preconditions for the parameters.
    java.math.BigInteger maximumX()  
    java.math.BigInteger maximumY()  
    java.math.BigInteger maximumZ()  
    java.math.BigInteger minimumX()  
    java.math.BigInteger minimumY()  
    java.math.BigInteger minimumZ()  

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

    sizeX, sizeY, sizeZ

  • Method Details

    • minimumX

      @Parameter(order=0) java.math.BigInteger minimumX()
      Specified by:
      minimumX in interface VolumeValuesBIType
      Returns:
      The value on the X axis of the minimum edge of the box (inclusive)

    • maximumX

      @Parameter(order=1) java.math.BigInteger maximumX()
      Specified by:
      maximumX in interface VolumeValuesBIType
      Returns:
      The value on the X axis of the maximum edge of the box (exclusive)

    • minimumY

      @Parameter(order=2) java.math.BigInteger minimumY()
      Specified by:
      minimumY in interface VolumeValuesBIType
      Returns:
      The value on the Y axis of the minimum edge of the box (inclusive)

    • maximumY

      @Parameter(order=3) java.math.BigInteger maximumY()
      Specified by:
      maximumY in interface VolumeValuesBIType
      Returns:
      The value on the Y axis of the maximum edge of the box (exclusive)

    • minimumZ

      @Parameter(order=4) java.math.BigInteger minimumZ()
      Specified by:
      minimumZ in interface VolumeValuesBIType
      Returns:
      The value on the Z axis of the minimum edge of the box (inclusive)

    • maximumZ

      @Parameter(order=5) java.math.BigInteger maximumZ()
      Specified by:
      maximumZ in interface VolumeValuesBIType
      Returns:
      The value on the Z axis of the maximum edge of the box (exclusive)

    • checkPreconditions

      @Check default void checkPreconditions()
      Check the preconditions for the parameters.