All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class javax.vecmath.Tuple2f

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

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

Version:
specification 1.1, implementation $Revision: 1.8 $, $Date: 1999/03/04 09:16:33 $
Author:
Kenji hiranabe

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(Tuple2d)
Constructs and initializes a Tuple2f from the specified Tuple2d.
 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 t1 and t2.
 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(Object)
Returns true if the Object o1 is of type Tuple2f and all of the data members of t1 are equal to the corresponding data members in this Tuple2f.
 o equals(Tuple2f)
Returns true if all of the data members of Tuple2f t1 are equal to the corresponding data members in this
 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 = (1-alpha)*this + alpha*t1.
 o interpolate(Tuple2f, Tuple2f, float)
Linearly interpolates between tuples t1 and t2 and places the result into this tuple: this = (1-alpha)*t1 + 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)
Sets the value of this tuple to the scalar multiplication of itself and then adds tuple t1 (this = s*this + 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(Tuple2d)
Sets the value of this tuple to the value of the Tuple2d argument.
 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(javax.vecmath.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(javax.vecmath.Tuple2d t1)
Constructs and initializes a Tuple2f from the specified Tuple2d.

Parameters:
t1 - the Tuple2d 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(javax.vecmath.Tuple2f t1)
Sets the value of this tuple to the value of the Tuple2f argument.

Parameters:
t1 - the tuple to be copied
 o set
 public final void set(javax.vecmath.Tuple2d t1)
Sets the value of this tuple to the value of the Tuple2d 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(javax.vecmath.Tuple2f t1,
                       javax.vecmath.Tuple2f 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
 o add
 public final void add(javax.vecmath.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(javax.vecmath.Tuple2f t1,
                       javax.vecmath.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(javax.vecmath.Tuple2f t1)
Sets the value of this tuple to the vector difference of itself and tuple t1 (this = this - t1).

Parameters:
t1 - the other tuple
 o negate
 public final void negate(javax.vecmath.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,
                         javax.vecmath.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,
                            javax.vecmath.Tuple2f t1,
                            javax.vecmath.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 scaleAdd
 public final void scaleAdd(float s,
                            javax.vecmath.Tuple2f 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
 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.

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

Parameters:
t1 - the vector with which the comparison is made.
 o equals
 public boolean equals(java.lang.Object o1)
Returns true if the Object o1 is of type Tuple2f and all of the data members of t1 are equal to the corresponding data members in this Tuple2f.

Parameters:
o1 - the object with which the comparison is made.
Overrides:
equals in class java.lang.Object
 o epsilonEquals
 public boolean epsilonEquals(javax.vecmath.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 java.lang.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 java.lang.Object
 o clamp
 public final void clamp(float min,
                         float max,
                         javax.vecmath.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,
                            javax.vecmath.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
 o clampMax
 public final void clampMax(float max,
                            javax.vecmath.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(javax.vecmath.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(javax.vecmath.Tuple2f t1,
                               javax.vecmath.Tuple2f 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
 o interpolate
 public final void interpolate(javax.vecmath.Tuple2f 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

All Packages  Class Hierarchy  This Package  Previous  Next  Index