javax.vecmath

Class Tuple4i

Implemented Interfaces:
Serializable
Known Direct Subclasses:
Point4i

public abstract class Tuple4i
extends java.lang.Object
implements Serializable

A 4-element tuple represented by signed integer x,y,z,w coordinates.
Version:
specification 1.2, implementation $Revision: 1.1 $, $Date: 1999/11/25 10:29:35 $
Author:
Kenji hiranabe
Since:
Java 3D 1.2

Field Summary

int
w
The w coordinate.
int
x
The x coordinate.
int
y
The y coordinate.
int
z
The z coordinate.

Constructor Summary

Tuple4i()
Constructs and initializes a Tuple4i to (0,0,0,0).
Tuple4i(int x, int y, int z, int w)
Constructs and initializes a Tuple4i from the specified x, y, z and w coordinates.
Tuple4i(Tuple4i t1)
Constructs and initializes a Tuple4i from the specified Tuple4i.
Tuple4i(t[] )
Constructs and initializes a Tuple4i from input array of length 4.

Method Summary

void
absolute()
Sets each component of this tuple to its absolute value.
void
absolute(Tuple4i t)
Sets each component of the tuple parameter to its absolute value and places the modified values into this tuple.
void
add(Tuple4i t1)
Sets the value of this tuple to the sum of itself and t1.
void
add(Tuple4i t1, Tuple4i t2)
Sets the value of this tuple to the sum of tuples t1 and t2.
void
clamp(int min, int max)
Clamps this tuple to the range [low, high].
void
clamp(int min, int max, Tuple4i t)
Clamps the tuple parameter to the range [low, high] and places the values into this tuple.
void
clampMax(int max)
Clamps the maximum value of this tuple to the max parameter.
void
clampMax(int max, Tuple4i t)
Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple.
void
clampMin(int min)
Clamps the minimum value of this tuple to the min parameter.
void
clampMin(int min, Tuple4i t)
Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.
boolean
equals(Object o1)
Returns true if the Object o1 is of type Tuple4i and all of the data members of t1 are equal to the corresponding data members in this Tuple4i.
void
get(Tuple4i t)
Copies the values of this tuple into the tuple t.
void
get(t[] )
Copies the values of this tuple into the array t.
int
hashCode()
Returns a hash number based on the data values in this object.
void
negate()
Sets the value of this tuple to the negation of itself.
void
negate(Tuple4i t1)
Sets the value of this tuple to the negation of tuples t1.
void
scale(int s)
Sets the value of this tuple to the scalar multiplication of itself.
void
scale(int s, Tuple4i t1)
Sets the value of this tuple to the scalar multiplication of tuples t1.
void
scaleAdd(int s, Tuple4i t1)
Sets the value of this tuple to the scalar multiplication of itself and then adds tuple t1 (this = s*this + t1).
void
scaleAdd(int s, Tuple4i t1, Tuple4i t2)
Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).
void
set(int x, int y, int z, int w)
Sets the value of this tuple to to the specified x, y, z, and w coordinates.
void
set(Tuple4i t1)
Sets the value of this tuple to the value of tuple t1.
void
set(t[] )
Sets the value of this tuple to the specified coordinates int the array of length 4.
void
sub(Tuple4i t1)
Sets the value of this tuple to the difference of itself and t1.
void
sub(Tuple4i t1, Tuple4i t2)
Sets the value of this tuple to the difference of tuples t1 and t2.
String
toString()
Returns a string that contains the values of this Tuple4i.

Field Details

w

public int w
The w coordinate.

x

public int x
The x coordinate.

y

public int y
The y coordinate.

z

public int z
The z coordinate.

Constructor Details

Tuple4i

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

Tuple4i

public Tuple4i(int x,
               int y,
               int z,
               int w)
Constructs and initializes a Tuple4i from the specified x, y, z and w coordinates.
Parameters:
x - the x coordinate.
y - the y coordinate.
z - the z coordinate.
w - the w coordinate.

Tuple4i

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

Tuple4i

public Tuple4i(t[] )
Constructs and initializes a Tuple4i from input array of length 4.
Parameters:

Method Details

absolute

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

absolute

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

add

public final void add(Tuple4i t1)
Sets the value of this tuple to the sum of itself and t1.
Parameters:

add

public final void add(Tuple4i t1,
                      Tuple4i t2)
Sets the value of this tuple to the sum of tuples t1 and t2.
Parameters:
t1 - the first tuple
t2 - the second tuple

clamp

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

clamp

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

clampMax

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

clampMax

public final void clampMax(int max,
                           Tuple4i 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

clampMin

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

clampMin

public final void clampMin(int min,
                           Tuple4i 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

equals

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

get

public final void get(Tuple4i t)
Copies the values of this tuple into the tuple t.
Parameters:
t - is the target tuple

get

public final void get(t[] )
Copies the values of this tuple into the array t.
Parameters:

hashCode

public int hashCode()
Returns a hash number based on the data values in this object. Two different Tuple4i objects with identical data values (ie, returns true for equals(Tuple4i) ) will return the same hash number. Two vectors with different data members may return the same hash value, although this is not likely.

negate

public final void negate()
Sets the value of this tuple to the negation of itself.

negate

public final void negate(Tuple4i t1)
Sets the value of this tuple to the negation of tuples t1.
Parameters:
t1 - the source tuple

scale

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

scale

public final void scale(int s,
                        Tuple4i t1)
Sets the value of this tuple to the scalar multiplication of tuples t1.
Parameters:
s - the scalar value
t1 - the source tuple

scaleAdd

public final void scaleAdd(int s,
                           Tuple4i 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

scaleAdd

public final void scaleAdd(int s,
                           Tuple4i t1,
                           Tuple4i t2)
Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).
Parameters:
s - the scalar value
t1 - the tuple to be multipled
t2 - the tuple to be added

set

public final void set(int x,
                      int y,
                      int z,
                      int w)
Sets the value of this tuple to to the specified x, y, z, and w coordinates.
Parameters:
x - the x coordinate.
y - the y coordinate.
z - the z coordinate.
w - the w coordinate.

set

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

set

public final void set(t[] )
Sets the value of this tuple to the specified coordinates int the array of length 4.
Parameters:

sub

public final void sub(Tuple4i t1)
Sets the value of this tuple to the difference of itself and t1.
Parameters:

sub

public final void sub(Tuple4i t1,
                      Tuple4i t2)
Sets the value of this tuple to the difference of tuples t1 and t2.
Parameters:
t1 - the first tuple
t2 - the second tuple

toString

public String toString()
Returns a string that contains the values of this Tuple4i. The form is (x,y,z,w).
Returns:
the String representation