File: forceModel.h

package info (click to toggle)
ball 1.4.3~beta1-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 318,984 kB
  • sloc: cpp: 346,579; ansic: 4,097; python: 2,664; yacc: 1,778; lex: 1,099; xml: 964; sh: 688; sql: 316; awk: 118; makefile: 108
file content (108 lines) | stat: -rw-r--r-- 2,495 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: forceModel.h,v 1.5.18.1 2007/03/25 21:26:06 oliver Exp $
//

#ifndef BALL_VIEW_MODELS_FORCEMODEL_H
#define BALL_VIEW_MODELS_FORCEMODEL_H

#ifndef BALL_VIEW_MODELS_MODELPROCESSOR_H
# include <BALL/VIEW/MODELS/modelProcessor.h>
#endif

namespace BALL
{
	namespace VIEW
	{

		/** 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.
				\ingroup  ViewModels
		*/
		class BALL_VIEW_EXPORT ForceModel: public ModelProcessor
		{
			public:

			BALL_CREATE(ForceModel)

			/**	@name	Constructors and Destructors
			*/	
			//@{

			/** Default Constructor.
			*/
			ForceModel();

			/** Copy constructor.
			*/
			ForceModel(const ForceModel& add_line_model);

			/** Destructor.
			*/
			virtual ~ForceModel();

			///
			void setScaling(float value)
				{ scaling_ = value;}

			///
			void setMaxLength(float value)
				{ max_length_ = value;}

			///
			float getScaling() const
				{ return scaling_;}

			///
			float getMaxLength() const
				{ return max_length_;}

			///
			void setBaseSize(float size) { base_size_ = size;}

			///
			float getBaseSize() const { return base_size_;}

			///
			void setOffset(float off) { offset_ = off;}

			///
			float getOffset() const { return offset_;}

			//@} 
			/**	@name Processor specific methods 
			*/ 
			//@{

			/**	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_().
					\param  composite the Composite object that will be processed
					\return Processor::Result the result 
					@exception OutOfMemory thrown if the memory allocation for a Point object failed
			*/
			virtual Processor::Result operator() (Composite& composite);
						
			//@}

			protected:

			float scaling_;
			float max_length_;
			float base_size_;
			float offset_;
		};

	} // namespace VIEW
} // namspace BALL

#endif // BALL_VIEW_MODELS_FORCEMODEL_H