diff options
author | Teravus Ovares (Dan Olivares) | 2009-08-12 23:34:12 -0400 |
---|---|---|
committer | Teravus Ovares (Dan Olivares) | 2009-08-12 23:34:12 -0400 |
commit | 0a85d1d767d5ab3b37a3a1a797be843d0b54780e (patch) | |
tree | 5e05a0533fa6c54229a17cf1f6712bfdf7e52493 /OpenSim | |
parent | minor: comments (diff) | |
download | opensim-SC-0a85d1d767d5ab3b37a3a1a797be843d0b54780e.zip opensim-SC-0a85d1d767d5ab3b37a3a1a797be843d0b54780e.tar.gz opensim-SC-0a85d1d767d5ab3b37a3a1a797be843d0b54780e.tar.bz2 opensim-SC-0a85d1d767d5ab3b37a3a1a797be843d0b54780e.tar.xz |
minor:comments
Diffstat (limited to 'OpenSim')
-rw-r--r-- | OpenSim/Framework/Animation.cs | 30 | ||||
-rw-r--r-- | OpenSim/Framework/AssetBase.cs | 29 | ||||
-rw-r--r-- | OpenSim/Framework/AvatarAppearance.cs | 7 | ||||
-rw-r--r-- | OpenSim/Framework/AvatarPickerAvatar.cs | 14 | ||||
-rw-r--r-- | OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs | 10 | ||||
-rw-r--r-- | OpenSim/Framework/Culture.cs | 3 | ||||
-rw-r--r-- | 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 9f86513..232f5a1 100644 --- a/OpenSim/Framework/Animation.cs +++ b/OpenSim/Framework/Animation.cs | |||
@@ -31,10 +31,17 @@ using OpenMetaverse.StructuredData; | |||
31 | 31 | ||
32 | namespace OpenSim.Framework | 32 | namespace OpenSim.Framework |
33 | { | 33 | { |
34 | /// <summary> | ||
35 | /// Information about an Animation | ||
36 | /// </summary> | ||
34 | [Serializable] | 37 | [Serializable] |
35 | public class Animation | 38 | public class Animation |
36 | { | 39 | { |
37 | private UUID animID; | 40 | private UUID animID; |
41 | |||
42 | /// <summary> | ||
43 | /// ID of Animation | ||
44 | /// </summary> | ||
38 | public UUID AnimID | 45 | public UUID AnimID |
39 | { | 46 | { |
40 | get { return animID; } | 47 | get { return animID; } |
@@ -49,6 +56,10 @@ namespace OpenSim.Framework | |||
49 | } | 56 | } |
50 | 57 | ||
51 | private UUID objectID; | 58 | private UUID objectID; |
59 | |||
60 | /// <summary> | ||
61 | /// Unique ID of object that is being animated | ||
62 | /// </summary> | ||
52 | public UUID ObjectID | 63 | public UUID ObjectID |
53 | { | 64 | { |
54 | get { return objectID; } | 65 | get { return objectID; } |
@@ -59,6 +70,12 @@ namespace OpenSim.Framework | |||
59 | { | 70 | { |
60 | } | 71 | } |
61 | 72 | ||
73 | /// <summary> | ||
74 | /// Creates an Animation based on the data | ||
75 | /// </summary> | ||
76 | /// <param name="animID">UUID ID of animation</param> | ||
77 | /// <param name="sequenceNum"></param> | ||
78 | /// <param name="objectID">ID of object to be animated</param> | ||
62 | public Animation(UUID animID, int sequenceNum, UUID objectID) | 79 | public Animation(UUID animID, int sequenceNum, UUID objectID) |
63 | { | 80 | { |
64 | this.animID = animID; | 81 | this.animID = animID; |
@@ -66,11 +83,20 @@ namespace OpenSim.Framework | |||
66 | this.objectID = objectID; | 83 | this.objectID = objectID; |
67 | } | 84 | } |
68 | 85 | ||
86 | /// <summary> | ||
87 | /// Animation from OSDMap from LLSD XML or LLSD json | ||
88 | /// </summary> | ||
89 | /// <param name="args"></param> | ||
69 | public Animation(OSDMap args) | 90 | public Animation(OSDMap args) |
70 | { | 91 | { |
71 | UnpackUpdateMessage(args); | 92 | UnpackUpdateMessage(args); |
72 | } | 93 | } |
73 | 94 | ||
95 | |||
96 | /// <summary> | ||
97 | /// Pack this object up as an OSDMap for transferring via LLSD XML or LLSD json | ||
98 | /// </summary> | ||
99 | /// <returns></returns> | ||
74 | public OSDMap PackUpdateMessage() | 100 | public OSDMap PackUpdateMessage() |
75 | { | 101 | { |
76 | OSDMap anim = new OSDMap(); | 102 | OSDMap anim = new OSDMap(); |
@@ -80,6 +106,10 @@ namespace OpenSim.Framework | |||
80 | return anim; | 106 | return anim; |
81 | } | 107 | } |
82 | 108 | ||
109 | /// <summary> | ||
110 | /// Fill object with data from OSDMap | ||
111 | /// </summary> | ||
112 | /// <param name="args"></param> | ||
83 | public void UnpackUpdateMessage(OSDMap args) | 113 | public void UnpackUpdateMessage(OSDMap args) |
84 | { | 114 | { |
85 | if (args["animation"] != null) | 115 | if (args["animation"] != null) |
diff --git a/OpenSim/Framework/AssetBase.cs b/OpenSim/Framework/AssetBase.cs index 614670c..9679ff2 100644 --- a/OpenSim/Framework/AssetBase.cs +++ b/OpenSim/Framework/AssetBase.cs | |||
@@ -31,10 +31,20 @@ using OpenMetaverse; | |||
31 | 31 | ||
32 | namespace OpenSim.Framework | 32 | namespace OpenSim.Framework |
33 | { | 33 | { |
34 | /// <summary> | ||
35 | /// Asset class. All Assets are reference by this class or a class derived from this class | ||
36 | /// </summary> | ||
34 | [Serializable] | 37 | [Serializable] |
35 | public class AssetBase | 38 | public class AssetBase |
36 | { | 39 | { |
40 | /// <summary> | ||
41 | /// Data of the Asset | ||
42 | /// </summary> | ||
37 | private byte[] m_data; | 43 | private byte[] m_data; |
44 | |||
45 | /// <summary> | ||
46 | /// Meta Data of the Asset | ||
47 | /// </summary> | ||
38 | private AssetMetadata m_metadata; | 48 | private AssetMetadata m_metadata; |
39 | 49 | ||
40 | public AssetBase() | 50 | public AssetBase() |
@@ -71,6 +81,9 @@ namespace OpenSim.Framework | |||
71 | 81 | ||
72 | } | 82 | } |
73 | 83 | ||
84 | /// <summary> | ||
85 | /// Checks if this asset is a binary or text asset | ||
86 | /// </summary> | ||
74 | public bool IsBinaryAsset | 87 | public bool IsBinaryAsset |
75 | { | 88 | { |
76 | get | 89 | get |
@@ -102,12 +115,17 @@ namespace OpenSim.Framework | |||
102 | set { m_data = value; } | 115 | set { m_data = value; } |
103 | } | 116 | } |
104 | 117 | ||
118 | /// <summary> | ||
119 | /// Asset UUID | ||
120 | /// </summary> | ||
105 | public UUID FullID | 121 | public UUID FullID |
106 | { | 122 | { |
107 | get { return m_metadata.FullID; } | 123 | get { return m_metadata.FullID; } |
108 | set { m_metadata.FullID = value; } | 124 | set { m_metadata.FullID = value; } |
109 | } | 125 | } |
110 | 126 | /// <summary> | |
127 | /// Asset MetaData ID (transferring from UUID to string ID) | ||
128 | /// </summary> | ||
111 | public string ID | 129 | public string ID |
112 | { | 130 | { |
113 | get { return m_metadata.ID; } | 131 | get { return m_metadata.ID; } |
@@ -126,18 +144,27 @@ namespace OpenSim.Framework | |||
126 | set { m_metadata.Description = value; } | 144 | set { m_metadata.Description = value; } |
127 | } | 145 | } |
128 | 146 | ||
147 | /// <summary> | ||
148 | /// (sbyte) AssetType enum | ||
149 | /// </summary> | ||
129 | public sbyte Type | 150 | public sbyte Type |
130 | { | 151 | { |
131 | get { return m_metadata.Type; } | 152 | get { return m_metadata.Type; } |
132 | set { m_metadata.Type = value; } | 153 | set { m_metadata.Type = value; } |
133 | } | 154 | } |
134 | 155 | ||
156 | /// <summary> | ||
157 | /// Is this a region only asset, or does this exist on the asset server also | ||
158 | /// </summary> | ||
135 | public bool Local | 159 | public bool Local |
136 | { | 160 | { |
137 | get { return m_metadata.Local; } | 161 | get { return m_metadata.Local; } |
138 | set { m_metadata.Local = value; } | 162 | set { m_metadata.Local = value; } |
139 | } | 163 | } |
140 | 164 | ||
165 | /// <summary> | ||
166 | /// Is this asset going to be saved to the asset database? | ||
167 | /// </summary> | ||
141 | public bool Temporary | 168 | public bool Temporary |
142 | { | 169 | { |
143 | get { return m_metadata.Temporary; } | 170 | get { return m_metadata.Temporary; } |
diff --git a/OpenSim/Framework/AvatarAppearance.cs b/OpenSim/Framework/AvatarAppearance.cs index 6a07bc9..7270f32 100644 --- a/OpenSim/Framework/AvatarAppearance.cs +++ b/OpenSim/Framework/AvatarAppearance.cs | |||
@@ -28,14 +28,13 @@ | |||
28 | using System; | 28 | using System; |
29 | using System.Collections; | 29 | using System.Collections; |
30 | using System.Collections.Generic; | 30 | using System.Collections.Generic; |
31 | using System.Runtime.Serialization; | ||
32 | using System.Security.Permissions; | ||
33 | using OpenMetaverse; | 31 | using OpenMetaverse; |
34 | using log4net; | ||
35 | using System.Reflection; | ||
36 | 32 | ||
37 | namespace OpenSim.Framework | 33 | namespace OpenSim.Framework |
38 | { | 34 | { |
35 | /// <summary> | ||
36 | /// Contains the Avatar's Appearance and methods to manipulate the appearance. | ||
37 | /// </summary> | ||
39 | public class AvatarAppearance | 38 | public class AvatarAppearance |
40 | { | 39 | { |
41 | //private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); | 40 | //private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); |
diff --git a/OpenSim/Framework/AvatarPickerAvatar.cs b/OpenSim/Framework/AvatarPickerAvatar.cs index 0e8602d..200c054 100644 --- a/OpenSim/Framework/AvatarPickerAvatar.cs +++ b/OpenSim/Framework/AvatarPickerAvatar.cs | |||
@@ -29,10 +29,24 @@ using OpenMetaverse; | |||
29 | 29 | ||
30 | namespace OpenSim.Framework | 30 | namespace OpenSim.Framework |
31 | { | 31 | { |
32 | /// <summary> | ||
33 | /// Avatar returned by the Avatar Picker request | ||
34 | /// </summary> | ||
32 | public class AvatarPickerAvatar | 35 | public class AvatarPickerAvatar |
33 | { | 36 | { |
37 | /// <summary> | ||
38 | /// Avatar's Unique ID | ||
39 | /// </summary> | ||
34 | public UUID AvatarID; | 40 | public UUID AvatarID; |
41 | |||
42 | /// <summary> | ||
43 | /// Avatar's Account first name | ||
44 | /// </summary> | ||
35 | public string firstName; | 45 | public string firstName; |
46 | |||
47 | /// <summary> | ||
48 | /// Avatar's Account last name | ||
49 | /// </summary> | ||
36 | public string lastName; | 50 | public string lastName; |
37 | } | 51 | } |
38 | } | 52 | } |
diff --git a/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs b/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs index 8fd21d7..54835da 100644 --- a/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs +++ b/OpenSim/Framework/AvatarPickerReplyAgentDataArgs.cs | |||
@@ -30,9 +30,19 @@ using OpenMetaverse; | |||
30 | 30 | ||
31 | namespace OpenSim.Framework | 31 | namespace OpenSim.Framework |
32 | { | 32 | { |
33 | /// <summary> | ||
34 | /// Args to return to a client that queries picker data | ||
35 | /// </summary> | ||
33 | public class AvatarPickerReplyAgentDataArgs : EventArgs | 36 | public class AvatarPickerReplyAgentDataArgs : EventArgs |
34 | { | 37 | { |
38 | /// <summary> | ||
39 | /// Unique Agent ID | ||
40 | /// </summary> | ||
35 | public UUID AgentID; | 41 | public UUID AgentID; |
42 | |||
43 | /// <summary> | ||
44 | /// ID of query user submitted | ||
45 | /// </summary> | ||
36 | public UUID QueryID; | 46 | public UUID QueryID; |
37 | } | 47 | } |
38 | } | 48 | } |
diff --git a/OpenSim/Framework/Culture.cs b/OpenSim/Framework/Culture.cs index c76841d..2066794 100644 --- a/OpenSim/Framework/Culture.cs +++ b/OpenSim/Framework/Culture.cs | |||
@@ -45,6 +45,9 @@ namespace OpenSim.Framework | |||
45 | get { return m_cultureInfo; } | 45 | get { return m_cultureInfo; } |
46 | } | 46 | } |
47 | 47 | ||
48 | /// <summary> | ||
49 | /// Set Culture to en-US to make string processing of numbers simpler. | ||
50 | /// </summary> | ||
48 | public static void SetCurrentCulture() | 51 | public static void SetCurrentCulture() |
49 | { | 52 | { |
50 | Thread.CurrentThread.CurrentCulture = m_cultureInfo; | 53 | Thread.CurrentThread.CurrentCulture = m_cultureInfo; |
diff --git a/OpenSim/Framework/LandData.cs b/OpenSim/Framework/LandData.cs index d6afb95..94c0d3b 100644 --- a/OpenSim/Framework/LandData.cs +++ b/OpenSim/Framework/LandData.cs | |||
@@ -31,6 +31,9 @@ using OpenMetaverse; | |||
31 | 31 | ||
32 | namespace OpenSim.Framework | 32 | namespace OpenSim.Framework |
33 | { | 33 | { |
34 | /// <summary> | ||
35 | /// Details of a Parcel of land | ||
36 | /// </summary> | ||
34 | public class LandData | 37 | public class LandData |
35 | { | 38 | { |
36 | private Vector3 _AABBMax = new Vector3(); | 39 | private Vector3 _AABBMax = new Vector3(); |