Package com.io7m.jcamera

Class JCameraRotationCoefficients

java.lang.Object
com.io7m.jcamera.JCameraRotationCoefficients
All Implemented Interfaces:
JCameraRotationCoefficientsType
public final class JCameraRotationCoefficients extends Object implements JCameraRotationCoefficientsType
A pair of rotation coefficients.

  • Method Details

    • horizontal

      public double horizontal()
      Specified by:
      horizontal in interface JCameraRotationCoefficientsType
      Returns:
      The horizontal coefficient

    • vertical

      public double vertical()
      Specified by:
      vertical in interface JCameraRotationCoefficientsType
      Returns:
      The vertical coefficient

    • withHorizontal

      public final JCameraRotationCoefficients withHorizontal(double value)
      Copy the current immutable object by setting a value for the horizontal attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for horizontal
      Returns:
      A modified copy of the this object

    • withVertical

      public final JCameraRotationCoefficients withVertical(double value)
      Copy the current immutable object by setting a value for the vertical attribute. A value strict bits equality used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for vertical
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(Object another)
      This instance is equal to all instances of JCameraRotationCoefficients that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: horizontal, vertical.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • of

      public static JCameraRotationCoefficients of(double horizontal, double vertical)
      Construct a new immutable JCameraRotationCoefficients instance.
      Parameters:
      horizontal - The value for the horizontal attribute
      vertical - The value for the vertical attribute
      Returns:
      An immutable JCameraRotationCoefficients instance

    • copyOf

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

    • builder

      public static JCameraRotationCoefficients.Builder builder()
      Creates a builder for JCameraRotationCoefficients. 
       JCameraRotationCoefficients.builder()
    .setHorizontal(double) // optional horizontal
    .setVertical(double) // optional vertical
    .build();
      Returns:
      A new JCameraRotationCoefficients builder