aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Framework/Interfaces
diff options
context:
space:
mode:
Diffstat (limited to 'OpenSim/Region/Framework/Interfaces')
-rw-r--r--OpenSim/Region/Framework/Interfaces/IWindModelPlugin.cs83
1 files changed, 83 insertions, 0 deletions
diff --git a/OpenSim/Region/Framework/Interfaces/IWindModelPlugin.cs b/OpenSim/Region/Framework/Interfaces/IWindModelPlugin.cs
new file mode 100644
index 0000000..b087c8b
--- /dev/null
+++ b/OpenSim/Region/Framework/Interfaces/IWindModelPlugin.cs
@@ -0,0 +1,83 @@
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
28using System;
29using System.Collections.Generic;
30
31using Nini.Config;
32using OpenSim.Framework;
33using OpenMetaverse;
34using OpenSim.Region.Framework.Scenes;
35
36namespace OpenSim.Region.Framework.Interfaces
37{
38 public interface IWindModelPlugin : IPlugin
39 {
40 /// <summary>
41 /// Brief description of this plugin's wind model
42 /// </summary>
43 string Description { get; }
44
45 /// <summary>
46 /// Provides access to the wind configuration, if any.
47 /// </summary>
48 void WindConfig(Scene scene, IConfig windConfig);
49
50 /// <summary>
51 /// Update wind.
52 /// </summary>
53 void WindUpdate(uint frame);
54
55 /// <summary>
56 /// Returns the wind vector at the given local region coordinates.
57 /// </summary>
58 Vector3 WindSpeed(float x, float y, float z);
59
60 /// <summary>
61 /// Generate a 16 x 16 Vector2 array of wind speeds for LL* based viewers
62 /// </summary>
63 /// <returns>Must return a Vector2[256]</returns>
64 Vector2[] WindLLClientArray();
65
66 /// <summary>
67 /// Retrieve a list of parameter/description pairs.
68 /// </summary>
69 /// <returns></returns>
70 Dictionary<string, string> WindParams();
71
72 /// <summary>
73 /// Set the specified parameter
74 /// </summary>
75 void WindParamSet(string param, float value);
76
77 /// <summary>
78 /// Get the specified parameter
79 /// </summary>
80 float WindParamGet(string param);
81
82 }
83}