javax.vecmath

Class Tuple3i

public abstract class Tuple3i extends Object implements Serializable

A 3-element tuple represented by signed integer x,y,z coordinates.

Since: Java 3D 1.2

Field Summary
intx
The x coordinate.
inty
The y coordinate.
intz
The z coordinate.
Constructor Summary
Tuple3i(int x, int y, int z)
Constructs and initializes a Tuple3i from the specified x, y, and z coordinates.
Tuple3i(int[] t)
Constructs and initializes a Tuple3i from input array of length 3.
Tuple3i(Tuple3i t1)
Constructs and initializes a Tuple3i from the specified Tuple3i.
Tuple3i()
Constructs and initializes a Tuple3i to (0,0,0).
Method Summary
voidabsolute(Tuple3i t)
Sets each component of the tuple parameter to its absolute value and places the modified values into this tuple.
voidabsolute()
Sets each component of this tuple to its absolute value.
voidadd(Tuple3i t1, Tuple3i t2)
Sets the value of this tuple to the sum of tuples t1 and t2.
voidadd(Tuple3i t1)
Sets the value of this tuple to the sum of itself and t1.
voidclamp(int min, int max, Tuple3i t)
Clamps the tuple parameter to the range [low, high] and places the values into this tuple.
voidclamp(int min, int max)
Clamps this tuple to the range [low, high].
voidclampMax(int max, Tuple3i t)
Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple.
voidclampMax(int max)
Clamps the maximum value of this tuple to the max parameter.
voidclampMin(int min, Tuple3i t)
Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.
voidclampMin(int min)
Clamps the minimum value of this tuple to the min parameter.
booleanequals(Object o1)
Returns true if the Object o1 is of type Tuple3i and all of the data members of t1 are equal to the corresponding data members in this Tuple3i.
voidget(int[] t)
Copies the values of this tuple into the array t.
voidget(Tuple3i t)
Copies the values of this tuple into the tuple t.
inthashCode()
Returns a hash number based on the data values in this object.
voidnegate(Tuple3i t1)
Sets the value of this tuple to the negation of tuples t1.
voidnegate()
Sets the value of this tuple to the negation of itself.
voidscale(int s, Tuple3i t1)
Sets the value of this tuple to the scalar multiplication of tuples t1.
voidscale(int s)
Sets the value of this tuple to the scalar multiplication of itself.
voidscaleAdd(int s, Tuple3i t1, Tuple3i t2)
Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).
voidscaleAdd(int s, Tuple3i t1)
Sets the value of this tuple to the scalar multiplication of itself and then adds tuple t1 (this = s*this + t1).
voidset(int x, int y, int z)
Sets the value of this tuple to to the specified x, y, and z coordinates.
voidset(int[] t)
Sets the value of this tuple to the specified coordinates int the array of length 3.
voidset(Tuple3i t1)
Sets the value of this tuple to the value of tuple t1.
voidsub(Tuple3i t1, Tuple3i t2)
Sets the value of this tuple to the difference of tuples t1 and t2.
voidsub(Tuple3i t1)
Sets the value of this tuple to the difference of itself and t1.
StringtoString()
Returns a string that contains the values of this Tuple3i.

Field Detail

x

public int x
The x coordinate.

y

public int y
The y coordinate.

z

public int z
The z coordinate.

Constructor Detail

Tuple3i

public Tuple3i(int x, int y, int z)
Constructs and initializes a Tuple3i from the specified x, y, and z coordinates.

Parameters: x the x coordinate. y the y coordinate. z the z coordinate.

Tuple3i

public Tuple3i(int[] t)
Constructs and initializes a Tuple3i from input array of length 3.

Parameters: t the array of length 3 containing x, y, and z in order.

Tuple3i

public Tuple3i(Tuple3i t1)
Constructs and initializes a Tuple3i from the specified Tuple3i.

Parameters: t1 the Tuple3i containing the initialization x y z data

Tuple3i

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

Method Detail

absolute

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

absolute

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

add

public final void add(Tuple3i t1, Tuple3i t2)
Sets the value of this tuple to the sum of tuples t1 and t2.

Parameters: t1 the first tuple t2 the second tuple

add

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

Parameters: t is the other tuple

clamp

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

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

clampMax

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

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

clampMin

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

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

equals

public boolean equals(Object o1)
Returns true if the Object o1 is of type Tuple3i and all of the data members of t1 are equal to the corresponding data members in this Tuple3i.

Parameters: o1 the object with which the comparison is made.

get

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

Parameters: t is the array

get

public final void get(Tuple3i t)
Copies the values of this tuple into the tuple t.

Parameters: t is the target tuple

hashCode

public int hashCode()
Returns a hash number based on the data values in this object. Two different Tuple3i objects with identical data values (ie, returns true for equals(Tuple3i) ) 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(Tuple3i t1)
Sets the value of this tuple to the negation of tuples t1.

Parameters: t1 the source tuple

negate

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

scale

public final void scale(int s, Tuple3i t1)
Sets the value of this tuple to the scalar multiplication of tuples t1.

Parameters: s the scalar value 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

scaleAdd

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

scaleAdd

public final void scaleAdd(int s, Tuple3i 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 t the tuple to be added

set

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

Parameters: x the x coordinate. y the y coordinate. z the z coordinate.

set

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

Parameters: t array of length 3 x, y, and z in order.

set

public final void set(Tuple3i t1)
Sets the value of this tuple to the value of tuple t1.

Parameters: t1 the tuple to be copied.

sub

public final void sub(Tuple3i t1, Tuple3i t2)
Sets the value of this tuple to the difference of tuples t1 and t2.

Parameters: t1 the first tuple t2 the second tuple

sub

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

Parameters: t is the other tuple

toString

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

Returns: the String representation