Mantis#2796. Thank you kindly, Gerhard for a patch that addresses:

On a call of llVolumeDetect(1) (or any other number !=0) volume 
detection is enabled. Together with VD, the phantom flag is set to the GUI.
On a call of llVolumeDetect(0), vd detection is switched of again, 
also the phantom state is removed. On a call to llSetState(STATE_PHANTOM, 
false) while VD is active, also VD is switched off. The same is true for 
unchecking the phantom flag via GUI. This allows to take back VD without 
the need to script just by removing the phantom flag.
Things missing in this patch: persistance of the volume-detection flag. 
This needs more discussion and will be included in another patch soon.

3 files changed, 113 insertions, 21 deletions

diff --git a/OpenSim/Region/Environment/Scenes/SceneGraph.cs b/OpenSim/Region/Environment/Scenes/SceneGraph.cs
index b373c09..d261e2d 100644
--- a/OpenSim/Region/Environment/Scenes/SceneGraph.cs
+++ b/OpenSim/Region/Environment/Scenes/SceneGraph.cs
@@ -1203,6 +1203,8 @@ namespace OpenSim.Region.Environment.Scenes
         /// <param name="localID"></param>
         /// <param name="packet"></param>
         /// <param name="remoteClient"></param>
+        /// This routine seems to get called when a user changes object settings in the viewer.
+        /// If some one can confirm that, please change the comment according.
         protected internal void UpdatePrimFlags(uint localID, bool UsePhysics, bool IsTemporary, bool IsPhantom, IClientAPI remoteClient)
         {
             SceneObjectGroup group = GetGroupByPrim(localID);
@@ -1210,7 +1212,7 @@ namespace OpenSim.Region.Environment.Scenes
             {
                 if (m_parentScene.Permissions.CanEditObject(group.UUID, remoteClient.AgentId))
                 {
-                    group.UpdatePrimFlags(localID, UsePhysics, IsTemporary, IsPhantom);
+                    group.UpdatePrimFlags(localID, UsePhysics, IsTemporary, IsPhantom, false); // VolumeDetect can't be set via UI and will always be off when a change is made there
                 }
             }
         }
diff --git a/OpenSim/Region/Environment/Scenes/SceneObjectGroup.cs b/OpenSim/Region/Environment/Scenes/SceneObjectGroup.cs
index 5456282..f4ccc46 100644
--- a/OpenSim/Region/Environment/Scenes/SceneObjectGroup.cs
+++ b/OpenSim/Region/Environment/Scenes/SceneObjectGroup.cs
@@ -1431,21 +1431,45 @@ namespace OpenSim.Region.Environment.Scenes
         {
             bool IsTemporary = ((RootPart.Flags & PrimFlags.TemporaryOnRez) != 0);
             bool IsPhantom = ((RootPart.Flags & PrimFlags.Phantom) != 0);
-            UpdatePrimFlags(RootPart.LocalId, UsePhysics, IsTemporary, IsPhantom);
+            bool IsVolumeDetect = RootPart.VolumeDetectActive;
+            UpdatePrimFlags(RootPart.LocalId, UsePhysics, IsTemporary, IsPhantom, IsVolumeDetect);
         }
 
         public void ScriptSetTemporaryStatus(bool TemporaryStatus)
         {
             bool UsePhysics = ((RootPart.Flags & PrimFlags.Physics) != 0);
             bool IsPhantom = ((RootPart.Flags & PrimFlags.Phantom) != 0);
-            UpdatePrimFlags(RootPart.LocalId, UsePhysics, TemporaryStatus, IsPhantom);
+            bool IsVolumeDetect = RootPart.VolumeDetectActive;
+            UpdatePrimFlags(RootPart.LocalId, UsePhysics, TemporaryStatus, IsPhantom, IsVolumeDetect);
         }
 
         public void ScriptSetPhantomStatus(bool PhantomStatus)
         {
             bool UsePhysics = ((RootPart.Flags & PrimFlags.Physics) != 0);
             bool IsTemporary = ((RootPart.Flags & PrimFlags.TemporaryOnRez) != 0);
-            UpdatePrimFlags(RootPart.LocalId, UsePhysics, IsTemporary, PhantomStatus);
+            bool IsVolumeDetect = RootPart.VolumeDetectActive;
+            UpdatePrimFlags(RootPart.LocalId, UsePhysics, IsTemporary, PhantomStatus, IsVolumeDetect);
+        }
+
+        public void ScriptSetVolumeDetect(bool VDStatus)
+        {
+            bool UsePhysics = ((RootPart.Flags & PrimFlags.Physics) != 0);
+            bool IsTemporary = ((RootPart.Flags & PrimFlags.TemporaryOnRez) != 0);
+            bool IsPhantom = ((RootPart.Flags & PrimFlags.Phantom) != 0);
+            UpdatePrimFlags(RootPart.LocalId, UsePhysics, IsTemporary, IsPhantom, VDStatus);
+
+            /*
+            ScriptSetPhantomStatus(false);  // What ever it was before, now it's not phantom anymore
+
+            if (PhysActor != null) // Should always be the case now
+            {
+                PhysActor.SetVolumeDetect(param);
+            }
+            if (param != 0)
+                AddFlag(PrimFlags.Phantom);
+
+            ScheduleFullUpdate();
+            */
         }
 
         public void applyImpulse(PhysicsVector impulse)
@@ -2251,7 +2275,7 @@ namespace OpenSim.Region.Environment.Scenes
         /// <param name="type"></param>
         /// <param name="inUse"></param>
         /// <param name="data"></param>
-        public void UpdatePrimFlags(uint localID, bool UsePhysics, bool IsTemporary, bool IsPhantom)
+        public void UpdatePrimFlags(uint localID, bool UsePhysics, bool IsTemporary, bool IsPhantom, bool IsVolumeDetect)
         {
             SceneObjectPart selectionPart = GetChildPart(localID);
 
@@ -2279,7 +2303,7 @@ namespace OpenSim.Region.Environment.Scenes
 
                     foreach (SceneObjectPart part in m_parts.Values)
                     {
-                        part.UpdatePrimFlags(UsePhysics, IsTemporary, IsPhantom);
+                        part.UpdatePrimFlags(UsePhysics, IsTemporary, IsPhantom, IsVolumeDetect);
                     }
                 }
             }
diff --git a/OpenSim/Region/Environment/Scenes/SceneObjectPart.cs b/OpenSim/Region/Environment/Scenes/SceneObjectPart.cs
index 6b4d47a..0315c92 100644
--- a/OpenSim/Region/Environment/Scenes/SceneObjectPart.cs
+++ b/OpenSim/Region/Environment/Scenes/SceneObjectPart.cs
@@ -167,7 +167,11 @@ namespace OpenSim.Region.Environment.Scenes
         
         [XmlIgnore]
         public PhysicsVector RotationAxis = new PhysicsVector(1f,1f,1f);
-        
+
+        [XmlIgnore]
+        public bool VolumeDetectActive = false; // XmlIgnore set to avoid problems with persistance until I come to care for this
+                                                // Certainly this must be a persistant setting finally
+
         /// <summary>
         /// This part's inventory
         /// </summary>
@@ -2178,6 +2182,16 @@ if (m_shape != null) {
                 m_parentGroup.ScriptSetPhysicsStatus(UsePhysics);
         }
 
+        public void ScriptSetVolumeDetect(bool SetVD)
+        {
+
+            if (m_parentGroup != null)
+            {
+                m_parentGroup.ScriptSetVolumeDetect(SetVD);
+            }
+        }
+
+
         public void SculptTextureCallback(UUID textureID, AssetBase texture)
         {
             if (m_shape.SculptEntry)
@@ -2484,14 +2498,6 @@ if (m_shape != null) {
             }
         }
 
-        public void SetVolumeDetect(int param)
-        {
-            if (PhysActor != null)
-            {
-                PhysActor.SetVolumeDetect(param);
-            }
-        }
-
         public void SetGroup(UUID groupID, IClientAPI client)
         {
             _groupID = groupID;
@@ -3184,17 +3190,46 @@ if (m_shape != null) {
             }
         }
 
-        public void UpdatePrimFlags(bool UsePhysics, bool IsTemporary, bool IsPhantom)
+        public void UpdatePrimFlags(bool UsePhysics, bool IsTemporary, bool IsPhantom, bool IsVD)
         {
             bool wasUsingPhysics = ((ObjectFlags & (uint) PrimFlags.Physics) != 0);
             bool wasTemporary = ((ObjectFlags & (uint)PrimFlags.TemporaryOnRez) != 0);
             bool wasPhantom = ((ObjectFlags & (uint)PrimFlags.Phantom) != 0);
+            bool wasVD = VolumeDetectActive;
 
-            if ((UsePhysics == wasUsingPhysics) && (wasTemporary == IsTemporary) && (wasPhantom == IsPhantom))
+            if ((UsePhysics == wasUsingPhysics) && (wasTemporary == IsTemporary) && (wasPhantom == IsPhantom) && (IsVD==wasVD) )
             {
                 return;
             }
 
+            // Special cases for VD. VD can only be called from a script 
+            // and can't be combined with changes to other states. So we can rely
+            // that...
+            // ... if VD is changed, all others are not.
+            // ... if one of the others is changed, VD is not.
+            if (IsVD) // VD is active, special logic applies
+            {
+                // State machine logic for VolumeDetect
+                // More logic below
+                bool phanReset = (IsPhantom != wasPhantom) && !IsPhantom;
+
+                if (phanReset) // Phantom changes from on to off switch VD off too
+                {
+                    IsVD = false;               // Switch it of for the course of this routine
+                    VolumeDetectActive = false; // and also permanently
+                    if (PhysActor != null)
+                        PhysActor.SetVolumeDetect(0);   // Let physics know about it too
+                }
+                else
+                {
+                    IsPhantom = false;  
+                    // If volumedetect is active we don't want phantom to be applied.
+                    // If this is a new call to VD out of the state "phantom"
+                    // this will also cause the prim to be visible to physics
+                }
+
+            }
+
             if (UsePhysics)
             {
                 AddFlag(PrimFlags.Physics);
@@ -3222,6 +3257,7 @@ if (m_shape != null) {
                 }
             }
 
+            
             if (IsPhantom || IsAttachment)
             {
                 AddFlag(PrimFlags.Phantom);
@@ -3232,11 +3268,13 @@ if (m_shape != null) {
                     PhysActor = null;
                 }
             }
-            else
+            else // Not phantom
             {
                 RemFlag(PrimFlags.Phantom);
+
                 if (PhysActor == null)
                 {
+                    // It's not phantom anymore. So make sure the physics engine get's knowledge of it
                     PhysActor = m_parentGroup.Scene.PhysicsScene.AddPrimShape(
                         Name,
                         Shape,
@@ -3261,10 +3299,11 @@ if (m_shape != null) {
                         }
                     }
                 }
-                else
+                else // it already has a physical representation
                 {
-                    PhysActor.IsPhysical = UsePhysics;
-                    DoPhysicsPropertyUpdate(UsePhysics, false);
+                    PhysActor.IsPhysical = UsePhysics;                    
+
+                    DoPhysicsPropertyUpdate(UsePhysics, false); // Update physical status. If it's phantom this will remove the prim
                     if (m_parentGroup != null)
                     {
                         if (!m_parentGroup.IsDeleted)
@@ -3278,6 +3317,32 @@ if (m_shape != null) {
                 }
             }
 
+            if (IsVD)
+            {
+                // If the above logic worked (this is urgent candidate to unit tests!)
+                // we now have a physicsactor.
+                // Defensive programming calls for a check here.
+                // Better would be throwing an exception that could be catched by a unit test as the internal 
+                // logic should make sure, this Physactor is always here.
+                if (this.PhysActor != null)
+                {
+                    PhysActor.SetVolumeDetect(1);
+                    AddFlag(PrimFlags.Phantom); // We set this flag also if VD is active
+                    this.VolumeDetectActive = true;
+                }
+
+            }
+            else
+            {   // Remove VolumeDetect in any case. Note, it's safe to call SetVolumeDetect as often as you like
+                // (mumbles, well, at least if you have infinte CPU powers :-) )
+                if (this.PhysActor != null)
+                {
+                    PhysActor.SetVolumeDetect(0);
+                }
+                this.VolumeDetectActive = false;
+            }
+
+
             if (IsTemporary)
             {
                 AddFlag(PrimFlags.TemporaryOnRez);
@@ -3287,6 +3352,7 @@ if (m_shape != null) {
                 RemFlag(PrimFlags.TemporaryOnRez);
             }
             //            System.Console.WriteLine("Update:  PHY:" + UsePhysics.ToString() + ", T:" + IsTemporary.ToString() + ", PHA:" + IsPhantom.ToString() + " S:" + CastsShadows.ToString());
+
             ParentGroup.HasGroupChanged = true;
             ScheduleFullUpdate();
         }