From: Charles <Charles@92bb83a3-7c8f-8a45-bc97-515c4e399668>
Date: Mon, 19 Apr 2010 05:56:07 +0000 (+0000)
Subject: Documentation for Map.Zoom.
X-Git-Url: https://git.dogcows.com/gitweb?a=commitdiff_plain;h=df831ce5a969f0e59c6ea22d5d47fbd4c8d9b987;p=chaz%2Fcarfire

Documentation for Map.Zoom.

git-svn-id: https://bd85.net/svn/cs3505_group@108 92bb83a3-7c8f-8a45-bc97-515c4e399668
---

diff --git a/CarFire/CarFire/CarFire/Map.cs b/CarFire/CarFire/CarFire/Map.cs
index 2440f12..4fb11cb 100644
--- a/CarFire/CarFire/CarFire/Map.cs
+++ b/CarFire/CarFire/CarFire/Map.cs
@@ -156,6 +156,10 @@ namespace CarFire
             set { mView.CenterCell = value; }
         }
 
+        /// <summary>
+        /// Get and set the zoom of the map view.  The default zoom is
+        /// PixelsToUnitSquares.
+        /// </summary>
         public float Zoom
         {
             get { return mView.Zoom; }
@@ -176,7 +180,7 @@ namespace CarFire
         public Map(Metadata metadata, char[,] grid, char defaultTile,
             List<RawEntity> entities, Point[] playerPositions)
         {
-            mData = new Modal(metadata, grid, defaultTile, entities, playerPositions);
+            mData = new Model(metadata, grid, defaultTile, entities, playerPositions);
             mView = new View(mData);
         }
 
@@ -347,7 +351,7 @@ namespace CarFire
 
         #region Private Types
 
-        class Modal
+        class Model
         {
             public Metadata Metadata { get { return mMetadata; } }
             public List<RawEntity> Entities { get { return mEntities; } }
@@ -355,7 +359,7 @@ namespace CarFire
             public bool[,] Grid { get { return mBooleanGrid; } }
 
 
-            public Modal(Metadata metadata, char[,] grid, char defaultTile,
+            public Model(Metadata metadata, char[,] grid, char defaultTile,
                 List<RawEntity> entities, Point[] playerPositions)
             {
                 Debug.Assert(metadata != null);
@@ -500,7 +504,7 @@ namespace CarFire
             public float Zoom;
 
 
-            public View(Modal data)
+            public View(Model data)
             {
                 Debug.Assert(data != null);
                 mData = data;
@@ -581,7 +585,7 @@ namespace CarFire
             }
 
 
-            Modal mData;
+            Model mData;
             Viewport mViewport;
         }
 
@@ -590,7 +594,7 @@ namespace CarFire
 
         #region Private Variables
 
-        Modal mData;
+        Model mData;
         View mView;
 
         #endregion