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

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 and 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

double minimumX()

Specified by:

minimumX in interface VolumeValuesDType

Returns:

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

maximumX

double maximumX()

Specified by:

maximumX in interface VolumeValuesDType

Returns:

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

minimumY

double minimumY()

Specified by:

minimumY in interface VolumeValuesDType

Returns:

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

maximumY

double maximumY()

Specified by:

maximumY in interface VolumeValuesDType

Returns:

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

minimumZ

double minimumZ()

Specified by:

minimumZ in interface VolumeValuesDType

Returns:

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

maximumZ

double maximumZ()

Specified by:

maximumZ in interface VolumeValuesDType

Returns:

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

checkPreconditions

default void checkPreconditions()

Check the preconditions for the parameters.