Package etomica.action

Class AtomActionTranslateBy

java.lang.Object

etomica.action.AtomActionTranslateBy

All Implemented Interfaces:

AtomAction, java.io.Serializable

public class AtomActionTranslateBy
extends java.lang.Object
implements AtomAction, java.io.Serializable

Moves (translates) an atom by a specified vector amount. To move all atoms in a molecule (or atom group), wrap an instance of this class in an AtomGroupAction.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AtomActionTranslateBy(Space space)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(IAtom atom)	Performs the defined action on the specified atom
Vector	getTranslationVector()	Returns the translation vector, the distance that the atom will be moved by this action.
void	setTranslationVector(Vector translationVector)

Methods inherited from class java.lang.Object

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

Constructor Detail

AtomActionTranslateBy

public AtomActionTranslateBy(Space space)

Method Detail

actionPerformed

public void actionPerformed(IAtom atom)

Description copied from interface: AtomAction

Performs the defined action on the specified atom

Specified by:

actionPerformed in interface AtomAction

Parameters:

atom - the specified atom

getTranslationVector

public Vector getTranslationVector()

Returns the translation vector, the distance that the atom will be moved by this action. Returns the vector used by this instance, not a copy, so any manipulation of the returned vector will affect the action of this instance.

setTranslationVector

public void setTranslationVector(Vector translationVector)

Parameters:

translationVector - The translation vector to set. A local copy is made of the given vector.