Class VolumeD
java.lang.Object
com.io7m.jregions.core.unparameterized.volumes.VolumeD
- All Implemented Interfaces:
VolumeSizeValuesDType
,VolumeDType
,VolumeValuesDType
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
-
Method Summary
Modifier and TypeMethodDescriptionstatic VolumeD.Builder
builder()
Creates a builder forVolumeD
.static VolumeD
copyOf
(VolumeDType instance) Creates an immutable copy of aVolumeDType
value.boolean
This instance is equal to all instances ofVolumeD
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 VolumeD
of
(double minimumX, double maximumX, double minimumY, double maximumY, double minimumZ, double maximumZ) Construct a new immutableVolumeD
instance.toString()
Prints the immutable valueVolumeD
with attribute values.final VolumeD
withMaximumX
(double value) Copy the current immutable object by setting a value for themaximumX
attribute.final VolumeD
withMaximumY
(double value) Copy the current immutable object by setting a value for themaximumY
attribute.final VolumeD
withMaximumZ
(double value) Copy the current immutable object by setting a value for themaximumZ
attribute.final VolumeD
withMinimumX
(double value) Copy the current immutable object by setting a value for theminimumX
attribute.final VolumeD
withMinimumY
(double value) Copy the current immutable object by setting a value for theminimumY
attribute.final VolumeD
withMinimumZ
(double value) Copy the current immutable object by setting a value for theminimumZ
attribute.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.VolumeDType
checkPreconditions
Methods inherited from interface com.io7m.jregions.core.unparameterized.volumes.VolumeValuesDType
sizeX, sizeY, sizeZ
-
Method Details
-
minimumX
public double minimumX()- Specified by:
minimumX
in interfaceVolumeDType
- Specified by:
minimumX
in interfaceVolumeValuesDType
- Returns:
- The value of the
minimumX
attribute
-
maximumX
public double maximumX()- Specified by:
maximumX
in interfaceVolumeDType
- Specified by:
maximumX
in interfaceVolumeValuesDType
- Returns:
- The value of the
maximumX
attribute
-
minimumY
public double minimumY()- Specified by:
minimumY
in interfaceVolumeDType
- Specified by:
minimumY
in interfaceVolumeValuesDType
- Returns:
- The value of the
minimumY
attribute
-
maximumY
public double maximumY()- Specified by:
maximumY
in interfaceVolumeDType
- Specified by:
maximumY
in interfaceVolumeValuesDType
- Returns:
- The value of the
maximumY
attribute
-
minimumZ
public double minimumZ()- Specified by:
minimumZ
in interfaceVolumeDType
- Specified by:
minimumZ
in interfaceVolumeValuesDType
- Returns:
- The value of the
minimumZ
attribute
-
maximumZ
public double maximumZ()- Specified by:
maximumZ
in interfaceVolumeDType
- Specified by:
maximumZ
in interfaceVolumeValuesDType
- Returns:
- The value of the
maximumZ
attribute
-
withMinimumX
Copy the current immutable object by setting a value for theminimumX
attribute. A value strict bits equality used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for minimumX- Returns:
- A modified copy of the
this
object
-
withMaximumX
Copy the current immutable object by setting a value for themaximumX
attribute. A value strict bits equality used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for maximumX- Returns:
- A modified copy of the
this
object
-
withMinimumY
Copy the current immutable object by setting a value for theminimumY
attribute. A value strict bits equality used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for minimumY- Returns:
- A modified copy of the
this
object
-
withMaximumY
Copy the current immutable object by setting a value for themaximumY
attribute. A value strict bits equality used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for maximumY- Returns:
- A modified copy of the
this
object
-
withMinimumZ
Copy the current immutable object by setting a value for theminimumZ
attribute. A value strict bits equality used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for minimumZ- Returns:
- A modified copy of the
this
object
-
withMaximumZ
Copy the current immutable object by setting a value for themaximumZ
attribute. A value strict bits equality used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for maximumZ- Returns:
- A modified copy of the
this
object
-
equals
This instance is equal to all instances ofVolumeD
that have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:minimumX
,maximumX
,minimumY
,maximumY
,minimumZ
,maximumZ
. -
toString
Prints the immutable valueVolumeD
with attribute values. -
of
public static VolumeD of(double minimumX, double maximumX, double minimumY, double maximumY, double minimumZ, double maximumZ) Construct a new immutableVolumeD
instance.- Parameters:
minimumX
- The value for theminimumX
attributemaximumX
- The value for themaximumX
attributeminimumY
- The value for theminimumY
attributemaximumY
- The value for themaximumY
attributeminimumZ
- The value for theminimumZ
attributemaximumZ
- The value for themaximumZ
attribute- Returns:
- An immutable VolumeD instance
-
copyOf
Creates an immutable copy of aVolumeDType
value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.- Parameters:
instance
- The instance to copy- Returns:
- A copied immutable VolumeD instance
-
builder
Creates a builder forVolumeD
.VolumeD.builder() .setMinimumX(double) // required
minimumX
.setMaximumX(double) // requiredmaximumX
.setMinimumY(double) // requiredminimumY
.setMaximumY(double) // requiredmaximumY
.setMinimumZ(double) // requiredminimumZ
.setMaximumZ(double) // requiredmaximumZ
.build();- Returns:
- A new VolumeD builder
-