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

# Interface AreaValuesFType

All Superinterfaces:
  `AreaSizeValuesFType`

All Known Subinterfaces:
  `AreaFType`, `PAreaFType<S>`

All Known Implementing Classes:
  `AreaF`, `PAreaF`

public interface AreaValuesFType extends AreaSizeValuesFType

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

  ### Methods inherited from interface com.io7m.jregions.core.unparameterized.sizes.AreaSizeValuesFType

  `height, width`

- ## Method Details

  - ### minimumX

    @Parameter(order=0) float minimumX()
    Returns:
      The value on the X axis of the minimum edge of the box (inclusive)

  - ### maximumX

    @Parameter(order=1) float maximumX()
    Returns:
      The value on the X axis of the maximum edge of the box (exclusive)

  - ### minimumY

    @Parameter(order=2) float minimumY()
    Returns:
      The value on the Y axis of the minimum edge of the box (inclusive)

  - ### maximumY

    @Parameter(order=3) float maximumY()
    Returns:
      The value on the Y axis of the maximum edge of the box (exclusive)

  - ### sizeX

    default float sizeX()
    Specified by:
      `sizeX` in interface `AreaSizeValuesFType`
    Returns:
      The size of the area on the X axis

  - ### sizeY

    default float sizeY()
    Specified by:
      `sizeY` in interface `AreaSizeValuesFType`
    Returns:
      The size of the area on the Y axis