Merge branch 'master' into careminster-presence-refactor

1 files changed, 22 insertions, 0 deletions

diff --git a/OpenSim/Framework/ILandObject.cs b/OpenSim/Framework/ILandObject.cs
index 98ea01e..5a55b02 100644
--- a/OpenSim/Framework/ILandObject.cs
+++ b/OpenSim/Framework/ILandObject.cs
@@ -82,8 +82,30 @@ 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.  The inputs are treated as points.  So if you want to create a bitmap
+        /// that covers an entire 256 x 256m region apart from a strip of land on the east, then you would need to 
+        /// specify start_x = 0, start_y = 0, end_x = 252 (or anything up to 255), end_y = 256.
+        /// 
+        /// At the moment, the smallest parcel of land is 4m x 4m, so if the 
+        /// region is 256 x 256m (the SL size), the bitmap returned will start at (0,0) and end 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);