org.openmali.vecmath2
Class Tuple3i

java.lang.Object
  org.openmali.vecmath2.TupleNi<Tuple3i>
      org.openmali.vecmath2.Tuple3i

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class Tuple3i
extends TupleNi<Tuple3i>

A simple three-dimensional tuple implementation. Inspired by Kenji Hiranabe's Tuple3i implementation

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openmali.vecmath2.TupleNi

isDirty, N, roTrick, values

Constructor Summary

	Tuple3i() Creates a new Tuple3i instance.
protected	Tuple3i(boolean readOnly) Creates a new Tuple3i instance.
protected	Tuple3i(boolean readOnly, int[] values, boolean[] isDirty, boolean copy) Creates a new Tuple3i instance.
protected	Tuple3i(boolean readOnly, int x, int y, int z) Creates a new Tuple3i instance.
protected	Tuple3i(boolean readOnly, Tuple3i that) Creates a new Tuple3i instance.
	Tuple3i(int[] values) Creates a new Tuple3i instance.
	Tuple3i(int x, int y, int z) Creates a new Tuple3i instance.
	Tuple3i(Tuple3i that) Creates a new Tuple3i instance.

Method Summary

Tuple3i	add(int x, int y, int z) Adds the given parameters to this tuple's values.
Tuple3i	addX(int v) Adds v to this tuple's x value.
Tuple3i	addY(int v) Adds v to this tuple's y value.
Tuple3i	addZ(int v) Adds v to this tuple's z value.
Tuple3i	asReadOnly()
Tuple3i	clone() Creates and returns a copy of this object.
Tuple3i	div(int vx, int vy, int vz) Divides this tuple's values by vx, vy, vz.
Tuple3i	divX(int v) Divides this tuple's x value by v.
Tuple3i	divY(int v) Divides this tuple's y value by v.
Tuple3i	divZ(int v) Divides this tuple's z value by v.
boolean	equals(java.lang.Object tuple2) Returns true if the Object t1 is of type Tuple3f and all of the data members of t1 are equal to the corresponding data members in this Tuple2f.
boolean	equals(Tuple3i tuple2) Returns true if all of the data members of GVector vector1 are equal to the corresponding data members in this GVector.
static Tuple3i	fromPool() Allocates an Tuple3i instance from the pool.
static Tuple3i	fromPool(int x, int y, int z) Allocates an Tuple3i instance from the pool.
static Tuple3i	fromPool(Tuple3i tuple) Allocates an Tuple3i instance from the pool.
Tuple3i	getReadOnly()
int	getX()
int	getY()
int	getZ()
int	hashCode() Returns a hash number based on the data values in this object.
Tuple3i	mul(int vx, int vy, int vz) Multiplies this tuple's values with vx, vy.
Tuple3i	mulX(int v) Multiplies this tuple's x value with v.
Tuple3i	mulY(int v) Multiplies this tuple's y value with v.
Tuple3i	mulZ(int v) Multiplies this tuple's z value with v.
static Tuple3i	newReadOnly() Creates a new Tuple3i instance.
static Tuple3i	newReadOnly(int[] values) Creates a new Tuple3i instance.
static Tuple3i	newReadOnly(int x, int y, int z) Creates a new Tuple3i instance.
static Tuple3i	newReadOnly(Tuple3i tuple) Creates a new Tuple3i instance.
Tuple3i	scale(int factorX, int factorY, int factorZ) Sets the value of this tuple to the scalar multiplication of tuple t1.
Tuple3i	set(int x, int y, int z) Sets all three values of this Tuple to the specified ones.
Tuple3i	setX(int x) Sets the value of the x-element of this tuple.
Tuple3i	setY(int y) Sets the value of the y-element of this tuple.
Tuple3i	setZ(int z) Sets the value of the z-element of this tuple.
Tuple3i	sub(int x, int y, int z) Subtracts the given parameters from this tuple's values.
Tuple3i	subX(int v) Subtracts v from this tuple's x value.
Tuple3i	subY(int v) Subtracts v from this tuple's y value.
Tuple3i	subZ(int v) Subtracts v from this tuple's z value.
static void	toPool(Tuple3i o) Stores the given Tuple3i instance in the pool.
java.lang.String	toString() Returns a string that contains the values of this Tuple2f.
int	x()
Tuple3i	x(int x) Sets the value of the x-element of this tuple.
int	y()
Tuple3i	y(int y) Sets the value of the y-element of this tuple.
int	z()
Tuple3i	z(int z) Sets the value of the z-element of this tuple.

Methods inherited from class org.openmali.vecmath2.TupleNi

absolute, absolute, add, add, clamp, clamp, clampMax, clampMax, clampMin, clampMin, deserialize, get, get, get, getSerializationBufferSize, getSize, getValue, isDirty, isReadOnly, negate, negate, readExternal, scale, scale, scaleAdd, scaleAdd, serialize, set, set, set, setClean, setValue, setZero, sub, sub, writeExternal

Methods inherited from class java.lang.Object

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

Constructor Detail

Tuple3i

protected Tuple3i(boolean readOnly,
                  int x,
                  int y,
                  int z)

Creates a new Tuple3i instance.

Parameters:

readOnly -

x - the x element to use

y - the y element to use

z - the z element to use

Tuple3i

protected Tuple3i(boolean readOnly,
                  int[] values,
                  boolean[] isDirty,
                  boolean copy)

Creates a new Tuple3i instance.

Parameters:

readOnly -

values - the values array (must be at least size 3)

isDirty - the isDirty-value

copy - copy the array?

Tuple3i

protected Tuple3i(boolean readOnly,
                  Tuple3i that)

Creates a new Tuple3i instance.

Parameters:

readOnly -

that - the Tuple3i to copy the values from

Tuple3i

protected Tuple3i(boolean readOnly)

Creates a new Tuple3i instance.

Parameters:

readOnly -

Tuple3i

public Tuple3i(int x,
               int y,
               int z)

Creates a new Tuple3i instance.

Parameters:

x - the x element to use

y - the y element to use

z - the z element to use

Tuple3i

public Tuple3i(int[] values)

Creates a new Tuple3i instance.

Parameters:

values - the values array (must be at least size 4)

Tuple3i

public Tuple3i(Tuple3i that)

Creates a new Tuple3i instance.

Parameters:

that - the Tuple3i to copy the values from

Tuple3i

public Tuple3i()

Creates a new Tuple3i instance.

Method Detail

setX

public final Tuple3i setX(int x)

Sets the value of the x-element of this tuple.

Parameters:

x -

Returns:

itself

setY

public final Tuple3i setY(int y)

Sets the value of the y-element of this tuple.

Parameters:

y -

Returns:

itself

setZ

public final Tuple3i setZ(int z)

Sets the value of the z-element of this tuple.

Parameters:

z -

Returns:

itself

getX

public final int getX()

Returns:

the value of the x-element of this tuple.

getY

public final int getY()

Returns:

the value of the y-element of this tuple.

getZ

public final int getZ()

Returns:

the value of the z-element of this tuple.

x

public final Tuple3i x(int x)

Sets the value of the x-element of this tuple.

Parameters:

x -

Returns:

itself

y

public final Tuple3i y(int y)

Sets the value of the y-element of this tuple.

Parameters:

y -

Returns:

itself

z

public final Tuple3i z(int z)

Sets the value of the z-element of this tuple.

Parameters:

z -

Returns:

itself

x

public final int x()

Returns:

the value of the x-element of this tuple.

y

public final int y()

Returns:

the value of the y-element of this tuple.

z

public final int z()

Returns:

the value of the z-element of this tuple.

set

public final Tuple3i set(int x,
                         int y,
                         int z)

Sets all three values of this Tuple to the specified ones.

Parameters:

x - the x element to use

y - the y element to use

z - the z element to use

Returns:

itself

addX

public final Tuple3i addX(int v)

Adds v to this tuple's x value.

Parameters:

v -

Returns:

itself

addY

public final Tuple3i addY(int v)

Adds v to this tuple's y value.

Parameters:

v -

Returns:

itself

addZ

public final Tuple3i addZ(int v)

Adds v to this tuple's z value.

Parameters:

v -

Returns:

itself

add

public final Tuple3i add(int x,
                         int y,
                         int z)

Adds the given parameters to this tuple's values.

Parameters:

x -

y -

z -

Returns:

itself

subX

public final Tuple3i subX(int v)

Subtracts v from this tuple's x value.

Parameters:

v -

Returns:

itself

subY

public final Tuple3i subY(int v)

Subtracts v from this tuple's y value.

Parameters:

v -

Returns:

itself

subZ

public final Tuple3i subZ(int v)

Subtracts v from this tuple's z value.

Parameters:

v -

Returns:

itself

sub

public final Tuple3i sub(int x,
                         int y,
                         int z)

Subtracts the given parameters from this tuple's values.

Parameters:

x -

y -

z -

Returns:

itself

mulX

public final Tuple3i mulX(int v)

Multiplies this tuple's x value with v.

Parameters:

v -

Returns:

itself

mulY

public final Tuple3i mulY(int v)

Multiplies this tuple's y value with v.

Parameters:

v -

Returns:

itself

mulZ

public final Tuple3i mulZ(int v)

Multiplies this tuple's z value with v.

Parameters:

v -

Returns:

itself

mul

public final Tuple3i mul(int vx,
                         int vy,
                         int vz)

Multiplies this tuple's values with vx, vy.

Parameters:

vx -

vy -

vz -

Returns:

itself

divX

public final Tuple3i divX(int v)

Divides this tuple's x value by v.

Parameters:

v -

Returns:

itself

divY

public final Tuple3i divY(int v)

Divides this tuple's y value by v.

Parameters:

v -

Returns:

itself

divZ

public final Tuple3i divZ(int v)

Divides this tuple's z value by v.

Parameters:

v -

Returns:

itself

div

public final Tuple3i div(int vx,
                         int vy,
                         int vz)

Divides this tuple's values by vx, vy, vz.

Parameters:

vx -

vy -

vz -

Returns:

itself

scale

public final Tuple3i scale(int factorX,
                           int factorY,
                           int factorZ)

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

Parameters:

factorX -

factorY -

factorZ -

Returns:

itself

asReadOnly

public Tuple3i asReadOnly()

Specified by:

asReadOnly in class TupleNi<Tuple3i>

Returns:

a new instance sharing the values array with this instance. The new instance is read-only. Changes to this instance will be reflected in the new read-only-instance.

See Also:

TupleNi.getReadOnly()

getReadOnly

public Tuple3i getReadOnly()

Specified by:

getReadOnly in class TupleNi<Tuple3i>

Returns:

a single instance sharing the values array with this instance (one unique instance per 'master-instance'). The instance is read-only. Changes to this instance will be reflected in the read-only-instance.

See Also:

TupleNi.asReadOnly()

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.

Specified by:

hashCode in class TupleNi<Tuple3i>

equals

public boolean equals(Tuple3i tuple2)

Returns true if all of the data members of GVector vector1 are equal to the corresponding data members in this GVector.

Overrides:

equals in class TupleNi<Tuple3i>

Parameters:

tuple2 - The vector with which the comparison is made.

Returns:

true or false

equals

public boolean equals(java.lang.Object tuple2)

Returns true if the Object t1 is of type Tuple3f and all of the data members of t1 are equal to the corresponding data members in this Tuple2f.

Overrides:

equals in class TupleNi<Tuple3i>

Parameters:

tuple2 - the Object with which the comparison is made

Returns:

true or false

toString

public java.lang.String toString()

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

Specified by:

toString in class TupleNi<Tuple3i>

Returns:

the String representation

clone

public Tuple3i clone()

Creates and returns a copy of this object.

Overrides:

clone in class java.lang.Object

Returns:

a clone of this instance.

Throws:

java.lang.OutOfMemoryError - if there is not enough memory.

See Also:

Cloneable

newReadOnly

public static Tuple3i newReadOnly(int x,
                                  int y,
                                  int z)

Creates a new Tuple3i instance.

Parameters:

x - the x element to use

y - the y element to use

z - the z element to use

newReadOnly

public static Tuple3i newReadOnly(int[] values)

Creates a new Tuple3i instance.

Parameters:

values - the values array (must be at least size 3)

newReadOnly

public static Tuple3i newReadOnly(Tuple3i tuple)

Creates a new Tuple3i instance.

Parameters:

tuple - the Tuple3i to copy the values from

newReadOnly

public static Tuple3i newReadOnly()

Creates a new Tuple3i instance.

fromPool

public static Tuple3i fromPool()

Allocates an Tuple3i instance from the pool.

fromPool

public static Tuple3i fromPool(int x,
                               int y,
                               int z)

Allocates an Tuple3i instance from the pool.

fromPool

public static Tuple3i fromPool(Tuple3i tuple)

Allocates an Tuple3i instance from the pool.

toPool

public static void toPool(Tuple3i o)

Stores the given Tuple3i instance in the pool.

Parameters:

o -