Package javax.vecmath
Class Tuple4f
java.lang.Object
javax.vecmath.Tuple4f
- All Implemented Interfaces:
Serializable
,Cloneable
- Direct Known Subclasses:
Color4f
,Point4f
,Quat4f
,TexCoord4f
,Vector4f
A 4-element tuple represented by single-precision floating point x,y,z,w
coordinates.
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionTuple4f()
Constructs and initializes a Tuple4f to (0,0,0,0).Tuple4f
(float[] t) Constructs and initializes a Tuple4f from the array of length 4.Tuple4f
(float x, float y, float z, float w) Constructs and initializes a Tuple4f from the specified xyzw coordinates.Constructs and initializes a Tuple4f from the specified Tuple4d.Constructs and initializes a Tuple4f from the specified Tuple4f. -
Method Summary
Modifier and TypeMethodDescriptionfinal void
absolute()
Sets each component of this tuple to its absolute value.final void
Sets each component of the tuple parameter to its absolute value and places the modified values into this tuple.final void
Sets the value of this tuple to the sum of itself and t1.final void
Sets the value of this tuple to the sum of tuples t1 and t2.final void
clamp
(float min, float max) Clamps this tuple to the range [low, high].final void
Clamps the tuple parameter to the range [low, high] and places the values into this tuple.final void
clampMax
(float max) Clamps the maximum value of this tuple to the max parameter.final void
Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple.final void
clampMin
(float min) Clamps the minimum value of this tuple to the min parameter.final void
Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.clone()
Creates a new object of the same class as this object.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.boolean
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.boolean
Returns true if all of the data members of Tuple4f t1 are equal to the corresponding data members in this Tuple4f.final void
get
(float[] t) Copies the values of this tuple into the array t.final void
Copies the values of this tuple into the tuple t.final float
getW()
Get the w coordinate.final float
getX()
Get the x coordinate.final float
getY()
Get the y coordinate.final float
getZ()
Get the z coordinate.int
hashCode()
Returns a hash code value based on the data values in this object.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.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.final void
negate()
Negates the value of this tuple in place.final void
Sets the value of this tuple to the negation of tuple t1.final void
scale
(float s) Sets the value of this tuple to the scalar multiplication of the scale factor with this.final void
Sets the value of this tuple to the scalar multiplication of tuple t1.final void
Sets the value of this tuple to the scalar multiplication of itself and then adds tuple t1 (this = s*this + t1).final void
Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).final void
set
(float[] t) Sets the value of this tuple to the specified coordinates in the array of length 4.final void
set
(float x, float y, float z, float w) Sets the value of this tuple to the specified xyzw coordinates.final void
Sets the value of this tuple to the value of tuple t1.final void
Sets the value of this tuple to the value of tuple t1.final void
setW
(float w) Set the w coordinate.final void
setX
(float x) Set the x coordinate.final void
setY
(float y) Set the y coordinate.final void
setZ
(float z) Set the z coordinate.final void
Sets the value of this tuple to the difference of itself and t1 (this = this - t1).final void
Sets the value of this tuple to the difference of tuples t1 and t2 (this = t1 - t2).toString()
Returns a string that contains the values of this Tuple4f.
-
Field Details
-
x
public float xThe x coordinate. -
y
public float yThe y coordinate. -
z
public float zThe z coordinate. -
w
public float wThe w coordinate.
-
-
Constructor Details
-
Tuple4f
public Tuple4f(float x, float y, float z, float w) Constructs and initializes a Tuple4f from the specified xyzw coordinates.- Parameters:
x
- the x coordinatey
- the y coordinatez
- the z coordinatew
- the w coordinate
-
Tuple4f
public Tuple4f(float[] t) Constructs and initializes a Tuple4f from the array of length 4.- Parameters:
t
- the array of length 4 containing xyzw in order
-
Tuple4f
Constructs and initializes a Tuple4f from the specified Tuple4f.- Parameters:
t1
- the Tuple4f containing the initialization x y z w data
-
Tuple4f
Constructs and initializes a Tuple4f from the specified Tuple4d.- Parameters:
t1
- the Tuple4d containing the initialization x y z w data
-
Tuple4f
public Tuple4f()Constructs and initializes a Tuple4f to (0,0,0,0).
-
-
Method Details
-
set
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
- the x coordinatey
- the y coordinatez
- the z coordinatew
- the w coordinate
-
set
public final void set(float[] t) Sets the value of this tuple to the specified coordinates in the array of length 4.- Parameters:
t
- the array of length 4 containing xyzw in order
-
set
Sets the value of this tuple to the value of tuple t1.- Parameters:
t1
- the tuple to be copied
-
set
Sets the value of this tuple to the value of tuple t1.- Parameters:
t1
- the tuple to be copied
-
get
public final void get(float[] t) Copies the values of this tuple into the array t.- Parameters:
t
- the array
-
get
Copies the values of this tuple into the tuple t.- Parameters:
t
- the target tuple
-
add
Sets the value of this tuple to the sum of tuples t1 and t2.- Parameters:
t1
- the first tuplet2
- the second tuple
-
add
Sets the value of this tuple to the sum of itself and t1.- Parameters:
t1
- the other tuple
-
sub
Sets the value of this tuple to the difference of tuples t1 and t2 (this = t1 - t2).- Parameters:
t1
- the first tuplet2
- the second tuple
-
sub
Sets the value of this tuple to the difference of itself and t1 (this = this - t1).- Parameters:
t1
- the other tuple
-
negate
Sets the value of this tuple to the negation of tuple t1.- Parameters:
t1
- the source tuple
-
negate
public final void negate()Negates the value of this tuple in place. -
scale
Sets the value of this tuple to the scalar multiplication of tuple t1.- Parameters:
s
- the scalar valuet1
- the source tuple
-
scale
public final void scale(float s) Sets the value of this tuple to the scalar multiplication of the scale factor with this.- Parameters:
s
- the scalar value
-
scaleAdd
Sets the value of this tuple to the scalar multiplication of tuple t1 plus tuple t2 (this = s*t1 + t2).- Parameters:
s
- the scalar valuet1
- the tuple to be multipledt2
- the tuple to be added
-
scaleAdd
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 valuet1
- the tuple to be added
-
toString
Returns a string that contains the values of this Tuple4f. The form is (x,y,z,w). -
equals
Returns true if all of the data members of Tuple4f t1 are equal to the corresponding data members in this Tuple4f.- Parameters:
t1
- the vector with which the comparison is made- Returns:
- true or false
-
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. -
epsilonEquals
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
- the tuple to be compared to this tupleepsilon
- the threshold value- Returns:
- true or false
-
hashCode
public int 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. -
clamp
Clamps the tuple parameter to the range [low, high] and places the values into this tuple.- Parameters:
min
- the lowest value in the tuple after clampingmax
- the highest value in the tuple after clampingt
- the source tuple, which will not be modified
-
clampMin
Clamps the minimum value of the tuple parameter to the min parameter and places the values into this tuple.- Parameters:
min
- the lowest value in the tuple after clampingt
- the source tuple, which will not be modified
-
clampMax
Clamps the maximum value of the tuple parameter to the max parameter and places the values into this tuple.- Parameters:
max
- the highest value in the tuple after clampingt
- the source tuple, which will not be modified
-
absolute
Sets each component of the tuple parameter to its absolute value and places the modified values into this tuple.- Parameters:
t
- the source tuple, which will not be modified
-
clamp
public final void clamp(float min, float max) Clamps this tuple to the range [low, high].- Parameters:
min
- the lowest value in this tuple after clampingmax
- the highest value in this tuple after clamping
-
clampMin
public final void clampMin(float min) Clamps the minimum value of this tuple to the min parameter.- Parameters:
min
- the lowest value in this tuple after clamping
-
clampMax
public final void clampMax(float max) Clamps the maximum value of this tuple to the max parameter.- Parameters:
max
- the highest value in the tuple after clamping
-
absolute
public final void absolute()Sets each component of this tuple to its absolute value. -
interpolate
Linearly interpolates between tuples t1 and t2 and places the result into this tuple: this = (1-alpha)*t1 + alpha*t2.- Parameters:
t1
- the first tuplet2
- the second tuplealpha
- the alpha interpolation parameter
-
interpolate
Linearly interpolates between this tuple and tuple t1 and places the result into this tuple: this = (1-alpha)*this + alpha*t1.- Parameters:
t1
- the first tuplealpha
- the alpha interpolation parameter
-
clone
Creates a new object of the same class as this object.- Overrides:
clone
in classObject
- Returns:
- a clone of this instance.
- Throws:
OutOfMemoryError
- if there is not enough memory.- Since:
- vecmath 1.3
- See Also:
-
getX
public final float getX()Get the x coordinate.- Returns:
- the x coordinate.
- Since:
- vecmath 1.5
-
setX
public final void setX(float x) Set the x coordinate.- Parameters:
x
- value to x coordinate.- Since:
- vecmath 1.5
-
getY
public final float getY()Get the y coordinate.- Returns:
- the y coordinate.
- Since:
- vecmath 1.5
-
setY
public final void setY(float y) Set the y coordinate.- Parameters:
y
- value to y coordinate.- Since:
- vecmath 1.5
-
getZ
public final float getZ()Get the z coordinate.- Returns:
- the z coordinate.
- Since:
- vecmath 1.5
-
setZ
public final void setZ(float z) Set the z coordinate.- Parameters:
z
- value to z coordinate.- Since:
- vecmath 1.5
-
getW
public final float getW()Get the w coordinate.- Returns:
- the w coordinate.
- Since:
- vecmath 1.5
-
setW
public final void setW(float w) Set the w coordinate.- Parameters:
w
- value to w coordinate.- Since:
- vecmath 1.5
-