All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class javax.vecmath.Tuple3f

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

public abstract class Tuple3f
extends java.lang.Object
implements java.io.Serializable

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.9 $, $Date: 1999/03/04 09:16:33 $
Author:: Kenji hiranabe

x: The x coordinate.
y: The y coordinate.
z: The z coordinate.

Tuple3f(): Constructs and initializes a Tuple3f to (0,0,0).
Tuple3f(float, float, float): Constructs and initializes a Tuple3f from the specified xyz coordinates.
Tuple3f(float[]): Constructs and initializes a Tuple3f from the specified array.
Tuple3f(Tuple3d): Constructs and initializes a Tuple3f from the specified Tuple3d.
Tuple3f(Tuple3f): Constructs and initializes a Tuple3f from the specified Tuple3f.

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

 public float x

The x coordinate.

 public float y

The y coordinate.

 public float z

The z coordinate.

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(javax.vecmath.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(javax.vecmath.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).

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(javax.vecmath.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(javax.vecmath.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(javax.vecmath.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(javax.vecmath.Tuple3f t1,
                       javax.vecmath.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(javax.vecmath.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(javax.vecmath.Tuple3f t1,
                       javax.vecmath.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(javax.vecmath.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(javax.vecmath.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,
                         javax.vecmath.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,
                            javax.vecmath.Tuple3f t1,
                            javax.vecmath.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,
                            javax.vecmath.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 java.lang.Object

equals

 public boolean equals(javax.vecmath.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.

epsilonEquals

 public boolean epsilonEquals(javax.vecmath.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 java.lang.String toString()

Returns a string that contains the values of this Tuple3f. The form is (x,y,z).

Returns:: the String representation
Overrides:: toString in class java.lang.Object

clamp

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

All Packages  Class Hierarchy  This Package  Previous  Next  Index