Module com.io7m.jregions.core

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

Interface AreaValuesIType

All Superinterfaces:

AreaSizeValuesIType

All Known Subinterfaces:

AreaIType, PAreaIType<S>

All Known Implementing Classes:

AreaI, PAreaI

public interface AreaValuesIType
extends AreaSizeValuesIType

An area with int 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
int	maximumX()
int	maximumY()
int	minimumX()
int	minimumY()
default int	sizeX()
default int	sizeY()

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

height, width

Method Detail

minimumX

@Parameter(order=0)
int minimumX()

Returns:

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

maximumX

@Parameter(order=1)
int maximumX()

Returns:

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

minimumY

@Parameter(order=2)
int minimumY()

Returns:

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

maximumY

@Parameter(order=3)
int maximumY()

Returns:

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

sizeX

default int sizeX()

Specified by:

sizeX in interface AreaSizeValuesIType

Returns:

The size of the area on the X axis

sizeY

default int sizeY()

Specified by:

sizeY in interface AreaSizeValuesIType

Returns:

The size of the area on the Y axis