source:
orxonox.OLD/branches/spaceshipcontrol/src/lib/physics/fields/field.h
@
6782
Last change on this file since 6782 was 6512, checked in by bensch, 19 years ago | |
---|---|
File size: 1.5 KB |
Line | |
---|---|
1 | /* |
2 | orxonox - the future of 3D-vertical-scrollers |
3 | |
4 | Copyright (C) 2004 orx |
5 | |
6 | This program is free software; you can redistribute it and/or modify |
7 | it under the terms of the GNU General Public License as published by |
8 | the Free Software Foundation; either version 2, or (at your option) |
9 | any later version. |
10 | |
11 | ### File Specific: |
12 | main-programmer: Benjamin Grauer |
13 | co-programmer: ... |
14 | */ |
15 | |
16 | /*! |
17 | * @file field.h |
18 | * abstract definition of a Physical Field |
19 | |
20 | This is a totally abstract class, that only enables different Physical Fields to |
21 | exist on a common Level. |
22 | */ |
23 | |
24 | #ifndef _FIELD_H |
25 | #define _FIELD_H |
26 | |
27 | #include "p_node.h" |
28 | |
29 | // FORWARD DECLARATION |
30 | class TiXmlElement; |
31 | |
32 | |
33 | //! An abstract class that represents a Force. |
34 | class Field : public PNode |
35 | { |
36 | public: |
37 | Field(); |
38 | virtual ~Field(); |
39 | |
40 | void init(); |
41 | virtual void loadParams(const TiXmlElement* root); |
42 | |
43 | /** |
44 | * @param data This is the data given to this force, to calculate the ForceVector |
45 | * @returns The Force Vector |
46 | */ |
47 | virtual Vector calcForce(const Vector& data) const = 0; |
48 | |
49 | void setMagnitude(float magnitude); |
50 | /** @returns The Magnitude of the Field */ |
51 | inline const float& getMagnitude() const {return this->magnitude;} |
52 | |
53 | void setAttenuation(float attenuation); |
54 | /** @returns The Attenuation of the Fiels */ |
55 | inline const float& getAttenuation() const {return this->attenuation;} |
56 | |
57 | private: |
58 | float magnitude; //!< The strength of the field |
59 | float attenuation; //!< The Attenuation (the bigger the shorter the influenced distance). |
60 | }; |
61 | |
62 | #endif /* _FIELD_H */ |
Note: See TracBrowser
for help on using the repository browser.