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