com.io7m.jregions.core.unparameterized.volumes

Interface VolumeValuesBIType

All Superinterfaces:

VolumeSizeValuesBIType

All Known Subinterfaces:

PVolumeBIType<S>, VolumeBIType

All Known Implementing Classes:

PVolumeBI, VolumeBI

public interface VolumeValuesBIType
extends VolumeSizeValuesBIType

A volume with BigInteger coordinates.

The coordinates of the volume 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 and Description
BigInteger	maximumX()
BigInteger	maximumY()
BigInteger	maximumZ()
BigInteger	minimumX()
BigInteger	minimumY()
BigInteger	minimumZ()
default BigInteger	sizeX()
default BigInteger	sizeY()
default BigInteger	sizeZ()

Method Detail

minimumX

BigInteger minimumX()

Returns:

The value on the X axis of the minimum edge of the box (inclusive)

maximumX

BigInteger maximumX()

Returns:

The value on the X axis of the maximum edge of the box (exclusive)

minimumY

BigInteger minimumY()

Returns:

The value on the Y axis of the minimum edge of the box (inclusive)

maximumY

BigInteger maximumY()

Returns:

The value on the Y axis of the maximum edge of the box (exclusive)

minimumZ

BigInteger minimumZ()

Returns:

The value on the Z axis of the minimum edge of the box (inclusive)

maximumZ

BigInteger maximumZ()

Returns:

The value on the Z axis of the maximum edge of the box (exclusive)

sizeX

default BigInteger sizeX()

Specified by:

sizeX in interface VolumeSizeValuesBIType

Returns:

The size of the area on the X axis

sizeY

default BigInteger sizeY()

Specified by:

sizeY in interface VolumeSizeValuesBIType

Returns:

The size of the area on the Y axis

sizeZ

default BigInteger sizeZ()

Specified by:

sizeZ in interface VolumeSizeValuesBIType

Returns:

The size of the area on the Z axis