1
0

IHeightmap.cs 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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.Text;
  30. namespace OpenSim.Region.OptionalModules.Scripting.Minimodule
  31. {
  32. public interface IHeightmap
  33. {
  34. /// <summary>
  35. /// Returns [or sets] the heightmap value at specified coordinates.
  36. /// </summary>
  37. /// <param name="x">X Coordinate</param>
  38. /// <param name="y">Y Coordinate</param>
  39. /// <returns>A value in meters representing height. Can be negative. Value correlates with Z parameter in world coordinates</returns>
  40. /// <example>
  41. /// double heightVal = World.Heightmap[128,128];
  42. /// World.Heightmap[128,128] *= 5.0;
  43. /// World.Heightmap[128,128] = 25;
  44. /// </example>
  45. double this[int x, int y]
  46. {
  47. get;
  48. set;
  49. }
  50. /// <summary>
  51. /// The maximum length of the region (Y axis), exclusive. (eg Height = 256, max Y = 255). Minimum is always 0 inclusive.
  52. /// </summary>
  53. /// <example>
  54. /// Host.Console.Info("The terrain length of this region is " + World.Heightmap.Length);
  55. /// </example>
  56. int Length { get; }
  57. /// <summary>
  58. /// The maximum width of the region (X axis), exclusive. (eg Width = 256, max X = 255). Minimum is always 0 inclusive.
  59. /// </summary>
  60. /// <example>
  61. /// Host.Console.Info("The terrain width of this region is " + World.Heightmap.Width);
  62. /// </example>
  63. int Width { get; }
  64. }
  65. }