Module com.io7m.jregions.core

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

Class PVolumeXYZSplitBI<S,T extends PVolumeBIType<S>>

java.lang.Object

com.io7m.jregions.core.parameterized.volumes.PVolumeXYZSplitBI<S,T>

Type Parameters:

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

T - The precise type of volume

All Implemented Interfaces:

PVolumeXYZSplitBIType<S,T>

public final class PVolumeXYZSplitBI<S,T extends PVolumeBIType<S>>
extends java.lang.Object
implements PVolumeXYZSplitBIType<S,T>

A volume that has been split into octants via an X, Y, and Z axis.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PVolumeXYZSplitBI.Builder<S,T extends PVolumeBIType<S>>	Builds instances of type PVolumeXYZSplitBI.

Method Summary

Modifier and Type	Method	Description
static <S,T extends PVolumeBIType<S>> PVolumeXYZSplitBI.Builder<S,T>	builder()	Creates a builder for PVolumeXYZSplitBI.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of PVolumeXYZSplitBI that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: x0y0z0, x1y0z0, x0y1z0, x1y1z0, x0y0z1, x1y0z1, x0y1z1, x1y1z1.
static <S,T extends PVolumeBIType<S>> PVolumeXYZSplitBI<S,T>	of(T x0y0z0, T x1y0z0, T x0y1z0, T x1y1z0, T x0y0z1, T x1y0z1, T x0y1z1, T x1y1z1)	Construct a new immutable PVolumeXYZSplitBI instance.
java.lang.String	toString()	Prints the immutable value PVolumeXYZSplitBI with attribute values.
T	x0y0z0()
T	x0y0z1()
T	x0y1z0()
T	x0y1z1()
T	x1y0z0()
T	x1y0z1()
T	x1y1z0()
T	x1y1z1()

Methods inherited from class java.lang.Object

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

Method Detail

x0y0z0

public T x0y0z0()

Specified by:

x0y0z0 in interface PVolumeXYZSplitBIType<S,T extends PVolumeBIType<S>>

Returns:

The minimum X, minimum Y, minimum Z octant

x1y0z0

public T x1y0z0()

Specified by:

x1y0z0 in interface PVolumeXYZSplitBIType<S,T extends PVolumeBIType<S>>

Returns:

The maximum X, minimum Y, minimum Z octant

x0y1z0

public T x0y1z0()

Specified by:

x0y1z0 in interface PVolumeXYZSplitBIType<S,T extends PVolumeBIType<S>>

Returns:

The minimum X, maximum Y, minimum Z octant

x1y1z0

public T x1y1z0()

Specified by:

x1y1z0 in interface PVolumeXYZSplitBIType<S,T extends PVolumeBIType<S>>

Returns:

The maximum X, maximum Y, minimum Z octant

x0y0z1

public T x0y0z1()

Specified by:

x0y0z1 in interface PVolumeXYZSplitBIType<S,T extends PVolumeBIType<S>>

Returns:

The minimum X, minimum Y, maximum Z octant

x1y0z1

public T x1y0z1()

Specified by:

x1y0z1 in interface PVolumeXYZSplitBIType<S,T extends PVolumeBIType<S>>

Returns:

The maximum X, minimum Y, maximum Z octant

x0y1z1

public T x0y1z1()

Specified by:

x0y1z1 in interface PVolumeXYZSplitBIType<S,T extends PVolumeBIType<S>>

Returns:

The minimum X, maximum Y, maximum Z octant

x1y1z1

public T x1y1z1()

Specified by:

x1y1z1 in interface PVolumeXYZSplitBIType<S,T extends PVolumeBIType<S>>

Returns:

The maximum X, maximum Y, maximum Z octant

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of PVolumeXYZSplitBI 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: x0y0z0, x1y0z0, x0y1z0, x1y1z0, x0y0z1, x1y0z1, x0y1z1, x1y1z1.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value PVolumeXYZSplitBI with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static <S,T extends PVolumeBIType<S>> PVolumeXYZSplitBI<S,T> of(T x0y0z0,
                                                                       T x1y0z0,
                                                                       T x0y1z0,
                                                                       T x1y1z0,
                                                                       T x0y0z1,
                                                                       T x1y0z1,
                                                                       T x0y1z1,
                                                                       T x1y1z1)

Construct a new immutable PVolumeXYZSplitBI instance.

Parameters:

x0y0z0 - The value for the x0y0z0 attribute

x1y0z0 - The value for the x1y0z0 attribute

x0y1z0 - The value for the x0y1z0 attribute

x1y1z0 - The value for the x1y1z0 attribute

x0y0z1 - The value for the x0y0z1 attribute

x1y0z1 - The value for the x1y0z1 attribute

x0y1z1 - The value for the x0y1z1 attribute

x1y1z1 - The value for the x1y1z1 attribute

Returns:

An immutable PVolumeXYZSplitBI instance

builder

public static <S,T extends PVolumeBIType<S>> PVolumeXYZSplitBI.Builder<S,T> builder()

Creates a builder for PVolumeXYZSplitBI.

Type Parameters:

S - generic parameter S

T - generic parameter T

Returns:

A new PVolumeXYZSplitBI builder