com.io7m.jregions.core.parameterized.volumes

Interface PVolumeFType<S>

Type Parameters:

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

All Superinterfaces:

VolumeSizeValuesFType, VolumeValuesFType

All Known Implementing Classes:

PVolumeF

public interface PVolumeFType<S>
extends VolumeValuesFType

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

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

sizeX, sizeY, sizeZ

Method Detail

minimumX

float minimumX()

Specified by:

minimumX in interface VolumeValuesFType

Returns:

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

maximumX

float maximumX()

Specified by:

maximumX in interface VolumeValuesFType

Returns:

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

minimumY

float minimumY()

Specified by:

minimumY in interface VolumeValuesFType

Returns:

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

maximumY

float maximumY()

Specified by:

maximumY in interface VolumeValuesFType

Returns:

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

minimumZ

float minimumZ()

Specified by:

minimumZ in interface VolumeValuesFType

Returns:

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

maximumZ

float maximumZ()

Specified by:

maximumZ in interface VolumeValuesFType

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.