[Orxonox-commit 4236] r8907 - code/branches/gamecontent/src/orxonox/interfaces

[jo at orxonox.net]

Author: jo
Date: 2011-10-26 16:22:52 +0200 (Wed, 26 Oct 2011)
New Revision: 8907

Added:
   code/branches/gamecontent/src/orxonox/interfaces/PartyMember.h
Log:
Started to create an interface to make objects belong to a group.

Added: code/branches/gamecontent/src/orxonox/interfaces/PartyMember.h
===================================================================
--- code/branches/gamecontent/src/orxonox/interfaces/PartyMember.h	                        (rev 0)
+++ code/branches/gamecontent/src/orxonox/interfaces/PartyMember.h	2011-10-26 14:22:52 UTC (rev 8907)
@@ -0,0 +1,79 @@
+/*
+ *   ORXONOX - the hottest 3D action shooter ever to exist
+ *                    > www.orxonox.net <
+ *
+ *
+ *   License notice:
+ *
+ *   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
+ *   of the License, or (at your option) any later version.
+ *
+ *   This program is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *   GNU General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with this program; if not, write to the Free Software
+ *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ *   Author:
+ *      Damian 'Mozork' Frick
+ *   Co-authors:
+ *      ...
+ *
+ */
+
+/**
+    @file
+    @brief Definition of the PartyMember class.
+*/
+
+#ifndef _PartyMember_H__
+#define _PartyMember_H__
+
+#include "OrxonoxPrereqs.h"
+#include "core/OrxonoxClass.h"
+
+namespace orxonox
+{
+    /**
+    @brief
+        PartyMember is an Interface, that can be implemented by any object to enable it to belong to a certain group. (friend, foe, neutral, ...)
+
+        It just needs to inherit form PartyMember, and implement the  methods.
+    @author
+        Damian 'Mozork' Frick
+    */
+    class _OrxonoxExport PartyMember : virtual public OrxonoxClass
+    {
+        public:
+            PartyMember();
+            virtual ~PartyMember() {}
+
+            /**
+            @brief
+                Method to transcribe a PartyMember object to the player.
+                Must be implemented by every class inheriting from PartyMember.
+            @param team
+                
+            @return
+                
+            */
+
+            inline void setTeam(int team)
+                { this->team_ = team; }
+            inline int getTeam() const
+                { return this->team_; }
+
+        protected:
+            int team_; //<! Teamnumber: to identify to which group a PartyMember belongs to
+                       //<! Default value: -1 : neutral the meaning of other values is defined in the context
+
+
+    };
+}
+
+#endif /* _PartyMember_H__ */