Package etomica.space3d

Class OrientationFull3D

java.lang.Object

etomica.space3d.OrientationFull3D

All Implemented Interfaces:

IOrientation, IOrientation3D, IOrientationFull3D, java.io.Serializable

public class OrientationFull3D
extends java.lang.Object
implements IOrientationFull3D, java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Vector	direction
protected Tensor3D	rotationTensor
protected Vector	secondaryDirection
protected Vector	v2
protected Vector	v3

Constructor Summary

Constructors

Constructor	Description
OrientationFull3D(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()
Vector	getSecondaryDirection()	Returns a unit vector pointing in the orientation's secondary direction.
void	randomRotation(IRandom random, double tStep)	Applies a random rotation of angle selected uniformly from 0 to tStep.
void	relax()	Normalizes both direction and secondaryDirection
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.
void	setDirections(Vector newPrimaryDirection, Vector newSecondaryDirection)	Sets the orientation's primary and secondary direction to be the given directions.

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

secondaryDirection

protected final Vector secondaryDirection

v2

protected final Vector v2

v3

protected final Vector v3

rotationTensor

protected final Tensor3D rotationTensor

Constructor Detail

OrientationFull3D

public OrientationFull3D(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

getSecondaryDirection

public Vector getSecondaryDirection()

Description copied from interface: IOrientationFull3D

Returns a unit vector pointing in the orientation's secondary direction. This vector should not be modified.

Specified by:

getSecondaryDirection in interface IOrientationFull3D

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

setDirections

public void setDirections(Vector newPrimaryDirection,
                          Vector newSecondaryDirection)

Description copied from interface: IOrientationFull3D

Sets the orientation's primary and secondary direction to be the given directions. The two vectors should be orthogonal.

Specified by:

setDirections in interface IOrientationFull3D

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.

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

relax

public void relax()

Normalizes both direction and secondaryDirection