com.io7m.jregions.core.unparameterized.areas

## Interface AreaIType

- All Known Implementing Classes:
    AreaI

      public interface AreaIType

  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

    All Methods Instance Methods Abstract Methods Default Methods
    Modifier and Type | Method and Description
    --- | ---
    `default void` | `checkPreconditions()` Check the preconditions for the parameters.
    `default int` | `height()`
    `int` | `maximumX()`
    `int` | `maximumY()`
    `int` | `minimumX()`
    `int` | `minimumY()`
    `default int` | `width()`

- - ### Method Detail

    - #### minimumX

          int minimumX()

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

    - #### maximumX

          int maximumX()

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

    - #### minimumY

          int minimumY()

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

    - #### maximumY

          int maximumY()

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

    - #### width

          default int width()

      Returns:
        The width of the area

    - #### height

          default int height()

      Returns:
        The height of the area

    - #### checkPreconditions

          default void checkPreconditions()

      Check the preconditions for the parameters.

Copyright © 2017 <code@io7m.com> http://io7m.com