Module com.io7m.jregions.core

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

Interface PVolumeDType<S>

Type Parameters:

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

All Superinterfaces:

VolumeSizeValuesDType, VolumeValuesDType

All Known Implementing Classes:

PVolumeD

@Immutable
public interface PVolumeDType<S>
extends VolumeValuesDType

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.

Method Summary

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

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

sizeX, sizeY, sizeZ

Method Detail

minimumX

@Parameter(order=0)
double minimumX()

Specified by:

minimumX in interface VolumeValuesDType

Returns:

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

maximumX

@Parameter(order=1)
double maximumX()

Specified by:

maximumX in interface VolumeValuesDType

Returns:

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

minimumY

@Parameter(order=2)
double minimumY()

Specified by:

minimumY in interface VolumeValuesDType

Returns:

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

maximumY

@Parameter(order=3)
double maximumY()

Specified by:

maximumY in interface VolumeValuesDType

Returns:

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

minimumZ

@Parameter(order=4)
double minimumZ()

Specified by:

minimumZ in interface VolumeValuesDType

Returns:

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

maximumZ

@Parameter(order=5)
double maximumZ()

Specified by:

maximumZ in interface VolumeValuesDType

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.