1 files changed, 310 insertions, 100 deletions

diff --git a/OpenSim/Region/CoreModules/World/Wind/WindModule.cs b/OpenSim/Region/CoreModules/World/Wind/WindModule.cs
index 87e6fd9..26901a4 100644
--- a/OpenSim/Region/CoreModules/World/Wind/WindModule.cs
+++ b/OpenSim/Region/CoreModules/World/Wind/WindModule.cs
@@ -27,57 +27,125 @@
 
 using System;
 using System.Collections.Generic;
+using System.Reflection;
+using log4net;
+using Mono.Addins;
 using Nini.Config;
 using OpenMetaverse;
 using OpenSim.Framework;
 using OpenSim.Region.Framework.Interfaces;
 using OpenSim.Region.Framework.Scenes;
 
+using OpenSim.Region.CoreModules.World.Wind;
+
 namespace OpenSim.Region.CoreModules
 {
     public class WindModule : IWindModule
     {
-//        private static readonly log4net.ILog m_log 
-//            = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
-        private int m_frame = 0;
-        private int m_frame_mod = 150;
+        private uint m_frame = 0;
+        private uint m_frameLastUpdateClientArray = 0;
+        private int m_frameUpdateRate = 150;
         private Random m_rndnums = new Random(Environment.TickCount);
         private Scene m_scene = null;
         private bool m_ready = false;
-        private float m_strength = 1.0F;
+
         private bool m_enabled = true;
 
+        private IWindModelPlugin m_activeWindPlugin = null;
+        private const string m_dWindPluginName = "SimpleRandomWind";
+        private Dictionary<string, IWindModelPlugin> m_availableWindPlugins = new Dictionary<string, IWindModelPlugin>();
+
         // Simplified windSpeeds based on the fact that the client protocal tracks at a resolution of 16m
         private Vector2[] windSpeeds = new Vector2[16 * 16];
 
-        private Dictionary<UUID, ulong> m_rootAgents = new Dictionary<UUID, ulong>();
-     
+        #region IRegion Methods
+
         public void Initialise(Scene scene, IConfigSource config)
         {
             IConfig windConfig = config.Configs["Wind"];
+            string desiredWindPlugin = m_dWindPluginName;
 
             if (windConfig != null)
             {
                 m_enabled = windConfig.GetBoolean("enabled", true);
-                m_strength = windConfig.GetFloat("strength", 1.0F);
+
+                m_frameUpdateRate = windConfig.GetInt("wind_update_rate", 150);
+
+                // Determine which wind model plugin is desired
+                if (windConfig.Contains("wind_plugin"))
+                {
+                    desiredWindPlugin = windConfig.GetString("wind_plugin");
+                }
             }
 
             if (m_enabled)
             {
+                m_log.InfoFormat("[WIND] Enabled with an update rate of {0} frames.", m_frameUpdateRate);
 
                 m_scene = scene;
                 m_frame = 0;
 
+                // Register all the Wind Model Plug-ins
+                foreach (IWindModelPlugin windPlugin in AddinManager.GetExtensionObjects("/OpenSim/WindModule"))
+                {
+                    m_log.InfoFormat("[WIND] Found Plugin: {0}", windPlugin.Name);
+                    m_availableWindPlugins.Add(windPlugin.Name, windPlugin);
+                }
+
+                // Check for desired plugin
+                if (m_availableWindPlugins.ContainsKey(desiredWindPlugin))
+                {
+                    m_activeWindPlugin = m_availableWindPlugins[desiredWindPlugin];
+
+                    m_log.InfoFormat("[WIND] {0} plugin found, initializing.", desiredWindPlugin);
+
+                    if (windConfig != null)
+                    {
+                        m_activeWindPlugin.Initialise();
+                        m_activeWindPlugin.WindConfig(m_scene, windConfig);
+                    }
+                } 
+
+
+                // if the plug-in wasn't found, default to no wind.
+                if (m_activeWindPlugin == null)
+                {
+                    m_log.ErrorFormat("[WIND] Could not find specified wind plug-in: {0}", desiredWindPlugin);
+                    m_log.ErrorFormat("[WIND] Defaulting to no wind.");
+                }
 
-                scene.EventManager.OnFrame += WindUpdate;
-                scene.EventManager.OnMakeChildAgent += MakeChildAgent;
-                scene.EventManager.OnAvatarEnteringNewParcel += AvatarEnteringParcel;
-                scene.EventManager.OnClientClosed += ClientLoggedOut;
-                scene.RegisterModuleInterface<IWindModule>(this);
+                // This one puts an entry in the main help screen
+                m_scene.AddCommand(this, String.Empty, "wind", "Usage: wind <plugin> <param> [value] - Get or Update Wind paramaters", null);
+                
+                // This one enables the ability to type just the base command without any parameters
+                m_scene.AddCommand(this, "wind", "", "", HandleConsoleCommand);
 
+                // Get a list of the parameters for each plugin
+                foreach (IWindModelPlugin windPlugin in m_availableWindPlugins.Values)
+                {
+                    m_scene.AddCommand(this, String.Format("wind base wind_plugin {0}", windPlugin.Name), String.Format("{0} - {1}", windPlugin.Name, windPlugin.Description), "", HandleConsoleBaseCommand);
+                    m_scene.AddCommand(this, String.Format("wind base wind_update_rate"), "Change the wind update rate.", "", HandleConsoleBaseCommand);
+                    
+                    foreach (KeyValuePair<string, string> kvp in windPlugin.WindParams())
+                    {
+                        m_scene.AddCommand(this, String.Format("wind {0} {1}", windPlugin.Name, kvp.Key), String.Format("{0} : {1} - {2}", windPlugin.Name, kvp.Key, kvp.Value), "", HandleConsoleParamCommand);
+                    }
+                }
+
+
+                // Register event handlers for when Avatars enter the region, and frame ticks
+                m_scene.EventManager.OnFrame += WindUpdate;
+                m_scene.EventManager.OnMakeRootAgent += OnAgentEnteredRegion;
+
+                // Register the wind module 
+                m_scene.RegisterModuleInterface<IWindModule>(this);
+
+                // Generate initial wind values
                 GenWindPos();
 
+                // Mark Module Ready for duty
                 m_ready = true;
 
             }
@@ -93,12 +161,19 @@ namespace OpenSim.Region.CoreModules
             if (m_enabled)
             {
                 m_ready = false;
+
+                // REVIEW: If a region module is closed, is there a possibility that it'll re-open/initialize ??
+                m_activeWindPlugin = null;
+                foreach (IWindModelPlugin windPlugin in m_availableWindPlugins.Values)
+                {
+                    windPlugin.Dispose();
+                }
+
+                m_availableWindPlugins.Clear();
+
                 //  Remove our hooks
                 m_scene.EventManager.OnFrame -= WindUpdate;
-                // m_scene.EventManager.OnNewClient -= SunToClient;
-                m_scene.EventManager.OnMakeChildAgent -= MakeChildAgent;
-                m_scene.EventManager.OnAvatarEnteringNewParcel -= AvatarEnteringParcel;
-                m_scene.EventManager.OnClientClosed -= ClientLoggedOut;
+                m_scene.EventManager.OnMakeRootAgent -= OnAgentEnteredRegion;
             }
         }
 
@@ -112,144 +187,279 @@ namespace OpenSim.Region.CoreModules
             get { return false; }
         }
 
-        /// <summary>
-        /// Retrieve the wind speed at the given region coordinate.  This 
-        /// implimentation ignores Z.
-        /// </summary>
-        /// <param name="x">0...255</param>
-        /// <param name="y">0...255</param>
-        /// <returns></returns>
-        public Vector3 WindSpeed(int x, int y, int z)
-        {
-            Vector3 windVector = new Vector3(0.0f, 0.0f, 0.0f);
-            
-            x /= 16;
-            y /= 16;
-            if (x < 0) x = 0;
-            if (x > 15) x = 15;
-            if (y < 0) y = 0;
-            if (y > 15) y = 15;
 
-            if (windSpeeds != null)
+        #endregion
+
+        #region Console Commands
+        private void ValidateConsole()
+        {
+            if (m_scene.ConsoleScene() == null)
             {
-                windVector.X = windSpeeds[y * 16 + x].X;
-                windVector.Y = windSpeeds[y * 16 + x].Y;
+                // FIXME: If console region is root then this will be printed by every module.  Currently, there is no
+                // way to prevent this, short of making the entire module shared (which is complete overkill).
+                // One possibility is to return a bool to signal whether the module has completely handled the command
+                m_log.InfoFormat("[WIND]: Please change to a specific region in order to set Sun parameters.");
+                return;
             }
 
+            if (m_scene.ConsoleScene() != m_scene)
+            {
+                m_log.InfoFormat("[WIND]: Console Scene is not my scene.");
+                return;
+            }
+        }
 
-            return windVector;
+        /// <summary>
+        /// Base console command handler, only used if a person specifies the base command with now options
+        /// </summary>
+        private void HandleConsoleCommand(string module, string[] cmdparams)
+        {
+            ValidateConsole();
+            m_log.Info("[WIND] The wind command can be used to change the currently active wind model plugin and update the parameters for wind plugins.");
         }
 
-        public void WindToClient(IClientAPI client)
+        /// <summary>
+        /// Called to change the active wind model plugin
+        /// </summary>
+        private void HandleConsoleBaseCommand(string module, string[] cmdparams)
         {
-            if (m_ready)
+            ValidateConsole();
+
+            if( (cmdparams.Length != 4)
+                || !cmdparams[1].Equals("base")
+                )
             {
-                //if (!sunFixed)
-                    //GenWindPos();    // Generate shared values once
-                client.SendWindData(windSpeeds);
+                m_log.Info("[WIND] Invalid parameters to change parameters for Wind module base, usage: wind base <parameter> <value>");
+                return;
             }
+
+            switch (cmdparams[2])
+            {
+                case "wind_update_rate":
+                    int newRate = 1;
+
+                    if (int.TryParse(cmdparams[3], out newRate))
+                    {
+                        m_frameUpdateRate = newRate;
+                    }
+                    else
+                    {
+                        m_log.InfoFormat("[WIND] Invalid value {0} specified for {1}", cmdparams[3], cmdparams[2]);
+                        return;
+                    }
+
+                    break;
+                case "wind_plugin":
+                    string desiredPlugin = cmdparams[3];
+
+                    if (desiredPlugin.Equals(m_activeWindPlugin.Name))
+                    {
+                        m_log.InfoFormat("[WIND] Wind model plugin {0} is already active", cmdparams[3]);
+                        return;
+                    }
+
+                    if (m_availableWindPlugins.ContainsKey(desiredPlugin))
+                    {
+                        m_activeWindPlugin = m_availableWindPlugins[cmdparams[3]];
+                        m_log.InfoFormat("[WIND] {0} wind model plugin now active", m_activeWindPlugin.Name);
+                    }
+                    else
+                    {
+                        m_log.InfoFormat("[WIND] Could not find wind model plugin {0}", desiredPlugin);
+                    }
+                    break;
+            }
+
         }
 
-        public void WindUpdate()
+        /// <summary>
+        /// Called to change plugin parameters.
+        /// </summary>
+        private void HandleConsoleParamCommand(string module, string[] cmdparams)
         {
-            if (((m_frame++ % m_frame_mod) != 0) || !m_ready)
+            ValidateConsole();
+
+            // wind <plugin> <param> [value]
+            if ((cmdparams.Length != 4)
+                && (cmdparams.Length != 3))
             {
+                m_log.Info("[WIND] Usage: wind <plugin> <param> [value]");
                 return;
             }
-            //m_log.Debug("[WIND]:Regenerating...");
-            GenWindPos();        // Generate shared values once
 
-            //int spotxp = 0;
-            //int spotyp = 0;
-            //int spotxm = 0;
-            //int spotym = 0;
-            List<ScenePresence> avatars = m_scene.GetAvatars();
-            foreach (ScenePresence avatar in avatars)
+            string plugin = cmdparams[1];
+            string param = cmdparams[2];
+            float value = 0f;
+            if (cmdparams.Length == 4)
             {
-                if (!avatar.IsChildAgent)
+                if (!float.TryParse(cmdparams[3], out value))
                 {
-                    avatar.ControllingClient.SendWindData(windSpeeds);
+                    m_log.InfoFormat("[WIND] Invalid value {0}", cmdparams[3]);
                 }
-            }
 
-            // set estate settings for region access to sun position
-            //m_scene.RegionInfo.RegionSettings.SunVector = Position;
-            //m_scene.RegionInfo.EstateSettings.sunHour = GetLindenEstateHourFromCurrentTime();
-        }
-        
-        public void ForceWindUpdateToAllClients()
-        {
-            GenWindPos();        // Generate shared values once
-
-            List<ScenePresence> avatars = m_scene.GetAvatars();
-            foreach (ScenePresence avatar in avatars)
+                try
+                {
+                    WindParamSet(plugin, param, value);
+                }
+                catch (Exception e)
+                {
+                    m_log.InfoFormat("[WIND] {0}", e.Message);
+                }
+            }
+            else
             {
-                if (!avatar.IsChildAgent)
-                    avatar.ControllingClient.SendWindData(windSpeeds);
+                try
+                {
+                    value = WindParamGet(plugin, param);
+                    m_log.InfoFormat("[WIND] {0} : {1}", param, value);
+                }
+                catch (Exception e)
+                {
+                    m_log.InfoFormat("[WIND] {0}", e.Message);
+                }
             }
 
-            // set estate settings for region access to sun position
-            //m_scene.RegionInfo.RegionSettings.SunVector = Position;
-            //m_scene.RegionInfo.RegionSettings.SunPosition = GetLindenEstateHourFromCurrentTime();
         }
+        #endregion
+
+
+        #region IWindModule Methods
+
         /// <summary>
-        /// Calculate the sun's orbital position and its velocity.
+        /// Retrieve the wind speed at the given region coordinate.  This 
+        /// implimentation ignores Z.
         /// </summary>
+        /// <param name="x">0...255</param>
+        /// <param name="y">0...255</param>
+        public Vector3 WindSpeed(int x, int y, int z)
+        {
+            if (m_activeWindPlugin != null)
+            {
+                return m_activeWindPlugin.WindSpeed(x, y, z);
+            }
+            else
+            {
+                return new Vector3(0.0f, 0.0f, 0.0f);
+            }
+        }
 
-        private void GenWindPos()
+        public void WindParamSet(string plugin, string param, float value)
         {
-            for (int y = 0; y < 16; y++)
+            if (m_availableWindPlugins.ContainsKey(plugin))
             {
-                for (int x = 0; x < 16; x++)
-                {
-                    windSpeeds[y * 16 + x].X = (float)(m_rndnums.NextDouble() * 2d - 1d); // -1 to 1
-                    windSpeeds[y * 16 + x].Y = (float)(m_rndnums.NextDouble() * 2d - 1d); // -1 to 1
-                    windSpeeds[y * 16 + x].X *= m_strength;
-                    windSpeeds[y * 16 + x].Y *= m_strength;
-                }
+                IWindModelPlugin windPlugin = m_availableWindPlugins[plugin];
+                windPlugin.WindParamSet(param, value);
+                m_log.InfoFormat("[WIND] {0} set to {1}", param, value);
+            }
+            else
+            {
+                throw new Exception(String.Format("Could not find plugin {0}", plugin));
             }
+
         }
 
-        private void ClientLoggedOut(UUID AgentId)
+        public float WindParamGet(string plugin, string param)
         {
-            lock (m_rootAgents)
+            if (m_availableWindPlugins.ContainsKey(plugin))
             {
-                if (m_rootAgents.ContainsKey(AgentId))
-                {
-                    m_rootAgents.Remove(AgentId);
-                }
+                IWindModelPlugin windPlugin = m_availableWindPlugins[plugin];
+                return windPlugin.WindParamGet(param);
+            }
+            else
+            {
+                throw new Exception(String.Format("Could not find plugin {0}", plugin));
             }
         }
 
-        private void AvatarEnteringParcel(ScenePresence avatar, int localLandID, UUID regionID)
+        public string WindActiveModelPluginName
         {
-            lock (m_rootAgents)
+            get 
             {
-                if (m_rootAgents.ContainsKey(avatar.UUID))
+                if (m_activeWindPlugin != null)
                 {
-                    m_rootAgents[avatar.UUID] = avatar.RegionHandle;
+                    return m_activeWindPlugin.Name;
                 }
                 else
                 {
-                    m_rootAgents.Add(avatar.UUID, avatar.RegionHandle);
-                    WindToClient(avatar.ControllingClient);
+                    return String.Empty;
                 }
             }
-            //m_log.Info("[FRIEND]: " + avatar.Name + " status:" + (!avatar.IsChildAgent).ToString());
         }
 
-        private void MakeChildAgent(ScenePresence avatar)
+        #endregion
+
+        /// <summary>
+        /// Called on each frame update.  Updates the wind model and clients as necessary.
+        /// </summary>
+        public void WindUpdate()
+        {
+            if (((m_frame++ % m_frameUpdateRate) != 0) || !m_ready)
+            {
+                return;
+            }
+
+            GenWindPos();
+
+            SendWindAllClients();
+        }
+
+        public void OnAgentEnteredRegion(ScenePresence avatar)
+        {
+            if (m_ready)
+            {
+                if (m_activeWindPlugin != null)
+                {
+                    // Ask wind plugin to generate a LL wind array to be cached locally
+                    // Try not to update this too often, as it may involve array copies
+                    if (m_frame >= (m_frameLastUpdateClientArray + m_frameUpdateRate))
+                    {
+                        windSpeeds = m_activeWindPlugin.WindLLClientArray();
+                        m_frameLastUpdateClientArray = m_frame;
+                    }
+                }
+
+                avatar.ControllingClient.SendWindData(windSpeeds);
+            }            
+        }
+
+        private void SendWindAllClients()
         {
-            lock (m_rootAgents)
+            if (m_ready)
             {
-                if (m_rootAgents.ContainsKey(avatar.UUID))
+                List<ScenePresence> avatars = m_scene.GetAvatars();
+
+                if (avatars.Count > 0)
                 {
-                    if (m_rootAgents[avatar.UUID] == avatar.RegionHandle)
+                    // Ask wind plugin to generate a LL wind array to be cached locally
+                    // Try not to update this too often, as it may involve array copies
+                    if (m_frame >= (m_frameLastUpdateClientArray + m_frameUpdateRate))
+                    {
+                        windSpeeds = m_activeWindPlugin.WindLLClientArray();
+                        m_frameLastUpdateClientArray = m_frame;
+                    }
+
+                    foreach (ScenePresence avatar in avatars)
                     {
-                        m_rootAgents.Remove(avatar.UUID);
+                        if (!avatar.IsChildAgent)
+                            avatar.ControllingClient.SendWindData(windSpeeds);
                     }
                 }
             }
         }
+        /// <summary>
+        /// Calculate the sun's orbital position and its velocity.
+        /// </summary>
+
+        private void GenWindPos()
+        {
+            if( m_activeWindPlugin != null )
+            {
+                // Tell Wind Plugin to update it's wind data
+                m_activeWindPlugin.WindUpdate(m_frame);
+            }
+        }
+
+
+
     }
 }