Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 | 2100x 2100x 2100x 2100x 2100x 2100x 2100x 2100x 2100x 1x 6123x 2886x 2887x 1x 3173x 3173x 1x 3172x 26x 2x 24x 2x 3168x 3168x 3168x 3168x 3146x 22x 3168x 10x 7x 3x 3168x 3168x 1x 1123x 956x 956x 956x 956x 956x 7x 956x 940x 956x 956x 167x 1x 226x 226x 3x 226x 1x 4681x 4681x 4681x 2166x 2166x 2166x 2x 2166x 1783x 2166x 4681x 1x 1182x 24x 4x 20x 1x 7x 7x 6x 6x 5x 5x 5x 1x 7x 7x 6x 6x 5x 5x 1x 5x 5x 4x 4x 3x 3x 3x 1x 5x 5x 4x 4x 3x 3x 1x 9459x 1x 9458x 1x 24761x 3x 24758x 24758x 17970x 1x 12018x 12018x 16995x 16995x 5942x 1x 12049x 12049x 17007x 17007x 5954x 1x 11985x 11985x 16965x 16965x 5941x 1x 130x 1x 1706x 1706x | import createGuid from "../Core/createGuid.js";
import Frozen from "../Core/Frozen.js";
import defined from "../Core/defined.js";
import destroyObject from "../Core/destroyObject.js";
import DeveloperError from "../Core/DeveloperError.js";
import Event from "../Core/Event.js";
/**
* A collection of primitives. This is most often used with {@link Scene#primitives},
* but <code>PrimitiveCollection</code> is also a primitive itself so collections can
* be added to collections forming a hierarchy.
*
* @alias PrimitiveCollection
* @constructor
*
* @param {object} [options] Object with the following properties:
* @param {boolean} [options.show=true] Determines if the primitives in the collection will be shown.
* @param {boolean} [options.destroyPrimitives=true] Determines if primitives in the collection are destroyed when they are removed.
* @privateParam {boolean} [options.countReferences=false] Specifies whether adding and removing primitives from this collection alters their reference counts. If so, adding a
* primitive to this collection increments its reference count. Removing the primitive decrements its reference count and - if the count reaches zero **and** destroyPrimitives is true - destroys the primitive.
* This permits primitives to be shared between multiple collections.
*
* @example
* const billboards = new Cesium.BillboardCollection();
* const labels = new Cesium.LabelCollection();
*
* const collection = new Cesium.PrimitiveCollection();
* collection.add(billboards);
*
* scene.primitives.add(collection); // Add collection
* scene.primitives.add(labels); // Add regular primitive
*/
function PrimitiveCollection(options) {
options = options ?? Frozen.EMPTY_OBJECT;
this._primitives = [];
this._guid = createGuid();
this._primitiveAdded = new Event();
this._primitiveRemoved = new Event();
// Used by the OrderedGroundPrimitiveCollection
this._zIndex = undefined;
/**
* Determines if primitives in this collection will be shown.
*
* @type {boolean}
* @default true
*/
this.show = options.show ?? true;
/**
* Determines if primitives in the collection are destroyed when they are removed by
* {@link PrimitiveCollection#destroy} or {@link PrimitiveCollection#remove} or implicitly
* by {@link PrimitiveCollection#removeAll}.
*
* @type {boolean}
* @default true
*
* @example
* // Example 1. Primitives are destroyed by default.
* const primitives = new Cesium.PrimitiveCollection();
* const labels = primitives.add(new Cesium.LabelCollection());
* primitives = primitives.destroy();
* const b = labels.isDestroyed(); // true
*
* @example
* // Example 2. Do not destroy primitives in a collection.
* const primitives = new Cesium.PrimitiveCollection();
* primitives.destroyPrimitives = false;
* const labels = primitives.add(new Cesium.LabelCollection());
* primitives = primitives.destroy();
* const b = labels.isDestroyed(); // false
* labels = labels.destroy(); // explicitly destroy
*/
this.destroyPrimitives = options.destroyPrimitives ?? true;
this._countReferences = options.countReferences ?? false;
}
Object.defineProperties(PrimitiveCollection.prototype, {
/**
* Gets the number of primitives in the collection.
*
* @memberof PrimitiveCollection.prototype
*
* @type {number}
* @readonly
*/
length: {
get: function () {
return this._primitives.length;
},
},
/**
* An event that is raised when a primitive is added to the collection.
* Event handlers are passed the primitive that was added.
* @memberof PrimitiveCollection.prototype
* @type {Event}
* @readonly
*/
primitiveAdded: {
get: function () {
return this._primitiveAdded;
},
},
/**
* An event that is raised when a primitive is removed from the collection.
* Event handlers are passed the primitive that was removed.
* <p>
* Note: Depending on the destroyPrimitives constructor option, the primitive may already be destroyed.
* </p>
* @memberof PrimitiveCollection.prototype
* @type {Event}
* @readonly
*/
primitiveRemoved: {
get: function () {
return this._primitiveRemoved;
},
},
});
/**
* Adds a primitive to the collection.
*
* @param {object} primitive The primitive to add.
* @param {number} [index] The index to add the layer at. If omitted, the primitive will be added at the bottom of all existing primitives.
* @returns {object} The primitive added to the collection.
*
* @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
*
* @example
* const billboards = scene.primitives.add(new Cesium.BillboardCollection());
*/
PrimitiveCollection.prototype.add = function (primitive, index) {
const hasIndex = defined(index);
//>>includeStart('debug', pragmas.debug);
if (!defined(primitive)) {
throw new DeveloperError("primitive is required.");
}
if (hasIndex) {
if (index < 0) {
throw new DeveloperError("index must be greater than or equal to zero.");
} else if (index > this._primitives.length) {
throw new DeveloperError(
"index must be less than or equal to the number of primitives.",
);
}
}
//>>includeEnd('debug');
const external = (primitive._external = primitive._external || {});
const composites = (external._composites = external._composites || {});
composites[this._guid] = {
collection: this,
};
if (!hasIndex) {
this._primitives.push(primitive);
} else {
this._primitives.splice(index, 0, primitive);
}
if (this._countReferences) {
if (!defined(external._referenceCount)) {
external._referenceCount = 1;
} else {
++external._referenceCount;
}
}
this._primitiveAdded.raiseEvent(primitive);
return primitive;
};
/**
* Removes a primitive from the collection.
*
* @param {object} [primitive] The primitive to remove.
* @returns {boolean} <code>true</code> if the primitive was removed; <code>false</code> if the primitive is <code>undefined</code> or was not found in the collection.
*
* @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
*
*
* @example
* const billboards = scene.primitives.add(new Cesium.BillboardCollection());
* scene.primitives.remove(billboards); // Returns true
*
* @see PrimitiveCollection#destroyPrimitives
*/
PrimitiveCollection.prototype.remove = function (primitive) {
// PERFORMANCE_IDEA: We can obviously make this a lot faster.
if (this.contains(primitive)) {
const index = this._primitives.indexOf(primitive);
Eif (index !== -1) {
this._primitives.splice(index, 1);
delete primitive._external._composites[this._guid];
if (this._countReferences) {
primitive._external._referenceCount--;
}
if (
this.destroyPrimitives &&
(!this._countReferences || primitive._external._referenceCount <= 0)
) {
primitive.destroy();
}
this._primitiveRemoved.raiseEvent(primitive);
return true;
}
// else ... this is not possible, I swear.
}
return false;
};
/**
* Removes and destroys a primitive, regardless of destroyPrimitives or countReferences setting.
* @private
*/
PrimitiveCollection.prototype.removeAndDestroy = function (primitive) {
const removed = this.remove(primitive);
if (removed && !this.destroyPrimitives) {
primitive.destroy();
}
return removed;
};
/**
* Removes all primitives in the collection.
*
* @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
*
* @see PrimitiveCollection#destroyPrimitives
*/
PrimitiveCollection.prototype.removeAll = function () {
const primitives = this._primitives;
const length = primitives.length;
for (let i = 0; i < length; ++i) {
const primitive = primitives[i];
delete primitive._external._composites[this._guid];
if (this._countReferences) {
primitive._external._referenceCount--;
}
if (
this.destroyPrimitives &&
(!this._countReferences || primitive._external._referenceCount <= 0)
) {
primitive.destroy();
}
this._primitiveRemoved.raiseEvent(primitive);
}
this._primitives = [];
};
/**
* Determines if this collection contains a primitive.
*
* @param {object} [primitive] The primitive to check for.
* @returns {boolean} <code>true</code> if the primitive is in the collection; <code>false</code> if the primitive is <code>undefined</code> or was not found in the collection.
*
* @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
*
* @see PrimitiveCollection#get
*/
PrimitiveCollection.prototype.contains = function (primitive) {
return !!(
defined(primitive) &&
primitive._external &&
primitive._external._composites &&
primitive._external._composites[this._guid]
);
};
function getPrimitiveIndex(compositePrimitive, primitive) {
//>>includeStart('debug', pragmas.debug);
if (!compositePrimitive.contains(primitive)) {
throw new DeveloperError("primitive is not in this collection.");
}
//>>includeEnd('debug');
return compositePrimitive._primitives.indexOf(primitive);
}
/**
* Raises a primitive "up one" in the collection. If all primitives in the collection are drawn
* on the globe surface, this visually moves the primitive up one.
*
* @param {object} [primitive] The primitive to raise.
*
* @exception {DeveloperError} primitive is not in this collection.
* @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
*
* @see PrimitiveCollection#raiseToTop
* @see PrimitiveCollection#lower
* @see PrimitiveCollection#lowerToBottom
*/
PrimitiveCollection.prototype.raise = function (primitive) {
Eif (defined(primitive)) {
const index = getPrimitiveIndex(this, primitive);
const primitives = this._primitives;
if (index !== primitives.length - 1) {
const p = primitives[index];
primitives[index] = primitives[index + 1];
primitives[index + 1] = p;
}
}
};
/**
* Raises a primitive to the "top" of the collection. If all primitives in the collection are drawn
* on the globe surface, this visually moves the primitive to the top.
*
* @param {object} [primitive] The primitive to raise the top.
*
* @exception {DeveloperError} primitive is not in this collection.
* @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
*
* @see PrimitiveCollection#raise
* @see PrimitiveCollection#lower
* @see PrimitiveCollection#lowerToBottom
*/
PrimitiveCollection.prototype.raiseToTop = function (primitive) {
Eif (defined(primitive)) {
const index = getPrimitiveIndex(this, primitive);
const primitives = this._primitives;
if (index !== primitives.length - 1) {
// PERFORMANCE_IDEA: Could be faster
primitives.splice(index, 1);
primitives.push(primitive);
}
}
};
/**
* Lowers a primitive "down one" in the collection. If all primitives in the collection are drawn
* on the globe surface, this visually moves the primitive down one.
*
* @param {object} [primitive] The primitive to lower.
*
* @exception {DeveloperError} primitive is not in this collection.
* @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
*
* @see PrimitiveCollection#lowerToBottom
* @see PrimitiveCollection#raise
* @see PrimitiveCollection#raiseToTop
*/
PrimitiveCollection.prototype.lower = function (primitive) {
Eif (defined(primitive)) {
const index = getPrimitiveIndex(this, primitive);
const primitives = this._primitives;
if (index !== 0) {
const p = primitives[index];
primitives[index] = primitives[index - 1];
primitives[index - 1] = p;
}
}
};
/**
* Lowers a primitive to the "bottom" of the collection. If all primitives in the collection are drawn
* on the globe surface, this visually moves the primitive to the bottom.
*
* @param {object} [primitive] The primitive to lower to the bottom.
*
* @exception {DeveloperError} primitive is not in this collection.
* @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
*
* @see PrimitiveCollection#lower
* @see PrimitiveCollection#raise
* @see PrimitiveCollection#raiseToTop
*/
PrimitiveCollection.prototype.lowerToBottom = function (primitive) {
Eif (defined(primitive)) {
const index = getPrimitiveIndex(this, primitive);
const primitives = this._primitives;
if (index !== 0) {
// PERFORMANCE_IDEA: Could be faster
primitives.splice(index, 1);
primitives.unshift(primitive);
}
}
};
/**
* Returns the primitive in the collection at the specified index.
*
* @param {number} index The zero-based index of the primitive to return.
* @returns {object} The primitive at the <code>index</code>.
*
* @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
*
*
* @example
* // Toggle the show property of every primitive in the collection.
* const primitives = scene.primitives;
* const length = primitives.length;
* for (let i = 0; i < length; ++i) {
* const p = primitives.get(i);
* p.show = !p.show;
* }
*
* @see PrimitiveCollection#length
*/
PrimitiveCollection.prototype.get = function (index) {
//>>includeStart('debug', pragmas.debug);
if (!defined(index)) {
throw new DeveloperError("index is required.");
}
//>>includeEnd('debug');
return this._primitives[index];
};
/**
* @private
*/
PrimitiveCollection.prototype.update = function (frameState) {
if (!this.show) {
return;
}
const primitives = this._primitives;
// Using primitives.length in the loop is a temporary workaround
// to allow quadtree updates to add and remove primitives in
// update(). This will be changed to manage added and removed lists.
for (let i = 0; i < primitives.length; ++i) {
primitives[i].update(frameState);
}
};
/**
* @private
*/
PrimitiveCollection.prototype.prePassesUpdate = function (frameState) {
const primitives = this._primitives;
// Using primitives.length in the loop is a temporary workaround
// to allow quadtree updates to add and remove primitives in
// update(). This will be changed to manage added and removed lists.
for (let i = 0; i < primitives.length; ++i) {
const primitive = primitives[i];
if (defined(primitive.prePassesUpdate)) {
primitive.prePassesUpdate(frameState);
}
}
};
/**
* @private
*/
PrimitiveCollection.prototype.updateForPass = function (frameState, passState) {
const primitives = this._primitives;
// Using primitives.length in the loop is a temporary workaround
// to allow quadtree updates to add and remove primitives in
// update(). This will be changed to manage added and removed lists.
for (let i = 0; i < primitives.length; ++i) {
const primitive = primitives[i];
if (defined(primitive.updateForPass)) {
primitive.updateForPass(frameState, passState);
}
}
};
/**
* @private
*/
PrimitiveCollection.prototype.postPassesUpdate = function (frameState) {
const primitives = this._primitives;
// Using primitives.length in the loop is a temporary workaround
// to allow quadtree updates to add and remove primitives in
// update(). This will be changed to manage added and removed lists.
for (let i = 0; i < primitives.length; ++i) {
const primitive = primitives[i];
if (defined(primitive.postPassesUpdate)) {
primitive.postPassesUpdate(frameState);
}
}
};
/**
* Returns true if this object was destroyed; otherwise, false.
* <br /><br />
* If this object was destroyed, it should not be used; calling any function other than
* <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
*
* @returns {boolean} True if this object was destroyed; otherwise, false.
*
* @see PrimitiveCollection#destroy
*/
PrimitiveCollection.prototype.isDestroyed = function () {
return false;
};
/**
* Destroys the WebGL resources held by each primitive in this collection. Explicitly destroying this
* collection allows for deterministic release of WebGL resources, instead of relying on the garbage
* collector to destroy this collection.
* <br /><br />
* Since destroying a collection destroys all the contained primitives, only destroy a collection
* when you are sure no other code is still using any of the contained primitives.
* <br /><br />
* Once this collection is destroyed, it should not be used; calling any function other than
* <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
* assign the return value (<code>undefined</code>) to the object as done in the example.
*
* @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
*
*
* @example
* primitives = primitives && primitives.destroy();
*
* @see PrimitiveCollection#isDestroyed
*/
PrimitiveCollection.prototype.destroy = function () {
this.removeAll();
return destroyObject(this);
};
export default PrimitiveCollection;
|