Module com.io7m.jregions.core

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

Interface AreaFType

All Superinterfaces:

AreaSizeValuesFType, AreaValuesFType

All Known Implementing Classes:

AreaF

@Immutable
public interface AreaFType
extends AreaValuesFType

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
default void	checkPreconditions()	Check the preconditions for the parameters.
float	maximumX()
float	maximumY()
float	minimumX()
float	minimumY()

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

height, width

Methods inherited from interface com.io7m.jregions.core.unparameterized.areas.AreaValuesFType

sizeX, sizeY

Method Detail

minimumX

@Parameter(order=0)
float minimumX()

Specified by:

minimumX in interface AreaValuesFType

Returns:

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

maximumX

@Parameter(order=1)
float maximumX()

Specified by:

maximumX in interface AreaValuesFType

Returns:

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

minimumY

@Parameter(order=2)
float minimumY()

Specified by:

minimumY in interface AreaValuesFType

Returns:

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

maximumY

@Parameter(order=3)
float maximumY()

Specified by:

maximumY in interface AreaValuesFType

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.