@itwin/core-frontend
Version:
iTwin.js frontend components
69 lines • 3.03 kB
JavaScript
;
/*---------------------------------------------------------------------------------------------
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
* See LICENSE.md in the project root for license terms and full copyright notice.
*--------------------------------------------------------------------------------------------*/
/** @packageDocumentation
* @module Views
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.DecorationsCache = void 0;
const core_bentley_1 = require("@itwin/core-bentley");
function disposeCachedDecorations(decorations) {
for (const dec of decorations)
if ("graphic" === dec.type)
dec.graphicOwner.disposeGraphic();
}
/** A cache of decorations previously produced by a [[ViewportDecorator]] for which `useCachedDecorations` is `true`.
* The decorations are preserved until either:
* - The associated [[Viewport]]'s scene is invalidated; or
* - The decorator explicitly requests them to be discarded.
* The primary benefit is that cached decorations do not get recreated on every mouse motion.
* @internal
*/
class DecorationsCache {
_cache = new Map();
/** If true, attempts to remove entries from the cache will silently fail. This is set while a [[ScreenViewport]] is producing decorations
* to prevent poorly-written decorators from invalidating the cache while it is being populated by, e.g., calling [[Viewport.invalidateScene]].
*/
prohibitRemoval = false;
/** The number of decorators that have entries in the cache. */
get size() {
return this._cache.size;
}
/** Get the list of cached decorations for the decorator. */
get(decorator) {
return this._cache.get(decorator);
}
/** Add a decoration to the list of cached decorations for the decorator. */
add(decorator, decoration) {
(0, core_bentley_1.assert)(true === decorator.useCachedDecorations);
if (!decorator.useCachedDecorations)
return;
let decorations = this.get(decorator);
if (!decorations)
this._cache.set(decorator, decorations = []);
decorations.push(decoration);
}
/** Delete the decorator and all of its decorations, disposing of the decorations' graphics. */
delete(decorator) {
if (this.prohibitRemoval)
return;
(0, core_bentley_1.assert)(true === decorator.useCachedDecorations);
const decs = this._cache.get(decorator);
if (decs) {
disposeCachedDecorations(decs);
this._cache.delete(decorator);
}
}
/** Remove all decorators and their decorations from the cache, disposing of the decorations' graphics. */
clear() {
if (this.prohibitRemoval)
return;
for (const decorations of this._cache.values())
disposeCachedDecorations(decorations);
this._cache.clear();
}
}
exports.DecorationsCache = DecorationsCache;
//# sourceMappingURL=DecorationsCache.js.map