aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorJustin Clark-Casey (justincc)2013-03-13 22:59:06 +0000
committerJustin Clark-Casey (justincc)2013-03-13 22:59:06 +0000
commit5c53660a7f055be9ed41f30893de673acac8a0f1 (patch)
tree3c3568c6ab1caf1df975ef7ceaa15cd332dc69a1
parentminor: save some commented out log lines which will be useful again in future... (diff)
downloadopensim-SC_OLD-5c53660a7f055be9ed41f30893de673acac8a0f1.zip
opensim-SC_OLD-5c53660a7f055be9ed41f30893de673acac8a0f1.tar.gz
opensim-SC_OLD-5c53660a7f055be9ed41f30893de673acac8a0f1.tar.bz2
opensim-SC_OLD-5c53660a7f055be9ed41f30893de673acac8a0f1.tar.xz
Add prototype dynamic objects map for scene object parts
This allows region modules to add dynamic objects to SOPs rather than having to continually push and pull OSD dynamic attributes. This is to explore the original MOAP use case for dynamic attributes where it could be very awkward and possibly time-consuming to keep reconstructing MediaEntrys from stored DynamicAttributes. This commit adds a DOExampleModule to demonstrate/evolve this code. Dynamic objects involve no storage or persistence changes - the 'backing store' for any data that does need to be saved will remain the DAMap. DOExampleModule in this commit only attaches a fresh dynamic object. Actually constructing this from stored dynamic attributes and handling persistence is left for later. These changes should affect no existing functionality, though it may or may not reveal necessary changes in DAMap down the road.
-rw-r--r--OpenSim/Framework/DAMap.cs2
-rw-r--r--OpenSim/Framework/DOMap.cs98
-rw-r--r--OpenSim/Region/CoreModules/Framework/DynamicAttributes/DOExampleModule.cs117
-rw-r--r--OpenSim/Region/Framework/Scenes/SceneObjectPart.cs22
4 files changed, 238 insertions, 1 deletions
diff --git a/OpenSim/Framework/DAMap.cs b/OpenSim/Framework/DAMap.cs
index 64cea77..df4a6bc 100644
--- a/OpenSim/Framework/DAMap.cs
+++ b/OpenSim/Framework/DAMap.cs
@@ -180,7 +180,7 @@ namespace OpenSim.Framework
180 /// Validate the key used for storing separate data stores. 180 /// Validate the key used for storing separate data stores.
181 /// </summary> 181 /// </summary>
182 /// <param name='key'></param> 182 /// <param name='key'></param>
183 private static void ValidateKey(string key) 183 public static void ValidateKey(string key)
184 { 184 {
185 if (key.Length < MIN_STORE_NAME_LENGTH) 185 if (key.Length < MIN_STORE_NAME_LENGTH)
186 throw new Exception("Minimum store name length is " + MIN_STORE_NAME_LENGTH); 186 throw new Exception("Minimum store name length is " + MIN_STORE_NAME_LENGTH);
diff --git a/OpenSim/Framework/DOMap.cs b/OpenSim/Framework/DOMap.cs
new file mode 100644
index 0000000..755e129
--- /dev/null
+++ b/OpenSim/Framework/DOMap.cs
@@ -0,0 +1,98 @@
1/*
2 * Copyright (c) Contributors, http://opensimulator.org/
3 * See CONTRIBUTORS.TXT for a full list of copyright holders.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the OpenSimulator Project nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28using System;
29using System.Collections;
30using System.Collections.Generic;
31using System.IO;
32using System.Text;
33using System.Xml;
34using System.Xml.Schema;
35using System.Xml.Serialization;
36using OpenMetaverse;
37using OpenMetaverse.StructuredData;
38
39namespace OpenSim.Framework
40{
41 /// <summary>
42 /// This class stores and retrieves dynamic objects.
43 /// </summary>
44 /// <remarks>
45 /// Experimental - DO NOT USE.
46 /// </remarks>
47 public class DOMap
48 {
49 private IDictionary<string, object> m_map;
50
51 public void Add(string key, object dynObj)
52 {
53 DAMap.ValidateKey(key);
54
55 lock (this)
56 {
57 if (m_map == null)
58 m_map = new Dictionary<string, object>();
59
60 m_map.Add(key, dynObj);
61 }
62 }
63
64 public bool ContainsKey(string key)
65 {
66 return Get(key) != null;
67 }
68
69 /// <summary>
70 /// Get a dynamic object
71 /// </summary>
72 /// <remarks>
73 /// Not providing an index method so that users can't casually overwrite each other's objects.
74 /// </remarks>
75 /// <param name='key'></param>
76 public object Get(string key)
77 {
78 lock (this)
79 {
80 if (m_map == null)
81 return null;
82 else
83 return m_map[key];
84 }
85 }
86
87 public bool Remove(string key)
88 {
89 lock (this)
90 {
91 if (m_map == null)
92 return false;
93 else
94 return m_map.Remove(key);
95 }
96 }
97 }
98} \ No newline at end of file
diff --git a/OpenSim/Region/CoreModules/Framework/DynamicAttributes/DOExampleModule.cs b/OpenSim/Region/CoreModules/Framework/DynamicAttributes/DOExampleModule.cs
new file mode 100644
index 0000000..71bb3f0
--- /dev/null
+++ b/OpenSim/Region/CoreModules/Framework/DynamicAttributes/DOExampleModule.cs
@@ -0,0 +1,117 @@
1/*
2 * Copyright (c) Contributors, http://opensimulator.org/
3 * See CONTRIBUTORS.TXT for a full list of copyright holders.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the OpenSimulator Project nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28using System;
29using System.Collections.Generic;
30using System.Reflection;
31using log4net;
32using Mono.Addins;
33using Nini.Config;
34using OpenMetaverse;
35using OpenMetaverse.Packets;
36using OpenMetaverse.StructuredData;
37using OpenSim.Framework;
38using OpenSim.Region.Framework;
39using OpenSim.Region.Framework.Interfaces;
40using OpenSim.Region.Framework.Scenes;
41
42namespace OpenSim.Region.Framework.DynamicAttributes.DOExampleModule
43{
44 /// <summary>
45 /// Example module for experimenting with and demonstrating dynamic object ideas.
46 /// </summary>
47 [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "DOExampleModule")]
48 public class DOExampleModule : INonSharedRegionModule
49 {
50 public class MyObject
51 {
52 public int Moves { get; set; }
53 }
54
55 // private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
56
57 private static readonly bool ENABLED = false; // enable for testing
58
59 private Scene m_scene;
60 private IDialogModule m_dialogMod;
61
62 public string Name { get { return "DOExample Module"; } }
63 public Type ReplaceableInterface { get { return null; } }
64
65 public void Initialise(IConfigSource source) {}
66
67 public void AddRegion(Scene scene)
68 {
69 if (ENABLED)
70 {
71 m_scene = scene;
72 m_scene.EventManager.OnObjectAddedToScene += OnObjectAddedToScene;
73 m_scene.EventManager.OnSceneGroupMove += OnSceneGroupMove;
74 m_dialogMod = m_scene.RequestModuleInterface<IDialogModule>();
75 }
76 }
77
78 public void RemoveRegion(Scene scene)
79 {
80 if (ENABLED)
81 {
82 m_scene.EventManager.OnSceneGroupMove -= OnSceneGroupMove;
83 }
84 }
85
86 public void RegionLoaded(Scene scene) {}
87
88 public void Close()
89 {
90 RemoveRegion(m_scene);
91 }
92
93 private void OnObjectAddedToScene(SceneObjectGroup so)
94 {
95 so.RootPart.DynObjs.Add(Name, new MyObject());
96 }
97
98 private bool OnSceneGroupMove(UUID groupId, Vector3 delta)
99 {
100 SceneObjectGroup so = m_scene.GetSceneObjectGroup(groupId);
101
102 if (so == null)
103 return true;
104
105 object rawObj = so.RootPart.DynObjs.Get(Name);
106
107 if (rawObj != null)
108 {
109 MyObject myObj = (MyObject)rawObj;
110
111 m_dialogMod.SendGeneralAlert(string.Format("{0} {1} moved {2} times", so.Name, so.UUID, ++myObj.Moves));
112 }
113
114 return true;
115 }
116 }
117} \ No newline at end of file
diff --git a/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs b/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
index 3e9a6fa..ee7c4f4 100644
--- a/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
+++ b/OpenSim/Region/Framework/Scenes/SceneObjectPart.cs
@@ -129,6 +129,27 @@ namespace OpenSim.Region.Framework.Scenes
129 /// Dynamic attributes can be created and deleted as required. 129 /// Dynamic attributes can be created and deleted as required.
130 /// </summary> 130 /// </summary>
131 public DAMap DynAttrs { get; set; } 131 public DAMap DynAttrs { get; set; }
132
133 private DOMap m_dynObjs;
134
135 /// <summary>
136 /// Dynamic objects that can be created and deleted as required.
137 /// </summary>
138 public DOMap DynObjs
139 {
140 get
141 {
142 if (m_dynObjs == null)
143 m_dynObjs = new DOMap();
144
145 return m_dynObjs;
146 }
147
148 set
149 {
150 m_dynObjs = value;
151 }
152 }
132 153
133 /// <value> 154 /// <value>
134 /// Is this a root part? 155 /// Is this a root part?
@@ -348,6 +369,7 @@ namespace OpenSim.Region.Framework.Scenes
348 Rezzed = DateTime.UtcNow; 369 Rezzed = DateTime.UtcNow;
349 Description = String.Empty; 370 Description = String.Empty;
350 DynAttrs = new DAMap(); 371 DynAttrs = new DAMap();
372 DynObjs = new DOMap();
351 373
352 // Prims currently only contain a single folder (Contents). From looking at the Second Life protocol, 374 // Prims currently only contain a single folder (Contents). From looking at the Second Life protocol,
353 // this appears to have the same UUID (!) as the prim. If this isn't the case, one can't drag items from 375 // this appears to have the same UUID (!) as the prim. If this isn't the case, one can't drag items from