BALL::TranslationProcessor Class Reference
[Geometric property processors.]

#include <BALL/STRUCTURE/geometricTransformations.h>

Inheritance diagram for BALL::TranslationProcessor:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 TranslationProcessor ()
 TranslationProcessor (const Vector3 &translation)
void setTranslation (const Vector3 &translation)
const Vector3getTranslation () const
virtual Processor::Result operator() (Atom &atom)
 Applicator method.

Private Attributes

Vector3 translation_

Detailed Description

Translation processor. This processor executes a translation on each atom of a given Composite object. The translation may be given in the constructor, or by calling setTranslation. Applying the processor to a given Composite object will add the given translation vector to the coordinates of each Atom object (and derived classes).

Definition at line 41 of file geometricTransformations.h.


Constructor & Destructor Documentation

BALL::TranslationProcessor::TranslationProcessor (  ) 

Default constructor. The translation applicator object is initialized and the transformation is set to (0, 0, 0).

BALL::TranslationProcessor::TranslationProcessor ( const Vector3 translation  ) 

Constructor. Creates a new instance of a TranslationProcessor and sets the translation vector.

Parameters:
translation the new translation vector

Member Function Documentation

const Vector3& BALL::TranslationProcessor::getTranslation (  )  const

Returns the translation vector.

Returns:
the current translation vector
virtual Processor::Result BALL::TranslationProcessor::operator() ( Atom atom  )  [virtual]

Applicator method.

Reimplemented from BALL::UnaryProcessor< Atom >.

void BALL::TranslationProcessor::setTranslation ( const Vector3 translation  ) 

Sets a new translation.

Parameters:
translation the new translation vector

Member Data Documentation

Definition at line 75 of file geometricTransformations.h.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines
Generated by  doxygen 1.6.3