Class PVolumeF<S>
java.lang.Object
com.io7m.jregions.core.parameterized.volumes.PVolumeF<S>
- Type Parameters:
S
- A phantom type parameter indicating the coordinate space of the volume
- All Implemented Interfaces:
PVolumeFType<S>
,VolumeSizeValuesFType
,VolumeValuesFType
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
-
Method Summary
Modifier and TypeMethodDescriptionstatic <S> PVolumeF.Builder<S>
builder()
Creates a builder forPVolumeF
.static <S> PVolumeF<S>
copyOf
(PVolumeFType<S> instance) Creates an immutable copy of aPVolumeFType
value.boolean
This instance is equal to all instances ofPVolumeF
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 <S> PVolumeF<S>
of
(float minimumX, float maximumX, float minimumY, float maximumY, float minimumZ, float maximumZ) Construct a new immutablePVolumeF
instance.toString()
Prints the immutable valuePVolumeF
with attribute values.withMaximumX
(float value) Copy the current immutable object by setting a value for themaximumX
attribute.withMaximumY
(float value) Copy the current immutable object by setting a value for themaximumY
attribute.withMaximumZ
(float value) Copy the current immutable object by setting a value for themaximumZ
attribute.withMinimumX
(float value) Copy the current immutable object by setting a value for theminimumX
attribute.withMinimumY
(float value) Copy the current immutable object by setting a value for theminimumY
attribute.withMinimumZ
(float 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.parameterized.volumes.PVolumeFType
checkPreconditions
Methods inherited from interface com.io7m.jregions.core.unparameterized.volumes.VolumeValuesFType
sizeX, sizeY, sizeZ
-
Method Details
-
minimumX
public float minimumX()- Specified by:
minimumX
in interfacePVolumeFType<S>
- Specified by:
minimumX
in interfaceVolumeValuesFType
- Returns:
- The value of the
minimumX
attribute
-
maximumX
public float maximumX()- Specified by:
maximumX
in interfacePVolumeFType<S>
- Specified by:
maximumX
in interfaceVolumeValuesFType
- Returns:
- The value of the
maximumX
attribute
-
minimumY
public float minimumY()- Specified by:
minimumY
in interfacePVolumeFType<S>
- Specified by:
minimumY
in interfaceVolumeValuesFType
- Returns:
- The value of the
minimumY
attribute
-
maximumY
public float maximumY()- Specified by:
maximumY
in interfacePVolumeFType<S>
- Specified by:
maximumY
in interfaceVolumeValuesFType
- Returns:
- The value of the
maximumY
attribute
-
minimumZ
public float minimumZ()- Specified by:
minimumZ
in interfacePVolumeFType<S>
- Specified by:
minimumZ
in interfaceVolumeValuesFType
- Returns:
- The value of the
minimumZ
attribute
-
maximumZ
public float maximumZ()- Specified by:
maximumZ
in interfacePVolumeFType<S>
- Specified by:
maximumZ
in interfaceVolumeValuesFType
- 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 ofPVolumeF
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 valuePVolumeF
with attribute values. -
of
public static <S> PVolumeF<S> of(float minimumX, float maximumX, float minimumY, float maximumY, float minimumZ, float maximumZ) Construct a new immutablePVolumeF
instance.- Type Parameters:
S
- generic parameter S- 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 PVolumeF instance
-
copyOf
Creates an immutable copy of aPVolumeFType
value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.- Type Parameters:
S
- generic parameter S- Parameters:
instance
- The instance to copy- Returns:
- A copied immutable PVolumeF instance
-
builder
Creates a builder forPVolumeF
.PVolumeF.<S>builder() .setMinimumX(float) // required
minimumX
.setMaximumX(float) // requiredmaximumX
.setMinimumY(float) // requiredminimumY
.setMaximumY(float) // requiredmaximumY
.setMinimumZ(float) // requiredminimumZ
.setMaximumZ(float) // requiredmaximumZ
.build();- Type Parameters:
S
- generic parameter S- Returns:
- A new PVolumeF builder
-