From abd5d1f7470ba07b784c6dbad4cdcdeaedc58d37 Mon Sep 17 00:00:00 2001
From: John Hurliman
Date: Fri, 21 May 2010 14:04:10 -0700
Subject: * Added code comments to Prioritizer.cs that document how to add a
 new update priority policy

---
 OpenSim/Region/Framework/Scenes/Prioritizer.cs | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

(limited to 'OpenSim/Region')

diff --git a/OpenSim/Region/Framework/Scenes/Prioritizer.cs b/OpenSim/Region/Framework/Scenes/Prioritizer.cs
index af25014..e6a4642 100644
--- a/OpenSim/Region/Framework/Scenes/Prioritizer.cs
+++ b/OpenSim/Region/Framework/Scenes/Prioritizer.cs
@@ -5,6 +5,18 @@ using Nini.Config;
 using OpenSim.Framework;
 using OpenMetaverse;
 
+/*
+ * Steps to add a new prioritization policy:
+ * 
+ *  - Add a new value to the UpdatePrioritizationSchemes enum.
+ *  - Specify this new value in the [InterestManagement] section of your
+ *    OpenSim.ini. The name in the config file must match the enum value name
+ *    (although it is not case sensitive).
+ *  - Write a new GetPriorityBy*() method in this class.
+ *  - Add a new entry to the switch statement in GetUpdatePriority() that calls
+ *    your method.
+ */
+
 namespace OpenSim.Region.Framework.Scenes
 {
     public enum UpdatePrioritizationSchemes
@@ -35,7 +47,7 @@ namespace OpenSim.Region.Framework.Scenes
                 case UpdatePrioritizationSchemes.Distance:
                     return GetPriorityByDistance(client, entity);
                 case UpdatePrioritizationSchemes.SimpleAngularDistance:
-                    return GetPriorityByDistance(client, entity);
+                    return GetPriorityByDistance(client, entity); // TODO: Reimplement SimpleAngularDistance
                 case UpdatePrioritizationSchemes.FrontBack:
                     return GetPriorityByFrontBack(client, entity);
                 default:
-- 
cgit v1.1