com.io7m.jregions.core.parameterized.areas

Interface PAreaLType<S>

Type Parameters:

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

All Superinterfaces:

AreaSizeValuesLType, AreaValuesLType

All Known Implementing Classes:

PAreaL

public interface PAreaLType<S>
extends AreaValuesLType

An area with long 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.
long	maximumX()
long	maximumY()
long	minimumX()
long	minimumY()

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

sizeX, sizeY

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

height, width

Method Detail

minimumX

long minimumX()

Specified by:

minimumX in interface AreaValuesLType

Returns:

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

maximumX

long maximumX()

Specified by:

maximumX in interface AreaValuesLType

Returns:

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

minimumY

long minimumY()

Specified by:

minimumY in interface AreaValuesLType

Returns:

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

maximumY

long maximumY()

Specified by:

maximumY in interface AreaValuesLType

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.