Package org.jmol.util

Class Tuple3i

java.lang.Object

org.jmol.util.Tuple3i

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Point3i

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

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

Since:

Java 3D 1.2

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
int	x	The x coordinate.
int	y	The y coordinate.
int	z	The z coordinate.

Constructor Summary

Constructors

Constructor	Description
Tuple3i()	Constructs and initializes a Tuple3i to (0,0,0).

Method Summary

Modifier and Type	Method	Description
void	add(Tuple3i t)	Sets the value of this tuple to the sum of itself and t1.
boolean	equals(java.lang.Object o)	Returns true if the Object o is of type Tuple3i and all of the data members of t are equal to the corresponding data members in this Tuple3i.
int	hashCode()	Returns a hash number based on the data values in this object.
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).
void	set(int x, int y, int z)	Sets the value of this tuple to to the specified x, y, and z coordinates.
void	setT(Tuple3i t1)	Sets the value of this tuple to the value of tuple t1.
java.lang.String	toString()	Returns a string that contains the values of this Tuple3i.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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()

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

Method Detail

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.

setT

public final void setT(Tuple3i t1)

Sets the value of this tuple to the value of tuple t1.

Parameters:

t1 - the tuple to be copied.

add

public final void add(Tuple3i t)

Sets the value of this tuple to the sum of itself and t1.

Parameters:

t - is the other tuple

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

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.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Returns true if the Object o is of type Tuple3i and all of the data members of t are equal to the corresponding data members in this Tuple3i.

Overrides:

equals in class java.lang.Object

Parameters:

o - the object with which the comparison is made.

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

the String representation