From d917010433dda944dd1f6a7afcb827937804e805 Mon Sep 17 00:00:00 2001
From: Justin Clark-Casey (justincc)
Date: Sat, 30 Jul 2011 03:11:36 +0100
Subject: minor: Add method doc to collision subscription methods.  Change
 method case to reflect OpenSim standards.

---
 OpenSim/Region/Physics/OdePlugin/ODECharacter.cs |  7 +++++--
 OpenSim/Region/Physics/OdePlugin/ODEPrim.cs      |  4 ++--
 OpenSim/Region/Physics/OdePlugin/OdeScene.cs     | 22 +++++++++++++++++++---
 3 files changed, 26 insertions(+), 7 deletions(-)

(limited to 'OpenSim/Region/Physics')

diff --git a/OpenSim/Region/Physics/OdePlugin/ODECharacter.cs b/OpenSim/Region/Physics/OdePlugin/ODECharacter.cs
index 6b74e74..7766691 100644
--- a/OpenSim/Region/Physics/OdePlugin/ODECharacter.cs
+++ b/OpenSim/Region/Physics/OdePlugin/ODECharacter.cs
@@ -1220,14 +1220,16 @@ namespace OpenSim.Region.Physics.OdePlugin
         {
             m_requestedUpdateFrequency = ms;
             m_eventsubscription = ms;
-            _parent_scene.addCollisionEventReporting(this);
+            _parent_scene.AddCollisionEventReporting(this);
         }
+
         public override void UnSubscribeEvents()
         {
-            _parent_scene.remCollisionEventReporting(this);
+            _parent_scene.RemoveCollisionEventReporting(this);
             m_requestedUpdateFrequency = 0;
             m_eventsubscription = 0;
         }
+        
         public void AddCollisionEvent(uint CollidedWith, ContactPoint contact)
         {
             if (m_eventsubscription > 0)
@@ -1248,6 +1250,7 @@ namespace OpenSim.Region.Physics.OdePlugin
                 m_eventsubscription = 0;
             }
         }
+
         public override bool SubscribedEvents()
         {
             if (m_eventsubscription > 0)
diff --git a/OpenSim/Region/Physics/OdePlugin/ODEPrim.cs b/OpenSim/Region/Physics/OdePlugin/ODEPrim.cs
index b3045bd..34c0deb 100644
--- a/OpenSim/Region/Physics/OdePlugin/ODEPrim.cs
+++ b/OpenSim/Region/Physics/OdePlugin/ODEPrim.cs
@@ -2986,12 +2986,12 @@ Console.WriteLine("changeshape not need meshing");
         public override void SubscribeEvents(int ms)
         {
             m_eventsubscription = ms;
-            _parent_scene.addCollisionEventReporting(this);
+            _parent_scene.AddCollisionEventReporting(this);
         }
 
         public override void UnSubscribeEvents()
         {
-            _parent_scene.remCollisionEventReporting(this);
+            _parent_scene.RemoveCollisionEventReporting(this);
             m_eventsubscription = 0;
         }
 
diff --git a/OpenSim/Region/Physics/OdePlugin/OdeScene.cs b/OpenSim/Region/Physics/OdePlugin/OdeScene.cs
index cd2b156..e1e031f 100644
--- a/OpenSim/Region/Physics/OdePlugin/OdeScene.cs
+++ b/OpenSim/Region/Physics/OdePlugin/OdeScene.cs
@@ -198,7 +198,12 @@ namespace OpenSim.Region.Physics.OdePlugin
         private readonly List<OdePrim> _taintedPrimL = new List<OdePrim>();
         private readonly HashSet<OdeCharacter> _taintedActors = new HashSet<OdeCharacter>();
         private readonly List<d.ContactGeom> _perloopContact = new List<d.ContactGeom>();
+
+        /// <summary>
+        /// A list of actors that should receive collision events.
+        /// </summary>
         private readonly List<PhysicsActor> _collisionEventPrim = new List<PhysicsActor>();
+        
         private readonly HashSet<OdeCharacter> _badCharacter = new HashSet<OdeCharacter>();
         public Dictionary<IntPtr, String> geom_name_map = new Dictionary<IntPtr, String>();
         public Dictionary<IntPtr, PhysicsActor> actor_name_map = new Dictionary<IntPtr, PhysicsActor>();
@@ -1604,7 +1609,11 @@ namespace OpenSim.Region.Physics.OdePlugin
         } 
 // End recovered. Kitto Flora
 
-        public void addCollisionEventReporting(PhysicsActor obj)
+        /// <summary>
+        /// Add actor to the list that should receive collision events in the simulate loop.
+        /// </summary>
+        /// <param name="obj"></param>
+        public void AddCollisionEventReporting(PhysicsActor obj)
         {
             lock (_collisionEventPrim)
             {
@@ -1613,7 +1622,11 @@ namespace OpenSim.Region.Physics.OdePlugin
             }
         }
 
-        public void remCollisionEventReporting(PhysicsActor obj)
+        /// <summary>
+        /// Remove actor from the list that should receive collision events in the simulate loop.
+        /// </summary>
+        /// <param name="obj"></param>
+        public void RemoveCollisionEventReporting(PhysicsActor obj)
         {
             lock (_collisionEventPrim)
             {
@@ -2132,7 +2145,7 @@ namespace OpenSim.Region.Physics.OdePlugin
 //Console.WriteLine("RemovePrimThreadLocked " +  prim.m_primName);
             lock (prim)
             {
-                remCollisionEventReporting(prim);
+                RemoveCollisionEventReporting(prim);
                 lock (ode)
                 {
                     if (prim.prim_geom != IntPtr.Zero)
@@ -2792,6 +2805,8 @@ Console.WriteLine("AddPhysicsActorTaint to " + taintedprim.Name);
                                 if (obj == null)
                                     continue;
 
+//                                m_log.DebugFormat("[PHYSICS]: Assessing {0} for collision events", obj.SOPName);
+
                                 switch ((ActorTypes)obj.PhysicsActorType)
                                 {
                                     case ActorTypes.Agent:
@@ -2799,6 +2814,7 @@ Console.WriteLine("AddPhysicsActorTaint to " + taintedprim.Name);
                                         cobj.AddCollisionFrameTime(100);
                                         cobj.SendCollisions();
                                         break;
+
                                     case ActorTypes.Prim:
                                         OdePrim pobj = (OdePrim)obj;
                                         pobj.SendCollisions();
-- 
cgit v1.1