Changeset 4179 in orxonox.OLD for orxonox/branches/physics/src/util/physics/field.h

Timestamp:

May 13, 2005, 11:39:44 PM (19 years ago)

Author:

bensch

Message:

orxonox/branches/physics: definition of the ground-class: field

File:

• orxonox/branches/physics/src/util/physics/field.h (copied) (copied from orxonox/branches/physics/src/proto/proto_class.h) (2 diffs)

orxonox/branches/physics/src/util/physics/field.h

@@ -1 @@
-/*! 
-    \file proto_class.h
-    \brief Definition of ...
+/* 
+   orxonox - the future of 3D-vertical-scrollers
 
+   Copyright (C) 2004 orx
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2, or (at your option)
+   any later version.
+
+   ### File Specific:
+   main-programmer: Benjamin Grauer
+   co-programmer: ...
 */
 
-#ifndef _PROTO_CLASS_H
-#define _PROTO_CLASS_H
+/*! 
+    \file field.h
+    \brief abstract definition of a Physical Field
 
-#include "base_object.h"
+    This is a totally abstract class, that only enables different Physical Fields to 
+    exist on a common Level.
+*/
+
+#ifndef _FIELD_H
+#define _FIELD_H
+
+#include "p_node.h"
 
 // FORWARD DEFINITION
@@ -14 +31 @@
 
 
-//! A class for ...
-class ProtoClass : public BaseObject {
+//! An abstract class that represents a Force.
+class Field : public PNode 
+{
+ public:
+  Field();
+  virtual ~Field();
 
- public:
-  ProtoClass();
-  virtual ~ProtoClass();
+  /** 
+      \param data This is the data given to this force, to calculate the ForceVector
+      \returns The Force Vector
+  */
+  virtual Vector& calcForce(Vector& data) = 0;
 
+  void setMagnitude(const float& magnitude);
+  /** \returns The Magnitude of the Field */
+  const float& getMagnitude(void) const {return this->magnitude;}
+
+  void setAttenuation(const float& attenuation);
+  /** \returns The Attenuation of the Fiels */
+  const float& getAttenuation(void) const {return this->attenuation;}
 
  private:
-
+  float magnitude;                //!< The strength of the field
+  float attenuation;              //!< The Attenuation (the bigger the shorter the influenced distance).
 };
 
-#endif /* _PROTO_CLASS_H */
+#endif /* _FIELD_H */