Package javax.vecmath

Class Tuple3d

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    Point3d, Vector3d

    public abstract class Tuple3d
    extends java.lang.Object
    implements java.io.Serializable
    A generic 3 element tuple that is represented by double precision floating point x,y and z coordinates.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      double x
      The x coordinate.
      double y
      The y coordinate.
      double z
      The z coordinate.
    • Constructor Summary

      Constructors 
      Constructor Description
      Tuple3d()
      Constructs and initializes a Tuple3d to (0,0,0).
      Tuple3d​(double[] t)
      Constructs and initializes a Tuple3d from the specified array.
      Tuple3d​(double x, double y, double z)
      Constructs and initializes a Tuple3d from the specified xyz coordinates.
      Tuple3d​(Tuple3d t1)
      Constructs and initializes a Tuple3d from the specified Tuple3d.
      Tuple3d​(Tuple3f t1)
      Constructs and initializes a Tuple3d from the specified Tuple3f.
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void absolute()
      Sets each component of this tuple to its absolute value.
      void absolute​(Tuple3d t)
      Sets each component of the tuple parameter to its absolute value and places the modified values into this tuple.
      void add​(Tuple3d t1)
      Sets the value of this tuple to the vector sum of itself and tuple t1.
      void add​(Tuple3d t1, Tuple3d t2)
      Sets the value of this tuple to the vector sum of tuples t1 and t2.
      void clamp​(double min, double max)
      Clamps this tuple to the range [low, high].
      void clamp​(double min, double max, Tuple3d t)
      Clamps the tuple parameter to the range [low, high] and places the values into this tuple.
      void clamp​(float min, float max)
      Deprecated.
      As of Java3D API 1.1 Beta02
      void clamp​(float min, float max, Tuple3d t)
      Deprecated.
      As of Java3D API 1.1 Beta02
      void clampMax​(double max)
      Clamps the maximum value of this tuple to the max parameter.
      void clampMax​(double max, Tuple3d t)
      Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple.
      void clampMax​(float max)
      Deprecated.
      As of Java3D API 1.1 Beta02
      void clampMax​(float max, Tuple3d t)
      Deprecated.
      As of Java3D API 1.1 Beta02
      void clampMin​(double min)
      Clamps the minimum value of this tuple to the min parameter.
      void clampMin​(double min, Tuple3d t)
      Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.
      void clampMin​(float min)
      Deprecated.
      As of Java3D API 1.1 Beta02
      void clampMin​(float min, Tuple3d t)
      Deprecated.
      As of Java3D API 1.1 Beta02
      boolean epsilonEquals​(Tuple3d t1, double epsilon)
      Returns true if the L-infinite distance between this tuple and tuple t1 is less than or equal to the epsilon parameter, otherwise returns false.
      boolean equals​(Tuple3d t1)
      Returns true if all of the data members of Tuple3d t1 are equal to the corresponding data members in this
      void get​(double[] t)
      Copies the value of the elements of this tuple into the array t[].
      void get​(Tuple3d t)
      Gets the value of this tuple and copies the values into the Tuple3d.
      int hashCode()
      Returns a hash number based on the data values in this object.
      void interpolate​(Tuple3d t1, double alpha)
      Linearly interpolates between this tuple and tuple t1 and places the result into this tuple: this = (1-alpha)*this + alpha*t1.
      void interpolate​(Tuple3d t1, float alpha)
      Deprecated.
      As of Java3D API 1.1 Beta02
      void interpolate​(Tuple3d t1, Tuple3d t2, double alpha)
      Linearly interpolates between tuples t1 and t2 and places the result into this tuple: this = (1-alpha)*t1 + alpha*t2.
      void interpolate​(Tuple3d t1, Tuple3d t2, float alpha)
      Deprecated.
      As of Java3D API 1.1 Beta02
      void negate()
      Negates the value of this vector in place.
      void negate​(Tuple3d t1)
      Sets the value of this tuple to the negation of tuple t1.
      void scale​(double s)
      Sets the value of this tuple to the scalar multiplication of itself.
      void scale​(double s, Tuple3d t1)
      Sets the value of this tuple to the scalar multiplication of tuple t1.
      void scaleAdd​(double s, Tuple3d t1)
      Sets the value of this tuple to the scalar multiplication of itself and then adds tuple t1 (this = s*this + t1).
      void scaleAdd​(double s, Tuple3d t1, Tuple3d t2)
      Sets the value of this tuple to the scalar multiplication of tuple t1 and then adds tuple t2 (this = s*t1 + t2).
      void set​(double[] t)
      Sets the value of this tuple from the 3 values specified in the array.
      void set​(double x, double y, double z)
      Sets the value of this tuple to the specified xyz coordinates.
      void set​(Tuple3d t1)
      Sets the value of this tuple to the value of the Tuple3d argument.
      void set​(Tuple3f t1)
      Sets the value of this tuple to the value of the Tuple3f argument.
      void sub​(Tuple3d t1)
      Sets the value of this tuple to the vector difference of itself and tuple t1 (this = this - t1).
      void sub​(Tuple3d t1, Tuple3d t2)
      Sets the value of this tuple to the vector difference of tuple t1 and t2 (this = t1 - t2).
      java.lang.String toString()
      Returns a string that contains the values of this Tuple3d.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • x

        public double x
        The x coordinate.
      • y

        public double y
        The y coordinate.
      • z

        public double z
        The z coordinate.
    • Constructor Detail

      • Tuple3d

        public Tuple3d​(double x,
                       double y,
                       double z)
        Constructs and initializes a Tuple3d from the specified xyz coordinates.
        Parameters:
        x - the x coordinate
        y - the y coordinate
        z - the z coordinate
      • Tuple3d

        public Tuple3d​(double[] t)
        Constructs and initializes a Tuple3d from the specified array.
        Parameters:
        t - the array of length 3 containing xyz in order
      • Tuple3d

        public Tuple3d​(Tuple3d t1)
        Constructs and initializes a Tuple3d from the specified Tuple3d.
        Parameters:
        t1 - the Tuple3d containing the initialization x y z data
      • Tuple3d

        public Tuple3d​(Tuple3f t1)
        Constructs and initializes a Tuple3d from the specified Tuple3f.
        Parameters:
        t1 - the Tuple3f containing the initialization x y z data
      • Tuple3d

        public Tuple3d()
        Constructs and initializes a Tuple3d to (0,0,0).
    • Method Detail

      • set

        public final void set​(double x,
                              double y,
                              double z)
        Sets the value of this tuple to the specified xyz coordinates.
        Parameters:
        x - the x coordinate
        y - the y coordinate
        z - the z coordinate
      • set

        public final void set​(double[] t)
        Sets the value of this tuple from the 3 values specified in the array.
        Parameters:
        t - the array of length 3 containing xyz in order
      • set

        public final void set​(Tuple3d t1)
        Sets the value of this tuple to the value of the Tuple3d argument.
        Parameters:
        t1 - the tuple to be copied
      • set

        public final void set​(Tuple3f t1)
        Sets the value of this tuple to the value of the Tuple3f argument.
        Parameters:
        t1 - the tuple to be copied
      • get

        public final void get​(double[] t)
        Copies the value of the elements of this tuple into the array t[].
        Parameters:
        t - the array that will contain the values of the vector
      • get

        public final void get​(Tuple3d t)
        Gets the value of this tuple and copies the values into the Tuple3d.
        Parameters:
        t - Tuple3d object into which that values of this object are copied
      • add

        public final void add​(Tuple3d t1,
                              Tuple3d t2)
        Sets the value of this tuple to the vector sum of tuples t1 and t2.
        Parameters:
        t1 - the first tuple
        t2 - the second tuple
      • add

        public final void add​(Tuple3d t1)
        Sets the value of this tuple to the vector sum of itself and tuple t1.
        Parameters:
        t1 - the other tuple
      • sub

        public final void sub​(Tuple3d t1,
                              Tuple3d t2)
        Sets the value of this tuple to the vector difference of tuple t1 and t2 (this = t1 - t2).
        Parameters:
        t1 - the first tuple
        t2 - the second tuple
      • sub

        public final void sub​(Tuple3d t1)
        Sets the value of this tuple to the vector difference of itself and tuple t1 (this = this - t1).
        Parameters:
        t1 - the other tuple
      • negate

        public final void negate​(Tuple3d t1)
        Sets the value of this tuple to the negation of tuple t1.
        Parameters:
        t1 - the source vector
      • negate

        public final void negate()
        Negates the value of this vector in place.
      • scale

        public final void scale​(double s,
                                Tuple3d t1)
        Sets the value of this tuple to the scalar multiplication of tuple t1.
        Parameters:
        s - the scalar value
        t1 - the source tuple
      • scale

        public final void scale​(double s)
        Sets the value of this tuple to the scalar multiplication of itself.
        Parameters:
        s - the scalar value
      • scaleAdd

        public final void scaleAdd​(double s,
                                   Tuple3d t1,
                                   Tuple3d t2)
        Sets the value of this tuple to the scalar multiplication of tuple t1 and then adds tuple t2 (this = s*t1 + t2).
        Parameters:
        s - the scalar value
        t1 - the tuple to be multipled
        t2 - the tuple to be added
      • scaleAdd

        public final void scaleAdd​(double s,
                                   Tuple3d t1)
        Sets the value of this tuple to the scalar multiplication of itself and then adds tuple t1 (this = s*this + t1).
        Parameters:
        s - the scalar value
        t1 - the tuple to be added
      • hashCode

        public int hashCode()
        Returns a hash number based on the data values in this object. Two different Tuple3d objects with identical data values (ie, returns true for equals(Tuple3d) ) will return the same hash number. Two vectors with different data members may return the same hash value, although this is not likely.
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(Tuple3d t1)
        Returns true if all of the data members of Tuple3d t1 are equal to the corresponding data members in this
        Parameters:
        t1 - the vector with which the comparison is made.
      • epsilonEquals

        public boolean epsilonEquals​(Tuple3d t1,
                                     double epsilon)
        Returns true if the L-infinite distance between this tuple and tuple t1 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)].
        Parameters:
        t1 - the tuple to be compared to this tuple
        epsilon - the threshold value
      • toString

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

        public final void absolute​(Tuple3d t)
        Sets each component of the tuple parameter to its absolute value and places the modified values into this tuple.
        Parameters:
        t - the source tuple, which will not be modified
      • absolute

        public final void absolute()
        Sets each component of this tuple to its absolute value.
      • clamp

        public final void clamp​(float min,
                                float max)
        Deprecated.
        As of Java3D API 1.1 Beta02
        Clamps this tuple to the range [low, high].
        Parameters:
        min - the lowest value in this tuple after clamping
        max - the highest value in this tuple after clamping
      • clamp

        public final void clamp​(float min,
                                float max,
                                Tuple3d t)
        Deprecated.
        As of Java3D API 1.1 Beta02
        Clamps the tuple parameter to the range [low, high] and places the values into this tuple.
        Parameters:
        min - the lowest value in the tuple after clamping
        max - the highest value in the tuple after clamping
        t - the source tuple, which will not be modified
      • clampMin

        public final void clampMin​(float min)
        Deprecated.
        As of Java3D API 1.1 Beta02
        Clamps the minimum value of this tuple to the min parameter.
        Parameters:
        min - the lowest value in this tuple after clamping
      • clampMin

        public final void clampMin​(float min,
                                   Tuple3d t)
        Deprecated.
        As of Java3D API 1.1 Beta02
        Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.
        Parameters:
        min - the lowest value in the tuple after clamping
        t - the source tuple, which will not be modified
      • clampMax

        public final void clampMax​(float max,
                                   Tuple3d t)
        Deprecated.
        As of Java3D API 1.1 Beta02
        Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple.
        Parameters:
        max - the highest value in the tuple after clamping
        t - the source tuple, which will not be modified
      • clampMax

        public final void clampMax​(float max)
        Deprecated.
        As of Java3D API 1.1 Beta02
        Clamps the maximum value of this tuple to the max parameter.
        Parameters:
        max - the highest value in the tuple after clamping
      • clamp

        public final void clamp​(double min,
                                double max)
        Clamps this tuple to the range [low, high].
        Parameters:
        min - the lowest value in this tuple after clamping
        max - the highest value in this tuple after clamping
      • clamp

        public final void clamp​(double min,
                                double max,
                                Tuple3d t)
        Clamps the tuple parameter to the range [low, high] and places the values into this tuple.
        Parameters:
        min - the lowest value in the tuple after clamping
        max - the highest value in the tuple after clamping
        t - the source tuple, which will not be modified
      • clampMin

        public final void clampMin​(double min)
        Clamps the minimum value of this tuple to the min parameter.
        Parameters:
        min - the lowest value in this tuple after clamping
      • clampMin

        public final void clampMin​(double min,
                                   Tuple3d t)
        Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.
        Parameters:
        min - the lowest value in the tuple after clamping
        t - the source tuple, which will not be modified
      • clampMax

        public final void clampMax​(double max,
                                   Tuple3d t)
        Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple.
        Parameters:
        max - the highest value in the tuple after clamping
        t - the source tuple, which will not be modified
      • clampMax

        public final void clampMax​(double max)
        Clamps the maximum value of this tuple to the max parameter.
        Parameters:
        max - the highest value in the tuple after clamping
      • interpolate

        public final void interpolate​(Tuple3d t1,
                                      Tuple3d t2,
                                      float alpha)
        Deprecated.
        As of Java3D API 1.1 Beta02
        Linearly interpolates between tuples t1 and t2 and places the result into this tuple: this = (1-alpha)*t1 + alpha*t2.
        Parameters:
        t1 - the first tuple
        t2 - the second tuple
        alpha - the alpha interpolation parameter
      • interpolate

        public final void interpolate​(Tuple3d t1,
                                      float alpha)
        Deprecated.
        As of Java3D API 1.1 Beta02
        Linearly interpolates between this tuple and tuple t1 and places the result into this tuple: this = (1-alpha)*this + alpha*t1.
        Parameters:
        t1 - the first tuple
        alpha - the alpha interpolation parameter
      • interpolate

        public final void interpolate​(Tuple3d t1,
                                      Tuple3d t2,
                                      double alpha)
        Linearly interpolates between tuples t1 and t2 and places the result into this tuple: this = (1-alpha)*t1 + alpha*t2.
        Parameters:
        t1 - the first tuple
        t2 - the second tuple
        alpha - the alpha interpolation parameter
      • interpolate

        public final void interpolate​(Tuple3d t1,
                                      double alpha)
        Linearly interpolates between this tuple and tuple t1 and places the result into this tuple: this = (1-alpha)*this + alpha*t1.
        Parameters:
        t1 - the first tuple
        alpha - the alpha interpolation parameter