com.io7m.jboxes.core

Interface BoxType<S>

Type Parameters:

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

All Known Implementing Classes:

Box, BoxMutable

@Value.Immutable
 @Value.Modifiable
public interface BoxType<S>

The type of boxes expressed as half-closed ranges on the X and Y axis.

Method Summary

Modifier and Type	Method and Description
default void	checkPreconditions() Check the preconditions for the parameters.
default int	height()
int	maximumX()
int	maximumY()
int	minimumX()
int	minimumY()
default int	width()

Method Detail

checkPreconditions

@Value.Check
default void checkPreconditions()

Check the preconditions for the parameters.

minimumX

@Value.Parameter(order=0)
int minimumX()

Returns:

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

maximumX

@Value.Parameter(order=1)
int maximumX()

Returns:

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

minimumY

@Value.Parameter(order=2)
int minimumY()

Returns:

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

maximumY

@Value.Parameter(order=3)
int maximumY()

Returns:

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

width

default int width()

Returns:

The width of the box

height

default int height()

Returns:

The height of the box