Last change
on this file since 5452 was
5405,
checked in by bensch, 19 years ago
|
orxonox/trunk: renamed definition to the right term declaration…
|
File size:
1.5 KB
|
Rev | Line | |
---|
[4728] | 1 | /* |
---|
[4179] | 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 | |
---|
[4728] | 16 | /*! |
---|
[5039] | 17 | * @file field.h |
---|
[4836] | 18 | * abstract definition of a Physical Field |
---|
[3329] | 19 | |
---|
[4728] | 20 | This is a totally abstract class, that only enables different Physical Fields to |
---|
[4179] | 21 | exist on a common Level. |
---|
[3245] | 22 | */ |
---|
[1853] | 23 | |
---|
[4179] | 24 | #ifndef _FIELD_H |
---|
| 25 | #define _FIELD_H |
---|
[1853] | 26 | |
---|
[4179] | 27 | #include "p_node.h" |
---|
[1853] | 28 | |
---|
[5405] | 29 | // FORWARD DECLARATION |
---|
[4728] | 30 | class TiXmlElement; |
---|
[3543] | 31 | |
---|
| 32 | |
---|
[4179] | 33 | //! An abstract class that represents a Force. |
---|
[4728] | 34 | class Field : public PNode |
---|
[4179] | 35 | { |
---|
[1904] | 36 | public: |
---|
[4179] | 37 | Field(); |
---|
| 38 | virtual ~Field(); |
---|
[1853] | 39 | |
---|
[4746] | 40 | void init(); |
---|
[4728] | 41 | void loadParams(const TiXmlElement* root); |
---|
| 42 | |
---|
| 43 | /** |
---|
[4836] | 44 | * @param data This is the data given to this force, to calculate the ForceVector |
---|
| 45 | * @returns The Force Vector |
---|
[4179] | 46 | */ |
---|
[4395] | 47 | virtual Vector calcForce(const Vector& data) const = 0; |
---|
[3245] | 48 | |
---|
[4728] | 49 | void setMagnitude(float magnitude); |
---|
[4836] | 50 | /** @returns The Magnitude of the Field */ |
---|
[4746] | 51 | inline const float& getMagnitude() const {return this->magnitude;} |
---|
[4179] | 52 | |
---|
[4728] | 53 | void setAttenuation(float attenuation); |
---|
[4836] | 54 | /** @returns The Attenuation of the Fiels */ |
---|
[4746] | 55 | inline const float& getAttenuation() const {return this->attenuation;} |
---|
[4179] | 56 | |
---|
[3245] | 57 | private: |
---|
[4179] | 58 | float magnitude; //!< The strength of the field |
---|
| 59 | float attenuation; //!< The Attenuation (the bigger the shorter the influenced distance). |
---|
[1853] | 60 | }; |
---|
| 61 | |
---|
[4179] | 62 | #endif /* _FIELD_H */ |
---|
Note: See
TracBrowser
for help on using the repository browser.