Module com.io7m.jregions.core

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

Interface PVolumeLType<S>

Type Parameters:

S - A phantom type parameter indicating the coordinate space of the volume

All Superinterfaces:

VolumeSizeValuesLType, VolumeValuesLType

All Known Implementing Classes:

PVolumeL

@Immutable
public interface PVolumeLType<S>
extends VolumeValuesLType

A volume with long 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.
long	maximumX()
long	maximumY()
long	maximumZ()
long	minimumX()
long	minimumY()
long	minimumZ()

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

sizeX, sizeY, sizeZ

Method Detail

minimumX

@Parameter(order=0)
long minimumX()

Specified by:

minimumX in interface VolumeValuesLType

Returns:

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

maximumX

@Parameter(order=1)
long maximumX()

Specified by:

maximumX in interface VolumeValuesLType

Returns:

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

minimumY

@Parameter(order=2)
long minimumY()

Specified by:

minimumY in interface VolumeValuesLType

Returns:

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

maximumY

@Parameter(order=3)
long maximumY()

Specified by:

maximumY in interface VolumeValuesLType

Returns:

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

minimumZ

@Parameter(order=4)
long minimumZ()

Specified by:

minimumZ in interface VolumeValuesLType

Returns:

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

maximumZ

@Parameter(order=5)
long maximumZ()

Specified by:

maximumZ in interface VolumeValuesLType

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.