* refactor: Move tree code out into a separate module

5 files changed, 215 insertions, 57 deletions

diff --git a/OpenSim/Region/Environment/Interfaces/IVegetationModule.cs b/OpenSim/Region/Environment/Interfaces/IVegetationModule.cs
new file mode 100644
index 0000000..c411993
--- /dev/null
+++ b/OpenSim/Region/Environment/Interfaces/IVegetationModule.cs
@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) Contributors, http://opensimulator.org/
+ * See CONTRIBUTORS.TXT for a full list of copyright holders.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of the OpenSim Project nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+using OpenMetaverse;
+using OpenSim.Region.Environment.Scenes;
+
+namespace OpenSim.Region.Environment.Interfaces
+{        
+    public interface IVegetationModule : IEntityCreator
+    {
+        /// <summary>
+        /// Add a new tree to the scene.  Used by other modules.
+        /// </summary>
+        /// <param name="uuid"></param>
+        /// <param name="groupID"></param>
+        /// <param name="scale"></param>
+        /// <param name="rotation"></param>
+        /// <param name="position"></param>
+        /// <param name="treeType"></param>
+        /// <param name="newTree"></param>
+        /// <returns></returns>
+        SceneObjectGroup AddTree(
+            UUID uuid, UUID groupID, Vector3 scale, Quaternion rotation, Vector3 position, Tree treeType, bool newTree);        
+    }
+}
diff --git a/OpenSim/Region/Environment/Modules/Avatar/Gestures/GesturesModule.cs b/OpenSim/Region/Environment/Modules/Avatar/Gestures/GesturesModule.cs
index 5f0f4f9..a86fceb 100644
--- a/OpenSim/Region/Environment/Modules/Avatar/Gestures/GesturesModule.cs
+++ b/OpenSim/Region/Environment/Modules/Avatar/Gestures/GesturesModule.cs
@@ -74,7 +74,7 @@ namespace OpenSim.Region.Environment.Modules.Avatar.Gestures
                 m_log.ErrorFormat("[GESTURES]: Unable to find user {0}", client.Name);
         }
 
-        public virtual void DeactivateGesture(IClientAPI client,  UUID gestureId)
+        public virtual void DeactivateGesture(IClientAPI client, UUID gestureId)
         {
             CachedUserInfo userInfo = m_scene.CommsManager.UserProfileCacheService.GetUserDetails(client.AgentId);
 
diff --git a/OpenSim/Region/Environment/Modules/World/TreePopulator/TreePopulatorModule.cs b/OpenSim/Region/Environment/Modules/World/TreePopulator/TreePopulatorModule.cs
index 990d36e..8061648 100644
--- a/OpenSim/Region/Environment/Modules/World/TreePopulator/TreePopulatorModule.cs
+++ b/OpenSim/Region/Environment/Modules/World/TreePopulator/TreePopulatorModule.cs
@@ -233,13 +233,15 @@ namespace OpenSim.Region.Environment.Modules.World.TreePopulator
         {
             position.Z = (float) m_scene.Heightmap[(int) position.X, (int) position.Y];
 
-            SceneObjectGroup tree =
-                m_scene.AddTree(uuid, UUID.Zero, new Vector3(0.1f, 0.1f, 0.1f),
-                                Quaternion.Identity,
-                                position,
-                                Tree.Cypress1,
-                                false);
-
+            IVegetationModule module = m_scene.RequestModuleInterface<IVegetationModule>();
+            
+            if (null == module)
+                return;
+            
+            SceneObjectGroup tree 
+                = module.AddTree(
+                    uuid, UUID.Zero, new Vector3(0.1f, 0.1f, 0.1f), Quaternion.Identity, position, Tree.Cypress1, false);
+            
             m_trees.Add(tree.UUID);
             tree.SendGroupFullUpdate();
         }
diff --git a/OpenSim/Region/Environment/Modules/World/Vegetation/VegetationModule.cs b/OpenSim/Region/Environment/Modules/World/Vegetation/VegetationModule.cs
new file mode 100644
index 0000000..a1c2192
--- /dev/null
+++ b/OpenSim/Region/Environment/Modules/World/Vegetation/VegetationModule.cs
@@ -0,0 +1,118 @@
+/*
+ * Copyright (c) Contributors, http://opensimulator.org/
+ * See CONTRIBUTORS.TXT for a full list of copyright holders.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of the OpenSim Project nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+using System;
+using System.Reflection;
+using log4net;
+using Nini.Config;
+using OpenMetaverse;
+using OpenSim.Framework;
+using OpenSim.Framework.Communications;
+using OpenSim.Framework.Communications.Cache;
+using OpenSim.Region.Environment.Interfaces;
+using OpenSim.Region.Environment.Scenes;
+
+namespace OpenSim.Region.Environment.Modules.Avatar.Vegetation
+{
+    public class VegetationModule : IRegionModule, IVegetationModule
+    { 
+        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+        
+        protected Scene m_scene;
+        
+        protected static readonly PCode[] creationCapabilities = new PCode[] { PCode.Grass, PCode.NewTree, PCode.Tree };
+        public PCode[] CreationCapabilities { get { return creationCapabilities; } }            
+        
+        public void Initialise(Scene scene, IConfigSource source)
+        {
+            m_scene = scene;
+            m_scene.RegisterModuleInterface<IVegetationModule>(this);
+        }
+        
+        public void PostInitialise() {}
+        public void Close() {}
+        public string Name { get { return "Vegetation Module"; } }
+        public bool IsSharedModule { get { return false; } }
+
+        public SceneObjectGroup AddTree(
+            UUID uuid, UUID groupID, Vector3 scale, Quaternion rotation, Vector3 position, Tree treeType, bool newTree)
+        {
+            PrimitiveBaseShape treeShape = new PrimitiveBaseShape();
+            treeShape.PathCurve = 16;
+            treeShape.PathEnd = 49900;
+            treeShape.PCode = newTree ? (byte)PCode.NewTree : (byte)PCode.Tree;
+            treeShape.Scale = scale;
+            treeShape.State = (byte)treeType;
+            
+            return m_scene.AddNewPrim(uuid, groupID, position, rotation, treeShape);
+        }
+        
+        public SceneObjectGroup CreateEntity(
+            UUID ownerID, UUID groupID, Vector3 pos, Quaternion rot, PrimitiveBaseShape shape)
+        {
+            if (Array.IndexOf(creationCapabilities, (PCode)shape.PCode) < 0)
+            {    
+                m_log.DebugFormat("[VEGETATION]: PCode {0} not handled by {1}", shape.PCode, Name);
+                return null;
+            }
+            
+            SceneObjectGroup sceneObject = new SceneObjectGroup(ownerID, pos, rot, shape);
+            SceneObjectPart rootPart = sceneObject.GetChildPart(sceneObject.UUID);
+            
+            // if grass or tree, make phantom
+            //rootPart.TrimPermissions();
+            rootPart.AddFlag(PrimFlags.Phantom);
+            if (rootPart.Shape.PCode != (byte)PCode.Grass)
+                AdaptTree(ref shape);
+            
+            m_scene.AddNewSceneObject(sceneObject, true);
+            sceneObject.SetGroup(groupID, null);
+            
+            return sceneObject;
+        }
+        
+        protected void AdaptTree(ref PrimitiveBaseShape tree)
+        {
+            // Tree size has to be adapted depending on its type
+            switch ((Tree)tree.State)
+            {
+                case Tree.Cypress1:
+                case Tree.Cypress2:
+                    tree.Scale = new Vector3(4, 4, 10);
+                    break;
+
+                // case... other tree types
+                // tree.Scale = new Vector3(?, ?, ?);
+                // break;
+
+                default:
+                    tree.Scale = new Vector3(4, 4, 4);
+                    break;
+            }
+        }        
+    }
+}
diff --git a/OpenSim/Region/Environment/Scenes/Scene.cs b/OpenSim/Region/Environment/Scenes/Scene.cs
index 72748b6..eecfd70 100644
--- a/OpenSim/Region/Environment/Scenes/Scene.cs
+++ b/OpenSim/Region/Environment/Scenes/Scene.cs
@@ -6,7 +6,7 @@
  * modification, are permitted provided that the following conditions are met:
  *     * Redistributions of source code must retain the above copyright
  *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
+ *     * Redistributions in binary form must reproduce the above copyrightD
  *       notice, this list of conditions and the following disclaimer in the
  *       documentation and/or other materials provided with the distribution.
  *     * Neither the name of the OpenSim Project nor the
@@ -259,6 +259,11 @@ namespace OpenSim.Region.Environment.Scenes
         }
 
         public int objectCapacity = 45000;
+        
+        /// <value>
+        /// Registered classes that are capable of creating entities.
+        /// </value>       
+        protected Dictionary<PCode, IEntityCreator> m_entityCreators = new Dictionary<PCode, IEntityCreator>();
 
         #endregion
 
@@ -1753,63 +1758,24 @@ namespace OpenSim.Region.Environment.Scenes
             }
         }
 
-        public virtual SceneObjectGroup AddNewPrim(UUID ownerID, UUID groupID, Vector3 pos, Quaternion rot, PrimitiveBaseShape shape)
+        public virtual SceneObjectGroup AddNewPrim(
+            UUID ownerID, UUID groupID, Vector3 pos, Quaternion rot, PrimitiveBaseShape shape)
         {
             //m_log.DebugFormat(
-            //    "[SCENE]: Scene.AddNewPrim() called for agent {0} in {1}", ownerID, RegionInfo.RegionName);
+            //    "[SCENE]: Scene.AddNewPrim() pcode {0} called for {1} in {2}", shape.PCode, ownerID, RegionInfo.RegionName);
+            
+            // If an entity creator has been registered for this prim type then use that
+            if (m_entityCreators.ContainsKey((PCode)shape.PCode))
+                return m_entityCreators[(PCode)shape.PCode].CreateEntity(ownerID, groupID, pos, rot, shape);
 
+            // Otherwise, use this default creation code;
             SceneObjectGroup sceneObject = new SceneObjectGroup(ownerID, pos, rot, shape);
-
-            SceneObjectPart rootPart = sceneObject.GetChildPart(sceneObject.UUID);
-            // if grass or tree, make phantom
-            //rootPart.TrimPermissions();
-            if ((rootPart.Shape.PCode == (byte)PCode.Grass) 
-                || (rootPart.Shape.PCode == (byte)PCode.Tree) || (rootPart.Shape.PCode == (byte)PCode.NewTree))
-            {
-                rootPart.AddFlag(PrimFlags.Phantom);
-                //rootPart.ObjectFlags += (uint)PrimFlags.Phantom;
-                if (rootPart.Shape.PCode != (byte)PCode.Grass)
-                    AdaptTree(ref shape);
-            }
-
             AddNewSceneObject(sceneObject, true);
             sceneObject.SetGroup(groupID, null);
 
             return sceneObject;
         }
 
-        protected void AdaptTree(ref PrimitiveBaseShape tree)
-        {
-            // Tree size has to be adapted depending on its type
-            switch ((Tree)tree.State)
-            {
-                case Tree.Cypress1:
-                case Tree.Cypress2:
-                    tree.Scale = new Vector3(4, 4, 10);
-                    break;
-
-                // case... other tree types
-                // tree.Scale = new Vector3(?, ?, ?);
-                // break;
-
-                default:
-                    tree.Scale = new Vector3(4, 4, 4);
-                    break;
-            }
-        }
-
-        public SceneObjectGroup AddTree(UUID uuid, UUID groupID, Vector3 scale, Quaternion rotation, Vector3 position,
-                                        Tree treeType, bool newTree)
-        {
-            PrimitiveBaseShape treeShape = new PrimitiveBaseShape();
-            treeShape.PathCurve = 16;
-            treeShape.PathEnd = 49900;
-            treeShape.PCode = newTree ? (byte)PCode.NewTree : (byte)PCode.Tree;
-            treeShape.Scale = scale;
-            treeShape.State = (byte)treeType;
-            return AddNewPrim(uuid, groupID, position, rotation, treeShape);
-        }
-
         /// <summary>
         /// Add an object into the scene that has come from storage
         /// </summary>
@@ -3299,6 +3265,15 @@ namespace OpenSim.Region.Environment.Scenes
                 List<Object> l = new List<Object>();
                 l.Add(mod);
                 ModuleInterfaces.Add(typeof(M), l);
+
+                if (mod is IEntityCreator)
+                {
+                    IEntityCreator entityCreator = (IEntityCreator)mod;
+                    foreach (PCode pcode in entityCreator.CreationCapabilities)
+                    {
+                        m_entityCreators[pcode] = entityCreator;
+                    }
+                }
             }
         }
 
@@ -3314,13 +3289,23 @@ namespace OpenSim.Region.Environment.Scenes
                 return;
 
             l.Add(mod);
+            
+            if (mod is IEntityCreator)
+            {
+                IEntityCreator entityCreator = (IEntityCreator)mod;
+                foreach (PCode pcode in entityCreator.CreationCapabilities)
+                {
+                    m_entityCreators[pcode] = entityCreator;
+                }
+            }
+            
             ModuleInterfaces[typeof(M)] = l;
         }
 
         /// <summary>
         /// For the given interface, retrieve the region module which implements it.
         /// </summary>
-        /// <returns>null if there is no module implementing that interface</returns>
+        /// <returns>null if there is no registered module implementing that interface</returns>
         public override T RequestModuleInterface<T>()
         {
             if (ModuleInterfaces.ContainsKey(typeof(T)))
@@ -3333,6 +3318,10 @@ namespace OpenSim.Region.Environment.Scenes
             }
         }
 
+        /// <summary>
+        /// For the given interface, retrieve an array of region modules that implement it.
+        /// </summary>
+        /// <returns>an empty array if there are no registered modules implementing that interface</returns>        
         public override T[] RequestModuleInterfaces<T>()
         {
             if (ModuleInterfaces.ContainsKey(typeof(T)))