Package com.io7m.jtensors.core.quaternions

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 type Quaternion4F.

  • Method Summary

    Modifier and Type Method Description
    static Quaternion4F.Builder builder()
    Creates a builder for Quaternion4F.
    static Quaternion4F copyOf​(Quaternion4FType instance)
    Creates an immutable copy of a Quaternion4FType value.
    boolean equals​(java.lang.Object another)
    This instance is equal to all instances of Quaternion4F 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 immutable Quaternion4F instance.
    java.lang.String toString()
    Prints the immutable value Quaternion4F with attribute values.
    float w()  
    Quaternion4F withW​(float value)
    Copy the current immutable object by setting a value for the w attribute.
    Quaternion4F withX​(float value)
    Copy the current immutable object by setting a value for the x attribute.
    Quaternion4F withY​(float value)
    Copy the current immutable object by setting a value for the y attribute.
    Quaternion4F withZ​(float value)
    Copy the current immutable object by setting a value for the z attribute.
    float x()  
    float y()  
    float z()  

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • x

      public float x()
      Specified by:
      x in interface Quaternion4FType
      Specified by:
      x in interface QuaternionReadable4FType
      Returns:
      The value of the x attribute

    • y

      public float y()
      Specified by:
      y in interface Quaternion4FType
      Specified by:
      y in interface QuaternionReadable4FType
      Returns:
      The value of the y attribute

    • z

      public float z()
      Specified by:
      z in interface Quaternion4FType
      Specified by:
      z in interface QuaternionReadable4FType
      Returns:
      The value of the z attribute

    • w

      public float w()
      Specified by:
      w in interface Quaternion4FType
      Specified by:
      w in interface QuaternionReadable4FType
      Returns:
      The value of the w attribute

    • withX

      public final Quaternion4F withX​(float value)
      Copy the current immutable object by setting a value for the x attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for x
      Returns:
      A modified copy of the this object

    • withY

      public final Quaternion4F withY​(float value)
      Copy the current immutable object by setting a value for the y attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for y
      Returns:
      A modified copy of the this object

    • withZ

      public final Quaternion4F withZ​(float value)
      Copy the current immutable object by setting a value for the z attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for z
      Returns:
      A modified copy of the this object

    • withW

      public final Quaternion4F withW​(float value)
      Copy the current immutable object by setting a value for the w attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      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 of Quaternion4F that have equal attribute values.
      Overrides:
      equals in class java.lang.Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: x, y, z, w.
      Overrides:
      hashCode in class java.lang.Object
      Returns:
      hashCode value

    • toString

      public java.lang.String toString()
      Prints the immutable value Quaternion4F with attribute values.
      Overrides:
      toString in class java.lang.Object
      Returns:
      A string representation of the value

    • of

      public static Quaternion4F of​(float x, float y, float z, float w)
      Construct a new immutable Quaternion4F instance.
      Parameters:
      x - The value for the x attribute
      y - The value for the y attribute
      z - The value for the z attribute
      w - The value for the w attribute
      Returns:
      An immutable Quaternion4F instance

    • copyOf

      public static Quaternion4F copyOf​(Quaternion4FType instance)
      Creates an immutable copy of a Quaternion4FType 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

      public static Quaternion4F.Builder builder()
      Creates a builder for Quaternion4F. 
       Quaternion4F.builder()
    .setX(float) // required x
    .setY(float) // required y
    .setZ(float) // required z
    .setW(float) // required w
    .build();
      Returns:
      A new Quaternion4F builder