aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Environment/Modules/ContentManagementSystem/ContentManagementEntity.cs
blob: 1fa4ffc9b590929ff52b52bbcdcf7c8bf5c081f2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
/*
 * 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 copyright
 *       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 OpenSim 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.
 */

#region Header

// ContentManagementEntity.cs
// User: bongiojp
//
//

#endregion Header

using System;
using System.Collections.Generic;
using System.Drawing;

using libsecondlife;

using Nini.Config;

using OpenSim.Framework;
using OpenSim.Region.Environment.Interfaces;
using OpenSim.Region.Environment.Scenes;
using OpenSim.Region.Physics.Manager;

using log4net;

using Axiom.Math;

namespace OpenSim.Region.Environment.Modules.ContentManagement
{
    public class ContentManagementEntity : MetaEntity
    {
        #region Static Fields

        static float TimeToDiff = 0;
        static float TimeToCreateEntities = 0;

        #endregion Static Fields

        #region Fields

        protected Dictionary<LLUUID, AuraMetaEntity> m_AuraEntities = new Dictionary<LLUUID, AuraMetaEntity>();
        protected Dictionary<LLUUID, BeamMetaEntity> m_BeamEntities = new Dictionary<LLUUID, BeamMetaEntity>();

        // The LinkNum of parts in m_Entity and m_UnchangedEntity are the same though UUID and LocalId are different.
        // This can come in handy.
        protected SceneObjectGroup m_UnchangedEntity = null;

        /// <value>
        /// Should be set to true when there is a difference between m_UnchangedEntity and the corresponding scene object group in the scene entity list.
        /// </value>
        bool DiffersFromSceneGroup = false;

        #endregion Fields

        #region Constructors

        public ContentManagementEntity(SceneObjectGroup Unchanged, bool physics)
            : base(Unchanged, false)
        {
            m_UnchangedEntity = Unchanged.Copy(Unchanged.RootPart.OwnerID, Unchanged.RootPart.GroupID, false);
        }

        public ContentManagementEntity(string objectXML, Scene scene,  bool physics)
            : base(objectXML, scene, false)
        {
            m_UnchangedEntity = new SceneObjectGroup(objectXML);
        }

        #endregion Constructors

        #region Public Properties

        public SceneObjectGroup UnchangedEntity
        {
            get { return m_UnchangedEntity; }
        }

        #endregion Public Properties

        #region Private Methods

        /// <summary>
        /// Check if an entitybase list (like that returned by scene.GetEntities() ) contains a group with the rootpart uuid that matches the current uuid.
        /// </summary>
        private bool ContainsKey(List<EntityBase> list, LLUUID uuid)
        {
            foreach( EntityBase part in list)
            	if (part.UUID == uuid)
            		return true;
            return false;
        }

        private SceneObjectGroup GetGroupByUUID(System.Collections.Generic.List<EntityBase> list, LLUUID uuid)
        {
            foreach (EntityBase ent in list)
            {
            	if (ent is SceneObjectGroup)
            		if (ent.UUID == uuid)
            			return (SceneObjectGroup)ent;
            }
            return null;
        }

        #endregion Private Methods

        #region Public Methods

        /// <summary>
        /// Search for a corresponding group UUID in the scene. If not found, then the revisioned group this CMEntity represents has been deleted. Mark the metaentity appropriately.
        /// If a matching UUID is found in a scene object group, compare the two for differences. If differences exist, Mark the metaentity appropriately.
        /// </summary>
        public void FindDifferences()
        {
            System.Collections.Generic.List<EntityBase> sceneEntityList = m_Entity.Scene.GetEntities();
            DiffersFromSceneGroup = false;
            // if group is not contained in scene's list
            if(!ContainsKey(sceneEntityList, m_UnchangedEntity.UUID))
            {
            	foreach(SceneObjectPart part in m_UnchangedEntity.Children.Values)
            	{
            		// if scene list no longer contains this part, display translucent part and mark with red aura
            		if(! ContainsKey(sceneEntityList, part.UUID))
            		{
            			// if already displaying a red aura over part, make sure its red
            			if (m_AuraEntities.ContainsKey(part.UUID))
            			{
            				m_AuraEntities[part.UUID].SetAura(new LLVector3(254,0,0), part.Scale);
            			}
            			else
            			{
            				AuraMetaEntity auraGroup = new AuraMetaEntity(m_Entity.Scene, 
            				                                              m_Entity.Scene.PrimIDAllocate(),
            				                                              part.GetWorldPosition(),
            				                                              MetaEntity.TRANSLUCENT,
            				                                              new LLVector3(254,0,0),
            				                                              part.Scale
            				                                              );
            				m_AuraEntities.Add(part.UUID, auraGroup);
            			}
            			SceneObjectPart metaPart = m_Entity.GetLinkNumPart(part.LinkNum);
            			SetPartTransparency(metaPart, MetaEntity.TRANSLUCENT);
            		}
            		// otherwise, scene will not contain the part. note: a group can not remove a part without changing group id
            	}
            	
            	// a deleted part has no where to point a beam particle system, 
            	// if a metapart had a particle system (maybe it represented a moved part) remove it
            	if (m_BeamEntities.ContainsKey(m_UnchangedEntity.RootPart.UUID))
            	{
            		m_BeamEntities[m_UnchangedEntity.RootPart.UUID].HideFromAll();
            		m_BeamEntities.Remove(m_UnchangedEntity.RootPart.UUID);
            	}
            	
            	DiffersFromSceneGroup = true;
            }
            // if scene list does contain group, compare each part in group for differences and display beams and auras appropriately
            else 
            {
            	MarkWithDifferences((SceneObjectGroup)GetGroupByUUID(sceneEntityList, m_UnchangedEntity.UUID));
            }
        }

        /// <summary>
        /// Check if the revisioned scene object group that this CMEntity is based off of contains a child with the given UUID.
        /// </summary>
        public bool HasChildPrim(LLUUID uuid)
        {
            if (m_UnchangedEntity.Children.ContainsKey(uuid))
            	return true;
            return false;
        }

        /// <summary>
        /// Check if the revisioned scene object group that this CMEntity is based off of contains a child with the given LocalId.
        /// </summary>
        public bool HasChildPrim(uint localID)
        {
            foreach( SceneObjectPart part in m_UnchangedEntity.Children.Values)
            	if ( part.LocalId == localID )
            		return true;
            return false;
        }

        public override void Hide(IClientAPI client)
        {
            base.Hide(client);
            foreach(MetaEntity group in m_AuraEntities.Values)
            	group.Hide(client);
            foreach(MetaEntity group in m_BeamEntities.Values)
            	group.Hide(client);
        }

        public override void HideFromAll()
        {
            base.HideFromAll();
            foreach(MetaEntity group in m_AuraEntities.Values)
            	group.HideFromAll();		
            foreach(MetaEntity group in m_BeamEntities.Values)
            	group.HideFromAll();
        }

        /// <summary>
        /// Returns true if there was a change between meta entity and the entity group, false otherwise.
        /// If true is returned, it is assumed the metaentity's appearance has changed to reflect the difference (though clients haven't been updated).
        /// </summary>
        public bool MarkWithDifferences(SceneObjectGroup sceneEntityGroup)
        {
            SceneObjectPart sceneEntityPart;
            SceneObjectPart metaEntityPart;
            Diff differences;
            bool changed = false;

            // Use "UnchangedEntity" to do comparisons because its text, transparency, and other attributes will be just as the user 
            // had originally saved.
            // m_Entity will NOT necessarily be the same entity as the user had saved.
            foreach(SceneObjectPart UnchangedPart in m_UnchangedEntity.Children.Values)
            {
            	//This is the part that we use to show changes.
            	metaEntityPart = m_Entity.GetLinkNumPart(UnchangedPart.LinkNum);
            	if (sceneEntityGroup.Children.ContainsKey(UnchangedPart.UUID))
            	{
            		sceneEntityPart = sceneEntityGroup.Children[UnchangedPart.UUID];
            		differences = Difference.FindDifferences(UnchangedPart,  sceneEntityPart);
            		if (differences != Diff.NONE)
            			metaEntityPart.Text = "CHANGE: " + differences.ToString();
            		if (differences != 0)
            		{
            			// Root Part that has been modified
            			if ((differences&Diff.POSITION) > 0)
            			{
            				// If the position of any part has changed, make sure the RootPart of the 
            				// meta entity is pointing with a beam particle system
            				if (m_BeamEntities.ContainsKey(m_UnchangedEntity.RootPart.UUID))
            				{
            					m_BeamEntities[m_UnchangedEntity.RootPart.UUID].HideFromAll();
            					m_BeamEntities.Remove(m_UnchangedEntity.RootPart.UUID);
            				}
            				BeamMetaEntity beamGroup = new BeamMetaEntity(m_Entity.Scene, 
            				                                              m_Entity.Scene.PrimIDAllocate(), 
            				                                              m_UnchangedEntity.RootPart.GetWorldPosition(), 
            				                                              MetaEntity.TRANSLUCENT,
            				                                              sceneEntityPart,
            				                                              new LLVector3(0,0,254)
            				                                              );
            				m_BeamEntities.Add(m_UnchangedEntity.RootPart.UUID, beamGroup);
            			}
            			
            			if (m_AuraEntities.ContainsKey(UnchangedPart.UUID))
            			{								
            				m_AuraEntities[UnchangedPart.UUID].HideFromAll();
            				m_AuraEntities.Remove(UnchangedPart.UUID);
            			}
            			AuraMetaEntity auraGroup = new AuraMetaEntity(m_Entity.Scene, 
            			                                              m_Entity.Scene.PrimIDAllocate(),
            			                                              UnchangedPart.GetWorldPosition(),
            			                                              MetaEntity.TRANSLUCENT,
            			                                              new LLVector3(0,0,254),
            			                                              UnchangedPart.Scale
            			                                              );
            			m_AuraEntities.Add(UnchangedPart.UUID, auraGroup);
            			SetPartTransparency(metaEntityPart, MetaEntity.TRANSLUCENT);		
            			
            			DiffersFromSceneGroup = true;
            		}
            		else // no differences between scene part and meta part
            		{
            			if (m_BeamEntities.ContainsKey(m_UnchangedEntity.RootPart.UUID))
            			{
            				m_BeamEntities[m_UnchangedEntity.RootPart.UUID].HideFromAll();
            				m_BeamEntities.Remove(m_UnchangedEntity.RootPart.UUID);
            			}
            			if (m_AuraEntities.ContainsKey(UnchangedPart.UUID))
            			{								
            				m_AuraEntities[UnchangedPart.UUID].HideFromAll();
            				m_AuraEntities.Remove(UnchangedPart.UUID);
            			}
            			SetPartTransparency(metaEntityPart, MetaEntity.NONE);
            		}
            	}
            	else  //The entity currently in the scene is missing parts from the metaentity saved, so mark parts red as deleted.
            	{
            		if (m_AuraEntities.ContainsKey(UnchangedPart.UUID))
            		{
            			m_AuraEntities[UnchangedPart.UUID].HideFromAll();
            			m_AuraEntities.Remove(UnchangedPart.UUID);
            		}
            		AuraMetaEntity auraGroup = new AuraMetaEntity(m_Entity.Scene, 
            		                                              m_Entity.Scene.PrimIDAllocate(),
            		                                              UnchangedPart.GetWorldPosition(),
            		                                              MetaEntity.TRANSLUCENT,
            		                                              new LLVector3(254,0,0),
            		                                              UnchangedPart.Scale
            		                                              );
            		m_AuraEntities.Add(UnchangedPart.UUID, auraGroup);
            		SetPartTransparency(metaEntityPart, MetaEntity.TRANSLUCENT);					
            		
            		DiffersFromSceneGroup = true;
            	}
            }
            return changed;
        }

        public void SendFullAuraUpdate(IClientAPI client)
        {
            if (DiffersFromSceneGroup)
            {
            	foreach(AuraMetaEntity group in m_AuraEntities.Values)
            		group.SendFullUpdate(client);
            }
        }

        public void SendFullAuraUpdateToAll()
        {
            if (DiffersFromSceneGroup)
            {
            	foreach(AuraMetaEntity group in m_AuraEntities.Values)
            		group.SendFullUpdateToAll();
            }
        }

        public void SendFullBeamUpdate(IClientAPI client)
        {
            if (DiffersFromSceneGroup)
            {
            	foreach(BeamMetaEntity group in m_BeamEntities.Values)
            		group.SendFullUpdate(client);
            }
        }

        public void SendFullBeamUpdateToAll()
        {
            if (DiffersFromSceneGroup)
            {
            	foreach(BeamMetaEntity group in m_BeamEntities.Values)
            		group.SendFullUpdateToAll();
            }
        }

        public void SendFullDiffUpdate(IClientAPI client)
        {
            FindDifferences();
            if (DiffersFromSceneGroup)
            {
            	SendFullUpdate(client);
            	SendFullAuraUpdate(client);
            	SendFullBeamUpdate(client);
            }
        }

        public void SendFullDiffUpdateToAll()
        {
            FindDifferences();
            if (DiffersFromSceneGroup)
            {
            	SendFullUpdateToAll();
            	SendFullAuraUpdateToAll();
            	SendFullBeamUpdateToAll();
            }
        }

        #endregion Public Methods
    }
}