Changeset 8404 for code/branches/spaceboundaries/src/orxonox/worldentities/SpaceBoundaries.h

Timestamp:

May 5, 2011, 4:14:07 PM (14 years ago)

Author:

kmaurus

Message:

some adaptations and improvements

File:

• code/branches/spaceboundaries/src/orxonox/worldentities/SpaceBoundaries.h (modified) (8 diffs)

code/branches/spaceboundaries/src/orxonox/worldentities/SpaceBoundaries.h

@@ -27 +27 @@
  */
  
- /* TODO:   - Sobald Bots im Spiel sind, stürzt das Programm relativ bald ab!!!
- */
- 
- 
- /* REALISIERUNGSIDEEN:
-   
-    Mehrere Instanzen:
-        Im Konstruktor schauen, wer innerhalb der eigenen Grenzen ist und diese in eine Liste geben, die in jeder tick-Funktion
-        durchgearbeitet wird.
-        Moeglichkeit bereitstellen, ein Pawn durch ein Portal einer anderen Instanz von SpaceBoundaries zuzuweisen.
-        Schauen, wie es zu handhaben ist, wenn ein neuer Spieler oder Bot nachtraeglich ins Spiel kommt.
- 
+ /* TODO:   - Textmessages und Billboards sollen teils nur bei einem humanPlayer angezeigt werden, nicht bei allen (vgl. Netzwerk-Spiel mit mehreren humanPlayers)
+                beachte hierzu folgende statische Funktion: 'static unsigned int  Host::getPlayerID()'
+                (file:///home/kmaurus/orxonox/spaceBoundaries/build/doc/api/html/classorxonox_1_1_host.html#9c1e3b39e3b42e467dfbf42902911ce2)
+                
+            - Kommentieren (Betrachte als Beispiel/Vorbild 'libraries/core/WeakPtr.h')
+            
+            - Wiki-SpaceBoundaries-Eintrag aktualisieren
  */
 
@@ -44 +39 @@
 #define _SpaceBoundaries_H__
 
-/* Einige, spezifische include-Statements */
+
 #include "core/CoreIncludes.h"
+#include "core/WeakPtr.h"
 #include "tools/interfaces/Tickable.h"
 #include "interfaces/RadarViewable.h"
@@ -56 +52 @@
 #include <vector>
 
+namespace orxonox
+{
+
 /**
-@brief SpaceBoundaries gives level creators the possibility to bar Pawns from leaving a defined area.
+@brief SpaceBoundaries gives level creators the possibility to bar Pawns from leaving a defined area (until now this area is a ball).
 
        Five attributes can/should be defined in the XML-File:
-       - 'position' : absolute position of the SpaceBoundaries class. 'warnDistance' and 'maxDistance' refer to this 'position'.
        - 'warnDistance' : If the distance between the pawn of the human player and 'position' is bigger than 'warnDistance', a message is displayed to
                           inform the player that he'll soon be leaving the allowed area. 
        - 'maxDistance' : defines the area, where a pawn is allowed to be (radius of a ball).
        - 'showDistance' : If the distance between the pawn and the boundary of the allowed area is smaller than 'showDistance', the boundary is shown. 
-       - 'healthDecrease' : a measure to define how fast the health of a pawn should decrease after leaving the allowed area.
-                            Empfohlene Werte: 0.1 (langsame Health-Verminderung) bis 5 (sehr schnelle Health-Verminderung)
+       - 'healthDecrease' : a measure to define how fast the health of a pawn should decrease after leaving the allowed area (unnecessary if 'reactionMode' == 0).
+                            Recommended values: 0.1 (slow health decrease) to 5 (very fast health decrease)
+       - 'reactionMode' : Integer-Value. Defines what effect appears if a space ship has crossed the boundaries.
+                            0: Reflect the space ship (default).
+                            1: Decrease Health of the space ship after having left the allowed area.
 */
 
-namespace orxonox
-{
     class _OrxonoxExport SpaceBoundaries : public StaticEntity, public Tickable
     {
@@ -79 +78 @@
             void checkWhoIsIn(); //!< Update the list 'pawnsIn_'.
             
-            void positionBillboard(const Vector3 position);
+            void positionBillboard(const Vector3 position); //!< Display a Billboard at the position 'position'.
             void setBillboardOptions(Billboard *billy);
-            void removeAllBillboards();
+            void removeAllBillboards(); //!< Hide all all elements of '*billboard_' and set their attribute 'usedYet' to 0.
             
             void setMaxDistance(float r);
@@ -94 +93 @@
             void setHealthDecrease(float amount);
             float getHealthDecrease();
+            
+            void setReaction(int mode);
+            int getReaction();
 
             void XMLPort(Element& xmlelement, XMLPort::Mode mode);
@@ -102 +104 @@
             struct billboardAdministration{ bool usedYet; Billboard* billy; };
             
-            std::list<Pawn*> pawnsIn_; //!< List of the pawns that this instance of SpaceBoundaries has to handle.
+            std::list<WeakPtr<Pawn> > pawnsIn_; //!< List of the pawns that this instance of SpaceBoundaries has to handle.
             
             std::vector<billboardAdministration> billboards_;
         
+            int reaction_; //!< Werte: 0, 1. 0: Reflektion an Boundaries (Standard). 1: Health-Abzug-Modus.
             float maxDistance_; //!< maximal zulaessige Entfernung von 'this->getPosition()'.
             float warnDistance_; //!< Entfernung von 'this->getPosition()', ab der eine Warnung angezeigt wird, dass man bald das zulaessige Areal verlaesst.
@@ -113 +116 @@
                                    //!< Empfohlene Werte: 0.1 (langsame Health-Verminderung) bis 5 (sehr schnelle Health-Verminderung)
             
-            Billboard *boundary_;
-            
             RadarViewable* centerRadar_; //!< Repraesentation von SpaceBoundaries auf dem Radar.
         
@@ -120 +121 @@
             void displayWarning(const std::string warnText);
             void displayBoundaries(Pawn *item);
-            void bounceBack(Pawn *item);
+            void conditionalBounceBack(Pawn *item, float currentDistance, float dt);
             bool isHumanPlayer(Pawn *item);