From fa202a05e914395d5a1facf8bdadb6a553516bfe Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Wed, 6 Apr 2011 17:19:31 +0100
Subject: Add method doc to some land bitmap methods in ILandObject.

Also changes prim count tests to use the correct upper region bounds, though the method actually ignores the overage.
---
 OpenSim/Framework/ILandObject.cs | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'OpenSim/Framework')

diff --git a/OpenSim/Framework/ILandObject.cs b/OpenSim/Framework/ILandObject.cs
index 98ea01e..02775e9 100644
--- a/OpenSim/Framework/ILandObject.cs
+++ b/OpenSim/Framework/ILandObject.cs
@@ -82,8 +82,26 @@ namespace OpenSim.Framework
         void ForceUpdateLandInfo();
         void SetLandBitmap(bool[,] bitmap);
 
+        /// <summary>
+        /// Get a land bitmap that would cover an entire region.
+        /// </summary>
+        /// <returns>The bitmap created.</returns>
         bool[,] BasicFullRegionLandBitmap();
+        
+        /// <summary>
+        /// Create a square land bitmap.
+        /// </summary>
+        /// <remarks>
+        /// Land co-ordinates are zero indexed.  At the moment, the smallest parcel of land is 4m x 4m, so if the 
+        /// region is 256 x 256m (the SL size), the largest land parcel starts at (0,0) and ends at (63,63).
+        /// </remarks>
+        /// <param name="start_x"></param>
+        /// <param name="start_y"></param>
+        /// <param name="end_x"></param>
+        /// <param name="end_y"></param>
+        /// <returns>The bitmap created.</returns>
         bool[,] GetSquareLandBitmap(int start_x, int start_y, int end_x, int end_y);
+        
         bool[,] ModifyLandBitmapSquare(bool[,] land_bitmap, int start_x, int start_y, int end_x, int end_y, bool set_value);
         bool[,] MergeLandBitmaps(bool[,] bitmap_base, bool[,] bitmap_add);
         void SendForceObjectSelect(int local_id, int request_type, List<UUID> returnIDs, IClientAPI remote_client);
-- 
cgit v1.1