Changeset 7625

Timestamp:

Nov 6, 2010, 8:17:20 PM (13 years ago)

Author:

dafrick

Message:

Introducing LevelInfo class, which can be used to specify things about a Level and which is used to provide more flexibility in displaying a list of levels.
Basic functionality works, now all that needs to be dones is to exploit the new functionality.

Location:

code/branches/releasetodo

Files:

• data/gui/scripts/SingleplayerMenu.lua (modified) (1 diff)
• data/levels/empty_level.oxw (modified) (1 diff)
• data/levels/notifications.oxw (modified) (2 diffs)
• src/orxonox/LevelInfo.cc (deleted)
• src/orxonox/LevelInfo.h (modified) (2 diffs)
• src/orxonox/LevelManager.cc (modified) (3 diffs)
• src/orxonox/LevelManager.h (modified) (3 diffs)
• src/orxonox/OrxonoxPrereqs.h (modified) (1 diff)

code/branches/releasetodo/data/gui/scripts/SingleplayerMenu.lua

@@ -6 +6 @@
     listbox = winMgr:getWindow("orxonox/SingleplayerLevelListbox")
     preselect = orxonox.LevelManager:getInstance():getDefaultLevel()
-    orxonox.LevelManager:getInstance():compileAvailableLevelList()
+    size = orxonox.LevelManager:getInstance():getNumberOfLevels()
     local levelList = {}
     local index = 0
     local level = ""
-    while true do
+    while index < size do
       level = orxonox.LevelManager:getInstance():getAvailableLevelListItem(index)
-      if level == "" then
-        break
-      end
       table.insert(levelList, level)
       index = index + 1

code/branches/releasetodo/data/levels/empty_level.oxw

@@ +1 @@
+<LevelInfo
+ name = "Empty level"
+ description = "A level with absolutely nothing in it."
+ tags = "test, empty"
+/>
+
 <?lua
   include("stats.oxo")

code/branches/releasetodo/data/levels/notifications.oxw

@@ +1 @@
+<LevelInfo
+ name = "Notifications showcase"
+ description = "Level to test and showcase notifications."
+ tags = "test, showcase, notifications"
+/>
+
 <?lua
   include("hudtemplates3.oxo")
@@ -5 +11 @@
   include("templates/lodinformation.oxt")
 ?>
-
-<LevelInfo
- name = "Notifications showcase"
- description = "Level to test and showcase notifications."
- tags = "test, showcase, notifications"
-/>
 
 <Level

code/branches/releasetodo/src/orxonox/LevelInfo.h

@@ -27 +27 @@
  */
 
+/**
+    @file LevelInfo.h
+    @brief Definition of the LevelInfo and LevelInfoItem class.
+    @ingroup Orxonox
+*/
+
 #ifndef _LevelInfo_H__
 #define _LevelInfo_H__
@@ -34 +40 @@
 #include <set>
 #include <string>
+
 #include "core/BaseObject.h"
+#include "core/OrxonoxClass.h"
 
-namespace orxonox // tolua_export
-{  // tolua_export
-    class _OrxonoxExport LevelInfo  // tolua_export
-        : public BaseObject
-    { // tolua_export
-    
+namespace orxonox
+{
+
+    /**
+    @brief
+        The LevelInfoItem class stores information regarding a @ref orxonox::Level "Level" and makes that information it accessible trough the @ref orxonox::LevelManager "LevelManager".
+        A LevelInfoItem object is commonly created from a @ref orxonox::LevelInfo "LevelInfo" object, using its <code>copy()</code> method.
+
+    @author
+        Damian 'Mozork' Frick
+    */
+    class _OrxonoxExport LevelInfoItem : virtual public OrxonoxClass
+    {
+        public:
+            LevelInfoItem(); //!< Default constructor.
+            LevelInfoItem(const std::string& name, const std::string filename); //!< Constructor. Initializes the object.
+            virtual ~LevelInfoItem(); //!< Destructor.
+
+            /**
+            @brief Set the name of the Level.
+            @param name The name to be set.
+            */
+            inline void setName(const std::string& name)
+                { this->name_ = std::string(name); }
+            /**
+            @brief Get the name of the Level.
+            @return Returns the name of the Level.
+            */
+            inline const std::string& getName(void)
+                { return this->name_; }
+
+            /**
+            @brief Set the description of the Level.
+            @param description The description to be set.
+            */
+            inline void setDescription(const std::string& description)
+                { this->description_ = std::string(description); }
+            /**
+            @brief Get the description of the Level.
+            @return Returns the description of the Level.
+            */
+            inline const std::string& getDescription() const
+                { return this->description_; }
+
+            void setTags(const std::string& tags); //!< Set the tags the Level is tagged with.
+            bool addTag(const std::string& tag, bool update = true); //!< Add a tag to the set of tags the Level is tagged with.
+            /**
+            @brief Get the lis of the tags the Level is tagged with.
+            @return Returns a comma-seperated string of all the tags the Level is tagged with.
+            */
+            inline const std::string& getTags(void) const
+                { return this->tagsString_; }
+            /**
+            @brief Get whether the Level has a specific tag.
+            @param tag The tag for which is checked.
+            @return Returns true if the Level is tagged with the input tag.
+            */
+            bool hasTag(const std::string& tag) const
+                { return this->tags_.find(tag) != this->tags_.end(); }
+
+            /**
+            @brief Get the XML-filename of the Level.
+            @return Returns the XML-filename (including *.oxw extension) of the Level.
+            */
+            inline const std::string& getXMLFilename(void)
+                { return this->xmlfilename_; }
+
+        protected:
+            /**
+            @brief Set the XML-filename of the Level.
+            @param filename The XML-filename to be set.
+            */
+            inline void setXMLFilename(const std::string& filename)
+                { this->xmlfilename_ = std::string(filename); }
+
+            std::string xmlfilename_; //!< The XML-filename of the Level.
+
+        private:
+            void tagsUpdated(void); //!< Updates the comma-seperated string of all tags, if the set of tags has changed.
+
+            std::string name_; //!< The name of the Level.
+            std::string description_; //!< The description of the Level.
+            std::set<std::string> tags_; //!< The set of tags the Level is tagged with.
+            std::string tagsString_; //!< The comma-seperated string of all the tags the Level is tagged with.
+    };
+
+    /**
+    @brief
+        The LevelInfo class can be used to store information regarding a @ref orxonox::Level "Level" in its level file.
+        The following parameters can be specified:
+        - @b name The name of the level.
+        - @b description The description of the level.
+        - @b tags A comma-seperated string of tags.
+
+        An example would be:
+        @code
+        <LevelInfo
+            name = "Levelname"
+            description = "This is just some awesome level."
+            tags = "test, awesome"
+        />
+        @endcode
+        The LevelInfo is best located at the top of the level file.
+
+    @author
+        Damian 'Mozork' Frick
+    */
+    class _OrxonoxExport LevelInfo : public BaseObject, public LevelInfoItem
+    {
         public:
             LevelInfo(BaseObject* creator);
             virtual ~LevelInfo();
-            
-            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
 
+            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Creates a LevelInfo object through XML.
+
+            /**
+            @brief Set the description of the Level.
+            @param description The description to be set.
+            */
             inline void setDescription(const std::string& description)
-                { this->description_ = description; }
-            inline const std::string& getDescription() const // tolua_export
-                { return this->description_; }
-                
-            void setTags(const std::string& tags);
-            inline bool addTag(const std::string& tag)
-                { bool success = this->tags_.insert(tag).second; if(success) this->tagsUpdated(); return success; }
+                { this->LevelInfoItem::setDescription(description); }
+            /**
+            @brief Get the description of the Level.
+            @return Returns the description of the Level.
+            */
+            inline const std::string& getDescription() const
+                { return this->LevelInfoItem::getDescription(); }
+
+            /**
+            @brief Set the tags the Level is tagged with.
+            @param tags A comma-seperated string of all the tags to be set.
+            */
+            inline void setTags(const std::string& tags)
+                { this->LevelInfoItem::setTags(tags); }
+            /**
+            @brief Get the lis of the tags the Level is tagged with.
+            @return Returns a comma-seperated string of all the tags the Level is tagged with.
+            */
             inline const std::string& getTags(void) const
-                { return this->tagsString_; }
-            bool hasTag(const std::string& tag) { return this->tags_.find(tag) != this->tags_.end(); } // tolua_export
-            
-        private:
-            void tagsUpdated(void);
-        
-            std::string description_;
-            std::set<std::string> tags_;
-            std::string tagsString_;
-            
-    }; // tolua_export
-} // tolua_export
+                { return this->LevelInfoItem::getTags(); }
 
-#endif /* _Level_H__ */
+            LevelInfoItem* copy(void); //!< Copies the contents of this LevelInfo object to a new LevelInfoItem object.
+
+    };
+}
+
+#endif /* _LevelInfo_H__ */

code/branches/releasetodo/src/orxonox/LevelManager.cc

@@ -59 +59 @@
             ModifyConfigValue(defaultLevelName_, tset, CommandLineParser::getValue("level").getString());
         }
+
+        this->compileAvailableLevelList();
     }
 
@@ -128 +130 @@
     }
 
+    unsigned int LevelManager::getNumberOfLevels()
+    {
+        this->updateAvailableLevelList();
+
+        COUT(0) << "Number of Levels: " << this->infos_.size() << std::endl;
+
+        return this->availableLevels_.size();
+    }
+
     const std::string& LevelManager::getAvailableLevelListItem(unsigned int index) const
     {
-        if (index >= availableLevels_.size())
+        if (index >= this->availableLevels_.size())
             return BLANKSTRING;
         else
-            return availableLevels_[index];
+        {
+            std::map<std::string, LevelInfoItem*>::const_iterator it = this->infos_.find(this->availableLevels_[index]);
+            assert(it->second);
+            return it->second->getName();
+        }
     }
 
     void LevelManager::compileAvailableLevelList()
     {
-        this->availableLevels_.clear();
         Ogre::StringVectorPtr levels = Resource::findResourceNames("*.oxw");
+        // Iterate over all *.oxw level files.
         for (Ogre::StringVector::const_iterator it = levels->begin(); it != levels->end(); ++it)
         {
+            //TODO: Replace with tag,
             if (it->find("old/") != 0)
             {
                 size_t pos = it->find(".oxw");
-                COUT(0) << *it << std::endl;
+
+                bool infoExists = false;
+                // Load the LevelInfo object from the level file.
                 XMLFile file = XMLFile(*it);
                 ClassTreeMask mask = ClassTreeMask();
@@ -151 +169 @@
                 mask.include(ClassIdentifier<LevelInfo>::getIdentifier());
                 Loader::load(&file, mask);
-                
+                for(ObjectList<LevelInfo>::iterator item = ObjectList<LevelInfo>::begin(); item != ObjectList<LevelInfo>::end(); ++item)
+                {
+                    LevelInfoItem* info = item->copy();
+                    COUT(0) << "BUUUUUUUUUH: " << info->getName() << " | " << info->getXMLFilename() << " | " << it->substr(0, pos) << std::endl;
+                    if(info->getXMLFilename() == *it)
+                    {
+                        this->infos_.insert(std::pair<std::string, LevelInfoItem*>(it->substr(0, pos),info));
+                        infoExists = true;
+                    }
+                }
+                Loader::unload(&file, mask);
+                if(!infoExists)
+                {
+                    this->infos_.insert(std::pair<std::string, LevelInfoItem*>(it->substr(0, pos), new LevelInfoItem(it->substr(0, pos), *it)));
+                }
+
                 this->availableLevels_.push_back(it->substr(0, pos));
             }
         }
+    }
 
+    void LevelManager::updateAvailableLevelList(void)
+    {
+        //TODO: Implement some kind of update?
     }
 }

code/branches/releasetodo/src/orxonox/LevelManager.h

@@ -34 +34 @@
 #include <cassert>
 #include <list>
+#include <map>
 #include <string>
 
@@ -59 +60 @@
             void setDefaultLevel(const std::string& levelName); //tolua_export
             const std::string& getDefaultLevel() const; //tolua_export
-            void compileAvailableLevelList(); //tolua_export
+            unsigned int getNumberOfLevels(void); //tolua_export
             const std::string& getAvailableLevelListItem(unsigned int index) const; //tolua_export
 
@@ -69 +70 @@
             void activateNextLevel();
 
+            void compileAvailableLevelList(void);
+            void updateAvailableLevelList(void);
+
             std::list<Level*> levels_s;
             std::vector<std::string> availableLevels_;
+            std::map<std::string, LevelInfoItem*> infos_;
 
             // config values

code/branches/releasetodo/src/orxonox/OrxonoxPrereqs.h

@@ -68 +68 @@
     class Level;
     class LevelInfo;
+    class LevelInfoItem;
     class LevelManager;
     class PawnManager;