Module com.io7m.jregions.core

Package 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

@Immutable
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	Description
default void	checkPreconditions()	Check the preconditions for the parameters.
java.math.BigDecimal	maximumX()
java.math.BigDecimal	maximumY()
java.math.BigDecimal	maximumZ()
java.math.BigDecimal	minimumX()
java.math.BigDecimal	minimumY()
java.math.BigDecimal	minimumZ()

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

sizeX, sizeY, sizeZ

Method Detail

minimumX

@Parameter(order=0)
java.math.BigDecimal minimumX()

Specified by:

minimumX in interface VolumeValuesBDType

Returns:

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

maximumX

@Parameter(order=1)
java.math.BigDecimal maximumX()

Specified by:

maximumX in interface VolumeValuesBDType

Returns:

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

minimumY

@Parameter(order=2)
java.math.BigDecimal minimumY()

Specified by:

minimumY in interface VolumeValuesBDType

Returns:

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

maximumY

@Parameter(order=3)
java.math.BigDecimal maximumY()

Specified by:

maximumY in interface VolumeValuesBDType

Returns:

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

minimumZ

@Parameter(order=4)
java.math.BigDecimal minimumZ()

Specified by:

minimumZ in interface VolumeValuesBDType

Returns:

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

maximumZ

@Parameter(order=5)
java.math.BigDecimal maximumZ()

Specified by:

maximumZ in interface VolumeValuesBDType

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.