Class PVector3D<T>
java.lang.Object
com.io7m.jtensors.core.parameterized.vectors.PVector3D<T>
- Type Parameters:
T
- A phantom type parameter
- All Implemented Interfaces:
PVector3DType<T>
,PVectorReadable2DType<T>
,PVectorReadable3DType<T>
,VectorReadable2DType
,VectorReadable3DType
,VectorComputationalType
public final class PVector3D<T> extends java.lang.Object implements PVector3DType<T>
The type of 3D
double
-typed vectors.-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PVector3D.Builder<T>
Builds instances of typePVector3D
. -
Method Summary
Modifier and Type Method Description static <T> PVector3D.Builder<T>
builder()
Creates a builder forPVector3D
.static <T> PVector3D<T>
copyOf(PVector3DType<T> instance)
Creates an immutable copy of aPVector3DType
value.boolean
equals(java.lang.Object another)
This instance is equal to all instances ofPVector3D
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:x
,y
,z
.static <T> PVector3D<T>
of(double x, double y, double z)
Construct a new immutablePVector3D
instance.java.lang.String
toString()
Prints the immutable valuePVector3D
with attribute values.PVector3D<T>
withX(double value)
Copy the current immutable object by setting a value for thex
attribute.PVector3D<T>
withY(double value)
Copy the current immutable object by setting a value for they
attribute.PVector3D<T>
withZ(double value)
Copy the current immutable object by setting a value for thez
attribute.double
x()
double
y()
double
z()
-
Method Details
-
x
public double x()- Specified by:
x
in interfacePVector3DType<T>
- Specified by:
x
in interfaceVectorReadable2DType
- Returns:
- The value of the
x
attribute
-
y
public double y()- Specified by:
y
in interfacePVector3DType<T>
- Specified by:
y
in interfaceVectorReadable2DType
- Returns:
- The value of the
y
attribute
-
z
public double z()- Specified by:
z
in interfacePVector3DType<T>
- Specified by:
z
in interfaceVectorReadable3DType
- Returns:
- The value of the
z
attribute
-
withX
Copy the current immutable object by setting a value for thex
attribute. A value strict bits equality used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for x- Returns:
- A modified copy of the
this
object
-
withY
Copy the current immutable object by setting a value for they
attribute. A value strict bits equality used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for y- Returns:
- A modified copy of the
this
object
-
withZ
Copy the current immutable object by setting a value for thez
attribute. A value strict bits equality used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for z- Returns:
- A modified copy of the
this
object
-
equals
public boolean equals(java.lang.Object another)This instance is equal to all instances ofPVector3D
that have equal attribute values.- Overrides:
equals
in classjava.lang.Object
- Returns:
true
ifthis
is equal toanother
instance
-
hashCode
public int hashCode()Computes a hash code from attributes:x
,y
,z
.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hashCode value
-
toString
public java.lang.String toString()Prints the immutable valuePVector3D
with attribute values.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the value
-
of
Construct a new immutablePVector3D
instance.- Type Parameters:
T
- generic parameter T- Parameters:
x
- The value for thex
attributey
- The value for they
attributez
- The value for thez
attribute- Returns:
- An immutable PVector3D instance
-
copyOf
Creates an immutable copy of aPVector3DType
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:
T
- generic parameter T- Parameters:
instance
- The instance to copy- Returns:
- A copied immutable PVector3D instance
-
builder
Creates a builder forPVector3D
.PVector3D.<T>builder() .setX(double) // required
x
.setY(double) // requiredy
.setZ(double) // requiredz
.build();- Type Parameters:
T
- generic parameter T- Returns:
- A new PVector3D builder
-