All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.vecmath.Tuple3d

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

public abstract class Tuple3d
extends Object
A 3 generic 3 element tuple that is represented by double precision floating point x,y,z coordinates.


Variable Index

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

Constructor Index

 o Tuple3d()
Constructs and initializes a Tuple3d to (0,0,0).
 o Tuple3d(double, double, double)
Constructs and initializes a Tuple3d from the specified xyz coordinates.
 o Tuple3d(double[])
Constructs and initializes a Tuple3d from the array of length 3.
 o Tuple3d(Tuple3d)
Constructs and initializes a Tuple3d from the specified Tuple3d.
 o Tuple3d(Tuple3f)
Constructs and initializes a Tuple3d from the specified Tuple3f.

Method Index

 o absolute()
Sets each component of this tuple to its absolute value.
 o absolute(Tuple3d)
Sets each component of the tuple parameter to its absolute value and places the modified values into this tuple.
 o add(Tuple3d)
Sets the value of this tuple to the sum of itself and t1.
 o add(Tuple3d, Tuple3d)
Sets the value of this tuple to the sum of tuples t1 and t2.
 o clamp(float, float)
Clamps this tuple to the range [low, high].
 o clamp(float, float, Tuple3d)
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, Tuple3d)
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, Tuple3d)
Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.
 o epsilonEquals(Tuple3d, double)
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(Tuple3d)
Returns true if all of the data members of Tuple3d t1 are equal to the corresponding data members in this Tuple3d.
 o get(double[])
Copies the x,y,z coordinates of this tuple into the array t[] of length 3.
 o get(Tuple3d)
Copies tuple t into this tuple.
 o hashCode()
Returns a hash number based on the data values in this object.
 o interpolate(Tuple3d, float)
Linearly interpolates between this tuple and tuple t1 and places the result into this tuple: this = alpha*this + (1-alpha)*t1.
 o interpolate(Tuple3d, Tuple3d, 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 tuple in place.
 o negate(Tuple3d)
Sets the value of this tuple to the negation of tuple t1.
 o scale(double)
Sets the value of this tuple to the scalar multiplication of itself.
 o scale(double, Tuple3d)
Sets the value of this tuple to the scalar multiplication of tuple t1.
 o scaleAdd(double, Tuple3d, Tuple3d)
Sets the value of this tuple to the scalar multiplication of tuple t1 and then adds tuple t2 (this = s*t1 + t2).
 o set(double, double, double)
Sets the value of this tuple to the specified xyz coordinates.
 o set(double[])
Sets the value of this tuple to the value of the xyz coordinates located in the array of length 3.
 o set(Tuple3d)
Sets the value of this tuple to the value of tuple t1.
 o set(Tuple3f)
Sets the value of this tuple to the value of Tuple3f t1.
 o sub(Tuple3d)
Sets the value of this tuple to the difference of itself and t1 (this = this - t1).
 o sub(Tuple3d, Tuple3d)
Sets the value of this tuple to the difference of tuples t1 and t2 (this = t1 - t2).
 o toString()
Returns a string that contains the values of this Tuple3d.

Variables

 o x
 public double x
The x coordinate.

 o y
 public double y
The y coordinate.

 o z
 public double z
The z coordinate.

Constructors

 o 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
 o Tuple3d
 public Tuple3d(double t[])
Constructs and initializes a Tuple3d from the array of length 3.

Parameters:
t - the array of length 3 containing xyz in order
 o 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
 o 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
 o Tuple3d
 public Tuple3d()
Constructs and initializes a Tuple3d to (0,0,0).

Methods

 o 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
 o set
 public final void set(double t[])
Sets the value of this tuple to the value of the xyz coordinates located in the array of length 3.

Parameters:
t - the array of length 3 containing xyz in order
 o set
 public final void set(Tuple3d t1)
Sets the value of this tuple to the value of tuple t1.

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

Parameters:
t1 - the tuple to be copied
 o get
 public final void get(double t[])
Copies the x,y,z coordinates of this tuple into the array t[] of length 3.

Parameters:
t - the target array
 o get
 public final void get(Tuple3d t)
Copies tuple t into this tuple.

Parameters:
t - the tuple to be copied
 o add
 public final void add(Tuple3d t1,
                       Tuple3d t2)
Sets the value of this tuple to the sum of tuples t1 and t2.

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

Parameters:
t1 - the other tuple
 o sub
 public final void sub(Tuple3d t1,
                       Tuple3d t2)
Sets the value of this tuple to the difference of tuples t1 and t2 (this = t1 - t2).

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

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

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

 o 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
 o scale
 public final void scale(double s)
Sets the value of this tuple to the scalar multiplication of itself.

Parameters:
s - the scalar value
 o 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
 o toString
 public String toString()
Returns a string that contains the values of this Tuple3d. The form is (x,y,z).

Returns:
the String representation
Overrides:
toString in class Object
 o 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.

Returns:
the integer hash value
Overrides:
hashCode in class Object
 o 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 Tuple3d.

Parameters:
t1 - The tuple with which the comparison is made.
Returns:
true or false
 o 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), abs(z1-z2)].

Parameters:
t1 - The tuple to be compared to this tuple
epsilon - the threshold value
 o clamp
 public final void clamp(float min,
                         float 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
 o clampMin
 public final void clampMin(float 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
 o clampMax
 public final void clampMax(float 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
 o 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
 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(Tuple3d t1,
                               Tuple3d 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(Tuple3d 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