Package com.io7m.jregions.core.parameterized.areas

Interface PAreaIType<S>

Type Parameters:
S - A phantom type parameter indicating the coordinate space of the area
All Superinterfaces:
AreaSizeValuesIType, AreaValuesIType
All Known Implementing Classes:
PAreaI
@Immutable public interface PAreaIType<S> extends AreaValuesIType

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 Details

    • minimumX

      @Parameter(order=0) int minimumX()
      Specified by:
      minimumX in interface AreaValuesIType
      Returns:
      The value on the X axis of the minimum edge of the box (inclusive)

    • maximumX

      @Parameter(order=1) int maximumX()
      Specified by:
      maximumX in interface AreaValuesIType
      Returns:
      The value on the X axis of the maximum edge of the box (exclusive)

    • minimumY

      @Parameter(order=2) int minimumY()
      Specified by:
      minimumY in interface AreaValuesIType
      Returns:
      The value on the Y axis of the minimum edge of the box (inclusive)

    • maximumY

      @Parameter(order=3) int maximumY()
      Specified by:
      maximumY in interface AreaValuesIType
      Returns:
      The value on the Y axis of the maximum edge of the box (exclusive)

    • checkPreconditions

      @Check default void checkPreconditions()
      Check the preconditions for the parameters.