com.io7m.jregions.core.parameterized.areas

Interface PAreaBDType<S>

Type Parameters:

S - A phantom type parameter indicating the coordinate space of the area

All Superinterfaces:

AreaSizeValuesBDType, AreaValuesBDType

All Known Implementing Classes:

PAreaBD

public interface PAreaBDType<S>
extends AreaValuesBDType

An area with BigDecimal 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 and Description
default void	checkPreconditions() Check the preconditions for the parameters.
BigDecimal	maximumX()
BigDecimal	maximumY()
BigDecimal	minimumX()
BigDecimal	minimumY()

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

sizeX, sizeY

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

height, width

Method Detail

minimumX

BigDecimal minimumX()

Specified by:

minimumX in interface AreaValuesBDType

Returns:

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

maximumX

BigDecimal maximumX()

Specified by:

maximumX in interface AreaValuesBDType

Returns:

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

minimumY

BigDecimal minimumY()

Specified by:

minimumY in interface AreaValuesBDType

Returns:

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

maximumY

BigDecimal maximumY()

Specified by:

maximumY in interface AreaValuesBDType

Returns:

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

checkPreconditions

default void checkPreconditions()

Check the preconditions for the parameters.