Top Description Fields Constructors Methods
javax.vecmath

public abstract Class Tuple4f

extends Object
implements Serializable, Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable, java.io.Serializable
Known Direct Subclasses
javax.vecmath.Vector4f, javax.vecmath.Color4f, javax.vecmath.Point4f, javax.vecmath.Quat4f, javax.vecmath.TexCoord4f
Imports
java.lang.Math
A 4-element tuple represented by single-precision floating point x,y,z,w coordinates.

Field Summary

Modifier and TypeField and Description
pack-priv static final long
serialVersionUID

public float
w

The w coordinate.

public float
x

The x coordinate.

public float
y

The y coordinate.

public float
z

The z coordinate.

Constructor Summary

AccessConstructor and Description
public
Tuple4f(float
the x coordinate
x, float
the y coordinate
y, float
the z coordinate
z, float
the w coordinate
w)

Constructs and initializes a Tuple4f from the specified xyzw coordinates.

public
Tuple4f(float[]
the array of length 4 containing xyzw in order
t)

Constructs and initializes a Tuple4f from the array of length 4.

public
Tuple4f(Tuple4f
the Tuple4f containing the initialization x y z w data
t1)

Constructs and initializes a Tuple4f from the specified Tuple4f.

public
Tuple4f(Tuple4d
the Tuple4d containing the initialization x y z w data
t1)

Constructs and initializes a Tuple4f from the specified Tuple4d.

public
Tuple4f()

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

Method Summary

Modifier and TypeMethod and Description
public final void
absolute(Tuple4f
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(Tuple4f
the first tuple
t1, Tuple4f
the second tuple
t2)

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

public final void
add(Tuple4f
the other tuple
t1)

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

public final void
clamp(float
the lowest value in the tuple after clamping
min, float
the highest value in the tuple after clamping
max, Tuple4f
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(float
the lowest value in this tuple after clamping
min, float
the highest value in this tuple after clamping
max)

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

public final void
clampMax(float
the highest value in the tuple after clamping
max, Tuple4f
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(float
the highest value in the tuple after clamping
max)

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

public final void
clampMin(float
the lowest value in the tuple after clamping
min, Tuple4f
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(float
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

Returns:

true or false
epsilonEquals(Tuple4f
the tuple to be compared to this tuple
t1, float
the threshold value
epsilon)

Returns true if the L-infinite distance between this tuple and tuple t1 is less than or equal to the epsilon parameter, otherwise returns false.

public boolean

Returns:

true or false
equals(Tuple4f
the vector with which the comparison is made
t1)

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

public boolean

Returns:

true or false
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 Tuple4f and all of the data members of t1 are equal to the corresponding data members in this Tuple4f.
public final void
get(float[]
the array
t)

Copies the values of this tuple into the array t.

public final void
get(Tuple4f
the target tuple
t)

Copies the values of this tuple into the tuple t.

public final float

Returns:

the w coordinate.
getW()

Get the w coordinate.

public final float

Returns:

the x coordinate.
getX()

Get the x coordinate.

public final float

Returns:

the y coordinate.
getY()

Get the y coordinate.

public final float

Returns:

the z coordinate.
getZ()

Get the z 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 void
interpolate(Tuple4f
the first tuple
t1, Tuple4f
the second tuple
t2, float
the alpha interpolation parameter
alpha)

Linearly interpolates between tuples t1 and t2 and places the result into this tuple: this = (1-alpha)*t1 + alpha*t2.

public void
interpolate(Tuple4f
the first tuple
t1, float
the alpha interpolation parameter
alpha)

Linearly interpolates between this tuple and tuple t1 and places the result into this tuple: this = (1-alpha)*this + alpha*t1.

public final void
negate(Tuple4f
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(float
the scalar value
s, Tuple4f
the source tuple
t1)

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

public final void
scale(float
the scalar value
s)

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

public final void
scaleAdd(float
the scalar value
s, Tuple4f
the tuple to be multipled
t1, Tuple4f
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(float
the scalar value
s, Tuple4f
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(float
the x coordinate
x, float
the y coordinate
y, float
the z coordinate
z, float
the w coordinate
w)

Sets the value of this tuple to the specified xyzw coordinates.

public final void
set(float[]
the array of length 4 containing xyzw in order
t)

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

public final void
set(Tuple4f
the tuple to be copied
t1)

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

public final void
set(Tuple4d
the tuple to be copied
t1)

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

public final void
setW(float
value to w coordinate.
w)

Set the w coordinate.

public final void
setX(float
value to x coordinate.
x)

Set the x coordinate.

public final void
setY(float
value to y coordinate.
y)

Set the y coordinate.

public final void
setZ(float
value to z coordinate.
z)

Set the z coordinate.

public final void
sub(Tuple4f
the first tuple
t1, Tuple4f
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(Tuple4f
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 Tuple4f.
Inherited from java.lang.Object:
finalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

serialVersionUIDback to summary
pack-priv static final long serialVersionUID
wback to summary
public float w

The w coordinate.

xback to summary
public float x

The x coordinate.

yback to summary
public float y

The y coordinate.

zback to summary
public float z

The z coordinate.

Constructor Detail

Tuple4fback to summary
public Tuple4f(float x, float y, float z, float w)

Constructs and initializes a Tuple4f from the specified xyzw coordinates.

Parameters
x:float

the x coordinate

y:float

the y coordinate

z:float

the z coordinate

w:float

the w coordinate

Tuple4fback to summary
public Tuple4f(float[] t)

Constructs and initializes a Tuple4f from the array of length 4.

Parameters
t:float[]

the array of length 4 containing xyzw in order

Tuple4fback to summary
public Tuple4f(Tuple4f t1)

Constructs and initializes a Tuple4f from the specified Tuple4f.

Parameters
t1:Tuple4f

the Tuple4f containing the initialization x y z w data

Tuple4fback to summary
public Tuple4f(Tuple4d t1)

Constructs and initializes a Tuple4f from the specified Tuple4d.

Parameters
t1:Tuple4d

the Tuple4d containing the initialization x y z w data

Tuple4fback to summary
public Tuple4f()

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

Method Detail

absoluteback to summary
public final void absolute(Tuple4f t)

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

Parameters
t:Tuple4f

the source tuple, which will not be modified

absoluteback to summary
public final void absolute()

Sets each component of this tuple to its absolute value.

addback to summary
public final void add(Tuple4f t1, Tuple4f t2)

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

Parameters
t1:Tuple4f

the first tuple

t2:Tuple4f

the second tuple

addback to summary
public final void add(Tuple4f t1)

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

Parameters
t1:Tuple4f

the other tuple

clampback to summary
public final void clamp(float min, float max, Tuple4f t)

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

Parameters
min:float

the lowest value in the tuple after clamping

max:float

the highest value in the tuple after clamping

t:Tuple4f

the source tuple, which will not be modified

clampback to summary
public final void clamp(float min, float max)

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

Parameters
min:float

the lowest value in this tuple after clamping

max:float

the highest value in this tuple after clamping

clampMaxback to summary
public final void clampMax(float max, Tuple4f t)

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

Parameters
max:float

the highest value in the tuple after clamping

t:Tuple4f

the source tuple, which will not be modified

clampMaxback to summary
public final void clampMax(float max)

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

Parameters
max:float

the highest value in the tuple after clamping

clampMinback to summary
public final void clampMin(float min, Tuple4f t)

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

Parameters
min:float

the lowest value in the tuple after clamping

t:Tuple4f

the source tuple, which will not be modified

clampMinback to summary
public final void clampMin(float min)

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

Parameters
min:float

the lowest value in this tuple after clamping

cloneback 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.
Since
vecmath 1.3
See Also
java.lang.Cloneable
epsilonEqualsback to summary
public boolean epsilonEquals(Tuple4f t1, float epsilon)

Returns true if the L-infinite distance between this tuple and tuple t1 is less than or equal to the epsilon parameter, otherwise returns false. The L-infinite distance is equal to MAX[abs(x1-x2), abs(y1-y2), abs(z1-z2), abs(w1-w2)].

Parameters
t1:Tuple4f

the tuple to be compared to this tuple

epsilon:float

the threshold value

Returns:boolean

true or false

equalsback to summary
public boolean equals(Tuple4f t1)

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

Parameters
t1:Tuple4f

the vector with which the comparison is made

Returns:boolean

true or false

equalsback to summary
public boolean equals(Object t1)

Overrides java.lang.Object.equals.

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

Parameters
t1:Object

the object with which the comparison is made

Returns:boolean

true or false

getback to summary
public final void get(float[] t)

Copies the values of this tuple into the array t.

Parameters
t:float[]

the array

getback to summary
public final void get(Tuple4f t)

Copies the values of this tuple into the tuple t.

Parameters
t:Tuple4f

the target tuple

getWback to summary
public final float getW()

Get the w coordinate.

Returns:float

the w coordinate.

Since
vecmath 1.5
getXback to summary
public final float getX()

Get the x coordinate.

Returns:float

the x coordinate.

Since
vecmath 1.5
getYback to summary
public final float getY()

Get the y coordinate.

Returns:float

the y coordinate.

Since
vecmath 1.5
getZback to summary
public final float getZ()

Get the z coordinate.

Returns:float

the z coordinate.

Since
vecmath 1.5
hashCodeback 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 Tuple4f objects with identical data values (i.e., Tuple4f.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

interpolateback to summary
public void interpolate(Tuple4f t1, Tuple4f t2, float alpha)

Linearly interpolates between tuples t1 and t2 and places the result into this tuple: this = (1-alpha)*t1 + alpha*t2.

Parameters
t1:Tuple4f

the first tuple

t2:Tuple4f

the second tuple

alpha:float

the alpha interpolation parameter

interpolateback to summary
public void interpolate(Tuple4f t1, float alpha)

Linearly interpolates between this tuple and tuple t1 and places the result into this tuple: this = (1-alpha)*this + alpha*t1.

Parameters
t1:Tuple4f

the first tuple

alpha:float

the alpha interpolation parameter

negateback to summary
public final void negate(Tuple4f t1)

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

Parameters
t1:Tuple4f

the source tuple

negateback to summary
public final void negate()

Negates the value of this tuple in place.

scaleback to summary
public final void scale(float s, Tuple4f t1)

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

Parameters
s:float

the scalar value

t1:Tuple4f

the source tuple

scaleback to summary
public final void scale(float s)

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

Parameters
s:float

the scalar value

scaleAddback to summary
public final void scaleAdd(float s, Tuple4f t1, Tuple4f t2)

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

Parameters
s:float

the scalar value

t1:Tuple4f

the tuple to be multipled

t2:Tuple4f

the tuple to be added

scaleAddback to summary
public final void scaleAdd(float s, Tuple4f t1)

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

Parameters
s:float

the scalar value

t1:Tuple4f

the tuple to be added

setback to summary
public final void set(float x, float y, float z, float w)

Sets the value of this tuple to the specified xyzw coordinates.

Parameters
x:float

the x coordinate

y:float

the y coordinate

z:float

the z coordinate

w:float

the w coordinate

setback to summary
public final void set(float[] t)

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

Parameters
t:float[]

the array of length 4 containing xyzw in order

setback to summary
public final void set(Tuple4f t1)

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

Parameters
t1:Tuple4f

the tuple to be copied

setback to summary
public final void set(Tuple4d t1)

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

Parameters
t1:Tuple4d

the tuple to be copied

setWback to summary
public final void setW(float w)

Set the w coordinate.

Parameters
w:float

value to w coordinate.

Since
vecmath 1.5
setXback to summary
public final void setX(float x)

Set the x coordinate.

Parameters
x:float

value to x coordinate.

Since
vecmath 1.5
setYback to summary
public final void setY(float y)

Set the y coordinate.

Parameters
y:float

value to y coordinate.

Since
vecmath 1.5
setZback to summary
public final void setZ(float z)

Set the z coordinate.

Parameters
z:float

value to z coordinate.

Since
vecmath 1.5
subback to summary
public final void sub(Tuple4f t1, Tuple4f t2)

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

Parameters
t1:Tuple4f

the first tuple

t2:Tuple4f

the second tuple

subback to summary
public final void sub(Tuple4f t1)

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

Parameters
t1:Tuple4f

the other tuple

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

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

Returns:String

the String representation