vecmath 1.5.2 · javax.vecmath.Tuple3d

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

Access	Constructor and Description
public	Tuple3d(double the x coordinate x, double the y coordinate y, double the z coordinate z) Constructs and initializes a Tuple3d from the specified xyz coordinates.
public	Tuple3d(double[] the array of length 3 containing xyz in order t) Constructs and initializes a Tuple3d from the array of length 3.
public	Tuple3d(Tuple3d the Tuple3d containing the initialization x y z data t1) Constructs and initializes a Tuple3d from the specified Tuple3d.
public	Tuple3d(Tuple3f the Tuple3f containing the initialization x y z data t1) Constructs and initializes a Tuple3d from the specified Tuple3f.
public	Tuple3d() Constructs and initializes a Tuple3d to (0,0,0).

Method Summary

Modifier and Type	Method and Description
public final void	absolute(Tuple3d 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(Tuple3d the first tuple t1, Tuple3d the second tuple t2) Sets the value of this tuple to the sum of tuples t1 and t2.
public final void	add(Tuple3d the other tuple t1) Sets the value of this tuple to the sum of itself and t1.
public final void	clamp(float min, float max, Tuple3d t) Deprecated Use clamp(double,double,Tuple3d) instead
public final void	clamp(double the lowest value in the tuple after clamping min, double the highest value in the tuple after clamping max, Tuple3d 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 min, float max) Deprecated Use clamp(double,double) instead
public final void	clamp(double the lowest value in this tuple after clamping min, double the highest value in this tuple after clamping max) Clamps this tuple to the range [low, high].
public final void	clampMax(float max, Tuple3d t) Deprecated Use clampMax(double,Tuple3d) instead
public final void	clampMax(double the highest value in the tuple after clamping max, Tuple3d 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 max) Deprecated Use clampMax(double) instead
public final void	clampMax(double 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 min, Tuple3d t) Deprecated Use clampMin(double,Tuple3d) instead
public final void	clampMin(double the lowest value in the tuple after clamping min, Tuple3d 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 min) Deprecated Use clampMin(double) instead
public final void	clampMin(double 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(Tuple3d the tuple to be compared to this tuple t1, double 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(Tuple3d the tuple with which the comparison is made t1) Returns true if all of the data members of Tuple3d t1 are equal to the corresponding data members in this Tuple3d.
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 Tuple3d and all of the data members of t1 are equal to the corresponding data members in this Tuple3d.
public final void	get(double[] the target array t) Copies the x,y,z coordinates of this tuple into the array t of length 3.
public final void	get(Tuple3d the Tuple3d object into which the values of this object are copied t) Copies the x,y,z coordinates of this tuple into the tuple t.
public final double	Returns: the x coordinate. getX() Get the x coordinate.
public final double	Returns: the y coordinate. getY() Get the y coordinate.
public final double	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 final void	interpolate(Tuple3d t1, Tuple3d t2, float alpha) Deprecated Use interpolate(Tuple3d,Tuple3d,double) instead
public final void	interpolate(Tuple3d the first tuple t1, Tuple3d the second tuple t2, double the alpha interpolation parameter alpha) Linearly interpolates between tuples t1 and t2 and places the result into this tuple: this = (1-alpha)t1 + alphat2.
public final void	interpolate(Tuple3d t1, float alpha) Deprecated Use interpolate(Tuple3d,double) instead
public final void	interpolate(Tuple3d the first tuple t1, double the alpha interpolation parameter alpha) Linearly interpolates between this tuple and tuple t1 and places the result into this tuple: this = (1-alpha)this + alphat1.
public final void	negate(Tuple3d 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(double the scalar value s, Tuple3d the source tuple t1) Sets the value of this tuple to the scalar multiplication of tuple t1.
public final void	scale(double the scalar value s) Sets the value of this tuple to the scalar multiplication of itself.
public final void	scaleAdd(double the scalar value s, Tuple3d the tuple to be multipled t1, Tuple3d the tuple to be added t2) Sets the value of this tuple to the scalar multiplication of tuple t1 and then adds tuple t2 (this = s*t1 + t2).
public final void	scaleAdd(double s, Tuple3f t1) Deprecated Use scaleAdd(double,Tuple3d) instead
public final void	scaleAdd(double the scalar value s, Tuple3d 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(double the x coordinate x, double the y coordinate y, double the z coordinate z) Sets the value of this tuple to the specified xyz coordinates.
public final void	set(double[] the array of length 3 containing xyz in order t) Sets the value of this tuple to the value of the xyz coordinates located in the array of length 3.
public final void	set(Tuple3d the tuple to be copied t1) Sets the value of this tuple to the value of tuple t1.
public final void	set(Tuple3f the tuple to be copied t1) Sets the value of this tuple to the value of tuple t1.
public final void	setX(double value to x coordinate. x) Set the x coordinate.
public final void	setY(double value to y coordinate. y) Set the y coordinate.
public final void	setZ(double value to z coordinate. z) Set the z coordinate.
public final void	sub(Tuple3d the first tuple t1, Tuple3d 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(Tuple3d 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 Tuple3d.

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 double x The x coordinate.

y	back to summary
public double y The y coordinate.

z	back to summary
public double z The z coordinate.

Tuple3d	back to summary
public Tuple3d(double x, double y, double z) Constructs and initializes a Tuple3d from the specified xyz coordinates. Parameters x:double the x coordinate y:double the y coordinate z:double the z coordinate

Tuple3d	back to summary
public Tuple3d(double[] t) Constructs and initializes a Tuple3d from the array of length 3. Parameters t:double[] the array of length 3 containing xyz in order

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

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

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

Method Detail

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

absolute

back to summary

public final void absolute(Tuple3d t)

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

Parameters

t:Tuple3d: 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(Tuple3d t1, Tuple3d t2) Sets the value of this tuple to the sum of tuples t1 and t2. Parameters t1:Tuple3d the first tuple t2:Tuple3d the second tuple

add

back to summary

public final void add(Tuple3d t1, Tuple3d t2)

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

Parameters

t1:Tuple3d: the first tuple
t2:Tuple3d: the second tuple

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

add

back to summary

public final void add(Tuple3d t1)

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

Parameters

t1:Tuple3d: the other tuple

clamp	back to summary
public final void clamp(float min, float max, Tuple3d t) Deprecated Use clamp(double,double,Tuple3d) instead

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

clamp

back to summary

public final void clamp(double min, double max, Tuple3d t)

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

Parameters

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

clamp	back to summary
public final void clamp(float min, float max) Deprecated Use clamp(double,double) instead

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

clamp

back to summary

public final void clamp(double min, double max)

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

Parameters

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

clampMax	back to summary
public final void clampMax(float max, Tuple3d t) Deprecated Use clampMax(double,Tuple3d) instead

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

clampMax

back to summary

public final void clampMax(double max, Tuple3d t)

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

Parameters

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

clampMax	back to summary
public final void clampMax(float max) Deprecated Use clampMax(double) instead

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

clampMax

back to summary

public final void clampMax(double max)

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

Parameters

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

clampMin	back to summary
public final void clampMin(float min, Tuple3d t) Deprecated Use clampMin(double,Tuple3d) instead

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

clampMin

back to summary

public final void clampMin(double min, Tuple3d t)

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

Parameters

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

clampMin	back to summary
public final void clampMin(float min) Deprecated Use clampMin(double) instead

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

clampMin

back to summary

public final void clampMin(double min)

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

Parameters

min:double: 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. Since vecmath 1.3 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.

Since

vecmath 1.3

See Also

java.lang.Cloneable

epsilonEquals	back to summary
public boolean epsilonEquals(Tuple3d t1, double 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)]. Parameters t1:Tuple3d the tuple to be compared to this tuple epsilon:double the threshold value Returns:boolean true or false

epsilonEquals

back to summary

public boolean epsilonEquals(Tuple3d t1, double 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)].

Parameters

t1:Tuple3d: the tuple to be compared to this tuple
epsilon:double: the threshold value

Returns:boolean

true or false

equals	back to summary
public boolean equals(Tuple3d t1) Returns true if all of the data members of Tuple3d t1 are equal to the corresponding data members in this Tuple3d. Parameters t1:Tuple3d the tuple with which the comparison is made Returns:boolean true or false

equals

back to summary

public boolean equals(Tuple3d t1)

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

Parameters

t1:Tuple3d: the tuple with which the comparison is made

Returns:boolean

true or false

equals	back to summary
public boolean equals(Object t1) Overrides java.lang.Object.equals. Returns true if the Object t1 is of type Tuple3d and all of the data members of t1 are equal to the corresponding data members in this Tuple3d. Parameters t1:Object the Object with which the comparison is made Returns:boolean true or false

equals

back to summary

public boolean equals(Object t1)

Overrides java.lang.Object.equals.

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

Parameters

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

Returns:boolean

true or false

get	back to summary
public final void get(double[] t) Copies the x,y,z coordinates of this tuple into the array t of length 3. Parameters t:double[] the target array

get

back to summary

public final void get(double[] t)

Copies the x,y,z coordinates of this tuple into the array t of length 3.

Parameters

t:double[]: the target array

get	back to summary
public final void get(Tuple3d t) Copies the x,y,z coordinates of this tuple into the tuple t. Parameters t:Tuple3d the Tuple3d object into which the values of this object are copied

get

back to summary

public final void get(Tuple3d t)

Copies the x,y,z coordinates of this tuple into the tuple t.

Parameters

t:Tuple3d: the Tuple3d object into which the values of this object are copied

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

getX

back to summary

public final double getX()

Get the x coordinate.

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

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

getY

back to summary

public final double getY()

Get the y coordinate.

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

getZ	back to summary
public final double getZ() Get the z coordinate. Returns:double the z coordinate. Since vecmath 1.5

getZ

back to summary

public final double getZ()

Get the z coordinate.

Returns:double: the z 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 Tuple3d objects with identical data values (i.e., Tuple3d.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 Tuple3d objects with identical data values (i.e., Tuple3d.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

interpolate	back to summary
public final void interpolate(Tuple3d t1, Tuple3d t2, float alpha) Deprecated Use interpolate(Tuple3d,Tuple3d,double) instead

interpolate	back to summary
public final void interpolate(Tuple3d t1, Tuple3d t2, double alpha) Linearly interpolates between tuples t1 and t2 and places the result into this tuple: this = (1-alpha)t1 + alphat2. Parameters t1:Tuple3d the first tuple t2:Tuple3d the second tuple alpha:double the alpha interpolation parameter

interpolate

back to summary

public final void interpolate(Tuple3d t1, Tuple3d t2, double alpha)

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

Parameters

t1:Tuple3d: the first tuple
t2:Tuple3d: the second tuple
alpha:double: the alpha interpolation parameter

interpolate	back to summary
public final void interpolate(Tuple3d t1, float alpha) Deprecated Use interpolate(Tuple3d,double) instead

interpolate	back to summary
public final void interpolate(Tuple3d t1, double alpha) Linearly interpolates between this tuple and tuple t1 and places the result into this tuple: this = (1-alpha)this + alphat1. Parameters t1:Tuple3d the first tuple alpha:double the alpha interpolation parameter

interpolate

back to summary

public final void interpolate(Tuple3d t1, double alpha)

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

Parameters

t1:Tuple3d: the first tuple
alpha:double: the alpha interpolation parameter

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

negate

back to summary

public final void negate(Tuple3d t1)

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

Parameters

t1:Tuple3d: 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(double s, Tuple3d t1) Sets the value of this tuple to the scalar multiplication of tuple t1. Parameters s:double the scalar value t1:Tuple3d the source tuple

scale

back to summary

public final void scale(double s, Tuple3d t1)

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

Parameters

s:double: the scalar value
t1:Tuple3d: the source tuple

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

scale

back to summary

public final void scale(double s)

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

Parameters

s:double: the scalar value

scaleAdd	back to summary
public final void scaleAdd(double s, Tuple3d t1, Tuple3d 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:double the scalar value t1:Tuple3d the tuple to be multipled t2:Tuple3d the tuple to be added

scaleAdd

back to summary

public final void scaleAdd(double s, Tuple3d t1, Tuple3d 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:double: the scalar value
t1:Tuple3d: the tuple to be multipled
t2:Tuple3d: the tuple to be added

scaleAdd	back to summary
public final void scaleAdd(double s, Tuple3f t1) Deprecated Use scaleAdd(double,Tuple3d) instead

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

scaleAdd

back to summary

public final void scaleAdd(double s, Tuple3d t1)

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

Parameters

s:double: the scalar value
t1:Tuple3d: the tuple to be added

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

set

back to summary

public final void set(double x, double y, double z)

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

Parameters

x:double: the x coordinate
y:double: the y coordinate
z:double: the z coordinate

set

back to summary

public final void set(double[] t)

Sets the value of this tuple to the value of the xyz coordinates located in the array of length 3.

Parameters

t:double[]: the array of length 3 containing xyz in order

set

back to summary

public final void set(Tuple3d t1)

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

Parameters

t1:Tuple3d: the tuple to be copied

set

back to summary

public final void set(Tuple3f t1)

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

Parameters

t1:Tuple3f: the tuple to be copied

setX

back to summary

public final void setX(double x)

Set the x coordinate.

Parameters

x:double: value to x coordinate.

Since

vecmath 1.5

setY

back to summary

public final void setY(double y)

Set the y coordinate.

Parameters

y:double: value to y coordinate.

Since

vecmath 1.5

setZ

back to summary

public final void setZ(double z)

Set the z coordinate.

Parameters

z:double: value to z coordinate.

Since

vecmath 1.5

sub

back to summary

public final void sub(Tuple3d t1, Tuple3d t2)

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

Parameters

t1:Tuple3d: the first tuple
t2:Tuple3d: the second tuple

sub

back to summary

public final void sub(Tuple3d t1)

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

Parameters

t1:Tuple3d: the other tuple

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

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

Returns:String: the String representation

public abstract Class Tuple3d

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail