com.io7m.jregions.core.parameterized.volumes

Interface PVolumeBDType<S>

Type Parameters:

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

All Superinterfaces:

VolumeSizeValuesBDType, VolumeValuesBDType

All Known Implementing Classes:

PVolumeBD

public interface PVolumeBDType<S>
extends VolumeValuesBDType

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

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

sizeX, sizeY, sizeZ

Method Detail

minimumX

BigDecimal minimumX()

Specified by:

minimumX in interface VolumeValuesBDType

Returns:

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

maximumX

BigDecimal maximumX()

Specified by:

maximumX in interface VolumeValuesBDType

Returns:

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

minimumY

BigDecimal minimumY()

Specified by:

minimumY in interface VolumeValuesBDType

Returns:

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

maximumY

BigDecimal maximumY()

Specified by:

maximumY in interface VolumeValuesBDType

Returns:

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

minimumZ

BigDecimal minimumZ()

Specified by:

minimumZ in interface VolumeValuesBDType

Returns:

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

maximumZ

BigDecimal maximumZ()

Specified by:

maximumZ in interface VolumeValuesBDType

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.