1
0

ITerrainModule.cs 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  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.IO;
  28. using OpenSim.Framework;
  29. using OpenMetaverse;
  30. namespace OpenSim.Region.Framework.Interfaces
  31. {
  32. public interface ITerrainModule
  33. {
  34. void LoadFromFile(string filename);
  35. void SaveToFile(string filename);
  36. void ModifyTerrain(UUID user, Vector3 pos, byte size, byte action);
  37. /// <summary>
  38. /// Taint the terrain. This will lead to sending the terrain data to the clients again.
  39. /// Use this if you change terrain data outside of the terrain module (e.g. in osTerrainSetHeight)
  40. /// </summary>
  41. void TaintTerrain();
  42. /// <summary>
  43. /// When a client initially connects, all the terrain must be pushed to the viewer.
  44. /// This call causes all the terrain patches to be sent to the client.
  45. /// </summary>
  46. void PushTerrain(IClientAPI pClient);
  47. /// <summary>
  48. /// Load a terrain from a stream.
  49. /// </summary>
  50. /// <param name="filename">
  51. /// Only required here to identify the image type. Not otherwise used in the loading itself.
  52. /// </param>
  53. /// <param name="stream"></param>
  54. void LoadFromStream(string filename, Stream stream);
  55. void LoadFromStream(string filename, System.Uri pathToTerrainHeightmap);
  56. void LoadFromStream(string filename, Vector3 displacement,
  57. float radianRotation, Vector2 rotationDisplacement, Stream stream);
  58. void LoadFromStream(string filename, Vector3 displacement,
  59. float rotationDegress, Vector2 boundingOrigin, Vector2 boundingSize, Stream stream);
  60. /// <summary>
  61. /// Save a terrain to a stream.
  62. /// </summary>
  63. /// <param name="filename">
  64. /// Only required here to identify the image type. Not otherwise used in the saving itself.
  65. /// </param>
  66. /// <param name="stream"></param>
  67. void SaveToStream(string filename, Stream stream);
  68. void InstallPlugin(string name, ITerrainEffect plug);
  69. void UndoTerrain(ITerrainChannel channel);
  70. }
  71. }