@itwin/core-backend 3.4.0-dev.8 → 3.5.0-dev.4

package/lib/cjs/DisplayStyle.js

@@ -1,257 +1,257 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module ViewDefinitions
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DisplayStyle3d = exports.DisplayStyle2d = exports.DisplayStyle = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_common_1 = require("@itwin/core-common");
-const Element_1 = require("./Element");
-/** A DisplayStyle defines the parameters for 'styling' the contents of a view.
- * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.
- * Many ViewDefinitions may share the same DisplayStyle.
- * @public
- */
-class DisplayStyle extends Element_1.DefinitionElement {
-    /** @internal */
-    static get className() { return "DisplayStyle"; }
-    /** @internal */
-    constructor(props, iModel) {
-        super(props, iModel);
-    }
-    /** Create a Code for a DisplayStyle given a name that is meant to be unique within the scope of the specified DefinitionModel.
-     * @param iModel  The IModelDb
-     * @param scopeModelId The Id of the DefinitionModel that contains the DisplayStyle and provides the scope for its name.
-     * @param codeValue The DisplayStyle name
-     */
-    static createCode(iModel, scopeModelId, codeValue) {
-        const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.displayStyle);
-        return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
-    }
-    /** @alpha */
-    collectReferenceIds(referenceIds) {
-        super.collectReferenceIds(referenceIds);
-        for (const [id] of this.settings.subCategoryOverrides) {
-            referenceIds.add(id);
-        }
-        for (const excludedElementId of this.settings.excludedElementIds)
-            referenceIds.add(excludedElementId);
-        if (this.settings.renderTimeline) {
-            referenceIds.add(this.settings.renderTimeline);
-        }
-        else {
-            const script = this.loadScheduleScript();
-            if (script)
-                script.script.discloseIds(referenceIds);
-        }
-    }
-    /** @alpha */
-    static onCloned(context, sourceElementProps, targetElementProps) {
-        var _a;
-        super.onCloned(context, sourceElementProps, targetElementProps);
-        if (!context.isBetweenIModels || !((_a = targetElementProps.jsonProperties) === null || _a === void 0 ? void 0 : _a.styles))
-            return;
-        const settings = targetElementProps.jsonProperties.styles;
-        if (settings.subCategoryOvr) {
-            for (let i = 0; i < settings.subCategoryOvr.length; /* */) {
-                const ovr = settings.subCategoryOvr[i];
-                ovr.subCategory = context.findTargetElementId(core_bentley_1.Id64.fromJSON(ovr.subCategory));
-                if (core_bentley_1.Id64.invalid === ovr.subCategory)
-                    settings.subCategoryOvr.splice(i, 1);
-                else
-                    i++;
-            }
-        }
-        if (settings.excludedElements) {
-            const excluded = "string" === typeof settings.excludedElements ? core_bentley_1.CompressedId64Set.decompressArray(settings.excludedElements) : settings.excludedElements;
-            for (let i = 0; i < excluded.length; /* */) {
-                const remapped = context.findTargetElementId(excluded[i]);
-                if (core_bentley_1.Id64.invalid === remapped)
-                    excluded.splice(i, 1);
-                else
-                    excluded[i++] = remapped;
-            }
-            if (0 === excluded.length)
-                delete settings.excludedElements;
-            else
-                settings.excludedElements = core_bentley_1.CompressedId64Set.compressIds(core_bentley_1.OrderedId64Iterable.sortArray(excluded));
-        }
-        if (settings.renderTimeline) {
-            const renderTimeline = context.findTargetElementId(settings.renderTimeline);
-            if (core_bentley_1.Id64.isValid(renderTimeline))
-                settings.renderTimeline = renderTimeline;
-            else
-                delete settings.renderTimeline;
-        }
-        else if (settings.scheduleScript) {
-            const scheduleScript = Element_1.RenderTimeline.remapScript(context, settings.scheduleScript);
-            if (scheduleScript.length > 0)
-                settings.scheduleScript = scheduleScript;
-            else
-                delete settings.scheduleScript;
-        }
-    }
-    loadScheduleScript() {
-        let script;
-        let sourceId;
-        if (this.settings.renderTimeline) {
-            const timeline = this.iModel.elements.tryGetElement(this.settings.renderTimeline);
-            if (timeline) {
-                script = core_common_1.RenderSchedule.Script.fromJSON(timeline.scriptProps);
-                sourceId = timeline.id;
-            }
-        }
-        else if (this.settings.scheduleScriptProps) {
-            script = core_common_1.RenderSchedule.Script.fromJSON(this.settings.scheduleScriptProps);
-            sourceId = this.id;
-        }
-        return undefined !== sourceId && undefined !== script ? new core_common_1.RenderSchedule.ScriptReference(sourceId, script) : undefined;
-    }
-}
-exports.DisplayStyle = DisplayStyle;
-/** A DisplayStyle for 2d views.
- * @public
- */
-class DisplayStyle2d extends DisplayStyle {
-    /** @internal */
-    constructor(props, iModel) {
-        super(props, iModel);
-        this._settings = new core_common_1.DisplayStyleSettings(this.jsonProperties);
-    }
-    /** @internal */
-    static get className() { return "DisplayStyle2d"; }
-    get settings() { return this._settings; }
-    /** Create a DisplayStyle2d for use by a ViewDefinition.
-     * @param iModelDb The iModel
-     * @param definitionModelId The [[DefinitionModel]]
-     * @param name The name/CodeValue of the DisplayStyle2d
-     * @returns The newly constructed DisplayStyle2d element.
-     * @throws [[IModelError]] if unable to create the element.
-     */
-    static create(iModelDb, definitionModelId, name) {
-        const displayStyleProps = {
-            classFullName: this.classFullName,
-            code: this.createCode(iModelDb, definitionModelId, name),
-            model: definitionModelId,
-            isPrivate: false,
-            jsonProperties: {
-                styles: {
-                    backgroundColor: 0,
-                    monochromeColor: core_common_1.ColorDef.white.toJSON(),
-                    viewflags: core_common_1.ViewFlags.defaults,
-                },
-            },
-        };
-        return new DisplayStyle2d(displayStyleProps, iModelDb);
-    }
-    /** Insert a DisplayStyle2d for use by a ViewDefinition.
-     * @param iModelDb Insert into this iModel
-     * @param definitionModelId Insert the new DisplayStyle2d into this DefinitionModel
-     * @param name The name of the DisplayStyle2d
-     * @returns The Id of the newly inserted DisplayStyle2d element.
-     * @throws [[IModelError]] if unable to insert the element.
-     */
-    static insert(iModelDb, definitionModelId, name) {
-        const displayStyle = this.create(iModelDb, definitionModelId, name);
-        return iModelDb.elements.insertElement(displayStyle.toJSON());
-    }
-}
-exports.DisplayStyle2d = DisplayStyle2d;
-/** A DisplayStyle for 3d views.
- * See [how to create a DisplayStyle3d]$(docs/learning/backend/CreateElements.md#DisplayStyle3d).
- * @public
- */
-class DisplayStyle3d extends DisplayStyle {
-    /** @internal */
-    constructor(props, iModel) {
-        super(props, iModel);
-        this._settings = new core_common_1.DisplayStyle3dSettings(this.jsonProperties);
-    }
-    /** @internal */
-    static get className() { return "DisplayStyle3d"; }
-    get settings() { return this._settings; }
-    /** @alpha */
-    collectReferenceIds(referenceIds) {
-        super.collectReferenceIds(referenceIds);
-        for (const textureId of this.settings.environment.sky.textureIds)
-            referenceIds.add(textureId);
-        if (this.settings.planProjectionSettings)
-            for (const planProjectionSetting of this.settings.planProjectionSettings)
-                referenceIds.add(planProjectionSetting[0]);
-    }
-    /** @alpha */
-    static onCloned(context, sourceElementProps, targetElementProps) {
-        var _a, _b, _c, _d, _e, _f;
-        super.onCloned(context, sourceElementProps, targetElementProps);
-        if (context.isBetweenIModels) {
-            const convertTexture = (id) => core_bentley_1.Id64.isValidId64(id) ? context.findTargetElementId(id) : id;
-            const skyBoxImageProps = (_d = (_c = (_b = (_a = targetElementProps === null || targetElementProps === void 0 ? void 0 : targetElementProps.jsonProperties) === null || _a === void 0 ? void 0 : _a.styles) === null || _b === void 0 ? void 0 : _b.environment) === null || _c === void 0 ? void 0 : _c.sky) === null || _d === void 0 ? void 0 : _d.image;
-            if ((skyBoxImageProps === null || skyBoxImageProps === void 0 ? void 0 : skyBoxImageProps.texture) && core_bentley_1.Id64.isValidId64(skyBoxImageProps.texture))
-                skyBoxImageProps.texture = convertTexture(skyBoxImageProps.texture);
-            if (skyBoxImageProps === null || skyBoxImageProps === void 0 ? void 0 : skyBoxImageProps.textures) {
-                skyBoxImageProps.textures.front = convertTexture(skyBoxImageProps.textures.front);
-                skyBoxImageProps.textures.back = convertTexture(skyBoxImageProps.textures.back);
-                skyBoxImageProps.textures.left = convertTexture(skyBoxImageProps.textures.left);
-                skyBoxImageProps.textures.right = convertTexture(skyBoxImageProps.textures.right);
-                skyBoxImageProps.textures.top = convertTexture(skyBoxImageProps.textures.top);
-                skyBoxImageProps.textures.bottom = convertTexture(skyBoxImageProps.textures.bottom);
-            }
-            if ((_f = (_e = targetElementProps === null || targetElementProps === void 0 ? void 0 : targetElementProps.jsonProperties) === null || _e === void 0 ? void 0 : _e.styles) === null || _f === void 0 ? void 0 : _f.planProjections) {
-                const remappedPlanProjections = {};
-                for (const entry of Object.entries(targetElementProps.jsonProperties.styles.planProjections)) {
-                    const remappedModelId = context.findTargetElementId(entry[0]);
-                    if (core_bentley_1.Id64.isValidId64(remappedModelId)) {
-                        remappedPlanProjections[remappedModelId] = entry[1];
-                    }
-                }
-                targetElementProps.jsonProperties.styles.planProjections = remappedPlanProjections;
-            }
-        }
-    }
-    /** Create a DisplayStyle3d for use by a ViewDefinition.
-     * @param iModelDb The iModel
-     * @param definitionModelId The [[DefinitionModel]]
-     * @param name The name/CodeValue of the DisplayStyle3d
-     * @returns The newly constructed DisplayStyle3d element.
-     * @throws [[IModelError]] if unable to create the element.
-     */
-    static create(iModelDb, definitionModelId, name, options) {
-        var _a, _b;
-        options = options !== null && options !== void 0 ? options : {};
-        let viewflags = (_a = options.viewFlags) === null || _a === void 0 ? void 0 : _a.toJSON();
-        if (!viewflags)
-            viewflags = (_b = options.viewflags) !== null && _b !== void 0 ? _b : new core_common_1.ViewFlags().toJSON();
-        const backgroundColor = options.backgroundColor instanceof core_common_1.ColorDef ? options.backgroundColor.toJSON() : options.backgroundColor;
-        const settings = {
-            ...options,
-            viewflags,
-            backgroundColor,
-        };
-        const displayStyleProps = {
-            classFullName: this.classFullName,
-            code: this.createCode(iModelDb, definitionModelId, name),
-            model: definitionModelId,
-            jsonProperties: { styles: settings },
-            isPrivate: false,
-        };
-        return new DisplayStyle3d(displayStyleProps, iModelDb);
-    }
-    /**
-     * Insert a DisplayStyle3d for use by a ViewDefinition.
-     * @param iModelDb Insert into this iModel
-     * @param definitionModelId Insert the new DisplayStyle3d into this [[DefinitionModel]]
-     * @param name The name of the DisplayStyle3d
-     * @returns The Id of the newly inserted DisplayStyle3d element.
-     * @throws [[IModelError]] if unable to insert the element.
-     */
-    static insert(iModelDb, definitionModelId, name, options) {
-        const displayStyle = this.create(iModelDb, definitionModelId, name, options);
-        return iModelDb.elements.insertElement(displayStyle.toJSON());
-    }
-}
-exports.DisplayStyle3d = DisplayStyle3d;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ViewDefinitions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DisplayStyle3d = exports.DisplayStyle2d = exports.DisplayStyle = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const Element_1 = require("./Element");
+/** A DisplayStyle defines the parameters for 'styling' the contents of a view.
+ * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.
+ * Many ViewDefinitions may share the same DisplayStyle.
+ * @public
+ */
+class DisplayStyle extends Element_1.DefinitionElement {
+    /** @internal */
+    static get className() { return "DisplayStyle"; }
+    /** @internal */
+    constructor(props, iModel) {
+        super(props, iModel);
+    }
+    /** Create a Code for a DisplayStyle given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModelDb
+     * @param scopeModelId The Id of the DefinitionModel that contains the DisplayStyle and provides the scope for its name.
+     * @param codeValue The DisplayStyle name
+     */
+    static createCode(iModel, scopeModelId, codeValue) {
+        const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.displayStyle);
+        return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
+    }
+    /** @alpha */
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
+        for (const [id] of this.settings.subCategoryOverrides) {
+            referenceIds.add(id);
+        }
+        for (const excludedElementId of this.settings.excludedElementIds)
+            referenceIds.add(excludedElementId);
+        if (this.settings.renderTimeline) {
+            referenceIds.add(this.settings.renderTimeline);
+        }
+        else {
+            const script = this.loadScheduleScript();
+            if (script)
+                script.script.discloseIds(referenceIds);
+        }
+    }
+    /** @alpha */
+    static onCloned(context, sourceElementProps, targetElementProps) {
+        var _a;
+        super.onCloned(context, sourceElementProps, targetElementProps);
+        if (!context.isBetweenIModels || !((_a = targetElementProps.jsonProperties) === null || _a === void 0 ? void 0 : _a.styles))
+            return;
+        const settings = targetElementProps.jsonProperties.styles;
+        if (settings.subCategoryOvr) {
+            for (let i = 0; i < settings.subCategoryOvr.length; /* */) {
+                const ovr = settings.subCategoryOvr[i];
+                ovr.subCategory = context.findTargetElementId(core_bentley_1.Id64.fromJSON(ovr.subCategory));
+                if (core_bentley_1.Id64.invalid === ovr.subCategory)
+                    settings.subCategoryOvr.splice(i, 1);
+                else
+                    i++;
+            }
+        }
+        if (settings.excludedElements) {
+            const excluded = "string" === typeof settings.excludedElements ? core_bentley_1.CompressedId64Set.decompressArray(settings.excludedElements) : settings.excludedElements;
+            for (let i = 0; i < excluded.length; /* */) {
+                const remapped = context.findTargetElementId(excluded[i]);
+                if (core_bentley_1.Id64.invalid === remapped)
+                    excluded.splice(i, 1);
+                else
+                    excluded[i++] = remapped;
+            }
+            if (0 === excluded.length)
+                delete settings.excludedElements;
+            else
+                settings.excludedElements = core_bentley_1.CompressedId64Set.compressIds(core_bentley_1.OrderedId64Iterable.sortArray(excluded));
+        }
+        if (settings.renderTimeline) {
+            const renderTimeline = context.findTargetElementId(settings.renderTimeline);
+            if (core_bentley_1.Id64.isValid(renderTimeline))
+                settings.renderTimeline = renderTimeline;
+            else
+                delete settings.renderTimeline;
+        }
+        else if (settings.scheduleScript) {
+            const scheduleScript = Element_1.RenderTimeline.remapScript(context, settings.scheduleScript);
+            if (scheduleScript.length > 0)
+                settings.scheduleScript = scheduleScript;
+            else
+                delete settings.scheduleScript;
+        }
+    }
+    loadScheduleScript() {
+        let script;
+        let sourceId;
+        if (this.settings.renderTimeline) {
+            const timeline = this.iModel.elements.tryGetElement(this.settings.renderTimeline);
+            if (timeline) {
+                script = core_common_1.RenderSchedule.Script.fromJSON(timeline.scriptProps);
+                sourceId = timeline.id;
+            }
+        }
+        else if (this.settings.scheduleScriptProps) {
+            script = core_common_1.RenderSchedule.Script.fromJSON(this.settings.scheduleScriptProps);
+            sourceId = this.id;
+        }
+        return undefined !== sourceId && undefined !== script ? new core_common_1.RenderSchedule.ScriptReference(sourceId, script) : undefined;
+    }
+}
+exports.DisplayStyle = DisplayStyle;
+/** A DisplayStyle for 2d views.
+ * @public
+ */
+class DisplayStyle2d extends DisplayStyle {
+    /** @internal */
+    constructor(props, iModel) {
+        super(props, iModel);
+        this._settings = new core_common_1.DisplayStyleSettings(this.jsonProperties);
+    }
+    /** @internal */
+    static get className() { return "DisplayStyle2d"; }
+    get settings() { return this._settings; }
+    /** Create a DisplayStyle2d for use by a ViewDefinition.
+     * @param iModelDb The iModel
+     * @param definitionModelId The [[DefinitionModel]]
+     * @param name The name/CodeValue of the DisplayStyle2d
+     * @returns The newly constructed DisplayStyle2d element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(iModelDb, definitionModelId, name) {
+        const displayStyleProps = {
+            classFullName: this.classFullName,
+            code: this.createCode(iModelDb, definitionModelId, name),
+            model: definitionModelId,
+            isPrivate: false,
+            jsonProperties: {
+                styles: {
+                    backgroundColor: 0,
+                    monochromeColor: core_common_1.ColorDef.white.toJSON(),
+                    viewflags: core_common_1.ViewFlags.defaults,
+                },
+            },
+        };
+        return new DisplayStyle2d(displayStyleProps, iModelDb);
+    }
+    /** Insert a DisplayStyle2d for use by a ViewDefinition.
+     * @param iModelDb Insert into this iModel
+     * @param definitionModelId Insert the new DisplayStyle2d into this DefinitionModel
+     * @param name The name of the DisplayStyle2d
+     * @returns The Id of the newly inserted DisplayStyle2d element.
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    static insert(iModelDb, definitionModelId, name) {
+        const displayStyle = this.create(iModelDb, definitionModelId, name);
+        return iModelDb.elements.insertElement(displayStyle.toJSON());
+    }
+}
+exports.DisplayStyle2d = DisplayStyle2d;
+/** A DisplayStyle for 3d views.
+ * See [how to create a DisplayStyle3d]$(docs/learning/backend/CreateElements.md#DisplayStyle3d).
+ * @public
+ */
+class DisplayStyle3d extends DisplayStyle {
+    /** @internal */
+    constructor(props, iModel) {
+        super(props, iModel);
+        this._settings = new core_common_1.DisplayStyle3dSettings(this.jsonProperties);
+    }
+    /** @internal */
+    static get className() { return "DisplayStyle3d"; }
+    get settings() { return this._settings; }
+    /** @alpha */
+    collectReferenceIds(referenceIds) {
+        super.collectReferenceIds(referenceIds);
+        for (const textureId of this.settings.environment.sky.textureIds)
+            referenceIds.add(textureId);
+        if (this.settings.planProjectionSettings)
+            for (const planProjectionSetting of this.settings.planProjectionSettings)
+                referenceIds.add(planProjectionSetting[0]);
+    }
+    /** @alpha */
+    static onCloned(context, sourceElementProps, targetElementProps) {
+        var _a, _b, _c, _d, _e, _f;
+        super.onCloned(context, sourceElementProps, targetElementProps);
+        if (context.isBetweenIModels) {
+            const convertTexture = (id) => core_bentley_1.Id64.isValidId64(id) ? context.findTargetElementId(id) : id;
+            const skyBoxImageProps = (_d = (_c = (_b = (_a = targetElementProps === null || targetElementProps === void 0 ? void 0 : targetElementProps.jsonProperties) === null || _a === void 0 ? void 0 : _a.styles) === null || _b === void 0 ? void 0 : _b.environment) === null || _c === void 0 ? void 0 : _c.sky) === null || _d === void 0 ? void 0 : _d.image;
+            if ((skyBoxImageProps === null || skyBoxImageProps === void 0 ? void 0 : skyBoxImageProps.texture) && core_bentley_1.Id64.isValidId64(skyBoxImageProps.texture))
+                skyBoxImageProps.texture = convertTexture(skyBoxImageProps.texture);
+            if (skyBoxImageProps === null || skyBoxImageProps === void 0 ? void 0 : skyBoxImageProps.textures) {
+                skyBoxImageProps.textures.front = convertTexture(skyBoxImageProps.textures.front);
+                skyBoxImageProps.textures.back = convertTexture(skyBoxImageProps.textures.back);
+                skyBoxImageProps.textures.left = convertTexture(skyBoxImageProps.textures.left);
+                skyBoxImageProps.textures.right = convertTexture(skyBoxImageProps.textures.right);
+                skyBoxImageProps.textures.top = convertTexture(skyBoxImageProps.textures.top);
+                skyBoxImageProps.textures.bottom = convertTexture(skyBoxImageProps.textures.bottom);
+            }
+            if ((_f = (_e = targetElementProps === null || targetElementProps === void 0 ? void 0 : targetElementProps.jsonProperties) === null || _e === void 0 ? void 0 : _e.styles) === null || _f === void 0 ? void 0 : _f.planProjections) {
+                const remappedPlanProjections = {};
+                for (const entry of Object.entries(targetElementProps.jsonProperties.styles.planProjections)) {
+                    const remappedModelId = context.findTargetElementId(entry[0]);
+                    if (core_bentley_1.Id64.isValidId64(remappedModelId)) {
+                        remappedPlanProjections[remappedModelId] = entry[1];
+                    }
+                }
+                targetElementProps.jsonProperties.styles.planProjections = remappedPlanProjections;
+            }
+        }
+    }
+    /** Create a DisplayStyle3d for use by a ViewDefinition.
+     * @param iModelDb The iModel
+     * @param definitionModelId The [[DefinitionModel]]
+     * @param name The name/CodeValue of the DisplayStyle3d
+     * @returns The newly constructed DisplayStyle3d element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(iModelDb, definitionModelId, name, options) {
+        var _a, _b;
+        options = options !== null && options !== void 0 ? options : {};
+        let viewflags = (_a = options.viewFlags) === null || _a === void 0 ? void 0 : _a.toJSON();
+        if (!viewflags)
+            viewflags = (_b = options.viewflags) !== null && _b !== void 0 ? _b : new core_common_1.ViewFlags().toJSON();
+        const backgroundColor = options.backgroundColor instanceof core_common_1.ColorDef ? options.backgroundColor.toJSON() : options.backgroundColor;
+        const settings = {
+            ...options,
+            viewflags,
+            backgroundColor,
+        };
+        const displayStyleProps = {
+            classFullName: this.classFullName,
+            code: this.createCode(iModelDb, definitionModelId, name),
+            model: definitionModelId,
+            jsonProperties: { styles: settings },
+            isPrivate: false,
+        };
+        return new DisplayStyle3d(displayStyleProps, iModelDb);
+    }
+    /**
+     * Insert a DisplayStyle3d for use by a ViewDefinition.
+     * @param iModelDb Insert into this iModel
+     * @param definitionModelId Insert the new DisplayStyle3d into this [[DefinitionModel]]
+     * @param name The name of the DisplayStyle3d
+     * @returns The Id of the newly inserted DisplayStyle3d element.
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    static insert(iModelDb, definitionModelId, name, options) {
+        const displayStyle = this.create(iModelDb, definitionModelId, name, options);
+        return iModelDb.elements.insertElement(displayStyle.toJSON());
+    }
+}
+exports.DisplayStyle3d = DisplayStyle3d;
 //# sourceMappingURL=DisplayStyle.js.map

package/lib/cjs/DisplayStyle.js.map

@@ -1 +1 @@
-{"version":3,"file":"DisplayStyle.js","sourceRoot":"","sources":["../../src/DisplayStyle.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAmH;AACnH,oDAG4B;AAC5B,uCAA8D;AAI9D;;;;GAIG;AACH,MAAsB,YAAa,SAAQ,2BAAiB;IAC1D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IAGzE,gBAAgB;IAChB,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,YAAY,CAAC,CAAC;QAChF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,aAAa;IACM,mBAAmB,CAAC,YAAqB;QAC1D,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,oBAAoB,EAAE;YACrD,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACtB;QAED,KAAK,MAAM,iBAAiB,IAAI,IAAI,CAAC,QAAQ,CAAC,kBAAkB;YAC9D,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAEtC,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;YAChC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;SAChD;aAAM;YACL,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACzC,IAAI,MAAM;gBACR,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;SAC3C;IACH,CAAC;IAED,aAAa;IACH,MAAM,CAAU,QAAQ,CAAC,OAA2B,EAAE,kBAAqC,EAAE,kBAAqC;;QAC1I,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAEhE,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,CAAC,CAAA,MAAA,kBAAkB,CAAC,cAAc,0CAAE,MAAM,CAAA;YACzE,OAAO;QAET,MAAM,QAAQ,GAAG,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC;QAC1D,IAAI,QAAQ,CAAC,cAAc,EAAE;YAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE;gBACzD,MAAM,GAAG,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;gBACvC,GAAG,CAAC,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC9E,IAAI,mBAAI,CAAC,OAAO,KAAK,GAAG,CAAC,WAAW;oBAClC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;oBAErC,CAAC,EAAE,CAAC;aACP;SACF;QAED,IAAI,QAAQ,CAAC,gBAAgB,EAAE;YAC7B,MAAM,QAAQ,GAAc,QAAQ,KAAK,OAAO,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,gCAAiB,CAAC,eAAe,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YACrK,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE;gBAC1C,MAAM,QAAQ,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,mBAAI,CAAC,OAAO,KAAK,QAAQ;oBAC3B,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;oBAEtB,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC;aAC5B;YAED,IAAI,CAAC,KAAK,QAAQ,CAAC,MAAM;gBACvB,OAAO,QAAQ,CAAC,gBAAgB,CAAC;;gBAEjC,QAAQ,CAAC,gBAAgB,GAAG,gCAAiB,CAAC,WAAW,CAAC,kCAAmB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;SACtG;QAED,IAAI,QAAQ,CAAC,cAAc,EAAE;YAC3B,MAAM,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAC5E,IAAI,mBAAI,CAAC,OAAO,CAAC,cAAc,CAAC;gBAC9B,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;;gBAEzC,OAAO,QAAQ,CAAC,cAAc,CAAC;SAClC;aAAM,IAAI,QAAQ,CAAC,cAAc,EAAE;YAClC,MAAM,cAAc,GAAG,wBAAc,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;YACpF,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC;gBAC3B,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;;gBAEzC,OAAO,QAAQ,CAAC,cAAc,CAAC;SAClC;IACH,CAAC;IAEM,kBAAkB;QACvB,IAAI,MAAM,CAAC;QACX,IAAI,QAAQ,CAAC;QACb,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;YAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAiB,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAClG,IAAI,QAAQ,EAAE;gBACZ,MAAM,GAAG,4BAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;gBAC9D,QAAQ,GAAG,QAAQ,CAAC,EAAE,CAAC;aACxB;SACF;aAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE;YAC5C,MAAM,GAAG,4BAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;YAC3E,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAC;SACpB;QAED,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,4BAAc,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3H,CAAC;CACF;AAzGD,oCAyGC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,YAAY;IAO9C,gBAAgB;IAChB,YAAmB,KAAwB,EAAE,MAAgB;QAC3D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,kCAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACjE,CAAC;IAVD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAG3E,IAAW,QAAQ,KAA2B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAOtE;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,iBAAiB,GAAsB;YAC3C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,KAAK,EAAE,iBAAiB;YACxB,SAAS,EAAE,KAAK;YAChB,cAAc,EAAE;gBACd,MAAM,EAAE;oBACN,eAAe,EAAE,CAAC;oBAClB,eAAe,EAAE,sBAAQ,CAAC,KAAK,CAAC,MAAM,EAAE;oBACxC,SAAS,EAAE,uBAAS,CAAC,QAAQ;iBAC9B;aACF;SACF,CAAC;QACF,OAAO,IAAI,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AA9CD,wCA8CC;AAkBD;;;GAGG;AACH,MAAa,cAAe,SAAQ,YAAY;IAO9C,gBAAgB;IAChB,YAAmB,KAA0B,EAAE,MAAgB;QAC7D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,oCAAsB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACnE,CAAC;IAVD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAG3E,IAAW,QAAQ,KAA6B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAQxE,aAAa;IACM,mBAAmB,CAAC,YAAqB;QAC1D,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU;YAC9D,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAE9B,IAAI,IAAI,CAAC,QAAQ,CAAC,sBAAsB;YACtC,KAAK,MAAM,qBAAqB,IAAI,IAAI,CAAC,QAAQ,CAAC,sBAAsB;gBACtE,YAAY,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,aAAa;IACH,MAAM,CAAU,QAAQ,CAAC,OAA2B,EAAE,kBAAuC,EAAE,kBAAuC;;QAC9I,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAChE,IAAI,OAAO,CAAC,gBAAgB,EAAE;YAC5B,MAAM,cAAc,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,mBAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAEnG,MAAM,gBAAgB,GAAiC,MAAA,MAAA,MAAA,MAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,cAAc,0CAAE,MAAM,0CAAE,WAAW,0CAAE,GAAG,0CAAE,KAAK,CAAC;YAC3H,IAAI,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,KAAI,mBAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC;gBACzE,gBAAgB,CAAC,OAAO,GAAG,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAEtE,IAAI,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,QAAQ,EAAE;gBAC9B,gBAAgB,CAAC,QAAQ,CAAC,KAAK,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAClF,gBAAgB,CAAC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAChF,gBAAgB,CAAC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAChF,gBAAgB,CAAC,QAAQ,CAAC,KAAK,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAClF,gBAAgB,CAAC,QAAQ,CAAC,GAAG,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC9E,gBAAgB,CAAC,QAAQ,CAAC,MAAM,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;aACrF;YAED,IAAI,MAAA,MAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,cAAc,0CAAE,MAAM,0CAAE,eAAe,EAAE;gBAC/D,MAAM,uBAAuB,GAAuD,EAAE,CAAC;gBACvF,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE;oBAC5F,MAAM,eAAe,GAAe,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC1E,IAAI,mBAAI,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE;wBACrC,uBAAuB,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;qBACrD;iBACF;gBACD,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,GAAG,uBAAuB,CAAC;aACpF;SACF;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,OAAqC;;QACzH,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QACxB,IAAI,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,0CAAE,MAAM,EAAE,CAAC;QAC5C,IAAI,CAAC,SAAS;YACZ,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,IAAI,uBAAS,EAAE,CAAC,MAAM,EAAE,CAAC;QAE5D,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,YAAY,sBAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;QAEjI,MAAM,QAAQ,GAAgC;YAC5C,GAAG,OAAO;YACV,SAAS;YACT,eAAe;SAChB,CAAC;QAEF,MAAM,iBAAiB,GAAwB;YAC7C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,KAAK,EAAE,iBAAiB;YACxB,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE;YACpC,SAAS,EAAE,KAAK;SAEjB,CAAC;QAEF,OAAO,IAAI,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,OAAqC;QACzH,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7E,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AApGD,wCAoGC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module ViewDefinitions\r\n */\r\n\r\nimport { CompressedId64Set, Id64, Id64Array, Id64Set, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\r\nimport {\r\n  BisCodeSpec, Code, CodeScopeProps, CodeSpec, ColorDef, DisplayStyle3dProps, DisplayStyle3dSettings, DisplayStyle3dSettingsProps,\r\n  DisplayStyleProps, DisplayStyleSettings, PlanProjectionSettingsProps, RenderSchedule, SkyBoxImageProps, ViewFlags,\r\n} from \"@itwin/core-common\";\r\nimport { DefinitionElement, RenderTimeline } from \"./Element\";\r\nimport { IModelCloneContext } from \"./IModelCloneContext\";\r\nimport { IModelDb } from \"./IModelDb\";\r\n\r\n/** A DisplayStyle defines the parameters for 'styling' the contents of a view.\r\n * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.\r\n * Many ViewDefinitions may share the same DisplayStyle.\r\n * @public\r\n */\r\nexport abstract class DisplayStyle extends DefinitionElement {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DisplayStyle\"; }\r\n  public abstract get settings(): DisplayStyleSettings;\r\n\r\n  /** @internal */\r\n  protected constructor(props: DisplayStyleProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n  }\r\n\r\n  /** Create a Code for a DisplayStyle given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModelDb\r\n   * @param scopeModelId The Id of the DefinitionModel that contains the DisplayStyle and provides the scope for its name.\r\n   * @param codeValue The DisplayStyle name\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.displayStyle);\r\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\r\n  }\r\n\r\n  /** @alpha */\r\n  protected override collectReferenceIds(referenceIds: Id64Set): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    for (const [id] of this.settings.subCategoryOverrides) {\r\n      referenceIds.add(id);\r\n    }\r\n\r\n    for (const excludedElementId of this.settings.excludedElementIds)\r\n      referenceIds.add(excludedElementId);\r\n\r\n    if (this.settings.renderTimeline) {\r\n      referenceIds.add(this.settings.renderTimeline);\r\n    } else {\r\n      const script = this.loadScheduleScript();\r\n      if (script)\r\n        script.script.discloseIds(referenceIds);\r\n    }\r\n  }\r\n\r\n  /** @alpha */\r\n  protected static override onCloned(context: IModelCloneContext, sourceElementProps: DisplayStyleProps, targetElementProps: DisplayStyleProps): void {\r\n    super.onCloned(context, sourceElementProps, targetElementProps);\r\n\r\n    if (!context.isBetweenIModels || !targetElementProps.jsonProperties?.styles)\r\n      return;\r\n\r\n    const settings = targetElementProps.jsonProperties.styles;\r\n    if (settings.subCategoryOvr) {\r\n      for (let i = 0; i < settings.subCategoryOvr.length; /* */) {\r\n        const ovr = settings.subCategoryOvr[i];\r\n        ovr.subCategory = context.findTargetElementId(Id64.fromJSON(ovr.subCategory));\r\n        if (Id64.invalid === ovr.subCategory)\r\n          settings.subCategoryOvr.splice(i, 1);\r\n        else\r\n          i++;\r\n      }\r\n    }\r\n\r\n    if (settings.excludedElements) {\r\n      const excluded: Id64Array = \"string\" === typeof settings.excludedElements ? CompressedId64Set.decompressArray(settings.excludedElements) : settings.excludedElements;\r\n      for (let i = 0; i < excluded.length; /* */) {\r\n        const remapped = context.findTargetElementId(excluded[i]);\r\n        if (Id64.invalid === remapped)\r\n          excluded.splice(i, 1);\r\n        else\r\n          excluded[i++] = remapped;\r\n      }\r\n\r\n      if (0 === excluded.length)\r\n        delete settings.excludedElements;\r\n      else\r\n        settings.excludedElements = CompressedId64Set.compressIds(OrderedId64Iterable.sortArray(excluded));\r\n    }\r\n\r\n    if (settings.renderTimeline) {\r\n      const renderTimeline = context.findTargetElementId(settings.renderTimeline);\r\n      if (Id64.isValid(renderTimeline))\r\n        settings.renderTimeline = renderTimeline;\r\n      else\r\n        delete settings.renderTimeline;\r\n    } else if (settings.scheduleScript) {\r\n      const scheduleScript = RenderTimeline.remapScript(context, settings.scheduleScript);\r\n      if (scheduleScript.length > 0)\r\n        settings.scheduleScript = scheduleScript;\r\n      else\r\n        delete settings.scheduleScript;\r\n    }\r\n  }\r\n\r\n  public loadScheduleScript(): RenderSchedule.ScriptReference | undefined {\r\n    let script;\r\n    let sourceId;\r\n    if (this.settings.renderTimeline) {\r\n      const timeline = this.iModel.elements.tryGetElement<RenderTimeline>(this.settings.renderTimeline);\r\n      if (timeline) {\r\n        script = RenderSchedule.Script.fromJSON(timeline.scriptProps);\r\n        sourceId = timeline.id;\r\n      }\r\n    } else if (this.settings.scheduleScriptProps) {\r\n      script = RenderSchedule.Script.fromJSON(this.settings.scheduleScriptProps);\r\n      sourceId = this.id;\r\n    }\r\n\r\n    return undefined !== sourceId && undefined !== script ? new RenderSchedule.ScriptReference(sourceId, script) : undefined;\r\n  }\r\n}\r\n\r\n/** A DisplayStyle for 2d views.\r\n * @public\r\n */\r\nexport class DisplayStyle2d extends DisplayStyle {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DisplayStyle2d\"; }\r\n  private readonly _settings: DisplayStyleSettings;\r\n\r\n  public get settings(): DisplayStyleSettings { return this._settings; }\r\n\r\n  /** @internal */\r\n  public constructor(props: DisplayStyleProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this._settings = new DisplayStyleSettings(this.jsonProperties);\r\n  }\r\n  /** Create a DisplayStyle2d for use by a ViewDefinition.\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name/CodeValue of the DisplayStyle2d\r\n   * @returns The newly constructed DisplayStyle2d element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DisplayStyle2d {\r\n    const displayStyleProps: DisplayStyleProps = {\r\n      classFullName: this.classFullName,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      model: definitionModelId,\r\n      isPrivate: false,\r\n      jsonProperties: {\r\n        styles: {\r\n          backgroundColor: 0,\r\n          monochromeColor: ColorDef.white.toJSON(),\r\n          viewflags: ViewFlags.defaults,\r\n        },\r\n      },\r\n    };\r\n    return new DisplayStyle2d(displayStyleProps, iModelDb);\r\n  }\r\n  /** Insert a DisplayStyle2d for use by a ViewDefinition.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param definitionModelId Insert the new DisplayStyle2d into this DefinitionModel\r\n   * @param name The name of the DisplayStyle2d\r\n   * @returns The Id of the newly inserted DisplayStyle2d element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string): Id64String {\r\n    const displayStyle = this.create(iModelDb, definitionModelId, name);\r\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\r\n  }\r\n}\r\n\r\n/** Describes initial settings for a new [[DisplayStyle3d]].\r\n * Most properties are inherited from [DisplayStyle3dSettingsProps]($common), but for backwards compatibility reasons, this interface is slightly awkward:\r\n * - It adds a `viewFlags` member that differs only in case and type from [DisplayStyleSettingsProps.viewflags]($common); and\r\n * - It extends the type of [DisplayStyleSettingsProps.backgroundColor]($common) to include [ColorDef]($common).\r\n * These idiosyncrasies will be addressed in a future version of core-backend.\r\n * @see [[DisplayStyle3d.create]].\r\n * @public\r\n */\r\nexport interface DisplayStyleCreationOptions extends Omit<DisplayStyle3dSettingsProps, \"backgroundColor\" | \"scheduleScript\"> {\r\n  /** If supplied, the [ViewFlags]($common) applied by the display style.\r\n   * If undefined, [DisplayStyle3dSettingsProps.viewflags]($common) will be used if present (note the difference in case); otherwise, default-constructed [ViewFlags]($common) will be used.\r\n   */\r\n  viewFlags?: ViewFlags;\r\n  backgroundColor?: ColorDef | number;\r\n}\r\n\r\n/** A DisplayStyle for 3d views.\r\n * See [how to create a DisplayStyle3d]$(docs/learning/backend/CreateElements.md#DisplayStyle3d).\r\n * @public\r\n */\r\nexport class DisplayStyle3d extends DisplayStyle {\r\n  /** @internal */\r\n  public static override get className(): string { return \"DisplayStyle3d\"; }\r\n  private readonly _settings: DisplayStyle3dSettings;\r\n\r\n  public get settings(): DisplayStyle3dSettings { return this._settings; }\r\n\r\n  /** @internal */\r\n  public constructor(props: DisplayStyle3dProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this._settings = new DisplayStyle3dSettings(this.jsonProperties);\r\n  }\r\n\r\n  /** @alpha */\r\n  protected override collectReferenceIds(referenceIds: Id64Set): void {\r\n    super.collectReferenceIds(referenceIds);\r\n    for (const textureId of this.settings.environment.sky.textureIds)\r\n      referenceIds.add(textureId);\r\n\r\n    if (this.settings.planProjectionSettings)\r\n      for (const planProjectionSetting of this.settings.planProjectionSettings)\r\n        referenceIds.add(planProjectionSetting[0]);\r\n  }\r\n\r\n  /** @alpha */\r\n  protected static override onCloned(context: IModelCloneContext, sourceElementProps: DisplayStyle3dProps, targetElementProps: DisplayStyle3dProps): void {\r\n    super.onCloned(context, sourceElementProps, targetElementProps);\r\n    if (context.isBetweenIModels) {\r\n      const convertTexture = (id: string) => Id64.isValidId64(id) ? context.findTargetElementId(id) : id;\r\n\r\n      const skyBoxImageProps: SkyBoxImageProps | undefined = targetElementProps?.jsonProperties?.styles?.environment?.sky?.image;\r\n      if (skyBoxImageProps?.texture && Id64.isValidId64(skyBoxImageProps.texture))\r\n        skyBoxImageProps.texture = convertTexture(skyBoxImageProps.texture);\r\n\r\n      if (skyBoxImageProps?.textures) {\r\n        skyBoxImageProps.textures.front = convertTexture(skyBoxImageProps.textures.front);\r\n        skyBoxImageProps.textures.back = convertTexture(skyBoxImageProps.textures.back);\r\n        skyBoxImageProps.textures.left = convertTexture(skyBoxImageProps.textures.left);\r\n        skyBoxImageProps.textures.right = convertTexture(skyBoxImageProps.textures.right);\r\n        skyBoxImageProps.textures.top = convertTexture(skyBoxImageProps.textures.top);\r\n        skyBoxImageProps.textures.bottom = convertTexture(skyBoxImageProps.textures.bottom);\r\n      }\r\n\r\n      if (targetElementProps?.jsonProperties?.styles?.planProjections) {\r\n        const remappedPlanProjections: { [modelId: string]: PlanProjectionSettingsProps } = {};\r\n        for (const entry of Object.entries(targetElementProps.jsonProperties.styles.planProjections)) {\r\n          const remappedModelId: Id64String = context.findTargetElementId(entry[0]);\r\n          if (Id64.isValidId64(remappedModelId)) {\r\n            remappedPlanProjections[remappedModelId] = entry[1];\r\n          }\r\n        }\r\n        targetElementProps.jsonProperties.styles.planProjections = remappedPlanProjections;\r\n      }\r\n    }\r\n  }\r\n\r\n  /** Create a DisplayStyle3d for use by a ViewDefinition.\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param name The name/CodeValue of the DisplayStyle3d\r\n   * @returns The newly constructed DisplayStyle3d element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): DisplayStyle3d {\r\n    options = options ?? {};\r\n    let viewflags = options.viewFlags?.toJSON();\r\n    if (!viewflags)\r\n      viewflags = options.viewflags ?? new ViewFlags().toJSON();\r\n\r\n    const backgroundColor = options.backgroundColor instanceof ColorDef ? options.backgroundColor.toJSON() : options.backgroundColor;\r\n\r\n    const settings: DisplayStyle3dSettingsProps = {\r\n      ...options,\r\n      viewflags,\r\n      backgroundColor,\r\n    };\r\n\r\n    const displayStyleProps: DisplayStyle3dProps = {\r\n      classFullName: this.classFullName,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n      model: definitionModelId,\r\n      jsonProperties: { styles: settings },\r\n      isPrivate: false,\r\n\r\n    };\r\n\r\n    return new DisplayStyle3d(displayStyleProps, iModelDb);\r\n  }\r\n  /**\r\n   * Insert a DisplayStyle3d for use by a ViewDefinition.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param definitionModelId Insert the new DisplayStyle3d into this [[DefinitionModel]]\r\n   * @param name The name of the DisplayStyle3d\r\n   * @returns The Id of the newly inserted DisplayStyle3d element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): Id64String {\r\n    const displayStyle = this.create(iModelDb, definitionModelId, name, options);\r\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"DisplayStyle.js","sourceRoot":"","sources":["../../src/DisplayStyle.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAmH;AACnH,oDAG4B;AAC5B,uCAA8D;AAI9D;;;;GAIG;AACH,MAAsB,YAAa,SAAQ,2BAAiB;IAC1D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,cAAc,CAAC,CAAC,CAAC;IAGzE,gBAAgB;IAChB,YAAsB,KAAwB,EAAE,MAAgB;QAC9D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,YAAY,CAAC,CAAC;QAChF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED,aAAa;IACM,mBAAmB,CAAC,YAAqB;QAC1D,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,KAAK,MAAM,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,oBAAoB,EAAE;YACrD,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACtB;QAED,KAAK,MAAM,iBAAiB,IAAI,IAAI,CAAC,QAAQ,CAAC,kBAAkB;YAC9D,YAAY,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAEtC,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;YAChC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;SAChD;aAAM;YACL,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACzC,IAAI,MAAM;gBACR,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;SAC3C;IACH,CAAC;IAED,aAAa;IACH,MAAM,CAAU,QAAQ,CAAC,OAA2B,EAAE,kBAAqC,EAAE,kBAAqC;;QAC1I,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAEhE,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,CAAC,CAAA,MAAA,kBAAkB,CAAC,cAAc,0CAAE,MAAM,CAAA;YACzE,OAAO;QAET,MAAM,QAAQ,GAAG,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC;QAC1D,IAAI,QAAQ,CAAC,cAAc,EAAE;YAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE;gBACzD,MAAM,GAAG,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;gBACvC,GAAG,CAAC,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;gBAC9E,IAAI,mBAAI,CAAC,OAAO,KAAK,GAAG,CAAC,WAAW;oBAClC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;oBAErC,CAAC,EAAE,CAAC;aACP;SACF;QAED,IAAI,QAAQ,CAAC,gBAAgB,EAAE;YAC7B,MAAM,QAAQ,GAAc,QAAQ,KAAK,OAAO,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,gCAAiB,CAAC,eAAe,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YACrK,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE;gBAC1C,MAAM,QAAQ,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC1D,IAAI,mBAAI,CAAC,OAAO,KAAK,QAAQ;oBAC3B,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;;oBAEtB,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC;aAC5B;YAED,IAAI,CAAC,KAAK,QAAQ,CAAC,MAAM;gBACvB,OAAO,QAAQ,CAAC,gBAAgB,CAAC;;gBAEjC,QAAQ,CAAC,gBAAgB,GAAG,gCAAiB,CAAC,WAAW,CAAC,kCAAmB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;SACtG;QAED,IAAI,QAAQ,CAAC,cAAc,EAAE;YAC3B,MAAM,cAAc,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAC5E,IAAI,mBAAI,CAAC,OAAO,CAAC,cAAc,CAAC;gBAC9B,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;;gBAEzC,OAAO,QAAQ,CAAC,cAAc,CAAC;SAClC;aAAM,IAAI,QAAQ,CAAC,cAAc,EAAE;YAClC,MAAM,cAAc,GAAG,wBAAc,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;YACpF,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC;gBAC3B,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;;gBAEzC,OAAO,QAAQ,CAAC,cAAc,CAAC;SAClC;IACH,CAAC;IAEM,kBAAkB;QACvB,IAAI,MAAM,CAAC;QACX,IAAI,QAAQ,CAAC;QACb,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE;YAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAiB,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YAClG,IAAI,QAAQ,EAAE;gBACZ,MAAM,GAAG,4BAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;gBAC9D,QAAQ,GAAG,QAAQ,CAAC,EAAE,CAAC;aACxB;SACF;aAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,mBAAmB,EAAE;YAC5C,MAAM,GAAG,4BAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;YAC3E,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAC;SACpB;QAED,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,4BAAc,CAAC,eAAe,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3H,CAAC;CACF;AAzGD,oCAyGC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,YAAY;IAO9C,gBAAgB;IAChB,YAAmB,KAAwB,EAAE,MAAgB;QAC3D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,kCAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACjE,CAAC;IAVD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAG3E,IAAW,QAAQ,KAA2B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAOtE;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,iBAAiB,GAAsB;YAC3C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,KAAK,EAAE,iBAAiB;YACxB,SAAS,EAAE,KAAK;YAChB,cAAc,EAAE;gBACd,MAAM,EAAE;oBACN,eAAe,EAAE,CAAC;oBAClB,eAAe,EAAE,sBAAQ,CAAC,KAAK,CAAC,MAAM,EAAE;oBACxC,SAAS,EAAE,uBAAS,CAAC,QAAQ;iBAC9B;aACF;SACF,CAAC;QACF,OAAO,IAAI,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AA9CD,wCA8CC;AAkBD;;;GAGG;AACH,MAAa,cAAe,SAAQ,YAAY;IAO9C,gBAAgB;IAChB,YAAmB,KAA0B,EAAE,MAAgB;QAC7D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,oCAAsB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACnE,CAAC;IAVD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAG3E,IAAW,QAAQ,KAA6B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAQxE,aAAa;IACM,mBAAmB,CAAC,YAAqB;QAC1D,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACxC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU;YAC9D,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAE9B,IAAI,IAAI,CAAC,QAAQ,CAAC,sBAAsB;YACtC,KAAK,MAAM,qBAAqB,IAAI,IAAI,CAAC,QAAQ,CAAC,sBAAsB;gBACtE,YAAY,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,aAAa;IACH,MAAM,CAAU,QAAQ,CAAC,OAA2B,EAAE,kBAAuC,EAAE,kBAAuC;;QAC9I,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAC;QAChE,IAAI,OAAO,CAAC,gBAAgB,EAAE;YAC5B,MAAM,cAAc,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,mBAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAEnG,MAAM,gBAAgB,GAAiC,MAAA,MAAA,MAAA,MAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,cAAc,0CAAE,MAAM,0CAAE,WAAW,0CAAE,GAAG,0CAAE,KAAK,CAAC;YAC3H,IAAI,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,OAAO,KAAI,mBAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,OAAO,CAAC;gBACzE,gBAAgB,CAAC,OAAO,GAAG,cAAc,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAEtE,IAAI,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,QAAQ,EAAE;gBAC9B,gBAAgB,CAAC,QAAQ,CAAC,KAAK,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAClF,gBAAgB,CAAC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAChF,gBAAgB,CAAC,QAAQ,CAAC,IAAI,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAChF,gBAAgB,CAAC,QAAQ,CAAC,KAAK,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAClF,gBAAgB,CAAC,QAAQ,CAAC,GAAG,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC9E,gBAAgB,CAAC,QAAQ,CAAC,MAAM,GAAG,cAAc,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;aACrF;YAED,IAAI,MAAA,MAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,cAAc,0CAAE,MAAM,0CAAE,eAAe,EAAE;gBAC/D,MAAM,uBAAuB,GAAuD,EAAE,CAAC;gBACvF,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE;oBAC5F,MAAM,eAAe,GAAe,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC1E,IAAI,mBAAI,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE;wBACrC,uBAAuB,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;qBACrD;iBACF;gBACD,kBAAkB,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,GAAG,uBAAuB,CAAC;aACpF;SACF;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,OAAqC;;QACzH,OAAO,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;QACxB,IAAI,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,0CAAE,MAAM,EAAE,CAAC;QAC5C,IAAI,CAAC,SAAS;YACZ,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,mCAAI,IAAI,uBAAS,EAAE,CAAC,MAAM,EAAE,CAAC;QAE5D,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,YAAY,sBAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;QAEjI,MAAM,QAAQ,GAAgC;YAC5C,GAAG,OAAO;YACV,SAAS;YACT,eAAe;SAChB,CAAC;QAEF,MAAM,iBAAiB,GAAwB;YAC7C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,KAAK,EAAE,iBAAiB;YACxB,cAAc,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE;YACpC,SAAS,EAAE,KAAK;SAEjB,CAAC;QAEF,OAAO,IAAI,cAAc,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,OAAqC;QACzH,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7E,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AApGD,wCAoGC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module ViewDefinitions\n */\n\nimport { CompressedId64Set, Id64, Id64Array, Id64Set, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\nimport {\n  BisCodeSpec, Code, CodeScopeProps, CodeSpec, ColorDef, DisplayStyle3dProps, DisplayStyle3dSettings, DisplayStyle3dSettingsProps,\n  DisplayStyleProps, DisplayStyleSettings, PlanProjectionSettingsProps, RenderSchedule, SkyBoxImageProps, ViewFlags,\n} from \"@itwin/core-common\";\nimport { DefinitionElement, RenderTimeline } from \"./Element\";\nimport { IModelCloneContext } from \"./IModelCloneContext\";\nimport { IModelDb } from \"./IModelDb\";\n\n/** A DisplayStyle defines the parameters for 'styling' the contents of a view.\n * Internally a DisplayStyle consists of a dictionary of several named 'styles' describing specific aspects of the display style as a whole.\n * Many ViewDefinitions may share the same DisplayStyle.\n * @public\n */\nexport abstract class DisplayStyle extends DefinitionElement {\n  /** @internal */\n  public static override get className(): string { return \"DisplayStyle\"; }\n  public abstract get settings(): DisplayStyleSettings;\n\n  /** @internal */\n  protected constructor(props: DisplayStyleProps, iModel: IModelDb) {\n    super(props, iModel);\n  }\n\n  /** Create a Code for a DisplayStyle given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModelDb\n   * @param scopeModelId The Id of the DefinitionModel that contains the DisplayStyle and provides the scope for its name.\n   * @param codeValue The DisplayStyle name\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.displayStyle);\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  /** @alpha */\n  protected override collectReferenceIds(referenceIds: Id64Set): void {\n    super.collectReferenceIds(referenceIds);\n    for (const [id] of this.settings.subCategoryOverrides) {\n      referenceIds.add(id);\n    }\n\n    for (const excludedElementId of this.settings.excludedElementIds)\n      referenceIds.add(excludedElementId);\n\n    if (this.settings.renderTimeline) {\n      referenceIds.add(this.settings.renderTimeline);\n    } else {\n      const script = this.loadScheduleScript();\n      if (script)\n        script.script.discloseIds(referenceIds);\n    }\n  }\n\n  /** @alpha */\n  protected static override onCloned(context: IModelCloneContext, sourceElementProps: DisplayStyleProps, targetElementProps: DisplayStyleProps): void {\n    super.onCloned(context, sourceElementProps, targetElementProps);\n\n    if (!context.isBetweenIModels || !targetElementProps.jsonProperties?.styles)\n      return;\n\n    const settings = targetElementProps.jsonProperties.styles;\n    if (settings.subCategoryOvr) {\n      for (let i = 0; i < settings.subCategoryOvr.length; /* */) {\n        const ovr = settings.subCategoryOvr[i];\n        ovr.subCategory = context.findTargetElementId(Id64.fromJSON(ovr.subCategory));\n        if (Id64.invalid === ovr.subCategory)\n          settings.subCategoryOvr.splice(i, 1);\n        else\n          i++;\n      }\n    }\n\n    if (settings.excludedElements) {\n      const excluded: Id64Array = \"string\" === typeof settings.excludedElements ? CompressedId64Set.decompressArray(settings.excludedElements) : settings.excludedElements;\n      for (let i = 0; i < excluded.length; /* */) {\n        const remapped = context.findTargetElementId(excluded[i]);\n        if (Id64.invalid === remapped)\n          excluded.splice(i, 1);\n        else\n          excluded[i++] = remapped;\n      }\n\n      if (0 === excluded.length)\n        delete settings.excludedElements;\n      else\n        settings.excludedElements = CompressedId64Set.compressIds(OrderedId64Iterable.sortArray(excluded));\n    }\n\n    if (settings.renderTimeline) {\n      const renderTimeline = context.findTargetElementId(settings.renderTimeline);\n      if (Id64.isValid(renderTimeline))\n        settings.renderTimeline = renderTimeline;\n      else\n        delete settings.renderTimeline;\n    } else if (settings.scheduleScript) {\n      const scheduleScript = RenderTimeline.remapScript(context, settings.scheduleScript);\n      if (scheduleScript.length > 0)\n        settings.scheduleScript = scheduleScript;\n      else\n        delete settings.scheduleScript;\n    }\n  }\n\n  public loadScheduleScript(): RenderSchedule.ScriptReference | undefined {\n    let script;\n    let sourceId;\n    if (this.settings.renderTimeline) {\n      const timeline = this.iModel.elements.tryGetElement<RenderTimeline>(this.settings.renderTimeline);\n      if (timeline) {\n        script = RenderSchedule.Script.fromJSON(timeline.scriptProps);\n        sourceId = timeline.id;\n      }\n    } else if (this.settings.scheduleScriptProps) {\n      script = RenderSchedule.Script.fromJSON(this.settings.scheduleScriptProps);\n      sourceId = this.id;\n    }\n\n    return undefined !== sourceId && undefined !== script ? new RenderSchedule.ScriptReference(sourceId, script) : undefined;\n  }\n}\n\n/** A DisplayStyle for 2d views.\n * @public\n */\nexport class DisplayStyle2d extends DisplayStyle {\n  /** @internal */\n  public static override get className(): string { return \"DisplayStyle2d\"; }\n  private readonly _settings: DisplayStyleSettings;\n\n  public get settings(): DisplayStyleSettings { return this._settings; }\n\n  /** @internal */\n  public constructor(props: DisplayStyleProps, iModel: IModelDb) {\n    super(props, iModel);\n    this._settings = new DisplayStyleSettings(this.jsonProperties);\n  }\n  /** Create a DisplayStyle2d for use by a ViewDefinition.\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name/CodeValue of the DisplayStyle2d\n   * @returns The newly constructed DisplayStyle2d element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DisplayStyle2d {\n    const displayStyleProps: DisplayStyleProps = {\n      classFullName: this.classFullName,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      model: definitionModelId,\n      isPrivate: false,\n      jsonProperties: {\n        styles: {\n          backgroundColor: 0,\n          monochromeColor: ColorDef.white.toJSON(),\n          viewflags: ViewFlags.defaults,\n        },\n      },\n    };\n    return new DisplayStyle2d(displayStyleProps, iModelDb);\n  }\n  /** Insert a DisplayStyle2d for use by a ViewDefinition.\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new DisplayStyle2d into this DefinitionModel\n   * @param name The name of the DisplayStyle2d\n   * @returns The Id of the newly inserted DisplayStyle2d element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string): Id64String {\n    const displayStyle = this.create(iModelDb, definitionModelId, name);\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\n  }\n}\n\n/** Describes initial settings for a new [[DisplayStyle3d]].\n * Most properties are inherited from [DisplayStyle3dSettingsProps]($common), but for backwards compatibility reasons, this interface is slightly awkward:\n * - It adds a `viewFlags` member that differs only in case and type from [DisplayStyleSettingsProps.viewflags]($common); and\n * - It extends the type of [DisplayStyleSettingsProps.backgroundColor]($common) to include [ColorDef]($common).\n * These idiosyncrasies will be addressed in a future version of core-backend.\n * @see [[DisplayStyle3d.create]].\n * @public\n */\nexport interface DisplayStyleCreationOptions extends Omit<DisplayStyle3dSettingsProps, \"backgroundColor\" | \"scheduleScript\"> {\n  /** If supplied, the [ViewFlags]($common) applied by the display style.\n   * If undefined, [DisplayStyle3dSettingsProps.viewflags]($common) will be used if present (note the difference in case); otherwise, default-constructed [ViewFlags]($common) will be used.\n   */\n  viewFlags?: ViewFlags;\n  backgroundColor?: ColorDef | number;\n}\n\n/** A DisplayStyle for 3d views.\n * See [how to create a DisplayStyle3d]$(docs/learning/backend/CreateElements.md#DisplayStyle3d).\n * @public\n */\nexport class DisplayStyle3d extends DisplayStyle {\n  /** @internal */\n  public static override get className(): string { return \"DisplayStyle3d\"; }\n  private readonly _settings: DisplayStyle3dSettings;\n\n  public get settings(): DisplayStyle3dSettings { return this._settings; }\n\n  /** @internal */\n  public constructor(props: DisplayStyle3dProps, iModel: IModelDb) {\n    super(props, iModel);\n    this._settings = new DisplayStyle3dSettings(this.jsonProperties);\n  }\n\n  /** @alpha */\n  protected override collectReferenceIds(referenceIds: Id64Set): void {\n    super.collectReferenceIds(referenceIds);\n    for (const textureId of this.settings.environment.sky.textureIds)\n      referenceIds.add(textureId);\n\n    if (this.settings.planProjectionSettings)\n      for (const planProjectionSetting of this.settings.planProjectionSettings)\n        referenceIds.add(planProjectionSetting[0]);\n  }\n\n  /** @alpha */\n  protected static override onCloned(context: IModelCloneContext, sourceElementProps: DisplayStyle3dProps, targetElementProps: DisplayStyle3dProps): void {\n    super.onCloned(context, sourceElementProps, targetElementProps);\n    if (context.isBetweenIModels) {\n      const convertTexture = (id: string) => Id64.isValidId64(id) ? context.findTargetElementId(id) : id;\n\n      const skyBoxImageProps: SkyBoxImageProps | undefined = targetElementProps?.jsonProperties?.styles?.environment?.sky?.image;\n      if (skyBoxImageProps?.texture && Id64.isValidId64(skyBoxImageProps.texture))\n        skyBoxImageProps.texture = convertTexture(skyBoxImageProps.texture);\n\n      if (skyBoxImageProps?.textures) {\n        skyBoxImageProps.textures.front = convertTexture(skyBoxImageProps.textures.front);\n        skyBoxImageProps.textures.back = convertTexture(skyBoxImageProps.textures.back);\n        skyBoxImageProps.textures.left = convertTexture(skyBoxImageProps.textures.left);\n        skyBoxImageProps.textures.right = convertTexture(skyBoxImageProps.textures.right);\n        skyBoxImageProps.textures.top = convertTexture(skyBoxImageProps.textures.top);\n        skyBoxImageProps.textures.bottom = convertTexture(skyBoxImageProps.textures.bottom);\n      }\n\n      if (targetElementProps?.jsonProperties?.styles?.planProjections) {\n        const remappedPlanProjections: { [modelId: string]: PlanProjectionSettingsProps } = {};\n        for (const entry of Object.entries(targetElementProps.jsonProperties.styles.planProjections)) {\n          const remappedModelId: Id64String = context.findTargetElementId(entry[0]);\n          if (Id64.isValidId64(remappedModelId)) {\n            remappedPlanProjections[remappedModelId] = entry[1];\n          }\n        }\n        targetElementProps.jsonProperties.styles.planProjections = remappedPlanProjections;\n      }\n    }\n  }\n\n  /** Create a DisplayStyle3d for use by a ViewDefinition.\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name/CodeValue of the DisplayStyle3d\n   * @returns The newly constructed DisplayStyle3d element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): DisplayStyle3d {\n    options = options ?? {};\n    let viewflags = options.viewFlags?.toJSON();\n    if (!viewflags)\n      viewflags = options.viewflags ?? new ViewFlags().toJSON();\n\n    const backgroundColor = options.backgroundColor instanceof ColorDef ? options.backgroundColor.toJSON() : options.backgroundColor;\n\n    const settings: DisplayStyle3dSettingsProps = {\n      ...options,\n      viewflags,\n      backgroundColor,\n    };\n\n    const displayStyleProps: DisplayStyle3dProps = {\n      classFullName: this.classFullName,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      model: definitionModelId,\n      jsonProperties: { styles: settings },\n      isPrivate: false,\n\n    };\n\n    return new DisplayStyle3d(displayStyleProps, iModelDb);\n  }\n  /**\n   * Insert a DisplayStyle3d for use by a ViewDefinition.\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new DisplayStyle3d into this [[DefinitionModel]]\n   * @param name The name of the DisplayStyle3d\n   * @returns The Id of the newly inserted DisplayStyle3d element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, options?: DisplayStyleCreationOptions): Id64String {\n    const displayStyle = this.create(iModelDb, definitionModelId, name, options);\n    return iModelDb.elements.insertElement(displayStyle.toJSON());\n  }\n}\n"]}