Package javax.vecmath

Class AxisAngle4f

  • All Implemented Interfaces:
    Serializable, Cloneable

    public class AxisAngle4f
    extends Object
    implements Serializable, Cloneable
    A four-element axis angle represented by single-precision floating point x,y,z,angle components. An axis angle is a rotation of angle (radians) about the vector (x,y,z).
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      float angle
      The angle of rotation in radians.
      float x
      The x coordinate.
      float y
      The y coordinate.
      float z
      The z coordinate.
    • Constructor Summary

      Constructors 
      Constructor Description
      AxisAngle4f()
      Constructs and initializes an AxisAngle4f to (0,0,1,0).
      AxisAngle4f​(float[] a)
      Constructs and initializes an AxisAngle4f from the array of length 4.
      AxisAngle4f​(float x, float y, float z, float angle)
      Constructs and initializes a AxisAngle4f from the specified xyzw coordinates.
      AxisAngle4f​(AxisAngle4d a1)
      Constructs and initializes an AxisAngle4f from the specified AxisAngle4d.
      AxisAngle4f​(AxisAngle4f a1)
      Constructs and initializes an AxisAngle4f from the specified AxisAngle4f.
      AxisAngle4f​(Vector3f axis, float angle)
      Constructs and initializes an AxisAngle4f from the specified axis and angle.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Object clone()
      Creates a new object of the same class as this object.
      boolean epsilonEquals​(AxisAngle4f a1, float epsilon)
      Returns true if the L-infinite distance between this axis-angle and axis-angle a1 is less than or equal to the epsilon parameter, otherwise returns false.
      boolean equals​(Object o1)
      Returns true if the Object o1 is of type AxisAngle4f and all of the data members of o1 are equal to the corresponding data members in this AxisAngle4f.
      boolean equals​(AxisAngle4f a1)
      Returns true if all of the data members of AxisAngle4f a1 are equal to the corresponding data members in this AxisAngle4f.
      void get​(float[] a)
      Copies the value of this axis-angle into the array a.
      float getAngle()
      Get the axis angle, in radians.
      An axis angle is a rotation angle about the vector (x,y,z).
      float getX()
      Get value of x coordinate.
      float getY()
      Get value of y coordinate.
      float getZ()
      Get value of z coordinate.
      int hashCode()
      Returns a hash code value based on the data values in this object.
      void set​(float[] a)
      Sets the value of this axis-angle to the specified values in the array of length 4.
      void set​(float x, float y, float z, float angle)
      Sets the value of this axis-angle to the specified x,y,z,angle.
      void set​(AxisAngle4d a1)
      Sets the value of this axis-angle to the value of axis-angle a1.
      void set​(AxisAngle4f a1)
      Sets the value of this axis-angle to the value of axis-angle a1.
      void set​(Matrix3d m1)
      Sets the value of this axis-angle to the rotational component of the passed matrix.
      void set​(Matrix3f m1)
      Sets the value of this axis-angle to the rotational component of the passed matrix.
      void set​(Matrix4d m1)
      Sets the value of this axis-angle to the rotational component of the passed matrix.
      void set​(Matrix4f m1)
      Sets the value of this axis-angle to the rotational component of the passed matrix.
      void set​(Quat4d q1)
      Sets the value of this axis-angle to the rotational equivalent of the passed quaternion.
      void set​(Quat4f q1)
      Sets the value of this axis-angle to the rotational equivalent of the passed quaternion.
      void set​(Vector3f axis, float angle)
      Sets the value of this AxisAngle4f to the specified axis and angle.
      void setAngle​(float angle)
      Set the axis angle, in radians.
      An axis angle is a rotation angle about the vector (x,y,z).
      void setX​(float x)
      Set a new value for x coordinate.
      void setY​(float y)
      Set a new value for y coordinate.
      void setZ​(float z)
      Set a new value for z coordinate.
      String toString()
      Returns a string that contains the values of this AxisAngle4f.
    • Field Detail

      • x

        public float x
        The x coordinate.
      • y

        public float y
        The y coordinate.
      • z

        public float z
        The z coordinate.
      • angle

        public float angle
        The angle of rotation in radians.
    • Constructor Detail

      • AxisAngle4f

        public AxisAngle4f​(float x,
                           float y,
                           float z,
                           float angle)
        Constructs and initializes a AxisAngle4f from the specified xyzw coordinates.
        Parameters:
        x - the x coordinate
        y - the y coordinate
        z - the z coordinate
        angle - the angle of rotation in radians
      • AxisAngle4f

        public AxisAngle4f​(float[] a)
        Constructs and initializes an AxisAngle4f from the array of length 4.
        Parameters:
        a - the array of length 4 containing x,y,z,angle in order
      • AxisAngle4f

        public AxisAngle4f​(AxisAngle4f a1)
        Constructs and initializes an AxisAngle4f from the specified AxisAngle4f.
        Parameters:
        a1 - the AxisAngle4f containing the initialization x y z angle data
      • AxisAngle4f

        public AxisAngle4f​(AxisAngle4d a1)
        Constructs and initializes an AxisAngle4f from the specified AxisAngle4d.
        Parameters:
        a1 - the AxisAngle4d containing the initialization x y z angle data
      • AxisAngle4f

        public AxisAngle4f​(Vector3f axis,
                           float angle)
        Constructs and initializes an AxisAngle4f from the specified axis and angle.
        Parameters:
        axis - the axis
        angle - the angle of rotation in radians
        Since:
        vecmath 1.2
      • AxisAngle4f

        public AxisAngle4f()
        Constructs and initializes an AxisAngle4f to (0,0,1,0).
    • Method Detail

      • set

        public final void set​(float x,
                              float y,
                              float z,
                              float angle)
        Sets the value of this axis-angle to the specified x,y,z,angle.
        Parameters:
        x - the x coordinate
        y - the y coordinate
        z - the z coordinate
        angle - the angle of rotation in radians
      • set

        public final void set​(float[] a)
        Sets the value of this axis-angle to the specified values in the array of length 4.
        Parameters:
        a - the array of length 4 containing x,y,z,angle in order
      • set

        public final void set​(AxisAngle4f a1)
        Sets the value of this axis-angle to the value of axis-angle a1.
        Parameters:
        a1 - the axis-angle to be copied
      • set

        public final void set​(AxisAngle4d a1)
        Sets the value of this axis-angle to the value of axis-angle a1.
        Parameters:
        a1 - the axis-angle to be copied
      • set

        public final void set​(Vector3f axis,
                              float angle)
        Sets the value of this AxisAngle4f to the specified axis and angle.
        Parameters:
        axis - the axis
        angle - the angle of rotation in radians
        Since:
        vecmath 1.2
      • get

        public final void get​(float[] a)
        Copies the value of this axis-angle into the array a.
        Parameters:
        a - the array
      • set

        public final void set​(Quat4f q1)
        Sets the value of this axis-angle to the rotational equivalent of the passed quaternion. If the specified quaternion has no rotational component, the value of this AxisAngle4f is set to an angle of 0 about an axis of (0,1,0).
        Parameters:
        q1 - the Quat4f
      • set

        public final void set​(Quat4d q1)
        Sets the value of this axis-angle to the rotational equivalent of the passed quaternion. If the specified quaternion has no rotational component, the value of this AxisAngle4f is set to an angle of 0 about an axis of (0,1,0).
        Parameters:
        q1 - the Quat4d
      • set

        public final void set​(Matrix4f m1)
        Sets the value of this axis-angle to the rotational component of the passed matrix. If the specified matrix has no rotational component, the value of this AxisAngle4f is set to an angle of 0 about an axis of (0,1,0).
        Parameters:
        m1 - the matrix4f
      • set

        public final void set​(Matrix4d m1)
        Sets the value of this axis-angle to the rotational component of the passed matrix. If the specified matrix has no rotational component, the value of this AxisAngle4f is set to an angle of 0 about an axis of (0,1,0).
        Parameters:
        m1 - the matrix4d
      • set

        public final void set​(Matrix3f m1)
        Sets the value of this axis-angle to the rotational component of the passed matrix. If the specified matrix has no rotational component, the value of this AxisAngle4f is set to an angle of 0 about an axis of (0,1,0).
        Parameters:
        m1 - the matrix3f
      • set

        public final void set​(Matrix3d m1)
        Sets the value of this axis-angle to the rotational component of the passed matrix. If the specified matrix has no rotational component, the value of this AxisAngle4f is set to an angle of 0 about an axis of (0,1,0).
        Parameters:
        m1 - the matrix3d
      • toString

        public String toString()
        Returns a string that contains the values of this AxisAngle4f. The form is (x,y,z,angle).
        Overrides:
        toString in class Object
        Returns:
        the String representation
      • equals

        public boolean equals​(AxisAngle4f a1)
        Returns true if all of the data members of AxisAngle4f a1 are equal to the corresponding data members in this AxisAngle4f.
        Parameters:
        a1 - the axis-angle with which the comparison is made
        Returns:
        true or false
      • equals

        public boolean equals​(Object o1)
        Returns true if the Object o1 is of type AxisAngle4f and all of the data members of o1 are equal to the corresponding data members in this AxisAngle4f.
        Overrides:
        equals in class Object
        Parameters:
        o1 - the object with which the comparison is made
        Returns:
        true or false
      • epsilonEquals

        public boolean epsilonEquals​(AxisAngle4f a1,
                                     float epsilon)
        Returns true if the L-infinite distance between this axis-angle and axis-angle a1 is less than or equal to the epsilon parameter, otherwise returns false. The L-infinite distance is equal to MAX[abs(x1-x2), abs(y1-y2), abs(z1-z2), abs(angle1-angle2)].
        Parameters:
        a1 - the axis-angle to be compared to this axis-angle
        epsilon - the threshold value
      • hashCode

        public int hashCode()
        Returns a hash code value based on the data values in this object. Two different AxisAngle4f objects with identical data values (i.e., AxisAngle4f.equals returns true) will return the same hash code value. Two objects with different data members may return the same hash value, although this is not likely.
        Overrides:
        hashCode in class Object
        Returns:
        the integer hash code value
      • clone

        public Object clone()
        Creates a new object of the same class as this object.
        Overrides:
        clone in class Object
        Returns:
        a clone of this instance.
        Throws:
        OutOfMemoryError - if there is not enough memory.
        Since:
        vecmath 1.3
        See Also:
        Cloneable
      • getAngle

        public final float getAngle()
        Get the axis angle, in radians.
        An axis angle is a rotation angle about the vector (x,y,z).
        Returns:
        Returns the angle, in radians.
        Since:
        vecmath 1.5
      • setAngle

        public final void setAngle​(float angle)
        Set the axis angle, in radians.
        An axis angle is a rotation angle about the vector (x,y,z).
        Parameters:
        angle - The angle to set, in radians.
        Since:
        vecmath 1.5
      • getX

        public final float getX()
        Get value of x coordinate.
        Returns:
        the x coordinate.
        Since:
        vecmath 1.5
      • setX

        public final void setX​(float x)
        Set a new value for x coordinate.
        Parameters:
        x - the x coordinate.
        Since:
        vecmath 1.5
      • getY

        public final float getY()
        Get value of y coordinate.
        Returns:
        the y coordinate
        Since:
        vecmath 1.5
      • setY

        public final void setY​(float y)
        Set a new value for y coordinate.
        Parameters:
        y - the y coordinate.
        Since:
        vecmath 1.5
      • getZ

        public final float getZ()
        Get value of z coordinate.
        Returns:
        the z coordinate.
        Since:
        vecmath 1.5
      • setZ

        public final void setZ​(float z)
        Set a new value for z coordinate.
        Parameters:
        z - the z coordinate.
        Since:
        vecmath 1.5