/* * 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 OpenSimulator 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. */ using System; using System.Threading; using System.Collections.Generic; using System.Reflection; using OpenMetaverse; using OpenMetaverse.Packets; using log4net; using OpenSim.Framework; using OpenSim.Region.Framework.Scenes.Types; using OpenSim.Region.Physics.Manager; using OpenSim.Region.Framework.Interfaces; namespace OpenSim.Region.Framework.Scenes { public delegate void PhysicsCrash(); public delegate void ObjectDuplicateDelegate(EntityBase original, EntityBase clone); public delegate void AttachToBackupDelegate(SceneObjectGroup sog); public delegate void DetachFromBackupDelegate(SceneObjectGroup sog); public delegate void ChangedBackupDelegate(SceneObjectGroup sog); public delegate void ObjectCreateDelegate(EntityBase obj); public delegate void ObjectDeleteDelegate(EntityBase obj); /// /// This class used to be called InnerScene and may not yet truly be a SceneGraph. The non scene graph components /// should be migrated out over time. /// public class SceneGraph { private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); #region Events protected internal event PhysicsCrash UnRecoverableError; private PhysicsCrash handlerPhysicsCrash = null; public event ObjectDuplicateDelegate OnObjectDuplicate; public event AttachToBackupDelegate OnAttachToBackup; public event DetachFromBackupDelegate OnDetachFromBackup; public event ChangedBackupDelegate OnChangeBackup; public event ObjectCreateDelegate OnObjectCreate; public event ObjectDeleteDelegate OnObjectRemove; #endregion #region Fields protected OpenMetaverse.ReaderWriterLockSlim m_scenePresencesLock = new OpenMetaverse.ReaderWriterLockSlim(); protected Dictionary m_scenePresenceMap = new Dictionary(); protected List m_scenePresenceArray = new List(); // SceneObjects is not currently populated or used. //public Dictionary SceneObjects; protected internal EntityManager Entities = new EntityManager(); // protected internal Dictionary Entities = new Dictionary(); protected internal Dictionary RestorePresences = new Dictionary(); protected RegionInfo m_regInfo; protected Scene m_parentScene; protected Dictionary m_updateList = new Dictionary(); protected int m_numRootAgents = 0; protected int m_numPrim = 0; protected int m_numChildAgents = 0; protected int m_physicalPrim = 0; protected int m_activeScripts = 0; protected int m_scriptLPS = 0; protected internal object m_syncRoot = new object(); protected internal PhysicsScene _PhyScene; protected internal Dictionary SceneObjectGroupsByLocalID = new Dictionary(); protected internal Dictionary SceneObjectGroupsByFullID = new Dictionary(); private Object m_updateLock = new Object(); #endregion protected internal SceneGraph(Scene parent, RegionInfo regInfo) { m_parentScene = parent; m_regInfo = regInfo; } public PhysicsScene PhysicsScene { get { return _PhyScene; } set { // If we're not doing the initial set // Then we've got to remove the previous // event handler if (_PhyScene != null) _PhyScene.OnPhysicsCrash -= physicsBasedCrash; _PhyScene = value; if (_PhyScene != null) _PhyScene.OnPhysicsCrash += physicsBasedCrash; } } protected internal void Close() { m_scenePresencesLock.EnterWriteLock(); try { Dictionary newmap = new Dictionary(); List newlist = new List(); m_scenePresenceMap = newmap; m_scenePresenceArray = newlist; } finally { m_scenePresencesLock.ExitWriteLock(); } lock (SceneObjectGroupsByFullID) SceneObjectGroupsByFullID.Clear(); lock (SceneObjectGroupsByLocalID) SceneObjectGroupsByLocalID.Clear(); Entities.Clear(); } #region Update Methods protected internal void UpdatePreparePhysics() { // If we are using a threaded physics engine // grab the latest scene from the engine before // trying to process it. // PhysX does this (runs in the background). if (_PhyScene.IsThreaded) { _PhyScene.GetResults(); } } protected internal void UpdatePresences() { ForEachScenePresence(delegate(ScenePresence presence) { presence.Update(); }); } protected internal float UpdatePhysics(double elapsed) { lock (m_syncRoot) { // Here is where the Scene calls the PhysicsScene. This is a one-way // interaction; the PhysicsScene cannot access the calling Scene directly. // But with joints, we want a PhysicsActor to be able to influence a // non-physics SceneObjectPart. In particular, a PhysicsActor that is connected // with a joint should be able to move the SceneObjectPart which is the visual // representation of that joint (for editing and serialization purposes). // However the PhysicsActor normally cannot directly influence anything outside // of the PhysicsScene, and the non-physical SceneObjectPart which represents // the joint in the Scene does not exist in the PhysicsScene. // // To solve this, we have an event in the PhysicsScene that is fired when a joint // has changed position (because one of its associated PhysicsActors has changed // position). // // Therefore, JointMoved and JointDeactivated events will be fired as a result of the following Simulate(). return _PhyScene.Simulate((float)elapsed); } } protected internal void UpdateScenePresenceMovement() { ForEachScenePresence(delegate(ScenePresence presence) { presence.UpdateMovement(); }); } public void GetCoarseLocations(out List coarseLocations, out List avatarUUIDs, uint maxLocations) { coarseLocations = new List(); avatarUUIDs = new List(); List presences = GetScenePresences(); for (int i = 0; i < Math.Min(presences.Count, maxLocations); ++i) { ScenePresence sp = presences[i]; // If this presence is a child agent, we don't want its coarse locations if (sp.IsChildAgent) return; coarseLocations.Add(sp.AbsolutePosition); avatarUUIDs.Add(sp.UUID); } } #endregion #region Entity Methods /// /// Add an object into the scene that has come from storage /// /// /// /// If true, changes to the object will be reflected in its persisted data /// If false, the persisted data will not be changed even if the object in the scene is changed /// /// /// If true, we won't persist this object until it changes /// If false, we'll persist this object immediately /// /// /// If true, we send updates to the client to tell it about this object /// If false, we leave it up to the caller to do this /// /// /// true if the object was added, false if an object with the same uuid was already in the scene /// protected internal bool AddRestoredSceneObject( SceneObjectGroup sceneObject, bool attachToBackup, bool alreadyPersisted, bool sendClientUpdates) { if (!m_parentScene.CombineRegions) { // KF: Check for out-of-region, move inside and make static. Vector3 npos = new Vector3(sceneObject.RootPart.GroupPosition.X, sceneObject.RootPart.GroupPosition.Y, sceneObject.RootPart.GroupPosition.Z); if (!(((sceneObject.RootPart.Shape.PCode == (byte)PCode.Prim) && (sceneObject.RootPart.Shape.State != 0))) && (npos.X < 0.0 || npos.Y < 0.0 || npos.Z < 0.0 || npos.X > Constants.RegionSize || npos.Y > Constants.RegionSize)) { if (npos.X < 0.0) npos.X = 1.0f; if (npos.Y < 0.0) npos.Y = 1.0f; if (npos.Z < 0.0) npos.Z = 0.0f; if (npos.X > Constants.RegionSize) npos.X = Constants.RegionSize - 1.0f; if (npos.Y > Constants.RegionSize) npos.Y = Constants.RegionSize - 1.0f; foreach (SceneObjectPart part in sceneObject.Children.Values) { part.GroupPosition = npos; } sceneObject.RootPart.Velocity = Vector3.Zero; sceneObject.RootPart.AngularVelocity = Vector3.Zero; sceneObject.RootPart.Acceleration = Vector3.Zero; sceneObject.RootPart.Velocity = Vector3.Zero; } } if (!alreadyPersisted) { sceneObject.ForceInventoryPersistence(); sceneObject.HasGroupChanged = true; } return AddSceneObject(sceneObject, attachToBackup, sendClientUpdates); } /// /// Add a newly created object to the scene. This will both update the scene, and send information about the /// new object to all clients interested in the scene. /// /// /// /// If true, the object is made persistent into the scene. /// If false, the object will not persist over server restarts /// /// /// true if the object was added, false if an object with the same uuid was already in the scene /// protected internal bool AddNewSceneObject(SceneObjectGroup sceneObject, bool attachToBackup, bool sendClientUpdates) { // Ensure that we persist this new scene object sceneObject.HasGroupChanged = true; return AddSceneObject(sceneObject, attachToBackup, sendClientUpdates); } /// /// Add a newly created object to the scene. /// /// /// This method does not send updates to the client - callers need to handle this themselves. /// /// /// Position of the object /// Rotation of the object /// Velocity of the object. This parameter only has an effect if the object is physical /// public bool AddNewSceneObject( SceneObjectGroup sceneObject, bool attachToBackup, Vector3 pos, Quaternion rot, Vector3 vel) { AddNewSceneObject(sceneObject, true, false); // we set it's position in world. sceneObject.AbsolutePosition = pos; if (sceneObject.RootPart.Shape.PCode == (byte)PCode.Prim) { sceneObject.ClearPartAttachmentData(); } sceneObject.UpdateGroupRotationR(rot); //group.ApplyPhysics(m_physicalPrim); if (sceneObject.RootPart.PhysActor != null && sceneObject.RootPart.PhysActor.IsPhysical && vel != Vector3.Zero) { sceneObject.RootPart.ApplyImpulse((vel * sceneObject.GetMass()), false); sceneObject.Velocity = vel; } return true; } /// /// Add an object to the scene. This will both update the scene, and send information about the /// new object to all clients interested in the scene. /// /// /// /// If true, the object is made persistent into the scene. /// If false, the object will not persist over server restarts /// /// /// If true, updates for the new scene object are sent to all viewers in range. /// If false, it is left to the caller to schedule the update /// /// /// true if the object was added, false if an object with the same uuid was already in the scene /// protected bool AddSceneObject(SceneObjectGroup sceneObject, bool attachToBackup, bool sendClientUpdates) { if (sceneObject == null || sceneObject.RootPart == null || sceneObject.RootPart.UUID == UUID.Zero) return false; lock (sceneObject) { if (Entities.ContainsKey(sceneObject.UUID)) { // m_log.WarnFormat( // "[SCENE GRAPH]: Scene object {0} {1} was already in region {2} on add request", // sceneObject.Name, sceneObject.UUID, m_parentScene.RegionInfo.RegionName); return false; } // m_log.DebugFormat( // "[SCENE GRAPH]: Adding object {0} {1} to region {2}", // sceneObject.Name, sceneObject.UUID, m_parentScene.RegionInfo.RegionName); lock (sceneObject.Children) { if (m_parentScene.m_clampPrimSize) { foreach (SceneObjectPart part in sceneObject.Children.Values) { Vector3 scale = part.Shape.Scale; if (scale.X > m_parentScene.m_maxNonphys) scale.X = m_parentScene.m_maxNonphys; if (scale.Y > m_parentScene.m_maxNonphys) scale.Y = m_parentScene.m_maxNonphys; if (scale.Z > m_parentScene.m_maxNonphys) scale.Z = m_parentScene.m_maxNonphys; part.Shape.Scale = scale; } } m_numPrim += sceneObject.Children.Count; } sceneObject.AttachToScene(m_parentScene); if (sendClientUpdates) sceneObject.ScheduleGroupForFullUpdate(); Entities.Add(sceneObject); if (attachToBackup) sceneObject.AttachToBackup(); if (OnObjectCreate != null) OnObjectCreate(sceneObject); lock (SceneObjectGroupsByFullID) { SceneObjectGroupsByFullID[sceneObject.UUID] = sceneObject; foreach (SceneObjectPart part in sceneObject.Children.Values) SceneObjectGroupsByFullID[part.UUID] = sceneObject; } lock (SceneObjectGroupsByLocalID) { SceneObjectGroupsByLocalID[sceneObject.LocalId] = sceneObject; foreach (SceneObjectPart part in sceneObject.Children.Values) SceneObjectGroupsByLocalID[part.LocalId] = sceneObject; } } return true; } /// /// Delete an object from the scene /// /// true if the object was deleted, false if there was no object to delete public bool DeleteSceneObject(UUID uuid, bool resultOfObjectLinked) { if (Entities.ContainsKey(uuid)) { SceneObjectGroup grp = (SceneObjectGroup)Entities[uuid]; if (!resultOfObjectLinked) { m_numPrim -= grp.PrimCount; if ((grp.RootPart.Flags & PrimFlags.Physics) == PrimFlags.Physics) RemovePhysicalPrim(grp.PrimCount); } if (OnObjectRemove != null) OnObjectRemove(Entities[uuid]); lock (SceneObjectGroupsByFullID) { foreach (SceneObjectPart part in grp.Children.Values) SceneObjectGroupsByFullID.Remove(part.UUID); SceneObjectGroupsByFullID.Remove(grp.RootPart.UUID); } lock (SceneObjectGroupsByLocalID) { foreach (SceneObjectPart part in grp.Children.Values) SceneObjectGroupsByLocalID.Remove(part.LocalId); SceneObjectGroupsByLocalID.Remove(grp.RootPart.LocalId); } Entities.Remove(uuid); //SceneObjectGroup part; //((part.RootPart.Flags & PrimFlags.Physics) == PrimFlags.Physics) return true; } return false; } /// /// Add an object to the list of prims to process on the next update /// /// /// A /// protected internal void AddToUpdateList(SceneObjectGroup obj) { lock (m_updateList) { m_updateList[obj.UUID] = obj; } } public void FireAttachToBackup(SceneObjectGroup obj) { if (OnAttachToBackup != null) { OnAttachToBackup(obj); } } public void FireDetachFromBackup(SceneObjectGroup obj) { if (OnDetachFromBackup != null) { OnDetachFromBackup(obj); } } public void FireChangeBackup(SceneObjectGroup obj) { if (OnChangeBackup != null) { OnChangeBackup(obj); } } /// /// Process all pending updates /// protected internal void UpdateObjectGroups() { if (!Monitor.TryEnter(m_updateLock)) return; List updates; // Some updates add more updates to the updateList. // Get the current list of updates and clear the list before iterating lock (m_updateList) { updates = new List(m_updateList.Values); m_updateList.Clear(); } // Go through all updates for (int i = 0; i < updates.Count; i++) { SceneObjectGroup sog = updates[i]; // Don't abort the whole update if one entity happens to give us an exception. try { sog.Update(); } catch (Exception e) { m_log.ErrorFormat( "[INNER SCENE]: Failed to update {0}, {1} - {2}", sog.Name, sog.UUID, e); } } Monitor.Exit(m_updateLock); } protected internal void AddPhysicalPrim(int number) { m_physicalPrim++; } protected internal void RemovePhysicalPrim(int number) { m_physicalPrim--; } protected internal void AddToScriptLPS(int number) { m_scriptLPS += number; } protected internal void AddActiveScripts(int number) { m_activeScripts += number; } public void DropObject(uint objectLocalID, IClientAPI remoteClient) { SceneObjectGroup group = GetGroupByPrim(objectLocalID); if (group != null) m_parentScene.AttachmentsModule.DetachSingleAttachmentToGround(group.UUID, remoteClient); } protected internal void DetachObject(uint objectLocalID, IClientAPI remoteClient) { SceneObjectGroup group = GetGroupByPrim(objectLocalID); if (group != null) { //group.DetachToGround(); m_parentScene.AttachmentsModule.ShowDetachInUserInventory(group.GetFromItemID(), remoteClient); } } protected internal void HandleUndo(IClientAPI remoteClient, UUID primId) { if (primId != UUID.Zero) { SceneObjectPart part = m_parentScene.GetSceneObjectPart(primId); if (part != null) part.Undo(); } } protected internal void HandleRedo(IClientAPI remoteClient, UUID primId) { if (primId != UUID.Zero) { SceneObjectPart part = m_parentScene.GetSceneObjectPart(primId); if (part != null) part.Redo(); } } protected internal void HandleObjectGroupUpdate( IClientAPI remoteClient, UUID GroupID, uint objectLocalID, UUID Garbage) { SceneObjectGroup group = GetGroupByPrim(objectLocalID); if (group != null) { if (group.OwnerID == remoteClient.AgentId) group.SetGroup(GroupID, remoteClient); } } protected internal ScenePresence CreateAndAddChildScenePresence(IClientAPI client, AvatarAppearance appearance) { ScenePresence newAvatar = null; newAvatar = new ScenePresence(client, m_parentScene, m_regInfo, appearance); newAvatar.IsChildAgent = true; AddScenePresence(newAvatar); return newAvatar; } /// /// Add a presence to the scene /// /// protected internal void AddScenePresence(ScenePresence presence) { bool child = presence.IsChildAgent; if (child) { m_numChildAgents++; } else { m_numRootAgents++; presence.AddToPhysicalScene(false); } Entities[presence.UUID] = presence; m_scenePresencesLock.EnterWriteLock(); try { Dictionary newmap = new Dictionary(m_scenePresenceMap); List newlist = new List(m_scenePresenceArray); if (!newmap.ContainsKey(presence.UUID)) { newmap.Add(presence.UUID, presence); newlist.Add(presence); } else { // Remember the old presene reference from the dictionary ScenePresence oldref = newmap[presence.UUID]; // Replace the presence reference in the dictionary with the new value newmap[presence.UUID] = presence; // Find the index in the list where the old ref was stored and update the reference newlist[newlist.IndexOf(oldref)] = presence; } // Swap out the dictionary and list with new references m_scenePresenceMap = newmap; m_scenePresenceArray = newlist; } finally { m_scenePresencesLock.ExitWriteLock(); } } /// /// Remove a presence from the scene /// protected internal void RemoveScenePresence(UUID agentID) { if (!Entities.Remove(agentID)) { m_log.WarnFormat( "[SCENE]: Tried to remove non-existent scene presence with agent ID {0} from scene Entities list", agentID); } m_scenePresencesLock.EnterWriteLock(); try { Dictionary newmap = new Dictionary(m_scenePresenceMap); List newlist = new List(m_scenePresenceArray); // Remove the presence reference from the dictionary if (newmap.ContainsKey(agentID)) { ScenePresence oldref = newmap[agentID]; newmap.Remove(agentID); // Find the index in the list where the old ref was stored and remove the reference newlist.RemoveAt(newlist.IndexOf(oldref)); // Swap out the dictionary and list with new references m_scenePresenceMap = newmap; m_scenePresenceArray = newlist; } else { m_log.WarnFormat("[SCENE]: Tried to remove non-existent scene presence with agent ID {0} from scene ScenePresences list", agentID); } } finally { m_scenePresencesLock.ExitWriteLock(); } } protected internal void SwapRootChildAgent(bool direction_RC_CR_T_F) { if (direction_RC_CR_T_F) { m_numRootAgents--; m_numChildAgents++; } else { m_numChildAgents--; m_numRootAgents++; } } public void removeUserCount(bool TypeRCTF) { if (TypeRCTF) { m_numRootAgents--; } else { m_numChildAgents--; } } public void RecalculateStats() { int rootcount = 0; int childcount = 0; ForEachScenePresence(delegate(ScenePresence presence) { if (presence.IsChildAgent) ++childcount; else ++rootcount; }); m_numRootAgents = rootcount; m_numChildAgents = childcount; } public int GetChildAgentCount() { // some network situations come in where child agents get closed twice. if (m_numChildAgents < 0) { m_numChildAgents = 0; } return m_numChildAgents; } public int GetRootAgentCount() { return m_numRootAgents; } public int GetTotalObjectsCount() { return m_numPrim; } public int GetActiveObjectsCount() { return m_physicalPrim; } public int GetActiveScriptsCount() { return m_activeScripts; } public int GetScriptLPS() { int returnval = m_scriptLPS; m_scriptLPS = 0; return returnval; } #endregion #region Get Methods /// /// Get the controlling client for the given avatar, if there is one. /// /// FIXME: The only user of the method right now is Caps.cs, in order to resolve a client API since it can't /// use the ScenePresence. This could be better solved in a number of ways - we could establish an /// OpenSim.Framework.IScenePresence, or move the caps code into a region package (which might be the more /// suitable solution). /// /// /// null if either the avatar wasn't in the scene, or /// they do not have a controlling client /// this used to be protected internal, but that /// prevents CapabilitiesModule from accessing it public IClientAPI GetControllingClient(UUID agentId) { ScenePresence presence = GetScenePresence(agentId); if (presence != null) { return presence.ControllingClient; } return null; } /// /// Get a reference to the scene presence list. Changes to the list will be done in a copy /// There is no guarantee that presences will remain in the scene after the list is returned. /// This list should remain private to SceneGraph. Callers wishing to iterate should instead /// pass a delegate to ForEachScenePresence. /// /// private List GetScenePresences() { return m_scenePresenceArray; } /// /// Request a scene presence by UUID. Fast, indexed lookup. /// /// /// null if the presence was not found protected internal ScenePresence GetScenePresence(UUID agentID) { Dictionary presences = m_scenePresenceMap; ScenePresence presence; presences.TryGetValue(agentID, out presence); return presence; } /// /// Request the scene presence by name. /// /// /// /// null if the presence was not found protected internal ScenePresence GetScenePresence(string firstName, string lastName) { List presences = GetScenePresences(); foreach (ScenePresence presence in presences) { if (presence.Firstname == firstName && presence.Lastname == lastName) return presence; } return null; } /// /// Request the scene presence by localID. /// /// /// null if the presence was not found protected internal ScenePresence GetScenePresence(uint localID) { List presences = GetScenePresences(); foreach (ScenePresence presence in presences) if (presence.LocalId == localID) return presence; return null; } protected internal bool TryGetScenePresence(UUID agentID, out ScenePresence avatar) { Dictionary presences = m_scenePresenceMap; presences.TryGetValue(agentID, out avatar); return (avatar != null); } protected internal bool TryGetAvatarByName(string name, out ScenePresence avatar) { avatar = null; foreach (ScenePresence presence in GetScenePresences()) { if (String.Compare(name, presence.ControllingClient.Name, true) == 0) { avatar = presence; break; } } return (avatar != null); } /// /// Get a scene object group that contains the prim with the given local id /// /// /// null if no scene object group containing that prim is found public SceneObjectGroup GetGroupByPrim(uint localID) { if (Entities.ContainsKey(localID)) return Entities[localID] as SceneObjectGroup; //m_log.DebugFormat("Entered GetGroupByPrim with localID {0}", localID); SceneObjectGroup sog; lock (SceneObjectGroupsByLocalID) { if (SceneObjectGroupsByLocalID.TryGetValue(localID, out sog)) { if (sog.HasChildPrim(localID)) return sog; SceneObjectGroupsByLocalID.Remove(localID); } } List EntityList = GetEntities(); foreach (EntityBase ent in EntityList) { //m_log.DebugFormat("Looking at entity {0}", ent.UUID); if (ent is SceneObjectGroup) { if (((SceneObjectGroup)ent).HasChildPrim(localID)) { sog = (SceneObjectGroup)ent; lock (SceneObjectGroupsByLocalID) { SceneObjectGroupsByLocalID[localID] = sog; } return sog; } } } return null; } /// /// Get a scene object group that contains the prim with the given uuid /// /// /// null if no scene object group containing that prim is found private SceneObjectGroup GetGroupByPrim(UUID fullID) { SceneObjectGroup sog; lock (SceneObjectGroupsByFullID) { if (SceneObjectGroupsByFullID.TryGetValue(fullID, out sog)) { lock (sog.Children) { if (sog.Children.ContainsKey(fullID)) return sog; } SceneObjectGroupsByFullID.Remove(fullID); } } List EntityList = GetEntities(); foreach (EntityBase ent in EntityList) { if (ent is SceneObjectGroup) { if (((SceneObjectGroup)ent).HasChildPrim(fullID)) { sog = (SceneObjectGroup)ent; lock (SceneObjectGroupsByFullID) { SceneObjectGroupsByFullID[fullID] = sog; } return sog; } } } return null; } protected internal EntityIntersection GetClosestIntersectingPrim(Ray hray, bool frontFacesOnly, bool faceCenters) { // Primitive Ray Tracing float closestDistance = 280f; EntityIntersection result = new EntityIntersection(); List EntityList = GetEntities(); foreach (EntityBase ent in EntityList) { if (ent is SceneObjectGroup) { SceneObjectGroup reportingG = (SceneObjectGroup)ent; EntityIntersection inter = reportingG.TestIntersection(hray, frontFacesOnly, faceCenters); if (inter.HitTF && inter.distance < closestDistance) { closestDistance = inter.distance; result = inter; } } } return result; } /// /// Get a part contained in this scene. /// /// /// null if the part was not found protected internal SceneObjectPart GetSceneObjectPart(uint localID) { SceneObjectGroup group = GetGroupByPrim(localID); if (group == null) return null; return group.GetChildPart(localID); } /// /// Get a named prim contained in this scene (will return the first /// found, if there are more than one prim with the same name) /// /// /// null if the part was not found protected internal SceneObjectPart GetSceneObjectPart(string name) { List EntityList = GetEntities(); // FIXME: use a dictionary here foreach (EntityBase ent in EntityList) { if (ent is SceneObjectGroup) { foreach (SceneObjectPart p in ((SceneObjectGroup) ent).GetParts()) { if (p.Name == name) { return p; } } } } return null; } /// /// Get a part contained in this scene. /// /// /// null if the part was not found protected internal SceneObjectPart GetSceneObjectPart(UUID fullID) { SceneObjectGroup group = GetGroupByPrim(fullID); if (group == null) return null; return group.GetChildPart(fullID); } /// /// Returns a list of the entities in the scene. This is a new list so no locking is required to iterate over /// it /// /// protected internal List GetEntities() { return Entities.GetEntities(); } public Dictionary GetTopScripts() { Dictionary topScripts = new Dictionary(); List EntityList = GetEntities(); int limit = 0; foreach (EntityBase ent in EntityList) { if (ent is SceneObjectGroup) { SceneObjectGroup grp = (SceneObjectGroup)ent; if ((grp.RootPart.GetEffectiveObjectFlags() & (uint)PrimFlags.Scripted) != 0) { if (grp.scriptScore >= 0.01) { topScripts.Add(grp.LocalId, grp.scriptScore); limit++; if (limit >= 100) { break; } } grp.scriptScore = 0; } } } return topScripts; } #endregion #region Other Methods protected internal void physicsBasedCrash() { handlerPhysicsCrash = UnRecoverableError; if (handlerPhysicsCrash != null) { handlerPhysicsCrash(); } } protected internal UUID ConvertLocalIDToFullID(uint localID) { SceneObjectGroup group = GetGroupByPrim(localID); if (group != null) return group.GetPartsFullID(localID); else return UUID.Zero; } /// /// Performs action on all scene object groups. /// /// protected internal void ForEachSOG(Action action) { List objlist = Entities.GetAllByType(); foreach (EntityBase ent in objlist) { SceneObjectGroup obj = (SceneObjectGroup)ent; try { action(obj); } catch (Exception e) { // Catch it and move on. This includes situations where splist has inconsistent info m_log.WarnFormat("[SCENE]: Problem processing action in ForEachSOG: ", e.Message); } } } /// /// Performs action on all scene presences. This can ultimately run the actions in parallel but /// any delegates passed in will need to implement their own locking on data they reference and /// modify outside of the scope of the delegate. /// /// public void ForEachScenePresence(Action action) { // Once all callers have their delegates configured for parallelism, we can unleash this /* Action protectedAction = new Action(delegate(ScenePresence sp) { try { action(sp); } catch (Exception e) { m_log.Info("[BUG] in " + m_parentScene.RegionInfo.RegionName + ": " + e.ToString()); m_log.Info("[BUG] Stack Trace: " + e.StackTrace); } }); Parallel.ForEach(GetScenePresences(), protectedAction); */ // For now, perform actions serially List presences = GetScenePresences(); foreach (ScenePresence sp in presences) { try { action(sp); } catch (Exception e) { m_log.Info("[BUG] in " + m_parentScene.RegionInfo.RegionName + ": " + e.ToString()); m_log.Info("[BUG] Stack Trace: " + e.StackTrace); } } } #endregion #region Client Event handlers /// /// /// /// /// /// protected internal void UpdatePrimScale(uint localID, Vector3 scale, IClientAPI remoteClient) { SceneObjectGroup group = GetGroupByPrim(localID); if (group != null) { if (m_parentScene.Permissions.CanEditObject(group.UUID, remoteClient.AgentId)) { group.Resize(scale, localID); } } } protected internal void UpdatePrimGroupScale(uint localID, Vector3 scale, IClientAPI remoteClient) { SceneObjectGroup group = GetGroupByPrim(localID); if (group != null) { if (m_parentScene.Permissions.CanEditObject(group.UUID, remoteClient.AgentId)) { group.GroupResize(scale, localID); } } } /// /// This handles the nifty little tool tip that you get when you drag your mouse over an object /// Send to the Object Group to process. We don't know enough to service the request /// /// /// /// /// protected internal void RequestObjectPropertiesFamily( IClientAPI remoteClient, UUID AgentID, uint RequestFlags, UUID ObjectID) { SceneObjectGroup group = GetGroupByPrim(ObjectID); if (group != null) { group.ServiceObjectPropertiesFamilyRequest(remoteClient, AgentID, RequestFlags); } } /// /// /// /// /// /// protected internal void UpdatePrimSingleRotation(uint localID, Quaternion rot, IClientAPI remoteClient) { SceneObjectGroup group = GetGroupByPrim(localID); if (group != null) { if (m_parentScene.Permissions.CanMoveObject(group.UUID, remoteClient.AgentId)) { group.UpdateSingleRotation(rot, localID); } } } /// /// /// /// /// /// protected internal void UpdatePrimSingleRotationPosition(uint localID, Quaternion rot, Vector3 pos, IClientAPI remoteClient) { SceneObjectGroup group = GetGroupByPrim(localID); if (group != null) { if (m_parentScene.Permissions.CanMoveObject(group.UUID, remoteClient.AgentId)) { group.UpdateSingleRotation(rot,pos, localID); } } } /// /// /// /// /// /// protected internal void UpdatePrimRotation(uint localID, Quaternion rot, IClientAPI remoteClient) { SceneObjectGroup group = GetGroupByPrim(localID); if (group != null) { if (m_parentScene.Permissions.CanMoveObject(group.UUID, remoteClient.AgentId)) { group.UpdateGroupRotationR(rot); } } } /// /// /// /// /// /// /// protected internal void UpdatePrimRotation(uint localID, Vector3 pos, Quaternion rot, IClientAPI remoteClient) { SceneObjectGroup group = GetGroupByPrim(localID); if (group != null) { if (m_parentScene.Permissions.CanMoveObject(group.UUID, remoteClient.AgentId)) { group.UpdateGroupRotationPR(pos, rot); } } } /// /// Update the position of the given part /// /// /// /// protected internal void UpdatePrimSinglePosition(uint localID, Vector3 pos, IClientAPI remoteClient) { SceneObjectGroup group = GetGroupByPrim(localID); if (group != null) { if (m_parentScene.Permissions.CanMoveObject(group.UUID, remoteClient.AgentId) || group.IsAttachment) { group.UpdateSinglePosition(pos, localID); } } } /// /// Update the position of the given part /// /// /// /// public void UpdatePrimPosition(uint localID, Vector3 pos, IClientAPI remoteClient) { SceneObjectGroup group = GetGroupByPrim(localID); if (group != null) { if (group.IsAttachment || (group.RootPart.Shape.PCode == 9 && group.RootPart.Shape.State != 0)) { if (m_parentScene.AttachmentsModule != null) m_parentScene.AttachmentsModule.UpdateAttachmentPosition(remoteClient, group, pos); } else { if (m_parentScene.Permissions.CanMoveObject(group.UUID, remoteClient.AgentId) && m_parentScene.Permissions.CanObjectEntry(group.UUID, false, pos)) { group.UpdateGroupPosition(pos); } } } } /// /// Update the texture entry of the given prim. /// /// /// A texture entry is an object that contains details of all the textures of the prim's face. In this case, /// the texture is given in its byte serialized form. /// /// /// /// protected internal void UpdatePrimTexture(uint localID, byte[] texture, IClientAPI remoteClient) { SceneObjectGroup group = GetGroupByPrim(localID); if (group != null) { if (m_parentScene.Permissions.CanEditObject(group.UUID,remoteClient.AgentId)) { group.UpdateTextureEntry(localID, texture); } } } /// /// /// /// /// /// /// 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); if (group != null) { if (m_parentScene.Permissions.CanEditObject(group.UUID, remoteClient.AgentId)) { 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 } } } /// /// Move the given object /// /// /// /// /// protected internal void MoveObject(UUID objectID, Vector3 offset, Vector3 pos, IClientAPI remoteClient, List surfaceArgs) { SceneObjectGroup group = GetGroupByPrim(objectID); if (group != null) { if (m_parentScene.Permissions.CanMoveObject(group.UUID, remoteClient.AgentId))// && PermissionsMngr.) { group.GrabMovement(offset, pos, remoteClient); } // This is outside the above permissions condition // so that if the object is locked the client moving the object // get's it's position on the simulator even if it was the same as before // This keeps the moving user's client in sync with the rest of the world. group.SendGroupTerseUpdate(); } } /// /// Start spinning the given object /// /// /// /// protected internal void SpinStart(UUID objectID, IClientAPI remoteClient) { SceneObjectGroup group = GetGroupByPrim(objectID); if (group != null) { if (m_parentScene.Permissions.CanMoveObject(group.UUID, remoteClient.AgentId))// && PermissionsMngr.) { group.SpinStart(remoteClient); } } } /// /// Spin the given object /// /// /// /// protected internal void SpinObject(UUID objectID, Quaternion rotation, IClientAPI remoteClient) { SceneObjectGroup group = GetGroupByPrim(objectID); if (group != null) { if (m_parentScene.Permissions.CanMoveObject(group.UUID, remoteClient.AgentId))// && PermissionsMngr.) { group.SpinMovement(rotation, remoteClient); } // This is outside the above permissions condition // so that if the object is locked the client moving the object // get's it's position on the simulator even if it was the same as before // This keeps the moving user's client in sync with the rest of the world. group.SendGroupTerseUpdate(); } } /// /// /// /// /// protected internal void PrimName(IClientAPI remoteClient, uint primLocalID, string name) { SceneObjectGroup group = GetGroupByPrim(primLocalID); if (group != null) { if (m_parentScene.Permissions.CanEditObject(group.UUID, remoteClient.AgentId)) { group.SetPartName(Util.CleanString(name), primLocalID); group.HasGroupChanged = true; } } } /// /// /// /// /// protected internal void PrimDescription(IClientAPI remoteClient, uint primLocalID, string description) { SceneObjectGroup group = GetGroupByPrim(primLocalID); if (group != null) { if (m_parentScene.Permissions.CanEditObject(group.UUID, remoteClient.AgentId)) { group.SetPartDescription(Util.CleanString(description), primLocalID); group.HasGroupChanged = true; } } } protected internal void PrimClickAction(IClientAPI remoteClient, uint primLocalID, string clickAction) { SceneObjectGroup group = GetGroupByPrim(primLocalID); if (group != null) { if (m_parentScene.Permissions.CanEditObject(group.UUID, remoteClient.AgentId)) { SceneObjectPart part = m_parentScene.GetSceneObjectPart(primLocalID); part.ClickAction = Convert.ToByte(clickAction); group.HasGroupChanged = true; } } } protected internal void PrimMaterial(IClientAPI remoteClient, uint primLocalID, string material) { SceneObjectGroup group = GetGroupByPrim(primLocalID); if (group != null) { if (m_parentScene.Permissions.CanEditObject(group.UUID, remoteClient.AgentId)) { SceneObjectPart part = m_parentScene.GetSceneObjectPart(primLocalID); part.Material = Convert.ToByte(material); group.HasGroupChanged = true; } } } protected internal void UpdateExtraParam(UUID agentID, uint primLocalID, ushort type, bool inUse, byte[] data) { SceneObjectGroup group = GetGroupByPrim(primLocalID); if (group != null) { if (m_parentScene.Permissions.CanEditObject(group.UUID,agentID)) { group.UpdateExtraParam(primLocalID, type, inUse, data); } } } /// /// /// /// /// protected internal void UpdatePrimShape(UUID agentID, uint primLocalID, UpdateShapeArgs shapeBlock) { SceneObjectGroup group = GetGroupByPrim(primLocalID); if (group != null) { if (m_parentScene.Permissions.CanEditObject(group.GetPartsFullID(primLocalID), agentID)) { ObjectShapePacket.ObjectDataBlock shapeData = new ObjectShapePacket.ObjectDataBlock(); shapeData.ObjectLocalID = shapeBlock.ObjectLocalID; shapeData.PathBegin = shapeBlock.PathBegin; shapeData.PathCurve = shapeBlock.PathCurve; shapeData.PathEnd = shapeBlock.PathEnd; shapeData.PathRadiusOffset = shapeBlock.PathRadiusOffset; shapeData.PathRevolutions = shapeBlock.PathRevolutions; shapeData.PathScaleX = shapeBlock.PathScaleX; shapeData.PathScaleY = shapeBlock.PathScaleY; shapeData.PathShearX = shapeBlock.PathShearX; shapeData.PathShearY = shapeBlock.PathShearY; shapeData.PathSkew = shapeBlock.PathSkew; shapeData.PathTaperX = shapeBlock.PathTaperX; shapeData.PathTaperY = shapeBlock.PathTaperY; shapeData.PathTwist = shapeBlock.PathTwist; shapeData.PathTwistBegin = shapeBlock.PathTwistBegin; shapeData.ProfileBegin = shapeBlock.ProfileBegin; shapeData.ProfileCurve = shapeBlock.ProfileCurve; shapeData.ProfileEnd = shapeBlock.ProfileEnd; shapeData.ProfileHollow = shapeBlock.ProfileHollow; group.UpdateShape(shapeData, primLocalID); } } } /// /// Initial method invoked when we receive a link objects request from the client. /// /// /// /// protected internal void LinkObjects(SceneObjectPart root, List children) { SceneObjectGroup parentGroup = root.ParentGroup; if (parentGroup == null) return; Monitor.Enter(m_updateLock); try { parentGroup.areUpdatesSuspended = true; List childGroups = new List(); if (parentGroup != null) { // We do this in reverse to get the link order of the prims correct for (int i = children.Count - 1; i >= 0; i--) { SceneObjectGroup child = children[i].ParentGroup; if (child != null) { childGroups.Add(child); } } } else { return; // parent is null so not in this region } foreach (SceneObjectGroup child in childGroups) { parentGroup.LinkToGroup(child); // this is here so physics gets updated! // Don't remove! Bad juju! Stay away! or fix physics! child.AbsolutePosition = child.AbsolutePosition; } // We need to explicitly resend the newly link prim's object properties since no other actions // occur on link to invoke this elsewhere (such as object selection) parentGroup.RootPart.CreateSelected = true; parentGroup.TriggerScriptChangedEvent(Changed.LINK); } finally { parentGroup.areUpdatesSuspended = false; parentGroup.HasGroupChanged = true; parentGroup.ScheduleGroupForFullUpdate(); Monitor.Exit(m_updateLock); } } /// /// Delink a linkset /// /// protected internal void DelinkObjects(List prims) { Monitor.Enter(m_updateLock); try { List childParts = new List(); List rootParts = new List(); List affectedGroups = new List(); // Look them all up in one go, since that is comparatively expensive // foreach (SceneObjectPart part in prims) { if (part != null) { if (part.ParentGroup.PrimCount != 1) // Skip single { if (part.LinkNum < 2) // Root rootParts.Add(part); else childParts.Add(part); SceneObjectGroup group = part.ParentGroup; if (!affectedGroups.Contains(group)) affectedGroups.Add(group); } } } if (childParts.Count > 0) { try { childParts[0].ParentGroup.areUpdatesSuspended = true; foreach (SceneObjectPart child in childParts) { // Unlink all child parts from their groups // child.ParentGroup.DelinkFromGroup(child, true); } } finally { childParts[0].ParentGroup.areUpdatesSuspended = false; } } foreach (SceneObjectPart root in rootParts) { // In most cases, this will run only one time, and the prim // will be a solo prim // However, editing linked parts and unlinking may be different // SceneObjectGroup group = root.ParentGroup; List newSet = null; int numChildren = -1; lock (group.Children) { newSet = new List(group.Children.Values); numChildren = group.PrimCount; } // If there are prims left in a link set, but the root is // slated for unlink, we need to do this // if (numChildren != 1) { // Unlink the remaining set // bool sendEventsToRemainder = true; if (numChildren > 1) sendEventsToRemainder = false; if (newSet.Count > 0) { try { newSet[0].ParentGroup.areUpdatesSuspended = true; foreach (SceneObjectPart p in newSet) { if (p != group.RootPart) group.DelinkFromGroup(p, sendEventsToRemainder); } } finally { newSet[0].ParentGroup.areUpdatesSuspended = false; } } // If there is more than one prim remaining, we // need to re-link // if (numChildren > 2) { // Remove old root // if (newSet.Contains(root)) newSet.Remove(root); // Preserve link ordering // newSet.Sort(delegate (SceneObjectPart a, SceneObjectPart b) { return a.LinkNum.CompareTo(b.LinkNum); }); // Determine new root // SceneObjectPart newRoot = newSet[0]; newSet.RemoveAt(0); foreach (SceneObjectPart newChild in newSet) newChild.UpdateFlag = 0; LinkObjects(newRoot, newSet); if (!affectedGroups.Contains(newRoot.ParentGroup)) affectedGroups.Add(newRoot.ParentGroup); } } } // Finally, trigger events in the roots // foreach (SceneObjectGroup g in affectedGroups) { g.TriggerScriptChangedEvent(Changed.LINK); g.HasGroupChanged = true; // Persist g.ScheduleGroupForFullUpdate(); } } finally { Monitor.Exit(m_updateLock); } } protected internal void MakeObjectSearchable(IClientAPI remoteClient, bool IncludeInSearch, uint localID) { UUID user = remoteClient.AgentId; UUID objid = UUID.Zero; SceneObjectPart obj = null; List EntityList = GetEntities(); foreach (EntityBase ent in EntityList) { if (ent is SceneObjectGroup) { SceneObjectGroup sog = ent as SceneObjectGroup; lock (sog.Children) { foreach (KeyValuePair subent in sog.Children) { if (subent.Value.LocalId == localID) { objid = subent.Key; obj = subent.Value; } } } } } //Protip: In my day, we didn't call them searchable objects, we called them limited point-to-point joints //aka ObjectFlags.JointWheel = IncludeInSearch //Permissions model: Object can be REMOVED from search IFF: // * User owns object //use CanEditObject //Object can be ADDED to search IFF: // * User owns object // * Asset/DRM permission bit "modify" is enabled //use CanEditObjectPosition // libomv will complain about PrimFlags.JointWheel being // deprecated, so we #pragma warning disable 0612 if (IncludeInSearch && m_parentScene.Permissions.CanEditObject(objid, user)) { obj.ParentGroup.RootPart.AddFlag(PrimFlags.JointWheel); obj.ParentGroup.HasGroupChanged = true; } else if (!IncludeInSearch && m_parentScene.Permissions.CanMoveObject(objid,user)) { obj.ParentGroup.RootPart.RemFlag(PrimFlags.JointWheel); obj.ParentGroup.HasGroupChanged = true; } #pragma warning restore 0612 } /// /// Duplicate the given object, Fire and Forget, No rotation, no return wrapper /// /// /// /// /// /// protected internal void DuplicateObject(uint originalPrim, Vector3 offset, uint flags, UUID AgentID, UUID GroupID) { //m_log.DebugFormat("[SCENE]: Duplication of object {0} at offset {1} requested by agent {2}", originalPrim, offset, AgentID); // SceneObjectGroup dupe = DuplicateObject(originalPrim, offset, flags, AgentID, GroupID, Quaternion.Zero); DuplicateObject(originalPrim, offset, flags, AgentID, GroupID, Quaternion.Identity); } /// /// Duplicate the given object. /// /// /// /// /// /// /// public SceneObjectGroup DuplicateObject(uint originalPrimID, Vector3 offset, uint flags, UUID AgentID, UUID GroupID, Quaternion rot) { //m_log.DebugFormat("[SCENE]: Duplication of object {0} at offset {1} requested by agent {2}", originalPrim, offset, AgentID); SceneObjectGroup original = GetGroupByPrim(originalPrimID); if (original != null) { if (m_parentScene.Permissions.CanDuplicateObject( original.PrimCount, original.UUID, AgentID, original.AbsolutePosition)) { SceneObjectGroup copy = original.Copy(true); copy.AbsolutePosition = copy.AbsolutePosition + offset; if (original.OwnerID != AgentID) { copy.SetOwnerId(AgentID); copy.SetRootPartOwner(copy.RootPart, AgentID, GroupID); List partList = new List(copy.Children.Values); if (m_parentScene.Permissions.PropagatePermissions()) { foreach (SceneObjectPart child in partList) { child.Inventory.ChangeInventoryOwner(AgentID); child.TriggerScriptChangedEvent(Changed.OWNER); child.ApplyNextOwnerPermissions(); } } } Entities.Add(copy); // Since we copy from a source group that is in selected // state, but the copy is shown deselected in the viewer, // We need to clear the selection flag here, else that // prim never gets persisted at all. The client doesn't // think it's selected, so it will never send a deselect... copy.IsSelected = false; m_numPrim += copy.Children.Count; if (rot != Quaternion.Identity) { copy.UpdateGroupRotationR(rot); } copy.CreateScriptInstances(0, false, m_parentScene.DefaultScriptEngine, 1); copy.HasGroupChanged = true; copy.ScheduleGroupForFullUpdate(); copy.ResumeScripts(); // required for physics to update it's position copy.AbsolutePosition = copy.AbsolutePosition; if (OnObjectDuplicate != null) OnObjectDuplicate(original, copy); return copy; } } else { m_log.WarnFormat("[SCENE]: Attempted to duplicate nonexistant prim id {0}", GroupID); } return null; } /// /// Calculates the distance between two Vector3s /// /// /// /// protected internal float Vector3Distance(Vector3 v1, Vector3 v2) { // We don't really need the double floating point precision... // so casting it to a single return (float) Math.Sqrt((v1.X - v2.X) * (v1.X - v2.X) + (v1.Y - v2.Y) * (v1.Y - v2.Y) + (v1.Z - v2.Z) * (v1.Z - v2.Z)); } #endregion } }