initial commit, lordsawar source, slightly modified

[lordsawar] / src / road.h

diff --git a/src/road.h b/src/road.h
new file mode 100644 (file)
index 0000000..6f509a6
--- /dev/null
+++ b/src/road.h
@@ -0,0 +1,120 @@
+//  Copyright (C) 2007, 2008 Ben Asselstine
+//
+//  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 3 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 Library 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.
+
+#ifndef ROAD_H
+#define ROAD_H
+
+#include "Location.h"
+
+//! A single tile on the map that has a road on it.
+/**
+ * Stack objects move more efficently on roads, and they often interconnect 
+ * many City objects.
+ * A road object is built on a Tile with any terrain kind except Tile::WATER.
+ */
+class Road: public Location
+{
+    public:
+       //! The xml tag of this object in a saved-game file.
+       static std::string d_tag; 
+
+        enum Type {
+         CONNECTS_EAST_AND_WEST = 0,
+         CONNECTS_NORTH_AND_SOUTH = 1,
+         CONNECTS_ALL_DIRECTIONS = 2,
+         CONNECTS_NORTH_AND_WEST = 3,
+         CONNECTS_NORTH_AND_EAST = 4,
+         CONNECTS_SOUTH_AND_EAST = 5,
+         CONNECTS_WEST_AND_SOUTH = 6,
+         CONNECTS_NORTH_AND_SOUTH_AND_EAST = 7,
+         CONNECTS_EAST_WEST_AND_NORTH = 8,
+         CONNECTS_EAST_WEST_AND_SOUTH = 9,
+         CONNECTS_NORTH_SOUTH_AND_WEST = 10,
+         CONNECTS_WEST = 11,
+         CONNECTS_NORTH = 12,
+         CONNECTS_EAST = 13,
+         CONNECTS_SOUTH = 14,
+       };
+
+       //! Default constructor.
+        /**
+          * @param pos          The location of the road.
+          * @param type        The type of road.
+          */
+        Road(Vector<int> pos, int type = CONNECTS_ALL_DIRECTIONS);
+
+       //! Copy constructor.
+        Road(const Road&);
+
+       //! Alternative copy constructor that changes the road's position.
+        Road(const Road&, Vector<int> pos);
+
+        //! Loading constructor.
+       /**
+        * Make a new road object by reading lordsawar.roadlist.road XML 
+        * entities from the saved-game file.
+        *
+        * @param helper  The opened saved-game file to load the road from.
+        */
+        Road(XML_Helper* helper);
+
+       //! Destructor.
+        ~Road();
+
+
+       // Get Methods
+
+        //! Returns the type of the road.
+        int getType() const {return d_type;};
+
+
+       // Set Methods
+
+        //! Sets the type of the road.
+        void setType(int type) {d_type = type;};
+
+
+       // Methods that operate on class data but do not modify the class
+
+        //! Save the road data to an opened saved-game file.
+        bool save(XML_Helper* helper) const;
+
+
+       // Static Methods
+
+       //! Convert a Road::Type enumerated value to a string.
+       static std::string roadTypeToString(const Road::Type type);
+
+       //! Convert a string containing a Road::Type to it's enumerated value.
+       static Road::Type roadTypeFromString(const std::string str);
+
+    protected:
+
+       // DATA
+
+       //! The type of the road.
+       /**
+        * The type of road refers to the look of the road on the map.  It 
+        * can be any one of the values found in Road::Type.
+        *
+        * The Roadlist::calculateType method can calculate this value.
+        */
+       int d_type;
+
+};
+
+#endif // ROAD_H