Class Vector3F
java.lang.Object
com.io7m.jtensors.core.unparameterized.vectors.Vector3F
- All Implemented Interfaces:
Vector3FType
,VectorReadable2FType
,VectorReadable3FType
,VectorComputationalType
public final class Vector3F extends java.lang.Object implements Vector3FType
The type of 3D
float
-typed vectors.-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Vector3F.Builder
Builds instances of typeVector3F
. -
Method Summary
Modifier and Type Method Description static Vector3F.Builder
builder()
Creates a builder forVector3F
.static Vector3F
copyOf(Vector3FType instance)
Creates an immutable copy of aVector3FType
value.boolean
equals(java.lang.Object another)
This instance is equal to all instances ofVector3F
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:x
,y
,z
.static Vector3F
of(float x, float y, float z)
Construct a new immutableVector3F
instance.java.lang.String
toString()
Prints the immutable valueVector3F
with attribute values.Vector3F
withX(float value)
Copy the current immutable object by setting a value for thex
attribute.Vector3F
withY(float value)
Copy the current immutable object by setting a value for they
attribute.Vector3F
withZ(float value)
Copy the current immutable object by setting a value for thez
attribute.float
x()
float
y()
float
z()
-
Method Details
-
x
public float x()- Specified by:
x
in interfaceVector3FType
- Specified by:
x
in interfaceVectorReadable2FType
- Returns:
- The value of the
x
attribute
-
y
public float y()- Specified by:
y
in interfaceVector3FType
- Specified by:
y
in interfaceVectorReadable2FType
- Returns:
- The value of the
y
attribute
-
z
public float z()- Specified by:
z
in interfaceVector3FType
- Specified by:
z
in interfaceVectorReadable3FType
- 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 ofVector3F
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 valueVector3F
with attribute values.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the value
-
of
Construct a new immutableVector3F
instance.- Parameters:
x
- The value for thex
attributey
- The value for they
attributez
- The value for thez
attribute- Returns:
- An immutable Vector3F instance
-
copyOf
Creates an immutable copy of aVector3FType
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 Vector3F instance
-
builder
Creates a builder forVector3F
.Vector3F.builder() .setX(float) // required
x
.setY(float) // requiredy
.setZ(float) // requiredz
.build();- Returns:
- A new Vector3F builder
-