All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.vecmath.Tuple2f

java.lang.Object
   |
   +----java.vecmath.Tuple2f

public abstract class Tuple2f
extends Object
A generic 2 element tuple that is represented by single precision floating point x,y coordinates.


Variable Index

 o x
The x coordinate.
 o y
The y coordinate.

Constructor Index

 o Tuple2f()
Constructs and initializes a Tuple2f to (0,0).
 o Tuple2f(float, float)
Constructs and initializes a Tuple2f from the specified xy coordinates.
 o Tuple2f(float[])
Constructs and initializes a Tuple2f from the specified array.
 o Tuple2f(Tuple2f)
Constructs and initializes a Tuple2f from the specified Tuple2f.

Method Index

 o absolute()
Sets each component of this tuple to its absolute value.
 o absolute(Tuple2f)
Sets each component of the tuple parameter to its absolute value and places the modified values into this tuple.
 o add(Tuple2f)
Sets the value of this tuple to the vector sum of itself and tuple t1.
 o add(Tuple2f, Tuple2f)
Sets the value of this tuple to the vector sum of tuples v1 and v2.
 o clamp(float, float)
Clamps this tuple to the range [low, high].
 o clamp(float, float, Tuple2f)
Clamps the tuple parameter to the range [low, high] and places the values into this tuple.
 o clampMax(float)
Clamps the maximum value of this tuple to the max parameter.
 o clampMax(float, Tuple2f)
Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple.
 o clampMin(float)
Clamps the minimum value of this tuple to the min parameter.
 o clampMin(float, Tuple2f)
Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.
 o epsilonEquals(Tuple2f, float)
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.
 o equals(Tuple2f)
Returns true if all of the data members of Tuple2f t1 are equal to the corresponding data members in this Tuple2f.
 o get(float[])
Copies the value of the elements of this tuple into the array t[].
 o hashCode()
Returns a hash number based on the data values in this object.
 o interpolate(Tuple2f, float)
Linearly interpolates between this tuple and tuple t1 and places the result into this tuple: this = alpha*this + (1-alpha)*t1.
 o interpolate(Tuple2f, Tuple2f, float)
Linearly interpolates between tuples t1 and t2 and places the result into this tuple: this = alpha*t1 + (1-alpha)*t2.
 o negate()
Negates the value of this vector in place.
 o negate(Tuple2f)
Sets the value of this tuple to the negation of tuple t1.
 o scale(float)
Sets the value of this tuple to the scalar multiplication of itself.
 o scale(float, Tuple2f)
Sets the value of this tuple to the scalar multiplication of tuple t1.
 o scaleAdd(float, Tuple2f, Tuple2f)
Sets the value of this tuple to the scalar multiplication of tuple t1 and then adds tuple t2 (this = s*t1 + t2).
 o set(float, float)
Sets the value of this tuple to the specified xy coordinates.
 o set(float[])
Sets the value of this tuple from the 2 values specified in the array.
 o set(Tuple2f)
Sets the value of this tuple to the value of the Tuple2f argument.
 o sub(Tuple2f)
Sets the value of this tuple to the vector difference of itself and tuple t1 (this = this - t1).
 o sub(Tuple2f, Tuple2f)
Sets the value of this tuple to the vector difference of tuple t1 and t2 (this = t1 - t2).
 o toString()
Returns a string that contains the values of this Tuple2f.

Variables

 o x
 public float x
The x coordinate.

 o y
 public float y
The y coordinate.

Constructors

 o Tuple2f
 public Tuple2f(float x,
                float y)
Constructs and initializes a Tuple2f from the specified xy coordinates.

Parameters:
x - the x coordinate
y - the y coordinate
 o Tuple2f
 public Tuple2f(float t[])
Constructs and initializes a Tuple2f from the specified array.

Parameters:
t - the array of length 2 containing xy in order
 o Tuple2f
 public Tuple2f(Tuple2f t1)
Constructs and initializes a Tuple2f from the specified Tuple2f.

Parameters:
t1 - the Tuple2f containing the initialization x y data
 o Tuple2f
 public Tuple2f()
Constructs and initializes a Tuple2f to (0,0).

Methods

 o set
 public final void set(float x,
                       float y)
Sets the value of this tuple to the specified xy coordinates.

Parameters:
x - the x coordinate
y - the y coordinate
 o set
 public final void set(float t[])
Sets the value of this tuple from the 2 values specified in the array.

Parameters:
t - the array of length 2 containing xy in order
 o set
 public final void set(Tuple2f t1)
Sets the value of this tuple to the value of the Tuple2f argument.

Parameters:
t1 - the tuple to be copied
 o 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
 o add
 public final void add(Tuple2f t1,
                       Tuple2f t2)
Sets the value of this tuple to the vector sum of tuples v1 and v2.

Parameters:
t1 - the first tuple
t2 - the second tuple
 o add
 public final void add(Tuple2f t1)
Sets the value of this tuple to the vector sum of itself and tuple t1.

Parameters:
t1 - the other tuple
 o sub
 public final void sub(Tuple2f t1,
                       Tuple2f 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
 o sub
 public final void sub(Tuple2f t1)
Sets the value of this tuple to the vector difference of itself and tuple t1 (this = this - t1).

Parameters:
v1 - the other vector
 o negate
 public final void negate(Tuple2f t1)
Sets the value of this tuple to the negation of tuple t1.

Parameters:
t1 - the source vector
 o negate
 public final void negate()
Negates the value of this vector in place.

 o scale
 public final void scale(float s,
                         Tuple2f t1)
Sets the value of this tuple to the scalar multiplication of tuple t1.

Parameters:
s - the scalar value
t1 - the source tuple
 o scale
 public final void scale(float s)
Sets the value of this tuple to the scalar multiplication of itself.

Parameters:
s - the scalar value
 o scaleAdd
 public final void scaleAdd(float s,
                            Tuple2f t1,
                            Tuple2f 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
 o hashCode
 public int hashCode()
Returns a hash number based on the data values in this object. Two different Tuple2f objects with identical data values (ie, returns true for equals(Tuple2f) ) will return the same hash number. Two vectors with different data members may return the same hash value, although this is not likely.

Returns:
the integer hash value
Overrides:
hashCode in class Object
 o equals
 public boolean equals(Tuple2f t1)
Returns true if all of the data members of Tuple2f t1 are equal to the corresponding data members in this Tuple2f.

Parameters:
t1 - The vector with which the comparison is made.
Returns:
true or false
 o epsilonEquals
 public boolean epsilonEquals(Tuple2f 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
 o toString
 public String toString()
Returns a string that contains the values of this Tuple2f. The form is (x,y).

Returns:
the String representation
Overrides:
toString in class Object
 o clamp
 public final void clamp(float min,
                         float max,
                         Tuple2f 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
 o clampMin
 public final void clampMin(float min,
                            Tuple2f 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
 o clampMax
 public final void clampMax(float max,
                            Tuple2f 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
 o absolute
 public final void absolute(Tuple2f 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
 o 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
 o 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
 o 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
 o absolute
 public final void absolute()
Sets each component of this tuple to its absolute value.

 o interpolate
 public final void interpolate(Tuple2f t1,
                               Tuple2f t2,
                               float alpha)
Linearly interpolates between tuples t1 and t2 and places the result into this tuple: this = alpha*t1 + (1-alpha)*t2.

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

Parameters:
t1 - the first tuple
alpha - the alpha interpolation parameter

All Packages  Class Hierarchy  This Package  Previous  Next  Index