Package org.jmol.util

Class Tuple3f

java.lang.Object

org.jmol.util.Tuple3f

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Point3f, Vector3f

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.

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
Tuple3f()

Method Summary

Modifier and Type	Method	Description
void	add(Tuple3f t1)	Sets the value of this tuple to the vector sum of itself and tuple t1.
void	add2(Tuple3f t1, Tuple3f t2)	Sets the value of this tuple to the vector sum of tuples t1 and t2.
boolean	equals(java.lang.Object t1)	Returns true if all of the data members of Tuple3f t1 are equal to the corresponding data members in this
int	hashCode()	Returns a hash number based on the data values in this object.
void	scale(float s)	Sets the value of this tuple to the scalar multiplication of itself.
void	scaleAdd(float s, Tuple3f t1)	Sets the value of this tuple to the scalar multiplication of itself and then adds tuple t1 (this = s*this + t1).
void	scaleAdd2(float s, Tuple3f t1, Tuple3f t2)	Sets the value of this tuple to the scalar multiplication of tuple t1 and then adds tuple t2 (this = s*t1 + t2).
void	set(float x, float y, float z)	Sets the value of this tuple to the specified xyz coordinates.
void	setA(float[] t)	Sets the value of this tuple from the 3 values specified in the array.
void	setT(Tuple3f t1)	Sets the value of this tuple to the value of the Tuple3f argument.
void	sub(Tuple3f t1)	Sets the value of this tuple to the vector difference of itself and tuple t1 (this = this - t1).
void	sub2(Tuple3f t1, Tuple3f t2)	Sets the value of this tuple to the vector difference of tuple t1 and t2 (this = t1 - t2).
java.lang.String	toString()	Returns a string that contains the values of this Tuple3f.

Methods inherited from class java.lang.Object

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

Field Detail

x

public float x

The x coordinate.

y

public float y

The y coordinate.

z

public float z

The z coordinate.

Constructor Detail

Tuple3f

public Tuple3f()

Method Detail

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

setA

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

setT

public final void setT(Tuple3f t1)

Sets the value of this tuple to the value of the Tuple3f argument.

Parameters:

t1 - the tuple to be copied

add2

public final void add2(Tuple3f t1,
                       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(Tuple3f t1)

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

Parameters:

t1 - the other tuple

sub2

public final void sub2(Tuple3f t1,
                       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(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

scale

public final void scale(float s)

Sets the value of this tuple to the scalar multiplication of itself.

Parameters:

s - the scalar value

scaleAdd2

public final void scaleAdd2(float s,
                            Tuple3f t1,
                            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,
                           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(java.lang.Object t1)

Returns true if all of the data members of Tuple3f t1 are equal to the corresponding data members in this

Overrides:

equals in class java.lang.Object

Parameters:

t1 - the vector with which the comparison is made.

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

the String representation