Module com.io7m.jregions.core

Package com.io7m.jregions.core.parameterized.volumes

Class PVolumeD<S>

java.lang.Object

com.io7m.jregions.core.parameterized.volumes.PVolumeD<S>

Type Parameters:

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

All Implemented Interfaces:

PVolumeDType<S>, VolumeSizeValuesDType, VolumeValuesDType

public final class PVolumeD<S>
extends java.lang.Object
implements PVolumeDType<S>

A volume with double 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	PVolumeD.Builder<S>	Builds instances of type PVolumeD.

Method Summary

Modifier and Type	Method	Description
static <S> PVolumeD.Builder<S>	builder()	Creates a builder for PVolumeD.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of PVolumeD that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: minimumX, maximumX, minimumY, maximumY, minimumZ, maximumZ.
double	maximumX()
double	maximumY()
double	maximumZ()
double	minimumX()
double	minimumY()
double	minimumZ()
static <S> PVolumeD<S>	of(double minimumX, double maximumX, double minimumY, double maximumY, double minimumZ, double maximumZ)	Construct a new immutable PVolumeD instance.
java.lang.String	toString()	Prints the immutable value PVolumeD 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.parameterized.volumes.PVolumeDType

checkPreconditions

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

sizeX, sizeY, sizeZ

Method Detail

minimumX

public double minimumX()

Specified by:

minimumX in interface PVolumeDType<S>

Specified by:

minimumX in interface VolumeValuesDType

Returns:

The value of the minimumX attribute

maximumX

public double maximumX()

Specified by:

maximumX in interface PVolumeDType<S>

Specified by:

maximumX in interface VolumeValuesDType

Returns:

The value of the maximumX attribute

minimumY

public double minimumY()

Specified by:

minimumY in interface PVolumeDType<S>

Specified by:

minimumY in interface VolumeValuesDType

Returns:

The value of the minimumY attribute

maximumY

public double maximumY()

Specified by:

maximumY in interface PVolumeDType<S>

Specified by:

maximumY in interface VolumeValuesDType

Returns:

The value of the maximumY attribute

minimumZ

public double minimumZ()

Specified by:

minimumZ in interface PVolumeDType<S>

Specified by:

minimumZ in interface VolumeValuesDType

Returns:

The value of the minimumZ attribute

maximumZ

public double maximumZ()

Specified by:

maximumZ in interface PVolumeDType<S>

Specified by:

maximumZ in interface VolumeValuesDType

Returns:

The value of the maximumZ attribute

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of PVolumeD 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 PVolumeD with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static <S> PVolumeD<S> of(double minimumX,
                                 double maximumX,
                                 double minimumY,
                                 double maximumY,
                                 double minimumZ,
                                 double maximumZ)

Construct a new immutable PVolumeD 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 PVolumeD instance

builder

public static <S> PVolumeD.Builder<S> builder()

Creates a builder for PVolumeD.

Type Parameters:

S - generic parameter S

Returns:

A new PVolumeD builder