Class Quaternion4F
java.lang.Object
com.io7m.jtensors.core.quaternions.Quaternion4F
- All Implemented Interfaces:
Quaternion4FType
,QuaternionReadable4FType
public final class Quaternion4F extends java.lang.Object implements Quaternion4FType
The type of 4D
float
-typed quaternions.-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Quaternion4F.Builder
Builds instances of typeQuaternion4F
. -
Method Summary
Modifier and Type Method Description static Quaternion4F.Builder
builder()
Creates a builder forQuaternion4F
.static Quaternion4F
copyOf(Quaternion4FType instance)
Creates an immutable copy of aQuaternion4FType
value.boolean
equals(java.lang.Object another)
This instance is equal to all instances ofQuaternion4F
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:x
,y
,z
,w
.static Quaternion4F
of(float x, float y, float z, float w)
Construct a new immutableQuaternion4F
instance.java.lang.String
toString()
Prints the immutable valueQuaternion4F
with attribute values.float
w()
Quaternion4F
withW(float value)
Copy the current immutable object by setting a value for thew
attribute.Quaternion4F
withX(float value)
Copy the current immutable object by setting a value for thex
attribute.Quaternion4F
withY(float value)
Copy the current immutable object by setting a value for they
attribute.Quaternion4F
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 interfaceQuaternion4FType
- Specified by:
x
in interfaceQuaternionReadable4FType
- Returns:
- The value of the
x
attribute
-
y
public float y()- Specified by:
y
in interfaceQuaternion4FType
- Specified by:
y
in interfaceQuaternionReadable4FType
- Returns:
- The value of the
y
attribute
-
z
public float z()- Specified by:
z
in interfaceQuaternion4FType
- Specified by:
z
in interfaceQuaternionReadable4FType
- Returns:
- The value of the
z
attribute
-
w
public float w()- Specified by:
w
in interfaceQuaternion4FType
- Specified by:
w
in interfaceQuaternionReadable4FType
- Returns:
- The value of the
w
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
-
withW
Copy the current immutable object by setting a value for thew
attribute. A value strict bits equality used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for w- Returns:
- A modified copy of the
this
object
-
equals
public boolean equals(java.lang.Object another)This instance is equal to all instances ofQuaternion4F
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
,w
.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hashCode value
-
toString
public java.lang.String toString()Prints the immutable valueQuaternion4F
with attribute values.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the value
-
of
Construct a new immutableQuaternion4F
instance.- Parameters:
x
- The value for thex
attributey
- The value for they
attributez
- The value for thez
attributew
- The value for thew
attribute- Returns:
- An immutable Quaternion4F instance
-
copyOf
Creates an immutable copy of aQuaternion4FType
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 Quaternion4F instance
-
builder
Creates a builder forQuaternion4F
.Quaternion4F.builder() .setX(float) // required
x
.setY(float) // requiredy
.setZ(float) // requiredz
.setW(float) // requiredw
.build();- Returns:
- A new Quaternion4F builder
-