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