javax.vecmath

Class AxisAngle4f

java.lang.Object

javax.vecmath.AxisAngle4f

All Implemented Interfaces:

java.io.Serializable

public class AxisAngle4f
extends java.lang.Object
implements java.io.Serializable

A 4 element axis angle represented by single precision floating point x,y,z,angle components. An axis angle is a rotation of angle (radians) about the vector (x,y,z).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
float	angle The angle.
float	x The x coordinate.
float	y The y coordinate.
float	z The z coordinate.

Constructor Summary

Constructors

Constructor and Description
AxisAngle4f() Constructs and initializes a AxisAngle4f to (0,0,1,0).
AxisAngle4f(AxisAngle4d a1) Constructs and initializes a AxisAngle4f from the specified AxisAngle4f.
AxisAngle4f(AxisAngle4f a1) Constructs and initializes a AxisAngle4f from the specified AxisAngle4f.
AxisAngle4f(float[] a) Constructs and initializes an AxisAngle4f from the components contained in the array.
AxisAngle4f(float x, float y, float z, float angle) Constructs and initializes an AxisAngle4f from the specified x, y, z, and angle.
AxisAngle4f(Vector3f axis, float angle) Constructs and initializes an AxisAngle4f from the specified axis and angle.

Method Summary

Modifier and Type	Method and Description
boolean	epsilonEquals(AxisAngle4f a1, float epsilon) Returns true if the L-infinite distance between this axis-angle and axis-angle t1 is less than or equal to the epsilon parameter, otherwise returns false.
boolean	equals(AxisAngle4f a1) Returns true if all of the data members of AxisAngle4f t1 are equal to the corresponding data members in this
boolean	equals(java.lang.Object o1) Returns true if the Object o1 is of type AxisAngle4f and all of the data members of o1 are equal to the corresponding data members in this AxisAngle4f.
void	get(float[] a) Gets the value of this axis angle into the array a of length four in x,y,z,angle order.
int	hashCode() Returns a hash number based on the data values in this object.
void	set(AxisAngle4d a1) Sets the value of this axis angle to the value of axis angle t1.
void	set(AxisAngle4f a1) Sets the value of this axis angle to the value of axis angle t1.
void	set(float[] a) Sets the value of this axis angle from the 4 values specified in the array.
void	set(float x, float y, float z, float angle) Sets the value of this axis angle to the specified x,y,z,angle.
void	set(Matrix3d m1) Sets the value of this axis-angle to the rotational component of the passed matrix.
void	set(Matrix3f m1) Sets the value of this axis-angle to the rotational component of the passed matrix.
void	set(Matrix4d m1) Sets the value of this axis-angle to the rotational component of the passed matrix.
void	set(Matrix4f m1) Sets the value of this axis-angle to the rotational component of the passed matrix.
void	set(Quat4d q1) Sets the value of this axis-angle to the rotational equivalent of the passed quaternion.
void	set(Quat4f q1) Sets the value of this axis-angle to the rotational equivalent of the passed quaternion.
void	set(Vector3f axis, float angle) Sets the value of this AxisAngle4f to the specified axis and angle.
java.lang.String	toString() Returns a string that contains the values of this AxisAngle4f.

Methods inherited from class java.lang.Object

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

Field Detail

x

public float x

The x coordinate.

y

public float y

The y coordinate.

z

public float z

The z coordinate.

angle

public float angle

The angle.

Constructor Detail

AxisAngle4f

public AxisAngle4f(float x,
                   float y,
                   float z,
                   float angle)

Constructs and initializes an AxisAngle4f from the specified x, y, z, and angle.

Parameters:

x - the x coordinate

y - the y coordinate

z - the z coordinate

angle - the angle.

AxisAngle4f

public AxisAngle4f(float[] a)

Constructs and initializes an AxisAngle4f from the components contained in the array.

Parameters:

a - the array of length 4 containing x,y,z,angle in order

AxisAngle4f

public AxisAngle4f(AxisAngle4f a1)

Constructs and initializes a AxisAngle4f from the specified AxisAngle4f.

Parameters:

a1 - the AxisAngle4f containing the initialization x y z angle data

AxisAngle4f

public AxisAngle4f(AxisAngle4d a1)

Constructs and initializes a AxisAngle4f from the specified AxisAngle4f.

Parameters:

a1 - the AxisAngle4d containing the initialization x y z angle data

AxisAngle4f

public AxisAngle4f()

Constructs and initializes a AxisAngle4f to (0,0,1,0).

AxisAngle4f

public AxisAngle4f(Vector3f axis,
                   float angle)

Constructs and initializes an AxisAngle4f from the specified axis and angle.

Parameters:

axis - the axis

angle - the angle

Since:

Java 3D 1.2

Method Detail

set

public final void set(Vector3f axis,
                      float angle)

Sets the value of this AxisAngle4f to the specified axis and angle.

Parameters:

axis - the axis

angle - the angle

Since:

Java 3D 1.2

set

public final void set(float x,
                      float y,
                      float z,
                      float angle)

Sets the value of this axis angle to the specified x,y,z,angle.

Parameters:

x - the x coordinate

y - the y coordinate

z - the z coordinate

angle - the angle

set

public final void set(float[] a)

Sets the value of this axis angle from the 4 values specified in the array.

Parameters:

a - the array of length 4 containing x,y,z,angle in order

set

public final void set(AxisAngle4f a1)

Sets the value of this axis angle to the value of axis angle t1.

Parameters:

a1 - the axis angle to be copied

set

public final void set(AxisAngle4d a1)

Sets the value of this axis angle to the value of axis angle t1.

Parameters:

a1 - the axis angle to be copied

get

public final void get(float[] a)

Gets the value of this axis angle into the array a of length four in x,y,z,angle order.

Parameters:

a - the array of length four

set

public final void set(Matrix4f m1)

Sets the value of this axis-angle to the rotational component of the passed matrix.

Parameters:

m1 - the matrix4f

set

public final void set(Matrix4d m1)

Sets the value of this axis-angle to the rotational component of the passed matrix.

Parameters:

m1 - the matrix4d

set

public final void set(Matrix3f m1)

Sets the value of this axis-angle to the rotational component of the passed matrix.

Parameters:

m1 - the matrix3f

set

public final void set(Matrix3d m1)

Sets the value of this axis-angle to the rotational component of the passed matrix.

Parameters:

m1 - the matrix3d

set

public final void set(Quat4f q1)

Sets the value of this axis-angle to the rotational equivalent of the passed quaternion.

Parameters:

q1 - the Quat4f

set

public final void set(Quat4d q1)

Sets the value of this axis-angle to the rotational equivalent of the passed quaternion.

Parameters:

q1 - the Quat4d

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

the String representation

equals

public boolean equals(AxisAngle4f a1)

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

Parameters:

a1 - the vector with which the comparison is made.

equals

public boolean equals(java.lang.Object o1)

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

Overrides:

equals in class java.lang.Object

Parameters:

o1 - the object with which the comparison is made.

epsilonEquals

public boolean epsilonEquals(AxisAngle4f a1,
                             float epsilon)

Returns true if the L-infinite distance between this axis-angle and axis-angle 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(angle1-angle2)].

Parameters:

a1 - the axis-angle to be compared to this axis-angle

epsilon - the threshold value

hashCode

public int hashCode()

Returns a hash number based on the data values in this object. Two different AxisAngle4f objects with identical data values (ie, returns true for equals(AxisAngle4f) ) will return the same hash number. Two vectors with different data members may return the same hash value, although this is not likely.

Overrides:

hashCode in class java.lang.Object