aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework/LandData.cs
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--OpenSim/Framework/LandData.cs129
1 files changed, 128 insertions, 1 deletions
diff --git a/OpenSim/Framework/LandData.cs b/OpenSim/Framework/LandData.cs
index d6afb95..a24af04 100644
--- a/OpenSim/Framework/LandData.cs
+++ b/OpenSim/Framework/LandData.cs
@@ -31,6 +31,9 @@ using OpenMetaverse;
31 31
32namespace OpenSim.Framework 32namespace OpenSim.Framework
33{ 33{
34 /// <summary>
35 /// Details of a Parcel of land
36 /// </summary>
34 public class LandData 37 public class LandData
35 { 38 {
36 private Vector3 _AABBMax = new Vector3(); 39 private Vector3 _AABBMax = new Vector3();
@@ -80,6 +83,9 @@ namespace OpenSim.Framework
80 private int _dwell = 0; 83 private int _dwell = 0;
81 private int _otherCleanTime = 0; 84 private int _otherCleanTime = 0;
82 85
86 /// <summary>
87 /// Upper corner of the AABB for the parcel
88 /// </summary>
83 public Vector3 AABBMax { 89 public Vector3 AABBMax {
84 get { 90 get {
85 return _AABBMax; 91 return _AABBMax;
@@ -88,7 +94,9 @@ namespace OpenSim.Framework
88 _AABBMax = value; 94 _AABBMax = value;
89 } 95 }
90 } 96 }
91 97 /// <summary>
98 /// Lower corner of the AABB for the parcel
99 /// </summary>
92 public Vector3 AABBMin { 100 public Vector3 AABBMin {
93 get { 101 get {
94 return _AABBMin; 102 return _AABBMin;
@@ -98,6 +106,9 @@ namespace OpenSim.Framework
98 } 106 }
99 } 107 }
100 108
109 /// <summary>
110 /// Area in meters^2 the parcel contains
111 /// </summary>
101 public int Area { 112 public int Area {
102 get { 113 get {
103 return _area; 114 return _area;
@@ -107,6 +118,9 @@ namespace OpenSim.Framework
107 } 118 }
108 } 119 }
109 120
121 /// <summary>
122 /// ID of auction (3rd Party Integration) when parcel is being auctioned
123 /// </summary>
110 public uint AuctionID { 124 public uint AuctionID {
111 get { 125 get {
112 return _auctionID; 126 return _auctionID;
@@ -116,6 +130,9 @@ namespace OpenSim.Framework
116 } 130 }
117 } 131 }
118 132
133 /// <summary>
134 /// UUID of authorized buyer of parcel. This is UUID.Zero if anyone can buy it.
135 /// </summary>
119 public UUID AuthBuyerID { 136 public UUID AuthBuyerID {
120 get { 137 get {
121 return _authBuyerID; 138 return _authBuyerID;
@@ -125,6 +142,9 @@ namespace OpenSim.Framework
125 } 142 }
126 } 143 }
127 144
145 /// <summary>
146 /// Category of parcel. Used for classifying the parcel in classified listings
147 /// </summary>
128 public ParcelCategory Category { 148 public ParcelCategory Category {
129 get { 149 get {
130 return _category; 150 return _category;
@@ -134,6 +154,9 @@ namespace OpenSim.Framework
134 } 154 }
135 } 155 }
136 156
157 /// <summary>
158 /// Date that the current owner purchased or claimed the parcel
159 /// </summary>
137 public int ClaimDate { 160 public int ClaimDate {
138 get { 161 get {
139 return _claimDate; 162 return _claimDate;
@@ -143,6 +166,9 @@ namespace OpenSim.Framework
143 } 166 }
144 } 167 }
145 168
169 /// <summary>
170 /// The last price that the parcel was sold at
171 /// </summary>
146 public int ClaimPrice { 172 public int ClaimPrice {
147 get { 173 get {
148 return _claimPrice; 174 return _claimPrice;
@@ -152,6 +178,9 @@ namespace OpenSim.Framework
152 } 178 }
153 } 179 }
154 180
181 /// <summary>
182 /// Global ID for the parcel. (3rd Party Integration)
183 /// </summary>
155 public UUID GlobalID { 184 public UUID GlobalID {
156 get { 185 get {
157 return _globalID; 186 return _globalID;
@@ -161,6 +190,9 @@ namespace OpenSim.Framework
161 } 190 }
162 } 191 }
163 192
193 /// <summary>
194 /// Unique ID of the Group that owns
195 /// </summary>
164 public UUID GroupID { 196 public UUID GroupID {
165 get { 197 get {
166 return _groupID; 198 return _groupID;
@@ -170,6 +202,9 @@ namespace OpenSim.Framework
170 } 202 }
171 } 203 }
172 204
205 /// <summary>
206 /// Number of SceneObjectPart that are owned by a Group
207 /// </summary>
173 public int GroupPrims { 208 public int GroupPrims {
174 get { 209 get {
175 return _groupPrims; 210 return _groupPrims;
@@ -179,6 +214,9 @@ namespace OpenSim.Framework
179 } 214 }
180 } 215 }
181 216
217 /// <summary>
218 /// Returns true if the Land Parcel is owned by a group
219 /// </summary>
182 public bool IsGroupOwned { 220 public bool IsGroupOwned {
183 get { 221 get {
184 return _isGroupOwned; 222 return _isGroupOwned;
@@ -188,6 +226,9 @@ namespace OpenSim.Framework
188 } 226 }
189 } 227 }
190 228
229 /// <summary>
230 /// jp2 data for the image representative of the parcel in the parcel dialog
231 /// </summary>
191 public byte[] Bitmap { 232 public byte[] Bitmap {
192 get { 233 get {
193 return _bitmap; 234 return _bitmap;
@@ -197,6 +238,9 @@ namespace OpenSim.Framework
197 } 238 }
198 } 239 }
199 240
241 /// <summary>
242 /// Parcel Description
243 /// </summary>
200 public string Description { 244 public string Description {
201 get { 245 get {
202 return _description; 246 return _description;
@@ -206,6 +250,9 @@ namespace OpenSim.Framework
206 } 250 }
207 } 251 }
208 252
253 /// <summary>
254 /// Parcel settings. Access flags, Fly, NoPush, Voice, Scripts allowed, etc. ParcelFlags
255 /// </summary>
209 public uint Flags { 256 public uint Flags {
210 get { 257 get {
211 return _flags; 258 return _flags;
@@ -215,6 +262,10 @@ namespace OpenSim.Framework
215 } 262 }
216 } 263 }
217 264
265 /// <summary>
266 /// Determines if people are able to teleport where they please on the parcel or if they
267 /// get constrainted to a specific point on teleport within the parcel
268 /// </summary>
218 public byte LandingType { 269 public byte LandingType {
219 get { 270 get {
220 return _landingType; 271 return _landingType;
@@ -224,6 +275,9 @@ namespace OpenSim.Framework
224 } 275 }
225 } 276 }
226 277
278 /// <summary>
279 /// Parcel Name
280 /// </summary>
227 public string Name { 281 public string Name {
228 get { 282 get {
229 return _name; 283 return _name;
@@ -233,6 +287,9 @@ namespace OpenSim.Framework
233 } 287 }
234 } 288 }
235 289
290 /// <summary>
291 /// Status of Parcel, Leased, Abandoned, For Sale
292 /// </summary>
236 public ParcelStatus Status { 293 public ParcelStatus Status {
237 get { 294 get {
238 return _status; 295 return _status;
@@ -242,6 +299,9 @@ namespace OpenSim.Framework
242 } 299 }
243 } 300 }
244 301
302 /// <summary>
303 /// Internal ID of the parcel. Sometimes the client will try to use this value
304 /// </summary>
245 public int LocalID { 305 public int LocalID {
246 get { 306 get {
247 return _localID; 307 return _localID;
@@ -251,6 +311,9 @@ namespace OpenSim.Framework
251 } 311 }
252 } 312 }
253 313
314 /// <summary>
315 /// Determines if we scale the media based on the surface it's on
316 /// </summary>
254 public byte MediaAutoScale { 317 public byte MediaAutoScale {
255 get { 318 get {
256 return _mediaAutoScale; 319 return _mediaAutoScale;
@@ -260,6 +323,9 @@ namespace OpenSim.Framework
260 } 323 }
261 } 324 }
262 325
326 /// <summary>
327 /// Texture Guid to replace with the output of the media stream
328 /// </summary>
263 public UUID MediaID { 329 public UUID MediaID {
264 get { 330 get {
265 return _mediaID; 331 return _mediaID;
@@ -269,6 +335,9 @@ namespace OpenSim.Framework
269 } 335 }
270 } 336 }
271 337
338 /// <summary>
339 /// URL to the media file to display
340 /// </summary>
272 public string MediaURL { 341 public string MediaURL {
273 get { 342 get {
274 return _mediaURL; 343 return _mediaURL;
@@ -278,6 +347,9 @@ namespace OpenSim.Framework
278 } 347 }
279 } 348 }
280 349
350 /// <summary>
351 /// URL to the shoutcast music stream to play on the parcel
352 /// </summary>
281 public string MusicURL { 353 public string MusicURL {
282 get { 354 get {
283 return _musicURL; 355 return _musicURL;
@@ -287,6 +359,10 @@ namespace OpenSim.Framework
287 } 359 }
288 } 360 }
289 361
362 /// <summary>
363 /// Number of SceneObjectPart that are owned by users who do not own the parcel
364 /// and don't have the 'group. These are elegable for AutoReturn collection
365 /// </summary>
290 public int OtherPrims { 366 public int OtherPrims {
291 get { 367 get {
292 return _otherPrims; 368 return _otherPrims;
@@ -296,6 +372,10 @@ namespace OpenSim.Framework
296 } 372 }
297 } 373 }
298 374
375 /// <summary>
376 /// Owner Avatar or Group of the parcel. Naturally, all land masses must be
377 /// owned by someone
378 /// </summary>
299 public UUID OwnerID { 379 public UUID OwnerID {
300 get { 380 get {
301 return _ownerID; 381 return _ownerID;
@@ -305,6 +385,9 @@ namespace OpenSim.Framework
305 } 385 }
306 } 386 }
307 387
388 /// <summary>
389 /// Number of SceneObjectPart that are owned by the owner of the parcel
390 /// </summary>
308 public int OwnerPrims { 391 public int OwnerPrims {
309 get { 392 get {
310 return _ownerPrims; 393 return _ownerPrims;
@@ -314,6 +397,9 @@ namespace OpenSim.Framework
314 } 397 }
315 } 398 }
316 399
400 /// <summary>
401 /// List of access data for the parcel. User data, some bitflags, and a time
402 /// </summary>
317 public List<ParcelManager.ParcelAccessEntry> ParcelAccessList { 403 public List<ParcelManager.ParcelAccessEntry> ParcelAccessList {
318 get { 404 get {
319 return _parcelAccessList; 405 return _parcelAccessList;
@@ -323,6 +409,9 @@ namespace OpenSim.Framework
323 } 409 }
324 } 410 }
325 411
412 /// <summary>
413 /// How long in hours a Pass to the parcel is given
414 /// </summary>
326 public float PassHours { 415 public float PassHours {
327 get { 416 get {
328 return _passHours; 417 return _passHours;
@@ -332,6 +421,9 @@ namespace OpenSim.Framework
332 } 421 }
333 } 422 }
334 423
424 /// <summary>
425 /// Price to purchase a Pass to a restricted parcel
426 /// </summary>
335 public int PassPrice { 427 public int PassPrice {
336 get { 428 get {
337 return _passPrice; 429 return _passPrice;
@@ -341,6 +433,9 @@ namespace OpenSim.Framework
341 } 433 }
342 } 434 }
343 435
436 /// <summary>
437 /// When the parcel is being sold, this is the price to purchase the parcel
438 /// </summary>
344 public int SalePrice { 439 public int SalePrice {
345 get { 440 get {
346 return _salePrice; 441 return _salePrice;
@@ -350,6 +445,9 @@ namespace OpenSim.Framework
350 } 445 }
351 } 446 }
352 447
448 /// <summary>
449 /// Number of SceneObjectPart that are currently selected by avatar
450 /// </summary>
353 public int SelectedPrims { 451 public int SelectedPrims {
354 get { 452 get {
355 return _selectedPrims; 453 return _selectedPrims;
@@ -359,6 +457,9 @@ namespace OpenSim.Framework
359 } 457 }
360 } 458 }
361 459
460 /// <summary>
461 /// Number of meters^2 in the Simulator
462 /// </summary>
362 public int SimwideArea { 463 public int SimwideArea {
363 get { 464 get {
364 return _simwideArea; 465 return _simwideArea;
@@ -368,6 +469,9 @@ namespace OpenSim.Framework
368 } 469 }
369 } 470 }
370 471
472 /// <summary>
473 /// Number of SceneObjectPart in the Simulator
474 /// </summary>
371 public int SimwidePrims { 475 public int SimwidePrims {
372 get { 476 get {
373 return _simwidePrims; 477 return _simwidePrims;
@@ -377,6 +481,9 @@ namespace OpenSim.Framework
377 } 481 }
378 } 482 }
379 483
484 /// <summary>
485 /// ID of the snapshot used in the client parcel dialog of the parcel
486 /// </summary>
380 public UUID SnapshotID { 487 public UUID SnapshotID {
381 get { 488 get {
382 return _snapshotID; 489 return _snapshotID;
@@ -386,6 +493,10 @@ namespace OpenSim.Framework
386 } 493 }
387 } 494 }
388 495
496 /// <summary>
497 /// When teleporting is restricted to a certain point, this is the location
498 /// that the user will be redirected to
499 /// </summary>
389 public Vector3 UserLocation { 500 public Vector3 UserLocation {
390 get { 501 get {
391 return _userLocation; 502 return _userLocation;
@@ -395,6 +506,10 @@ namespace OpenSim.Framework
395 } 506 }
396 } 507 }
397 508
509 /// <summary>
510 /// When teleporting is restricted to a certain point, this is the rotation
511 /// that the user will be positioned
512 /// </summary>
398 public Vector3 UserLookAt { 513 public Vector3 UserLookAt {
399 get { 514 get {
400 return _userLookAt; 515 return _userLookAt;
@@ -404,6 +519,9 @@ namespace OpenSim.Framework
404 } 519 }
405 } 520 }
406 521
522 /// <summary>
523 /// Depreciated idea. Number of visitors ~= free money
524 /// </summary>
407 public int Dwell { 525 public int Dwell {
408 get { 526 get {
409 return _dwell; 527 return _dwell;
@@ -413,6 +531,10 @@ namespace OpenSim.Framework
413 } 531 }
414 } 532 }
415 533
534 /// <summary>
535 /// Number of minutes to return SceneObjectGroup that are owned by someone who doesn't own
536 /// the parcel and isn't set to the same 'group' as the parcel.
537 /// </summary>
416 public int OtherCleanTime { 538 public int OtherCleanTime {
417 get { 539 get {
418 return _otherCleanTime; 540 return _otherCleanTime;
@@ -422,11 +544,16 @@ namespace OpenSim.Framework
422 } 544 }
423 } 545 }
424 546
547
425 public LandData() 548 public LandData()
426 { 549 {
427 _globalID = UUID.Random(); 550 _globalID = UUID.Random();
428 } 551 }
429 552
553 /// <summary>
554 /// Make a new copy of the land data
555 /// </summary>
556 /// <returns></returns>
430 public LandData Copy() 557 public LandData Copy()
431 { 558 {
432 LandData landData = new LandData(); 559 LandData landData = new LandData();