Module vecmath
Package javax.vecmath

Class Tuple3f

java.lang.Object
javax.vecmath.Tuple3f
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
Color3f, Point3f, Vector3f
public abstract class Tuple3f extends Object implements Serializable, Cloneable
A generic 3 element tuple that is represented by single precision floating point x,y and z coordinates.
Version:
specification 1.1, implementation $Revision: 1.10 $, $Date: 1999/10/05 07:03:50 $
Author:
Kenji hiranabe
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    float
    x
    The x coordinate.
    float
    y
    The y coordinate.
    float
    z
    The z coordinate.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    absolute()
    Sets each component of this tuple to its absolute value.
    final void
    absolute(Tuple3f t)
    Sets each component of the tuple parameter to its absolute value and places the modified values into this tuple.
    final void
    add(Tuple3f t1)
    Sets the value of this tuple to the vector sum of itself and tuple t1.
    final void
    add(Tuple3f t1, Tuple3f t2)
    Sets the value of this tuple to the vector sum of tuples t1 and t2.
    final void
    clamp(float min, float max)
    Clamps this tuple to the range [low, high].
    final void
    clamp(float min, float max, Tuple3f t)
    Clamps the tuple parameter to the range [low, high] and places the values into this tuple.
    final void
    clampMax(float max)
    Clamps the maximum value of this tuple to the max parameter.
    final void
    clampMax(float max, Tuple3f t)
    Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple.
    final void
    clampMin(float min)
    Clamps the minimum value of this tuple to the min parameter.
    final void
    clampMin(float min, Tuple3f t)
    Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.
    abstract Object
    clone()
     
    boolean
    epsilonEquals(Tuple3f t1, float 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(Object o1)
     
    boolean
    equals(Tuple3f t1)
    Returns true if all of the data members of Tuple3f t1 are equal to the corresponding data members in this
    final void
    get(float[] t)
    Copies the value of the elements of this tuple into the array t[].
    final void
    get(Tuple3f t)
    Gets the value of this tuple and copies the values into the Tuple3f.
    int
    hashCode()
    Returns a hash number based on the data values in this object.
    final void
    interpolate(Tuple3f t1, float alpha)
    Linearly interpolates between this tuple and tuple t1 and places the result into this tuple: this = (1-alpha)*this + alpha*t1.
    final void
    interpolate(Tuple3f t1, Tuple3f t2, float alpha)
    Linearly interpolates between tuples t1 and t2 and places the result into this tuple: this = (1-alpha)*t1 + alpha*t2.
    final void
    negate()
    Negates the value of this vector in place.
    final void
    negate(Tuple3f t1)
    Sets the value of this tuple to the negation of tuple t1.
    final void
    scale(float s)
    Sets the value of this tuple to the scalar multiplication of itself.
    final void
    scale(float s, Tuple3f t1)
    Sets the value of this tuple to the scalar multiplication of tuple t1.
    final void
    scaleAdd(float s, Tuple3f t1)
    Sets the value of this tuple to the scalar multiplication of itself and then adds tuple t1 (this = s*this + t1).
    final void
    scaleAdd(float s, Tuple3f t1, Tuple3f t2)
    Sets the value of this tuple to the scalar multiplication of tuple t1 and then adds tuple t2 (this = s*t1 + t2).
    final void
    set(float[] t)
    Sets the value of this tuple from the 3 values specified in the array.
    final void
    set(float x, float y, float z)
    Sets the value of this tuple to the specified xyz coordinates.
    final void
    set(Tuple3d t1)
    Sets the value of this tuple to the value of the Tuple3d argument.
    final void
    set(Tuple3f t1)
    Sets the value of this tuple to the value of the Tuple3f argument.
    final void
    sub(Tuple3f t1)
    Sets the value of this tuple to the vector difference of itself and tuple t1 (this = this - t1).
    final void
    sub(Tuple3f t1, Tuple3f t2)
    Sets the value of this tuple to the vector difference of tuple t1 and t2 (this = t1 - t2).
    String
    toString()
    Returns a string that contains the values of this Tuple3f.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • x

      public float x
      The x coordinate.

    • y

      public float y
      The y coordinate.

    • z

      public float z
      The z coordinate.

  • Constructor Details

    • Tuple3f

      public Tuple3f(float x, float y, float z)
      Constructs and initializes a Tuple3f from the specified xyz coordinates.
      Parameters:
      x - the x coordinate
      y - the y coordinate
      z - the z coordinate

    • Tuple3f

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

    • Tuple3f

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

    • Tuple3f

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

    • Tuple3f

      public Tuple3f()
      Constructs and initializes a Tuple3f to (0,0,0).

  • Method Details

    • set

      public final void set(float x, float y, float 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(float[] 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(Tuple3f t1)
      Sets the value of this tuple to the value of the Tuple3f argument.
      Parameters:
      t1 - the tuple to be copied

    • 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

    • get

      public final void get(float[] 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(Tuple3f t)
      Gets the value of this tuple and copies the values into the Tuple3f.
      Parameters:
      t - Tuple3f object into which that values of this object are copied

    • add

      public final void add(Tuple3f t1, Tuple3f 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(Tuple3f 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(Tuple3f t1, Tuple3f 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(Tuple3f 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(Tuple3f 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(float s, Tuple3f 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(float s)
      Sets the value of this tuple to the scalar multiplication of itself.
      Parameters:
      s - the scalar value

    • scaleAdd

      public final void scaleAdd(float s, Tuple3f t1, Tuple3f 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(float s, Tuple3f 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 Tuple3f objects with identical data values (ie, returns true for equals(Tuple3f) ) 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 Object

    • equals

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

    • equals

      public boolean equals(Object o1)
      Overrides:
      equals in class Object

    • epsilonEquals

      public boolean epsilonEquals(Tuple3f t1, float 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 String toString()
      Returns a string that contains the values of this Tuple3f. The form is (x,y,z).
      Overrides:
      toString in class Object
      Returns:
      the String representation

    • clamp

      public final void clamp(float min, float max, Tuple3f 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(float min, Tuple3f 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

    • clampMax

      public final void clampMax(float max, Tuple3f 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

    • absolute

      public final void absolute(Tuple3f 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

    • clamp

      public final void clamp(float min, float 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

    • clampMin

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

    • clampMax

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

    • absolute

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

    • interpolate

      public final void interpolate(Tuple3f t1, Tuple3f t2, float 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(Tuple3f t1, float 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

    • clone

      public abstract Object clone()
      Overrides:
      clone in class Object