Package etomica.space2d

Class Orientation2D

java.lang.Object

etomica.space2d.Orientation2D

All Implemented Interfaces:

IOrientation, IOrientation2D, java.io.Serializable

public class Orientation2D
extends java.lang.Object
implements IOrientation2D, java.io.Serializable

Orientation in a 2-dimensional space. Orientation can be expressed in terms of a single angle that describes rotation of the body frame in a counter-clockwise direction with respect to the fixed space frame. Periodicity is applied to restrict the angle to values between 0 and 2 PI.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	angle
protected Vector	direction

Constructor Summary

Constructors

Constructor	Description
Orientation2D()	Default constructor sets orientation angle to zero.
Orientation2D(Vector direction)	Constructs with orientation as specified by the given angle theta.

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 within plus or minus tStep from the current value.
void	rotateBy(double dt)	Rotates orientation around the given axis by the given value.
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

angle

protected double angle

direction

protected Vector direction

Constructor Detail

Orientation2D

public Orientation2D()

Default constructor sets orientation angle to zero.

Orientation2D

public Orientation2D(Vector direction)

Constructs with orientation as specified by the given angle theta.

Throws:

java.lang.Exception - if vector has 0 length

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)

Description copied from interface: IOrientation

Sets this orientation to point in the given direction.

Specified by:

setDirection in interface IOrientation

Parameters:

newDirection - the new direction for this orientation

rotateBy

public void rotateBy(double dt)

Rotates orientation around the given axis by the given value.

Specified by:

rotateBy in interface IOrientation2D

randomRotation

public void randomRotation(IRandom random,
                           double tStep)

Applies a random rotation of angle selected uniformly within plus or minus tStep from the current value.

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