BALL::TranslationProcessor Class Reference

#include <BALL/STRUCTURE/geometricTransformations.h>

Inheritance diagram for BALL::TranslationProcessor:

Public Member Functions
	TranslationProcessor ()
	TranslationProcessor (const Vector3 &translation)
void	setTranslation (const Vector3 &translation)
const Vector3 &	getTranslation () const
virtual Processor::Result	operator() (Atom &atom)
	Applicator method. More...
Public Member Functions inherited from BALL::UnaryProcessor< Atom >
	UnaryProcessor ()
	UnaryProcessor (const UnaryProcessor &)
virtual	~UnaryProcessor ()
virtual bool	start ()
virtual bool	finish ()

Additional Inherited Members
Public Types inherited from BALL::UnaryFunctor< Atom, Processor::Result >
typedef Processor::Result	result_type
typedef Atom	argument_type
typedef Atom &	argument_reference
typedef const Atom &	const_argument_reference
typedef Atom *	argument_pointer
typedef const Atom *	const_argument_pointer

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