VolumeValuesBDType (com.io7m.jregions.documentation 2.0.0 API)

All Superinterfaces:

VolumeSizeValuesBDType

All Known Subinterfaces:

PVolumeBDType<S>, VolumeBDType

All Known Implementing Classes:

PVolumeBD, VolumeBD
```
public interface VolumeValuesBDType
extends VolumeSizeValuesBDType
```
A volume with BigDecimal coordinates.

The coordinates of the volume 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

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`java.math.BigDecimal`	`maximumX()`
`java.math.BigDecimal`	`maximumY()`
`java.math.BigDecimal`	`maximumZ()`
`java.math.BigDecimal`	`minimumX()`
`java.math.BigDecimal`	`minimumY()`
`java.math.BigDecimal`	`minimumZ()`
`default java.math.BigDecimal`	`sizeX()`
`default java.math.BigDecimal`	`sizeY()`
`default java.math.BigDecimal`	`sizeZ()`

- Method Detail
  - minimumX
```
@Parameter(order=0)
java.math.BigDecimal minimumX()
```
    Returns:
    
    The value on the X axis of the minimum edge of the box (inclusive)
  - maximumX
```
@Parameter(order=1)
java.math.BigDecimal maximumX()
```
    Returns:
    
    The value on the X axis of the maximum edge of the box (exclusive)
  - minimumY
```
@Parameter(order=2)
java.math.BigDecimal minimumY()
```
    Returns:
    
    The value on the Y axis of the minimum edge of the box (inclusive)
  - maximumY
```
@Parameter(order=3)
java.math.BigDecimal maximumY()
```
    Returns:
    
    The value on the Y axis of the maximum edge of the box (exclusive)
  - minimumZ
```
@Parameter(order=4)
java.math.BigDecimal minimumZ()
```
    Returns:
    
    The value on the Z axis of the minimum edge of the box (inclusive)
  - maximumZ
```
@Parameter(order=5)
java.math.BigDecimal maximumZ()
```
    Returns:
    
    The value on the Z axis of the maximum edge of the box (exclusive)
  - sizeX
```
default java.math.BigDecimal sizeX()
```
    Specified by:
    
    sizeX in interface VolumeSizeValuesBDType
    
    Returns:
    
    The size of the area on the X axis
  - sizeY
```
default java.math.BigDecimal sizeY()
```
    Specified by:
    
    sizeY in interface VolumeSizeValuesBDType
    
    Returns:
    
    The size of the area on the Y axis
  - sizeZ
```
default java.math.BigDecimal sizeZ()
```
    Specified by:
    
    sizeZ in interface VolumeSizeValuesBDType
    
    Returns:
    
    The size of the area on the Z axis

Interface VolumeValuesBDType

Method Summary

Method Detail

minimumX

maximumX

minimumY

maximumY

minimumZ

maximumZ

sizeX

sizeY

sizeZ