Module com.io7m.jregions.core

Package com.io7m.jregions.core.unparameterized.areas

Interface AreaValuesBIType

All Superinterfaces:

AreaSizeValuesBIType

All Known Subinterfaces:

AreaBIType, PAreaBIType<S>

All Known Implementing Classes:

AreaBI, PAreaBI

public interface AreaValuesBIType
extends AreaSizeValuesBIType

An area with BigInteger 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 axis.

Method Summary

Modifier and Type	Method	Description
java.math.BigInteger	maximumX()
java.math.BigInteger	maximumY()
java.math.BigInteger	minimumX()
java.math.BigInteger	minimumY()
default java.math.BigInteger	sizeX()
default java.math.BigInteger	sizeY()

Methods inherited from interface com.io7m.jregions.core.unparameterized.sizes.AreaSizeValuesBIType

height, width

Method Detail

minimumX

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

Returns:

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

maximumX

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

Returns:

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

minimumY

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

Returns:

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

maximumY

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

Returns:

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

sizeX

default java.math.BigInteger sizeX()

Specified by:

sizeX in interface AreaSizeValuesBIType

Returns:

The size of the area on the X axis

sizeY

default java.math.BigInteger sizeY()

Specified by:

sizeY in interface AreaSizeValuesBIType

Returns:

The size of the area on the Y axis