From 23c4a409b754e708cc36cd13108060e9569fb08d Mon Sep 17 00:00:00 2001
From: Justin Clarke Casey
Date: Sat, 12 Jul 2008 21:43:35 +0000
Subject: minor: method documentation
---
OpenSim/Region/Environment/Scenes/InnerScene.cs | 21 +++
.../Region/Environment/Scenes/SceneObjectGroup.cs | 6 +-
.../Region/Environment/Scenes/SceneObjectPart.cs | 180 ++++++++-------------
3 files changed, 90 insertions(+), 117 deletions(-)
(limited to 'OpenSim/Region/Environment/Scenes')
diff --git a/OpenSim/Region/Environment/Scenes/InnerScene.cs b/OpenSim/Region/Environment/Scenes/InnerScene.cs
index d553f4b..6a2b2d9 100644
--- a/OpenSim/Region/Environment/Scenes/InnerScene.cs
+++ b/OpenSim/Region/Environment/Scenes/InnerScene.cs
@@ -747,6 +747,11 @@ namespace OpenSim.Region.Environment.Scenes
return sp;
}
+ ///
+ /// 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
private SceneObjectGroup GetGroupByPrim(uint localID)
{
List EntityList = GetEntities();
@@ -762,6 +767,11 @@ namespace OpenSim.Region.Environment.Scenes
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(LLUUID fullID)
{
List EntityList = GetEntities();
@@ -802,15 +812,26 @@ namespace OpenSim.Region.Environment.Scenes
return returnResult;
}
+ ///
+ /// 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 group.GetChildPart(localID);
else
return null;
}
+ ///
+ /// Get a part contained in this scene.
+ ///
+ ///
+ /// null if the part was not found
protected internal SceneObjectPart GetSceneObjectPart(LLUUID fullID)
{
SceneObjectGroup group = GetGroupByPrim(fullID);
diff --git a/OpenSim/Region/Environment/Scenes/SceneObjectGroup.cs b/OpenSim/Region/Environment/Scenes/SceneObjectGroup.cs
index 1482f9a..1b3d942 100644
--- a/OpenSim/Region/Environment/Scenes/SceneObjectGroup.cs
+++ b/OpenSim/Region/Environment/Scenes/SceneObjectGroup.cs
@@ -442,12 +442,12 @@ namespace OpenSim.Region.Environment.Scenes
}
more = !reader.EOF;
}
+
reader.Close();
sr.Close();
UpdateParentIDs();
}
-
///
///
@@ -832,7 +832,7 @@ namespace OpenSim.Region.Environment.Scenes
}
///
- ///
+ /// Make sure that every non root part has the proper parent root part local id
///
public void UpdateParentIDs()
{
@@ -1663,6 +1663,7 @@ namespace OpenSim.Region.Environment.Scenes
{
return true;
}
+
return false;
}
@@ -1684,6 +1685,7 @@ namespace OpenSim.Region.Environment.Scenes
}
}
}
+
return false;
}
diff --git a/OpenSim/Region/Environment/Scenes/SceneObjectPart.cs b/OpenSim/Region/Environment/Scenes/SceneObjectPart.cs
index 8bf8575..b71657d 100644
--- a/OpenSim/Region/Environment/Scenes/SceneObjectPart.cs
+++ b/OpenSim/Region/Environment/Scenes/SceneObjectPart.cs
@@ -819,151 +819,101 @@ namespace OpenSim.Region.Environment.Scenes
}
}
- public uint ParentID {
- get {
- return _parentID;
- }
- set {
- _parentID = value;
- }
+ public uint ParentID
+ {
+ get { return _parentID; }
+ set { _parentID = value; }
}
- public int CreationDate {
- get {
- return _creationDate;
- }
- set {
- _creationDate = value;
- }
+ public int CreationDate
+ {
+ get { return _creationDate; }
+ set { _creationDate = value; }
}
- public uint Category {
- get {
- return _category;
- }
- set {
- _category = value;
- }
+ public uint Category
+ {
+ get { return _category; }
+ set { _category = value; }
}
- public int SalePrice {
- get {
- return _salePrice;
- }
- set {
- _salePrice = value;
- }
+ public int SalePrice
+ {
+ get { return _salePrice; }
+ set { _salePrice = value; }
}
- public byte ObjectSaleType {
- get {
- return _objectSaleType;
- }
- set {
- _objectSaleType = value;
- }
+ public byte ObjectSaleType
+ {
+ get { return _objectSaleType; }
+ set { _objectSaleType = value; }
}
- public int OwnershipCost {
- get {
- return _ownershipCost;
- }
- set {
- _ownershipCost = value;
- }
+ public int OwnershipCost
+ {
+ get { return _ownershipCost; }
+ set { _ownershipCost = value; }
}
- public LLUUID GroupID {
- get {
- return _groupID;
- }
- set {
- _groupID = value;
- }
+ public LLUUID GroupID
+ {
+ get { return _groupID; }
+ set { _groupID = value; }
}
- public LLUUID OwnerID {
- get {
- return _ownerID;
- }
- set {
- _ownerID = value;
- }
+ public LLUUID OwnerID
+ {
+ get { return _ownerID; }
+ set { _ownerID = value; }
}
- public LLUUID LastOwnerID {
- get {
- return _lastOwnerID;
- }
- set {
- _lastOwnerID = value;
- }
+ public LLUUID LastOwnerID
+ {
+ get { return _lastOwnerID; }
+ set { _lastOwnerID = value; }
}
- public uint BaseMask {
- get {
- return _baseMask;
- }
- set {
- _baseMask = value;
- }
+ public uint BaseMask
+ {
+ get { return _baseMask; }
+ set { _baseMask = value; }
}
- public uint OwnerMask {
- get {
- return _ownerMask;
- }
- set {
- _ownerMask = value;
- }
+ public uint OwnerMask
+ {
+ get { return _ownerMask; }
+ set { _ownerMask = value; }
}
- public uint GroupMask {
- get {
- return _groupMask;
- }
- set {
- _groupMask = value;
- }
+ public uint GroupMask
+ {
+ get { return _groupMask; }
+ set { _groupMask = value; }
}
- public uint EveryoneMask {
- get {
- return _everyoneMask;
- }
- set {
- _everyoneMask = value;
- }
+ public uint EveryoneMask
+ {
+ get { return _everyoneMask; }
+ set { _everyoneMask = value; }
}
- public uint NextOwnerMask {
- get {
- return _nextOwnerMask;
- }
- set {
- _nextOwnerMask = value;
- }
+ public uint NextOwnerMask
+ {
+ get { return _nextOwnerMask; }
+ set { _nextOwnerMask = value; }
}
- public libsecondlife.LLObject.ObjectFlags Flags {
- get {
- return _flags;
- }
- set {
- _flags = value;
- }
+ public libsecondlife.LLObject.ObjectFlags Flags
+ {
+ get { return _flags; }
+ set { _flags = value; }
}
- public LLUUID SitTargetAvatar {
- get {
- return m_sitTargetAvatar;
- }
- set {
- m_sitTargetAvatar = value;
- }
+ public LLUUID SitTargetAvatar
+ {
+ get { return m_sitTargetAvatar; }
+ set { m_sitTargetAvatar = value; }
}
-
-
#endregion Public Properties with only Get
@@ -982,7 +932,7 @@ namespace OpenSim.Region.Environment.Scenes
}
///
- /// Clear all pending updates
+ /// Clear all pending updates of parts to clients
///
private void ClearUpdateSchedule()
{
--
cgit v1.1