com.io7m.jregions.core.unparameterized.volumes

Interface VolumeValuesIType

All Superinterfaces:

VolumeSizeValuesIType

All Known Subinterfaces:

PVolumeIType<S>, VolumeIType

All Known Implementing Classes:

PVolumeI, VolumeI

public interface VolumeValuesIType
extends VolumeSizeValuesIType

A volume with int 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
int	maximumX()
int	maximumY()
int	maximumZ()
int	minimumX()
int	minimumY()
int	minimumZ()
default int	sizeX()
default int	sizeY()
default int	sizeZ()

Method Detail

minimumX

int minimumX()

Returns:

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

maximumX

int maximumX()

Returns:

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

minimumY

int minimumY()

Returns:

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

maximumY

int maximumY()

Returns:

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

minimumZ

int minimumZ()

Returns:

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

maximumZ

int maximumZ()

Returns:

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

sizeX

default int sizeX()

Specified by:

sizeX in interface VolumeSizeValuesIType

Returns:

The size of the area on the X axis

sizeY

default int sizeY()

Specified by:

sizeY in interface VolumeSizeValuesIType

Returns:

The size of the area on the Y axis

sizeZ

default int sizeZ()

Specified by:

sizeZ in interface VolumeSizeValuesIType

Returns:

The size of the area on the Z axis