BALL::VIEW::ForceModel Class Reference
[Model Processors]

#include <BALL/VIEW/MODELS/forceModel.h>

Inheritance diagram for BALL::VIEW::ForceModel:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Constructors and Destructors

 ForceModel ()
 ForceModel (const ForceModel &add_line_model)
virtual ~ForceModel ()
void setScaling (float value)
void setMaxLength (float value)
float getScaling () const
float getMaxLength () const
void setBaseSize (float size)
float getBaseSize () const
void setOffset (float off)
float getOffset () const
Processor specific methods

virtual Processor::Result operator() (Composite &composite)

Protected Attributes

float scaling_
float max_length_
float base_size_
float offset_

Detailed Description

ForceModel class. The class ForceModel is a model processor that is responsible for creating a model for forces on atoms. For information about the processor concept see Processor.

Definition at line 25 of file forceModel.h.


Constructor & Destructor Documentation

BALL::VIEW::ForceModel::ForceModel (  ) 

Default Constructor.

BALL::VIEW::ForceModel::ForceModel ( const ForceModel add_line_model  ) 

Copy constructor.

virtual BALL::VIEW::ForceModel::~ForceModel (  )  [virtual]

Destructor.


Member Function Documentation

float BALL::VIEW::ForceModel::getBaseSize (  )  const [inline]

Definition at line 67 of file forceModel.h.

float BALL::VIEW::ForceModel::getMaxLength (  )  const [inline]

Definition at line 60 of file forceModel.h.

float BALL::VIEW::ForceModel::getOffset (  )  const [inline]

Definition at line 73 of file forceModel.h.

float BALL::VIEW::ForceModel::getScaling (  )  const [inline]

Definition at line 56 of file forceModel.h.

virtual Processor::Result BALL::VIEW::ForceModel::operator() ( Composite composite  )  [virtual]

Operator method. This method iterates over each Composite object reachable in the tree. If the composite is of kind Atom than a Point is created for that atom, and it inserted with the method insertAtom_(). The color for that Point object is calculated with the ColorCalculator object retrieved with the method getColorCalculator(). All atoms inserted with the method insertAtom_() will later used for creating the model of the reachable Bond objects. Those models will be created with the method buildBondModels_().

Parameters:
composite the Composite object that will be processed
Returns:
Processor::Result the result
Exceptions:
OutOfMemory thrown if the memory allocation for a Point object failed

Reimplemented from BALL::UnaryProcessor< Composite >.

void BALL::VIEW::ForceModel::setBaseSize ( float  size  )  [inline]

Definition at line 64 of file forceModel.h.

void BALL::VIEW::ForceModel::setMaxLength ( float  value  )  [inline]

Definition at line 52 of file forceModel.h.

void BALL::VIEW::ForceModel::setOffset ( float  off  )  [inline]

Definition at line 70 of file forceModel.h.

void BALL::VIEW::ForceModel::setScaling ( float  value  )  [inline]

Definition at line 48 of file forceModel.h.


Member Data Documentation

Definition at line 101 of file forceModel.h.

Definition at line 100 of file forceModel.h.

Definition at line 102 of file forceModel.h.

Definition at line 99 of file forceModel.h.

Generated by  doxygen 1.6.3