Changeset 8493 for code/branches/dockingsystem2/src/modules/docking

Timestamp:

May 16, 2011, 6:21:05 PM (14 years ago)

Author:

sven

Message:

Added docking animations, skeletton for DockingController..

Location:

code/branches/dockingsystem2/src/modules/docking

Files:

• CMakeLists.txt (modified) (1 diff)
• Dock.cc (modified) (10 diffs)
• Dock.h (modified) (3 diffs)
• DockToShip.cc (modified) (2 diffs)
• DockToShip.h (modified) (1 diff)
• DockingAnimation.cc (added)
• DockingAnimation.h (added)
• DockingController.cc (added)
• DockingController.h (added)
• DockingEffect.cc (modified) (2 diffs)
• DockingEffect.h (modified) (2 diffs)
• DockingPrereqs.h (modified) (1 diff)
• MoveToDockingTarget.cc (added)
• MoveToDockingTarget.h (added)

code/branches/dockingsystem2/src/modules/docking/CMakeLists.txt

@@ -2 +2 @@
   DockingTarget.cc
   DockingEffect.cc
+  DockingAnimation.cc
   DockToShip.cc
+  MoveToDockingTarget.cc
+  DockingController.cc
   Dock.cc
 )

code/branches/dockingsystem2/src/modules/docking/Dock.cc

@@ -57 +57 @@
     {
         RegisterObject(Dock);
-        COUT(0) << "Registering dock..." << std::endl;
     }
 
@@ -70 +69 @@
 
         XMLPortObject(Dock, DockingEffect, "effects", addEffect, getEffect, xmlelement, mode);
+        XMLPortObject(Dock, DockingAnimation, "animations", addAnimation, getAnimation, xmlelement, mode);
         XMLPortEventSink(Dock, BaseObject, "execute", execute, xmlelement, mode);
-
-        COUT(0) << "Dock created.." << std::endl;
     }
 
@@ -96 +94 @@
             }
             pawn = pTrigger->getTriggeringPlayer();
-        } else {
+        }
+        else
+        {
             COUT(2) << "Docking::execute Not a player trigger, can't extract pawn from it.." << std::endl;
             return false;
@@ -110 +110 @@
         if(player == NULL)
         {
-            COUT(2) << "The PlayerInfo* is NULL." << std::endl;
-            return false;
-        }
-
-        COUT(0) << "Dock triggered by player: " << player->getName() << ".." << std::endl;
+            COUT(2) << "Docking::execute The PlayerInfo* is NULL." << std::endl;
+            return false;
+        }
 
         if(bTriggered)
@@ -123 +121 @@
             // Show docking dialog
             GUIManager::showGUI("DockingDialog");
-            //DockingEffect::invokeEffect(docking::DOCKING, player, effects_);
         }
         else
@@ -129 +126 @@
             // Remove player from candidates list
             candidates.erase(player);
-
-            //DockingEffect::invokeEffect(docking::RELEASE, player, effects_);
         }
 
@@ -163 +158 @@
         if(candidates.find(player) == candidates.end())
         {
-            COUT(0) << "Player is not a candidate!" << std::endl;
-            return false;
-        }
-
-        // Remove player from candidates, add to docked players and invoke docking effect
+            COUT(0) << "Dock::dock Player is not a candidate!" << std::endl;
+            return false;
+        }
+
         candidates.erase(player);
         docked.insert(player);
-        DockingEffect::invokeEffect(docking::ATTACH, player, effects);
+
+        if (animations.empty())
+            return dockingAnimationFinished(player);
+        else
+            DockingAnimation::invokeAnimation(true, player, animations);
+
+        return true;
+    }
+
+    bool Dock::dockingAnimationFinished(PlayerInfo* player)
+    {
+        if(docked.find(player) == docked.end())
+        {
+            COUT(0) << "Dock::dockingAnimationFinished Player is not currently docked." << std::endl;
+            return false;
+        }
+
+        DockingEffect::invokeEffect(true, player, effects);
         return true;
     }
@@ -179 +190 @@
         if(docked.find(player) == docked.end())
         {
-            COUT(0) << "Player is not docked to this Dock." << std::endl;
-            return false;
-        }
-
-        // Remove player from docked, add to candidates and reverse DockingEffect 
+            COUT(0) << "Dock::undock Player is not docked to this Dock." << std::endl;
+            return false;
+        }
+
         docked.erase(player);
         candidates.insert(player);
-        DockingEffect::invokeEffect(docking::RELEASE, player, effects);
+
+        DockingEffect::invokeEffect(false, player, effects);
+
+        if (animations.empty())
+            return undockingAnimationFinished(player);
+        else
+            DockingAnimation::invokeAnimation(false, player, animations);
+
+        return true;
+    }
+
+    bool Dock::undockingAnimationFinished(PlayerInfo* player) {
+        COUT(0) << "Dock::undockingAnimationFinished executed" << std::endl;
         return true;
     }
@@ -226 +248 @@
     }
 
-    const DockingEffect* Dock::getEffect(unsigned int index) const
-    {
-        int i = index;
+    const DockingEffect* Dock::getEffect(unsigned int i) const
+    {
         for (std::list<DockingEffect*>::const_iterator effect = this->effects.begin(); effect != this->effects.end(); ++effect)
         {
@@ -237 +258 @@
         return NULL;
     }
+
+    bool Dock::addAnimation(DockingAnimation* animation)
+    {
+        assert(animation);
+        animation->setParent(this);
+        animations.push_back(animation);
+        return true;
+    }
+
+    const DockingAnimation* Dock::getAnimation(unsigned int i) const
+    {
+        for (std::list<DockingAnimation*>::const_iterator animation = this->animations.begin(); animation != this->animations.end(); ++animation)
+        {
+            if(i == 0)
+               return *animation;
+            i--;
+        }
+        return NULL;
+    }
 }

code/branches/dockingsystem2/src/modules/docking/Dock.h

@@ -46 +46 @@
 
 #include "DockingEffect.h"
+#include "DockingAnimation.h"
 #include "DockingPrereqs.h"
 
@@ -58 +59 @@
         virtual ~Dock();
 
+        // Trigger interface
+        bool execute(bool bTriggered, BaseObject* trigger);
+
+        // XML interface
         virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
         virtual void XMLEventPort(Element& xmlelement, XMLPort::Mode mode);
 
-        bool execute(bool bTriggered, BaseObject* trigger);
-
+        // XML functions
         bool addEffect(DockingEffect* effect); //!< Add a DockingEffect to the Dock.
         const DockingEffect* getEffect(unsigned int index) const; //!< Get the DockingEffect at a given index.
+        bool addAnimation(DockingAnimation* animation); //!< Add a DockingAnimation to the Dock.
+        const DockingAnimation* getAnimation(unsigned int index) const; //!< Get the DockingAnimation at a given index.
 
+        // Docking/undocking logic, checks conditions and invokes the DockingAnimations
         bool dock(PlayerInfo* player); //!< Returns true if given player docked successfully (player must be a candidate)
         bool undock(PlayerInfo* player); //!< Undocks a player (player must be docked)
 
+        // Animation logic
+        bool dockingAnimationFinished(PlayerInfo* player); //!< Called when a docking animation finished
+        bool undockingAnimationFinished(PlayerInfo* player); //!< Called when a undocking animation finished
+
+        // LUA interface
         void dock() { this->dock(HumanController::getLocalControllerSingleton()->getPlayer()); } // tolua_export
         static unsigned int getNumberOfActiveDocks(); // tolua_export
         static Dock* getActiveDockAtIndex(unsigned int index); // tolua_export
 
+        // Console commands
         static void cmdDock();
         static void cmdUndock();
@@ -79 +92 @@
         std::set<PlayerInfo*> candidates; //!< A set of all players which are allowed to dock using the console command.
         std::set<PlayerInfo*> docked; //!< A set of all docked players
+
         std::list<DockingEffect*> effects; //!< The list of DockingEffects to be executed when a player docks.
+        std::list<DockingAnimation*> animations; //!< The list of DockingAnimations to be executed before a player docks
     }; // tolua_export
 } // tolua_export

code/branches/dockingsystem2/src/modules/docking/DockToShip.cc

@@ -21 +21 @@
  *
  *   Author:
- *      Damian 'Mozork' Frick
+ *      Sven Stucki
  *   Co-authors:
  *      ...
@@ -69 +69 @@
     bool DockToShip::docking(PlayerInfo* player)
     {
-        COUT(0) << "DockToShip::docking" << endl;
-        return true;
-    }
-
-    bool DockToShip::attach(PlayerInfo* player)
-    {
         COUT(0) << "DockToShip::attach" << endl;
 

code/branches/dockingsystem2/src/modules/docking/DockToShip.h

@@ -61 +61 @@
 
             virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
-            virtual void setTargetId(std::string str);
-            virtual std::string getTargetId();
+            void setTargetId(std::string str);
+            std::string getTargetId();
 
             virtual bool docking(PlayerInfo* player); //!< Called when docking starts
-            virtual bool attach(PlayerInfo* player); //!< Called after docking animation
             virtual bool release(PlayerInfo* player); //!< Called when player wants undock
-
         private:
             std::string target;

code/branches/dockingsystem2/src/modules/docking/DockingEffect.cc

@@ -21 +21 @@
  *
  *   Author:
- *      Damian 'Mozork' Frick
+ *      Sven Stucki
  *   Co-authors:
  *      ...
@@ -46 +46 @@
     }
 
-    bool DockingEffect::invokeEffect(docking::event event, PlayerInfo* player, std::list<DockingEffect*> & effects)
+    bool DockingEffect::invokeEffect(bool dock, PlayerInfo* player, std::list<DockingEffect*> & effects)
     {
         bool check = true;
 
-        COUT(4) << "Invoking DockingEffects on player: " << player << " ."  << std::endl;
-
         for (std::list<DockingEffect*>::iterator effect = effects.begin(); effect != effects.end(); effect++)
         {
-            switch(event)
-            {
-                case docking::DOCKING:
-                    check &= (*effect)->docking(player);
-                    break;
-                case docking::RELEASE:
-                    check &= (*effect)->release(player);
-                    break;
-                default:
-                    assert(0);
-            }
+            if (dock)
+                check &= (*effect)->docking(player);
+            else
+                check &= (*effect)->release(player);
         }
 

code/branches/dockingsystem2/src/modules/docking/DockingEffect.h

@@ -49 +49 @@
 namespace orxonox
 {
-    namespace docking {
-        enum event {
-            DOCKING,
-            RELEASE
-        };
-    }
 
     /**
@@ -74 +68 @@
             virtual bool release(PlayerInfo* player) = 0; //!< Called when player wants to undock
 
-            static bool invokeEffect(docking::event event, PlayerInfo* player, std::list<DockingEffect*> & effects); //!< Invokes the event specific method of all DockingEffects in the list
+            static bool invokeEffect(bool dock, PlayerInfo* player, std::list<DockingEffect*> & effects); //!< Invokes the event specific method of all DockingEffects in the list
             static DockingTarget *findTarget(std::string name); //!< Iterates through all DockingTarget objects to find the one with name=target
     };

code/branches/dockingsystem2/src/modules/docking/DockingPrereqs.h

@@ -66 +66 @@
 {
     class Dock;
+    class DockingAnimation;
     class DockingTarget;
     class DockingEffect;
     class DockToShip;
+    class MoveToDockingTarget;
 }