Package etomica.space3d

Class Orientation3D

java.lang.Object

etomica.space3d.Orientation3D

All Implemented Interfaces:

IOrientation, IOrientation3D, java.io.Serializable

public class Orientation3D
extends java.lang.Object
implements IOrientation3D, java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Vector	direction
protected Vector	temp
protected Vector	temp2

Constructor Summary

Constructors

Constructor	Description
Orientation3D(Space space)	Default constructor sets orientation to point in the X direction.

Method Summary

Modifier and Type	Method	Description
void	E(IOrientation o)	Copies the given orientation to this one.
Vector	getDirection()
void	randomRotation(IRandom random, double tStep)	Applies a random rotation of angle selected uniformly from 0 to tStep.
void	rotateBy(double dt, Vector axis)	Rotates orientation by the given value about the given axis.
void	setDirection(Vector newDirection)	Sets this orientation to point in the given direction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

direction

protected final Vector direction

temp

protected final Vector temp

temp2

protected final Vector temp2

Constructor Detail

Orientation3D

public Orientation3D(Space space)

Default constructor sets orientation to point in the X direction.

Method Detail

E

public void E(IOrientation o)

Description copied from interface: IOrientation

Copies the given orientation to this one.

Specified by:

E in interface IOrientation

Parameters:

o - the new orientation

getDirection

public Vector getDirection()

Specified by:

getDirection in interface IOrientation

setDirection

public void setDirection(Vector newDirection)

Sets this orientation to point in the given direction.

Specified by:

setDirection in interface IOrientation

Parameters:

newDirection - the new direction for this orientation

Throws:

java.lang.Exception - if vector has 0 length

rotateBy

public void rotateBy(double dt,
                     Vector axis)

Rotates orientation by the given value about the given axis. The axis must have unit length, but need not be perpendicular to the current orientation direction.

Specified by:

rotateBy in interface IOrientation3D

randomRotation

public void randomRotation(IRandom random,
                           double tStep)

Applies a random rotation of angle selected uniformly from 0 to tStep. The rotation axis is selected randomly, but is orthogonal to the original direction.

Specified by:

randomRotation in interface IOrientation

Parameters:

random - random number generator used to select the angle

tStep - the maximum angle (in radians) for random rotation