diff options
author | Teravus Ovares (Dan Olivares) | 2010-10-30 02:06:43 -0400 |
---|---|---|
committer | Teravus Ovares (Dan Olivares) | 2010-10-30 02:06:43 -0400 |
commit | 4a24bf74d93924b688fcd5246218083108c93c01 (patch) | |
tree | 430b157be40c50c9dc48c89f95d53ecc3360aa21 /bin/OpenMetaverseTypes.XML | |
parent | Logins work now, but avatars are green ugly gnomes. (diff) | |
download | opensim-SC_OLD-4a24bf74d93924b688fcd5246218083108c93c01.zip opensim-SC_OLD-4a24bf74d93924b688fcd5246218083108c93c01.tar.gz opensim-SC_OLD-4a24bf74d93924b688fcd5246218083108c93c01.tar.bz2 opensim-SC_OLD-4a24bf74d93924b688fcd5246218083108c93c01.tar.xz |
* Thank you lkalif for fixing the {array[array[]]} json OSD serialization issue.
* This is libOMV SVN revision 3463.
Diffstat (limited to '')
-rw-r--r-- | bin/OpenMetaverseTypes.XML | 2178 |
1 files changed, 1089 insertions, 1089 deletions
diff --git a/bin/OpenMetaverseTypes.XML b/bin/OpenMetaverseTypes.XML index c61d91a..befc8d4 100644 --- a/bin/OpenMetaverseTypes.XML +++ b/bin/OpenMetaverseTypes.XML | |||
@@ -4,221 +4,510 @@ | |||
4 | <name>OpenMetaverseTypes</name> | 4 | <name>OpenMetaverseTypes</name> |
5 | </assembly> | 5 | </assembly> |
6 | <members> | 6 | <members> |
7 | <member name="T:OpenMetaverse.UUID"> | 7 | <member name="T:OpenMetaverse.Vector3d"> |
8 | <summary> | 8 | <summary> |
9 | A 128-bit Universally Unique Identifier, used throughout the Second | 9 | A three-dimensional vector with doubleing-point values |
10 | Life networking protocol | ||
11 | </summary> | 10 | </summary> |
12 | </member> | 11 | </member> |
13 | <member name="F:OpenMetaverse.UUID.Guid"> | 12 | <member name="F:OpenMetaverse.Vector3d.X"> |
14 | <summary>The System.Guid object this struct wraps around</summary> | 13 | <summary>X value</summary> |
15 | </member> | 14 | </member> |
16 | <member name="M:OpenMetaverse.UUID.#ctor(System.String)"> | 15 | <member name="F:OpenMetaverse.Vector3d.Y"> |
16 | <summary>Y value</summary> | ||
17 | </member> | ||
18 | <member name="F:OpenMetaverse.Vector3d.Z"> | ||
19 | <summary>Z value</summary> | ||
20 | </member> | ||
21 | <member name="M:OpenMetaverse.Vector3d.#ctor(System.Byte[],System.Int32)"> | ||
17 | <summary> | 22 | <summary> |
18 | Constructor that takes a string UUID representation | 23 | Constructor, builds a vector from a byte array |
19 | </summary> | 24 | </summary> |
20 | <param name="val">A string representation of a UUID, case | 25 | <param name="byteArray">Byte array containing three eight-byte doubles</param> |
21 | insensitive and can either be hyphenated or non-hyphenated</param> | 26 | <param name="pos">Beginning position in the byte array</param> |
22 | <example>UUID("11f8aa9c-b071-4242-836b-13b7abe0d489")</example> | ||
23 | </member> | 27 | </member> |
24 | <member name="M:OpenMetaverse.UUID.#ctor(System.Guid)"> | 28 | <member name="M:OpenMetaverse.Vector3d.ApproxEquals(OpenMetaverse.Vector3d,System.Double)"> |
25 | <summary> | 29 | <summary> |
26 | Constructor that takes a System.Guid object | 30 | Test if this vector is equal to another vector, within a given |
31 | tolerance range | ||
27 | </summary> | 32 | </summary> |
28 | <param name="val">A Guid object that contains the unique identifier | 33 | <param name="vec">Vector to test against</param> |
29 | to be represented by this UUID</param> | 34 | <param name="tolerance">The acceptable magnitude of difference |
35 | between the two vectors</param> | ||
36 | <returns>True if the magnitude of difference between the two vectors | ||
37 | is less than the given tolerance, otherwise false</returns> | ||
30 | </member> | 38 | </member> |
31 | <member name="M:OpenMetaverse.UUID.#ctor(System.Byte[],System.Int32)"> | 39 | <member name="M:OpenMetaverse.Vector3d.CompareTo(OpenMetaverse.Vector3d)"> |
32 | <summary> | 40 | <summary> |
33 | Constructor that takes a byte array containing a UUID | 41 | IComparable.CompareTo implementation |
34 | </summary> | 42 | </summary> |
35 | <param name="source">Byte array containing a 16 byte UUID</param> | ||
36 | <param name="pos">Beginning offset in the array</param> | ||
37 | </member> | 43 | </member> |
38 | <member name="M:OpenMetaverse.UUID.#ctor(System.UInt64)"> | 44 | <member name="M:OpenMetaverse.Vector3d.IsFinite"> |
39 | <summary> | 45 | <summary> |
40 | Constructor that takes an unsigned 64-bit unsigned integer to | 46 | Test if this vector is composed of all finite numbers |
41 | convert to a UUID | ||
42 | </summary> | 47 | </summary> |
43 | <param name="val">64-bit unsigned integer to convert to a UUID</param> | ||
44 | </member> | 48 | </member> |
45 | <member name="M:OpenMetaverse.UUID.#ctor(OpenMetaverse.UUID)"> | 49 | <member name="M:OpenMetaverse.Vector3d.FromBytes(System.Byte[],System.Int32)"> |
46 | <summary> | 50 | <summary> |
47 | Copy constructor | 51 | Builds a vector from a byte array |
48 | </summary> | 52 | </summary> |
49 | <param name="val">UUID to copy</param> | 53 | <param name="byteArray">Byte array containing a 24 byte vector</param> |
54 | <param name="pos">Beginning position in the byte array</param> | ||
50 | </member> | 55 | </member> |
51 | <member name="M:OpenMetaverse.UUID.CompareTo(OpenMetaverse.UUID)"> | 56 | <member name="M:OpenMetaverse.Vector3d.GetBytes"> |
52 | <summary> | 57 | <summary> |
53 | IComparable.CompareTo implementation | 58 | Returns the raw bytes for this vector |
54 | </summary> | 59 | </summary> |
60 | <returns>A 24 byte array containing X, Y, and Z</returns> | ||
55 | </member> | 61 | </member> |
56 | <member name="M:OpenMetaverse.UUID.FromBytes(System.Byte[],System.Int32)"> | 62 | <member name="M:OpenMetaverse.Vector3d.ToBytes(System.Byte[],System.Int32)"> |
57 | <summary> | 63 | <summary> |
58 | Assigns this UUID from 16 bytes out of a byte array | 64 | Writes the raw bytes for this vector to a byte array |
59 | </summary> | 65 | </summary> |
60 | <param name="source">Byte array containing the UUID to assign this UUID to</param> | 66 | <param name="dest">Destination byte array</param> |
61 | <param name="pos">Starting position of the UUID in the byte array</param> | 67 | <param name="pos">Position in the destination array to start |
68 | writing. Must be at least 24 bytes before the end of the array</param> | ||
62 | </member> | 69 | </member> |
63 | <member name="M:OpenMetaverse.UUID.GetBytes"> | 70 | <member name="M:OpenMetaverse.Vector3d.Parse(System.String)"> |
64 | <summary> | 71 | <summary> |
65 | Returns a copy of the raw bytes for this UUID | 72 | Parse a vector from a string |
66 | </summary> | 73 | </summary> |
67 | <returns>A 16 byte array containing this UUID</returns> | 74 | <param name="val">A string representation of a 3D vector, enclosed |
75 | in arrow brackets and separated by commas</param> | ||
68 | </member> | 76 | </member> |
69 | <member name="M:OpenMetaverse.UUID.ToBytes(System.Byte[],System.Int32)"> | 77 | <member name="M:OpenMetaverse.Vector3d.SmoothStep(OpenMetaverse.Vector3d,OpenMetaverse.Vector3d,System.Double)"> |
70 | <summary> | 78 | <summary> |
71 | Writes the raw bytes for this UUID to a byte array | 79 | Interpolates between two vectors using a cubic equation |
72 | </summary> | 80 | </summary> |
73 | <param name="dest">Destination byte array</param> | ||
74 | <param name="pos">Position in the destination array to start | ||
75 | writing. Must be at least 16 bytes before the end of the array</param> | ||
76 | </member> | 81 | </member> |
77 | <member name="M:OpenMetaverse.UUID.CRC"> | 82 | <member name="M:OpenMetaverse.Vector3d.ToString"> |
78 | <summary> | 83 | <summary> |
79 | Calculate an LLCRC (cyclic redundancy check) for this UUID | 84 | Get a formatted string representation of the vector |
80 | </summary> | 85 | </summary> |
81 | <returns>The CRC checksum for this UUID</returns> | 86 | <returns>A string representation of the vector</returns> |
82 | </member> | 87 | </member> |
83 | <member name="M:OpenMetaverse.UUID.GetULong"> | 88 | <member name="M:OpenMetaverse.Vector3d.ToRawString"> |
84 | <summary> | 89 | <summary> |
85 | Create a 64-bit integer representation from the second half of this UUID | 90 | Get a string representation of the vector elements with up to three |
91 | decimal digits and separated by spaces only | ||
86 | </summary> | 92 | </summary> |
87 | <returns>An integer created from the last eight bytes of this UUID</returns> | 93 | <returns>Raw string representation of the vector</returns> |
88 | </member> | 94 | </member> |
89 | <member name="M:OpenMetaverse.UUID.Parse(System.String)"> | 95 | <member name="M:OpenMetaverse.Vector3d.op_Modulus(OpenMetaverse.Vector3d,OpenMetaverse.Vector3d)"> |
90 | <summary> | 96 | <summary> |
91 | Generate a UUID from a string | 97 | Cross product between two vectors |
92 | </summary> | 98 | </summary> |
93 | <param name="val">A string representation of a UUID, case | ||
94 | insensitive and can either be hyphenated or non-hyphenated</param> | ||
95 | <example>UUID.Parse("11f8aa9c-b071-4242-836b-13b7abe0d489")</example> | ||
96 | </member> | 99 | </member> |
97 | <member name="M:OpenMetaverse.UUID.TryParse(System.String,OpenMetaverse.UUID@)"> | 100 | <member name="F:OpenMetaverse.Vector3d.Zero"> |
101 | <summary>A vector with a value of 0,0,0</summary> | ||
102 | </member> | ||
103 | <member name="F:OpenMetaverse.Vector3d.One"> | ||
104 | <summary>A vector with a value of 1,1,1</summary> | ||
105 | </member> | ||
106 | <member name="F:OpenMetaverse.Vector3d.UnitX"> | ||
107 | <summary>A unit vector facing forward (X axis), value of 1,0,0</summary> | ||
108 | </member> | ||
109 | <member name="F:OpenMetaverse.Vector3d.UnitY"> | ||
110 | <summary>A unit vector facing left (Y axis), value of 0,1,0</summary> | ||
111 | </member> | ||
112 | <member name="F:OpenMetaverse.Vector3d.UnitZ"> | ||
113 | <summary>A unit vector facing up (Z axis), value of 0,0,1</summary> | ||
114 | </member> | ||
115 | <member name="T:OpenMetaverse.EnumInfoAttribute"> | ||
98 | <summary> | 116 | <summary> |
99 | Generate a UUID from a string | 117 | Attribute class that allows extra attributes to be attached to ENUMs |
100 | </summary> | 118 | </summary> |
101 | <param name="val">A string representation of a UUID, case | ||
102 | insensitive and can either be hyphenated or non-hyphenated</param> | ||
103 | <param name="result">Will contain the parsed UUID if successful, | ||
104 | otherwise null</param> | ||
105 | <returns>True if the string was successfully parse, otherwise false</returns> | ||
106 | <example>UUID.TryParse("11f8aa9c-b071-4242-836b-13b7abe0d489", result)</example> | ||
107 | </member> | 119 | </member> |
108 | <member name="M:OpenMetaverse.UUID.Combine(OpenMetaverse.UUID,OpenMetaverse.UUID)"> | 120 | <member name="F:OpenMetaverse.EnumInfoAttribute.Text"> |
121 | <summary>Text used when presenting ENUM to user</summary> | ||
122 | </member> | ||
123 | <member name="M:OpenMetaverse.EnumInfoAttribute.#ctor"> | ||
124 | <summary>Default initializer</summary> | ||
125 | </member> | ||
126 | <member name="M:OpenMetaverse.EnumInfoAttribute.#ctor(System.String)"> | ||
127 | <summary>Text used when presenting ENUM to user</summary> | ||
128 | </member> | ||
129 | <member name="T:OpenMetaverse.AssetType"> | ||
109 | <summary> | 130 | <summary> |
110 | Combine two UUIDs together by taking the MD5 hash of a byte array | 131 | The different types of grid assets |
111 | containing both UUIDs | ||
112 | </summary> | 132 | </summary> |
113 | <param name="first">First UUID to combine</param> | ||
114 | <param name="second">Second UUID to combine</param> | ||
115 | <returns>The UUID product of the combination</returns> | ||
116 | </member> | 133 | </member> |
117 | <member name="M:OpenMetaverse.UUID.Random"> | 134 | <member name="F:OpenMetaverse.AssetType.Unknown"> |
135 | <summary>Unknown asset type</summary> | ||
136 | </member> | ||
137 | <member name="F:OpenMetaverse.AssetType.Texture"> | ||
138 | <summary>Texture asset, stores in JPEG2000 J2C stream format</summary> | ||
139 | </member> | ||
140 | <member name="F:OpenMetaverse.AssetType.Sound"> | ||
141 | <summary>Sound asset</summary> | ||
142 | </member> | ||
143 | <member name="F:OpenMetaverse.AssetType.CallingCard"> | ||
144 | <summary>Calling card for another avatar</summary> | ||
145 | </member> | ||
146 | <member name="F:OpenMetaverse.AssetType.Landmark"> | ||
147 | <summary>Link to a location in world</summary> | ||
148 | </member> | ||
149 | <member name="F:OpenMetaverse.AssetType.Clothing"> | ||
150 | <summary>Collection of textures and parameters that can be | ||
151 | worn by an avatar</summary> | ||
152 | </member> | ||
153 | <member name="F:OpenMetaverse.AssetType.Object"> | ||
154 | <summary>Primitive that can contain textures, sounds, | ||
155 | scripts and more</summary> | ||
156 | </member> | ||
157 | <member name="F:OpenMetaverse.AssetType.Notecard"> | ||
158 | <summary>Notecard asset</summary> | ||
159 | </member> | ||
160 | <member name="F:OpenMetaverse.AssetType.Folder"> | ||
161 | <summary>Holds a collection of inventory items</summary> | ||
162 | </member> | ||
163 | <member name="F:OpenMetaverse.AssetType.RootFolder"> | ||
164 | <summary>Root inventory folder</summary> | ||
165 | </member> | ||
166 | <member name="F:OpenMetaverse.AssetType.LSLText"> | ||
167 | <summary>Linden scripting language script</summary> | ||
168 | </member> | ||
169 | <member name="F:OpenMetaverse.AssetType.LSLBytecode"> | ||
170 | <summary>LSO bytecode for a script</summary> | ||
171 | </member> | ||
172 | <member name="F:OpenMetaverse.AssetType.TextureTGA"> | ||
173 | <summary>Uncompressed TGA texture</summary> | ||
174 | </member> | ||
175 | <member name="F:OpenMetaverse.AssetType.Bodypart"> | ||
176 | <summary>Collection of textures and shape parameters that can | ||
177 | be worn</summary> | ||
178 | </member> | ||
179 | <member name="F:OpenMetaverse.AssetType.TrashFolder"> | ||
180 | <summary>Trash folder</summary> | ||
181 | </member> | ||
182 | <member name="F:OpenMetaverse.AssetType.SnapshotFolder"> | ||
183 | <summary>Snapshot folder</summary> | ||
184 | </member> | ||
185 | <member name="F:OpenMetaverse.AssetType.LostAndFoundFolder"> | ||
186 | <summary>Lost and found folder</summary> | ||
187 | </member> | ||
188 | <member name="F:OpenMetaverse.AssetType.SoundWAV"> | ||
189 | <summary>Uncompressed sound</summary> | ||
190 | </member> | ||
191 | <member name="F:OpenMetaverse.AssetType.ImageTGA"> | ||
192 | <summary>Uncompressed TGA non-square image, not to be used as a | ||
193 | texture</summary> | ||
194 | </member> | ||
195 | <member name="F:OpenMetaverse.AssetType.ImageJPEG"> | ||
196 | <summary>Compressed JPEG non-square image, not to be used as a | ||
197 | texture</summary> | ||
198 | </member> | ||
199 | <member name="F:OpenMetaverse.AssetType.Animation"> | ||
200 | <summary>Animation</summary> | ||
201 | </member> | ||
202 | <member name="F:OpenMetaverse.AssetType.Gesture"> | ||
203 | <summary>Sequence of animations, sounds, chat, and pauses</summary> | ||
204 | </member> | ||
205 | <member name="F:OpenMetaverse.AssetType.Simstate"> | ||
206 | <summary>Simstate file</summary> | ||
207 | </member> | ||
208 | <member name="F:OpenMetaverse.AssetType.FavoriteFolder"> | ||
209 | <summary>Contains landmarks for favorites</summary> | ||
210 | </member> | ||
211 | <member name="F:OpenMetaverse.AssetType.Link"> | ||
212 | <summary>Asset is a link to another inventory item</summary> | ||
213 | </member> | ||
214 | <member name="F:OpenMetaverse.AssetType.LinkFolder"> | ||
215 | <summary>Asset is a link to another inventory folder</summary> | ||
216 | </member> | ||
217 | <member name="F:OpenMetaverse.AssetType.EnsembleStart"> | ||
218 | <summary>Beginning of the range reserved for ensembles</summary> | ||
219 | </member> | ||
220 | <member name="F:OpenMetaverse.AssetType.EnsembleEnd"> | ||
221 | <summary>End of the range reserved for ensembles</summary> | ||
222 | </member> | ||
223 | <member name="F:OpenMetaverse.AssetType.CurrentOutfitFolder"> | ||
224 | <summary>Folder containing inventory links to wearables and attachments | ||
225 | that are part of the current outfit</summary> | ||
226 | </member> | ||
227 | <member name="F:OpenMetaverse.AssetType.OutfitFolder"> | ||
228 | <summary>Folder containing inventory items or links to | ||
229 | inventory items of wearables and attachments | ||
230 | together make a full outfit</summary> | ||
231 | </member> | ||
232 | <member name="F:OpenMetaverse.AssetType.MyOutfitsFolder"> | ||
233 | <summary>Root folder for the folders of type OutfitFolder</summary> | ||
234 | </member> | ||
235 | <member name="F:OpenMetaverse.AssetType.Mesh"> | ||
236 | <summary>Linden mesh format</summary> | ||
237 | </member> | ||
238 | <member name="T:OpenMetaverse.InventoryType"> | ||
118 | <summary> | 239 | <summary> |
119 | 240 | Inventory Item Types, eg Script, Notecard, Folder, etc | |
120 | </summary> | 241 | </summary> |
121 | <returns></returns> | ||
122 | </member> | 242 | </member> |
123 | <member name="M:OpenMetaverse.UUID.GetHashCode"> | 243 | <member name="F:OpenMetaverse.InventoryType.Unknown"> |
244 | <summary>Unknown</summary> | ||
245 | </member> | ||
246 | <member name="F:OpenMetaverse.InventoryType.Texture"> | ||
247 | <summary>Texture</summary> | ||
248 | </member> | ||
249 | <member name="F:OpenMetaverse.InventoryType.Sound"> | ||
250 | <summary>Sound</summary> | ||
251 | </member> | ||
252 | <member name="F:OpenMetaverse.InventoryType.CallingCard"> | ||
253 | <summary>Calling Card</summary> | ||
254 | </member> | ||
255 | <member name="F:OpenMetaverse.InventoryType.Landmark"> | ||
256 | <summary>Landmark</summary> | ||
257 | </member> | ||
258 | <member name="F:OpenMetaverse.InventoryType.Notecard"> | ||
259 | <summary>Notecard</summary> | ||
260 | </member> | ||
261 | <member name="F:OpenMetaverse.InventoryType.Category"> | ||
262 | <summary></summary> | ||
263 | </member> | ||
264 | <member name="F:OpenMetaverse.InventoryType.Folder"> | ||
265 | <summary>Folder</summary> | ||
266 | </member> | ||
267 | <member name="F:OpenMetaverse.InventoryType.RootCategory"> | ||
268 | <summary></summary> | ||
269 | </member> | ||
270 | <member name="F:OpenMetaverse.InventoryType.LSL"> | ||
271 | <summary>an LSL Script</summary> | ||
272 | </member> | ||
273 | <member name="F:OpenMetaverse.InventoryType.Snapshot"> | ||
274 | <summary></summary> | ||
275 | </member> | ||
276 | <member name="F:OpenMetaverse.InventoryType.Attachment"> | ||
277 | <summary></summary> | ||
278 | </member> | ||
279 | <member name="F:OpenMetaverse.InventoryType.Wearable"> | ||
280 | <summary></summary> | ||
281 | </member> | ||
282 | <member name="F:OpenMetaverse.InventoryType.Animation"> | ||
283 | <summary></summary> | ||
284 | </member> | ||
285 | <member name="F:OpenMetaverse.InventoryType.Gesture"> | ||
286 | <summary></summary> | ||
287 | </member> | ||
288 | <member name="F:OpenMetaverse.InventoryType.Mesh"> | ||
289 | <summary></summary> | ||
290 | </member> | ||
291 | <member name="T:OpenMetaverse.SaleType"> | ||
124 | <summary> | 292 | <summary> |
125 | Return a hash code for this UUID, used by .NET for hash tables | 293 | Item Sale Status |
126 | </summary> | 294 | </summary> |
127 | <returns>An integer composed of all the UUID bytes XORed together</returns> | ||
128 | </member> | 295 | </member> |
129 | <member name="M:OpenMetaverse.UUID.Equals(System.Object)"> | 296 | <member name="F:OpenMetaverse.SaleType.Not"> |
297 | <summary>Not for sale</summary> | ||
298 | </member> | ||
299 | <member name="F:OpenMetaverse.SaleType.Original"> | ||
300 | <summary>The original is for sale</summary> | ||
301 | </member> | ||
302 | <member name="F:OpenMetaverse.SaleType.Copy"> | ||
303 | <summary>Copies are for sale</summary> | ||
304 | </member> | ||
305 | <member name="F:OpenMetaverse.SaleType.Contents"> | ||
306 | <summary>The contents of the object are for sale</summary> | ||
307 | </member> | ||
308 | <member name="T:OpenMetaverse.WearableType"> | ||
130 | <summary> | 309 | <summary> |
131 | Comparison function | 310 | Types of wearable assets |
132 | </summary> | 311 | </summary> |
133 | <param name="o">An object to compare to this UUID</param> | ||
134 | <returns>True if the object is a UUID and both UUIDs are equal</returns> | ||
135 | </member> | 312 | </member> |
136 | <member name="M:OpenMetaverse.UUID.Equals(OpenMetaverse.UUID)"> | 313 | <member name="F:OpenMetaverse.WearableType.Shape"> |
314 | <summary>Body shape</summary> | ||
315 | </member> | ||
316 | <member name="F:OpenMetaverse.WearableType.Skin"> | ||
317 | <summary>Skin textures and attributes</summary> | ||
318 | </member> | ||
319 | <member name="F:OpenMetaverse.WearableType.Hair"> | ||
320 | <summary>Hair</summary> | ||
321 | </member> | ||
322 | <member name="F:OpenMetaverse.WearableType.Eyes"> | ||
323 | <summary>Eyes</summary> | ||
324 | </member> | ||
325 | <member name="F:OpenMetaverse.WearableType.Shirt"> | ||
326 | <summary>Shirt</summary> | ||
327 | </member> | ||
328 | <member name="F:OpenMetaverse.WearableType.Pants"> | ||
329 | <summary>Pants</summary> | ||
330 | </member> | ||
331 | <member name="F:OpenMetaverse.WearableType.Shoes"> | ||
332 | <summary>Shoes</summary> | ||
333 | </member> | ||
334 | <member name="F:OpenMetaverse.WearableType.Socks"> | ||
335 | <summary>Socks</summary> | ||
336 | </member> | ||
337 | <member name="F:OpenMetaverse.WearableType.Jacket"> | ||
338 | <summary>Jacket</summary> | ||
339 | </member> | ||
340 | <member name="F:OpenMetaverse.WearableType.Gloves"> | ||
341 | <summary>Gloves</summary> | ||
342 | </member> | ||
343 | <member name="F:OpenMetaverse.WearableType.Undershirt"> | ||
344 | <summary>Undershirt</summary> | ||
345 | </member> | ||
346 | <member name="F:OpenMetaverse.WearableType.Underpants"> | ||
347 | <summary>Underpants</summary> | ||
348 | </member> | ||
349 | <member name="F:OpenMetaverse.WearableType.Skirt"> | ||
350 | <summary>Skirt</summary> | ||
351 | </member> | ||
352 | <member name="F:OpenMetaverse.WearableType.Alpha"> | ||
353 | <summary>Alpha mask to hide parts of the avatar</summary> | ||
354 | </member> | ||
355 | <member name="F:OpenMetaverse.WearableType.Tattoo"> | ||
356 | <summary>Tattoo</summary> | ||
357 | </member> | ||
358 | <member name="F:OpenMetaverse.WearableType.Invalid"> | ||
359 | <summary>Invalid wearable asset</summary> | ||
360 | </member> | ||
361 | <member name="T:OpenMetaverse.TokenBucket"> | ||
137 | <summary> | 362 | <summary> |
138 | Comparison function | 363 | A hierarchical token bucket for bandwidth throttling. See |
364 | http://en.wikipedia.org/wiki/Token_bucket for more information | ||
139 | </summary> | 365 | </summary> |
140 | <param name="uuid">UUID to compare to</param> | ||
141 | <returns>True if the UUIDs are equal, otherwise false</returns> | ||
142 | </member> | 366 | </member> |
143 | <member name="M:OpenMetaverse.UUID.ToString"> | 367 | <member name="F:OpenMetaverse.TokenBucket.parent"> |
368 | <summary>Parent bucket to this bucket, or null if this is a root | ||
369 | bucket</summary> | ||
370 | </member> | ||
371 | <member name="F:OpenMetaverse.TokenBucket.maxBurst"> | ||
372 | <summary>Size of the bucket in bytes. If zero, the bucket has | ||
373 | infinite capacity</summary> | ||
374 | </member> | ||
375 | <member name="F:OpenMetaverse.TokenBucket.tokensPerMS"> | ||
376 | <summary>Rate that the bucket fills, in bytes per millisecond. If | ||
377 | zero, the bucket always remains full</summary> | ||
378 | </member> | ||
379 | <member name="F:OpenMetaverse.TokenBucket.content"> | ||
380 | <summary>Number of tokens currently in the bucket</summary> | ||
381 | </member> | ||
382 | <member name="F:OpenMetaverse.TokenBucket.lastDrip"> | ||
383 | <summary>Time of the last drip, in system ticks</summary> | ||
384 | </member> | ||
385 | <member name="M:OpenMetaverse.TokenBucket.#ctor(OpenMetaverse.TokenBucket,System.Int32,System.Int32)"> | ||
144 | <summary> | 386 | <summary> |
145 | Get a hyphenated string representation of this UUID | 387 | Default constructor |
146 | </summary> | 388 | </summary> |
147 | <returns>A string representation of this UUID, lowercase and | 389 | <param name="parent">Parent bucket if this is a child bucket, or |
148 | with hyphens</returns> | 390 | null if this is a root bucket</param> |
149 | <example>11f8aa9c-b071-4242-836b-13b7abe0d489</example> | 391 | <param name="maxBurst">Maximum size of the bucket in bytes, or |
392 | zero if this bucket has no maximum capacity</param> | ||
393 | <param name="dripRate">Rate that the bucket fills, in bytes per | ||
394 | second. If zero, the bucket always remains full</param> | ||
150 | </member> | 395 | </member> |
151 | <member name="M:OpenMetaverse.UUID.op_Equality(OpenMetaverse.UUID,OpenMetaverse.UUID)"> | 396 | <member name="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32)"> |
152 | <summary> | 397 | <summary> |
153 | Equals operator | 398 | Remove a given number of tokens from the bucket |
154 | </summary> | 399 | </summary> |
155 | <param name="lhs">First UUID for comparison</param> | 400 | <param name="amount">Number of tokens to remove from the bucket</param> |
156 | <param name="rhs">Second UUID for comparison</param> | 401 | <returns>True if the requested number of tokens were removed from |
157 | <returns>True if the UUIDs are byte for byte equal, otherwise false</returns> | 402 | the bucket, otherwise false</returns> |
158 | </member> | 403 | </member> |
159 | <member name="M:OpenMetaverse.UUID.op_Inequality(OpenMetaverse.UUID,OpenMetaverse.UUID)"> | 404 | <member name="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32,System.Boolean@)"> |
160 | <summary> | 405 | <summary> |
161 | Not equals operator | 406 | Remove a given number of tokens from the bucket |
162 | </summary> | 407 | </summary> |
163 | <param name="lhs">First UUID for comparison</param> | 408 | <param name="amount">Number of tokens to remove from the bucket</param> |
164 | <param name="rhs">Second UUID for comparison</param> | 409 | <param name="dripSucceeded">True if tokens were added to the bucket |
165 | <returns>True if the UUIDs are not equal, otherwise true</returns> | 410 | during this call, otherwise false</param> |
411 | <returns>True if the requested number of tokens were removed from | ||
412 | the bucket, otherwise false</returns> | ||
166 | </member> | 413 | </member> |
167 | <member name="M:OpenMetaverse.UUID.op_ExclusiveOr(OpenMetaverse.UUID,OpenMetaverse.UUID)"> | 414 | <member name="M:OpenMetaverse.TokenBucket.Drip"> |
168 | <summary> | 415 | <summary> |
169 | XOR operator | 416 | Add tokens to the bucket over time. The number of tokens added each |
417 | call depends on the length of time that has passed since the last | ||
418 | call to Drip | ||
170 | </summary> | 419 | </summary> |
171 | <param name="lhs">First UUID</param> | 420 | <returns>True if tokens were added to the bucket, otherwise false</returns> |
172 | <param name="rhs">Second UUID</param> | ||
173 | <returns>A UUID that is a XOR combination of the two input UUIDs</returns> | ||
174 | </member> | 421 | </member> |
175 | <member name="M:OpenMetaverse.UUID.op_Explicit(System.String)~OpenMetaverse.UUID"> | 422 | <member name="P:OpenMetaverse.TokenBucket.Parent"> |
176 | <summary> | 423 | <summary> |
177 | String typecasting operator | 424 | The parent bucket of this bucket, or null if this bucket has no |
425 | parent. The parent bucket will limit the aggregate bandwidth of all | ||
426 | of its children buckets | ||
178 | </summary> | 427 | </summary> |
179 | <param name="val">A UUID in string form. Case insensitive, | ||
180 | hyphenated or non-hyphenated</param> | ||
181 | <returns>A UUID built from the string representation</returns> | ||
182 | </member> | 428 | </member> |
183 | <member name="F:OpenMetaverse.UUID.Zero"> | 429 | <member name="P:OpenMetaverse.TokenBucket.MaxBurst"> |
184 | <summary>An UUID with a value of all zeroes</summary> | 430 | <summary> |
431 | Maximum burst rate in bytes per second. This is the maximum number | ||
432 | of tokens that can accumulate in the bucket at any one time | ||
433 | </summary> | ||
185 | </member> | 434 | </member> |
186 | <member name="F:OpenMetaverse.UUID.ZeroString"> | 435 | <member name="P:OpenMetaverse.TokenBucket.DripRate"> |
187 | <summary>A cache of UUID.Zero as a string to optimize a common path</summary> | 436 | <summary> |
437 | The speed limit of this bucket in bytes per second. This is the | ||
438 | number of tokens that are added to the bucket per second | ||
439 | </summary> | ||
440 | <remarks>Tokens are added to the bucket any time | ||
441 | <seealso cref="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32)"/> is called, at the granularity of | ||
442 | the system tick interval (typically around 15-22ms)</remarks> | ||
188 | </member> | 443 | </member> |
189 | <member name="M:OpenMetaverse.Matrix4.GetEulerAngles(System.Single@,System.Single@,System.Single@)"> | 444 | <member name="P:OpenMetaverse.TokenBucket.Content"> |
190 | <summary> | 445 | <summary> |
191 | Convert this matrix to euler rotations | 446 | The number of bytes that can be sent at this moment. This is the |
447 | current number of tokens in the bucket | ||
448 | <remarks>If this bucket has a parent bucket that does not have | ||
449 | enough tokens for a request, <seealso cref="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32)"/> will | ||
450 | return false regardless of the content of this bucket</remarks> | ||
192 | </summary> | 451 | </summary> |
193 | <param name="roll">X euler angle</param> | ||
194 | <param name="pitch">Y euler angle</param> | ||
195 | <param name="yaw">Z euler angle</param> | ||
196 | </member> | 452 | </member> |
197 | <member name="M:OpenMetaverse.Matrix4.GetQuaternion"> | 453 | <member name="T:OpenMetaverse.LocklessQueue`1"> |
198 | <summary> | 454 | <summary> |
199 | Convert this matrix to a quaternion rotation | 455 | A thread-safe lockless queue that supports multiple readers and |
456 | multiple writers | ||
200 | </summary> | 457 | </summary> |
201 | <returns>A quaternion representation of this rotation matrix</returns> | ||
202 | </member> | 458 | </member> |
203 | <member name="M:OpenMetaverse.Matrix4.CreateFromEulers(System.Single,System.Single,System.Single)"> | 459 | <member name="F:OpenMetaverse.LocklessQueue`1.head"> |
460 | <summary>Queue head</summary> | ||
461 | </member> | ||
462 | <member name="F:OpenMetaverse.LocklessQueue`1.tail"> | ||
463 | <summary>Queue tail</summary> | ||
464 | </member> | ||
465 | <member name="F:OpenMetaverse.LocklessQueue`1.count"> | ||
466 | <summary>Queue item count</summary> | ||
467 | </member> | ||
468 | <member name="M:OpenMetaverse.LocklessQueue`1.#ctor"> | ||
204 | <summary> | 469 | <summary> |
205 | Construct a matrix from euler rotation values in radians | 470 | Constructor |
206 | </summary> | 471 | </summary> |
207 | <param name="roll">X euler angle in radians</param> | ||
208 | <param name="pitch">Y euler angle in radians</param> | ||
209 | <param name="yaw">Z euler angle in radians</param> | ||
210 | </member> | 472 | </member> |
211 | <member name="M:OpenMetaverse.Matrix4.ToString"> | 473 | <member name="M:OpenMetaverse.LocklessQueue`1.Enqueue(`0)"> |
212 | <summary> | 474 | <summary> |
213 | Get a formatted string representation of the vector | 475 | Enqueue an item |
214 | </summary> | 476 | </summary> |
215 | <returns>A string representation of the vector</returns> | 477 | <param name="item">Item to enqeue</param> |
216 | </member> | 478 | </member> |
217 | <member name="F:OpenMetaverse.Matrix4.Zero"> | 479 | <member name="M:OpenMetaverse.LocklessQueue`1.TryDequeue(`0@)"> |
218 | <summary>A 4x4 matrix containing all zeroes</summary> | 480 | <summary> |
481 | Try to dequeue an item | ||
482 | </summary> | ||
483 | <param name="item">Dequeued item if the dequeue was successful</param> | ||
484 | <returns>True if an item was successfully deqeued, otherwise false</returns> | ||
219 | </member> | 485 | </member> |
220 | <member name="F:OpenMetaverse.Matrix4.Identity"> | 486 | <member name="P:OpenMetaverse.LocklessQueue`1.Count"> |
221 | <summary>A 4x4 identity matrix</summary> | 487 | <summary>Gets the current number of items in the queue. Since this |
488 | is a lockless collection this value should be treated as a close | ||
489 | estimate</summary> | ||
490 | </member> | ||
491 | <member name="T:OpenMetaverse.LocklessQueue`1.SingleLinkNode"> | ||
492 | <summary> | ||
493 | Provides a node container for data in a singly linked list | ||
494 | </summary> | ||
495 | </member> | ||
496 | <member name="F:OpenMetaverse.LocklessQueue`1.SingleLinkNode.Next"> | ||
497 | <summary>Pointer to the next node in list</summary> | ||
498 | </member> | ||
499 | <member name="F:OpenMetaverse.LocklessQueue`1.SingleLinkNode.Item"> | ||
500 | <summary>The data contained by the node</summary> | ||
501 | </member> | ||
502 | <member name="M:OpenMetaverse.LocklessQueue`1.SingleLinkNode.#ctor"> | ||
503 | <summary> | ||
504 | Constructor | ||
505 | </summary> | ||
506 | </member> | ||
507 | <member name="M:OpenMetaverse.LocklessQueue`1.SingleLinkNode.#ctor(`0)"> | ||
508 | <summary> | ||
509 | Constructor | ||
510 | </summary> | ||
222 | </member> | 511 | </member> |
223 | <member name="T:OpenMetaverse.Color4"> | 512 | <member name="T:OpenMetaverse.Color4"> |
224 | <summary> | 513 | <summary> |
@@ -353,326 +642,357 @@ | |||
353 | <member name="F:OpenMetaverse.Color4.White"> | 642 | <member name="F:OpenMetaverse.Color4.White"> |
354 | <summary>A Color4 with full RGB values (1.0) and fully opaque (alpha 1.0)</summary> | 643 | <summary>A Color4 with full RGB values (1.0) and fully opaque (alpha 1.0)</summary> |
355 | </member> | 644 | </member> |
645 | <member name="M:OpenMetaverse.ReaderWriterLockSlim.ExitAndWakeUpAppropriateWaiters"> | ||
646 | <summary> | ||
647 | Determines the appropriate events to set, leaves the locks, and sets the events. | ||
648 | </summary> | ||
649 | </member> | ||
650 | <member name="M:OpenMetaverse.ReaderWriterLockSlim.LazyCreateEvent(System.Threading.EventWaitHandle@,System.Boolean)"> | ||
651 | <summary> | ||
652 | A routine for lazily creating a event outside the lock (so if errors | ||
653 | happen they are outside the lock and that we don't do much work | ||
654 | while holding a spin lock). If all goes well, reenter the lock and | ||
655 | set 'waitEvent' | ||
656 | </summary> | ||
657 | </member> | ||
658 | <member name="M:OpenMetaverse.ReaderWriterLockSlim.WaitOnEvent(System.Threading.EventWaitHandle,System.UInt32@,System.Int32)"> | ||
659 | <summary> | ||
660 | Waits on 'waitEvent' with a timeout of 'millisceondsTimeout. | ||
661 | Before the wait 'numWaiters' is incremented and is restored before leaving this routine. | ||
662 | </summary> | ||
663 | </member> | ||
356 | <member name="M:OpenMetaverse.CircularQueue`1.#ctor(OpenMetaverse.CircularQueue{`0})"> | 664 | <member name="M:OpenMetaverse.CircularQueue`1.#ctor(OpenMetaverse.CircularQueue{`0})"> |
357 | <summary> | 665 | <summary> |
358 | Copy constructor | 666 | Copy constructor |
359 | </summary> | 667 | </summary> |
360 | <param name="queue">Circular queue to copy</param> | 668 | <param name="queue">Circular queue to copy</param> |
361 | </member> | 669 | </member> |
362 | <member name="F:OpenMetaverse.Vector4.X"> | 670 | <member name="T:OpenMetaverse.UUID"> |
363 | <summary>X value</summary> | 671 | <summary> |
672 | A 128-bit Universally Unique Identifier, used throughout the Second | ||
673 | Life networking protocol | ||
674 | </summary> | ||
364 | </member> | 675 | </member> |
365 | <member name="F:OpenMetaverse.Vector4.Y"> | 676 | <member name="F:OpenMetaverse.UUID.Guid"> |
366 | <summary>Y value</summary> | 677 | <summary>The System.Guid object this struct wraps around</summary> |
367 | </member> | 678 | </member> |
368 | <member name="F:OpenMetaverse.Vector4.Z"> | 679 | <member name="M:OpenMetaverse.UUID.#ctor(System.String)"> |
369 | <summary>Z value</summary> | 680 | <summary> |
681 | Constructor that takes a string UUID representation | ||
682 | </summary> | ||
683 | <param name="val">A string representation of a UUID, case | ||
684 | insensitive and can either be hyphenated or non-hyphenated</param> | ||
685 | <example>UUID("11f8aa9c-b071-4242-836b-13b7abe0d489")</example> | ||
370 | </member> | 686 | </member> |
371 | <member name="F:OpenMetaverse.Vector4.W"> | 687 | <member name="M:OpenMetaverse.UUID.#ctor(System.Guid)"> |
372 | <summary>W value</summary> | 688 | <summary> |
689 | Constructor that takes a System.Guid object | ||
690 | </summary> | ||
691 | <param name="val">A Guid object that contains the unique identifier | ||
692 | to be represented by this UUID</param> | ||
373 | </member> | 693 | </member> |
374 | <member name="M:OpenMetaverse.Vector4.#ctor(System.Byte[],System.Int32)"> | 694 | <member name="M:OpenMetaverse.UUID.#ctor(System.Byte[],System.Int32)"> |
375 | <summary> | 695 | <summary> |
376 | Constructor, builds a vector from a byte array | 696 | Constructor that takes a byte array containing a UUID |
377 | </summary> | 697 | </summary> |
378 | <param name="byteArray">Byte array containing four four-byte floats</param> | 698 | <param name="source">Byte array containing a 16 byte UUID</param> |
379 | <param name="pos">Beginning position in the byte array</param> | 699 | <param name="pos">Beginning offset in the array</param> |
380 | </member> | 700 | </member> |
381 | <member name="M:OpenMetaverse.Vector4.ApproxEquals(OpenMetaverse.Vector4,System.Single)"> | 701 | <member name="M:OpenMetaverse.UUID.#ctor(System.UInt64)"> |
382 | <summary> | 702 | <summary> |
383 | Test if this vector is equal to another vector, within a given | 703 | Constructor that takes an unsigned 64-bit unsigned integer to |
384 | tolerance range | 704 | convert to a UUID |
385 | </summary> | 705 | </summary> |
386 | <param name="vec">Vector to test against</param> | 706 | <param name="val">64-bit unsigned integer to convert to a UUID</param> |
387 | <param name="tolerance">The acceptable magnitude of difference | ||
388 | between the two vectors</param> | ||
389 | <returns>True if the magnitude of difference between the two vectors | ||
390 | is less than the given tolerance, otherwise false</returns> | ||
391 | </member> | 707 | </member> |
392 | <member name="M:OpenMetaverse.Vector4.CompareTo(OpenMetaverse.Vector4)"> | 708 | <member name="M:OpenMetaverse.UUID.#ctor(OpenMetaverse.UUID)"> |
393 | <summary> | 709 | <summary> |
394 | IComparable.CompareTo implementation | 710 | Copy constructor |
395 | </summary> | 711 | </summary> |
712 | <param name="val">UUID to copy</param> | ||
396 | </member> | 713 | </member> |
397 | <member name="M:OpenMetaverse.Vector4.IsFinite"> | 714 | <member name="M:OpenMetaverse.UUID.CompareTo(OpenMetaverse.UUID)"> |
398 | <summary> | 715 | <summary> |
399 | Test if this vector is composed of all finite numbers | 716 | IComparable.CompareTo implementation |
400 | </summary> | 717 | </summary> |
401 | </member> | 718 | </member> |
402 | <member name="M:OpenMetaverse.Vector4.FromBytes(System.Byte[],System.Int32)"> | 719 | <member name="M:OpenMetaverse.UUID.FromBytes(System.Byte[],System.Int32)"> |
403 | <summary> | 720 | <summary> |
404 | Builds a vector from a byte array | 721 | Assigns this UUID from 16 bytes out of a byte array |
405 | </summary> | 722 | </summary> |
406 | <param name="byteArray">Byte array containing a 16 byte vector</param> | 723 | <param name="source">Byte array containing the UUID to assign this UUID to</param> |
407 | <param name="pos">Beginning position in the byte array</param> | 724 | <param name="pos">Starting position of the UUID in the byte array</param> |
408 | </member> | 725 | </member> |
409 | <member name="M:OpenMetaverse.Vector4.GetBytes"> | 726 | <member name="M:OpenMetaverse.UUID.GetBytes"> |
410 | <summary> | 727 | <summary> |
411 | Returns the raw bytes for this vector | 728 | Returns a copy of the raw bytes for this UUID |
412 | </summary> | 729 | </summary> |
413 | <returns>A 16 byte array containing X, Y, Z, and W</returns> | 730 | <returns>A 16 byte array containing this UUID</returns> |
414 | </member> | 731 | </member> |
415 | <member name="M:OpenMetaverse.Vector4.ToBytes(System.Byte[],System.Int32)"> | 732 | <member name="M:OpenMetaverse.UUID.ToBytes(System.Byte[],System.Int32)"> |
416 | <summary> | 733 | <summary> |
417 | Writes the raw bytes for this vector to a byte array | 734 | Writes the raw bytes for this UUID to a byte array |
418 | </summary> | 735 | </summary> |
419 | <param name="dest">Destination byte array</param> | 736 | <param name="dest">Destination byte array</param> |
420 | <param name="pos">Position in the destination array to start | 737 | <param name="pos">Position in the destination array to start |
421 | writing. Must be at least 16 bytes before the end of the array</param> | 738 | writing. Must be at least 16 bytes before the end of the array</param> |
422 | </member> | 739 | </member> |
423 | <member name="M:OpenMetaverse.Vector4.ToRawString"> | 740 | <member name="M:OpenMetaverse.UUID.CRC"> |
424 | <summary> | 741 | <summary> |
425 | Get a string representation of the vector elements with up to three | 742 | Calculate an LLCRC (cyclic redundancy check) for this UUID |
426 | decimal digits and separated by spaces only | ||
427 | </summary> | 743 | </summary> |
428 | <returns>Raw string representation of the vector</returns> | 744 | <returns>The CRC checksum for this UUID</returns> |
429 | </member> | ||
430 | <member name="F:OpenMetaverse.Vector4.Zero"> | ||
431 | <summary>A vector with a value of 0,0,0,0</summary> | ||
432 | </member> | ||
433 | <member name="F:OpenMetaverse.Vector4.One"> | ||
434 | <summary>A vector with a value of 1,1,1,1</summary> | ||
435 | </member> | ||
436 | <member name="F:OpenMetaverse.Vector4.UnitX"> | ||
437 | <summary>A vector with a value of 1,0,0,0</summary> | ||
438 | </member> | ||
439 | <member name="F:OpenMetaverse.Vector4.UnitY"> | ||
440 | <summary>A vector with a value of 0,1,0,0</summary> | ||
441 | </member> | ||
442 | <member name="F:OpenMetaverse.Vector4.UnitZ"> | ||
443 | <summary>A vector with a value of 0,0,1,0</summary> | ||
444 | </member> | ||
445 | <member name="F:OpenMetaverse.Vector4.UnitW"> | ||
446 | <summary>A vector with a value of 0,0,0,1</summary> | ||
447 | </member> | 745 | </member> |
448 | <member name="T:OpenMetaverse.Vector3d"> | 746 | <member name="M:OpenMetaverse.UUID.GetULong"> |
449 | <summary> | 747 | <summary> |
450 | A three-dimensional vector with doubleing-point values | 748 | Create a 64-bit integer representation from the second half of this UUID |
451 | </summary> | 749 | </summary> |
750 | <returns>An integer created from the last eight bytes of this UUID</returns> | ||
452 | </member> | 751 | </member> |
453 | <member name="F:OpenMetaverse.Vector3d.X"> | 752 | <member name="M:OpenMetaverse.UUID.Parse(System.String)"> |
454 | <summary>X value</summary> | ||
455 | </member> | ||
456 | <member name="F:OpenMetaverse.Vector3d.Y"> | ||
457 | <summary>Y value</summary> | ||
458 | </member> | ||
459 | <member name="F:OpenMetaverse.Vector3d.Z"> | ||
460 | <summary>Z value</summary> | ||
461 | </member> | ||
462 | <member name="M:OpenMetaverse.Vector3d.#ctor(System.Byte[],System.Int32)"> | ||
463 | <summary> | 753 | <summary> |
464 | Constructor, builds a vector from a byte array | 754 | Generate a UUID from a string |
465 | </summary> | 755 | </summary> |
466 | <param name="byteArray">Byte array containing three eight-byte doubles</param> | 756 | <param name="val">A string representation of a UUID, case |
467 | <param name="pos">Beginning position in the byte array</param> | 757 | insensitive and can either be hyphenated or non-hyphenated</param> |
758 | <example>UUID.Parse("11f8aa9c-b071-4242-836b-13b7abe0d489")</example> | ||
468 | </member> | 759 | </member> |
469 | <member name="M:OpenMetaverse.Vector3d.ApproxEquals(OpenMetaverse.Vector3d,System.Double)"> | 760 | <member name="M:OpenMetaverse.UUID.TryParse(System.String,OpenMetaverse.UUID@)"> |
470 | <summary> | 761 | <summary> |
471 | Test if this vector is equal to another vector, within a given | 762 | Generate a UUID from a string |
472 | tolerance range | ||
473 | </summary> | 763 | </summary> |
474 | <param name="vec">Vector to test against</param> | 764 | <param name="val">A string representation of a UUID, case |
475 | <param name="tolerance">The acceptable magnitude of difference | 765 | insensitive and can either be hyphenated or non-hyphenated</param> |
476 | between the two vectors</param> | 766 | <param name="result">Will contain the parsed UUID if successful, |
477 | <returns>True if the magnitude of difference between the two vectors | 767 | otherwise null</param> |
478 | is less than the given tolerance, otherwise false</returns> | 768 | <returns>True if the string was successfully parse, otherwise false</returns> |
769 | <example>UUID.TryParse("11f8aa9c-b071-4242-836b-13b7abe0d489", result)</example> | ||
479 | </member> | 770 | </member> |
480 | <member name="M:OpenMetaverse.Vector3d.CompareTo(OpenMetaverse.Vector3d)"> | 771 | <member name="M:OpenMetaverse.UUID.Combine(OpenMetaverse.UUID,OpenMetaverse.UUID)"> |
481 | <summary> | 772 | <summary> |
482 | IComparable.CompareTo implementation | 773 | Combine two UUIDs together by taking the MD5 hash of a byte array |
774 | containing both UUIDs | ||
483 | </summary> | 775 | </summary> |
776 | <param name="first">First UUID to combine</param> | ||
777 | <param name="second">Second UUID to combine</param> | ||
778 | <returns>The UUID product of the combination</returns> | ||
484 | </member> | 779 | </member> |
485 | <member name="M:OpenMetaverse.Vector3d.IsFinite"> | 780 | <member name="M:OpenMetaverse.UUID.Random"> |
486 | <summary> | 781 | <summary> |
487 | Test if this vector is composed of all finite numbers | 782 | |
488 | </summary> | 783 | </summary> |
784 | <returns></returns> | ||
489 | </member> | 785 | </member> |
490 | <member name="M:OpenMetaverse.Vector3d.FromBytes(System.Byte[],System.Int32)"> | 786 | <member name="M:OpenMetaverse.UUID.GetHashCode"> |
491 | <summary> | 787 | <summary> |
492 | Builds a vector from a byte array | 788 | Return a hash code for this UUID, used by .NET for hash tables |
493 | </summary> | 789 | </summary> |
494 | <param name="byteArray">Byte array containing a 24 byte vector</param> | 790 | <returns>An integer composed of all the UUID bytes XORed together</returns> |
495 | <param name="pos">Beginning position in the byte array</param> | ||
496 | </member> | 791 | </member> |
497 | <member name="M:OpenMetaverse.Vector3d.GetBytes"> | 792 | <member name="M:OpenMetaverse.UUID.Equals(System.Object)"> |
498 | <summary> | 793 | <summary> |
499 | Returns the raw bytes for this vector | 794 | Comparison function |
500 | </summary> | 795 | </summary> |
501 | <returns>A 24 byte array containing X, Y, and Z</returns> | 796 | <param name="o">An object to compare to this UUID</param> |
797 | <returns>True if the object is a UUID and both UUIDs are equal</returns> | ||
502 | </member> | 798 | </member> |
503 | <member name="M:OpenMetaverse.Vector3d.ToBytes(System.Byte[],System.Int32)"> | 799 | <member name="M:OpenMetaverse.UUID.Equals(OpenMetaverse.UUID)"> |
504 | <summary> | 800 | <summary> |
505 | Writes the raw bytes for this vector to a byte array | 801 | Comparison function |
506 | </summary> | 802 | </summary> |
507 | <param name="dest">Destination byte array</param> | 803 | <param name="uuid">UUID to compare to</param> |
508 | <param name="pos">Position in the destination array to start | 804 | <returns>True if the UUIDs are equal, otherwise false</returns> |
509 | writing. Must be at least 24 bytes before the end of the array</param> | ||
510 | </member> | 805 | </member> |
511 | <member name="M:OpenMetaverse.Vector3d.Parse(System.String)"> | 806 | <member name="M:OpenMetaverse.UUID.ToString"> |
512 | <summary> | 807 | <summary> |
513 | Parse a vector from a string | 808 | Get a hyphenated string representation of this UUID |
514 | </summary> | 809 | </summary> |
515 | <param name="val">A string representation of a 3D vector, enclosed | 810 | <returns>A string representation of this UUID, lowercase and |
516 | in arrow brackets and separated by commas</param> | 811 | with hyphens</returns> |
812 | <example>11f8aa9c-b071-4242-836b-13b7abe0d489</example> | ||
517 | </member> | 813 | </member> |
518 | <member name="M:OpenMetaverse.Vector3d.SmoothStep(OpenMetaverse.Vector3d,OpenMetaverse.Vector3d,System.Double)"> | 814 | <member name="M:OpenMetaverse.UUID.op_Equality(OpenMetaverse.UUID,OpenMetaverse.UUID)"> |
519 | <summary> | 815 | <summary> |
520 | Interpolates between two vectors using a cubic equation | 816 | Equals operator |
521 | </summary> | 817 | </summary> |
818 | <param name="lhs">First UUID for comparison</param> | ||
819 | <param name="rhs">Second UUID for comparison</param> | ||
820 | <returns>True if the UUIDs are byte for byte equal, otherwise false</returns> | ||
522 | </member> | 821 | </member> |
523 | <member name="M:OpenMetaverse.Vector3d.ToString"> | 822 | <member name="M:OpenMetaverse.UUID.op_Inequality(OpenMetaverse.UUID,OpenMetaverse.UUID)"> |
524 | <summary> | 823 | <summary> |
525 | Get a formatted string representation of the vector | 824 | Not equals operator |
526 | </summary> | 825 | </summary> |
527 | <returns>A string representation of the vector</returns> | 826 | <param name="lhs">First UUID for comparison</param> |
827 | <param name="rhs">Second UUID for comparison</param> | ||
828 | <returns>True if the UUIDs are not equal, otherwise true</returns> | ||
528 | </member> | 829 | </member> |
529 | <member name="M:OpenMetaverse.Vector3d.ToRawString"> | 830 | <member name="M:OpenMetaverse.UUID.op_ExclusiveOr(OpenMetaverse.UUID,OpenMetaverse.UUID)"> |
530 | <summary> | 831 | <summary> |
531 | Get a string representation of the vector elements with up to three | 832 | XOR operator |
532 | decimal digits and separated by spaces only | ||
533 | </summary> | 833 | </summary> |
534 | <returns>Raw string representation of the vector</returns> | 834 | <param name="lhs">First UUID</param> |
835 | <param name="rhs">Second UUID</param> | ||
836 | <returns>A UUID that is a XOR combination of the two input UUIDs</returns> | ||
535 | </member> | 837 | </member> |
536 | <member name="M:OpenMetaverse.Vector3d.op_Modulus(OpenMetaverse.Vector3d,OpenMetaverse.Vector3d)"> | 838 | <member name="M:OpenMetaverse.UUID.op_Explicit(System.String)~OpenMetaverse.UUID"> |
537 | <summary> | 839 | <summary> |
538 | Cross product between two vectors | 840 | String typecasting operator |
539 | </summary> | 841 | </summary> |
842 | <param name="val">A UUID in string form. Case insensitive, | ||
843 | hyphenated or non-hyphenated</param> | ||
844 | <returns>A UUID built from the string representation</returns> | ||
540 | </member> | 845 | </member> |
541 | <member name="F:OpenMetaverse.Vector3d.Zero"> | 846 | <member name="F:OpenMetaverse.UUID.Zero"> |
542 | <summary>A vector with a value of 0,0,0</summary> | 847 | <summary>An UUID with a value of all zeroes</summary> |
543 | </member> | 848 | </member> |
544 | <member name="F:OpenMetaverse.Vector3d.One"> | 849 | <member name="F:OpenMetaverse.UUID.ZeroString"> |
545 | <summary>A vector with a value of 1,1,1</summary> | 850 | <summary>A cache of UUID.Zero as a string to optimize a common path</summary> |
546 | </member> | 851 | </member> |
547 | <member name="F:OpenMetaverse.Vector3d.UnitX"> | 852 | <member name="F:OpenMetaverse.Utils.DEG_TO_RAD"> |
548 | <summary>A unit vector facing forward (X axis), value of 1,0,0</summary> | 853 | <summary>Used for converting degrees to radians</summary> |
549 | </member> | 854 | </member> |
550 | <member name="F:OpenMetaverse.Vector3d.UnitY"> | 855 | <member name="F:OpenMetaverse.Utils.RAD_TO_DEG"> |
551 | <summary>A unit vector facing left (Y axis), value of 0,1,0</summary> | 856 | <summary>Used for converting radians to degrees</summary> |
552 | </member> | 857 | </member> |
553 | <member name="F:OpenMetaverse.Vector3d.UnitZ"> | 858 | <member name="F:OpenMetaverse.Utils.EnUsCulture"> |
554 | <summary>A unit vector facing up (Z axis), value of 0,0,1</summary> | 859 | <summary>Provide a single instance of the CultureInfo class to |
860 | help parsing in situations where the grid assumes an en-us | ||
861 | culture</summary> | ||
555 | </member> | 862 | </member> |
556 | <member name="T:OpenMetaverse.Vector3"> | 863 | <member name="F:OpenMetaverse.Utils.Epoch"> |
557 | <summary> | 864 | <summary>UNIX epoch in DateTime format</summary> |
558 | A three-dimensional vector with floating-point values | ||
559 | </summary> | ||
560 | </member> | 865 | </member> |
561 | <member name="F:OpenMetaverse.Vector3.X"> | 866 | <member name="F:OpenMetaverse.Utils.MD5Builder"> |
562 | <summary>X value</summary> | 867 | <summary>Provide a single instance of the MD5 class to avoid making |
868 | duplicate copies and handle thread safety</summary> | ||
563 | </member> | 869 | </member> |
564 | <member name="F:OpenMetaverse.Vector3.Y"> | 870 | <member name="F:OpenMetaverse.Utils.SHA1Builder"> |
565 | <summary>Y value</summary> | 871 | <summary>Provide a single instance of the SHA-1 class to avoid |
872 | making duplicate copies and handle thread safety</summary> | ||
566 | </member> | 873 | </member> |
567 | <member name="F:OpenMetaverse.Vector3.Z"> | 874 | <member name="F:OpenMetaverse.Utils.RNG"> |
568 | <summary>Z value</summary> | 875 | <summary>Provide a single instance of a random number generator |
876 | to avoid making duplicate copies and handle thread safety</summary> | ||
569 | </member> | 877 | </member> |
570 | <member name="M:OpenMetaverse.Vector3.#ctor(System.Byte[],System.Int32)"> | 878 | <member name="M:OpenMetaverse.Utils.Clamp(System.Single,System.Single,System.Single)"> |
571 | <summary> | 879 | <summary> |
572 | Constructor, builds a vector from a byte array | 880 | Clamp a given value between a range |
573 | </summary> | 881 | </summary> |
574 | <param name="byteArray">Byte array containing three four-byte floats</param> | 882 | <param name="value">Value to clamp</param> |
575 | <param name="pos">Beginning position in the byte array</param> | 883 | <param name="min">Minimum allowable value</param> |
884 | <param name="max">Maximum allowable value</param> | ||
885 | <returns>A value inclusively between lower and upper</returns> | ||
576 | </member> | 886 | </member> |
577 | <member name="M:OpenMetaverse.Vector3.ApproxEquals(OpenMetaverse.Vector3,System.Single)"> | 887 | <member name="M:OpenMetaverse.Utils.Clamp(System.Double,System.Double,System.Double)"> |
578 | <summary> | 888 | <summary> |
579 | Test if this vector is equal to another vector, within a given | 889 | Clamp a given value between a range |
580 | tolerance range | ||
581 | </summary> | 890 | </summary> |
582 | <param name="vec">Vector to test against</param> | 891 | <param name="value">Value to clamp</param> |
583 | <param name="tolerance">The acceptable magnitude of difference | 892 | <param name="min">Minimum allowable value</param> |
584 | between the two vectors</param> | 893 | <param name="max">Maximum allowable value</param> |
585 | <returns>True if the magnitude of difference between the two vectors | 894 | <returns>A value inclusively between lower and upper</returns> |
586 | is less than the given tolerance, otherwise false</returns> | ||
587 | </member> | 895 | </member> |
588 | <member name="M:OpenMetaverse.Vector3.CompareTo(OpenMetaverse.Vector3)"> | 896 | <member name="M:OpenMetaverse.Utils.Clamp(System.Int32,System.Int32,System.Int32)"> |
589 | <summary> | 897 | <summary> |
590 | IComparable.CompareTo implementation | 898 | Clamp a given value between a range |
591 | </summary> | 899 | </summary> |
900 | <param name="value">Value to clamp</param> | ||
901 | <param name="min">Minimum allowable value</param> | ||
902 | <param name="max">Maximum allowable value</param> | ||
903 | <returns>A value inclusively between lower and upper</returns> | ||
592 | </member> | 904 | </member> |
593 | <member name="M:OpenMetaverse.Vector3.IsFinite"> | 905 | <member name="M:OpenMetaverse.Utils.Round(System.Single)"> |
594 | <summary> | 906 | <summary> |
595 | Test if this vector is composed of all finite numbers | 907 | Round a floating-point value to the nearest integer |
596 | </summary> | 908 | </summary> |
909 | <param name="val">Floating point number to round</param> | ||
910 | <returns>Integer</returns> | ||
597 | </member> | 911 | </member> |
598 | <member name="M:OpenMetaverse.Vector3.FromBytes(System.Byte[],System.Int32)"> | 912 | <member name="M:OpenMetaverse.Utils.IsFinite(System.Single)"> |
599 | <summary> | 913 | <summary> |
600 | Builds a vector from a byte array | 914 | Test if a single precision float is a finite number |
601 | </summary> | 915 | </summary> |
602 | <param name="byteArray">Byte array containing a 12 byte vector</param> | ||
603 | <param name="pos">Beginning position in the byte array</param> | ||
604 | </member> | 916 | </member> |
605 | <member name="M:OpenMetaverse.Vector3.GetBytes"> | 917 | <member name="M:OpenMetaverse.Utils.IsFinite(System.Double)"> |
606 | <summary> | 918 | <summary> |
607 | Returns the raw bytes for this vector | 919 | Test if a double precision float is a finite number |
608 | </summary> | 920 | </summary> |
609 | <returns>A 12 byte array containing X, Y, and Z</returns> | ||
610 | </member> | 921 | </member> |
611 | <member name="M:OpenMetaverse.Vector3.ToBytes(System.Byte[],System.Int32)"> | 922 | <member name="M:OpenMetaverse.Utils.Distance(System.Single,System.Single)"> |
612 | <summary> | 923 | <summary> |
613 | Writes the raw bytes for this vector to a byte array | 924 | Get the distance between two floating-point values |
614 | </summary> | 925 | </summary> |
615 | <param name="dest">Destination byte array</param> | 926 | <param name="value1">First value</param> |
616 | <param name="pos">Position in the destination array to start | 927 | <param name="value2">Second value</param> |
617 | writing. Must be at least 12 bytes before the end of the array</param> | 928 | <returns>The distance between the two values</returns> |
618 | </member> | 929 | </member> |
619 | <member name="M:OpenMetaverse.Vector3.Parse(System.String)"> | 930 | <member name="M:OpenMetaverse.Utils.MD5(System.Byte[])"> |
620 | <summary> | 931 | <summary> |
621 | Parse a vector from a string | 932 | Compute the MD5 hash for a byte array |
622 | </summary> | 933 | </summary> |
623 | <param name="val">A string representation of a 3D vector, enclosed | 934 | <param name="data">Byte array to compute the hash for</param> |
624 | in arrow brackets and separated by commas</param> | 935 | <returns>MD5 hash of the input data</returns> |
625 | </member> | 936 | </member> |
626 | <member name="M:OpenMetaverse.Vector3.RotationBetween(OpenMetaverse.Vector3,OpenMetaverse.Vector3)"> | 937 | <member name="M:OpenMetaverse.Utils.SHA1(System.Byte[])"> |
627 | <summary> | 938 | <summary> |
628 | Calculate the rotation between two vectors | 939 | Compute the SHA1 hash for a byte array |
629 | </summary> | 940 | </summary> |
630 | <param name="a">Normalized directional vector (such as 1,0,0 for forward facing)</param> | 941 | <param name="data">Byte array to compute the hash for</param> |
631 | <param name="b">Normalized target vector</param> | 942 | <returns>SHA1 hash of the input data</returns> |
632 | </member> | 943 | </member> |
633 | <member name="M:OpenMetaverse.Vector3.SmoothStep(OpenMetaverse.Vector3,OpenMetaverse.Vector3,System.Single)"> | 944 | <member name="M:OpenMetaverse.Utils.SHA1String(System.String)"> |
634 | <summary> | 945 | <summary> |
635 | Interpolates between two vectors using a cubic equation | 946 | Calculate the SHA1 hash of a given string |
636 | </summary> | 947 | </summary> |
948 | <param name="value">The string to hash</param> | ||
949 | <returns>The SHA1 hash as a string</returns> | ||
637 | </member> | 950 | </member> |
638 | <member name="M:OpenMetaverse.Vector3.ToString"> | 951 | <member name="M:OpenMetaverse.Utils.SHA256(System.Byte[])"> |
639 | <summary> | 952 | <summary> |
640 | Get a formatted string representation of the vector | 953 | Compute the SHA256 hash for a byte array |
641 | </summary> | 954 | </summary> |
642 | <returns>A string representation of the vector</returns> | 955 | <param name="data">Byte array to compute the hash for</param> |
956 | <returns>SHA256 hash of the input data</returns> | ||
643 | </member> | 957 | </member> |
644 | <member name="M:OpenMetaverse.Vector3.ToRawString"> | 958 | <member name="M:OpenMetaverse.Utils.SHA256String(System.String)"> |
645 | <summary> | 959 | <summary> |
646 | Get a string representation of the vector elements with up to three | 960 | Calculate the SHA256 hash of a given string |
647 | decimal digits and separated by spaces only | ||
648 | </summary> | 961 | </summary> |
649 | <returns>Raw string representation of the vector</returns> | 962 | <param name="value">The string to hash</param> |
963 | <returns>The SHA256 hash as a string</returns> | ||
650 | </member> | 964 | </member> |
651 | <member name="M:OpenMetaverse.Vector3.op_Modulus(OpenMetaverse.Vector3,OpenMetaverse.Vector3)"> | 965 | <member name="M:OpenMetaverse.Utils.MD5(System.String)"> |
652 | <summary> | 966 | <summary> |
653 | Cross product between two vectors | 967 | Calculate the MD5 hash of a given string |
654 | </summary> | 968 | </summary> |
969 | <param name="password">The password to hash</param> | ||
970 | <returns>An MD5 hash in string format, with $1$ prepended</returns> | ||
655 | </member> | 971 | </member> |
656 | <member name="F:OpenMetaverse.Vector3.Zero"> | 972 | <member name="M:OpenMetaverse.Utils.MD5String(System.String)"> |
657 | <summary>A vector with a value of 0,0,0</summary> | 973 | <summary> |
658 | </member> | 974 | Calculate the MD5 hash of a given string |
659 | <member name="F:OpenMetaverse.Vector3.One"> | 975 | </summary> |
660 | <summary>A vector with a value of 1,1,1</summary> | 976 | <param name="value">The string to hash</param> |
661 | </member> | 977 | <returns>The MD5 hash as a string</returns> |
662 | <member name="F:OpenMetaverse.Vector3.UnitX"> | ||
663 | <summary>A unit vector facing forward (X axis), value 1,0,0</summary> | ||
664 | </member> | ||
665 | <member name="F:OpenMetaverse.Vector3.UnitY"> | ||
666 | <summary>A unit vector facing left (Y axis), value 0,1,0</summary> | ||
667 | </member> | 978 | </member> |
668 | <member name="F:OpenMetaverse.Vector3.UnitZ"> | 979 | <member name="M:OpenMetaverse.Utils.RandomDouble"> |
669 | <summary>A unit vector facing up (Z axis), value 0,0,1</summary> | 980 | <summary> |
981 | Generate a random double precision floating point value | ||
982 | </summary> | ||
983 | <returns>Random value of type double</returns> | ||
670 | </member> | 984 | </member> |
671 | <member name="F:OpenMetaverse.Utils.DEG_TO_RAD"> | 985 | <member name="M:OpenMetaverse.Utils.GetRunningPlatform"> |
672 | <summary>Used for converting degrees to radians</summary> | 986 | <summary> |
987 | Get the current running platform | ||
988 | </summary> | ||
989 | <returns>Enumeration of the current platform we are running on</returns> | ||
673 | </member> | 990 | </member> |
674 | <member name="F:OpenMetaverse.Utils.RAD_TO_DEG"> | 991 | <member name="M:OpenMetaverse.Utils.GetRunningRuntime"> |
675 | <summary>Used for converting radians to degrees</summary> | 992 | <summary> |
993 | Get the current running runtime | ||
994 | </summary> | ||
995 | <returns>Enumeration of the current runtime we are running on</returns> | ||
676 | </member> | 996 | </member> |
677 | <member name="M:OpenMetaverse.Utils.BytesToInt16(System.Byte[])"> | 997 | <member name="M:OpenMetaverse.Utils.BytesToInt16(System.Byte[])"> |
678 | <summary> | 998 | <summary> |
@@ -1099,188 +1419,350 @@ | |||
1099 | <returns>Converted IP address object, or null if the conversion | 1419 | <returns>Converted IP address object, or null if the conversion |
1100 | failed</returns> | 1420 | failed</returns> |
1101 | </member> | 1421 | </member> |
1102 | <member name="F:OpenMetaverse.Utils.EnUsCulture"> | 1422 | <member name="T:OpenMetaverse.Utils.Platform"> |
1103 | <summary>Provide a single instance of the CultureInfo class to | 1423 | <summary> |
1104 | help parsing in situations where the grid assumes an en-us | 1424 | Operating system |
1105 | culture</summary> | 1425 | </summary> |
1106 | </member> | 1426 | </member> |
1107 | <member name="F:OpenMetaverse.Utils.Epoch"> | 1427 | <member name="F:OpenMetaverse.Utils.Platform.Unknown"> |
1108 | <summary>UNIX epoch in DateTime format</summary> | 1428 | <summary>Unknown</summary> |
1109 | </member> | 1429 | </member> |
1110 | <member name="F:OpenMetaverse.Utils.MD5Builder"> | 1430 | <member name="F:OpenMetaverse.Utils.Platform.Windows"> |
1111 | <summary>Provide a single instance of the MD5 class to avoid making | 1431 | <summary>Microsoft Windows</summary> |
1112 | duplicate copies and handle thread safety</summary> | ||
1113 | </member> | 1432 | </member> |
1114 | <member name="F:OpenMetaverse.Utils.SHA1Builder"> | 1433 | <member name="F:OpenMetaverse.Utils.Platform.WindowsCE"> |
1115 | <summary>Provide a single instance of the SHA-1 class to avoid | 1434 | <summary>Microsoft Windows CE</summary> |
1116 | making duplicate copies and handle thread safety</summary> | ||
1117 | </member> | 1435 | </member> |
1118 | <member name="F:OpenMetaverse.Utils.RNG"> | 1436 | <member name="F:OpenMetaverse.Utils.Platform.Linux"> |
1119 | <summary>Provide a single instance of a random number generator | 1437 | <summary>Linux</summary> |
1120 | to avoid making duplicate copies and handle thread safety</summary> | ||
1121 | </member> | 1438 | </member> |
1122 | <member name="M:OpenMetaverse.Utils.Clamp(System.Single,System.Single,System.Single)"> | 1439 | <member name="F:OpenMetaverse.Utils.Platform.OSX"> |
1440 | <summary>Apple OSX</summary> | ||
1441 | </member> | ||
1442 | <member name="T:OpenMetaverse.Utils.Runtime"> | ||
1123 | <summary> | 1443 | <summary> |
1124 | Clamp a given value between a range | 1444 | Runtime platform |
1125 | </summary> | 1445 | </summary> |
1126 | <param name="value">Value to clamp</param> | ||
1127 | <param name="min">Minimum allowable value</param> | ||
1128 | <param name="max">Maximum allowable value</param> | ||
1129 | <returns>A value inclusively between lower and upper</returns> | ||
1130 | </member> | 1446 | </member> |
1131 | <member name="M:OpenMetaverse.Utils.Clamp(System.Double,System.Double,System.Double)"> | 1447 | <member name="F:OpenMetaverse.Utils.Runtime.Windows"> |
1448 | <summary>.NET runtime</summary> | ||
1449 | </member> | ||
1450 | <member name="F:OpenMetaverse.Utils.Runtime.Mono"> | ||
1451 | <summary>Mono runtime: http://www.mono-project.com/</summary> | ||
1452 | </member> | ||
1453 | <member name="F:OpenMetaverse.Quaternion.X"> | ||
1454 | <summary>X value</summary> | ||
1455 | </member> | ||
1456 | <member name="F:OpenMetaverse.Quaternion.Y"> | ||
1457 | <summary>Y value</summary> | ||
1458 | </member> | ||
1459 | <member name="F:OpenMetaverse.Quaternion.Z"> | ||
1460 | <summary>Z value</summary> | ||
1461 | </member> | ||
1462 | <member name="F:OpenMetaverse.Quaternion.W"> | ||
1463 | <summary>W value</summary> | ||
1464 | </member> | ||
1465 | <member name="M:OpenMetaverse.Quaternion.#ctor(System.Single,System.Single,System.Single)"> | ||
1132 | <summary> | 1466 | <summary> |
1133 | Clamp a given value between a range | 1467 | Build a quaternion from normalized float values |
1134 | </summary> | 1468 | </summary> |
1135 | <param name="value">Value to clamp</param> | 1469 | <param name="x">X value from -1.0 to 1.0</param> |
1136 | <param name="min">Minimum allowable value</param> | 1470 | <param name="y">Y value from -1.0 to 1.0</param> |
1137 | <param name="max">Maximum allowable value</param> | 1471 | <param name="z">Z value from -1.0 to 1.0</param> |
1138 | <returns>A value inclusively between lower and upper</returns> | ||
1139 | </member> | 1472 | </member> |
1140 | <member name="M:OpenMetaverse.Utils.Clamp(System.Int32,System.Int32,System.Int32)"> | 1473 | <member name="M:OpenMetaverse.Quaternion.#ctor(System.Byte[],System.Int32,System.Boolean)"> |
1141 | <summary> | 1474 | <summary> |
1142 | Clamp a given value between a range | 1475 | Constructor, builds a quaternion object from a byte array |
1143 | </summary> | 1476 | </summary> |
1144 | <param name="value">Value to clamp</param> | 1477 | <param name="byteArray">Byte array containing four four-byte floats</param> |
1145 | <param name="min">Minimum allowable value</param> | 1478 | <param name="pos">Offset in the byte array to start reading at</param> |
1146 | <param name="max">Maximum allowable value</param> | 1479 | <param name="normalized">Whether the source data is normalized or |
1147 | <returns>A value inclusively between lower and upper</returns> | 1480 | not. If this is true 12 bytes will be read, otherwise 16 bytes will |
1481 | be read.</param> | ||
1148 | </member> | 1482 | </member> |
1149 | <member name="M:OpenMetaverse.Utils.Round(System.Single)"> | 1483 | <member name="M:OpenMetaverse.Quaternion.Normalize"> |
1150 | <summary> | 1484 | <summary> |
1151 | Round a floating-point value to the nearest integer | 1485 | Normalizes the quaternion |
1152 | </summary> | 1486 | </summary> |
1153 | <param name="val">Floating point number to round</param> | ||
1154 | <returns>Integer</returns> | ||
1155 | </member> | 1487 | </member> |
1156 | <member name="M:OpenMetaverse.Utils.IsFinite(System.Single)"> | 1488 | <member name="M:OpenMetaverse.Quaternion.FromBytes(System.Byte[],System.Int32,System.Boolean)"> |
1157 | <summary> | 1489 | <summary> |
1158 | Test if a single precision float is a finite number | 1490 | Builds a quaternion object from a byte array |
1159 | </summary> | 1491 | </summary> |
1492 | <param name="byteArray">The source byte array</param> | ||
1493 | <param name="pos">Offset in the byte array to start reading at</param> | ||
1494 | <param name="normalized">Whether the source data is normalized or | ||
1495 | not. If this is true 12 bytes will be read, otherwise 16 bytes will | ||
1496 | be read.</param> | ||
1160 | </member> | 1497 | </member> |
1161 | <member name="M:OpenMetaverse.Utils.IsFinite(System.Double)"> | 1498 | <member name="M:OpenMetaverse.Quaternion.GetBytes"> |
1162 | <summary> | 1499 | <summary> |
1163 | Test if a double precision float is a finite number | 1500 | Normalize this quaternion and serialize it to a byte array |
1164 | </summary> | 1501 | </summary> |
1502 | <returns>A 12 byte array containing normalized X, Y, and Z floating | ||
1503 | point values in order using little endian byte ordering</returns> | ||
1165 | </member> | 1504 | </member> |
1166 | <member name="M:OpenMetaverse.Utils.Distance(System.Single,System.Single)"> | 1505 | <member name="M:OpenMetaverse.Quaternion.ToBytes(System.Byte[],System.Int32)"> |
1167 | <summary> | 1506 | <summary> |
1168 | Get the distance between two floating-point values | 1507 | Writes the raw bytes for this quaternion to a byte array |
1169 | </summary> | 1508 | </summary> |
1170 | <param name="value1">First value</param> | 1509 | <param name="dest">Destination byte array</param> |
1171 | <param name="value2">Second value</param> | 1510 | <param name="pos">Position in the destination array to start |
1172 | <returns>The distance between the two values</returns> | 1511 | writing. Must be at least 12 bytes before the end of the array</param> |
1173 | </member> | 1512 | </member> |
1174 | <member name="M:OpenMetaverse.Utils.MD5(System.Byte[])"> | 1513 | <member name="M:OpenMetaverse.Quaternion.GetEulerAngles(System.Single@,System.Single@,System.Single@)"> |
1175 | <summary> | 1514 | <summary> |
1176 | Compute the MD5 hash for a byte array | 1515 | Convert this quaternion to euler angles |
1177 | </summary> | 1516 | </summary> |
1178 | <param name="data">Byte array to compute the hash for</param> | 1517 | <param name="roll">X euler angle</param> |
1179 | <returns>MD5 hash of the input data</returns> | 1518 | <param name="pitch">Y euler angle</param> |
1519 | <param name="yaw">Z euler angle</param> | ||
1180 | </member> | 1520 | </member> |
1181 | <member name="M:OpenMetaverse.Utils.SHA1(System.Byte[])"> | 1521 | <member name="M:OpenMetaverse.Quaternion.GetAxisAngle(OpenMetaverse.Vector3@,System.Single@)"> |
1182 | <summary> | 1522 | <summary> |
1183 | Compute the SHA1 hash for a byte array | 1523 | Convert this quaternion to an angle around an axis |
1184 | </summary> | 1524 | </summary> |
1185 | <param name="data">Byte array to compute the hash for</param> | 1525 | <param name="axis">Unit vector describing the axis</param> |
1186 | <returns>SHA1 hash of the input data</returns> | 1526 | <param name="angle">Angle around the axis, in radians</param> |
1187 | </member> | 1527 | </member> |
1188 | <member name="M:OpenMetaverse.Utils.SHA1String(System.String)"> | 1528 | <member name="M:OpenMetaverse.Quaternion.Conjugate(OpenMetaverse.Quaternion)"> |
1189 | <summary> | 1529 | <summary> |
1190 | Calculate the SHA1 hash of a given string | 1530 | Returns the conjugate (spatial inverse) of a quaternion |
1191 | </summary> | 1531 | </summary> |
1192 | <param name="value">The string to hash</param> | ||
1193 | <returns>The SHA1 hash as a string</returns> | ||
1194 | </member> | 1532 | </member> |
1195 | <member name="M:OpenMetaverse.Utils.SHA256(System.Byte[])"> | 1533 | <member name="M:OpenMetaverse.Quaternion.CreateFromAxisAngle(System.Single,System.Single,System.Single,System.Single)"> |
1196 | <summary> | 1534 | <summary> |
1197 | Compute the SHA256 hash for a byte array | 1535 | Build a quaternion from an axis and an angle of rotation around |
1536 | that axis | ||
1198 | </summary> | 1537 | </summary> |
1199 | <param name="data">Byte array to compute the hash for</param> | ||
1200 | <returns>SHA256 hash of the input data</returns> | ||
1201 | </member> | 1538 | </member> |
1202 | <member name="M:OpenMetaverse.Utils.SHA256String(System.String)"> | 1539 | <member name="M:OpenMetaverse.Quaternion.CreateFromAxisAngle(OpenMetaverse.Vector3,System.Single)"> |
1203 | <summary> | 1540 | <summary> |
1204 | Calculate the SHA256 hash of a given string | 1541 | Build a quaternion from an axis and an angle of rotation around |
1542 | that axis | ||
1205 | </summary> | 1543 | </summary> |
1206 | <param name="value">The string to hash</param> | 1544 | <param name="axis">Axis of rotation</param> |
1207 | <returns>The SHA256 hash as a string</returns> | 1545 | <param name="angle">Angle of rotation</param> |
1208 | </member> | 1546 | </member> |
1209 | <member name="M:OpenMetaverse.Utils.MD5(System.String)"> | 1547 | <member name="M:OpenMetaverse.Quaternion.CreateFromEulers(OpenMetaverse.Vector3)"> |
1210 | <summary> | 1548 | <summary> |
1211 | Calculate the MD5 hash of a given string | 1549 | Creates a quaternion from a vector containing roll, pitch, and yaw |
1550 | in radians | ||
1212 | </summary> | 1551 | </summary> |
1213 | <param name="password">The password to hash</param> | 1552 | <param name="eulers">Vector representation of the euler angles in |
1214 | <returns>An MD5 hash in string format, with $1$ prepended</returns> | 1553 | radians</param> |
1554 | <returns>Quaternion representation of the euler angles</returns> | ||
1215 | </member> | 1555 | </member> |
1216 | <member name="M:OpenMetaverse.Utils.MD5String(System.String)"> | 1556 | <member name="M:OpenMetaverse.Quaternion.CreateFromEulers(System.Single,System.Single,System.Single)"> |
1217 | <summary> | 1557 | <summary> |
1218 | Calculate the MD5 hash of a given string | 1558 | Creates a quaternion from roll, pitch, and yaw euler angles in |
1559 | radians | ||
1219 | </summary> | 1560 | </summary> |
1220 | <param name="value">The string to hash</param> | 1561 | <param name="roll">X angle in radians</param> |
1221 | <returns>The MD5 hash as a string</returns> | 1562 | <param name="pitch">Y angle in radians</param> |
1563 | <param name="yaw">Z angle in radians</param> | ||
1564 | <returns>Quaternion representation of the euler angles</returns> | ||
1222 | </member> | 1565 | </member> |
1223 | <member name="M:OpenMetaverse.Utils.RandomDouble"> | 1566 | <member name="M:OpenMetaverse.Quaternion.Inverse(OpenMetaverse.Quaternion)"> |
1224 | <summary> | 1567 | <summary> |
1225 | Generate a random double precision floating point value | 1568 | Conjugates and renormalizes a vector |
1226 | </summary> | 1569 | </summary> |
1227 | <returns>Random value of type double</returns> | ||
1228 | </member> | 1570 | </member> |
1229 | <member name="M:OpenMetaverse.Utils.GetRunningPlatform"> | 1571 | <member name="M:OpenMetaverse.Quaternion.Slerp(OpenMetaverse.Quaternion,OpenMetaverse.Quaternion,System.Single)"> |
1230 | <summary> | 1572 | <summary> |
1231 | Get the current running platform | 1573 | Spherical linear interpolation between two quaternions |
1232 | </summary> | 1574 | </summary> |
1233 | <returns>Enumeration of the current platform we are running on</returns> | ||
1234 | </member> | 1575 | </member> |
1235 | <member name="M:OpenMetaverse.Utils.GetRunningRuntime"> | 1576 | <member name="M:OpenMetaverse.Quaternion.ToRawString"> |
1236 | <summary> | 1577 | <summary> |
1237 | Get the current running runtime | 1578 | Get a string representation of the quaternion elements with up to three |
1579 | decimal digits and separated by spaces only | ||
1238 | </summary> | 1580 | </summary> |
1239 | <returns>Enumeration of the current runtime we are running on</returns> | 1581 | <returns>Raw string representation of the quaternion</returns> |
1240 | </member> | 1582 | </member> |
1241 | <member name="T:OpenMetaverse.Utils.Platform"> | 1583 | <member name="F:OpenMetaverse.Quaternion.Identity"> |
1584 | <summary>A quaternion with a value of 0,0,0,1</summary> | ||
1585 | </member> | ||
1586 | <member name="T:OpenMetaverse.BlockingQueue`1"> | ||
1242 | <summary> | 1587 | <summary> |
1243 | Operating system | 1588 | Same as Queue except Dequeue function blocks until there is an object to return. |
1589 | Note: This class does not need to be synchronized | ||
1244 | </summary> | 1590 | </summary> |
1245 | </member> | 1591 | </member> |
1246 | <member name="F:OpenMetaverse.Utils.Platform.Unknown"> | 1592 | <member name="M:OpenMetaverse.BlockingQueue`1.#ctor(System.Collections.Generic.IEnumerable{`0})"> |
1247 | <summary>Unknown</summary> | 1593 | <summary> |
1594 | Create new BlockingQueue. | ||
1595 | </summary> | ||
1596 | <param name="col">The System.Collections.ICollection to copy elements from</param> | ||
1248 | </member> | 1597 | </member> |
1249 | <member name="F:OpenMetaverse.Utils.Platform.Windows"> | 1598 | <member name="M:OpenMetaverse.BlockingQueue`1.#ctor(System.Int32)"> |
1250 | <summary>Microsoft Windows</summary> | 1599 | <summary> |
1600 | Create new BlockingQueue. | ||
1601 | </summary> | ||
1602 | <param name="capacity">The initial number of elements that the queue can contain</param> | ||
1251 | </member> | 1603 | </member> |
1252 | <member name="F:OpenMetaverse.Utils.Platform.WindowsCE"> | 1604 | <member name="M:OpenMetaverse.BlockingQueue`1.#ctor"> |
1253 | <summary>Microsoft Windows CE</summary> | 1605 | <summary> |
1606 | Create new BlockingQueue. | ||
1607 | </summary> | ||
1254 | </member> | 1608 | </member> |
1255 | <member name="F:OpenMetaverse.Utils.Platform.Linux"> | 1609 | <member name="M:OpenMetaverse.BlockingQueue`1.Finalize"> |
1256 | <summary>Linux</summary> | 1610 | <summary> |
1611 | BlockingQueue Destructor (Close queue, resume any waiting thread). | ||
1612 | </summary> | ||
1257 | </member> | 1613 | </member> |
1258 | <member name="F:OpenMetaverse.Utils.Platform.OSX"> | 1614 | <member name="M:OpenMetaverse.BlockingQueue`1.Clear"> |
1259 | <summary>Apple OSX</summary> | 1615 | <summary> |
1616 | Remove all objects from the Queue. | ||
1617 | </summary> | ||
1260 | </member> | 1618 | </member> |
1261 | <member name="T:OpenMetaverse.Utils.Runtime"> | 1619 | <member name="M:OpenMetaverse.BlockingQueue`1.Close"> |
1262 | <summary> | 1620 | <summary> |
1263 | Runtime platform | 1621 | Remove all objects from the Queue, resume all dequeue threads. |
1264 | </summary> | 1622 | </summary> |
1265 | </member> | 1623 | </member> |
1266 | <member name="F:OpenMetaverse.Utils.Runtime.Windows"> | 1624 | <member name="M:OpenMetaverse.BlockingQueue`1.Dequeue"> |
1267 | <summary>.NET runtime</summary> | 1625 | <summary> |
1626 | Removes and returns the object at the beginning of the Queue. | ||
1627 | </summary> | ||
1628 | <returns>Object in queue.</returns> | ||
1268 | </member> | 1629 | </member> |
1269 | <member name="F:OpenMetaverse.Utils.Runtime.Mono"> | 1630 | <member name="M:OpenMetaverse.BlockingQueue`1.Dequeue(System.TimeSpan)"> |
1270 | <summary>Mono runtime: http://www.mono-project.com/</summary> | 1631 | <summary> |
1632 | Removes and returns the object at the beginning of the Queue. | ||
1633 | </summary> | ||
1634 | <param name="timeout">time to wait before returning</param> | ||
1635 | <returns>Object in queue.</returns> | ||
1271 | </member> | 1636 | </member> |
1272 | <member name="T:OpenMetaverse.Vector2"> | 1637 | <member name="M:OpenMetaverse.BlockingQueue`1.Dequeue(System.Int32)"> |
1273 | <summary> | 1638 | <summary> |
1274 | A two-dimensional vector with floating-point values | 1639 | Removes and returns the object at the beginning of the Queue. |
1275 | </summary> | 1640 | </summary> |
1641 | <param name="timeout">time to wait before returning (in milliseconds)</param> | ||
1642 | <returns>Object in queue.</returns> | ||
1276 | </member> | 1643 | </member> |
1277 | <member name="F:OpenMetaverse.Vector2.X"> | 1644 | <member name="M:OpenMetaverse.BlockingQueue`1.Enqueue(`0)"> |
1645 | <summary> | ||
1646 | Adds an object to the end of the Queue | ||
1647 | </summary> | ||
1648 | <param name="obj">Object to put in queue</param> | ||
1649 | </member> | ||
1650 | <member name="M:OpenMetaverse.BlockingQueue`1.Open"> | ||
1651 | <summary> | ||
1652 | Open Queue. | ||
1653 | </summary> | ||
1654 | </member> | ||
1655 | <member name="P:OpenMetaverse.BlockingQueue`1.Closed"> | ||
1656 | <summary> | ||
1657 | Gets flag indicating if queue has been closed. | ||
1658 | </summary> | ||
1659 | </member> | ||
1660 | <member name="T:OpenMetaverse.Parallel"> | ||
1661 | <summary> | ||
1662 | Provides helper methods for parallelizing loops | ||
1663 | </summary> | ||
1664 | </member> | ||
1665 | <member name="M:OpenMetaverse.Parallel.For(System.Int32,System.Int32,System.Action{System.Int32})"> | ||
1666 | <summary> | ||
1667 | Executes a for loop in which iterations may run in parallel | ||
1668 | </summary> | ||
1669 | <param name="fromInclusive">The loop will be started at this index</param> | ||
1670 | <param name="toExclusive">The loop will be terminated before this index is reached</param> | ||
1671 | <param name="body">Method body to run for each iteration of the loop</param> | ||
1672 | </member> | ||
1673 | <member name="M:OpenMetaverse.Parallel.For(System.Int32,System.Int32,System.Int32,System.Action{System.Int32})"> | ||
1674 | <summary> | ||
1675 | Executes a for loop in which iterations may run in parallel | ||
1676 | </summary> | ||
1677 | <param name="threadCount">The number of concurrent execution threads to run</param> | ||
1678 | <param name="fromInclusive">The loop will be started at this index</param> | ||
1679 | <param name="toExclusive">The loop will be terminated before this index is reached</param> | ||
1680 | <param name="body">Method body to run for each iteration of the loop</param> | ||
1681 | </member> | ||
1682 | <member name="M:OpenMetaverse.Parallel.ForEach``1(System.Collections.Generic.IEnumerable{``0},System.Action{``0})"> | ||
1683 | <summary> | ||
1684 | Executes a foreach loop in which iterations may run in parallel | ||
1685 | </summary> | ||
1686 | <typeparam name="T">Object type that the collection wraps</typeparam> | ||
1687 | <param name="enumerable">An enumerable collection to iterate over</param> | ||
1688 | <param name="body">Method body to run for each object in the collection</param> | ||
1689 | </member> | ||
1690 | <member name="M:OpenMetaverse.Parallel.ForEach``1(System.Int32,System.Collections.Generic.IEnumerable{``0},System.Action{``0})"> | ||
1691 | <summary> | ||
1692 | Executes a foreach loop in which iterations may run in parallel | ||
1693 | </summary> | ||
1694 | <typeparam name="T">Object type that the collection wraps</typeparam> | ||
1695 | <param name="threadCount">The number of concurrent execution threads to run</param> | ||
1696 | <param name="enumerable">An enumerable collection to iterate over</param> | ||
1697 | <param name="body">Method body to run for each object in the collection</param> | ||
1698 | </member> | ||
1699 | <member name="M:OpenMetaverse.Parallel.Invoke(System.Action[])"> | ||
1700 | <summary> | ||
1701 | Executes a series of tasks in parallel | ||
1702 | </summary> | ||
1703 | <param name="actions">A series of method bodies to execute</param> | ||
1704 | </member> | ||
1705 | <member name="M:OpenMetaverse.Parallel.Invoke(System.Int32,System.Action[])"> | ||
1706 | <summary> | ||
1707 | Executes a series of tasks in parallel | ||
1708 | </summary> | ||
1709 | <param name="threadCount">The number of concurrent execution threads to run</param> | ||
1710 | <param name="actions">A series of method bodies to execute</param> | ||
1711 | </member> | ||
1712 | <member name="M:OpenMetaverse.Matrix4.GetEulerAngles(System.Single@,System.Single@,System.Single@)"> | ||
1713 | <summary> | ||
1714 | Convert this matrix to euler rotations | ||
1715 | </summary> | ||
1716 | <param name="roll">X euler angle</param> | ||
1717 | <param name="pitch">Y euler angle</param> | ||
1718 | <param name="yaw">Z euler angle</param> | ||
1719 | </member> | ||
1720 | <member name="M:OpenMetaverse.Matrix4.GetQuaternion"> | ||
1721 | <summary> | ||
1722 | Convert this matrix to a quaternion rotation | ||
1723 | </summary> | ||
1724 | <returns>A quaternion representation of this rotation matrix</returns> | ||
1725 | </member> | ||
1726 | <member name="M:OpenMetaverse.Matrix4.CreateFromEulers(System.Single,System.Single,System.Single)"> | ||
1727 | <summary> | ||
1728 | Construct a matrix from euler rotation values in radians | ||
1729 | </summary> | ||
1730 | <param name="roll">X euler angle in radians</param> | ||
1731 | <param name="pitch">Y euler angle in radians</param> | ||
1732 | <param name="yaw">Z euler angle in radians</param> | ||
1733 | </member> | ||
1734 | <member name="M:OpenMetaverse.Matrix4.ToString"> | ||
1735 | <summary> | ||
1736 | Get a formatted string representation of the vector | ||
1737 | </summary> | ||
1738 | <returns>A string representation of the vector</returns> | ||
1739 | </member> | ||
1740 | <member name="F:OpenMetaverse.Matrix4.Zero"> | ||
1741 | <summary>A 4x4 matrix containing all zeroes</summary> | ||
1742 | </member> | ||
1743 | <member name="F:OpenMetaverse.Matrix4.Identity"> | ||
1744 | <summary>A 4x4 identity matrix</summary> | ||
1745 | </member> | ||
1746 | <member name="F:OpenMetaverse.Vector4.X"> | ||
1278 | <summary>X value</summary> | 1747 | <summary>X value</summary> |
1279 | </member> | 1748 | </member> |
1280 | <member name="F:OpenMetaverse.Vector2.Y"> | 1749 | <member name="F:OpenMetaverse.Vector4.Y"> |
1281 | <summary>Y value</summary> | 1750 | <summary>Y value</summary> |
1282 | </member> | 1751 | </member> |
1283 | <member name="M:OpenMetaverse.Vector2.ApproxEquals(OpenMetaverse.Vector2,System.Single)"> | 1752 | <member name="F:OpenMetaverse.Vector4.Z"> |
1753 | <summary>Z value</summary> | ||
1754 | </member> | ||
1755 | <member name="F:OpenMetaverse.Vector4.W"> | ||
1756 | <summary>W value</summary> | ||
1757 | </member> | ||
1758 | <member name="M:OpenMetaverse.Vector4.#ctor(System.Byte[],System.Int32)"> | ||
1759 | <summary> | ||
1760 | Constructor, builds a vector from a byte array | ||
1761 | </summary> | ||
1762 | <param name="byteArray">Byte array containing four four-byte floats</param> | ||
1763 | <param name="pos">Beginning position in the byte array</param> | ||
1764 | </member> | ||
1765 | <member name="M:OpenMetaverse.Vector4.ApproxEquals(OpenMetaverse.Vector4,System.Single)"> | ||
1284 | <summary> | 1766 | <summary> |
1285 | Test if this vector is equal to another vector, within a given | 1767 | Test if this vector is equal to another vector, within a given |
1286 | tolerance range | 1768 | tolerance range |
@@ -1291,73 +1773,187 @@ | |||
1291 | <returns>True if the magnitude of difference between the two vectors | 1773 | <returns>True if the magnitude of difference between the two vectors |
1292 | is less than the given tolerance, otherwise false</returns> | 1774 | is less than the given tolerance, otherwise false</returns> |
1293 | </member> | 1775 | </member> |
1294 | <member name="M:OpenMetaverse.Vector2.IsFinite"> | 1776 | <member name="M:OpenMetaverse.Vector4.CompareTo(OpenMetaverse.Vector4)"> |
1777 | <summary> | ||
1778 | IComparable.CompareTo implementation | ||
1779 | </summary> | ||
1780 | </member> | ||
1781 | <member name="M:OpenMetaverse.Vector4.IsFinite"> | ||
1295 | <summary> | 1782 | <summary> |
1296 | Test if this vector is composed of all finite numbers | 1783 | Test if this vector is composed of all finite numbers |
1297 | </summary> | 1784 | </summary> |
1298 | </member> | 1785 | </member> |
1299 | <member name="M:OpenMetaverse.Vector2.CompareTo(OpenMetaverse.Vector2)"> | 1786 | <member name="M:OpenMetaverse.Vector4.FromBytes(System.Byte[],System.Int32)"> |
1787 | <summary> | ||
1788 | Builds a vector from a byte array | ||
1789 | </summary> | ||
1790 | <param name="byteArray">Byte array containing a 16 byte vector</param> | ||
1791 | <param name="pos">Beginning position in the byte array</param> | ||
1792 | </member> | ||
1793 | <member name="M:OpenMetaverse.Vector4.GetBytes"> | ||
1794 | <summary> | ||
1795 | Returns the raw bytes for this vector | ||
1796 | </summary> | ||
1797 | <returns>A 16 byte array containing X, Y, Z, and W</returns> | ||
1798 | </member> | ||
1799 | <member name="M:OpenMetaverse.Vector4.ToBytes(System.Byte[],System.Int32)"> | ||
1800 | <summary> | ||
1801 | Writes the raw bytes for this vector to a byte array | ||
1802 | </summary> | ||
1803 | <param name="dest">Destination byte array</param> | ||
1804 | <param name="pos">Position in the destination array to start | ||
1805 | writing. Must be at least 16 bytes before the end of the array</param> | ||
1806 | </member> | ||
1807 | <member name="M:OpenMetaverse.Vector4.ToRawString"> | ||
1808 | <summary> | ||
1809 | Get a string representation of the vector elements with up to three | ||
1810 | decimal digits and separated by spaces only | ||
1811 | </summary> | ||
1812 | <returns>Raw string representation of the vector</returns> | ||
1813 | </member> | ||
1814 | <member name="F:OpenMetaverse.Vector4.Zero"> | ||
1815 | <summary>A vector with a value of 0,0,0,0</summary> | ||
1816 | </member> | ||
1817 | <member name="F:OpenMetaverse.Vector4.One"> | ||
1818 | <summary>A vector with a value of 1,1,1,1</summary> | ||
1819 | </member> | ||
1820 | <member name="F:OpenMetaverse.Vector4.UnitX"> | ||
1821 | <summary>A vector with a value of 1,0,0,0</summary> | ||
1822 | </member> | ||
1823 | <member name="F:OpenMetaverse.Vector4.UnitY"> | ||
1824 | <summary>A vector with a value of 0,1,0,0</summary> | ||
1825 | </member> | ||
1826 | <member name="F:OpenMetaverse.Vector4.UnitZ"> | ||
1827 | <summary>A vector with a value of 0,0,1,0</summary> | ||
1828 | </member> | ||
1829 | <member name="F:OpenMetaverse.Vector4.UnitW"> | ||
1830 | <summary>A vector with a value of 0,0,0,1</summary> | ||
1831 | </member> | ||
1832 | <member name="F:OpenMetaverse.ExpiringCache`2.syncRoot"> | ||
1833 | <summary>For thread safety</summary> | ||
1834 | </member> | ||
1835 | <member name="F:OpenMetaverse.ExpiringCache`2.isPurging"> | ||
1836 | <summary>For thread safety</summary> | ||
1837 | </member> | ||
1838 | <member name="M:OpenMetaverse.ExpiringCache`2.PurgeCache(System.Object,System.Timers.ElapsedEventArgs)"> | ||
1839 | <summary> | ||
1840 | Purges expired objects from the cache. Called automatically by the purge timer. | ||
1841 | </summary> | ||
1842 | </member> | ||
1843 | <member name="T:OpenMetaverse.Vector3"> | ||
1844 | <summary> | ||
1845 | A three-dimensional vector with floating-point values | ||
1846 | </summary> | ||
1847 | </member> | ||
1848 | <member name="F:OpenMetaverse.Vector3.X"> | ||
1849 | <summary>X value</summary> | ||
1850 | </member> | ||
1851 | <member name="F:OpenMetaverse.Vector3.Y"> | ||
1852 | <summary>Y value</summary> | ||
1853 | </member> | ||
1854 | <member name="F:OpenMetaverse.Vector3.Z"> | ||
1855 | <summary>Z value</summary> | ||
1856 | </member> | ||
1857 | <member name="M:OpenMetaverse.Vector3.#ctor(System.Byte[],System.Int32)"> | ||
1858 | <summary> | ||
1859 | Constructor, builds a vector from a byte array | ||
1860 | </summary> | ||
1861 | <param name="byteArray">Byte array containing three four-byte floats</param> | ||
1862 | <param name="pos">Beginning position in the byte array</param> | ||
1863 | </member> | ||
1864 | <member name="M:OpenMetaverse.Vector3.ApproxEquals(OpenMetaverse.Vector3,System.Single)"> | ||
1865 | <summary> | ||
1866 | Test if this vector is equal to another vector, within a given | ||
1867 | tolerance range | ||
1868 | </summary> | ||
1869 | <param name="vec">Vector to test against</param> | ||
1870 | <param name="tolerance">The acceptable magnitude of difference | ||
1871 | between the two vectors</param> | ||
1872 | <returns>True if the magnitude of difference between the two vectors | ||
1873 | is less than the given tolerance, otherwise false</returns> | ||
1874 | </member> | ||
1875 | <member name="M:OpenMetaverse.Vector3.CompareTo(OpenMetaverse.Vector3)"> | ||
1300 | <summary> | 1876 | <summary> |
1301 | IComparable.CompareTo implementation | 1877 | IComparable.CompareTo implementation |
1302 | </summary> | 1878 | </summary> |
1303 | </member> | 1879 | </member> |
1304 | <member name="M:OpenMetaverse.Vector2.FromBytes(System.Byte[],System.Int32)"> | 1880 | <member name="M:OpenMetaverse.Vector3.IsFinite"> |
1881 | <summary> | ||
1882 | Test if this vector is composed of all finite numbers | ||
1883 | </summary> | ||
1884 | </member> | ||
1885 | <member name="M:OpenMetaverse.Vector3.FromBytes(System.Byte[],System.Int32)"> | ||
1305 | <summary> | 1886 | <summary> |
1306 | Builds a vector from a byte array | 1887 | Builds a vector from a byte array |
1307 | </summary> | 1888 | </summary> |
1308 | <param name="byteArray">Byte array containing two four-byte floats</param> | 1889 | <param name="byteArray">Byte array containing a 12 byte vector</param> |
1309 | <param name="pos">Beginning position in the byte array</param> | 1890 | <param name="pos">Beginning position in the byte array</param> |
1310 | </member> | 1891 | </member> |
1311 | <member name="M:OpenMetaverse.Vector2.GetBytes"> | 1892 | <member name="M:OpenMetaverse.Vector3.GetBytes"> |
1312 | <summary> | 1893 | <summary> |
1313 | Returns the raw bytes for this vector | 1894 | Returns the raw bytes for this vector |
1314 | </summary> | 1895 | </summary> |
1315 | <returns>An eight-byte array containing X and Y</returns> | 1896 | <returns>A 12 byte array containing X, Y, and Z</returns> |
1316 | </member> | 1897 | </member> |
1317 | <member name="M:OpenMetaverse.Vector2.ToBytes(System.Byte[],System.Int32)"> | 1898 | <member name="M:OpenMetaverse.Vector3.ToBytes(System.Byte[],System.Int32)"> |
1318 | <summary> | 1899 | <summary> |
1319 | Writes the raw bytes for this vector to a byte array | 1900 | Writes the raw bytes for this vector to a byte array |
1320 | </summary> | 1901 | </summary> |
1321 | <param name="dest">Destination byte array</param> | 1902 | <param name="dest">Destination byte array</param> |
1322 | <param name="pos">Position in the destination array to start | 1903 | <param name="pos">Position in the destination array to start |
1323 | writing. Must be at least 8 bytes before the end of the array</param> | 1904 | writing. Must be at least 12 bytes before the end of the array</param> |
1324 | </member> | 1905 | </member> |
1325 | <member name="M:OpenMetaverse.Vector2.Parse(System.String)"> | 1906 | <member name="M:OpenMetaverse.Vector3.Parse(System.String)"> |
1326 | <summary> | 1907 | <summary> |
1327 | Parse a vector from a string | 1908 | Parse a vector from a string |
1328 | </summary> | 1909 | </summary> |
1329 | <param name="val">A string representation of a 2D vector, enclosed | 1910 | <param name="val">A string representation of a 3D vector, enclosed |
1330 | in arrow brackets and separated by commas</param> | 1911 | in arrow brackets and separated by commas</param> |
1331 | </member> | 1912 | </member> |
1332 | <member name="M:OpenMetaverse.Vector2.SmoothStep(OpenMetaverse.Vector2,OpenMetaverse.Vector2,System.Single)"> | 1913 | <member name="M:OpenMetaverse.Vector3.RotationBetween(OpenMetaverse.Vector3,OpenMetaverse.Vector3)"> |
1914 | <summary> | ||
1915 | Calculate the rotation between two vectors | ||
1916 | </summary> | ||
1917 | <param name="a">Normalized directional vector (such as 1,0,0 for forward facing)</param> | ||
1918 | <param name="b">Normalized target vector</param> | ||
1919 | </member> | ||
1920 | <member name="M:OpenMetaverse.Vector3.SmoothStep(OpenMetaverse.Vector3,OpenMetaverse.Vector3,System.Single)"> | ||
1333 | <summary> | 1921 | <summary> |
1334 | Interpolates between two vectors using a cubic equation | 1922 | Interpolates between two vectors using a cubic equation |
1335 | </summary> | 1923 | </summary> |
1336 | </member> | 1924 | </member> |
1337 | <member name="M:OpenMetaverse.Vector2.ToString"> | 1925 | <member name="M:OpenMetaverse.Vector3.ToString"> |
1338 | <summary> | 1926 | <summary> |
1339 | Get a formatted string representation of the vector | 1927 | Get a formatted string representation of the vector |
1340 | </summary> | 1928 | </summary> |
1341 | <returns>A string representation of the vector</returns> | 1929 | <returns>A string representation of the vector</returns> |
1342 | </member> | 1930 | </member> |
1343 | <member name="M:OpenMetaverse.Vector2.ToRawString"> | 1931 | <member name="M:OpenMetaverse.Vector3.ToRawString"> |
1344 | <summary> | 1932 | <summary> |
1345 | Get a string representation of the vector elements with up to three | 1933 | Get a string representation of the vector elements with up to three |
1346 | decimal digits and separated by spaces only | 1934 | decimal digits and separated by spaces only |
1347 | </summary> | 1935 | </summary> |
1348 | <returns>Raw string representation of the vector</returns> | 1936 | <returns>Raw string representation of the vector</returns> |
1349 | </member> | 1937 | </member> |
1350 | <member name="F:OpenMetaverse.Vector2.Zero"> | 1938 | <member name="M:OpenMetaverse.Vector3.op_Modulus(OpenMetaverse.Vector3,OpenMetaverse.Vector3)"> |
1351 | <summary>A vector with a value of 0,0</summary> | 1939 | <summary> |
1940 | Cross product between two vectors | ||
1941 | </summary> | ||
1352 | </member> | 1942 | </member> |
1353 | <member name="F:OpenMetaverse.Vector2.One"> | 1943 | <member name="F:OpenMetaverse.Vector3.Zero"> |
1354 | <summary>A vector with a value of 1,1</summary> | 1944 | <summary>A vector with a value of 0,0,0</summary> |
1355 | </member> | 1945 | </member> |
1356 | <member name="F:OpenMetaverse.Vector2.UnitX"> | 1946 | <member name="F:OpenMetaverse.Vector3.One"> |
1357 | <summary>A vector with a value of 1,0</summary> | 1947 | <summary>A vector with a value of 1,1,1</summary> |
1358 | </member> | 1948 | </member> |
1359 | <member name="F:OpenMetaverse.Vector2.UnitY"> | 1949 | <member name="F:OpenMetaverse.Vector3.UnitX"> |
1360 | <summary>A vector with a value of 0,1</summary> | 1950 | <summary>A unit vector facing forward (X axis), value 1,0,0</summary> |
1951 | </member> | ||
1952 | <member name="F:OpenMetaverse.Vector3.UnitY"> | ||
1953 | <summary>A unit vector facing left (Y axis), value 0,1,0</summary> | ||
1954 | </member> | ||
1955 | <member name="F:OpenMetaverse.Vector3.UnitZ"> | ||
1956 | <summary>A unit vector facing up (Z axis), value 0,0,1</summary> | ||
1361 | </member> | 1957 | </member> |
1362 | <member name="T:OpenMetaverse.PCode"> | 1958 | <member name="T:OpenMetaverse.PCode"> |
1363 | <summary> | 1959 | <summary> |
@@ -1912,691 +2508,95 @@ | |||
1912 | <member name="F:OpenMetaverse.ClickAction.OpenMedia"> | 2508 | <member name="F:OpenMetaverse.ClickAction.OpenMedia"> |
1913 | <summary>Open parcel media</summary> | 2509 | <summary>Open parcel media</summary> |
1914 | </member> | 2510 | </member> |
1915 | <member name="T:OpenMetaverse.BlockingQueue`1"> | 2511 | <member name="T:OpenMetaverse.Vector2"> |
1916 | <summary> | ||
1917 | Same as Queue except Dequeue function blocks until there is an object to return. | ||
1918 | Note: This class does not need to be synchronized | ||
1919 | </summary> | ||
1920 | </member> | ||
1921 | <member name="M:OpenMetaverse.BlockingQueue`1.#ctor(System.Collections.Generic.IEnumerable{`0})"> | ||
1922 | <summary> | ||
1923 | Create new BlockingQueue. | ||
1924 | </summary> | ||
1925 | <param name="col">The System.Collections.ICollection to copy elements from</param> | ||
1926 | </member> | ||
1927 | <member name="M:OpenMetaverse.BlockingQueue`1.#ctor(System.Int32)"> | ||
1928 | <summary> | ||
1929 | Create new BlockingQueue. | ||
1930 | </summary> | ||
1931 | <param name="capacity">The initial number of elements that the queue can contain</param> | ||
1932 | </member> | ||
1933 | <member name="M:OpenMetaverse.BlockingQueue`1.#ctor"> | ||
1934 | <summary> | ||
1935 | Create new BlockingQueue. | ||
1936 | </summary> | ||
1937 | </member> | ||
1938 | <member name="M:OpenMetaverse.BlockingQueue`1.Finalize"> | ||
1939 | <summary> | ||
1940 | BlockingQueue Destructor (Close queue, resume any waiting thread). | ||
1941 | </summary> | ||
1942 | </member> | ||
1943 | <member name="M:OpenMetaverse.BlockingQueue`1.Clear"> | ||
1944 | <summary> | ||
1945 | Remove all objects from the Queue. | ||
1946 | </summary> | ||
1947 | </member> | ||
1948 | <member name="M:OpenMetaverse.BlockingQueue`1.Close"> | ||
1949 | <summary> | ||
1950 | Remove all objects from the Queue, resume all dequeue threads. | ||
1951 | </summary> | ||
1952 | </member> | ||
1953 | <member name="M:OpenMetaverse.BlockingQueue`1.Dequeue"> | ||
1954 | <summary> | ||
1955 | Removes and returns the object at the beginning of the Queue. | ||
1956 | </summary> | ||
1957 | <returns>Object in queue.</returns> | ||
1958 | </member> | ||
1959 | <member name="M:OpenMetaverse.BlockingQueue`1.Dequeue(System.TimeSpan)"> | ||
1960 | <summary> | ||
1961 | Removes and returns the object at the beginning of the Queue. | ||
1962 | </summary> | ||
1963 | <param name="timeout">time to wait before returning</param> | ||
1964 | <returns>Object in queue.</returns> | ||
1965 | </member> | ||
1966 | <member name="M:OpenMetaverse.BlockingQueue`1.Dequeue(System.Int32)"> | ||
1967 | <summary> | ||
1968 | Removes and returns the object at the beginning of the Queue. | ||
1969 | </summary> | ||
1970 | <param name="timeout">time to wait before returning (in milliseconds)</param> | ||
1971 | <returns>Object in queue.</returns> | ||
1972 | </member> | ||
1973 | <member name="M:OpenMetaverse.BlockingQueue`1.Enqueue(`0)"> | ||
1974 | <summary> | ||
1975 | Adds an object to the end of the Queue | ||
1976 | </summary> | ||
1977 | <param name="obj">Object to put in queue</param> | ||
1978 | </member> | ||
1979 | <member name="M:OpenMetaverse.BlockingQueue`1.Open"> | ||
1980 | <summary> | ||
1981 | Open Queue. | ||
1982 | </summary> | ||
1983 | </member> | ||
1984 | <member name="P:OpenMetaverse.BlockingQueue`1.Closed"> | ||
1985 | <summary> | ||
1986 | Gets flag indicating if queue has been closed. | ||
1987 | </summary> | ||
1988 | </member> | ||
1989 | <member name="M:OpenMetaverse.ReaderWriterLockSlim.ExitAndWakeUpAppropriateWaiters"> | ||
1990 | <summary> | ||
1991 | Determines the appropriate events to set, leaves the locks, and sets the events. | ||
1992 | </summary> | ||
1993 | </member> | ||
1994 | <member name="M:OpenMetaverse.ReaderWriterLockSlim.LazyCreateEvent(System.Threading.EventWaitHandle@,System.Boolean)"> | ||
1995 | <summary> | ||
1996 | A routine for lazily creating a event outside the lock (so if errors | ||
1997 | happen they are outside the lock and that we don't do much work | ||
1998 | while holding a spin lock). If all goes well, reenter the lock and | ||
1999 | set 'waitEvent' | ||
2000 | </summary> | ||
2001 | </member> | ||
2002 | <member name="M:OpenMetaverse.ReaderWriterLockSlim.WaitOnEvent(System.Threading.EventWaitHandle,System.UInt32@,System.Int32)"> | ||
2003 | <summary> | ||
2004 | Waits on 'waitEvent' with a timeout of 'millisceondsTimeout. | ||
2005 | Before the wait 'numWaiters' is incremented and is restored before leaving this routine. | ||
2006 | </summary> | ||
2007 | </member> | ||
2008 | <member name="F:OpenMetaverse.ExpiringCache`2.syncRoot"> | ||
2009 | <summary>For thread safety</summary> | ||
2010 | </member> | ||
2011 | <member name="F:OpenMetaverse.ExpiringCache`2.isPurging"> | ||
2012 | <summary>For thread safety</summary> | ||
2013 | </member> | ||
2014 | <member name="M:OpenMetaverse.ExpiringCache`2.PurgeCache(System.Object,System.Timers.ElapsedEventArgs)"> | ||
2015 | <summary> | ||
2016 | Purges expired objects from the cache. Called automatically by the purge timer. | ||
2017 | </summary> | ||
2018 | </member> | ||
2019 | <member name="T:OpenMetaverse.EnumInfoAttribute"> | ||
2020 | <summary> | ||
2021 | Attribute class that allows extra attributes to be attached to ENUMs | ||
2022 | </summary> | ||
2023 | </member> | ||
2024 | <member name="F:OpenMetaverse.EnumInfoAttribute.Text"> | ||
2025 | <summary>Text used when presenting ENUM to user</summary> | ||
2026 | </member> | ||
2027 | <member name="M:OpenMetaverse.EnumInfoAttribute.#ctor"> | ||
2028 | <summary>Default initializer</summary> | ||
2029 | </member> | ||
2030 | <member name="M:OpenMetaverse.EnumInfoAttribute.#ctor(System.String)"> | ||
2031 | <summary>Text used when presenting ENUM to user</summary> | ||
2032 | </member> | ||
2033 | <member name="T:OpenMetaverse.AssetType"> | ||
2034 | <summary> | ||
2035 | The different types of grid assets | ||
2036 | </summary> | ||
2037 | </member> | ||
2038 | <member name="F:OpenMetaverse.AssetType.Unknown"> | ||
2039 | <summary>Unknown asset type</summary> | ||
2040 | </member> | ||
2041 | <member name="F:OpenMetaverse.AssetType.Texture"> | ||
2042 | <summary>Texture asset, stores in JPEG2000 J2C stream format</summary> | ||
2043 | </member> | ||
2044 | <member name="F:OpenMetaverse.AssetType.Sound"> | ||
2045 | <summary>Sound asset</summary> | ||
2046 | </member> | ||
2047 | <member name="F:OpenMetaverse.AssetType.CallingCard"> | ||
2048 | <summary>Calling card for another avatar</summary> | ||
2049 | </member> | ||
2050 | <member name="F:OpenMetaverse.AssetType.Landmark"> | ||
2051 | <summary>Link to a location in world</summary> | ||
2052 | </member> | ||
2053 | <member name="F:OpenMetaverse.AssetType.Clothing"> | ||
2054 | <summary>Collection of textures and parameters that can be | ||
2055 | worn by an avatar</summary> | ||
2056 | </member> | ||
2057 | <member name="F:OpenMetaverse.AssetType.Object"> | ||
2058 | <summary>Primitive that can contain textures, sounds, | ||
2059 | scripts and more</summary> | ||
2060 | </member> | ||
2061 | <member name="F:OpenMetaverse.AssetType.Notecard"> | ||
2062 | <summary>Notecard asset</summary> | ||
2063 | </member> | ||
2064 | <member name="F:OpenMetaverse.AssetType.Folder"> | ||
2065 | <summary>Holds a collection of inventory items</summary> | ||
2066 | </member> | ||
2067 | <member name="F:OpenMetaverse.AssetType.RootFolder"> | ||
2068 | <summary>Root inventory folder</summary> | ||
2069 | </member> | ||
2070 | <member name="F:OpenMetaverse.AssetType.LSLText"> | ||
2071 | <summary>Linden scripting language script</summary> | ||
2072 | </member> | ||
2073 | <member name="F:OpenMetaverse.AssetType.LSLBytecode"> | ||
2074 | <summary>LSO bytecode for a script</summary> | ||
2075 | </member> | ||
2076 | <member name="F:OpenMetaverse.AssetType.TextureTGA"> | ||
2077 | <summary>Uncompressed TGA texture</summary> | ||
2078 | </member> | ||
2079 | <member name="F:OpenMetaverse.AssetType.Bodypart"> | ||
2080 | <summary>Collection of textures and shape parameters that can | ||
2081 | be worn</summary> | ||
2082 | </member> | ||
2083 | <member name="F:OpenMetaverse.AssetType.TrashFolder"> | ||
2084 | <summary>Trash folder</summary> | ||
2085 | </member> | ||
2086 | <member name="F:OpenMetaverse.AssetType.SnapshotFolder"> | ||
2087 | <summary>Snapshot folder</summary> | ||
2088 | </member> | ||
2089 | <member name="F:OpenMetaverse.AssetType.LostAndFoundFolder"> | ||
2090 | <summary>Lost and found folder</summary> | ||
2091 | </member> | ||
2092 | <member name="F:OpenMetaverse.AssetType.SoundWAV"> | ||
2093 | <summary>Uncompressed sound</summary> | ||
2094 | </member> | ||
2095 | <member name="F:OpenMetaverse.AssetType.ImageTGA"> | ||
2096 | <summary>Uncompressed TGA non-square image, not to be used as a | ||
2097 | texture</summary> | ||
2098 | </member> | ||
2099 | <member name="F:OpenMetaverse.AssetType.ImageJPEG"> | ||
2100 | <summary>Compressed JPEG non-square image, not to be used as a | ||
2101 | texture</summary> | ||
2102 | </member> | ||
2103 | <member name="F:OpenMetaverse.AssetType.Animation"> | ||
2104 | <summary>Animation</summary> | ||
2105 | </member> | ||
2106 | <member name="F:OpenMetaverse.AssetType.Gesture"> | ||
2107 | <summary>Sequence of animations, sounds, chat, and pauses</summary> | ||
2108 | </member> | ||
2109 | <member name="F:OpenMetaverse.AssetType.Simstate"> | ||
2110 | <summary>Simstate file</summary> | ||
2111 | </member> | ||
2112 | <member name="F:OpenMetaverse.AssetType.FavoriteFolder"> | ||
2113 | <summary>Contains landmarks for favorites</summary> | ||
2114 | </member> | ||
2115 | <member name="F:OpenMetaverse.AssetType.Link"> | ||
2116 | <summary>Asset is a link to another inventory item</summary> | ||
2117 | </member> | ||
2118 | <member name="F:OpenMetaverse.AssetType.LinkFolder"> | ||
2119 | <summary>Asset is a link to another inventory folder</summary> | ||
2120 | </member> | ||
2121 | <member name="F:OpenMetaverse.AssetType.EnsembleStart"> | ||
2122 | <summary>Beginning of the range reserved for ensembles</summary> | ||
2123 | </member> | ||
2124 | <member name="F:OpenMetaverse.AssetType.EnsembleEnd"> | ||
2125 | <summary>End of the range reserved for ensembles</summary> | ||
2126 | </member> | ||
2127 | <member name="F:OpenMetaverse.AssetType.CurrentOutfitFolder"> | ||
2128 | <summary>Folder containing inventory links to wearables and attachments | ||
2129 | that are part of the current outfit</summary> | ||
2130 | </member> | ||
2131 | <member name="F:OpenMetaverse.AssetType.OutfitFolder"> | ||
2132 | <summary>Folder containing inventory items or links to | ||
2133 | inventory items of wearables and attachments | ||
2134 | together make a full outfit</summary> | ||
2135 | </member> | ||
2136 | <member name="F:OpenMetaverse.AssetType.MyOutfitsFolder"> | ||
2137 | <summary>Root folder for the folders of type OutfitFolder</summary> | ||
2138 | </member> | ||
2139 | <member name="F:OpenMetaverse.AssetType.Mesh"> | ||
2140 | <summary>Linden mesh format</summary> | ||
2141 | </member> | ||
2142 | <member name="T:OpenMetaverse.InventoryType"> | ||
2143 | <summary> | ||
2144 | Inventory Item Types, eg Script, Notecard, Folder, etc | ||
2145 | </summary> | ||
2146 | </member> | ||
2147 | <member name="F:OpenMetaverse.InventoryType.Unknown"> | ||
2148 | <summary>Unknown</summary> | ||
2149 | </member> | ||
2150 | <member name="F:OpenMetaverse.InventoryType.Texture"> | ||
2151 | <summary>Texture</summary> | ||
2152 | </member> | ||
2153 | <member name="F:OpenMetaverse.InventoryType.Sound"> | ||
2154 | <summary>Sound</summary> | ||
2155 | </member> | ||
2156 | <member name="F:OpenMetaverse.InventoryType.CallingCard"> | ||
2157 | <summary>Calling Card</summary> | ||
2158 | </member> | ||
2159 | <member name="F:OpenMetaverse.InventoryType.Landmark"> | ||
2160 | <summary>Landmark</summary> | ||
2161 | </member> | ||
2162 | <member name="F:OpenMetaverse.InventoryType.Notecard"> | ||
2163 | <summary>Notecard</summary> | ||
2164 | </member> | ||
2165 | <member name="F:OpenMetaverse.InventoryType.Category"> | ||
2166 | <summary></summary> | ||
2167 | </member> | ||
2168 | <member name="F:OpenMetaverse.InventoryType.Folder"> | ||
2169 | <summary>Folder</summary> | ||
2170 | </member> | ||
2171 | <member name="F:OpenMetaverse.InventoryType.RootCategory"> | ||
2172 | <summary></summary> | ||
2173 | </member> | ||
2174 | <member name="F:OpenMetaverse.InventoryType.LSL"> | ||
2175 | <summary>an LSL Script</summary> | ||
2176 | </member> | ||
2177 | <member name="F:OpenMetaverse.InventoryType.Snapshot"> | ||
2178 | <summary></summary> | ||
2179 | </member> | ||
2180 | <member name="F:OpenMetaverse.InventoryType.Attachment"> | ||
2181 | <summary></summary> | ||
2182 | </member> | ||
2183 | <member name="F:OpenMetaverse.InventoryType.Wearable"> | ||
2184 | <summary></summary> | ||
2185 | </member> | ||
2186 | <member name="F:OpenMetaverse.InventoryType.Animation"> | ||
2187 | <summary></summary> | ||
2188 | </member> | ||
2189 | <member name="F:OpenMetaverse.InventoryType.Gesture"> | ||
2190 | <summary></summary> | ||
2191 | </member> | ||
2192 | <member name="F:OpenMetaverse.InventoryType.Mesh"> | ||
2193 | <summary></summary> | ||
2194 | </member> | ||
2195 | <member name="T:OpenMetaverse.SaleType"> | ||
2196 | <summary> | ||
2197 | Item Sale Status | ||
2198 | </summary> | ||
2199 | </member> | ||
2200 | <member name="F:OpenMetaverse.SaleType.Not"> | ||
2201 | <summary>Not for sale</summary> | ||
2202 | </member> | ||
2203 | <member name="F:OpenMetaverse.SaleType.Original"> | ||
2204 | <summary>The original is for sale</summary> | ||
2205 | </member> | ||
2206 | <member name="F:OpenMetaverse.SaleType.Copy"> | ||
2207 | <summary>Copies are for sale</summary> | ||
2208 | </member> | ||
2209 | <member name="F:OpenMetaverse.SaleType.Contents"> | ||
2210 | <summary>The contents of the object are for sale</summary> | ||
2211 | </member> | ||
2212 | <member name="T:OpenMetaverse.WearableType"> | ||
2213 | <summary> | 2512 | <summary> |
2214 | Types of wearable assets | 2513 | A two-dimensional vector with floating-point values |
2215 | </summary> | 2514 | </summary> |
2216 | </member> | 2515 | </member> |
2217 | <member name="F:OpenMetaverse.WearableType.Shape"> | 2516 | <member name="F:OpenMetaverse.Vector2.X"> |
2218 | <summary>Body shape</summary> | ||
2219 | </member> | ||
2220 | <member name="F:OpenMetaverse.WearableType.Skin"> | ||
2221 | <summary>Skin textures and attributes</summary> | ||
2222 | </member> | ||
2223 | <member name="F:OpenMetaverse.WearableType.Hair"> | ||
2224 | <summary>Hair</summary> | ||
2225 | </member> | ||
2226 | <member name="F:OpenMetaverse.WearableType.Eyes"> | ||
2227 | <summary>Eyes</summary> | ||
2228 | </member> | ||
2229 | <member name="F:OpenMetaverse.WearableType.Shirt"> | ||
2230 | <summary>Shirt</summary> | ||
2231 | </member> | ||
2232 | <member name="F:OpenMetaverse.WearableType.Pants"> | ||
2233 | <summary>Pants</summary> | ||
2234 | </member> | ||
2235 | <member name="F:OpenMetaverse.WearableType.Shoes"> | ||
2236 | <summary>Shoes</summary> | ||
2237 | </member> | ||
2238 | <member name="F:OpenMetaverse.WearableType.Socks"> | ||
2239 | <summary>Socks</summary> | ||
2240 | </member> | ||
2241 | <member name="F:OpenMetaverse.WearableType.Jacket"> | ||
2242 | <summary>Jacket</summary> | ||
2243 | </member> | ||
2244 | <member name="F:OpenMetaverse.WearableType.Gloves"> | ||
2245 | <summary>Gloves</summary> | ||
2246 | </member> | ||
2247 | <member name="F:OpenMetaverse.WearableType.Undershirt"> | ||
2248 | <summary>Undershirt</summary> | ||
2249 | </member> | ||
2250 | <member name="F:OpenMetaverse.WearableType.Underpants"> | ||
2251 | <summary>Underpants</summary> | ||
2252 | </member> | ||
2253 | <member name="F:OpenMetaverse.WearableType.Skirt"> | ||
2254 | <summary>Skirt</summary> | ||
2255 | </member> | ||
2256 | <member name="F:OpenMetaverse.WearableType.Alpha"> | ||
2257 | <summary>Alpha mask to hide parts of the avatar</summary> | ||
2258 | </member> | ||
2259 | <member name="F:OpenMetaverse.WearableType.Tattoo"> | ||
2260 | <summary>Tattoo</summary> | ||
2261 | </member> | ||
2262 | <member name="F:OpenMetaverse.WearableType.Invalid"> | ||
2263 | <summary>Invalid wearable asset</summary> | ||
2264 | </member> | ||
2265 | <member name="F:OpenMetaverse.Quaternion.X"> | ||
2266 | <summary>X value</summary> | 2517 | <summary>X value</summary> |
2267 | </member> | 2518 | </member> |
2268 | <member name="F:OpenMetaverse.Quaternion.Y"> | 2519 | <member name="F:OpenMetaverse.Vector2.Y"> |
2269 | <summary>Y value</summary> | 2520 | <summary>Y value</summary> |
2270 | </member> | 2521 | </member> |
2271 | <member name="F:OpenMetaverse.Quaternion.Z"> | 2522 | <member name="M:OpenMetaverse.Vector2.ApproxEquals(OpenMetaverse.Vector2,System.Single)"> |
2272 | <summary>Z value</summary> | ||
2273 | </member> | ||
2274 | <member name="F:OpenMetaverse.Quaternion.W"> | ||
2275 | <summary>W value</summary> | ||
2276 | </member> | ||
2277 | <member name="M:OpenMetaverse.Quaternion.#ctor(System.Single,System.Single,System.Single)"> | ||
2278 | <summary> | 2523 | <summary> |
2279 | Build a quaternion from normalized float values | 2524 | Test if this vector is equal to another vector, within a given |
2525 | tolerance range | ||
2280 | </summary> | 2526 | </summary> |
2281 | <param name="x">X value from -1.0 to 1.0</param> | 2527 | <param name="vec">Vector to test against</param> |
2282 | <param name="y">Y value from -1.0 to 1.0</param> | 2528 | <param name="tolerance">The acceptable magnitude of difference |
2283 | <param name="z">Z value from -1.0 to 1.0</param> | 2529 | between the two vectors</param> |
2530 | <returns>True if the magnitude of difference between the two vectors | ||
2531 | is less than the given tolerance, otherwise false</returns> | ||
2284 | </member> | 2532 | </member> |
2285 | <member name="M:OpenMetaverse.Quaternion.#ctor(System.Byte[],System.Int32,System.Boolean)"> | 2533 | <member name="M:OpenMetaverse.Vector2.IsFinite"> |
2286 | <summary> | 2534 | <summary> |
2287 | Constructor, builds a quaternion object from a byte array | 2535 | Test if this vector is composed of all finite numbers |
2288 | </summary> | 2536 | </summary> |
2289 | <param name="byteArray">Byte array containing four four-byte floats</param> | ||
2290 | <param name="pos">Offset in the byte array to start reading at</param> | ||
2291 | <param name="normalized">Whether the source data is normalized or | ||
2292 | not. If this is true 12 bytes will be read, otherwise 16 bytes will | ||
2293 | be read.</param> | ||
2294 | </member> | 2537 | </member> |
2295 | <member name="M:OpenMetaverse.Quaternion.Normalize"> | 2538 | <member name="M:OpenMetaverse.Vector2.CompareTo(OpenMetaverse.Vector2)"> |
2296 | <summary> | 2539 | <summary> |
2297 | Normalizes the quaternion | 2540 | IComparable.CompareTo implementation |
2298 | </summary> | 2541 | </summary> |
2299 | </member> | 2542 | </member> |
2300 | <member name="M:OpenMetaverse.Quaternion.FromBytes(System.Byte[],System.Int32,System.Boolean)"> | 2543 | <member name="M:OpenMetaverse.Vector2.FromBytes(System.Byte[],System.Int32)"> |
2301 | <summary> | 2544 | <summary> |
2302 | Builds a quaternion object from a byte array | 2545 | Builds a vector from a byte array |
2303 | </summary> | 2546 | </summary> |
2304 | <param name="byteArray">The source byte array</param> | 2547 | <param name="byteArray">Byte array containing two four-byte floats</param> |
2305 | <param name="pos">Offset in the byte array to start reading at</param> | 2548 | <param name="pos">Beginning position in the byte array</param> |
2306 | <param name="normalized">Whether the source data is normalized or | ||
2307 | not. If this is true 12 bytes will be read, otherwise 16 bytes will | ||
2308 | be read.</param> | ||
2309 | </member> | 2549 | </member> |
2310 | <member name="M:OpenMetaverse.Quaternion.GetBytes"> | 2550 | <member name="M:OpenMetaverse.Vector2.GetBytes"> |
2311 | <summary> | 2551 | <summary> |
2312 | Normalize this quaternion and serialize it to a byte array | 2552 | Returns the raw bytes for this vector |
2313 | </summary> | 2553 | </summary> |
2314 | <returns>A 12 byte array containing normalized X, Y, and Z floating | 2554 | <returns>An eight-byte array containing X and Y</returns> |
2315 | point values in order using little endian byte ordering</returns> | ||
2316 | </member> | 2555 | </member> |
2317 | <member name="M:OpenMetaverse.Quaternion.ToBytes(System.Byte[],System.Int32)"> | 2556 | <member name="M:OpenMetaverse.Vector2.ToBytes(System.Byte[],System.Int32)"> |
2318 | <summary> | 2557 | <summary> |
2319 | Writes the raw bytes for this quaternion to a byte array | 2558 | Writes the raw bytes for this vector to a byte array |
2320 | </summary> | 2559 | </summary> |
2321 | <param name="dest">Destination byte array</param> | 2560 | <param name="dest">Destination byte array</param> |
2322 | <param name="pos">Position in the destination array to start | 2561 | <param name="pos">Position in the destination array to start |
2323 | writing. Must be at least 12 bytes before the end of the array</param> | 2562 | writing. Must be at least 8 bytes before the end of the array</param> |
2324 | </member> | ||
2325 | <member name="M:OpenMetaverse.Quaternion.GetEulerAngles(System.Single@,System.Single@,System.Single@)"> | ||
2326 | <summary> | ||
2327 | Convert this quaternion to euler angles | ||
2328 | </summary> | ||
2329 | <param name="roll">X euler angle</param> | ||
2330 | <param name="pitch">Y euler angle</param> | ||
2331 | <param name="yaw">Z euler angle</param> | ||
2332 | </member> | ||
2333 | <member name="M:OpenMetaverse.Quaternion.GetAxisAngle(OpenMetaverse.Vector3@,System.Single@)"> | ||
2334 | <summary> | ||
2335 | Convert this quaternion to an angle around an axis | ||
2336 | </summary> | ||
2337 | <param name="axis">Unit vector describing the axis</param> | ||
2338 | <param name="angle">Angle around the axis, in radians</param> | ||
2339 | </member> | ||
2340 | <member name="M:OpenMetaverse.Quaternion.Conjugate(OpenMetaverse.Quaternion)"> | ||
2341 | <summary> | ||
2342 | Returns the conjugate (spatial inverse) of a quaternion | ||
2343 | </summary> | ||
2344 | </member> | ||
2345 | <member name="M:OpenMetaverse.Quaternion.CreateFromAxisAngle(System.Single,System.Single,System.Single,System.Single)"> | ||
2346 | <summary> | ||
2347 | Build a quaternion from an axis and an angle of rotation around | ||
2348 | that axis | ||
2349 | </summary> | ||
2350 | </member> | ||
2351 | <member name="M:OpenMetaverse.Quaternion.CreateFromAxisAngle(OpenMetaverse.Vector3,System.Single)"> | ||
2352 | <summary> | ||
2353 | Build a quaternion from an axis and an angle of rotation around | ||
2354 | that axis | ||
2355 | </summary> | ||
2356 | <param name="axis">Axis of rotation</param> | ||
2357 | <param name="angle">Angle of rotation</param> | ||
2358 | </member> | ||
2359 | <member name="M:OpenMetaverse.Quaternion.CreateFromEulers(OpenMetaverse.Vector3)"> | ||
2360 | <summary> | ||
2361 | Creates a quaternion from a vector containing roll, pitch, and yaw | ||
2362 | in radians | ||
2363 | </summary> | ||
2364 | <param name="eulers">Vector representation of the euler angles in | ||
2365 | radians</param> | ||
2366 | <returns>Quaternion representation of the euler angles</returns> | ||
2367 | </member> | 2563 | </member> |
2368 | <member name="M:OpenMetaverse.Quaternion.CreateFromEulers(System.Single,System.Single,System.Single)"> | 2564 | <member name="M:OpenMetaverse.Vector2.Parse(System.String)"> |
2369 | <summary> | 2565 | <summary> |
2370 | Creates a quaternion from roll, pitch, and yaw euler angles in | 2566 | Parse a vector from a string |
2371 | radians | ||
2372 | </summary> | 2567 | </summary> |
2373 | <param name="roll">X angle in radians</param> | 2568 | <param name="val">A string representation of a 2D vector, enclosed |
2374 | <param name="pitch">Y angle in radians</param> | 2569 | in arrow brackets and separated by commas</param> |
2375 | <param name="yaw">Z angle in radians</param> | ||
2376 | <returns>Quaternion representation of the euler angles</returns> | ||
2377 | </member> | 2570 | </member> |
2378 | <member name="M:OpenMetaverse.Quaternion.Inverse(OpenMetaverse.Quaternion)"> | 2571 | <member name="M:OpenMetaverse.Vector2.SmoothStep(OpenMetaverse.Vector2,OpenMetaverse.Vector2,System.Single)"> |
2379 | <summary> | 2572 | <summary> |
2380 | Conjugates and renormalizes a vector | 2573 | Interpolates between two vectors using a cubic equation |
2381 | </summary> | 2574 | </summary> |
2382 | </member> | 2575 | </member> |
2383 | <member name="M:OpenMetaverse.Quaternion.Slerp(OpenMetaverse.Quaternion,OpenMetaverse.Quaternion,System.Single)"> | 2576 | <member name="M:OpenMetaverse.Vector2.ToString"> |
2384 | <summary> | 2577 | <summary> |
2385 | Spherical linear interpolation between two quaternions | 2578 | Get a formatted string representation of the vector |
2386 | </summary> | 2579 | </summary> |
2580 | <returns>A string representation of the vector</returns> | ||
2387 | </member> | 2581 | </member> |
2388 | <member name="M:OpenMetaverse.Quaternion.ToRawString"> | 2582 | <member name="M:OpenMetaverse.Vector2.ToRawString"> |
2389 | <summary> | 2583 | <summary> |
2390 | Get a string representation of the quaternion elements with up to three | 2584 | Get a string representation of the vector elements with up to three |
2391 | decimal digits and separated by spaces only | 2585 | decimal digits and separated by spaces only |
2392 | </summary> | 2586 | </summary> |
2393 | <returns>Raw string representation of the quaternion</returns> | 2587 | <returns>Raw string representation of the vector</returns> |
2394 | </member> | ||
2395 | <member name="F:OpenMetaverse.Quaternion.Identity"> | ||
2396 | <summary>A quaternion with a value of 0,0,0,1</summary> | ||
2397 | </member> | ||
2398 | <member name="T:OpenMetaverse.Parallel"> | ||
2399 | <summary> | ||
2400 | Provides helper methods for parallelizing loops | ||
2401 | </summary> | ||
2402 | </member> | ||
2403 | <member name="M:OpenMetaverse.Parallel.For(System.Int32,System.Int32,System.Action{System.Int32})"> | ||
2404 | <summary> | ||
2405 | Executes a for loop in which iterations may run in parallel | ||
2406 | </summary> | ||
2407 | <param name="fromInclusive">The loop will be started at this index</param> | ||
2408 | <param name="toExclusive">The loop will be terminated before this index is reached</param> | ||
2409 | <param name="body">Method body to run for each iteration of the loop</param> | ||
2410 | </member> | ||
2411 | <member name="M:OpenMetaverse.Parallel.For(System.Int32,System.Int32,System.Int32,System.Action{System.Int32})"> | ||
2412 | <summary> | ||
2413 | Executes a for loop in which iterations may run in parallel | ||
2414 | </summary> | ||
2415 | <param name="threadCount">The number of concurrent execution threads to run</param> | ||
2416 | <param name="fromInclusive">The loop will be started at this index</param> | ||
2417 | <param name="toExclusive">The loop will be terminated before this index is reached</param> | ||
2418 | <param name="body">Method body to run for each iteration of the loop</param> | ||
2419 | </member> | ||
2420 | <member name="M:OpenMetaverse.Parallel.ForEach``1(System.Collections.Generic.IEnumerable{``0},System.Action{``0})"> | ||
2421 | <summary> | ||
2422 | Executes a foreach loop in which iterations may run in parallel | ||
2423 | </summary> | ||
2424 | <typeparam name="T">Object type that the collection wraps</typeparam> | ||
2425 | <param name="enumerable">An enumerable collection to iterate over</param> | ||
2426 | <param name="body">Method body to run for each object in the collection</param> | ||
2427 | </member> | ||
2428 | <member name="M:OpenMetaverse.Parallel.ForEach``1(System.Int32,System.Collections.Generic.IEnumerable{``0},System.Action{``0})"> | ||
2429 | <summary> | ||
2430 | Executes a foreach loop in which iterations may run in parallel | ||
2431 | </summary> | ||
2432 | <typeparam name="T">Object type that the collection wraps</typeparam> | ||
2433 | <param name="threadCount">The number of concurrent execution threads to run</param> | ||
2434 | <param name="enumerable">An enumerable collection to iterate over</param> | ||
2435 | <param name="body">Method body to run for each object in the collection</param> | ||
2436 | </member> | ||
2437 | <member name="M:OpenMetaverse.Parallel.Invoke(System.Action[])"> | ||
2438 | <summary> | ||
2439 | Executes a series of tasks in parallel | ||
2440 | </summary> | ||
2441 | <param name="actions">A series of method bodies to execute</param> | ||
2442 | </member> | ||
2443 | <member name="M:OpenMetaverse.Parallel.Invoke(System.Int32,System.Action[])"> | ||
2444 | <summary> | ||
2445 | Executes a series of tasks in parallel | ||
2446 | </summary> | ||
2447 | <param name="threadCount">The number of concurrent execution threads to run</param> | ||
2448 | <param name="actions">A series of method bodies to execute</param> | ||
2449 | </member> | ||
2450 | <member name="T:OpenMetaverse.TokenBucket"> | ||
2451 | <summary> | ||
2452 | A hierarchical token bucket for bandwidth throttling. See | ||
2453 | http://en.wikipedia.org/wiki/Token_bucket for more information | ||
2454 | </summary> | ||
2455 | </member> | ||
2456 | <member name="F:OpenMetaverse.TokenBucket.parent"> | ||
2457 | <summary>Parent bucket to this bucket, or null if this is a root | ||
2458 | bucket</summary> | ||
2459 | </member> | ||
2460 | <member name="F:OpenMetaverse.TokenBucket.maxBurst"> | ||
2461 | <summary>Size of the bucket in bytes. If zero, the bucket has | ||
2462 | infinite capacity</summary> | ||
2463 | </member> | ||
2464 | <member name="F:OpenMetaverse.TokenBucket.tokensPerMS"> | ||
2465 | <summary>Rate that the bucket fills, in bytes per millisecond. If | ||
2466 | zero, the bucket always remains full</summary> | ||
2467 | </member> | ||
2468 | <member name="F:OpenMetaverse.TokenBucket.content"> | ||
2469 | <summary>Number of tokens currently in the bucket</summary> | ||
2470 | </member> | ||
2471 | <member name="F:OpenMetaverse.TokenBucket.lastDrip"> | ||
2472 | <summary>Time of the last drip, in system ticks</summary> | ||
2473 | </member> | ||
2474 | <member name="M:OpenMetaverse.TokenBucket.#ctor(OpenMetaverse.TokenBucket,System.Int32,System.Int32)"> | ||
2475 | <summary> | ||
2476 | Default constructor | ||
2477 | </summary> | ||
2478 | <param name="parent">Parent bucket if this is a child bucket, or | ||
2479 | null if this is a root bucket</param> | ||
2480 | <param name="maxBurst">Maximum size of the bucket in bytes, or | ||
2481 | zero if this bucket has no maximum capacity</param> | ||
2482 | <param name="dripRate">Rate that the bucket fills, in bytes per | ||
2483 | second. If zero, the bucket always remains full</param> | ||
2484 | </member> | ||
2485 | <member name="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32)"> | ||
2486 | <summary> | ||
2487 | Remove a given number of tokens from the bucket | ||
2488 | </summary> | ||
2489 | <param name="amount">Number of tokens to remove from the bucket</param> | ||
2490 | <returns>True if the requested number of tokens were removed from | ||
2491 | the bucket, otherwise false</returns> | ||
2492 | </member> | ||
2493 | <member name="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32,System.Boolean@)"> | ||
2494 | <summary> | ||
2495 | Remove a given number of tokens from the bucket | ||
2496 | </summary> | ||
2497 | <param name="amount">Number of tokens to remove from the bucket</param> | ||
2498 | <param name="dripSucceeded">True if tokens were added to the bucket | ||
2499 | during this call, otherwise false</param> | ||
2500 | <returns>True if the requested number of tokens were removed from | ||
2501 | the bucket, otherwise false</returns> | ||
2502 | </member> | ||
2503 | <member name="M:OpenMetaverse.TokenBucket.Drip"> | ||
2504 | <summary> | ||
2505 | Add tokens to the bucket over time. The number of tokens added each | ||
2506 | call depends on the length of time that has passed since the last | ||
2507 | call to Drip | ||
2508 | </summary> | ||
2509 | <returns>True if tokens were added to the bucket, otherwise false</returns> | ||
2510 | </member> | ||
2511 | <member name="P:OpenMetaverse.TokenBucket.Parent"> | ||
2512 | <summary> | ||
2513 | The parent bucket of this bucket, or null if this bucket has no | ||
2514 | parent. The parent bucket will limit the aggregate bandwidth of all | ||
2515 | of its children buckets | ||
2516 | </summary> | ||
2517 | </member> | ||
2518 | <member name="P:OpenMetaverse.TokenBucket.MaxBurst"> | ||
2519 | <summary> | ||
2520 | Maximum burst rate in bytes per second. This is the maximum number | ||
2521 | of tokens that can accumulate in the bucket at any one time | ||
2522 | </summary> | ||
2523 | </member> | ||
2524 | <member name="P:OpenMetaverse.TokenBucket.DripRate"> | ||
2525 | <summary> | ||
2526 | The speed limit of this bucket in bytes per second. This is the | ||
2527 | number of tokens that are added to the bucket per second | ||
2528 | </summary> | ||
2529 | <remarks>Tokens are added to the bucket any time | ||
2530 | <seealso cref="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32)"/> is called, at the granularity of | ||
2531 | the system tick interval (typically around 15-22ms)</remarks> | ||
2532 | </member> | ||
2533 | <member name="P:OpenMetaverse.TokenBucket.Content"> | ||
2534 | <summary> | ||
2535 | The number of bytes that can be sent at this moment. This is the | ||
2536 | current number of tokens in the bucket | ||
2537 | <remarks>If this bucket has a parent bucket that does not have | ||
2538 | enough tokens for a request, <seealso cref="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32)"/> will | ||
2539 | return false regardless of the content of this bucket</remarks> | ||
2540 | </summary> | ||
2541 | </member> | ||
2542 | <member name="T:OpenMetaverse.LocklessQueue`1"> | ||
2543 | <summary> | ||
2544 | A thread-safe lockless queue that supports multiple readers and | ||
2545 | multiple writers | ||
2546 | </summary> | ||
2547 | </member> | ||
2548 | <member name="F:OpenMetaverse.LocklessQueue`1.head"> | ||
2549 | <summary>Queue head</summary> | ||
2550 | </member> | ||
2551 | <member name="F:OpenMetaverse.LocklessQueue`1.tail"> | ||
2552 | <summary>Queue tail</summary> | ||
2553 | </member> | ||
2554 | <member name="F:OpenMetaverse.LocklessQueue`1.count"> | ||
2555 | <summary>Queue item count</summary> | ||
2556 | </member> | ||
2557 | <member name="M:OpenMetaverse.LocklessQueue`1.#ctor"> | ||
2558 | <summary> | ||
2559 | Constructor | ||
2560 | </summary> | ||
2561 | </member> | ||
2562 | <member name="M:OpenMetaverse.LocklessQueue`1.Enqueue(`0)"> | ||
2563 | <summary> | ||
2564 | Enqueue an item | ||
2565 | </summary> | ||
2566 | <param name="item">Item to enqeue</param> | ||
2567 | </member> | ||
2568 | <member name="M:OpenMetaverse.LocklessQueue`1.TryDequeue(`0@)"> | ||
2569 | <summary> | ||
2570 | Try to dequeue an item | ||
2571 | </summary> | ||
2572 | <param name="item">Dequeued item if the dequeue was successful</param> | ||
2573 | <returns>True if an item was successfully deqeued, otherwise false</returns> | ||
2574 | </member> | ||
2575 | <member name="P:OpenMetaverse.LocklessQueue`1.Count"> | ||
2576 | <summary>Gets the current number of items in the queue. Since this | ||
2577 | is a lockless collection this value should be treated as a close | ||
2578 | estimate</summary> | ||
2579 | </member> | ||
2580 | <member name="T:OpenMetaverse.LocklessQueue`1.SingleLinkNode"> | ||
2581 | <summary> | ||
2582 | Provides a node container for data in a singly linked list | ||
2583 | </summary> | ||
2584 | </member> | 2588 | </member> |
2585 | <member name="F:OpenMetaverse.LocklessQueue`1.SingleLinkNode.Next"> | 2589 | <member name="F:OpenMetaverse.Vector2.Zero"> |
2586 | <summary>Pointer to the next node in list</summary> | 2590 | <summary>A vector with a value of 0,0</summary> |
2587 | </member> | 2591 | </member> |
2588 | <member name="F:OpenMetaverse.LocklessQueue`1.SingleLinkNode.Item"> | 2592 | <member name="F:OpenMetaverse.Vector2.One"> |
2589 | <summary>The data contained by the node</summary> | 2593 | <summary>A vector with a value of 1,1</summary> |
2590 | </member> | 2594 | </member> |
2591 | <member name="M:OpenMetaverse.LocklessQueue`1.SingleLinkNode.#ctor"> | 2595 | <member name="F:OpenMetaverse.Vector2.UnitX"> |
2592 | <summary> | 2596 | <summary>A vector with a value of 1,0</summary> |
2593 | Constructor | ||
2594 | </summary> | ||
2595 | </member> | 2597 | </member> |
2596 | <member name="M:OpenMetaverse.LocklessQueue`1.SingleLinkNode.#ctor(`0)"> | 2598 | <member name="F:OpenMetaverse.Vector2.UnitY"> |
2597 | <summary> | 2599 | <summary>A vector with a value of 0,1</summary> |
2598 | Constructor | ||
2599 | </summary> | ||
2600 | </member> | 2600 | </member> |
2601 | </members> | 2601 | </members> |
2602 | </doc> | 2602 | </doc> |