com.io7m.jregions.core.parameterized.areas

Interface PAreaFType<S>

Type Parameters:

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

All Known Implementing Classes:

PAreaF

public interface PAreaFType<S>

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

Method Detail

minimumX

float minimumX()

Returns:

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

maximumX

float maximumX()

Returns:

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

minimumY

float minimumY()

Returns:

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

maximumY

float maximumY()

Returns:

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

width

default float width()

Returns:

The width of the area

height

default float height()

Returns:

The height of the area

checkPreconditions

default void checkPreconditions()

Check the preconditions for the parameters.