IWindModelPlugin.cs 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  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 Nini.Config;
  30. using OpenSim.Framework;
  31. using OpenMetaverse;
  32. using OpenSim.Region.Framework.Scenes;
  33. namespace OpenSim.Region.Framework.Interfaces
  34. {
  35. public interface IWindModelPlugin : IPlugin
  36. {
  37. /// <summary>
  38. /// Brief description of this plugin's wind model
  39. /// </summary>
  40. string Description { get; }
  41. /// <summary>
  42. /// Provides access to the wind configuration, if any.
  43. /// </summary>
  44. void WindConfig(Scene scene, IConfig windConfig);
  45. /// <summary>
  46. /// Update wind.
  47. /// </summary>
  48. void WindUpdate(uint frame);
  49. /// <summary>
  50. /// Returns the wind vector at the given local region coordinates.
  51. /// </summary>
  52. Vector3 WindSpeed(float x, float y, float z);
  53. /// <summary>
  54. /// Generate a 16 x 16 Vector2 array of wind speeds for LL* based viewers
  55. /// </summary>
  56. /// <returns>Must return a Vector2[256]</returns>
  57. Vector2[] WindLLClientArray();
  58. /// <summary>
  59. /// Retrieve a list of parameter/description pairs.
  60. /// </summary>
  61. /// <returns></returns>
  62. Dictionary<string, string> WindParams();
  63. /// <summary>
  64. /// Set the specified parameter
  65. /// </summary>
  66. void WindParamSet(string param, float value);
  67. /// <summary>
  68. /// Get the specified parameter
  69. /// </summary>
  70. float WindParamGet(string param);
  71. }
  72. }