OpenMetaverseTypes.XML 91 KB

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