Module com.io7m.jregions.core

Package com.io7m.jregions.core.unparameterized.volumes

Class VolumeF

java.lang.Object

com.io7m.jregions.core.unparameterized.volumes.VolumeF

All Implemented Interfaces:

VolumeSizeValuesFType, VolumeFType, VolumeValuesFType

public final class VolumeF
extends java.lang.Object
implements VolumeFType

A volume 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 and Z axes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VolumeF.Builder	Builds instances of type VolumeF.

Method Summary

Modifier and Type	Method	Description
static VolumeF.Builder	builder()	Creates a builder for VolumeF.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of VolumeF that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: minimumX, maximumX, minimumY, maximumY, minimumZ, maximumZ.
float	maximumX()
float	maximumY()
float	maximumZ()
float	minimumX()
float	minimumY()
float	minimumZ()
static VolumeF	of(float minimumX, float maximumX, float minimumY, float maximumY, float minimumZ, float maximumZ)	Construct a new immutable VolumeF instance.
java.lang.String	toString()	Prints the immutable value VolumeF with attribute values.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.io7m.jregions.core.unparameterized.volumes.VolumeFType

checkPreconditions

Methods inherited from interface com.io7m.jregions.core.unparameterized.volumes.VolumeValuesFType

sizeX, sizeY, sizeZ

Method Detail

minimumX

public float minimumX()

Specified by:

minimumX in interface VolumeFType

Specified by:

minimumX in interface VolumeValuesFType

Returns:

The value of the minimumX attribute

maximumX

public float maximumX()

Specified by:

maximumX in interface VolumeFType

Specified by:

maximumX in interface VolumeValuesFType

Returns:

The value of the maximumX attribute

minimumY

public float minimumY()

Specified by:

minimumY in interface VolumeFType

Specified by:

minimumY in interface VolumeValuesFType

Returns:

The value of the minimumY attribute

maximumY

public float maximumY()

Specified by:

maximumY in interface VolumeFType

Specified by:

maximumY in interface VolumeValuesFType

Returns:

The value of the maximumY attribute

minimumZ

public float minimumZ()

Specified by:

minimumZ in interface VolumeFType

Specified by:

minimumZ in interface VolumeValuesFType

Returns:

The value of the minimumZ attribute

maximumZ

public float maximumZ()

Specified by:

maximumZ in interface VolumeFType

Specified by:

maximumZ in interface VolumeValuesFType

Returns:

The value of the maximumZ attribute

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of VolumeF that have equal attribute values.

Overrides:

equals in class java.lang.Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: minimumX, maximumX, minimumY, maximumY, minimumZ, maximumZ.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value VolumeF with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static VolumeF of(float minimumX,
                         float maximumX,
                         float minimumY,
                         float maximumY,
                         float minimumZ,
                         float maximumZ)

Construct a new immutable VolumeF instance.

Parameters:

minimumX - The value for the minimumX attribute

maximumX - The value for the maximumX attribute

minimumY - The value for the minimumY attribute

maximumY - The value for the maximumY attribute

minimumZ - The value for the minimumZ attribute

maximumZ - The value for the maximumZ attribute

Returns:

An immutable VolumeF instance

builder

public static VolumeF.Builder builder()

Creates a builder for VolumeF.

Returns:

A new VolumeF builder