Package org.jmol.util

Class AxisAngle4f

java.lang.Object

org.jmol.util.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	Description
float	angle	The angle.
float	x	The x coordinate.
float	y	The y coordinate.
float	z	The z coordinate.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)	Returns true if the Object o is of type AxisAngle4f and all of the data members of o1 are equal to the corresponding data members in this AxisAngle4f.
int	hashCode()	Returns a hash number based on the data values in this object.
static AxisAngle4f	new4(float x, float y, float z, float angle)	Constructs and initializes an AxisAngle4f from the specified x, y, z, and angle.
static AxisAngle4f	newAA(AxisAngle4f a1)	Constructs and initializes a AxisAngle4f from the specified AxisAngle4f.
static AxisAngle4f	newVA(Vector3f axis, float angle)	Constructs and initializes an AxisAngle4f from the specified axis and angle.
void	set4(float x, float y, float z, float angle)	Sets the value of this axis angle to the specified x,y,z,angle.
void	setAA(AxisAngle4f a)	Sets the value of this axis angle to the value of axis angle t1.
void	setM(Matrix3f m1)	Sets the value of this axis-angle to the rotational component of the passed matrix.
void	setVA(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()

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

Method Detail

new4

public static AxisAngle4f new4(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.

Returns:

a

newAA

public static AxisAngle4f newAA(AxisAngle4f a1)

Constructs and initializes a AxisAngle4f from the specified AxisAngle4f.

Parameters:

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

Returns:

a

newVA

public static AxisAngle4f newVA(Vector3f axis,
                                float angle)

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

Parameters:

axis - the axis

angle - the angle

Returns:

a

setVA

public final void setVA(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

set4

public final void set4(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

setAA

public final void setAA(AxisAngle4f a)

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

Parameters:

a - the axis angle to be copied

setM

public final void setM(Matrix3f m1)

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

Parameters:

m1 - the matrix3f

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(java.lang.Object o)

Returns true if the Object o 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:

o - the object with which the comparison is made.

Returns:

T/F

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