IRegionCombinerModule.cs 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  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;
  28. using System.Collections.Generic;
  29. using System.Linq;
  30. using System.Text;
  31. using OpenSim.Region.Framework.Scenes;
  32. using System.IO;
  33. using OpenMetaverse;
  34. namespace OpenSim.Region.Framework.Interfaces
  35. {
  36. public interface IRegionCombinerModule
  37. {
  38. /// <summary>
  39. /// Does the given id belong to the root region of a megaregion?
  40. /// </summary>
  41. bool IsRootForMegaregion(UUID regionId);
  42. /// <summary>
  43. /// Gets the size of megaregion.
  44. /// </summary>
  45. /// <remarks>
  46. /// Returns size in meters.
  47. /// Do not rely on this method remaining the same - this area is actively under development.
  48. /// </remarks>
  49. /// <param name="sceneId">
  50. /// The id of the root region for a megaregion.
  51. /// This may change in the future to allow any region id that makes up a megaregion.
  52. /// Currently, will throw an exception if this does not match a root region.
  53. /// </param>
  54. Vector2 GetSizeOfMegaregion(UUID regionId);
  55. /// <summary>
  56. /// Tests to see of position (relative to the region) is within the megaregion
  57. /// </summary>
  58. bool PositionIsInMegaregion(UUID currentRegion, int xx, int yy);
  59. }
  60. }