diff options
Diffstat (limited to '')
-rw-r--r-- | bin/OpenMetaverseTypes.XML | 1186 |
1 files changed, 619 insertions, 567 deletions
diff --git a/bin/OpenMetaverseTypes.XML b/bin/OpenMetaverseTypes.XML index befc8d4..7d00b1b 100644 --- a/bin/OpenMetaverseTypes.XML +++ b/bin/OpenMetaverseTypes.XML | |||
@@ -4,114 +4,65 @@ | |||
4 | <name>OpenMetaverseTypes</name> | 4 | <name>OpenMetaverseTypes</name> |
5 | </assembly> | 5 | </assembly> |
6 | <members> | 6 | <members> |
7 | <member name="T:OpenMetaverse.Vector3d"> | 7 | <member name="T:OpenMetaverse.LocklessQueue`1"> |
8 | <summary> | 8 | <summary> |
9 | A three-dimensional vector with doubleing-point values | 9 | A thread-safe lockless queue that supports multiple readers and |
10 | multiple writers | ||
10 | </summary> | 11 | </summary> |
11 | </member> | 12 | </member> |
12 | <member name="F:OpenMetaverse.Vector3d.X"> | 13 | <member name="F:OpenMetaverse.LocklessQueue`1.head"> |
13 | <summary>X value</summary> | 14 | <summary>Queue head</summary> |
14 | </member> | ||
15 | <member name="F:OpenMetaverse.Vector3d.Y"> | ||
16 | <summary>Y value</summary> | ||
17 | </member> | ||
18 | <member name="F:OpenMetaverse.Vector3d.Z"> | ||
19 | <summary>Z value</summary> | ||
20 | </member> | 15 | </member> |
21 | <member name="M:OpenMetaverse.Vector3d.#ctor(System.Byte[],System.Int32)"> | 16 | <member name="F:OpenMetaverse.LocklessQueue`1.tail"> |
22 | <summary> | 17 | <summary>Queue tail</summary> |
23 | Constructor, builds a vector from a byte array | ||
24 | </summary> | ||
25 | <param name="byteArray">Byte array containing three eight-byte doubles</param> | ||
26 | <param name="pos">Beginning position in the byte array</param> | ||
27 | </member> | 18 | </member> |
28 | <member name="M:OpenMetaverse.Vector3d.ApproxEquals(OpenMetaverse.Vector3d,System.Double)"> | 19 | <member name="F:OpenMetaverse.LocklessQueue`1.count"> |
29 | <summary> | 20 | <summary>Queue item count</summary> |
30 | Test if this vector is equal to another vector, within a given | ||
31 | tolerance range | ||
32 | </summary> | ||
33 | <param name="vec">Vector to test against</param> | ||
34 | <param name="tolerance">The acceptable magnitude of difference | ||
35 | between the two vectors</param> | ||
36 | <returns>True if the magnitude of difference between the two vectors | ||
37 | is less than the given tolerance, otherwise false</returns> | ||
38 | </member> | 21 | </member> |
39 | <member name="M:OpenMetaverse.Vector3d.CompareTo(OpenMetaverse.Vector3d)"> | 22 | <member name="M:OpenMetaverse.LocklessQueue`1.#ctor"> |
40 | <summary> | 23 | <summary> |
41 | IComparable.CompareTo implementation | 24 | Constructor |
42 | </summary> | 25 | </summary> |
43 | </member> | 26 | </member> |
44 | <member name="M:OpenMetaverse.Vector3d.IsFinite"> | 27 | <member name="M:OpenMetaverse.LocklessQueue`1.Enqueue(`0)"> |
45 | <summary> | 28 | <summary> |
46 | Test if this vector is composed of all finite numbers | 29 | Enqueue an item |
47 | </summary> | 30 | </summary> |
31 | <param name="item">Item to enqeue</param> | ||
48 | </member> | 32 | </member> |
49 | <member name="M:OpenMetaverse.Vector3d.FromBytes(System.Byte[],System.Int32)"> | 33 | <member name="M:OpenMetaverse.LocklessQueue`1.TryDequeue(`0@)"> |
50 | <summary> | 34 | <summary> |
51 | Builds a vector from a byte array | 35 | Try to dequeue an item |
52 | </summary> | 36 | </summary> |
53 | <param name="byteArray">Byte array containing a 24 byte vector</param> | 37 | <param name="item">Dequeued item if the dequeue was successful</param> |
54 | <param name="pos">Beginning position in the byte array</param> | 38 | <returns>True if an item was successfully deqeued, otherwise false</returns> |
55 | </member> | 39 | </member> |
56 | <member name="M:OpenMetaverse.Vector3d.GetBytes"> | 40 | <member name="P:OpenMetaverse.LocklessQueue`1.Count"> |
57 | <summary> | 41 | <summary>Gets the current number of items in the queue. Since this |
58 | Returns the raw bytes for this vector | 42 | is a lockless collection this value should be treated as a close |
59 | </summary> | 43 | estimate</summary> |
60 | <returns>A 24 byte array containing X, Y, and Z</returns> | ||
61 | </member> | 44 | </member> |
62 | <member name="M:OpenMetaverse.Vector3d.ToBytes(System.Byte[],System.Int32)"> | 45 | <member name="T:OpenMetaverse.LocklessQueue`1.SingleLinkNode"> |
63 | <summary> | 46 | <summary> |
64 | Writes the raw bytes for this vector to a byte array | 47 | Provides a node container for data in a singly linked list |
65 | </summary> | 48 | </summary> |
66 | <param name="dest">Destination byte array</param> | ||
67 | <param name="pos">Position in the destination array to start | ||
68 | writing. Must be at least 24 bytes before the end of the array</param> | ||
69 | </member> | 49 | </member> |
70 | <member name="M:OpenMetaverse.Vector3d.Parse(System.String)"> | 50 | <member name="F:OpenMetaverse.LocklessQueue`1.SingleLinkNode.Next"> |
71 | <summary> | 51 | <summary>Pointer to the next node in list</summary> |
72 | Parse a vector from a string | ||
73 | </summary> | ||
74 | <param name="val">A string representation of a 3D vector, enclosed | ||
75 | in arrow brackets and separated by commas</param> | ||
76 | </member> | ||
77 | <member name="M:OpenMetaverse.Vector3d.SmoothStep(OpenMetaverse.Vector3d,OpenMetaverse.Vector3d,System.Double)"> | ||
78 | <summary> | ||
79 | Interpolates between two vectors using a cubic equation | ||
80 | </summary> | ||
81 | </member> | 52 | </member> |
82 | <member name="M:OpenMetaverse.Vector3d.ToString"> | 53 | <member name="F:OpenMetaverse.LocklessQueue`1.SingleLinkNode.Item"> |
83 | <summary> | 54 | <summary>The data contained by the node</summary> |
84 | Get a formatted string representation of the vector | ||
85 | </summary> | ||
86 | <returns>A string representation of the vector</returns> | ||
87 | </member> | 55 | </member> |
88 | <member name="M:OpenMetaverse.Vector3d.ToRawString"> | 56 | <member name="M:OpenMetaverse.LocklessQueue`1.SingleLinkNode.#ctor"> |
89 | <summary> | 57 | <summary> |
90 | Get a string representation of the vector elements with up to three | 58 | Constructor |
91 | decimal digits and separated by spaces only | ||
92 | </summary> | 59 | </summary> |
93 | <returns>Raw string representation of the vector</returns> | ||
94 | </member> | 60 | </member> |
95 | <member name="M:OpenMetaverse.Vector3d.op_Modulus(OpenMetaverse.Vector3d,OpenMetaverse.Vector3d)"> | 61 | <member name="M:OpenMetaverse.LocklessQueue`1.SingleLinkNode.#ctor(`0)"> |
96 | <summary> | 62 | <summary> |
97 | Cross product between two vectors | 63 | Constructor |
98 | </summary> | 64 | </summary> |
99 | </member> | 65 | </member> |
100 | <member name="F:OpenMetaverse.Vector3d.Zero"> | ||
101 | <summary>A vector with a value of 0,0,0</summary> | ||
102 | </member> | ||
103 | <member name="F:OpenMetaverse.Vector3d.One"> | ||
104 | <summary>A vector with a value of 1,1,1</summary> | ||
105 | </member> | ||
106 | <member name="F:OpenMetaverse.Vector3d.UnitX"> | ||
107 | <summary>A unit vector facing forward (X axis), value of 1,0,0</summary> | ||
108 | </member> | ||
109 | <member name="F:OpenMetaverse.Vector3d.UnitY"> | ||
110 | <summary>A unit vector facing left (Y axis), value of 0,1,0</summary> | ||
111 | </member> | ||
112 | <member name="F:OpenMetaverse.Vector3d.UnitZ"> | ||
113 | <summary>A unit vector facing up (Z axis), value of 0,0,1</summary> | ||
114 | </member> | ||
115 | <member name="T:OpenMetaverse.EnumInfoAttribute"> | 66 | <member name="T:OpenMetaverse.EnumInfoAttribute"> |
116 | <summary> | 67 | <summary> |
117 | Attribute class that allows extra attributes to be attached to ENUMs | 68 | Attribute class that allows extra attributes to be attached to ENUMs |
@@ -235,6 +186,15 @@ | |||
235 | <member name="F:OpenMetaverse.AssetType.Mesh"> | 186 | <member name="F:OpenMetaverse.AssetType.Mesh"> |
236 | <summary>Linden mesh format</summary> | 187 | <summary>Linden mesh format</summary> |
237 | </member> | 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> | ||
238 | <member name="T:OpenMetaverse.InventoryType"> | 198 | <member name="T:OpenMetaverse.InventoryType"> |
239 | <summary> | 199 | <summary> |
240 | Inventory Item Types, eg Script, Notecard, Folder, etc | 200 | Inventory Item Types, eg Script, Notecard, Folder, etc |
@@ -355,160 +315,12 @@ | |||
355 | <member name="F:OpenMetaverse.WearableType.Tattoo"> | 315 | <member name="F:OpenMetaverse.WearableType.Tattoo"> |
356 | <summary>Tattoo</summary> | 316 | <summary>Tattoo</summary> |
357 | </member> | 317 | </member> |
318 | <member name="F:OpenMetaverse.WearableType.Physics"> | ||
319 | <summary>Physics</summary> | ||
320 | </member> | ||
358 | <member name="F:OpenMetaverse.WearableType.Invalid"> | 321 | <member name="F:OpenMetaverse.WearableType.Invalid"> |
359 | <summary>Invalid wearable asset</summary> | 322 | <summary>Invalid wearable asset</summary> |
360 | </member> | 323 | </member> |
361 | <member name="T:OpenMetaverse.TokenBucket"> | ||
362 | <summary> | ||
363 | A hierarchical token bucket for bandwidth throttling. See | ||
364 | http://en.wikipedia.org/wiki/Token_bucket for more information | ||
365 | </summary> | ||
366 | </member> | ||
367 | <member name="F:OpenMetaverse.TokenBucket.parent"> | ||
368 | <summary>Parent bucket to this bucket, or null if this is a root | ||
369 | bucket</summary> | ||
370 | </member> | ||
371 | <member name="F:OpenMetaverse.TokenBucket.maxBurst"> | ||
372 | <summary>Size of the bucket in bytes. If zero, the bucket has | ||
373 | infinite capacity</summary> | ||
374 | </member> | ||
375 | <member name="F:OpenMetaverse.TokenBucket.tokensPerMS"> | ||
376 | <summary>Rate that the bucket fills, in bytes per millisecond. If | ||
377 | zero, the bucket always remains full</summary> | ||
378 | </member> | ||
379 | <member name="F:OpenMetaverse.TokenBucket.content"> | ||
380 | <summary>Number of tokens currently in the bucket</summary> | ||
381 | </member> | ||
382 | <member name="F:OpenMetaverse.TokenBucket.lastDrip"> | ||
383 | <summary>Time of the last drip, in system ticks</summary> | ||
384 | </member> | ||
385 | <member name="M:OpenMetaverse.TokenBucket.#ctor(OpenMetaverse.TokenBucket,System.Int32,System.Int32)"> | ||
386 | <summary> | ||
387 | Default constructor | ||
388 | </summary> | ||
389 | <param name="parent">Parent bucket if this is a child bucket, or | ||
390 | null if this is a root bucket</param> | ||
391 | <param name="maxBurst">Maximum size of the bucket in bytes, or | ||
392 | zero if this bucket has no maximum capacity</param> | ||
393 | <param name="dripRate">Rate that the bucket fills, in bytes per | ||
394 | second. If zero, the bucket always remains full</param> | ||
395 | </member> | ||
396 | <member name="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32)"> | ||
397 | <summary> | ||
398 | Remove a given number of tokens from the bucket | ||
399 | </summary> | ||
400 | <param name="amount">Number of tokens to remove from the bucket</param> | ||
401 | <returns>True if the requested number of tokens were removed from | ||
402 | the bucket, otherwise false</returns> | ||
403 | </member> | ||
404 | <member name="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32,System.Boolean@)"> | ||
405 | <summary> | ||
406 | Remove a given number of tokens from the bucket | ||
407 | </summary> | ||
408 | <param name="amount">Number of tokens to remove from the bucket</param> | ||
409 | <param name="dripSucceeded">True if tokens were added to the bucket | ||
410 | during this call, otherwise false</param> | ||
411 | <returns>True if the requested number of tokens were removed from | ||
412 | the bucket, otherwise false</returns> | ||
413 | </member> | ||
414 | <member name="M:OpenMetaverse.TokenBucket.Drip"> | ||
415 | <summary> | ||
416 | Add tokens to the bucket over time. The number of tokens added each | ||
417 | call depends on the length of time that has passed since the last | ||
418 | call to Drip | ||
419 | </summary> | ||
420 | <returns>True if tokens were added to the bucket, otherwise false</returns> | ||
421 | </member> | ||
422 | <member name="P:OpenMetaverse.TokenBucket.Parent"> | ||
423 | <summary> | ||
424 | The parent bucket of this bucket, or null if this bucket has no | ||
425 | parent. The parent bucket will limit the aggregate bandwidth of all | ||
426 | of its children buckets | ||
427 | </summary> | ||
428 | </member> | ||
429 | <member name="P:OpenMetaverse.TokenBucket.MaxBurst"> | ||
430 | <summary> | ||
431 | Maximum burst rate in bytes per second. This is the maximum number | ||
432 | of tokens that can accumulate in the bucket at any one time | ||
433 | </summary> | ||
434 | </member> | ||
435 | <member name="P:OpenMetaverse.TokenBucket.DripRate"> | ||
436 | <summary> | ||
437 | The speed limit of this bucket in bytes per second. This is the | ||
438 | number of tokens that are added to the bucket per second | ||
439 | </summary> | ||
440 | <remarks>Tokens are added to the bucket any time | ||
441 | <seealso cref="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32)"/> is called, at the granularity of | ||
442 | the system tick interval (typically around 15-22ms)</remarks> | ||
443 | </member> | ||
444 | <member name="P:OpenMetaverse.TokenBucket.Content"> | ||
445 | <summary> | ||
446 | The number of bytes that can be sent at this moment. This is the | ||
447 | current number of tokens in the bucket | ||
448 | <remarks>If this bucket has a parent bucket that does not have | ||
449 | enough tokens for a request, <seealso cref="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32)"/> will | ||
450 | return false regardless of the content of this bucket</remarks> | ||
451 | </summary> | ||
452 | </member> | ||
453 | <member name="T:OpenMetaverse.LocklessQueue`1"> | ||
454 | <summary> | ||
455 | A thread-safe lockless queue that supports multiple readers and | ||
456 | multiple writers | ||
457 | </summary> | ||
458 | </member> | ||
459 | <member name="F:OpenMetaverse.LocklessQueue`1.head"> | ||
460 | <summary>Queue head</summary> | ||
461 | </member> | ||
462 | <member name="F:OpenMetaverse.LocklessQueue`1.tail"> | ||
463 | <summary>Queue tail</summary> | ||
464 | </member> | ||
465 | <member name="F:OpenMetaverse.LocklessQueue`1.count"> | ||
466 | <summary>Queue item count</summary> | ||
467 | </member> | ||
468 | <member name="M:OpenMetaverse.LocklessQueue`1.#ctor"> | ||
469 | <summary> | ||
470 | Constructor | ||
471 | </summary> | ||
472 | </member> | ||
473 | <member name="M:OpenMetaverse.LocklessQueue`1.Enqueue(`0)"> | ||
474 | <summary> | ||
475 | Enqueue an item | ||
476 | </summary> | ||
477 | <param name="item">Item to enqeue</param> | ||
478 | </member> | ||
479 | <member name="M:OpenMetaverse.LocklessQueue`1.TryDequeue(`0@)"> | ||
480 | <summary> | ||
481 | Try to dequeue an item | ||
482 | </summary> | ||
483 | <param name="item">Dequeued item if the dequeue was successful</param> | ||
484 | <returns>True if an item was successfully deqeued, otherwise false</returns> | ||
485 | </member> | ||
486 | <member name="P:OpenMetaverse.LocklessQueue`1.Count"> | ||
487 | <summary>Gets the current number of items in the queue. Since this | ||
488 | is a lockless collection this value should be treated as a close | ||
489 | estimate</summary> | ||
490 | </member> | ||
491 | <member name="T:OpenMetaverse.LocklessQueue`1.SingleLinkNode"> | ||
492 | <summary> | ||
493 | Provides a node container for data in a singly linked list | ||
494 | </summary> | ||
495 | </member> | ||
496 | <member name="F:OpenMetaverse.LocklessQueue`1.SingleLinkNode.Next"> | ||
497 | <summary>Pointer to the next node in list</summary> | ||
498 | </member> | ||
499 | <member name="F:OpenMetaverse.LocklessQueue`1.SingleLinkNode.Item"> | ||
500 | <summary>The data contained by the node</summary> | ||
501 | </member> | ||
502 | <member name="M:OpenMetaverse.LocklessQueue`1.SingleLinkNode.#ctor"> | ||
503 | <summary> | ||
504 | Constructor | ||
505 | </summary> | ||
506 | </member> | ||
507 | <member name="M:OpenMetaverse.LocklessQueue`1.SingleLinkNode.#ctor(`0)"> | ||
508 | <summary> | ||
509 | Constructor | ||
510 | </summary> | ||
511 | </member> | ||
512 | <member name="T:OpenMetaverse.Color4"> | 324 | <member name="T:OpenMetaverse.Color4"> |
513 | <summary> | 325 | <summary> |
514 | An 8-bit color structure including an alpha channel | 326 | An 8-bit color structure including an alpha channel |
@@ -642,6 +454,121 @@ | |||
642 | <member name="F:OpenMetaverse.Color4.White"> | 454 | <member name="F:OpenMetaverse.Color4.White"> |
643 | <summary>A Color4 with full RGB values (1.0) and fully opaque (alpha 1.0)</summary> | 455 | <summary>A Color4 with full RGB values (1.0) and fully opaque (alpha 1.0)</summary> |
644 | </member> | 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> | ||
645 | <member name="M:OpenMetaverse.ReaderWriterLockSlim.ExitAndWakeUpAppropriateWaiters"> | 572 | <member name="M:OpenMetaverse.ReaderWriterLockSlim.ExitAndWakeUpAppropriateWaiters"> |
646 | <summary> | 573 | <summary> |
647 | Determines the appropriate events to set, leaves the locks, and sets the events. | 574 | Determines the appropriate events to set, leaves the locks, and sets the events. |
@@ -661,193 +588,218 @@ | |||
661 | Before the wait 'numWaiters' is incremented and is restored before leaving this routine. | 588 | Before the wait 'numWaiters' is incremented and is restored before leaving this routine. |
662 | </summary> | 589 | </summary> |
663 | </member> | 590 | </member> |
664 | <member name="M:OpenMetaverse.CircularQueue`1.#ctor(OpenMetaverse.CircularQueue{`0})"> | 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)"> | ||
665 | <summary> | 604 | <summary> |
666 | Copy constructor | 605 | Build a quaternion from normalized float values |
667 | </summary> | 606 | </summary> |
668 | <param name="queue">Circular queue to copy</param> | 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> | ||
669 | </member> | 610 | </member> |
670 | <member name="T:OpenMetaverse.UUID"> | 611 | <member name="M:OpenMetaverse.Quaternion.#ctor(System.Byte[],System.Int32,System.Boolean)"> |
671 | <summary> | 612 | <summary> |
672 | A 128-bit Universally Unique Identifier, used throughout the Second | 613 | Constructor, builds a quaternion object from a byte array |
673 | Life networking protocol | ||
674 | </summary> | 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> | ||
675 | </member> | 620 | </member> |
676 | <member name="F:OpenMetaverse.UUID.Guid"> | 621 | <member name="M:OpenMetaverse.Quaternion.Normalize"> |
677 | <summary>The System.Guid object this struct wraps around</summary> | 622 | <summary> |
623 | Normalizes the quaternion | ||
624 | </summary> | ||
678 | </member> | 625 | </member> |
679 | <member name="M:OpenMetaverse.UUID.#ctor(System.String)"> | 626 | <member name="M:OpenMetaverse.Quaternion.FromBytes(System.Byte[],System.Int32,System.Boolean)"> |
680 | <summary> | 627 | <summary> |
681 | Constructor that takes a string UUID representation | 628 | Builds a quaternion object from a byte array |
682 | </summary> | 629 | </summary> |
683 | <param name="val">A string representation of a UUID, case | 630 | <param name="byteArray">The source byte array</param> |
684 | insensitive and can either be hyphenated or non-hyphenated</param> | 631 | <param name="pos">Offset in the byte array to start reading at</param> |
685 | <example>UUID("11f8aa9c-b071-4242-836b-13b7abe0d489")</example> | 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> | ||
686 | </member> | 635 | </member> |
687 | <member name="M:OpenMetaverse.UUID.#ctor(System.Guid)"> | 636 | <member name="M:OpenMetaverse.Quaternion.GetBytes"> |
688 | <summary> | 637 | <summary> |
689 | Constructor that takes a System.Guid object | 638 | Normalize this quaternion and serialize it to a byte array |
690 | </summary> | 639 | </summary> |
691 | <param name="val">A Guid object that contains the unique identifier | 640 | <returns>A 12 byte array containing normalized X, Y, and Z floating |
692 | to be represented by this UUID</param> | 641 | point values in order using little endian byte ordering</returns> |
693 | </member> | 642 | </member> |
694 | <member name="M:OpenMetaverse.UUID.#ctor(System.Byte[],System.Int32)"> | 643 | <member name="M:OpenMetaverse.Quaternion.ToBytes(System.Byte[],System.Int32)"> |
695 | <summary> | 644 | <summary> |
696 | Constructor that takes a byte array containing a UUID | 645 | Writes the raw bytes for this quaternion to a byte array |
697 | </summary> | 646 | </summary> |
698 | <param name="source">Byte array containing a 16 byte UUID</param> | 647 | <param name="dest">Destination byte array</param> |
699 | <param name="pos">Beginning offset in the 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> | ||
700 | </member> | 650 | </member> |
701 | <member name="M:OpenMetaverse.UUID.#ctor(System.UInt64)"> | 651 | <member name="M:OpenMetaverse.Quaternion.GetEulerAngles(System.Single@,System.Single@,System.Single@)"> |
702 | <summary> | 652 | <summary> |
703 | Constructor that takes an unsigned 64-bit unsigned integer to | 653 | Convert this quaternion to euler angles |
704 | convert to a UUID | ||
705 | </summary> | 654 | </summary> |
706 | <param name="val">64-bit unsigned integer to convert to a UUID</param> | 655 | <param name="roll">X euler angle</param> |
656 | <param name="pitch">Y euler angle</param> | ||
657 | <param name="yaw">Z euler angle</param> | ||
707 | </member> | 658 | </member> |
708 | <member name="M:OpenMetaverse.UUID.#ctor(OpenMetaverse.UUID)"> | 659 | <member name="M:OpenMetaverse.Quaternion.GetAxisAngle(OpenMetaverse.Vector3@,System.Single@)"> |
709 | <summary> | 660 | <summary> |
710 | Copy constructor | 661 | Convert this quaternion to an angle around an axis |
711 | </summary> | 662 | </summary> |
712 | <param name="val">UUID to copy</param> | 663 | <param name="axis">Unit vector describing the axis</param> |
664 | <param name="angle">Angle around the axis, in radians</param> | ||
713 | </member> | 665 | </member> |
714 | <member name="M:OpenMetaverse.UUID.CompareTo(OpenMetaverse.UUID)"> | 666 | <member name="M:OpenMetaverse.Quaternion.Conjugate(OpenMetaverse.Quaternion)"> |
715 | <summary> | 667 | <summary> |
716 | IComparable.CompareTo implementation | 668 | Returns the conjugate (spatial inverse) of a quaternion |
717 | </summary> | 669 | </summary> |
718 | </member> | 670 | </member> |
719 | <member name="M:OpenMetaverse.UUID.FromBytes(System.Byte[],System.Int32)"> | 671 | <member name="M:OpenMetaverse.Quaternion.CreateFromAxisAngle(System.Single,System.Single,System.Single,System.Single)"> |
720 | <summary> | 672 | <summary> |
721 | Assigns this UUID from 16 bytes out of a byte array | 673 | Build a quaternion from an axis and an angle of rotation around |
674 | that axis | ||
722 | </summary> | 675 | </summary> |
723 | <param name="source">Byte array containing the UUID to assign this UUID to</param> | ||
724 | <param name="pos">Starting position of the UUID in the byte array</param> | ||
725 | </member> | 676 | </member> |
726 | <member name="M:OpenMetaverse.UUID.GetBytes"> | 677 | <member name="M:OpenMetaverse.Quaternion.CreateFromAxisAngle(OpenMetaverse.Vector3,System.Single)"> |
727 | <summary> | 678 | <summary> |
728 | Returns a copy of the raw bytes for this UUID | 679 | Build a quaternion from an axis and an angle of rotation around |
680 | that axis | ||
729 | </summary> | 681 | </summary> |
730 | <returns>A 16 byte array containing this UUID</returns> | 682 | <param name="axis">Axis of rotation</param> |
683 | <param name="angle">Angle of rotation</param> | ||
731 | </member> | 684 | </member> |
732 | <member name="M:OpenMetaverse.UUID.ToBytes(System.Byte[],System.Int32)"> | 685 | <member name="M:OpenMetaverse.Quaternion.CreateFromEulers(OpenMetaverse.Vector3)"> |
733 | <summary> | 686 | <summary> |
734 | Writes the raw bytes for this UUID to a byte array | 687 | Creates a quaternion from a vector containing roll, pitch, and yaw |
688 | in radians | ||
735 | </summary> | 689 | </summary> |
736 | <param name="dest">Destination byte array</param> | 690 | <param name="eulers">Vector representation of the euler angles in |
737 | <param name="pos">Position in the destination array to start | 691 | radians</param> |
738 | writing. Must be at least 16 bytes before the end of the array</param> | 692 | <returns>Quaternion representation of the euler angles</returns> |
739 | </member> | 693 | </member> |
740 | <member name="M:OpenMetaverse.UUID.CRC"> | 694 | <member name="M:OpenMetaverse.Quaternion.CreateFromEulers(System.Single,System.Single,System.Single)"> |
741 | <summary> | 695 | <summary> |
742 | Calculate an LLCRC (cyclic redundancy check) for this UUID | 696 | Creates a quaternion from roll, pitch, and yaw euler angles in |
697 | radians | ||
743 | </summary> | 698 | </summary> |
744 | <returns>The CRC checksum for this UUID</returns> | 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> | ||
745 | </member> | 703 | </member> |
746 | <member name="M:OpenMetaverse.UUID.GetULong"> | 704 | <member name="M:OpenMetaverse.Quaternion.Inverse(OpenMetaverse.Quaternion)"> |
747 | <summary> | 705 | <summary> |
748 | Create a 64-bit integer representation from the second half of this UUID | 706 | Conjugates and renormalizes a vector |
749 | </summary> | 707 | </summary> |
750 | <returns>An integer created from the last eight bytes of this UUID</returns> | ||
751 | </member> | 708 | </member> |
752 | <member name="M:OpenMetaverse.UUID.Parse(System.String)"> | 709 | <member name="M:OpenMetaverse.Quaternion.Slerp(OpenMetaverse.Quaternion,OpenMetaverse.Quaternion,System.Single)"> |
753 | <summary> | 710 | <summary> |
754 | Generate a UUID from a string | 711 | Spherical linear interpolation between two quaternions |
755 | </summary> | 712 | </summary> |
756 | <param name="val">A string representation of a UUID, case | ||
757 | insensitive and can either be hyphenated or non-hyphenated</param> | ||
758 | <example>UUID.Parse("11f8aa9c-b071-4242-836b-13b7abe0d489")</example> | ||
759 | </member> | 713 | </member> |
760 | <member name="M:OpenMetaverse.UUID.TryParse(System.String,OpenMetaverse.UUID@)"> | 714 | <member name="M:OpenMetaverse.Quaternion.ToRawString"> |
761 | <summary> | 715 | <summary> |
762 | Generate a UUID from a string | 716 | Get a string representation of the quaternion elements with up to three |
717 | decimal digits and separated by spaces only | ||
763 | </summary> | 718 | </summary> |
764 | <param name="val">A string representation of a UUID, case | 719 | <returns>Raw string representation of the quaternion</returns> |
765 | insensitive and can either be hyphenated or non-hyphenated</param> | ||
766 | <param name="result">Will contain the parsed UUID if successful, | ||
767 | otherwise null</param> | ||
768 | <returns>True if the string was successfully parse, otherwise false</returns> | ||
769 | <example>UUID.TryParse("11f8aa9c-b071-4242-836b-13b7abe0d489", result)</example> | ||
770 | </member> | 720 | </member> |
771 | <member name="M:OpenMetaverse.UUID.Combine(OpenMetaverse.UUID,OpenMetaverse.UUID)"> | 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})"> | ||
772 | <summary> | 725 | <summary> |
773 | Combine two UUIDs together by taking the MD5 hash of a byte array | 726 | Copy constructor |
774 | containing both UUIDs | ||
775 | </summary> | 727 | </summary> |
776 | <param name="first">First UUID to combine</param> | 728 | <param name="queue">Circular queue to copy</param> |
777 | <param name="second">Second UUID to combine</param> | ||
778 | <returns>The UUID product of the combination</returns> | ||
779 | </member> | 729 | </member> |
780 | <member name="M:OpenMetaverse.UUID.Random"> | 730 | <member name="T:OpenMetaverse.BlockingQueue`1"> |
781 | <summary> | 731 | <summary> |
782 | 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 | ||
783 | </summary> | 734 | </summary> |
784 | <returns></returns> | ||
785 | </member> | 735 | </member> |
786 | <member name="M:OpenMetaverse.UUID.GetHashCode"> | 736 | <member name="M:OpenMetaverse.BlockingQueue`1.#ctor(System.Collections.Generic.IEnumerable{`0})"> |
787 | <summary> | 737 | <summary> |
788 | Return a hash code for this UUID, used by .NET for hash tables | 738 | Create new BlockingQueue. |
789 | </summary> | 739 | </summary> |
790 | <returns>An integer composed of all the UUID bytes XORed together</returns> | 740 | <param name="col">The System.Collections.ICollection to copy elements from</param> |
791 | </member> | 741 | </member> |
792 | <member name="M:OpenMetaverse.UUID.Equals(System.Object)"> | 742 | <member name="M:OpenMetaverse.BlockingQueue`1.#ctor(System.Int32)"> |
793 | <summary> | 743 | <summary> |
794 | Comparison function | 744 | Create new BlockingQueue. |
795 | </summary> | 745 | </summary> |
796 | <param name="o">An object to compare to this UUID</param> | 746 | <param name="capacity">The initial number of elements that the queue can contain</param> |
797 | <returns>True if the object is a UUID and both UUIDs are equal</returns> | ||
798 | </member> | 747 | </member> |
799 | <member name="M:OpenMetaverse.UUID.Equals(OpenMetaverse.UUID)"> | 748 | <member name="M:OpenMetaverse.BlockingQueue`1.#ctor"> |
800 | <summary> | 749 | <summary> |
801 | Comparison function | 750 | Create new BlockingQueue. |
802 | </summary> | 751 | </summary> |
803 | <param name="uuid">UUID to compare to</param> | ||
804 | <returns>True if the UUIDs are equal, otherwise false</returns> | ||
805 | </member> | 752 | </member> |
806 | <member name="M:OpenMetaverse.UUID.ToString"> | 753 | <member name="M:OpenMetaverse.BlockingQueue`1.Finalize"> |
807 | <summary> | 754 | <summary> |
808 | Get a hyphenated string representation of this UUID | 755 | BlockingQueue Destructor (Close queue, resume any waiting thread). |
809 | </summary> | 756 | </summary> |
810 | <returns>A string representation of this UUID, lowercase and | ||
811 | with hyphens</returns> | ||
812 | <example>11f8aa9c-b071-4242-836b-13b7abe0d489</example> | ||
813 | </member> | 757 | </member> |
814 | <member name="M:OpenMetaverse.UUID.op_Equality(OpenMetaverse.UUID,OpenMetaverse.UUID)"> | 758 | <member name="M:OpenMetaverse.BlockingQueue`1.Clear"> |
815 | <summary> | 759 | <summary> |
816 | Equals operator | 760 | Remove all objects from the Queue. |
817 | </summary> | 761 | </summary> |
818 | <param name="lhs">First UUID for comparison</param> | ||
819 | <param name="rhs">Second UUID for comparison</param> | ||
820 | <returns>True if the UUIDs are byte for byte equal, otherwise false</returns> | ||
821 | </member> | 762 | </member> |
822 | <member name="M:OpenMetaverse.UUID.op_Inequality(OpenMetaverse.UUID,OpenMetaverse.UUID)"> | 763 | <member name="M:OpenMetaverse.BlockingQueue`1.Close"> |
823 | <summary> | 764 | <summary> |
824 | Not equals operator | 765 | Remove all objects from the Queue, resume all dequeue threads. |
825 | </summary> | 766 | </summary> |
826 | <param name="lhs">First UUID for comparison</param> | ||
827 | <param name="rhs">Second UUID for comparison</param> | ||
828 | <returns>True if the UUIDs are not equal, otherwise true</returns> | ||
829 | </member> | 767 | </member> |
830 | <member name="M:OpenMetaverse.UUID.op_ExclusiveOr(OpenMetaverse.UUID,OpenMetaverse.UUID)"> | 768 | <member name="M:OpenMetaverse.BlockingQueue`1.Dequeue"> |
831 | <summary> | 769 | <summary> |
832 | XOR operator | 770 | Removes and returns the object at the beginning of the Queue. |
833 | </summary> | 771 | </summary> |
834 | <param name="lhs">First UUID</param> | 772 | <returns>Object in queue.</returns> |
835 | <param name="rhs">Second UUID</param> | ||
836 | <returns>A UUID that is a XOR combination of the two input UUIDs</returns> | ||
837 | </member> | 773 | </member> |
838 | <member name="M:OpenMetaverse.UUID.op_Explicit(System.String)~OpenMetaverse.UUID"> | 774 | <member name="M:OpenMetaverse.BlockingQueue`1.Dequeue(System.TimeSpan)"> |
839 | <summary> | 775 | <summary> |
840 | String typecasting operator | 776 | Removes and returns the object at the beginning of the Queue. |
841 | </summary> | 777 | </summary> |
842 | <param name="val">A UUID in string form. Case insensitive, | 778 | <param name="timeout">time to wait before returning</param> |
843 | hyphenated or non-hyphenated</param> | 779 | <returns>Object in queue.</returns> |
844 | <returns>A UUID built from the string representation</returns> | ||
845 | </member> | 780 | </member> |
846 | <member name="F:OpenMetaverse.UUID.Zero"> | 781 | <member name="M:OpenMetaverse.BlockingQueue`1.Dequeue(System.Int32)"> |
847 | <summary>An UUID with a value of all zeroes</summary> | 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> | ||
848 | </member> | 787 | </member> |
849 | <member name="F:OpenMetaverse.UUID.ZeroString"> | 788 | <member name="M:OpenMetaverse.BlockingQueue`1.Enqueue(`0)"> |
850 | <summary>A cache of UUID.Zero as a string to optimize a common path</summary> | 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> | ||
851 | </member> | 803 | </member> |
852 | <member name="F:OpenMetaverse.Utils.DEG_TO_RAD"> | 804 | <member name="F:OpenMetaverse.Utils.DEG_TO_RAD"> |
853 | <summary>Used for converting degrees to radians</summary> | 805 | <summary>Used for converting degrees to radians</summary> |
@@ -1450,212 +1402,50 @@ | |||
1450 | <member name="F:OpenMetaverse.Utils.Runtime.Mono"> | 1402 | <member name="F:OpenMetaverse.Utils.Runtime.Mono"> |
1451 | <summary>Mono runtime: http://www.mono-project.com/</summary> | 1403 | <summary>Mono runtime: http://www.mono-project.com/</summary> |
1452 | </member> | 1404 | </member> |
1453 | <member name="F:OpenMetaverse.Quaternion.X"> | 1405 | <member name="F:OpenMetaverse.ExpiringCache`2.syncRoot"> |
1454 | <summary>X value</summary> | 1406 | <summary>For thread safety</summary> |
1455 | </member> | ||
1456 | <member name="F:OpenMetaverse.Quaternion.Y"> | ||
1457 | <summary>Y value</summary> | ||
1458 | </member> | ||
1459 | <member name="F:OpenMetaverse.Quaternion.Z"> | ||
1460 | <summary>Z value</summary> | ||
1461 | </member> | ||
1462 | <member name="F:OpenMetaverse.Quaternion.W"> | ||
1463 | <summary>W value</summary> | ||
1464 | </member> | ||
1465 | <member name="M:OpenMetaverse.Quaternion.#ctor(System.Single,System.Single,System.Single)"> | ||
1466 | <summary> | ||
1467 | Build a quaternion from normalized float values | ||
1468 | </summary> | ||
1469 | <param name="x">X value from -1.0 to 1.0</param> | ||
1470 | <param name="y">Y value from -1.0 to 1.0</param> | ||
1471 | <param name="z">Z value from -1.0 to 1.0</param> | ||
1472 | </member> | ||
1473 | <member name="M:OpenMetaverse.Quaternion.#ctor(System.Byte[],System.Int32,System.Boolean)"> | ||
1474 | <summary> | ||
1475 | Constructor, builds a quaternion object from a byte array | ||
1476 | </summary> | ||
1477 | <param name="byteArray">Byte array containing four four-byte floats</param> | ||
1478 | <param name="pos">Offset in the byte array to start reading at</param> | ||
1479 | <param name="normalized">Whether the source data is normalized or | ||
1480 | not. If this is true 12 bytes will be read, otherwise 16 bytes will | ||
1481 | be read.</param> | ||
1482 | </member> | ||
1483 | <member name="M:OpenMetaverse.Quaternion.Normalize"> | ||
1484 | <summary> | ||
1485 | Normalizes the quaternion | ||
1486 | </summary> | ||
1487 | </member> | ||
1488 | <member name="M:OpenMetaverse.Quaternion.FromBytes(System.Byte[],System.Int32,System.Boolean)"> | ||
1489 | <summary> | ||
1490 | Builds a quaternion object from a byte array | ||
1491 | </summary> | ||
1492 | <param name="byteArray">The source byte array</param> | ||
1493 | <param name="pos">Offset in the byte array to start reading at</param> | ||
1494 | <param name="normalized">Whether the source data is normalized or | ||
1495 | not. If this is true 12 bytes will be read, otherwise 16 bytes will | ||
1496 | be read.</param> | ||
1497 | </member> | 1407 | </member> |
1498 | <member name="M:OpenMetaverse.Quaternion.GetBytes"> | 1408 | <member name="F:OpenMetaverse.ExpiringCache`2.isPurging"> |
1499 | <summary> | 1409 | <summary>For thread safety</summary> |
1500 | Normalize this quaternion and serialize it to a byte array | ||
1501 | </summary> | ||
1502 | <returns>A 12 byte array containing normalized X, Y, and Z floating | ||
1503 | point values in order using little endian byte ordering</returns> | ||
1504 | </member> | 1410 | </member> |
1505 | <member name="M:OpenMetaverse.Quaternion.ToBytes(System.Byte[],System.Int32)"> | 1411 | <member name="M:OpenMetaverse.ExpiringCache`2.PurgeCache(System.Object,System.Timers.ElapsedEventArgs)"> |
1506 | <summary> | 1412 | <summary> |
1507 | Writes the raw bytes for this quaternion to a byte array | 1413 | Purges expired objects from the cache. Called automatically by the purge timer. |
1508 | </summary> | 1414 | </summary> |
1509 | <param name="dest">Destination byte array</param> | ||
1510 | <param name="pos">Position in the destination array to start | ||
1511 | writing. Must be at least 12 bytes before the end of the array</param> | ||
1512 | </member> | 1415 | </member> |
1513 | <member name="M:OpenMetaverse.Quaternion.GetEulerAngles(System.Single@,System.Single@,System.Single@)"> | 1416 | <member name="M:OpenMetaverse.Matrix4.GetEulerAngles(System.Single@,System.Single@,System.Single@)"> |
1514 | <summary> | 1417 | <summary> |
1515 | Convert this quaternion to euler angles | 1418 | Convert this matrix to euler rotations |
1516 | </summary> | 1419 | </summary> |
1517 | <param name="roll">X euler angle</param> | 1420 | <param name="roll">X euler angle</param> |
1518 | <param name="pitch">Y euler angle</param> | 1421 | <param name="pitch">Y euler angle</param> |
1519 | <param name="yaw">Z euler angle</param> | 1422 | <param name="yaw">Z euler angle</param> |
1520 | </member> | 1423 | </member> |
1521 | <member name="M:OpenMetaverse.Quaternion.GetAxisAngle(OpenMetaverse.Vector3@,System.Single@)"> | 1424 | <member name="M:OpenMetaverse.Matrix4.GetQuaternion"> |
1522 | <summary> | ||
1523 | Convert this quaternion to an angle around an axis | ||
1524 | </summary> | ||
1525 | <param name="axis">Unit vector describing the axis</param> | ||
1526 | <param name="angle">Angle around the axis, in radians</param> | ||
1527 | </member> | ||
1528 | <member name="M:OpenMetaverse.Quaternion.Conjugate(OpenMetaverse.Quaternion)"> | ||
1529 | <summary> | ||
1530 | Returns the conjugate (spatial inverse) of a quaternion | ||
1531 | </summary> | ||
1532 | </member> | ||
1533 | <member name="M:OpenMetaverse.Quaternion.CreateFromAxisAngle(System.Single,System.Single,System.Single,System.Single)"> | ||
1534 | <summary> | ||
1535 | Build a quaternion from an axis and an angle of rotation around | ||
1536 | that axis | ||
1537 | </summary> | ||
1538 | </member> | ||
1539 | <member name="M:OpenMetaverse.Quaternion.CreateFromAxisAngle(OpenMetaverse.Vector3,System.Single)"> | ||
1540 | <summary> | ||
1541 | Build a quaternion from an axis and an angle of rotation around | ||
1542 | that axis | ||
1543 | </summary> | ||
1544 | <param name="axis">Axis of rotation</param> | ||
1545 | <param name="angle">Angle of rotation</param> | ||
1546 | </member> | ||
1547 | <member name="M:OpenMetaverse.Quaternion.CreateFromEulers(OpenMetaverse.Vector3)"> | ||
1548 | <summary> | ||
1549 | Creates a quaternion from a vector containing roll, pitch, and yaw | ||
1550 | in radians | ||
1551 | </summary> | ||
1552 | <param name="eulers">Vector representation of the euler angles in | ||
1553 | radians</param> | ||
1554 | <returns>Quaternion representation of the euler angles</returns> | ||
1555 | </member> | ||
1556 | <member name="M:OpenMetaverse.Quaternion.CreateFromEulers(System.Single,System.Single,System.Single)"> | ||
1557 | <summary> | ||
1558 | Creates a quaternion from roll, pitch, and yaw euler angles in | ||
1559 | radians | ||
1560 | </summary> | ||
1561 | <param name="roll">X angle in radians</param> | ||
1562 | <param name="pitch">Y angle in radians</param> | ||
1563 | <param name="yaw">Z angle in radians</param> | ||
1564 | <returns>Quaternion representation of the euler angles</returns> | ||
1565 | </member> | ||
1566 | <member name="M:OpenMetaverse.Quaternion.Inverse(OpenMetaverse.Quaternion)"> | ||
1567 | <summary> | ||
1568 | Conjugates and renormalizes a vector | ||
1569 | </summary> | ||
1570 | </member> | ||
1571 | <member name="M:OpenMetaverse.Quaternion.Slerp(OpenMetaverse.Quaternion,OpenMetaverse.Quaternion,System.Single)"> | ||
1572 | <summary> | ||
1573 | Spherical linear interpolation between two quaternions | ||
1574 | </summary> | ||
1575 | </member> | ||
1576 | <member name="M:OpenMetaverse.Quaternion.ToRawString"> | ||
1577 | <summary> | ||
1578 | Get a string representation of the quaternion elements with up to three | ||
1579 | decimal digits and separated by spaces only | ||
1580 | </summary> | ||
1581 | <returns>Raw string representation of the quaternion</returns> | ||
1582 | </member> | ||
1583 | <member name="F:OpenMetaverse.Quaternion.Identity"> | ||
1584 | <summary>A quaternion with a value of 0,0,0,1</summary> | ||
1585 | </member> | ||
1586 | <member name="T:OpenMetaverse.BlockingQueue`1"> | ||
1587 | <summary> | ||
1588 | Same as Queue except Dequeue function blocks until there is an object to return. | ||
1589 | Note: This class does not need to be synchronized | ||
1590 | </summary> | ||
1591 | </member> | ||
1592 | <member name="M:OpenMetaverse.BlockingQueue`1.#ctor(System.Collections.Generic.IEnumerable{`0})"> | ||
1593 | <summary> | ||
1594 | Create new BlockingQueue. | ||
1595 | </summary> | ||
1596 | <param name="col">The System.Collections.ICollection to copy elements from</param> | ||
1597 | </member> | ||
1598 | <member name="M:OpenMetaverse.BlockingQueue`1.#ctor(System.Int32)"> | ||
1599 | <summary> | ||
1600 | Create new BlockingQueue. | ||
1601 | </summary> | ||
1602 | <param name="capacity">The initial number of elements that the queue can contain</param> | ||
1603 | </member> | ||
1604 | <member name="M:OpenMetaverse.BlockingQueue`1.#ctor"> | ||
1605 | <summary> | ||
1606 | Create new BlockingQueue. | ||
1607 | </summary> | ||
1608 | </member> | ||
1609 | <member name="M:OpenMetaverse.BlockingQueue`1.Finalize"> | ||
1610 | <summary> | ||
1611 | BlockingQueue Destructor (Close queue, resume any waiting thread). | ||
1612 | </summary> | ||
1613 | </member> | ||
1614 | <member name="M:OpenMetaverse.BlockingQueue`1.Clear"> | ||
1615 | <summary> | ||
1616 | Remove all objects from the Queue. | ||
1617 | </summary> | ||
1618 | </member> | ||
1619 | <member name="M:OpenMetaverse.BlockingQueue`1.Close"> | ||
1620 | <summary> | ||
1621 | Remove all objects from the Queue, resume all dequeue threads. | ||
1622 | </summary> | ||
1623 | </member> | ||
1624 | <member name="M:OpenMetaverse.BlockingQueue`1.Dequeue"> | ||
1625 | <summary> | ||
1626 | Removes and returns the object at the beginning of the Queue. | ||
1627 | </summary> | ||
1628 | <returns>Object in queue.</returns> | ||
1629 | </member> | ||
1630 | <member name="M:OpenMetaverse.BlockingQueue`1.Dequeue(System.TimeSpan)"> | ||
1631 | <summary> | 1425 | <summary> |
1632 | Removes and returns the object at the beginning of the Queue. | 1426 | Convert this matrix to a quaternion rotation |
1633 | </summary> | 1427 | </summary> |
1634 | <param name="timeout">time to wait before returning</param> | 1428 | <returns>A quaternion representation of this rotation matrix</returns> |
1635 | <returns>Object in queue.</returns> | ||
1636 | </member> | 1429 | </member> |
1637 | <member name="M:OpenMetaverse.BlockingQueue`1.Dequeue(System.Int32)"> | 1430 | <member name="M:OpenMetaverse.Matrix4.CreateFromEulers(System.Single,System.Single,System.Single)"> |
1638 | <summary> | 1431 | <summary> |
1639 | Removes and returns the object at the beginning of the Queue. | 1432 | Construct a matrix from euler rotation values in radians |
1640 | </summary> | 1433 | </summary> |
1641 | <param name="timeout">time to wait before returning (in milliseconds)</param> | 1434 | <param name="roll">X euler angle in radians</param> |
1642 | <returns>Object in queue.</returns> | 1435 | <param name="pitch">Y euler angle in radians</param> |
1436 | <param name="yaw">Z euler angle in radians</param> | ||
1643 | </member> | 1437 | </member> |
1644 | <member name="M:OpenMetaverse.BlockingQueue`1.Enqueue(`0)"> | 1438 | <member name="M:OpenMetaverse.Matrix4.ToString"> |
1645 | <summary> | 1439 | <summary> |
1646 | Adds an object to the end of the Queue | 1440 | Get a formatted string representation of the vector |
1647 | </summary> | 1441 | </summary> |
1648 | <param name="obj">Object to put in queue</param> | 1442 | <returns>A string representation of the vector</returns> |
1649 | </member> | 1443 | </member> |
1650 | <member name="M:OpenMetaverse.BlockingQueue`1.Open"> | 1444 | <member name="F:OpenMetaverse.Matrix4.Zero"> |
1651 | <summary> | 1445 | <summary>A 4x4 matrix containing all zeroes</summary> |
1652 | Open Queue. | ||
1653 | </summary> | ||
1654 | </member> | 1446 | </member> |
1655 | <member name="P:OpenMetaverse.BlockingQueue`1.Closed"> | 1447 | <member name="F:OpenMetaverse.Matrix4.Identity"> |
1656 | <summary> | 1448 | <summary>A 4x4 identity matrix</summary> |
1657 | Gets flag indicating if queue has been closed. | ||
1658 | </summary> | ||
1659 | </member> | 1449 | </member> |
1660 | <member name="T:OpenMetaverse.Parallel"> | 1450 | <member name="T:OpenMetaverse.Parallel"> |
1661 | <summary> | 1451 | <summary> |
@@ -1709,40 +1499,6 @@ | |||
1709 | <param name="threadCount">The number of concurrent execution threads to run</param> | 1499 | <param name="threadCount">The number of concurrent execution threads to run</param> |
1710 | <param name="actions">A series of method bodies to execute</param> | 1500 | <param name="actions">A series of method bodies to execute</param> |
1711 | </member> | 1501 | </member> |
1712 | <member name="M:OpenMetaverse.Matrix4.GetEulerAngles(System.Single@,System.Single@,System.Single@)"> | ||
1713 | <summary> | ||
1714 | Convert this matrix to euler rotations | ||
1715 | </summary> | ||
1716 | <param name="roll">X euler angle</param> | ||
1717 | <param name="pitch">Y euler angle</param> | ||
1718 | <param name="yaw">Z euler angle</param> | ||
1719 | </member> | ||
1720 | <member name="M:OpenMetaverse.Matrix4.GetQuaternion"> | ||
1721 | <summary> | ||
1722 | Convert this matrix to a quaternion rotation | ||
1723 | </summary> | ||
1724 | <returns>A quaternion representation of this rotation matrix</returns> | ||
1725 | </member> | ||
1726 | <member name="M:OpenMetaverse.Matrix4.CreateFromEulers(System.Single,System.Single,System.Single)"> | ||
1727 | <summary> | ||
1728 | Construct a matrix from euler rotation values in radians | ||
1729 | </summary> | ||
1730 | <param name="roll">X euler angle in radians</param> | ||
1731 | <param name="pitch">Y euler angle in radians</param> | ||
1732 | <param name="yaw">Z euler angle in radians</param> | ||
1733 | </member> | ||
1734 | <member name="M:OpenMetaverse.Matrix4.ToString"> | ||
1735 | <summary> | ||
1736 | Get a formatted string representation of the vector | ||
1737 | </summary> | ||
1738 | <returns>A string representation of the vector</returns> | ||
1739 | </member> | ||
1740 | <member name="F:OpenMetaverse.Matrix4.Zero"> | ||
1741 | <summary>A 4x4 matrix containing all zeroes</summary> | ||
1742 | </member> | ||
1743 | <member name="F:OpenMetaverse.Matrix4.Identity"> | ||
1744 | <summary>A 4x4 identity matrix</summary> | ||
1745 | </member> | ||
1746 | <member name="F:OpenMetaverse.Vector4.X"> | 1502 | <member name="F:OpenMetaverse.Vector4.X"> |
1747 | <summary>X value</summary> | 1503 | <summary>X value</summary> |
1748 | </member> | 1504 | </member> |
@@ -1829,16 +1585,187 @@ | |||
1829 | <member name="F:OpenMetaverse.Vector4.UnitW"> | 1585 | <member name="F:OpenMetaverse.Vector4.UnitW"> |
1830 | <summary>A vector with a value of 0,0,0,1</summary> | 1586 | <summary>A vector with a value of 0,0,0,1</summary> |
1831 | </member> | 1587 | </member> |
1832 | <member name="F:OpenMetaverse.ExpiringCache`2.syncRoot"> | 1588 | <member name="T:OpenMetaverse.UUID"> |
1833 | <summary>For thread safety</summary> | 1589 | <summary> |
1590 | A 128-bit Universally Unique Identifier, used throughout the Second | ||
1591 | Life networking protocol | ||
1592 | </summary> | ||
1834 | </member> | 1593 | </member> |
1835 | <member name="F:OpenMetaverse.ExpiringCache`2.isPurging"> | 1594 | <member name="F:OpenMetaverse.UUID.Guid"> |
1836 | <summary>For thread safety</summary> | 1595 | <summary>The System.Guid object this struct wraps around</summary> |
1837 | </member> | 1596 | </member> |
1838 | <member name="M:OpenMetaverse.ExpiringCache`2.PurgeCache(System.Object,System.Timers.ElapsedEventArgs)"> | 1597 | <member name="M:OpenMetaverse.UUID.#ctor(System.String)"> |
1839 | <summary> | 1598 | <summary> |
1840 | Purges expired objects from the cache. Called automatically by the purge timer. | 1599 | Constructor that takes a string UUID representation |
1841 | </summary> | 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> | ||
1605 | <member name="M:OpenMetaverse.UUID.#ctor(System.Guid)"> | ||
1606 | <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> | ||
1612 | <member name="M:OpenMetaverse.UUID.#ctor(System.Byte[],System.Int32)"> | ||
1613 | <summary> | ||
1614 | Constructor that takes a byte array containing a UUID | ||
1615 | </summary> | ||
1616 | <param name="source">Byte array containing a 16 byte UUID</param> | ||
1617 | <param name="pos">Beginning offset in the array</param> | ||
1618 | </member> | ||
1619 | <member name="M:OpenMetaverse.UUID.#ctor(System.UInt64)"> | ||
1620 | <summary> | ||
1621 | Constructor that takes an unsigned 64-bit unsigned integer to | ||
1622 | convert to a UUID | ||
1623 | </summary> | ||
1624 | <param name="val">64-bit unsigned integer to convert to a UUID</param> | ||
1625 | </member> | ||
1626 | <member name="M:OpenMetaverse.UUID.#ctor(OpenMetaverse.UUID)"> | ||
1627 | <summary> | ||
1628 | Copy constructor | ||
1629 | </summary> | ||
1630 | <param name="val">UUID to copy</param> | ||
1631 | </member> | ||
1632 | <member name="M:OpenMetaverse.UUID.CompareTo(OpenMetaverse.UUID)"> | ||
1633 | <summary> | ||
1634 | IComparable.CompareTo implementation | ||
1635 | </summary> | ||
1636 | </member> | ||
1637 | <member name="M:OpenMetaverse.UUID.FromBytes(System.Byte[],System.Int32)"> | ||
1638 | <summary> | ||
1639 | Assigns this UUID from 16 bytes out of a byte array | ||
1640 | </summary> | ||
1641 | <param name="source">Byte array containing the UUID to assign this UUID to</param> | ||
1642 | <param name="pos">Starting position of the UUID in the byte array</param> | ||
1643 | </member> | ||
1644 | <member name="M:OpenMetaverse.UUID.GetBytes"> | ||
1645 | <summary> | ||
1646 | Returns a copy of the raw bytes for this UUID | ||
1647 | </summary> | ||
1648 | <returns>A 16 byte array containing this UUID</returns> | ||
1649 | </member> | ||
1650 | <member name="M:OpenMetaverse.UUID.ToBytes(System.Byte[],System.Int32)"> | ||
1651 | <summary> | ||
1652 | Writes the raw bytes for this UUID to a byte array | ||
1653 | </summary> | ||
1654 | <param name="dest">Destination byte array</param> | ||
1655 | <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> | ||
1657 | </member> | ||
1658 | <member name="M:OpenMetaverse.UUID.CRC"> | ||
1659 | <summary> | ||
1660 | Calculate an LLCRC (cyclic redundancy check) for this UUID | ||
1661 | </summary> | ||
1662 | <returns>The CRC checksum for this UUID</returns> | ||
1663 | </member> | ||
1664 | <member name="M:OpenMetaverse.UUID.GetULong"> | ||
1665 | <summary> | ||
1666 | Create a 64-bit integer representation from the second half of this UUID | ||
1667 | </summary> | ||
1668 | <returns>An integer created from the last eight bytes of this UUID</returns> | ||
1669 | </member> | ||
1670 | <member name="M:OpenMetaverse.UUID.Parse(System.String)"> | ||
1671 | <summary> | ||
1672 | Generate a UUID from a string | ||
1673 | </summary> | ||
1674 | <param name="val">A string representation of a UUID, case | ||
1675 | insensitive and can either be hyphenated or non-hyphenated</param> | ||
1676 | <example>UUID.Parse("11f8aa9c-b071-4242-836b-13b7abe0d489")</example> | ||
1677 | </member> | ||
1678 | <member name="M:OpenMetaverse.UUID.TryParse(System.String,OpenMetaverse.UUID@)"> | ||
1679 | <summary> | ||
1680 | Generate a UUID from a string | ||
1681 | </summary> | ||
1682 | <param name="val">A string representation of a UUID, case | ||
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> | ||
1689 | <member name="M:OpenMetaverse.UUID.Combine(OpenMetaverse.UUID,OpenMetaverse.UUID)"> | ||
1690 | <summary> | ||
1691 | Combine two UUIDs together by taking the MD5 hash of a byte array | ||
1692 | containing both UUIDs | ||
1693 | </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> | ||
1698 | <member name="M:OpenMetaverse.UUID.Random"> | ||
1699 | <summary> | ||
1700 | |||
1701 | </summary> | ||
1702 | <returns></returns> | ||
1703 | </member> | ||
1704 | <member name="M:OpenMetaverse.UUID.GetHashCode"> | ||
1705 | <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> | ||
1748 | <member name="M:OpenMetaverse.UUID.op_ExclusiveOr(OpenMetaverse.UUID,OpenMetaverse.UUID)"> | ||
1749 | <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> | ||
1756 | <member name="M:OpenMetaverse.UUID.op_Explicit(System.String)~OpenMetaverse.UUID"> | ||
1757 | <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> | ||
1764 | <member name="F:OpenMetaverse.UUID.Zero"> | ||
1765 | <summary>An UUID with a value of all zeroes</summary> | ||
1766 | </member> | ||
1767 | <member name="F:OpenMetaverse.UUID.ZeroString"> | ||
1768 | <summary>A cache of UUID.Zero as a string to optimize a common path</summary> | ||
1842 | </member> | 1769 | </member> |
1843 | <member name="T:OpenMetaverse.Vector3"> | 1770 | <member name="T:OpenMetaverse.Vector3"> |
1844 | <summary> | 1771 | <summary> |
@@ -1940,6 +1867,13 @@ | |||
1940 | Cross product between two vectors | 1867 | Cross product between two vectors |
1941 | </summary> | 1868 | </summary> |
1942 | </member> | 1869 | </member> |
1870 | <member name="M:OpenMetaverse.Vector3.op_Explicit(OpenMetaverse.Vector3d)~OpenMetaverse.Vector3"> | ||
1871 | <summary> | ||
1872 | Explicit casting for Vector3d > Vector3 | ||
1873 | </summary> | ||
1874 | <param name="value"></param> | ||
1875 | <returns></returns> | ||
1876 | </member> | ||
1943 | <member name="F:OpenMetaverse.Vector3.Zero"> | 1877 | <member name="F:OpenMetaverse.Vector3.Zero"> |
1944 | <summary>A vector with a value of 0,0,0</summary> | 1878 | <summary>A vector with a value of 0,0,0</summary> |
1945 | </member> | 1879 | </member> |
@@ -1955,6 +1889,98 @@ | |||
1955 | <member name="F:OpenMetaverse.Vector3.UnitZ"> | 1889 | <member name="F:OpenMetaverse.Vector3.UnitZ"> |
1956 | <summary>A unit vector facing up (Z axis), value 0,0,1</summary> | 1890 | <summary>A unit vector facing up (Z axis), value 0,0,1</summary> |
1957 | </member> | 1891 | </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> | ||
1958 | <member name="T:OpenMetaverse.PCode"> | 1984 | <member name="T:OpenMetaverse.PCode"> |
1959 | <summary> | 1985 | <summary> |
1960 | Identifier code for primitive types | 1986 | Identifier code for primitive types |
@@ -2165,6 +2191,12 @@ | |||
2165 | <member name="F:OpenMetaverse.ExtraParamType.Sculpt"> | 2191 | <member name="F:OpenMetaverse.ExtraParamType.Sculpt"> |
2166 | <summary>Whether this object is a sculpted prim</summary> | 2192 | <summary>Whether this object is a sculpted prim</summary> |
2167 | </member> | 2193 | </member> |
2194 | <member name="F:OpenMetaverse.ExtraParamType.LightImage"> | ||
2195 | <summary>Whether this object is a light image map</summary> | ||
2196 | </member> | ||
2197 | <member name="F:OpenMetaverse.ExtraParamType.Mesh"> | ||
2198 | <summary>Whether this object is a mesh</summary> | ||
2199 | </member> | ||
2168 | <member name="T:OpenMetaverse.JointType"> | 2200 | <member name="T:OpenMetaverse.JointType"> |
2169 | <summary> | 2201 | <summary> |
2170 | 2202 | ||
@@ -2391,6 +2423,12 @@ | |||
2391 | <member name="F:OpenMetaverse.AttachmentPoint.HUDBottomRight"> | 2423 | <member name="F:OpenMetaverse.AttachmentPoint.HUDBottomRight"> |
2392 | <summary>HUD Bottom-right</summary> | 2424 | <summary>HUD Bottom-right</summary> |
2393 | </member> | 2425 | </member> |
2426 | <member name="F:OpenMetaverse.AttachmentPoint.Neck"> | ||
2427 | <summary>Neck</summary> | ||
2428 | </member> | ||
2429 | <member name="F:OpenMetaverse.AttachmentPoint.Root"> | ||
2430 | <summary>Avatar Center</summary> | ||
2431 | </member> | ||
2394 | <member name="T:OpenMetaverse.Tree"> | 2432 | <member name="T:OpenMetaverse.Tree"> |
2395 | <summary> | 2433 | <summary> |
2396 | Tree foliage types | 2434 | Tree foliage types |
@@ -2508,6 +2546,20 @@ | |||
2508 | <member name="F:OpenMetaverse.ClickAction.OpenMedia"> | 2546 | <member name="F:OpenMetaverse.ClickAction.OpenMedia"> |
2509 | <summary>Open parcel media</summary> | 2547 | <summary>Open parcel media</summary> |
2510 | </member> | 2548 | </member> |
2549 | <member name="T:OpenMetaverse.PhysicsShapeType"> | ||
2550 | <summary> | ||
2551 | Type of physics representation used for this prim in the simulator | ||
2552 | </summary> | ||
2553 | </member> | ||
2554 | <member name="F:OpenMetaverse.PhysicsShapeType.Prim"> | ||
2555 | <summary>Use prim physics form this object</summary> | ||
2556 | </member> | ||
2557 | <member name="F:OpenMetaverse.PhysicsShapeType.None"> | ||
2558 | <summary>No physics, prim doesn't collide</summary> | ||
2559 | </member> | ||
2560 | <member name="F:OpenMetaverse.PhysicsShapeType.ConvexHull"> | ||
2561 | <summary>Use convex hull represantion of this prim</summary> | ||
2562 | </member> | ||
2511 | <member name="T:OpenMetaverse.Vector2"> | 2563 | <member name="T:OpenMetaverse.Vector2"> |
2512 | <summary> | 2564 | <summary> |
2513 | A two-dimensional vector with floating-point values | 2565 | A two-dimensional vector with floating-point values |