From 0a85d1d767d5ab3b37a3a1a797be843d0b54780e Mon Sep 17 00:00:00 2001 From: "Teravus Ovares (Dan Olivares)" Date: Wed, 12 Aug 2009 23:34:12 -0400 Subject: [PATCH] minor:comments --- OpenSim/Framework/Animation.cs | 30 +++++++++++++++++++ OpenSim/Framework/AssetBase.cs | 29 +++++++++++++++++- OpenSim/Framework/AvatarAppearance.cs | 7 ++--- OpenSim/Framework/AvatarPickerAvatar.cs | 14 +++++++++ .../AvatarPickerReplyAgentDataArgs.cs | 10 +++++++ OpenSim/Framework/Culture.cs | 3 ++ OpenSim/Framework/LandData.cs | 3 ++ 7 files changed, 91 insertions(+), 5 deletions(-) diff --git a/OpenSim/Framework/Animation.cs b/OpenSim/Framework/Animation.cs index 9f865135ed..232f5a1893 100644 --- a/OpenSim/Framework/Animation.cs +++ b/OpenSim/Framework/Animation.cs @@ -31,10 +31,17 @@ using OpenMetaverse.StructuredData; namespace OpenSim.Framework { + /// + /// Information about an Animation + /// [Serializable] public class Animation { private UUID animID; + + /// + /// ID of Animation + /// public UUID AnimID { get { return animID; } @@ -49,6 +56,10 @@ namespace OpenSim.Framework } private UUID objectID; + + /// + /// Unique ID of object that is being animated + /// public UUID ObjectID { get { return objectID; } @@ -59,6 +70,12 @@ namespace OpenSim.Framework { } + /// + /// Creates an Animation based on the data + /// + /// UUID ID of animation + /// + /// ID of object to be animated public Animation(UUID animID, int sequenceNum, UUID objectID) { this.animID = animID; @@ -66,11 +83,20 @@ namespace OpenSim.Framework this.objectID = objectID; } + /// + /// Animation from OSDMap from LLSD XML or LLSD json + /// + /// public Animation(OSDMap args) { UnpackUpdateMessage(args); } + + /// + /// Pack this object up as an OSDMap for transferring via LLSD XML or LLSD json + /// + /// public OSDMap PackUpdateMessage() { OSDMap anim = new OSDMap(); @@ -80,6 +106,10 @@ namespace OpenSim.Framework return anim; } + /// + /// Fill object with data from OSDMap + /// + /// public void UnpackUpdateMessage(OSDMap args) { if (args["animation"] != null) diff --git a/OpenSim/Framework/AssetBase.cs b/OpenSim/Framework/AssetBase.cs index 614670cc81..9679ff2512 100644 --- a/OpenSim/Framework/AssetBase.cs +++ b/OpenSim/Framework/AssetBase.cs @@ -31,10 +31,20 @@ using OpenMetaverse; namespace OpenSim.Framework { + /// + /// Asset class. All Assets are reference by this class or a class derived from this class + /// [Serializable] public class AssetBase { + /// + /// Data of the Asset + /// private byte[] m_data; + + /// + /// Meta Data of the Asset + /// private AssetMetadata m_metadata; public AssetBase() @@ -71,6 +81,9 @@ namespace OpenSim.Framework } + /// + /// Checks if this asset is a binary or text asset + /// public bool IsBinaryAsset { get @@ -102,12 +115,17 @@ namespace OpenSim.Framework set { m_data = value; } } + /// + /// Asset UUID + /// public UUID FullID { get { return m_metadata.FullID; } set { m_metadata.FullID = value; } } - + /// + /// Asset MetaData ID (transferring from UUID to string ID) + /// public string ID { get { return m_metadata.ID; } @@ -126,18 +144,27 @@ namespace OpenSim.Framework set { m_metadata.Description = value; } } + /// + /// (sbyte) AssetType enum + /// public sbyte Type { get { return m_metadata.Type; } set { m_metadata.Type = value; } } + /// + /// Is this a region only asset, or does this exist on the asset server also + /// public bool Local { get { return m_metadata.Local; } set { m_metadata.Local = value; } } + /// + /// Is this asset going to be saved to the asset database? + /// public bool Temporary { get { return m_metadata.Temporary; } diff --git a/OpenSim/Framework/AvatarAppearance.cs b/OpenSim/Framework/AvatarAppearance.cs index 6a07bc962f..7270f32646 100644 --- a/OpenSim/Framework/AvatarAppearance.cs +++ b/OpenSim/Framework/AvatarAppearance.cs @@ -28,14 +28,13 @@ using System; using System.Collections; using System.Collections.Generic; -using System.Runtime.Serialization; -using System.Security.Permissions; using OpenMetaverse; -using log4net; -using System.Reflection; namespace OpenSim.Framework { + /// + /// Contains the Avatar's Appearance and methods to manipulate the appearance. + /// public class AvatarAppearance { //private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); diff --git a/OpenSim/Framework/AvatarPickerAvatar.cs b/OpenSim/Framework/AvatarPickerAvatar.cs index 0e8602dd81..200c054b5f 100644 --- a/OpenSim/Framework/AvatarPickerAvatar.cs +++ b/OpenSim/Framework/AvatarPickerAvatar.cs @@ -29,10 +29,24 @@ using OpenMetaverse; namespace OpenSim.Framework { + /// + /// Avatar returned by the Avatar Picker request + /// public class AvatarPickerAvatar { + /// + /// Avatar's Unique ID + /// public UUID AvatarID; + + /// + /// Avatar's Account first name + /// public string firstName; + + /// + /// Avatar's Account last name + /// public string lastName; } } diff --git a/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs b/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs index 8fd21d710d..54835da929 100644 --- a/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs +++ b/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs @@ -30,9 +30,19 @@ using OpenMetaverse; namespace OpenSim.Framework { + /// + /// Args to return to a client that queries picker data + /// public class AvatarPickerReplyAgentDataArgs : EventArgs { + /// + /// Unique Agent ID + /// public UUID AgentID; + + /// + /// ID of query user submitted + /// public UUID QueryID; } } diff --git a/OpenSim/Framework/Culture.cs b/OpenSim/Framework/Culture.cs index c76841dc89..2066794671 100644 --- a/OpenSim/Framework/Culture.cs +++ b/OpenSim/Framework/Culture.cs @@ -45,6 +45,9 @@ namespace OpenSim.Framework get { return m_cultureInfo; } } + /// + /// Set Culture to en-US to make string processing of numbers simpler. + /// public static void SetCurrentCulture() { Thread.CurrentThread.CurrentCulture = m_cultureInfo; diff --git a/OpenSim/Framework/LandData.cs b/OpenSim/Framework/LandData.cs index d6afb9547a..94c0d3b1c1 100644 --- a/OpenSim/Framework/LandData.cs +++ b/OpenSim/Framework/LandData.cs @@ -31,6 +31,9 @@ using OpenMetaverse; namespace OpenSim.Framework { + /// + /// Details of a Parcel of land + /// public class LandData { private Vector3 _AABBMax = new Vector3();