vecmath 1.5.2 · javax.vecmath.Tuple2i

Modifier and Type	Field and Description
pack-priv static final long	serialVersionUID
public int	x The x coordinate.
public int	y The y coordinate.

Access	Constructor and Description
public	Tuple2i(int the x coordinate x, int the y coordinate y) Constructs and initializes a Tuple2i from the specified x and y coordinates.
public	Tuple2i(int[] the array of length 2 containing x and y in order. t) Constructs and initializes a Tuple2i from the array of length 2.
public	Tuple2i(Tuple2i the Tuple2i containing the initialization x and y data. t1) Constructs and initializes a Tuple2i from the specified Tuple2i.
public	Tuple2i() Constructs and initializes a Tuple2i to (0,0).

Method Summary

Modifier and Type	Method and Description
public final void	absolute(Tuple2i the source tuple, which will not be modified t) Sets each component of the tuple parameter to its absolute value and places the modified values into this tuple.
public final void	absolute() Sets each component of this tuple to its absolute value.
public final void	add(Tuple2i the first tuple t1, Tuple2i the second tuple t2) Sets the value of this tuple to the sum of tuples t1 and t2.
public final void	add(Tuple2i the other tuple t1) Sets the value of this tuple to the sum of itself and t1.
public final void	clamp(int the lowest value in the tuple after clamping min, int the highest value in the tuple after clamping max, Tuple2i the source tuple, which will not be modified t) Clamps the tuple parameter to the range [low, high] and places the values into this tuple.
public final void	clamp(int the lowest value in this tuple after clamping min, int the highest value in this tuple after clamping max) Clamps this tuple to the range [low, high].
public final void	clampMax(int the highest value in the tuple after clamping max, Tuple2i the source tuple, which will not be modified t) Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple.
public final void	clampMax(int the highest value in the tuple after clamping max) Clamps the maximum value of this tuple to the max parameter.
public final void	clampMin(int the lowest value in the tuple after clamping min, Tuple2i the source tuple, which will not be modified t) Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.
public final void	clampMin(int the lowest value in this tuple after clamping min) Clamps the minimum value of this tuple to the min parameter.
public Object	Returns: a clone of this instance. clone() Overrides java.lang.Object.clone. Creates a new object of the same class as this object.
public boolean	equals(Object the object with which the comparison is made t1) Overrides java.lang.Object.equals. Returns true if the Object t1 is of type Tuple2i and all of the data members of t1 are equal to the corresponding data members in this Tuple2i.
public final void	get(int[] is the array t) Copies the values of this tuple into the array t.
public final void	get(Tuple2i is the target tuple t) Copies the values of this tuple into the tuple t.
public final int	Returns: the x coordinate. getX() Get the x coordinate.
public final int	Returns: the y coordinate. getY() Get the y coordinate.
public int	Returns: the integer hash code value hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value based on the data values in this object.
public final void	negate(Tuple2i the source tuple t1) Sets the value of this tuple to the negation of tuple t1.
public final void	negate() Negates the value of this tuple in place.
public final void	scale(int the scalar value s, Tuple2i the source tuple t1) Sets the value of this tuple to the scalar multiplication of tuple t1.
public final void	scale(int the scalar value s) Sets the value of this tuple to the scalar multiplication of the scale factor with this.
public final void	scaleAdd(int the scalar value s, Tuple2i the tuple to be multipled t1, Tuple2i the tuple to be added t2) Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).
public final void	scaleAdd(int the scalar value s, Tuple2i the tuple to be added t1) Sets the value of this tuple to the scalar multiplication of itself and then adds tuple t1 (this = s*this + t1).
public final void	set(int the x coordinate x, int the y coordinate y) Sets the value of this tuple to the specified x and y coordinates.
public final void	set(int[] the array of length 2 containing x and y in order. t) Sets the value of this tuple to the specified coordinates in the array of length 2.
public final void	set(Tuple2i the tuple to be copied t1) Sets the value of this tuple to the value of tuple t1.
public final void	setX(int value to x coordinate. x) Set the x coordinate.
public final void	setY(int value to y coordinate. y) Set the y coordinate.
public final void	sub(Tuple2i the first tuple t1, Tuple2i the second tuple t2) Sets the value of this tuple to the difference of tuples t1 and t2 (this = t1 - t2).
public final void	sub(Tuple2i the other tuple t1) Sets the value of this tuple to the difference of itself and t1 (this = this - t1).
public String	Returns: the String representation toString() Overrides java.lang.Object.toString. Returns a string that contains the values of this Tuple2i.

Inherited from java.lang.Object:: finalize getClass notify notifyAll wait wait wait

serialVersionUID	back to summary
pack-priv static final long serialVersionUID

x	back to summary
public int x The x coordinate.

y	back to summary
public int y The y coordinate.

Tuple2i	back to summary
public Tuple2i(int x, int y) Constructs and initializes a Tuple2i from the specified x and y coordinates. Parameters x:int the x coordinate y:int the y coordinate

Tuple2i	back to summary
public Tuple2i(int[] t) Constructs and initializes a Tuple2i from the array of length 2. Parameters t:int[] the array of length 2 containing x and y in order.

Tuple2i	back to summary
public Tuple2i(Tuple2i t1) Constructs and initializes a Tuple2i from the specified Tuple2i. Parameters t1:Tuple2i the Tuple2i containing the initialization x and y data.

Tuple2i	back to summary
public Tuple2i() Constructs and initializes a Tuple2i to (0,0).

Method Detail

absolute	back to summary
public final void absolute(Tuple2i t) Sets each component of the tuple parameter to its absolute value and places the modified values into this tuple. Parameters t:Tuple2i the source tuple, which will not be modified

absolute

back to summary

public final void absolute(Tuple2i t)

Sets each component of the tuple parameter to its absolute value and places the modified values into this tuple.

Parameters

t:Tuple2i: the source tuple, which will not be modified

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

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

add

back to summary

public final void add(Tuple2i t1, Tuple2i t2)

Sets the value of this tuple to the sum of tuples t1 and t2.

Parameters

t1:Tuple2i: the first tuple
t2:Tuple2i: the second tuple

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

add

back to summary

public final void add(Tuple2i t1)

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

Parameters

t1:Tuple2i: the other tuple

clamp	back to summary
public final void clamp(int min, int max, Tuple2i t) Clamps the tuple parameter to the range [low, high] and places the values into this tuple. Parameters min:int the lowest value in the tuple after clamping max:int the highest value in the tuple after clamping t:Tuple2i the source tuple, which will not be modified

clamp

back to summary

public final void clamp(int min, int max, Tuple2i t)

Clamps the tuple parameter to the range [low, high] and places the values into this tuple.

Parameters

min:int: the lowest value in the tuple after clamping
max:int: the highest value in the tuple after clamping
t:Tuple2i: the source tuple, which will not be modified

clamp	back to summary
public final void clamp(int min, int max) Clamps this tuple to the range [low, high]. Parameters min:int the lowest value in this tuple after clamping max:int the highest value in this tuple after clamping

clamp

back to summary

public final void clamp(int min, int max)

Clamps this tuple to the range [low, high].

Parameters

min:int: the lowest value in this tuple after clamping
max:int: the highest value in this tuple after clamping

clampMax	back to summary
public final void clampMax(int max, Tuple2i t) Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple. Parameters max:int the highest value in the tuple after clamping t:Tuple2i the source tuple, which will not be modified

clampMax

back to summary

public final void clampMax(int max, Tuple2i t)

Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple.

Parameters

max:int: the highest value in the tuple after clamping
t:Tuple2i: the source tuple, which will not be modified

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

clampMax

back to summary

public final void clampMax(int max)

Clamps the maximum value of this tuple to the max parameter.

Parameters

max:int: the highest value in the tuple after clamping

clampMin	back to summary
public final void clampMin(int min, Tuple2i t) Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple. Parameters min:int the lowest value in the tuple after clamping t:Tuple2i the source tuple, which will not be modified

clampMin

back to summary

public final void clampMin(int min, Tuple2i t)

Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.

Parameters

min:int: the lowest value in the tuple after clamping
t:Tuple2i: the source tuple, which will not be modified

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

clampMin

back to summary

public final void clampMin(int min)

Clamps the minimum value of this tuple to the min parameter.

Parameters

min:int: the lowest value in this tuple after clamping

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Creates a new object of the same class as this object. Returns:Object a clone of this instance. Exceptions OutOfMemoryError: if there is not enough memory. See Also `java.lang.Cloneable`

public Object clone()

Overrides java.lang.Object.clone.

Creates a new object of the same class as this object.

Returns:Object

a clone of this instance.

Exceptions

OutOfMemoryError:: if there is not enough memory.

See Also

java.lang.Cloneable

equals back to summary

equals	back to summary
public boolean equals(Object t1) Overrides java.lang.Object.equals. Returns true if the Object t1 is of type Tuple2i and all of the data members of t1 are equal to the corresponding data members in this Tuple2i. Parameters t1:Object the object with which the comparison is made Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(Object t1)

Overrides java.lang.Object.equals.

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

Parameters

t1:Object: the object with which the comparison is made

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

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

get

back to summary

public final void get(int[] t)

Copies the values of this tuple into the array t.

Parameters

t:int[]: is the array

get	back to summary
public final void get(Tuple2i t) Copies the values of this tuple into the tuple t. Parameters t:Tuple2i is the target tuple

get

back to summary

public final void get(Tuple2i t)

Copies the values of this tuple into the tuple t.

Parameters

t:Tuple2i: is the target tuple

getX	back to summary
public final int getX() Get the x coordinate. Returns:int the x coordinate. Since vecmath 1.5

getX

back to summary

public final int getX()

Get the x coordinate.

Returns:int: the x coordinate.
Since: vecmath 1.5

getY	back to summary
public final int getY() Get the y coordinate. Returns:int the y coordinate. Since vecmath 1.5

getY

back to summary

public final int getY()

Get the y coordinate.

Returns:int: the y coordinate.
Since: vecmath 1.5

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value based on the data values in this object. Two different Tuple2i objects with identical data values (i.e., Tuple2i.equals returns true) will return the same hash code value. Two objects with different data members may return the same hash value, although this is not likely. Returns:int the integer hash code value

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value based on the data values in this object. Two different Tuple2i objects with identical data values (i.e., Tuple2i.equals returns true) will return the same hash code value. Two objects with different data members may return the same hash value, although this is not likely.

Returns:int: the integer hash code value

negate	back to summary
public final void negate(Tuple2i t1) Sets the value of this tuple to the negation of tuple t1. Parameters t1:Tuple2i the source tuple

negate

back to summary

public final void negate(Tuple2i t1)

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

Parameters

t1:Tuple2i: the source tuple

negate	back to summary
public final void negate() Negates the value of this tuple in place.

scale	back to summary
public final void scale(int s, Tuple2i t1) Sets the value of this tuple to the scalar multiplication of tuple t1. Parameters s:int the scalar value t1:Tuple2i the source tuple

scale

back to summary

public final void scale(int s, Tuple2i t1)

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

Parameters

s:int: the scalar value
t1:Tuple2i: the source tuple

scale	back to summary
public final void scale(int s) Sets the value of this tuple to the scalar multiplication of the scale factor with this. Parameters s:int the scalar value

scale

back to summary

public final void scale(int s)

Sets the value of this tuple to the scalar multiplication of the scale factor with this.

Parameters

s:int: the scalar value

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

scaleAdd

back to summary

public final void scaleAdd(int s, Tuple2i t1, Tuple2i t2)

Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).

Parameters

s:int: the scalar value
t1:Tuple2i: the tuple to be multipled
t2:Tuple2i: the tuple to be added

scaleAdd	back to summary
public final void scaleAdd(int s, Tuple2i t1) Sets the value of this tuple to the scalar multiplication of itself and then adds tuple t1 (this = s*this + t1). Parameters s:int the scalar value t1:Tuple2i the tuple to be added

scaleAdd

back to summary

public final void scaleAdd(int s, Tuple2i t1)

Sets the value of this tuple to the scalar multiplication of itself and then adds tuple t1 (this = s*this + t1).

Parameters

s:int: the scalar value
t1:Tuple2i: the tuple to be added

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

set

back to summary

public final void set(int x, int y)

Sets the value of this tuple to the specified x and y coordinates.

Parameters

x:int: the x coordinate
y:int: the y coordinate

set	back to summary
public final void set(int[] t) Sets the value of this tuple to the specified coordinates in the array of length 2. Parameters t:int[] the array of length 2 containing x and y in order.

set

back to summary

public final void set(int[] t)

Sets the value of this tuple to the specified coordinates in the array of length 2.

Parameters

t:int[]: the array of length 2 containing x and y in order.

set	back to summary
public final void set(Tuple2i t1) Sets the value of this tuple to the value of tuple t1. Parameters t1:Tuple2i the tuple to be copied

set

back to summary

public final void set(Tuple2i t1)

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

Parameters

t1:Tuple2i: the tuple to be copied

setX	back to summary
public final void setX(int x) Set the x coordinate. Parameters x:int value to x coordinate. Since vecmath 1.5

setX

back to summary

public final void setX(int x)

Set the x coordinate.

Parameters

x:int: value to x coordinate.

Since

vecmath 1.5

setY	back to summary
public final void setY(int y) Set the y coordinate. Parameters y:int value to y coordinate. Since vecmath 1.5

setY

back to summary

public final void setY(int y)

Set the y coordinate.

Parameters

y:int: value to y coordinate.

Since

vecmath 1.5

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

sub

back to summary

public final void sub(Tuple2i t1, Tuple2i t2)

Sets the value of this tuple to the difference of tuples t1 and t2 (this = t1 - t2).

Parameters

t1:Tuple2i: the first tuple
t2:Tuple2i: the second tuple

sub	back to summary
public final void sub(Tuple2i t1) Sets the value of this tuple to the difference of itself and t1 (this = this - t1). Parameters t1:Tuple2i the other tuple

sub

back to summary

public final void sub(Tuple2i t1)

Sets the value of this tuple to the difference of itself and t1 (this = this - t1).

Parameters

t1:Tuple2i: the other tuple

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string that contains the values of this Tuple2i. The form is (x,y). Returns:String the String representation

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

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

Returns:String: the String representation

public abstract Class Tuple2i

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail