BulletSim: add initial instance of the ExtendedPhysics region module which adds new LSL commands for extended physics functions. Uses the modInvoke system. Disabled by default.

OpenSim/Region/OptionalModules/Scripting/ExtendedPhysics/ExtendedPhysics.cs

@@ -0,0 +1,163 @@
+/*
+ * 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 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 OpenSimulator 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.Collections.Generic;
+using System.Linq;
+using System.Reflection;
+using System.Text;
+
+using OpenSim.Framework;
+using OpenSim.Region.Framework;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.Framework.Scenes;
+using OpenSim.Region.CoreModules;
+
+using Mono.Addins;
+using Nini.Config;
+using log4net;
+using OpenMetaverse;
+
+namespace OpenSim.Region.OptionalModules.Scripting
+{
+[Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule")]
+public class ExtendedPhysics : INonSharedRegionModule
+{
+    private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+    private static string LogHeader = "[EXTENDED PHYSICS]";
+
+    private IConfig Configuration { get; set; }
+    private bool Enabled { get; set; }
+    private Scene BaseScene { get; set; }
+    private IScriptModuleComms Comms { get; set; }
+
+    #region INonSharedRegionModule
+
+    public string Name { get { return this.GetType().Name; } }
+
+    public void Initialise(IConfigSource config)
+    {
+        BaseScene = null;
+        Enabled = false;
+        Configuration = null;
+        Comms = null;
+
+        try
+        {
+            if ((Configuration = config.Configs["ExtendedPhysics"]) != null)
+            {
+                Enabled = Configuration.GetBoolean("Enabled", Enabled);
+            }
+        }
+        catch (Exception e)
+        {
+            m_log.ErrorFormat("{0} Initialization error: {0}", LogHeader, e);
+        }
+
+        m_log.ErrorFormat("{0} module {1} enabled", LogHeader, (Enabled ? "is" : "is not"));
+    }
+
+    public void Close()
+    {
+        if (BaseScene != null)
+        {
+            BaseScene.EventManager.OnSceneObjectPartUpdated -= EventManager_OnSceneObjectPartUpdated;
+            BaseScene = null;
+        }
+    }
+
+    public void AddRegion(Scene scene)
+    {
+    }
+
+    public void RemoveRegion(Scene scene)
+    {
+        if (BaseScene != null && BaseScene == scene)
+        {
+            Close();
+        }
+    }
+
+    public void RegionLoaded(Scene scene)
+    {
+        if (!Enabled) return;
+
+        BaseScene = scene;
+
+        Comms = BaseScene.RequestModuleInterface<IScriptModuleComms>();
+        if (Comms == null)
+        {
+            m_log.WarnFormat("{0} ScriptModuleComms interface not defined", LogHeader);
+            Enabled = false;
+
+            return;
+        }
+ 
+        // Register as LSL functions all the [ScriptInvocation] marked methods.
+        Comms.RegisterScriptInvocations(this);
+
+        // When an object is modified, we might need to update its extended physics parameters
+        BaseScene.EventManager.OnSceneObjectPartUpdated += EventManager_OnSceneObjectPartUpdated;
+    }
+
+    public Type ReplaceableInterface { get { return null; } }
+
+    #endregion // INonSharedRegionModule
+
+    // Event generated when some property of a prim changes.
+    private void EventManager_OnSceneObjectPartUpdated(SceneObjectPart sop, bool isFullUpdate)
+    {
+    }
+
+    [ScriptConstant]
+    public static int PHYS_CENTER_OF_MASS =     1 << 0;
+
+    [ScriptConstant]
+    public static int PHYS_LINKSET_TYPE_CONSTRAINT  = 1;
+    [ScriptConstant]
+    public static int PHYS_LINKSET_TYPE_COMPOUND    = 2;
+    [ScriptConstant]
+    public static int PHYS_LINKSET_TYPE_MANUAL      = 3;
+
+    [ScriptInvocation]
+    public string physGetEngineType(UUID hostID, UUID scriptID)
+    {
+        string ret = string.Empty;
+
+        if (BaseScene.PhysicsScene != null)
+        {
+            ret = BaseScene.PhysicsScene.EngineType;
+        }
+
+        return ret;
+    }
+
+    [ScriptInvocation]
+    public void physSetLinksetType(UUID hostID, UUID scriptID, int linksetType)
+    {
+    }
+}
+}