OpenMetaverseTypes.XML 86 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>OpenMetaverseTypes</name>
  5. </assembly>
  6. <members>
  7. <member name="T:OpenMetaverse.Vector3d">
  8. <summary>
  9. A three-dimensional vector with doubleing-point values
  10. </summary>
  11. </member>
  12. <member name="F:OpenMetaverse.Vector3d.X">
  13. <summary>X value</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>
  21. <member name="M:OpenMetaverse.Vector3d.#ctor(System.Byte[],System.Int32)">
  22. <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>
  28. <member name="M:OpenMetaverse.Vector3d.ApproxEquals(OpenMetaverse.Vector3d,System.Double)">
  29. <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>
  39. <member name="M:OpenMetaverse.Vector3d.CompareTo(OpenMetaverse.Vector3d)">
  40. <summary>
  41. IComparable.CompareTo implementation
  42. </summary>
  43. </member>
  44. <member name="M:OpenMetaverse.Vector3d.IsFinite">
  45. <summary>
  46. Test if this vector is composed of all finite numbers
  47. </summary>
  48. </member>
  49. <member name="M:OpenMetaverse.Vector3d.FromBytes(System.Byte[],System.Int32)">
  50. <summary>
  51. Builds a vector from a byte array
  52. </summary>
  53. <param name="byteArray">Byte array containing a 24 byte vector</param>
  54. <param name="pos">Beginning position in the byte array</param>
  55. </member>
  56. <member name="M:OpenMetaverse.Vector3d.GetBytes">
  57. <summary>
  58. Returns the raw bytes for this vector
  59. </summary>
  60. <returns>A 24 byte array containing X, Y, and Z</returns>
  61. </member>
  62. <member name="M:OpenMetaverse.Vector3d.ToBytes(System.Byte[],System.Int32)">
  63. <summary>
  64. Writes the raw bytes for this vector to a byte array
  65. </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>
  70. <member name="M:OpenMetaverse.Vector3d.Parse(System.String)">
  71. <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>
  82. <member name="M:OpenMetaverse.Vector3d.ToString">
  83. <summary>
  84. Get a formatted string representation of the vector
  85. </summary>
  86. <returns>A string representation of the vector</returns>
  87. </member>
  88. <member name="M:OpenMetaverse.Vector3d.ToRawString">
  89. <summary>
  90. Get a string representation of the vector elements with up to three
  91. decimal digits and separated by spaces only
  92. </summary>
  93. <returns>Raw string representation of the vector</returns>
  94. </member>
  95. <member name="M:OpenMetaverse.Vector3d.op_Modulus(OpenMetaverse.Vector3d,OpenMetaverse.Vector3d)">
  96. <summary>
  97. Cross product between two vectors
  98. </summary>
  99. </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.AssetType">
  116. <summary>
  117. The different types of grid assets
  118. </summary>
  119. </member>
  120. <member name="F:OpenMetaverse.AssetType.Unknown">
  121. <summary>Unknown asset type</summary>
  122. </member>
  123. <member name="F:OpenMetaverse.AssetType.Texture">
  124. <summary>Texture asset, stores in JPEG2000 J2C stream format</summary>
  125. </member>
  126. <member name="F:OpenMetaverse.AssetType.Sound">
  127. <summary>Sound asset</summary>
  128. </member>
  129. <member name="F:OpenMetaverse.AssetType.CallingCard">
  130. <summary>Calling card for another avatar</summary>
  131. </member>
  132. <member name="F:OpenMetaverse.AssetType.Landmark">
  133. <summary>Link to a location in world</summary>
  134. </member>
  135. <member name="F:OpenMetaverse.AssetType.Clothing">
  136. <summary>Collection of textures and parameters that can be
  137. worn by an avatar</summary>
  138. </member>
  139. <member name="F:OpenMetaverse.AssetType.Object">
  140. <summary>Primitive that can contain textures, sounds,
  141. scripts and more</summary>
  142. </member>
  143. <member name="F:OpenMetaverse.AssetType.Notecard">
  144. <summary>Notecard asset</summary>
  145. </member>
  146. <member name="F:OpenMetaverse.AssetType.Folder">
  147. <summary>Holds a collection of inventory items</summary>
  148. </member>
  149. <member name="F:OpenMetaverse.AssetType.RootFolder">
  150. <summary>Root inventory folder</summary>
  151. </member>
  152. <member name="F:OpenMetaverse.AssetType.LSLText">
  153. <summary>Linden scripting language script</summary>
  154. </member>
  155. <member name="F:OpenMetaverse.AssetType.LSLBytecode">
  156. <summary>LSO bytecode for a script</summary>
  157. </member>
  158. <member name="F:OpenMetaverse.AssetType.TextureTGA">
  159. <summary>Uncompressed TGA texture</summary>
  160. </member>
  161. <member name="F:OpenMetaverse.AssetType.Bodypart">
  162. <summary>Collection of textures and shape parameters that can
  163. be worn</summary>
  164. </member>
  165. <member name="F:OpenMetaverse.AssetType.TrashFolder">
  166. <summary>Trash folder</summary>
  167. </member>
  168. <member name="F:OpenMetaverse.AssetType.SnapshotFolder">
  169. <summary>Snapshot folder</summary>
  170. </member>
  171. <member name="F:OpenMetaverse.AssetType.LostAndFoundFolder">
  172. <summary>Lost and found folder</summary>
  173. </member>
  174. <member name="F:OpenMetaverse.AssetType.SoundWAV">
  175. <summary>Uncompressed sound</summary>
  176. </member>
  177. <member name="F:OpenMetaverse.AssetType.ImageTGA">
  178. <summary>Uncompressed TGA non-square image, not to be used as a
  179. texture</summary>
  180. </member>
  181. <member name="F:OpenMetaverse.AssetType.ImageJPEG">
  182. <summary>Compressed JPEG non-square image, not to be used as a
  183. texture</summary>
  184. </member>
  185. <member name="F:OpenMetaverse.AssetType.Animation">
  186. <summary>Animation</summary>
  187. </member>
  188. <member name="F:OpenMetaverse.AssetType.Gesture">
  189. <summary>Sequence of animations, sounds, chat, and pauses</summary>
  190. </member>
  191. <member name="F:OpenMetaverse.AssetType.Simstate">
  192. <summary>Simstate file</summary>
  193. </member>
  194. <member name="T:OpenMetaverse.InventoryType">
  195. <summary>
  196. Inventory Item Types, eg Script, Notecard, Folder, etc
  197. </summary>
  198. </member>
  199. <member name="F:OpenMetaverse.InventoryType.Unknown">
  200. <summary>Unknown</summary>
  201. </member>
  202. <member name="F:OpenMetaverse.InventoryType.Texture">
  203. <summary>Texture</summary>
  204. </member>
  205. <member name="F:OpenMetaverse.InventoryType.Sound">
  206. <summary>Sound</summary>
  207. </member>
  208. <member name="F:OpenMetaverse.InventoryType.CallingCard">
  209. <summary>Calling Card</summary>
  210. </member>
  211. <member name="F:OpenMetaverse.InventoryType.Landmark">
  212. <summary>Landmark</summary>
  213. </member>
  214. <member name="F:OpenMetaverse.InventoryType.Notecard">
  215. <summary>Notecard</summary>
  216. </member>
  217. <member name="F:OpenMetaverse.InventoryType.Category">
  218. <summary></summary>
  219. </member>
  220. <member name="F:OpenMetaverse.InventoryType.Folder">
  221. <summary>Folder</summary>
  222. </member>
  223. <member name="F:OpenMetaverse.InventoryType.RootCategory">
  224. <summary></summary>
  225. </member>
  226. <member name="F:OpenMetaverse.InventoryType.LSL">
  227. <summary>an LSL Script</summary>
  228. </member>
  229. <member name="F:OpenMetaverse.InventoryType.Snapshot">
  230. <summary></summary>
  231. </member>
  232. <member name="F:OpenMetaverse.InventoryType.Attachment">
  233. <summary></summary>
  234. </member>
  235. <member name="F:OpenMetaverse.InventoryType.Wearable">
  236. <summary></summary>
  237. </member>
  238. <member name="F:OpenMetaverse.InventoryType.Animation">
  239. <summary></summary>
  240. </member>
  241. <member name="F:OpenMetaverse.InventoryType.Gesture">
  242. <summary></summary>
  243. </member>
  244. <member name="T:OpenMetaverse.SaleType">
  245. <summary>
  246. Item Sale Status
  247. </summary>
  248. </member>
  249. <member name="F:OpenMetaverse.SaleType.Not">
  250. <summary>Not for sale</summary>
  251. </member>
  252. <member name="F:OpenMetaverse.SaleType.Original">
  253. <summary>The original is for sale</summary>
  254. </member>
  255. <member name="F:OpenMetaverse.SaleType.Copy">
  256. <summary>Copies are for sale</summary>
  257. </member>
  258. <member name="F:OpenMetaverse.SaleType.Contents">
  259. <summary>The contents of the object are for sale</summary>
  260. </member>
  261. <member name="T:OpenMetaverse.WearableType">
  262. <summary>
  263. Types of wearable assets
  264. </summary>
  265. </member>
  266. <member name="F:OpenMetaverse.WearableType.Shape">
  267. <summary>Body shape</summary>
  268. </member>
  269. <member name="F:OpenMetaverse.WearableType.Skin">
  270. <summary>Skin textures and attributes</summary>
  271. </member>
  272. <member name="F:OpenMetaverse.WearableType.Hair">
  273. <summary>Hair</summary>
  274. </member>
  275. <member name="F:OpenMetaverse.WearableType.Eyes">
  276. <summary>Eyes</summary>
  277. </member>
  278. <member name="F:OpenMetaverse.WearableType.Shirt">
  279. <summary>Shirt</summary>
  280. </member>
  281. <member name="F:OpenMetaverse.WearableType.Pants">
  282. <summary>Pants</summary>
  283. </member>
  284. <member name="F:OpenMetaverse.WearableType.Shoes">
  285. <summary>Shoes</summary>
  286. </member>
  287. <member name="F:OpenMetaverse.WearableType.Socks">
  288. <summary>Socks</summary>
  289. </member>
  290. <member name="F:OpenMetaverse.WearableType.Jacket">
  291. <summary>Jacket</summary>
  292. </member>
  293. <member name="F:OpenMetaverse.WearableType.Gloves">
  294. <summary>Gloves</summary>
  295. </member>
  296. <member name="F:OpenMetaverse.WearableType.Undershirt">
  297. <summary>Undershirt</summary>
  298. </member>
  299. <member name="F:OpenMetaverse.WearableType.Underpants">
  300. <summary>Underpants</summary>
  301. </member>
  302. <member name="F:OpenMetaverse.WearableType.Skirt">
  303. <summary>Skirt</summary>
  304. </member>
  305. <member name="F:OpenMetaverse.WearableType.Invalid">
  306. <summary>Invalid wearable asset</summary>
  307. </member>
  308. <member name="T:OpenMetaverse.BlockingQueue`1">
  309. <summary>
  310. Same as Queue except Dequeue function blocks until there is an object to return.
  311. Note: This class does not need to be synchronized
  312. </summary>
  313. </member>
  314. <member name="M:OpenMetaverse.BlockingQueue`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
  315. <summary>
  316. Create new BlockingQueue.
  317. </summary>
  318. <param name="col">The System.Collections.ICollection to copy elements from</param>
  319. </member>
  320. <member name="M:OpenMetaverse.BlockingQueue`1.#ctor(System.Int32)">
  321. <summary>
  322. Create new BlockingQueue.
  323. </summary>
  324. <param name="capacity">The initial number of elements that the queue can contain</param>
  325. </member>
  326. <member name="M:OpenMetaverse.BlockingQueue`1.#ctor">
  327. <summary>
  328. Create new BlockingQueue.
  329. </summary>
  330. </member>
  331. <member name="M:OpenMetaverse.BlockingQueue`1.Finalize">
  332. <summary>
  333. BlockingQueue Destructor (Close queue, resume any waiting thread).
  334. </summary>
  335. </member>
  336. <member name="M:OpenMetaverse.BlockingQueue`1.Clear">
  337. <summary>
  338. Remove all objects from the Queue.
  339. </summary>
  340. </member>
  341. <member name="M:OpenMetaverse.BlockingQueue`1.Close">
  342. <summary>
  343. Remove all objects from the Queue, resume all dequeue threads.
  344. </summary>
  345. </member>
  346. <member name="M:OpenMetaverse.BlockingQueue`1.Dequeue">
  347. <summary>
  348. Removes and returns the object at the beginning of the Queue.
  349. </summary>
  350. <returns>Object in queue.</returns>
  351. </member>
  352. <member name="M:OpenMetaverse.BlockingQueue`1.Dequeue(System.TimeSpan)">
  353. <summary>
  354. Removes and returns the object at the beginning of the Queue.
  355. </summary>
  356. <param name="timeout">time to wait before returning</param>
  357. <returns>Object in queue.</returns>
  358. </member>
  359. <member name="M:OpenMetaverse.BlockingQueue`1.Dequeue(System.Int32)">
  360. <summary>
  361. Removes and returns the object at the beginning of the Queue.
  362. </summary>
  363. <param name="timeout">time to wait before returning (in milliseconds)</param>
  364. <returns>Object in queue.</returns>
  365. </member>
  366. <member name="M:OpenMetaverse.BlockingQueue`1.Enqueue(`0)">
  367. <summary>
  368. Adds an object to the end of the Queue
  369. </summary>
  370. <param name="obj">Object to put in queue</param>
  371. </member>
  372. <member name="M:OpenMetaverse.BlockingQueue`1.Open">
  373. <summary>
  374. Open Queue.
  375. </summary>
  376. </member>
  377. <member name="P:OpenMetaverse.BlockingQueue`1.Closed">
  378. <summary>
  379. Gets flag indicating if queue has been closed.
  380. </summary>
  381. </member>
  382. <member name="F:OpenMetaverse.ExpiringCache`2.syncRoot">
  383. <summary>For thread safety</summary>
  384. </member>
  385. <member name="F:OpenMetaverse.ExpiringCache`2.isPurging">
  386. <summary>For thread safety</summary>
  387. </member>
  388. <member name="M:OpenMetaverse.ExpiringCache`2.PurgeCache(System.Object,System.Timers.ElapsedEventArgs)">
  389. <summary>
  390. Purges expired objects from the cache. Called automatically by the purge timer.
  391. </summary>
  392. </member>
  393. <member name="T:OpenMetaverse.UUID">
  394. <summary>
  395. A 128-bit Universally Unique Identifier, used throughout the Second
  396. Life networking protocol
  397. </summary>
  398. </member>
  399. <member name="F:OpenMetaverse.UUID.Guid">
  400. <summary>The System.Guid object this struct wraps around</summary>
  401. </member>
  402. <member name="M:OpenMetaverse.UUID.#ctor(System.String)">
  403. <summary>
  404. Constructor that takes a string UUID representation
  405. </summary>
  406. <param name="val">A string representation of a UUID, case
  407. insensitive and can either be hyphenated or non-hyphenated</param>
  408. <example>UUID("11f8aa9c-b071-4242-836b-13b7abe0d489")</example>
  409. </member>
  410. <member name="M:OpenMetaverse.UUID.#ctor(System.Guid)">
  411. <summary>
  412. Constructor that takes a System.Guid object
  413. </summary>
  414. <param name="val">A Guid object that contains the unique identifier
  415. to be represented by this UUID</param>
  416. </member>
  417. <member name="M:OpenMetaverse.UUID.#ctor(System.Byte[],System.Int32)">
  418. <summary>
  419. Constructor that takes a byte array containing a UUID
  420. </summary>
  421. <param name="source">Byte array containing a 16 byte UUID</param>
  422. <param name="pos">Beginning offset in the array</param>
  423. </member>
  424. <member name="M:OpenMetaverse.UUID.#ctor(System.UInt64)">
  425. <summary>
  426. Constructor that takes an unsigned 64-bit unsigned integer to
  427. convert to a UUID
  428. </summary>
  429. <param name="val">64-bit unsigned integer to convert to a UUID</param>
  430. </member>
  431. <member name="M:OpenMetaverse.UUID.#ctor(OpenMetaverse.UUID)">
  432. <summary>
  433. Copy constructor
  434. </summary>
  435. <param name="val">UUID to copy</param>
  436. </member>
  437. <member name="M:OpenMetaverse.UUID.CompareTo(OpenMetaverse.UUID)">
  438. <summary>
  439. IComparable.CompareTo implementation
  440. </summary>
  441. </member>
  442. <member name="M:OpenMetaverse.UUID.FromBytes(System.Byte[],System.Int32)">
  443. <summary>
  444. Assigns this UUID from 16 bytes out of a byte array
  445. </summary>
  446. <param name="source">Byte array containing the UUID to assign this UUID to</param>
  447. <param name="pos">Starting position of the UUID in the byte array</param>
  448. </member>
  449. <member name="M:OpenMetaverse.UUID.GetBytes">
  450. <summary>
  451. Returns a copy of the raw bytes for this UUID
  452. </summary>
  453. <returns>A 16 byte array containing this UUID</returns>
  454. </member>
  455. <member name="M:OpenMetaverse.UUID.ToBytes(System.Byte[],System.Int32)">
  456. <summary>
  457. Writes the raw bytes for this UUID to a byte array
  458. </summary>
  459. <param name="dest">Destination byte array</param>
  460. <param name="pos">Position in the destination array to start
  461. writing. Must be at least 16 bytes before the end of the array</param>
  462. </member>
  463. <member name="M:OpenMetaverse.UUID.CRC">
  464. <summary>
  465. Calculate an LLCRC (cyclic redundancy check) for this UUID
  466. </summary>
  467. <returns>The CRC checksum for this UUID</returns>
  468. </member>
  469. <member name="M:OpenMetaverse.UUID.GetULong">
  470. <summary>
  471. Create a 64-bit integer representation from the second half of this UUID
  472. </summary>
  473. <returns>An integer created from the last eight bytes of this UUID</returns>
  474. </member>
  475. <member name="M:OpenMetaverse.UUID.Parse(System.String)">
  476. <summary>
  477. Generate a UUID from a string
  478. </summary>
  479. <param name="val">A string representation of a UUID, case
  480. insensitive and can either be hyphenated or non-hyphenated</param>
  481. <example>UUID.Parse("11f8aa9c-b071-4242-836b-13b7abe0d489")</example>
  482. </member>
  483. <member name="M:OpenMetaverse.UUID.TryParse(System.String,OpenMetaverse.UUID@)">
  484. <summary>
  485. Generate a UUID from a string
  486. </summary>
  487. <param name="val">A string representation of a UUID, case
  488. insensitive and can either be hyphenated or non-hyphenated</param>
  489. <param name="result">Will contain the parsed UUID if successful,
  490. otherwise null</param>
  491. <returns>True if the string was successfully parse, otherwise false</returns>
  492. <example>UUID.TryParse("11f8aa9c-b071-4242-836b-13b7abe0d489", result)</example>
  493. </member>
  494. <member name="M:OpenMetaverse.UUID.Combine(OpenMetaverse.UUID,OpenMetaverse.UUID)">
  495. <summary>
  496. Combine two UUIDs together by taking the MD5 hash of a byte array
  497. containing both UUIDs
  498. </summary>
  499. <param name="first">First UUID to combine</param>
  500. <param name="second">Second UUID to combine</param>
  501. <returns>The UUID product of the combination</returns>
  502. </member>
  503. <member name="M:OpenMetaverse.UUID.Random">
  504. <summary>
  505. </summary>
  506. <returns></returns>
  507. </member>
  508. <member name="M:OpenMetaverse.UUID.GetHashCode">
  509. <summary>
  510. Return a hash code for this UUID, used by .NET for hash tables
  511. </summary>
  512. <returns>An integer composed of all the UUID bytes XORed together</returns>
  513. </member>
  514. <member name="M:OpenMetaverse.UUID.Equals(System.Object)">
  515. <summary>
  516. Comparison function
  517. </summary>
  518. <param name="o">An object to compare to this UUID</param>
  519. <returns>True if the object is a UUID and both UUIDs are equal</returns>
  520. </member>
  521. <member name="M:OpenMetaverse.UUID.Equals(OpenMetaverse.UUID)">
  522. <summary>
  523. Comparison function
  524. </summary>
  525. <param name="uuid">UUID to compare to</param>
  526. <returns>True if the UUIDs are equal, otherwise false</returns>
  527. </member>
  528. <member name="M:OpenMetaverse.UUID.ToString">
  529. <summary>
  530. Get a hyphenated string representation of this UUID
  531. </summary>
  532. <returns>A string representation of this UUID, lowercase and
  533. with hyphens</returns>
  534. <example>11f8aa9c-b071-4242-836b-13b7abe0d489</example>
  535. </member>
  536. <member name="M:OpenMetaverse.UUID.op_Equality(OpenMetaverse.UUID,OpenMetaverse.UUID)">
  537. <summary>
  538. Equals operator
  539. </summary>
  540. <param name="lhs">First UUID for comparison</param>
  541. <param name="rhs">Second UUID for comparison</param>
  542. <returns>True if the UUIDs are byte for byte equal, otherwise false</returns>
  543. </member>
  544. <member name="M:OpenMetaverse.UUID.op_Inequality(OpenMetaverse.UUID,OpenMetaverse.UUID)">
  545. <summary>
  546. Not equals operator
  547. </summary>
  548. <param name="lhs">First UUID for comparison</param>
  549. <param name="rhs">Second UUID for comparison</param>
  550. <returns>True if the UUIDs are not equal, otherwise true</returns>
  551. </member>
  552. <member name="M:OpenMetaverse.UUID.op_ExclusiveOr(OpenMetaverse.UUID,OpenMetaverse.UUID)">
  553. <summary>
  554. XOR operator
  555. </summary>
  556. <param name="lhs">First UUID</param>
  557. <param name="rhs">Second UUID</param>
  558. <returns>A UUID that is a XOR combination of the two input UUIDs</returns>
  559. </member>
  560. <member name="M:OpenMetaverse.UUID.op_Explicit(System.String)~OpenMetaverse.UUID">
  561. <summary>
  562. String typecasting operator
  563. </summary>
  564. <param name="val">A UUID in string form. Case insensitive,
  565. hyphenated or non-hyphenated</param>
  566. <returns>A UUID built from the string representation</returns>
  567. </member>
  568. <member name="F:OpenMetaverse.UUID.Zero">
  569. <summary>An UUID with a value of all zeroes</summary>
  570. </member>
  571. <member name="M:OpenMetaverse.Matrix4.GetEulerAngles(System.Single@,System.Single@,System.Single@)">
  572. <summary>
  573. Convert this matrix to euler rotations
  574. </summary>
  575. <param name="roll">X euler angle</param>
  576. <param name="pitch">Y euler angle</param>
  577. <param name="yaw">Z euler angle</param>
  578. </member>
  579. <member name="M:OpenMetaverse.Matrix4.GetQuaternion">
  580. <summary>
  581. Convert this matrix to a quaternion rotation
  582. </summary>
  583. <returns>A quaternion representation of this rotation matrix</returns>
  584. </member>
  585. <member name="M:OpenMetaverse.Matrix4.CreateFromEulers(System.Single,System.Single,System.Single)">
  586. <summary>
  587. Construct a matrix from euler rotation values in radians
  588. </summary>
  589. <param name="roll">X euler angle in radians</param>
  590. <param name="pitch">Y euler angle in radians</param>
  591. <param name="yaw">Z euler angle in radians</param>
  592. </member>
  593. <member name="M:OpenMetaverse.Matrix4.ToString">
  594. <summary>
  595. Get a formatted string representation of the vector
  596. </summary>
  597. <returns>A string representation of the vector</returns>
  598. </member>
  599. <member name="F:OpenMetaverse.Matrix4.Zero">
  600. <summary>A 4x4 matrix containing all zeroes</summary>
  601. </member>
  602. <member name="F:OpenMetaverse.Matrix4.Identity">
  603. <summary>A 4x4 identity matrix</summary>
  604. </member>
  605. <member name="T:OpenMetaverse.Color4">
  606. <summary>
  607. An 8-bit color structure including an alpha channel
  608. </summary>
  609. </member>
  610. <member name="F:OpenMetaverse.Color4.R">
  611. <summary>Red</summary>
  612. </member>
  613. <member name="F:OpenMetaverse.Color4.G">
  614. <summary>Green</summary>
  615. </member>
  616. <member name="F:OpenMetaverse.Color4.B">
  617. <summary>Blue</summary>
  618. </member>
  619. <member name="F:OpenMetaverse.Color4.A">
  620. <summary>Alpha</summary>
  621. </member>
  622. <member name="M:OpenMetaverse.Color4.#ctor(System.Byte,System.Byte,System.Byte,System.Byte)">
  623. <summary>
  624. </summary>
  625. <param name="r"></param>
  626. <param name="g"></param>
  627. <param name="b"></param>
  628. <param name="a"></param>
  629. </member>
  630. <member name="M:OpenMetaverse.Color4.#ctor(System.Byte[],System.Int32,System.Boolean)">
  631. <summary>
  632. Builds a color from a byte array
  633. </summary>
  634. <param name="byteArray">Byte array containing a 16 byte color</param>
  635. <param name="pos">Beginning position in the byte array</param>
  636. <param name="inverted">True if the byte array stores inverted values,
  637. otherwise false. For example the color black (fully opaque) inverted
  638. would be 0xFF 0xFF 0xFF 0x00</param>
  639. </member>
  640. <member name="M:OpenMetaverse.Color4.#ctor(System.Byte[],System.Int32,System.Boolean,System.Boolean)">
  641. <summary>
  642. Returns the raw bytes for this vector
  643. </summary>
  644. <param name="byteArray">Byte array containing a 16 byte color</param>
  645. <param name="pos">Beginning position in the byte array</param>
  646. <param name="inverted">True if the byte array stores inverted values,
  647. otherwise false. For example the color black (fully opaque) inverted
  648. would be 0xFF 0xFF 0xFF 0x00</param>
  649. <param name="alphaInverted">True if the alpha value is inverted in
  650. addition to whatever the inverted parameter is. Setting inverted true
  651. and alphaInverted true will flip the alpha value back to non-inverted,
  652. but keep the other color bytes inverted</param>
  653. <returns>A 16 byte array containing R, G, B, and A</returns>
  654. </member>
  655. <member name="M:OpenMetaverse.Color4.#ctor(OpenMetaverse.Color4)">
  656. <summary>
  657. Copy constructor
  658. </summary>
  659. <param name="color">Color to copy</param>
  660. </member>
  661. <member name="M:OpenMetaverse.Color4.CompareTo(OpenMetaverse.Color4)">
  662. <summary>
  663. IComparable.CompareTo implementation
  664. </summary>
  665. <remarks>Sorting ends up like this: |--Grayscale--||--Color--|.
  666. Alpha is only used when the colors are otherwise equivalent</remarks>
  667. </member>
  668. <member name="M:OpenMetaverse.Color4.FromBytes(System.Byte[],System.Int32,System.Boolean,System.Boolean)">
  669. <summary>
  670. Builds a color from a byte array
  671. </summary>
  672. <param name="byteArray">Byte array containing a 16 byte color</param>
  673. <param name="pos">Beginning position in the byte array</param>
  674. <param name="inverted">True if the byte array stores inverted values,
  675. otherwise false. For example the color black (fully opaque) inverted
  676. would be 0xFF 0xFF 0xFF 0x00</param>
  677. <param name="alphaInverted">True if the alpha value is inverted in
  678. addition to whatever the inverted parameter is. Setting inverted true
  679. and alphaInverted true will flip the alpha value back to non-inverted,
  680. but keep the other color bytes inverted</param>
  681. </member>
  682. <member name="M:OpenMetaverse.Color4.ToBytes(System.Byte[],System.Int32)">
  683. <summary>
  684. Writes the raw bytes for this color to a byte array
  685. </summary>
  686. <param name="dest">Destination byte array</param>
  687. <param name="pos">Position in the destination array to start
  688. writing. Must be at least 16 bytes before the end of the array</param>
  689. </member>
  690. <member name="M:OpenMetaverse.Color4.ToBytes(System.Byte[],System.Int32,System.Boolean)">
  691. <summary>
  692. Serializes this color into four bytes in a byte array
  693. </summary>
  694. <param name="dest">Destination byte array</param>
  695. <param name="pos">Position in the destination array to start
  696. writing. Must be at least 4 bytes before the end of the array</param>
  697. <param name="inverted">True to invert the output (1.0 becomes 0
  698. instead of 255)</param>
  699. </member>
  700. <member name="M:OpenMetaverse.Color4.ToFloatBytes(System.Byte[],System.Int32)">
  701. <summary>
  702. Writes the raw bytes for this color to a byte array
  703. </summary>
  704. <param name="dest">Destination byte array</param>
  705. <param name="pos">Position in the destination array to start
  706. writing. Must be at least 16 bytes before the end of the array</param>
  707. </member>
  708. <member name="M:OpenMetaverse.Color4.FromHSV(System.Double,System.Double,System.Double)">
  709. <summary>
  710. Create an RGB color from a hue, saturation, value combination
  711. </summary>
  712. <param name="hue">Hue</param>
  713. <param name="saturation">Saturation</param>
  714. <param name="value">Value</param>
  715. <returns>An fully opaque RGB color (alpha is 1.0)</returns>
  716. </member>
  717. <member name="F:OpenMetaverse.Color4.Black">
  718. <summary>A Color4 with zero RGB values and fully opaque (alpha 1.0)</summary>
  719. </member>
  720. <member name="F:OpenMetaverse.Color4.White">
  721. <summary>A Color4 with full RGB values (1.0) and fully opaque (alpha 1.0)</summary>
  722. </member>
  723. <member name="F:OpenMetaverse.Quaternion.X">
  724. <summary>X value</summary>
  725. </member>
  726. <member name="F:OpenMetaverse.Quaternion.Y">
  727. <summary>Y value</summary>
  728. </member>
  729. <member name="F:OpenMetaverse.Quaternion.Z">
  730. <summary>Z value</summary>
  731. </member>
  732. <member name="F:OpenMetaverse.Quaternion.W">
  733. <summary>W value</summary>
  734. </member>
  735. <member name="M:OpenMetaverse.Quaternion.#ctor(System.Single,System.Single,System.Single)">
  736. <summary>
  737. Build a quaternion from normalized float values
  738. </summary>
  739. <param name="x">X value from -1.0 to 1.0</param>
  740. <param name="y">Y value from -1.0 to 1.0</param>
  741. <param name="z">Z value from -1.0 to 1.0</param>
  742. </member>
  743. <member name="M:OpenMetaverse.Quaternion.#ctor(System.Byte[],System.Int32,System.Boolean)">
  744. <summary>
  745. Constructor, builds a quaternion object from a byte array
  746. </summary>
  747. <param name="byteArray">Byte array containing four four-byte floats</param>
  748. <param name="pos">Offset in the byte array to start reading at</param>
  749. <param name="normalized">Whether the source data is normalized or
  750. not. If this is true 12 bytes will be read, otherwise 16 bytes will
  751. be read.</param>
  752. </member>
  753. <member name="M:OpenMetaverse.Quaternion.Normalize">
  754. <summary>
  755. Normalizes the quaternion
  756. </summary>
  757. </member>
  758. <member name="M:OpenMetaverse.Quaternion.FromBytes(System.Byte[],System.Int32,System.Boolean)">
  759. <summary>
  760. Builds a quaternion object from a byte array
  761. </summary>
  762. <param name="byteArray">The source byte array</param>
  763. <param name="pos">Offset in the byte array to start reading at</param>
  764. <param name="normalized">Whether the source data is normalized or
  765. not. If this is true 12 bytes will be read, otherwise 16 bytes will
  766. be read.</param>
  767. </member>
  768. <member name="M:OpenMetaverse.Quaternion.GetBytes">
  769. <summary>
  770. Normalize this quaternion and serialize it to a byte array
  771. </summary>
  772. <returns>A 12 byte array containing normalized X, Y, and Z floating
  773. point values in order using little endian byte ordering</returns>
  774. </member>
  775. <member name="M:OpenMetaverse.Quaternion.ToBytes(System.Byte[],System.Int32)">
  776. <summary>
  777. Writes the raw bytes for this quaternion to a byte array
  778. </summary>
  779. <param name="dest">Destination byte array</param>
  780. <param name="pos">Position in the destination array to start
  781. writing. Must be at least 12 bytes before the end of the array</param>
  782. </member>
  783. <member name="M:OpenMetaverse.Quaternion.GetEulerAngles(System.Single@,System.Single@,System.Single@)">
  784. <summary>
  785. Convert this quaternion to euler angles
  786. </summary>
  787. <param name="roll">X euler angle</param>
  788. <param name="pitch">Y euler angle</param>
  789. <param name="yaw">Z euler angle</param>
  790. </member>
  791. <member name="M:OpenMetaverse.Quaternion.GetAxisAngle(OpenMetaverse.Vector3@,System.Single@)">
  792. <summary>
  793. Convert this quaternion to an angle around an axis
  794. </summary>
  795. <param name="axis">Unit vector describing the axis</param>
  796. <param name="angle">Angle around the axis, in radians</param>
  797. </member>
  798. <member name="M:OpenMetaverse.Quaternion.Conjugate(OpenMetaverse.Quaternion)">
  799. <summary>
  800. Returns the conjugate (spatial inverse) of a quaternion
  801. </summary>
  802. </member>
  803. <member name="M:OpenMetaverse.Quaternion.CreateFromAxisAngle(System.Single,System.Single,System.Single,System.Single)">
  804. <summary>
  805. Build a quaternion from an axis and an angle of rotation around
  806. that axis
  807. </summary>
  808. </member>
  809. <member name="M:OpenMetaverse.Quaternion.CreateFromAxisAngle(OpenMetaverse.Vector3,System.Single)">
  810. <summary>
  811. Build a quaternion from an axis and an angle of rotation around
  812. that axis
  813. </summary>
  814. <param name="axis">Axis of rotation</param>
  815. <param name="angle">Angle of rotation</param>
  816. </member>
  817. <member name="M:OpenMetaverse.Quaternion.CreateFromEulers(OpenMetaverse.Vector3)">
  818. <summary>
  819. Creates a quaternion from a vector containing roll, pitch, and yaw
  820. in radians
  821. </summary>
  822. <param name="eulers">Vector representation of the euler angles in
  823. radians</param>
  824. <returns>Quaternion representation of the euler angles</returns>
  825. </member>
  826. <member name="M:OpenMetaverse.Quaternion.CreateFromEulers(System.Single,System.Single,System.Single)">
  827. <summary>
  828. Creates a quaternion from roll, pitch, and yaw euler angles in
  829. radians
  830. </summary>
  831. <param name="roll">X angle in radians</param>
  832. <param name="pitch">Y angle in radians</param>
  833. <param name="yaw">Z angle in radians</param>
  834. <returns>Quaternion representation of the euler angles</returns>
  835. </member>
  836. <member name="M:OpenMetaverse.Quaternion.Inverse(OpenMetaverse.Quaternion)">
  837. <summary>
  838. Conjugates and renormalizes a vector
  839. </summary>
  840. </member>
  841. <member name="M:OpenMetaverse.Quaternion.Slerp(OpenMetaverse.Quaternion,OpenMetaverse.Quaternion,System.Single)">
  842. <summary>
  843. Spherical linear interpolation between two quaternions
  844. </summary>
  845. </member>
  846. <member name="M:OpenMetaverse.Quaternion.ToRawString">
  847. <summary>
  848. Get a string representation of the quaternion elements with up to three
  849. decimal digits and separated by spaces only
  850. </summary>
  851. <returns>Raw string representation of the quaternion</returns>
  852. </member>
  853. <member name="F:OpenMetaverse.Quaternion.Identity">
  854. <summary>A quaternion with a value of 0,0,0,1</summary>
  855. </member>
  856. <member name="F:OpenMetaverse.Vector4.X">
  857. <summary>X value</summary>
  858. </member>
  859. <member name="F:OpenMetaverse.Vector4.Y">
  860. <summary>Y value</summary>
  861. </member>
  862. <member name="F:OpenMetaverse.Vector4.Z">
  863. <summary>Z value</summary>
  864. </member>
  865. <member name="F:OpenMetaverse.Vector4.W">
  866. <summary>W value</summary>
  867. </member>
  868. <member name="M:OpenMetaverse.Vector4.#ctor(System.Byte[],System.Int32)">
  869. <summary>
  870. Constructor, builds a vector from a byte array
  871. </summary>
  872. <param name="byteArray">Byte array containing four four-byte floats</param>
  873. <param name="pos">Beginning position in the byte array</param>
  874. </member>
  875. <member name="M:OpenMetaverse.Vector4.ApproxEquals(OpenMetaverse.Vector4,System.Single)">
  876. <summary>
  877. Test if this vector is equal to another vector, within a given
  878. tolerance range
  879. </summary>
  880. <param name="vec">Vector to test against</param>
  881. <param name="tolerance">The acceptable magnitude of difference
  882. between the two vectors</param>
  883. <returns>True if the magnitude of difference between the two vectors
  884. is less than the given tolerance, otherwise false</returns>
  885. </member>
  886. <member name="M:OpenMetaverse.Vector4.CompareTo(OpenMetaverse.Vector4)">
  887. <summary>
  888. IComparable.CompareTo implementation
  889. </summary>
  890. </member>
  891. <member name="M:OpenMetaverse.Vector4.IsFinite">
  892. <summary>
  893. Test if this vector is composed of all finite numbers
  894. </summary>
  895. </member>
  896. <member name="M:OpenMetaverse.Vector4.FromBytes(System.Byte[],System.Int32)">
  897. <summary>
  898. Builds a vector from a byte array
  899. </summary>
  900. <param name="byteArray">Byte array containing a 16 byte vector</param>
  901. <param name="pos">Beginning position in the byte array</param>
  902. </member>
  903. <member name="M:OpenMetaverse.Vector4.GetBytes">
  904. <summary>
  905. Returns the raw bytes for this vector
  906. </summary>
  907. <returns>A 16 byte array containing X, Y, Z, and W</returns>
  908. </member>
  909. <member name="M:OpenMetaverse.Vector4.ToBytes(System.Byte[],System.Int32)">
  910. <summary>
  911. Writes the raw bytes for this vector to a byte array
  912. </summary>
  913. <param name="dest">Destination byte array</param>
  914. <param name="pos">Position in the destination array to start
  915. writing. Must be at least 16 bytes before the end of the array</param>
  916. </member>
  917. <member name="M:OpenMetaverse.Vector4.ToRawString">
  918. <summary>
  919. Get a string representation of the vector elements with up to three
  920. decimal digits and separated by spaces only
  921. </summary>
  922. <returns>Raw string representation of the vector</returns>
  923. </member>
  924. <member name="F:OpenMetaverse.Vector4.Zero">
  925. <summary>A vector with a value of 0,0,0,0</summary>
  926. </member>
  927. <member name="F:OpenMetaverse.Vector4.One">
  928. <summary>A vector with a value of 1,1,1,1</summary>
  929. </member>
  930. <member name="F:OpenMetaverse.Vector4.UnitX">
  931. <summary>A vector with a value of 1,0,0,0</summary>
  932. </member>
  933. <member name="F:OpenMetaverse.Vector4.UnitY">
  934. <summary>A vector with a value of 0,1,0,0</summary>
  935. </member>
  936. <member name="F:OpenMetaverse.Vector4.UnitZ">
  937. <summary>A vector with a value of 0,0,1,0</summary>
  938. </member>
  939. <member name="F:OpenMetaverse.Vector4.UnitW">
  940. <summary>A vector with a value of 0,0,0,1</summary>
  941. </member>
  942. <member name="T:OpenMetaverse.Vector3">
  943. <summary>
  944. A three-dimensional vector with floating-point values
  945. </summary>
  946. </member>
  947. <member name="F:OpenMetaverse.Vector3.X">
  948. <summary>X value</summary>
  949. </member>
  950. <member name="F:OpenMetaverse.Vector3.Y">
  951. <summary>Y value</summary>
  952. </member>
  953. <member name="F:OpenMetaverse.Vector3.Z">
  954. <summary>Z value</summary>
  955. </member>
  956. <member name="M:OpenMetaverse.Vector3.#ctor(System.Byte[],System.Int32)">
  957. <summary>
  958. Constructor, builds a vector from a byte array
  959. </summary>
  960. <param name="byteArray">Byte array containing three four-byte floats</param>
  961. <param name="pos">Beginning position in the byte array</param>
  962. </member>
  963. <member name="M:OpenMetaverse.Vector3.ApproxEquals(OpenMetaverse.Vector3,System.Single)">
  964. <summary>
  965. Test if this vector is equal to another vector, within a given
  966. tolerance range
  967. </summary>
  968. <param name="vec">Vector to test against</param>
  969. <param name="tolerance">The acceptable magnitude of difference
  970. between the two vectors</param>
  971. <returns>True if the magnitude of difference between the two vectors
  972. is less than the given tolerance, otherwise false</returns>
  973. </member>
  974. <member name="M:OpenMetaverse.Vector3.CompareTo(OpenMetaverse.Vector3)">
  975. <summary>
  976. IComparable.CompareTo implementation
  977. </summary>
  978. </member>
  979. <member name="M:OpenMetaverse.Vector3.IsFinite">
  980. <summary>
  981. Test if this vector is composed of all finite numbers
  982. </summary>
  983. </member>
  984. <member name="M:OpenMetaverse.Vector3.FromBytes(System.Byte[],System.Int32)">
  985. <summary>
  986. Builds a vector from a byte array
  987. </summary>
  988. <param name="byteArray">Byte array containing a 12 byte vector</param>
  989. <param name="pos">Beginning position in the byte array</param>
  990. </member>
  991. <member name="M:OpenMetaverse.Vector3.GetBytes">
  992. <summary>
  993. Returns the raw bytes for this vector
  994. </summary>
  995. <returns>A 12 byte array containing X, Y, and Z</returns>
  996. </member>
  997. <member name="M:OpenMetaverse.Vector3.ToBytes(System.Byte[],System.Int32)">
  998. <summary>
  999. Writes the raw bytes for this vector to a byte array
  1000. </summary>
  1001. <param name="dest">Destination byte array</param>
  1002. <param name="pos">Position in the destination array to start
  1003. writing. Must be at least 12 bytes before the end of the array</param>
  1004. </member>
  1005. <member name="M:OpenMetaverse.Vector3.Parse(System.String)">
  1006. <summary>
  1007. Parse a vector from a string
  1008. </summary>
  1009. <param name="val">A string representation of a 3D vector, enclosed
  1010. in arrow brackets and separated by commas</param>
  1011. </member>
  1012. <member name="M:OpenMetaverse.Vector3.RotationBetween(OpenMetaverse.Vector3,OpenMetaverse.Vector3)">
  1013. <summary>
  1014. Calculate the rotation between two vectors
  1015. </summary>
  1016. <param name="a">Normalized directional vector (such as 1,0,0 for forward facing)</param>
  1017. <param name="b">Normalized target vector</param>
  1018. </member>
  1019. <member name="M:OpenMetaverse.Vector3.SmoothStep(OpenMetaverse.Vector3,OpenMetaverse.Vector3,System.Single)">
  1020. <summary>
  1021. Interpolates between two vectors using a cubic equation
  1022. </summary>
  1023. </member>
  1024. <member name="M:OpenMetaverse.Vector3.ToString">
  1025. <summary>
  1026. Get a formatted string representation of the vector
  1027. </summary>
  1028. <returns>A string representation of the vector</returns>
  1029. </member>
  1030. <member name="M:OpenMetaverse.Vector3.ToRawString">
  1031. <summary>
  1032. Get a string representation of the vector elements with up to three
  1033. decimal digits and separated by spaces only
  1034. </summary>
  1035. <returns>Raw string representation of the vector</returns>
  1036. </member>
  1037. <member name="M:OpenMetaverse.Vector3.op_Modulus(OpenMetaverse.Vector3,OpenMetaverse.Vector3)">
  1038. <summary>
  1039. Cross product between two vectors
  1040. </summary>
  1041. </member>
  1042. <member name="F:OpenMetaverse.Vector3.Zero">
  1043. <summary>A vector with a value of 0,0,0</summary>
  1044. </member>
  1045. <member name="F:OpenMetaverse.Vector3.One">
  1046. <summary>A vector with a value of 1,1,1</summary>
  1047. </member>
  1048. <member name="F:OpenMetaverse.Vector3.UnitX">
  1049. <summary>A unit vector facing forward (X axis), value 1,0,0</summary>
  1050. </member>
  1051. <member name="F:OpenMetaverse.Vector3.UnitY">
  1052. <summary>A unit vector facing left (Y axis), value 0,1,0</summary>
  1053. </member>
  1054. <member name="F:OpenMetaverse.Vector3.UnitZ">
  1055. <summary>A unit vector facing up (Z axis), value 0,0,1</summary>
  1056. </member>
  1057. <member name="T:OpenMetaverse.TokenBucket">
  1058. <summary>
  1059. A hierarchical token bucket for bandwidth throttling. See
  1060. http://en.wikipedia.org/wiki/Token_bucket for more information
  1061. </summary>
  1062. </member>
  1063. <member name="F:OpenMetaverse.TokenBucket.parent">
  1064. <summary>Parent bucket to this bucket, or null if this is a root
  1065. bucket</summary>
  1066. </member>
  1067. <member name="F:OpenMetaverse.TokenBucket.maxBurst">
  1068. <summary>Size of the bucket in bytes. If zero, the bucket has
  1069. infinite capacity</summary>
  1070. </member>
  1071. <member name="F:OpenMetaverse.TokenBucket.tokensPerMS">
  1072. <summary>Rate that the bucket fills, in bytes per millisecond. If
  1073. zero, the bucket always remains full</summary>
  1074. </member>
  1075. <member name="F:OpenMetaverse.TokenBucket.content">
  1076. <summary>Number of tokens currently in the bucket</summary>
  1077. </member>
  1078. <member name="F:OpenMetaverse.TokenBucket.lastDrip">
  1079. <summary>Time of the last drip, in system ticks</summary>
  1080. </member>
  1081. <member name="M:OpenMetaverse.TokenBucket.#ctor(OpenMetaverse.TokenBucket,System.Int32,System.Int32)">
  1082. <summary>
  1083. Default constructor
  1084. </summary>
  1085. <param name="parent">Parent bucket if this is a child bucket, or
  1086. null if this is a root bucket</param>
  1087. <param name="maxBurst">Maximum size of the bucket in bytes, or
  1088. zero if this bucket has no maximum capacity</param>
  1089. <param name="dripRate">Rate that the bucket fills, in bytes per
  1090. second. If zero, the bucket always remains full</param>
  1091. </member>
  1092. <member name="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32)">
  1093. <summary>
  1094. Remove a given number of tokens from the bucket
  1095. </summary>
  1096. <param name="amount">Number of tokens to remove from the bucket</param>
  1097. <returns>True if the requested number of tokens were removed from
  1098. the bucket, otherwise false</returns>
  1099. </member>
  1100. <member name="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32,System.Boolean@)">
  1101. <summary>
  1102. Remove a given number of tokens from the bucket
  1103. </summary>
  1104. <param name="amount">Number of tokens to remove from the bucket</param>
  1105. <param name="dripSucceeded">True if tokens were added to the bucket
  1106. during this call, otherwise false</param>
  1107. <returns>True if the requested number of tokens were removed from
  1108. the bucket, otherwise false</returns>
  1109. </member>
  1110. <member name="M:OpenMetaverse.TokenBucket.Drip">
  1111. <summary>
  1112. Add tokens to the bucket over time. The number of tokens added each
  1113. call depends on the length of time that has passed since the last
  1114. call to Drip
  1115. </summary>
  1116. <returns>True if tokens were added to the bucket, otherwise false</returns>
  1117. </member>
  1118. <member name="P:OpenMetaverse.TokenBucket.Parent">
  1119. <summary>
  1120. The parent bucket of this bucket, or null if this bucket has no
  1121. parent. The parent bucket will limit the aggregate bandwidth of all
  1122. of its children buckets
  1123. </summary>
  1124. </member>
  1125. <member name="P:OpenMetaverse.TokenBucket.MaxBurst">
  1126. <summary>
  1127. Maximum burst rate in bytes per second. This is the maximum number
  1128. of tokens that can accumulate in the bucket at any one time
  1129. </summary>
  1130. </member>
  1131. <member name="P:OpenMetaverse.TokenBucket.DripRate">
  1132. <summary>
  1133. The speed limit of this bucket in bytes per second. This is the
  1134. number of tokens that are added to the bucket per second
  1135. </summary>
  1136. <remarks>Tokens are added to the bucket any time
  1137. <seealso cref="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32)"/> is called, at the granularity of
  1138. the system tick interval (typically around 15-22ms)</remarks>
  1139. </member>
  1140. <member name="P:OpenMetaverse.TokenBucket.Content">
  1141. <summary>
  1142. The number of bytes that can be sent at this moment. This is the
  1143. current number of tokens in the bucket
  1144. <remarks>If this bucket has a parent bucket that does not have
  1145. enough tokens for a request, <seealso cref="M:OpenMetaverse.TokenBucket.RemoveTokens(System.Int32)"/> will
  1146. return false regardless of the content of this bucket</remarks>
  1147. </summary>
  1148. </member>
  1149. <member name="T:OpenMetaverse.Vector2">
  1150. <summary>
  1151. A two-dimensional vector with floating-point values
  1152. </summary>
  1153. </member>
  1154. <member name="F:OpenMetaverse.Vector2.X">
  1155. <summary>X value</summary>
  1156. </member>
  1157. <member name="F:OpenMetaverse.Vector2.Y">
  1158. <summary>Y value</summary>
  1159. </member>
  1160. <member name="M:OpenMetaverse.Vector2.ApproxEquals(OpenMetaverse.Vector2,System.Single)">
  1161. <summary>
  1162. Test if this vector is equal to another vector, within a given
  1163. tolerance range
  1164. </summary>
  1165. <param name="vec">Vector to test against</param>
  1166. <param name="tolerance">The acceptable magnitude of difference
  1167. between the two vectors</param>
  1168. <returns>True if the magnitude of difference between the two vectors
  1169. is less than the given tolerance, otherwise false</returns>
  1170. </member>
  1171. <member name="M:OpenMetaverse.Vector2.IsFinite">
  1172. <summary>
  1173. Test if this vector is composed of all finite numbers
  1174. </summary>
  1175. </member>
  1176. <member name="M:OpenMetaverse.Vector2.CompareTo(OpenMetaverse.Vector2)">
  1177. <summary>
  1178. IComparable.CompareTo implementation
  1179. </summary>
  1180. </member>
  1181. <member name="M:OpenMetaverse.Vector2.FromBytes(System.Byte[],System.Int32)">
  1182. <summary>
  1183. Builds a vector from a byte array
  1184. </summary>
  1185. <param name="byteArray">Byte array containing two four-byte floats</param>
  1186. <param name="pos">Beginning position in the byte array</param>
  1187. </member>
  1188. <member name="M:OpenMetaverse.Vector2.GetBytes">
  1189. <summary>
  1190. Returns the raw bytes for this vector
  1191. </summary>
  1192. <returns>An eight-byte array containing X and Y</returns>
  1193. </member>
  1194. <member name="M:OpenMetaverse.Vector2.ToBytes(System.Byte[],System.Int32)">
  1195. <summary>
  1196. Writes the raw bytes for this vector to a byte array
  1197. </summary>
  1198. <param name="dest">Destination byte array</param>
  1199. <param name="pos">Position in the destination array to start
  1200. writing. Must be at least 8 bytes before the end of the array</param>
  1201. </member>
  1202. <member name="M:OpenMetaverse.Vector2.Parse(System.String)">
  1203. <summary>
  1204. Parse a vector from a string
  1205. </summary>
  1206. <param name="val">A string representation of a 2D vector, enclosed
  1207. in arrow brackets and separated by commas</param>
  1208. </member>
  1209. <member name="M:OpenMetaverse.Vector2.SmoothStep(OpenMetaverse.Vector2,OpenMetaverse.Vector2,System.Single)">
  1210. <summary>
  1211. Interpolates between two vectors using a cubic equation
  1212. </summary>
  1213. </member>
  1214. <member name="M:OpenMetaverse.Vector2.ToString">
  1215. <summary>
  1216. Get a formatted string representation of the vector
  1217. </summary>
  1218. <returns>A string representation of the vector</returns>
  1219. </member>
  1220. <member name="M:OpenMetaverse.Vector2.ToRawString">
  1221. <summary>
  1222. Get a string representation of the vector elements with up to three
  1223. decimal digits and separated by spaces only
  1224. </summary>
  1225. <returns>Raw string representation of the vector</returns>
  1226. </member>
  1227. <member name="F:OpenMetaverse.Vector2.Zero">
  1228. <summary>A vector with a value of 0,0</summary>
  1229. </member>
  1230. <member name="F:OpenMetaverse.Vector2.One">
  1231. <summary>A vector with a value of 1,1</summary>
  1232. </member>
  1233. <member name="F:OpenMetaverse.Vector2.UnitX">
  1234. <summary>A vector with a value of 1,0</summary>
  1235. </member>
  1236. <member name="F:OpenMetaverse.Vector2.UnitY">
  1237. <summary>A vector with a value of 0,1</summary>
  1238. </member>
  1239. <member name="F:OpenMetaverse.Utils.DEG_TO_RAD">
  1240. <summary>Used for converting degrees to radians</summary>
  1241. </member>
  1242. <member name="F:OpenMetaverse.Utils.RAD_TO_DEG">
  1243. <summary>Used for converting radians to degrees</summary>
  1244. </member>
  1245. <member name="M:OpenMetaverse.Utils.BytesToInt16(System.Byte[])">
  1246. <summary>
  1247. Convert the first two bytes starting in the byte array in
  1248. little endian ordering to a signed short integer
  1249. </summary>
  1250. <param name="bytes">An array two bytes or longer</param>
  1251. <returns>A signed short integer, will be zero if a short can't be
  1252. read at the given position</returns>
  1253. </member>
  1254. <member name="M:OpenMetaverse.Utils.BytesToInt16(System.Byte[],System.Int32)">
  1255. <summary>
  1256. Convert the first two bytes starting at the given position in
  1257. little endian ordering to a signed short integer
  1258. </summary>
  1259. <param name="bytes">An array two bytes or longer</param>
  1260. <param name="pos">Position in the array to start reading</param>
  1261. <returns>A signed short integer, will be zero if a short can't be
  1262. read at the given position</returns>
  1263. </member>
  1264. <member name="M:OpenMetaverse.Utils.BytesToInt(System.Byte[],System.Int32)">
  1265. <summary>
  1266. Convert the first four bytes starting at the given position in
  1267. little endian ordering to a signed integer
  1268. </summary>
  1269. <param name="bytes">An array four bytes or longer</param>
  1270. <param name="pos">Position to start reading the int from</param>
  1271. <returns>A signed integer, will be zero if an int can't be read
  1272. at the given position</returns>
  1273. </member>
  1274. <member name="M:OpenMetaverse.Utils.BytesToInt(System.Byte[])">
  1275. <summary>
  1276. Convert the first four bytes of the given array in little endian
  1277. ordering to a signed integer
  1278. </summary>
  1279. <param name="bytes">An array four bytes or longer</param>
  1280. <returns>A signed integer, will be zero if the array contains
  1281. less than four bytes</returns>
  1282. </member>
  1283. <member name="M:OpenMetaverse.Utils.BytesToInt64(System.Byte[])">
  1284. <summary>
  1285. Convert the first eight bytes of the given array in little endian
  1286. ordering to a signed long integer
  1287. </summary>
  1288. <param name="bytes">An array eight bytes or longer</param>
  1289. <returns>A signed long integer, will be zero if the array contains
  1290. less than eight bytes</returns>
  1291. </member>
  1292. <member name="M:OpenMetaverse.Utils.BytesToInt64(System.Byte[],System.Int32)">
  1293. <summary>
  1294. Convert the first eight bytes starting at the given position in
  1295. little endian ordering to a signed long integer
  1296. </summary>
  1297. <param name="bytes">An array eight bytes or longer</param>
  1298. <param name="pos">Position to start reading the long from</param>
  1299. <returns>A signed long integer, will be zero if a long can't be read
  1300. at the given position</returns>
  1301. </member>
  1302. <member name="M:OpenMetaverse.Utils.BytesToUInt16(System.Byte[],System.Int32)">
  1303. <summary>
  1304. Convert the first two bytes starting at the given position in
  1305. little endian ordering to an unsigned short
  1306. </summary>
  1307. <param name="bytes">Byte array containing the ushort</param>
  1308. <param name="pos">Position to start reading the ushort from</param>
  1309. <returns>An unsigned short, will be zero if a ushort can't be read
  1310. at the given position</returns>
  1311. </member>
  1312. <member name="M:OpenMetaverse.Utils.BytesToUInt16(System.Byte[])">
  1313. <summary>
  1314. Convert two bytes in little endian ordering to an unsigned short
  1315. </summary>
  1316. <param name="bytes">Byte array containing the ushort</param>
  1317. <returns>An unsigned short, will be zero if a ushort can't be
  1318. read</returns>
  1319. </member>
  1320. <member name="M:OpenMetaverse.Utils.BytesToUInt(System.Byte[],System.Int32)">
  1321. <summary>
  1322. Convert the first four bytes starting at the given position in
  1323. little endian ordering to an unsigned integer
  1324. </summary>
  1325. <param name="bytes">Byte array containing the uint</param>
  1326. <param name="pos">Position to start reading the uint from</param>
  1327. <returns>An unsigned integer, will be zero if a uint can't be read
  1328. at the given position</returns>
  1329. </member>
  1330. <member name="M:OpenMetaverse.Utils.BytesToUInt(System.Byte[])">
  1331. <summary>
  1332. Convert the first four bytes of the given array in little endian
  1333. ordering to an unsigned integer
  1334. </summary>
  1335. <param name="bytes">An array four bytes or longer</param>
  1336. <returns>An unsigned integer, will be zero if the array contains
  1337. less than four bytes</returns>
  1338. </member>
  1339. <member name="M:OpenMetaverse.Utils.BytesToUInt64(System.Byte[])">
  1340. <summary>
  1341. Convert the first eight bytes of the given array in little endian
  1342. ordering to an unsigned 64-bit integer
  1343. </summary>
  1344. <param name="bytes">An array eight bytes or longer</param>
  1345. <returns>An unsigned 64-bit integer, will be zero if the array
  1346. contains less than eight bytes</returns>
  1347. </member>
  1348. <member name="M:OpenMetaverse.Utils.BytesToFloat(System.Byte[],System.Int32)">
  1349. <summary>
  1350. Convert four bytes in little endian ordering to a floating point
  1351. value
  1352. </summary>
  1353. <param name="bytes">Byte array containing a little ending floating
  1354. point value</param>
  1355. <param name="pos">Starting position of the floating point value in
  1356. the byte array</param>
  1357. <returns>Single precision value</returns>
  1358. </member>
  1359. <member name="M:OpenMetaverse.Utils.IntToBytes(System.Int32)">
  1360. <summary>
  1361. Convert an integer to a byte array in little endian format
  1362. </summary>
  1363. <param name="value">The integer to convert</param>
  1364. <returns>A four byte little endian array</returns>
  1365. </member>
  1366. <member name="M:OpenMetaverse.Utils.IntToBytesBig(System.Int32)">
  1367. <summary>
  1368. Convert an integer to a byte array in big endian format
  1369. </summary>
  1370. <param name="value">The integer to convert</param>
  1371. <returns>A four byte big endian array</returns>
  1372. </member>
  1373. <member name="M:OpenMetaverse.Utils.Int64ToBytes(System.Int64)">
  1374. <summary>
  1375. Convert a 64-bit integer to a byte array in little endian format
  1376. </summary>
  1377. <param name="value">The value to convert</param>
  1378. <returns>An 8 byte little endian array</returns>
  1379. </member>
  1380. <member name="M:OpenMetaverse.Utils.UInt64ToBytes(System.UInt64)">
  1381. <summary>
  1382. Convert a 64-bit unsigned integer to a byte array in little endian
  1383. format
  1384. </summary>
  1385. <param name="value">The value to convert</param>
  1386. <returns>An 8 byte little endian array</returns>
  1387. </member>
  1388. <member name="M:OpenMetaverse.Utils.FloatToBytes(System.Single)">
  1389. <summary>
  1390. Convert a floating point value to four bytes in little endian
  1391. ordering
  1392. </summary>
  1393. <param name="value">A floating point value</param>
  1394. <returns>A four byte array containing the value in little endian
  1395. ordering</returns>
  1396. </member>
  1397. <member name="M:OpenMetaverse.Utils.UIntToHexString(System.UInt32)">
  1398. <summary>
  1399. Converts an unsigned integer to a hexadecimal string
  1400. </summary>
  1401. <param name="i">An unsigned integer to convert to a string</param>
  1402. <returns>A hexadecimal string 10 characters long</returns>
  1403. <example>0x7fffffff</example>
  1404. </member>
  1405. <member name="M:OpenMetaverse.Utils.BytesToString(System.Byte[])">
  1406. <summary>
  1407. Convert a variable length UTF8 byte array to a string
  1408. </summary>
  1409. <param name="bytes">The UTF8 encoded byte array to convert</param>
  1410. <returns>The decoded string</returns>
  1411. </member>
  1412. <member name="M:OpenMetaverse.Utils.BytesToHexString(System.Byte[],System.String)">
  1413. <summary>
  1414. Converts a byte array to a string containing hexadecimal characters
  1415. </summary>
  1416. <param name="bytes">The byte array to convert to a string</param>
  1417. <param name="fieldName">The name of the field to prepend to each
  1418. line of the string</param>
  1419. <returns>A string containing hexadecimal characters on multiple
  1420. lines. Each line is prepended with the field name</returns>
  1421. </member>
  1422. <member name="M:OpenMetaverse.Utils.BytesToHexString(System.Byte[],System.Int32,System.String)">
  1423. <summary>
  1424. Converts a byte array to a string containing hexadecimal characters
  1425. </summary>
  1426. <param name="bytes">The byte array to convert to a string</param>
  1427. <param name="length">Number of bytes in the array to parse</param>
  1428. <param name="fieldName">A string to prepend to each line of the hex
  1429. dump</param>
  1430. <returns>A string containing hexadecimal characters on multiple
  1431. lines. Each line is prepended with the field name</returns>
  1432. </member>
  1433. <member name="M:OpenMetaverse.Utils.StringToBytes(System.String)">
  1434. <summary>
  1435. Convert a string to a UTF8 encoded byte array
  1436. </summary>
  1437. <param name="str">The string to convert</param>
  1438. <returns>A null-terminated UTF8 byte array</returns>
  1439. </member>
  1440. <member name="M:OpenMetaverse.Utils.HexStringToBytes(System.String,System.Boolean)">
  1441. <summary>
  1442. Converts a string containing hexadecimal characters to a byte array
  1443. </summary>
  1444. <param name="hexString">String containing hexadecimal characters</param>
  1445. <param name="handleDirty">If true, gracefully handles null, empty and
  1446. uneven strings as well as stripping unconvertable characters</param>
  1447. <returns>The converted byte array</returns>
  1448. </member>
  1449. <member name="M:OpenMetaverse.Utils.IsHexDigit(System.Char)">
  1450. <summary>
  1451. Returns true is c is a hexadecimal digit (A-F, a-f, 0-9)
  1452. </summary>
  1453. <param name="c">Character to test</param>
  1454. <returns>true if hex digit, false if not</returns>
  1455. </member>
  1456. <member name="M:OpenMetaverse.Utils.HexToByte(System.String)">
  1457. <summary>
  1458. Converts 1 or 2 character string into equivalant byte value
  1459. </summary>
  1460. <param name="hex">1 or 2 character string</param>
  1461. <returns>byte</returns>
  1462. </member>
  1463. <member name="M:OpenMetaverse.Utils.FloatToByte(System.Single,System.Single,System.Single)">
  1464. <summary>
  1465. Convert a float value to a byte given a minimum and maximum range
  1466. </summary>
  1467. <param name="val">Value to convert to a byte</param>
  1468. <param name="lower">Minimum value range</param>
  1469. <param name="upper">Maximum value range</param>
  1470. <returns>A single byte representing the original float value</returns>
  1471. </member>
  1472. <member name="M:OpenMetaverse.Utils.ByteToFloat(System.Byte[],System.Int32,System.Single,System.Single)">
  1473. <summary>
  1474. Convert a byte to a float value given a minimum and maximum range
  1475. </summary>
  1476. <param name="bytes">Byte array to get the byte from</param>
  1477. <param name="pos">Position in the byte array the desired byte is at</param>
  1478. <param name="lower">Minimum value range</param>
  1479. <param name="upper">Maximum value range</param>
  1480. <returns>A float value inclusively between lower and upper</returns>
  1481. </member>
  1482. <member name="M:OpenMetaverse.Utils.ByteToFloat(System.Byte,System.Single,System.Single)">
  1483. <summary>
  1484. Convert a byte to a float value given a minimum and maximum range
  1485. </summary>
  1486. <param name="val">Byte to convert to a float value</param>
  1487. <param name="lower">Minimum value range</param>
  1488. <param name="upper">Maximum value range</param>
  1489. <returns>A float value inclusively between lower and upper</returns>
  1490. </member>
  1491. <member name="M:OpenMetaverse.Utils.TryParseSingle(System.String,System.Single@)">
  1492. <summary>
  1493. Attempts to parse a floating point value from a string, using an
  1494. EN-US number format
  1495. </summary>
  1496. <param name="s">String to parse</param>
  1497. <param name="result">Resulting floating point number</param>
  1498. <returns>True if the parse was successful, otherwise false</returns>
  1499. </member>
  1500. <member name="M:OpenMetaverse.Utils.TryParseDouble(System.String,System.Double@)">
  1501. <summary>
  1502. Attempts to parse a floating point value from a string, using an
  1503. EN-US number format
  1504. </summary>
  1505. <param name="s">String to parse</param>
  1506. <param name="result">Resulting floating point number</param>
  1507. <returns>True if the parse was successful, otherwise false</returns>
  1508. </member>
  1509. <member name="M:OpenMetaverse.Utils.TryParseHex(System.String,System.UInt32@)">
  1510. <summary>
  1511. Tries to parse an unsigned 32-bit integer from a hexadecimal string
  1512. </summary>
  1513. <param name="s">String to parse</param>
  1514. <param name="result">Resulting integer</param>
  1515. <returns>True if the parse was successful, otherwise false</returns>
  1516. </member>
  1517. <member name="M:OpenMetaverse.Utils.AssetTypeToString(OpenMetaverse.AssetType)">
  1518. <summary>
  1519. Takes an AssetType and returns the string representation
  1520. </summary>
  1521. <param name="type">The source <seealso cref="T:OpenMetaverse.AssetType"/></param>
  1522. <returns>The string version of the AssetType</returns>
  1523. </member>
  1524. <member name="M:OpenMetaverse.Utils.StringToAssetType(System.String)">
  1525. <summary>
  1526. Translate a string name of an AssetType into the proper Type
  1527. </summary>
  1528. <param name="type">A string containing the AssetType name</param>
  1529. <returns>The AssetType which matches the string name, or AssetType.Unknown if no match was found</returns>
  1530. </member>
  1531. <member name="M:OpenMetaverse.Utils.InventoryTypeToString(OpenMetaverse.InventoryType)">
  1532. <summary>
  1533. Convert an InventoryType to a string
  1534. </summary>
  1535. <param name="type">The <seealso cref="T:InventoryType"/> to convert</param>
  1536. <returns>A string representation of the source</returns>
  1537. </member>
  1538. <member name="M:OpenMetaverse.Utils.StringToInventoryType(System.String)">
  1539. <summary>
  1540. Convert a string into a valid InventoryType
  1541. </summary>
  1542. <param name="type">A string representation of the InventoryType to convert</param>
  1543. <returns>A InventoryType object which matched the type</returns>
  1544. </member>
  1545. <member name="M:OpenMetaverse.Utils.SaleTypeToString(OpenMetaverse.SaleType)">
  1546. <summary>
  1547. Convert a SaleType to a string
  1548. </summary>
  1549. <param name="type">The <seealso cref="T:SaleType"/> to convert</param>
  1550. <returns>A string representation of the source</returns>
  1551. </member>
  1552. <member name="M:OpenMetaverse.Utils.StringToSaleType(System.String)">
  1553. <summary>
  1554. Convert a string into a valid SaleType
  1555. </summary>
  1556. <param name="value">A string representation of the SaleType to convert</param>
  1557. <returns>A SaleType object which matched the type</returns>
  1558. </member>
  1559. <member name="M:OpenMetaverse.Utils.CopyBytes(System.Byte[])">
  1560. <summary>
  1561. Copy a byte array
  1562. </summary>
  1563. <param name="bytes">Byte array to copy</param>
  1564. <returns>A copy of the given byte array</returns>
  1565. </member>
  1566. <member name="M:OpenMetaverse.Utils.UIntsToLong(System.UInt32,System.UInt32)">
  1567. <summary>
  1568. Packs to 32-bit unsigned integers in to a 64-bit unsigned integer
  1569. </summary>
  1570. <param name="a">The left-hand (or X) value</param>
  1571. <param name="b">The right-hand (or Y) value</param>
  1572. <returns>A 64-bit integer containing the two 32-bit input values</returns>
  1573. </member>
  1574. <member name="M:OpenMetaverse.Utils.LongToUInts(System.UInt64,System.UInt32@,System.UInt32@)">
  1575. <summary>
  1576. Unpacks two 32-bit unsigned integers from a 64-bit unsigned integer
  1577. </summary>
  1578. <param name="a">The 64-bit input integer</param>
  1579. <param name="b">The left-hand (or X) output value</param>
  1580. <param name="c">The right-hand (or Y) output value</param>
  1581. </member>
  1582. <member name="M:OpenMetaverse.Utils.IPToUInt(System.Net.IPAddress)">
  1583. <summary>
  1584. Convert an IP address object to an unsigned 32-bit integer
  1585. </summary>
  1586. <param name="address">IP address to convert</param>
  1587. <returns>32-bit unsigned integer holding the IP address bits</returns>
  1588. </member>
  1589. <member name="M:OpenMetaverse.Utils.GetUnixTime">
  1590. <summary>
  1591. Gets a unix timestamp for the current time
  1592. </summary>
  1593. <returns>An unsigned integer representing a unix timestamp for now</returns>
  1594. </member>
  1595. <member name="M:OpenMetaverse.Utils.UnixTimeToDateTime(System.UInt32)">
  1596. <summary>
  1597. Convert a UNIX timestamp to a native DateTime object
  1598. </summary>
  1599. <param name="timestamp">An unsigned integer representing a UNIX
  1600. timestamp</param>
  1601. <returns>A DateTime object containing the same time specified in
  1602. the given timestamp</returns>
  1603. </member>
  1604. <member name="M:OpenMetaverse.Utils.UnixTimeToDateTime(System.Int32)">
  1605. <summary>
  1606. Convert a UNIX timestamp to a native DateTime object
  1607. </summary>
  1608. <param name="timestamp">A signed integer representing a UNIX
  1609. timestamp</param>
  1610. <returns>A DateTime object containing the same time specified in
  1611. the given timestamp</returns>
  1612. </member>
  1613. <member name="M:OpenMetaverse.Utils.DateTimeToUnixTime(System.DateTime)">
  1614. <summary>
  1615. Convert a native DateTime object to a UNIX timestamp
  1616. </summary>
  1617. <param name="time">A DateTime object you want to convert to a
  1618. timestamp</param>
  1619. <returns>An unsigned integer representing a UNIX timestamp</returns>
  1620. </member>
  1621. <member name="M:OpenMetaverse.Utils.Swap``1(``0@,``0@)">
  1622. <summary>
  1623. Swap two values
  1624. </summary>
  1625. <typeparam name="T">Type of the values to swap</typeparam>
  1626. <param name="lhs">First value</param>
  1627. <param name="rhs">Second value</param>
  1628. </member>
  1629. <member name="M:OpenMetaverse.Utils.EnumTryParse``1(System.String,``0@)">
  1630. <summary>
  1631. Try to parse an enumeration value from a string
  1632. </summary>
  1633. <typeparam name="T">Enumeration type</typeparam>
  1634. <param name="strType">String value to parse</param>
  1635. <param name="result">Enumeration value on success</param>
  1636. <returns>True if the parsing succeeded, otherwise false</returns>
  1637. </member>
  1638. <member name="M:OpenMetaverse.Utils.SwapWords(System.Byte)">
  1639. <summary>
  1640. Swaps the high and low words in a byte. Converts aaaabbbb to bbbbaaaa
  1641. </summary>
  1642. <param name="value">Byte to swap the words in</param>
  1643. <returns>Byte value with the words swapped</returns>
  1644. </member>
  1645. <member name="M:OpenMetaverse.Utils.HostnameToIPv4(System.String)">
  1646. <summary>
  1647. Attempts to convert a string representation of a hostname or IP
  1648. address to a <seealso cref="T:System.Net.IPAddress"/>
  1649. </summary>
  1650. <param name="hostname">Hostname to convert to an IPAddress</param>
  1651. <returns>Converted IP address object, or null if the conversion
  1652. failed</returns>
  1653. </member>
  1654. <member name="F:OpenMetaverse.Utils.EnUsCulture">
  1655. <summary>Provide a single instance of the CultureInfo class to
  1656. help parsing in situations where the grid assumes an en-us
  1657. culture</summary>
  1658. </member>
  1659. <member name="F:OpenMetaverse.Utils.Epoch">
  1660. <summary>UNIX epoch in DateTime format</summary>
  1661. </member>
  1662. <member name="F:OpenMetaverse.Utils.MD5Builder">
  1663. <summary>Provide a single instance of the MD5 class to avoid making
  1664. duplicate copies and handle thread safety</summary>
  1665. </member>
  1666. <member name="F:OpenMetaverse.Utils.SHA1Builder">
  1667. <summary>Provide a single instance of the SHA-1 class to avoid
  1668. making duplicate copies and handle thread safety</summary>
  1669. </member>
  1670. <member name="F:OpenMetaverse.Utils.RNG">
  1671. <summary>Provide a single instance of a random number generator
  1672. to avoid making duplicate copies and handle thread safety</summary>
  1673. </member>
  1674. <member name="M:OpenMetaverse.Utils.Clamp(System.Single,System.Single,System.Single)">
  1675. <summary>
  1676. Clamp a given value between a range
  1677. </summary>
  1678. <param name="value">Value to clamp</param>
  1679. <param name="min">Minimum allowable value</param>
  1680. <param name="max">Maximum allowable value</param>
  1681. <returns>A value inclusively between lower and upper</returns>
  1682. </member>
  1683. <member name="M:OpenMetaverse.Utils.Clamp(System.Double,System.Double,System.Double)">
  1684. <summary>
  1685. Clamp a given value between a range
  1686. </summary>
  1687. <param name="value">Value to clamp</param>
  1688. <param name="min">Minimum allowable value</param>
  1689. <param name="max">Maximum allowable value</param>
  1690. <returns>A value inclusively between lower and upper</returns>
  1691. </member>
  1692. <member name="M:OpenMetaverse.Utils.Clamp(System.Int32,System.Int32,System.Int32)">
  1693. <summary>
  1694. Clamp a given value between a range
  1695. </summary>
  1696. <param name="value">Value to clamp</param>
  1697. <param name="min">Minimum allowable value</param>
  1698. <param name="max">Maximum allowable value</param>
  1699. <returns>A value inclusively between lower and upper</returns>
  1700. </member>
  1701. <member name="M:OpenMetaverse.Utils.Round(System.Single)">
  1702. <summary>
  1703. Round a floating-point value to the nearest integer
  1704. </summary>
  1705. <param name="val">Floating point number to round</param>
  1706. <returns>Integer</returns>
  1707. </member>
  1708. <member name="M:OpenMetaverse.Utils.IsFinite(System.Single)">
  1709. <summary>
  1710. Test if a single precision float is a finite number
  1711. </summary>
  1712. </member>
  1713. <member name="M:OpenMetaverse.Utils.IsFinite(System.Double)">
  1714. <summary>
  1715. Test if a double precision float is a finite number
  1716. </summary>
  1717. </member>
  1718. <member name="M:OpenMetaverse.Utils.Distance(System.Single,System.Single)">
  1719. <summary>
  1720. Get the distance between two floating-point values
  1721. </summary>
  1722. <param name="value1">First value</param>
  1723. <param name="value2">Second value</param>
  1724. <returns>The distance between the two values</returns>
  1725. </member>
  1726. <member name="M:OpenMetaverse.Utils.MD5(System.Byte[])">
  1727. <summary>
  1728. Compute the MD5 hash for a byte array
  1729. </summary>
  1730. <param name="data">Byte array to compute the hash for</param>
  1731. <returns>MD5 hash of the input data</returns>
  1732. </member>
  1733. <member name="M:OpenMetaverse.Utils.SHA1(System.Byte[])">
  1734. <summary>
  1735. Compute the SHA1 hash for a byte array
  1736. </summary>
  1737. <param name="data">Byte array to compute the hash for</param>
  1738. <returns>SHA1 hash of the input data</returns>
  1739. </member>
  1740. <member name="M:OpenMetaverse.Utils.SHA1String(System.String)">
  1741. <summary>
  1742. Calculate the SHA1 hash of a given string
  1743. </summary>
  1744. <param name="value">The string to hash</param>
  1745. <returns>The SHA1 hash as a string</returns>
  1746. </member>
  1747. <member name="M:OpenMetaverse.Utils.SHA256(System.Byte[])">
  1748. <summary>
  1749. Compute the SHA256 hash for a byte array
  1750. </summary>
  1751. <param name="data">Byte array to compute the hash for</param>
  1752. <returns>SHA256 hash of the input data</returns>
  1753. </member>
  1754. <member name="M:OpenMetaverse.Utils.SHA256String(System.String)">
  1755. <summary>
  1756. Calculate the SHA256 hash of a given string
  1757. </summary>
  1758. <param name="value">The string to hash</param>
  1759. <returns>The SHA256 hash as a string</returns>
  1760. </member>
  1761. <member name="M:OpenMetaverse.Utils.MD5(System.String)">
  1762. <summary>
  1763. Calculate the MD5 hash of a given string
  1764. </summary>
  1765. <param name="password">The password to hash</param>
  1766. <returns>An MD5 hash in string format, with $1$ prepended</returns>
  1767. </member>
  1768. <member name="M:OpenMetaverse.Utils.MD5String(System.String)">
  1769. <summary>
  1770. Calculate the MD5 hash of a given string
  1771. </summary>
  1772. <param name="value">The string to hash</param>
  1773. <returns>The MD5 hash as a string</returns>
  1774. </member>
  1775. <member name="M:OpenMetaverse.Utils.RandomDouble">
  1776. <summary>
  1777. Generate a random double precision floating point value
  1778. </summary>
  1779. <returns>Random value of type double</returns>
  1780. </member>
  1781. <member name="M:OpenMetaverse.Utils.GetRunningPlatform">
  1782. <summary>
  1783. Get the current running platform
  1784. </summary>
  1785. <returns>Enumeration of the current platform we are running on</returns>
  1786. </member>
  1787. <member name="M:OpenMetaverse.Utils.GetRunningRuntime">
  1788. <summary>
  1789. Get the current running runtime
  1790. </summary>
  1791. <returns>Enumeration of the current runtime we are running on</returns>
  1792. </member>
  1793. <member name="T:OpenMetaverse.Utils.Platform">
  1794. <summary>
  1795. Operating system
  1796. </summary>
  1797. </member>
  1798. <member name="F:OpenMetaverse.Utils.Platform.Unknown">
  1799. <summary>Unknown</summary>
  1800. </member>
  1801. <member name="F:OpenMetaverse.Utils.Platform.Windows">
  1802. <summary>Microsoft Windows</summary>
  1803. </member>
  1804. <member name="F:OpenMetaverse.Utils.Platform.WindowsCE">
  1805. <summary>Microsoft Windows CE</summary>
  1806. </member>
  1807. <member name="F:OpenMetaverse.Utils.Platform.Linux">
  1808. <summary>Linux</summary>
  1809. </member>
  1810. <member name="F:OpenMetaverse.Utils.Platform.OSX">
  1811. <summary>Apple OSX</summary>
  1812. </member>
  1813. <member name="T:OpenMetaverse.Utils.Runtime">
  1814. <summary>
  1815. Runtime platform
  1816. </summary>
  1817. </member>
  1818. <member name="F:OpenMetaverse.Utils.Runtime.Windows">
  1819. <summary>.NET runtime</summary>
  1820. </member>
  1821. <member name="F:OpenMetaverse.Utils.Runtime.Mono">
  1822. <summary>Mono runtime: http://www.mono-project.com/</summary>
  1823. </member>
  1824. <member name="M:OpenMetaverse.ReaderWriterLockSlim.ExitAndWakeUpAppropriateWaiters">
  1825. <summary>
  1826. Determines the appropriate events to set, leaves the locks, and sets the events.
  1827. </summary>
  1828. </member>
  1829. <member name="M:OpenMetaverse.ReaderWriterLockSlim.LazyCreateEvent(System.Threading.EventWaitHandle@,System.Boolean)">
  1830. <summary>
  1831. A routine for lazily creating a event outside the lock (so if errors
  1832. happen they are outside the lock and that we don't do much work
  1833. while holding a spin lock). If all goes well, reenter the lock and
  1834. set 'waitEvent'
  1835. </summary>
  1836. </member>
  1837. <member name="M:OpenMetaverse.ReaderWriterLockSlim.WaitOnEvent(System.Threading.EventWaitHandle,System.UInt32@,System.Int32)">
  1838. <summary>
  1839. Waits on 'waitEvent' with a timeout of 'millisceondsTimeout.
  1840. Before the wait 'numWaiters' is incremented and is restored before leaving this routine.
  1841. </summary>
  1842. </member>
  1843. <member name="M:OpenMetaverse.CircularQueue`1.#ctor(OpenMetaverse.CircularQueue{`0})">
  1844. <summary>
  1845. Copy constructor
  1846. </summary>
  1847. <param name="queue">Circular queue to copy</param>
  1848. </member>
  1849. </members>
  1850. </doc>