From 95be3eccd28f39b33e70202d2db4f7d57a99c9c8 Mon Sep 17 00:00:00 2001
From: Teravus Ovares (Dan Olivares)
Date: Sat, 15 Aug 2009 00:01:58 -0400
Subject: * minor: comments * also re-trigger panda
---
OpenSim/Region/Framework/Scenes/Scene.cs | 101 ++++++++++++++++++++++++++++++-
1 file changed, 99 insertions(+), 2 deletions(-)
(limited to 'OpenSim/Region/Framework/Scenes/Scene.cs')
diff --git a/OpenSim/Region/Framework/Scenes/Scene.cs b/OpenSim/Region/Framework/Scenes/Scene.cs
index 56e5ef0..18d7bad 100644
--- a/OpenSim/Region/Framework/Scenes/Scene.cs
+++ b/OpenSim/Region/Framework/Scenes/Scene.cs
@@ -1038,6 +1038,10 @@ namespace OpenSim.Region.Framework.Scenes
}
}
+ ///
+ /// Send out simstats data to all clients
+ ///
+ /// Stats on the Simulator's performance
private void SendSimStatsPackets(SimStats stats)
{
List StatSendAgents = GetScenePresences();
@@ -1050,6 +1054,9 @@ namespace OpenSim.Region.Framework.Scenes
}
}
+ ///
+ /// Recount SceneObjectPart in parcel aabb
+ ///
private void UpdateLand()
{
if (LandChannel != null)
@@ -1061,11 +1068,17 @@ namespace OpenSim.Region.Framework.Scenes
}
}
+ ///
+ /// Update the terrain if it needs to be updated.
+ ///
private void UpdateTerrain()
{
EventManager.TriggerTerrainTick();
}
+ ///
+ /// Back up queued up changes
+ ///
private void UpdateStorageBackup()
{
if (!m_backingup)
@@ -1078,6 +1091,9 @@ namespace OpenSim.Region.Framework.Scenes
}
}
+ ///
+ /// Sends out the OnFrame event to the modules
+ ///
private void UpdateEvents()
{
m_eventManager.TriggerOnFrame();
@@ -1133,6 +1149,10 @@ namespace OpenSim.Region.Framework.Scenes
}
}
+ ///
+ /// Synchronous force backup. For deletes and links/unlinks
+ ///
+ /// Object to be backed up
public void ForceSceneObjectBackup(SceneObjectGroup group)
{
if (group != null)
@@ -1141,6 +1161,13 @@ namespace OpenSim.Region.Framework.Scenes
}
}
+ ///
+ /// Return object to avatar Message
+ ///
+ /// Avatar Unique Id
+ /// Name of object returned
+ /// Location of object returned
+ /// Reasion for object return
public void AddReturn(UUID agentID, string objectName, Vector3 location, string reason)
{
lock (m_returns)
@@ -1167,6 +1194,9 @@ namespace OpenSim.Region.Framework.Scenes
#region Load Terrain
+ ///
+ /// Store the terrain in the persistant data store
+ ///
public void SaveTerrain()
{
m_storageManager.DataStore.StoreTerrain(Heightmap.GetDoubles(), RegionInfo.RegionID);
@@ -1269,6 +1299,10 @@ namespace OpenSim.Region.Framework.Scenes
#region Load Land
+ ///
+ /// Loads all Parcel data from the datastore for region identified by regionID
+ ///
+ /// Unique Identifier of the Region to load parcel data for
public void loadAllLandObjectsFromStorage(UUID regionID)
{
m_log.Info("[SCENE]: Loading land objects from storage");
@@ -1322,6 +1356,20 @@ namespace OpenSim.Region.Framework.Scenes
m_log.Info("[SCENE]: Loaded " + PrimsFromDB.Count.ToString() + " SceneObject(s)");
}
+
+ ///
+ /// Gets a new rez location based on the raycast and the size of the object that is being rezzed.
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
public Vector3 GetNewRezLocation(Vector3 RayStart, Vector3 RayEnd, UUID RayTargetID, Quaternion rot, byte bypassRayCast, byte RayEndIsIntersection, bool frontFacesOnly, Vector3 scale, bool FaceCenter)
{
Vector3 pos = Vector3.Zero;
@@ -1412,6 +1460,19 @@ namespace OpenSim.Region.Framework.Scenes
}
}
+
+ ///
+ /// Create a New SceneObjectGroup/Part by raycasting
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
+ ///
public virtual void AddNewPrim(UUID ownerID, UUID groupID, Vector3 RayEnd, Quaternion rot, PrimitiveBaseShape shape,
byte bypassRaycast, Vector3 RayStart, UUID RayTargetID,
byte RayEndIsIntersection)
@@ -1829,6 +1890,12 @@ namespace OpenSim.Region.Framework.Scenes
return true;
}
+ ///
+ /// Attachment rezzing
+ ///
+ /// Agent Unique ID
+ /// Object ID
+ /// False
public virtual bool IncomingCreateObject(UUID userID, UUID itemID)
{
ScenePresence sp = GetScenePresence(userID);
@@ -1841,6 +1908,13 @@ namespace OpenSim.Region.Framework.Scenes
return false;
}
+ ///
+ /// Adds a Scene Object group to the Scene.
+ /// Verifies that the creator of the object is not banned from the simulator.
+ /// Checks if the item is an Attachment
+ ///
+ ///
+ /// True if the SceneObjectGroup was added, False if it was not
public bool AddSceneObject(SceneObjectGroup sceneObject)
{
// If the user is banned, we won't let any of their objects
@@ -1933,6 +2007,10 @@ namespace OpenSim.Region.Framework.Scenes
#region Add/Remove Avatar Methods
+ ///
+ /// Adding a New Client and Create a Presence for it.
+ ///
+ ///
public override void AddNewClient(IClientAPI client)
{
SubscribeToClientEvents(client);
@@ -1977,6 +2055,10 @@ namespace OpenSim.Region.Framework.Scenes
EventManager.TriggerOnNewClient(client);
}
+ ///
+ /// Register for events from the client
+ ///
+ /// The IClientAPI of the connected client
protected virtual void SubscribeToClientEvents(IClientAPI client)
{
client.OnRegionHandShakeReply += SendLayerData;
@@ -2070,8 +2152,8 @@ namespace OpenSim.Region.Framework.Scenes
///
/// Teleport an avatar to their home region
///
- ///
- ///
+ /// The avatar's Unique ID
+ /// The IClientAPI for the client
public virtual void TeleportClientHome(UUID agentId, IClientAPI client)
{
UserProfileData UserProfile = CommsManager.UserService.GetUserProfile(agentId);
@@ -2099,6 +2181,21 @@ namespace OpenSim.Region.Framework.Scenes
}
}
+ ///
+ /// Duplicates object specified by localID at position raycasted against RayTargetObject using
+ /// RayEnd and RayStart to determine what the angle of the ray is
+ ///
+ /// ID of object to duplicate
+ ///
+ /// Agent doing the duplication
+ /// Group of new object
+ /// The target of the Ray
+ /// The ending of the ray (farthest away point)
+ /// The Beginning of the ray (closest point)
+ /// Bool to bypass raycasting
+ /// The End specified is the place to add the object
+ /// Position the object at the center of the face that it's colliding with
+ /// Rotate the object the same as the localID object
public void doObjectDuplicateOnRay(uint localID, uint dupeFlags, UUID AgentID, UUID GroupID,
UUID RayTargetObj, Vector3 RayEnd, Vector3 RayStart,
bool BypassRaycast, bool RayEndIsIntersection, bool CopyCenters, bool CopyRotates)
--
cgit v1.1