Package etomica.action

Class MoleculeActionTranslateTo

java.lang.Object

etomica.action.MoleculeActionTranslateTo

All Implemented Interfaces:

MoleculeAction, java.io.Serializable

public class MoleculeActionTranslateTo
extends java.lang.Object
implements MoleculeAction, java.io.Serializable

Moves (translates) an atom to a specified position. Location of the atom (which may be an atom group) is determined by an AtomPositionDefinition instance that may be set for this class.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MoleculeActionTranslateTo(Space space)	Creates new action with atom position defined by its center of mass (via MoleculePositionCOM).

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(IMolecule atom)
IMoleculePositionDefinition	getAtomPositionDefinition()
Vector	getDestination()
Vector	getTranslationVector()	Returns the vector that was used to accomplish the most recent translation action.
void	setAtomPositionDefinition(IMoleculePositionDefinition atomPositionDefinition)
void	setDestination(Vector newDestination)

Methods inherited from class java.lang.Object

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

Constructor Detail

MoleculeActionTranslateTo

public MoleculeActionTranslateTo(Space space)

Creates new action with atom position defined by its center of mass (via MoleculePositionCOM).

Parameters:

space -

Method Detail

actionPerformed

public void actionPerformed(IMolecule atom)

Specified by:

actionPerformed in interface MoleculeAction

getDestination

public Vector getDestination()

Returns:

Returns the destination, the position that the atom will be moved to by this action.

setDestination

public void setDestination(Vector newDestination)

Parameters:

newDestination - The destination to set. A local copy is made of the given vector.

getAtomPositionDefinition

public IMoleculePositionDefinition getAtomPositionDefinition()

Returns:

Returns the atomPositionDefinition.

setAtomPositionDefinition

public void setAtomPositionDefinition(IMoleculePositionDefinition atomPositionDefinition)

Parameters:

atomPositionDefinition - The atomPositionDefinition to set.

getTranslationVector

public Vector getTranslationVector()

Returns the vector that was used to accomplish the most recent translation action. This vector can be used to reverse the translation by multiplying it by -1 and performing an atomActionTranslateBy with it.