ILandObject.cs 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using System.Collections.Generic;
  28. using OpenMetaverse;
  29. namespace OpenSim.Framework
  30. {
  31. public delegate int overrideParcelMaxPrimCountDelegate(ILandObject obj);
  32. public delegate int overrideSimulatorMaxPrimCountDelegate(ILandObject obj);
  33. public interface ILandObject
  34. {
  35. int GetParcelMaxPrimCount();
  36. int GetSimulatorMaxPrimCount();
  37. int GetPrimsFree();
  38. Dictionary<UUID, int> GetLandObjectOwners();
  39. LandData LandData { get; set; }
  40. bool[,] LandBitmap { get; set; }
  41. UUID RegionUUID { get; }
  42. /// <summary>
  43. /// Prim counts for this land object.
  44. /// </summary>
  45. IPrimCounts PrimCounts { get; set; }
  46. /// <summary>
  47. /// The start point for the land object. This is the northern-most point as one scans land working from
  48. /// west to east.
  49. /// </summary>
  50. Vector2 StartPoint { get; }
  51. /// <summary>
  52. /// The end point for the land object. This is the southern-most point as one scans land working from
  53. /// west to east.
  54. /// </summary>
  55. Vector2 EndPoint { get; }
  56. // a estimation of a parcel center.
  57. Vector2 CenterPoint { get; }
  58. // get positions
  59. Vector2? GetNearestPoint(Vector3 pos);
  60. Vector2? GetNearestPointAlongDirection(Vector3 pos, Vector3 pdirection);
  61. bool ContainsPoint(int x, int y);
  62. ILandObject Copy();
  63. void SendLandUpdateToAvatarsOverMe();
  64. void SendLandProperties(int sequence_id, bool snap_selection, int request_result, IClientAPI remote_client);
  65. bool UpdateLandProperties(LandUpdateArgs args, IClientAPI remote_client, out bool snap_selection, out bool needOverlay);
  66. bool IsEitherBannedOrRestricted(UUID avatar);
  67. bool IsBannedFromLand(UUID avatar);
  68. bool CanBeOnThisLand(UUID avatar, float posHeight);
  69. bool IsRestrictedFromLand(UUID avatar);
  70. bool IsInLandAccessList(UUID avatar);
  71. void SendLandUpdateToClient(IClientAPI remote_client);
  72. void SendLandUpdateToClient(bool snap_selection, IClientAPI remote_client);
  73. List<LandAccessEntry> CreateAccessListArrayByFlag(AccessList flag);
  74. void SendAccessList(UUID agentID, UUID sessionID, uint flags, int sequenceID, IClientAPI remote_client);
  75. void UpdateAccessList(uint flags, UUID transactionID, int sequenceID, int sections, List<LandAccessEntry> entries, IClientAPI remote_client);
  76. void UpdateLandBitmapByteArray();
  77. void SetLandBitmapFromByteArray();
  78. bool[,] GetLandBitmap();
  79. void ForceUpdateLandInfo();
  80. void SetLandBitmap(bool[,] bitmap);
  81. /// <summary>
  82. /// Get a land bitmap that would cover an entire region.
  83. /// </summary>
  84. /// <returns>The bitmap created.</returns>
  85. bool[,] BasicFullRegionLandBitmap();
  86. /// <summary>
  87. /// Create a square land bitmap.
  88. /// </summary>
  89. /// <remarks>
  90. /// Land co-ordinates are zero indexed. The inputs are treated as points. So if you want to create a bitmap
  91. /// that covers an entire 256 x 256m region apart from a strip of land on the east, then you would need to
  92. /// specify start_x = 0, start_y = 0, end_x = 252 (or anything up to 255), end_y = 255.
  93. ///
  94. /// At the moment, the smallest parcel of land is 4m x 4m, so if the
  95. /// region is 256 x 256m (the SL size), the bitmap returned will start at (0,0) and end at (63,63).
  96. /// The value of the set_value needs to be true to define an active parcel of the given size.
  97. /// </remarks>
  98. /// <param name="start_x"></param>
  99. /// <param name="start_y"></param>
  100. /// <param name="end_x"></param>
  101. /// <param name="end_y"></param>
  102. /// <param name="set_value"></param>
  103. /// <returns>The bitmap created.</returns>
  104. bool[,] GetSquareLandBitmap(int start_x, int start_y, int end_x, int end_y, bool set_value = true);
  105. bool[,] ModifyLandBitmapSquare(bool[,] land_bitmap, int start_x, int start_y, int end_x, int end_y, bool set_value);
  106. /// <summary>
  107. /// Merge two (same size) land bitmaps.
  108. /// </summary>
  109. /// <param name="bitmap_base"></param>
  110. /// <param name="bitmap_add"></param>
  111. /// <returns>The modified bitmap.</returns>
  112. bool[,] MergeLandBitmaps(bool[,] bitmap_base, bool[,] bitmap_add);
  113. /// <summary>
  114. /// Remap a land bitmap. Takes the supplied land bitmap and rotates it, crops it and finally offsets it into
  115. /// a final land bitmap of the target region size.
  116. /// </summary>
  117. /// <param name="bitmap_base">The original parcel bitmap</param>
  118. /// <param name="rotationDegrees"></param>
  119. /// <param name="displacement">&lt;x,y,?&gt;</param>
  120. /// <param name="boundingOrigin">&lt;x,y,?&gt;</param>
  121. /// <param name="boundingSize">&lt;x,y,?&gt;</param>
  122. /// <param name="regionSize">&lt;x,y,?&gt;</param>
  123. /// <param name="isEmptyNow">out: This is set if the resultant bitmap is now empty</param>
  124. /// <param name="AABBMin">out: parcel.AABBMin &lt;x,y,0&gt</param>
  125. /// <param name="AABBMax">out: parcel.AABBMax &lt;x,y,0&gt</param>
  126. /// <returns>New parcel bitmap</returns>
  127. bool[,] RemapLandBitmap(bool[,] bitmap_base, Vector2 displacement, float rotationDegrees, Vector2 boundingOrigin, Vector2 boundingSize, Vector2 regionSize, out bool isEmptyNow, out Vector3 AABBMin, out Vector3 AABBMax);
  128. /// <summary>
  129. /// Clears any parcel data in bitmap_base where there exists parcel data in bitmap_new. In other words the parcel data
  130. /// in bitmap_new takes over the space of the parcel data in bitmap_base.
  131. /// </summary>
  132. /// <param name="bitmap_base"></param>
  133. /// <param name="bitmap_new"></param>
  134. /// <param name="isEmptyNow">out: This is set if the resultant bitmap is now empty</param>
  135. /// <param name="AABBMin">out: parcel.AABBMin &lt;x,y,0&gt;</param>
  136. /// <param name="AABBMax">out: parcel.AABBMax &lt;x,y,0&gt</param>
  137. /// <returns>New parcel bitmap</returns>
  138. bool[,] RemoveFromLandBitmap(bool[,] bitmap_base, bool[,] bitmap_new, out bool isEmptyNow, out Vector3 AABBMin, out Vector3 AABBMax);
  139. byte[] ConvertLandBitmapToBytes();
  140. bool[,] ConvertBytesToLandBitmap(bool overrideRegionSize = false);
  141. bool IsLandBitmapEmpty(bool[,] landBitmap);
  142. void DebugLandBitmap(bool[,] landBitmap);
  143. void SendForceObjectSelect(int local_id, int request_type, List<UUID> returnIDs, IClientAPI remote_client);
  144. void SendLandObjectOwners(IClientAPI remote_client);
  145. void ReturnLandObjects(uint type, UUID[] owners, UUID[] tasks, IClientAPI remote_client);
  146. void ResetOverMeRecord();
  147. void UpdateLandSold(UUID avatarID, UUID groupID, bool groupOwned, uint AuctionID, int claimprice, int area);
  148. void DeedToGroup(UUID groupID);
  149. void SetParcelObjectMaxOverride(overrideParcelMaxPrimCountDelegate overrideDel);
  150. void SetSimulatorObjectMaxOverride(overrideSimulatorMaxPrimCountDelegate overrideDel);
  151. /// <summary>
  152. /// Set the media url for this land parcel
  153. /// </summary>
  154. /// <param name="url"></param>
  155. void SetMediaUrl(string url);
  156. /// <summary>
  157. /// Set the music url for this land parcel
  158. /// </summary>
  159. /// <param name="url"></param>
  160. void SetMusicUrl(string url);
  161. /// <summary>
  162. /// Get the music url for this land parcel
  163. /// </summary>
  164. /// <returns>The music url.</returns>
  165. string GetMusicUrl();
  166. void Clear();
  167. }
  168. }