@itwin/core-frontend 3.0.0-extension.0 → 3.1.0-dev.5

package/lib/cjs/DisplayStyleState.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DisplayStyle3dState = exports.Environment = exports.SkyCube = exports.SkySphere = exports.SkyGradient = exports.SkyBox = exports.DisplayStyle2dState = exports.DisplayStyleState = exports.TerrainDisplayOverrides = void 0;
+exports.DisplayStyle3dState = exports.DisplayStyle2dState = exports.DisplayStyleState = exports.TerrainDisplayOverrides = void 0;
 /*---------------------------------------------------------------------------------------------
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
@@ -70,29 +70,58 @@ class DisplayStyleState extends EntityState_1.ElementState {
                     return;
             }
         }
-        this._scheduleState = await this.loadScheduleState();
+        if (undefined !== this.settings.renderTimeline)
+            await this.loadScheduleStateFromTimeline(this.settings.renderTimeline);
+        else
+            this.loadScheduleStateFromScript(this.settings.scheduleScriptProps); // eslint-disable-line deprecation/deprecation
     }
-    async loadScheduleState() {
-        // The script can be stored on a separate RenderTimeline element (new, preferred way); or stuffed into the display style's JSON properties (old, deprecated way).
-        try {
-            let script;
-            let sourceId;
-            if (this.settings.renderTimeline) {
-                const timeline = await this.iModel.elements.loadProps(this.settings.renderTimeline, { renderTimeline: { omitScriptElementIds: true } });
-                if (timeline) {
-                    const scriptProps = JSON.parse(timeline.script);
-                    script = core_common_1.RenderSchedule.Script.fromJSON(scriptProps);
-                    sourceId = this.settings.renderTimeline;
-                }
+    loadScheduleStateFromScript(scriptProps) {
+        let newState;
+        if (scriptProps) {
+            try {
+                const script = core_common_1.RenderSchedule.Script.fromJSON(scriptProps);
+                if (script)
+                    newState = new RenderScheduleState_1.RenderScheduleState(this.id, script);
             }
-            else if (this.settings.scheduleScriptProps) { // eslint-disable-line deprecation/deprecation
-                // eslint-disable-next-line deprecation/deprecation
-                script = core_common_1.RenderSchedule.Script.fromJSON(this.settings.scheduleScriptProps);
-                sourceId = this.id;
+            catch (_) {
+                // schedule state is undefined.
             }
-            return (script && sourceId) ? new RenderScheduleState_1.RenderScheduleState(sourceId, script) : undefined;
         }
-        catch {
+        if (newState !== this._scheduleState) {
+            this.onScheduleScriptReferenceChanged.raiseEvent(newState);
+            this._scheduleState = newState;
+        }
+    }
+    async loadScheduleStateFromTimeline(timelineId) {
+        let newState;
+        try {
+            // If a subsequent call to loadScheduleStateFromTimeline is made while we're awaiting this one, we'll abort this one.
+            const promise = this._queryRenderTimelinePropsPromise = this.queryRenderTimelineProps(timelineId);
+            const timeline = await promise;
+            if (promise !== this._queryRenderTimelinePropsPromise)
+                return;
+            if (timeline) {
+                const scriptProps = JSON.parse(timeline.script);
+                const script = core_common_1.RenderSchedule.Script.fromJSON(scriptProps);
+                if (script)
+                    newState = new RenderScheduleState_1.RenderScheduleState(timelineId, script);
+            }
+        }
+        catch (_) {
+            // schedule state is undefined.
+        }
+        this._queryRenderTimelinePropsPromise = undefined;
+        if (newState !== this._scheduleState) {
+            this.onScheduleScriptReferenceChanged.raiseEvent(newState);
+            this._scheduleState = newState;
+        }
+    }
+    /** @internal */
+    async queryRenderTimelineProps(timelineId) {
+        try {
+            return await this.iModel.elements.loadProps(timelineId, { renderTimeline: { omitScriptElementIds: true } });
+        }
+        catch (_) {
             return undefined;
         }
     }
@@ -178,14 +207,16 @@ class DisplayStyleState extends EntityState_1.ElementState {
     /** The name of this DisplayStyle */
     get name() { return this.code.value; }
     /** Change the Id of the [RenderTimeline]($backend) element that hosts the [RenderSchedule.Script]($common) to be applied by this display style for
-     * animating the contents of the view.
+     * animating the contents of the view, and update [[scheduleScriptReference]] using the script associated with the [RenderTimeline]($backend) element.
+     * @see [DisplayStyleSettings.renderTimeline]($common).
      */
     async changeRenderTimeline(timelineId) {
-        if (timelineId === this.settings.renderTimeline)
-            return;
-        const script = await this.loadScheduleState();
-        this.onScheduleScriptReferenceChanged.raiseEvent(script);
-        this._scheduleState = script;
+        // Potentially trigger async loading of new schedule state.
+        this.settings.renderTimeline = timelineId;
+        // Await async loading if necessary.
+        // Note the `await` in loadScheduleStateFromTimeline will resolve before this one [per the spec](https://262.ecma-international.org/6.0/#sec-triggerpromisereactions).
+        if (this._queryRenderTimelinePropsPromise)
+            await this._queryRenderTimelinePropsPromise;
     }
     /** The [RenderSchedule.Script]($common) that animates the contents of the view, if any.
      * @see [[changeRenderTimeline]] to change the script.
@@ -210,16 +241,13 @@ class DisplayStyleState extends EntityState_1.ElementState {
      * @internal
      */
     setScheduleState(state) {
+        if (state === this._scheduleState)
+            return;
         this.onScheduleScriptReferenceChanged.raiseEvent(state);
         this._scheduleState = state;
         // eslint-disable-next-line deprecation/deprecation
         this.settings.scheduleScriptProps = state === null || state === void 0 ? void 0 : state.script.toJSON();
     }
-    /** @internal */
-    getAnimationBranches(scheduleTime) {
-        var _a;
-        return (_a = this.scheduleState) === null || _a === void 0 ? void 0 : _a.getAnimationBranches(scheduleTime);
-    }
     /** Attach a [ContextRealityModel]($common) to this display style.
      * @see [DisplayStyleSettings.contextRealityModels]($common).
      * @see [ContextRealityModels.add]($common)
@@ -560,24 +588,16 @@ class DisplayStyleState extends EntityState_1.ElementState {
     registerSettingsEventListeners() {
         // eslint-disable-next-line deprecation/deprecation
         this.settings.onScheduleScriptPropsChanged.addListener((scriptProps) => {
-            let newState;
-            if (scriptProps) {
-                const script = core_common_1.RenderSchedule.Script.fromJSON(scriptProps);
-                if (script)
-                    newState = new RenderScheduleState_1.RenderScheduleState(this.id, script);
-            }
-            if (newState !== this._scheduleState) {
-                this.onScheduleScriptReferenceChanged.raiseEvent(newState);
-                this._scheduleState = newState;
-            }
+            if (undefined === this.settings.renderTimeline)
+                this.loadScheduleStateFromScript(scriptProps);
         });
         this.settings.onRenderTimelineChanged.addListener((newTimeline) => {
-            var _a;
-            if (newTimeline !== ((_a = this._scheduleState) === null || _a === void 0 ? void 0 : _a.sourceId)) {
-                // Loading the new script is asynchronous...people should really be using DisplayStyleState.changeRenderTimeline().
-                this.onScheduleScriptReferenceChanged.raiseEvent(undefined);
-                this._scheduleState = undefined;
-            }
+            // Cancel any in-progress loading of script from timeline.
+            this._queryRenderTimelinePropsPromise = undefined;
+            if (undefined !== newTimeline)
+                this.loadScheduleStateFromTimeline(newTimeline); // eslint-disable-line @typescript-eslint/no-floating-promises
+            else
+                this.loadScheduleStateFromScript(this.settings.scheduleScriptProps); // eslint-disable-line deprecation/deprecation
         });
         this.settings.onPlanarClipMaskChanged.addListener((id, newSettings) => {
             if (newSettings)
@@ -614,324 +634,26 @@ class DisplayStyle2dState extends DisplayStyleState {
     overrideTerrainDisplay() { return undefined; }
 }
 exports.DisplayStyle2dState = DisplayStyle2dState;
-/** The SkyBox is part of an [[Environment]] drawn in the background of spatial views to provide context.
- * Several types of skybox are supported:
- *  - A cube with a texture image mapped to each face;
- *  - A sphere with a single texture image mapped to its surface;
- *  - A sphere with a [[Gradient]] mapped to its surface.
- * @public
- */
-class SkyBox {
-    constructor(sky) {
-        /** Whether or not the skybox should be displayed. */
-        this.display = false;
-        this.display = undefined !== sky && core_bentley_1.JsonUtils.asBool(sky.display, false);
-    }
-    toJSON() {
-        return { display: this.display };
-    }
-    /** Instantiate a [[SkyBox]] from its JSON representation. */
-    static createFromJSON(json) {
-        let imageType = core_common_1.SkyBoxImageType.None;
-        if (undefined !== json && undefined !== json.image && undefined !== json.image.type)
-            imageType = json.image.type;
-        let skybox;
-        switch (imageType) {
-            case core_common_1.SkyBoxImageType.Spherical:
-                skybox = SkySphere.fromJSON(json);
-                break;
-            case core_common_1.SkyBoxImageType.Cube:
-                skybox = SkyCube.fromJSON(json);
-                break;
-            case core_common_1.SkyBoxImageType.Cylindrical: // ###TODO...
-                break;
-        }
-        return undefined !== skybox ? skybox : new SkyGradient(json);
-    }
-}
-exports.SkyBox = SkyBox;
-/** The SkyBox is part of an [[Environment]] drawn in the background of spatial views to provide context.
- * Several types of skybox are supported:
- *  - A cube with a texture image mapped to each face;
- *  - A sphere with a single texture image mapped to its surface;
- *  - A sphere with a [[Gradient]] mapped to its surface.
- * @public
- */
-(function (SkyBox) {
-    /** Parameters defining a spherical [[SkyBox]].
-     * @public
-     */
-    class SphereParams {
-        constructor(texture, rotation) {
-            this.texture = texture;
-            this.rotation = rotation;
-        }
-    }
-    SkyBox.SphereParams = SphereParams;
-    /** Parameters used by the [[RenderSystem]] to instantiate a [[SkyBox]].
-     * @public
-     */
-    class CreateParams {
-        constructor(zOffset, gradient, sphere, cube) {
-            this.gradient = gradient;
-            this.sphere = sphere;
-            this.cube = cube;
-            this.zOffset = zOffset;
-        }
-        static createForGradient(gradient, zOffset) { return new CreateParams(zOffset, gradient); }
-        static createForSphere(sphere, zOffset) { return new CreateParams(zOffset, undefined, sphere); }
-        static createForCube(cube) { return new CreateParams(0.0, undefined, undefined, cube); }
-    }
-    SkyBox.CreateParams = CreateParams;
-})(SkyBox = exports.SkyBox || (exports.SkyBox = {}));
-/** A [[SkyBox]] drawn as a sphere with a gradient mapped to its interior surface.
- * @see [[SkyBox.createFromJSON]]
- * @see [SkyBoxProps]($common) for descriptions of the color and exponent properties.
- * @public
- */
-class SkyGradient extends SkyBox {
-    /** Construct a SkyGradient from its JSON representation. */
-    constructor(sky) {
-        super(sky);
-        /** If true, a 2-color gradient is used (nadir and zenith colors only); if false a 4-color gradient is used. Defaults to false. */
-        this.twoColor = false;
-        /** @see [SkyBoxProps.skyExponent]($common). */
-        this.skyExponent = 4.0;
-        /** @see [SkyBoxProps.groundExponent]($common). */
-        this.groundExponent = 4.0;
-        sky = sky ? sky : {};
-        this.twoColor = core_bentley_1.JsonUtils.asBool(sky.twoColor, false);
-        this.groundExponent = core_bentley_1.JsonUtils.asDouble(sky.groundExponent, 4.0);
-        this.skyExponent = core_bentley_1.JsonUtils.asDouble(sky.skyExponent, 4.0);
-        this.groundColor = (undefined !== sky.groundColor) ? core_common_1.ColorDef.fromJSON(sky.groundColor) : core_common_1.ColorDef.from(120, 143, 125);
-        this.zenithColor = (undefined !== sky.zenithColor) ? core_common_1.ColorDef.fromJSON(sky.zenithColor) : core_common_1.ColorDef.from(54, 117, 255);
-        this.nadirColor = (undefined !== sky.nadirColor) ? core_common_1.ColorDef.fromJSON(sky.nadirColor) : core_common_1.ColorDef.from(40, 15, 0);
-        this.skyColor = (undefined !== sky.skyColor) ? core_common_1.ColorDef.fromJSON(sky.skyColor) : core_common_1.ColorDef.from(143, 205, 255);
-    }
-    toJSON() {
-        const val = super.toJSON();
-        val.twoColor = this.twoColor ? true : undefined;
-        val.groundExponent = this.groundExponent !== 4.0 ? this.groundExponent : undefined;
-        val.skyExponent = this.skyExponent !== 4.0 ? this.skyExponent : undefined;
-        val.groundColor = this.groundColor.toJSON();
-        val.zenithColor = this.zenithColor.toJSON();
-        val.nadirColor = this.nadirColor.toJSON();
-        val.skyColor = this.skyColor.toJSON();
-        return val;
-    }
-    /** @internal */
-    loadParams(_system, iModel) {
-        return SkyBox.CreateParams.createForGradient(this, iModel.globalOrigin.z);
-    }
-}
-exports.SkyGradient = SkyGradient;
-/** A [[SkyBox]] drawn as a sphere with an image mapped to its interior surface.
- * @see [[SkyBox.createFromJSON]]
- * @public
- */
-class SkySphere extends SkyBox {
-    constructor(textureId, display) {
-        super({ display });
-        this.textureId = textureId;
-    }
-    /** Create a [[SkySphere]] from its JSON representation.
-     * @param json: The JSON representation
-     * @returns A SkySphere, or undefined if the JSON lacks a valid texture Id.
-     */
-    static fromJSON(json) {
-        const textureId = core_bentley_1.Id64.fromJSON(undefined !== json.image ? json.image.texture : undefined);
-        return undefined !== textureId && core_bentley_1.Id64.isValid(textureId) ? new SkySphere(textureId, json.display) : undefined;
-    }
-    toJSON() {
-        const val = super.toJSON();
-        val.image = {
-            type: core_common_1.SkyBoxImageType.Spherical,
-            texture: this.textureId,
-        };
-        return val;
-    }
-    /** @internal */
-    loadParams(system, iModel) {
-        const rotation = 0.0; // ###TODO: from where do we obtain rotation?
-        const createParams = (tex) => undefined !== tex ? SkyBox.CreateParams.createForSphere(new SkyBox.SphereParams(tex, rotation), iModel.globalOrigin.z) : undefined;
-        const texture = system.findTexture(this.textureId, iModel);
-        if (undefined !== texture)
-            return createParams(texture);
-        else
-            return system.loadTexture(this.textureId, iModel).then((tex) => createParams(tex));
-    }
-}
-exports.SkySphere = SkySphere;
-/** A [[SkyBox]] drawn as a cube with an image mapped to each of its interior faces.
- * Each member specifies the Id of a persistent texture element stored in the iModel
- * from which the image mapped to the corresponding face is obtained.
- * @see [[SkyBox.createFromJSON]].
- * @public
- */
-class SkyCube extends SkyBox {
-    constructor(front, back, top, bottom, right, left, display) {
-        super({ display });
-        this.front = front;
-        this.back = back;
-        this.top = top;
-        this.bottom = bottom;
-        this.right = right;
-        this.left = left;
-    }
-    /** Use [[SkyCube.create]].
-     * @internal
-     */
-    static fromJSON(skyboxJson) {
-        const image = skyboxJson.image;
-        const json = (undefined !== image && image.type === core_common_1.SkyBoxImageType.Cube ? image.textures : undefined);
-        if (undefined === json)
-            return undefined;
-        return this.create(core_bentley_1.Id64.fromJSON(json.front), core_bentley_1.Id64.fromJSON(json.back), core_bentley_1.Id64.fromJSON(json.top), core_bentley_1.Id64.fromJSON(json.bottom), core_bentley_1.Id64.fromJSON(json.right), core_bentley_1.Id64.fromJSON(json.left), skyboxJson.display);
-    }
-    toJSON() {
-        const val = super.toJSON();
-        val.image = {
-            type: core_common_1.SkyBoxImageType.Cube,
-            textures: {
-                front: this.front,
-                back: this.back,
-                top: this.top,
-                bottom: this.bottom,
-                right: this.right,
-                left: this.left,
-            },
-        };
-        return val;
-    }
-    /** Create and return a SkyCube. (Calls the SkyCube constructor after validating the Ids passed in for the images.)
-     * @param front The Id of the image to use for the front side of the sky cube.
-     * @param back The Id of the image to use for the back side of the sky cube.
-     * @param top The Id of the image to use for the top side of the sky cube.
-     * @param bottom The Id of the image to use for the bottom side of the sky cube.
-     * @param right The Id of the image to use for the right side of the sky cube.
-     * @param left The Id of the image to use for the left side of the sky cube.
-     * @returns A SkyCube, or undefined if any of the supplied texture Ids are invalid.
-     * @note All Ids must refer to a persistent texture element stored in the iModel.
-     */
-    static create(front, back, top, bottom, right, left, display) {
-        if (!core_bentley_1.Id64.isValid(front) || !core_bentley_1.Id64.isValid(back) || !core_bentley_1.Id64.isValid(top) || !core_bentley_1.Id64.isValid(bottom) || !core_bentley_1.Id64.isValid(right) || !core_bentley_1.Id64.isValid(left))
-            return undefined;
-        else
-            return new SkyCube(front, back, top, bottom, right, left, display);
-    }
-    /** @internal */
-    loadParams(system, iModel) {
-        // ###TODO: We never cache the actual texture *images* used here to create a single cubemap texture...
-        const textureIds = new Set([this.front, this.back, this.top, this.bottom, this.right, this.left]);
-        const promises = [];
-        for (const textureId of textureIds)
-            promises.push(system.loadTextureImage(textureId, iModel));
-        return Promise.all(promises).then((images) => {
-            // ###TODO there's gotta be a simpler way to map the unique images back to their texture Ids...
-            const idToImage = new Map();
-            let index = 0;
-            for (const textureId of textureIds) {
-                const image = images[index++];
-                if (undefined === image || undefined === image.image)
-                    return undefined;
-                else
-                    idToImage.set(textureId, image.image);
-            }
-            // eslint-disable-next-line deprecation/deprecation
-            const params = new core_common_1.RenderTexture.Params(undefined, core_common_1.RenderTexture.Type.SkyBox);
-            const textureImages = [
-                idToImage.get(this.front), idToImage.get(this.back), idToImage.get(this.top),
-                idToImage.get(this.bottom), idToImage.get(this.right), idToImage.get(this.left),
-            ];
-            const texture = system.createTextureFromCubeImages(textureImages[0], textureImages[1], textureImages[2], textureImages[3], textureImages[4], textureImages[5], iModel, params);
-            return undefined !== texture ? SkyBox.CreateParams.createForCube(texture) : undefined;
-        }).catch((_err) => {
-            return undefined;
-        });
-    }
-}
-exports.SkyCube = SkyCube;
-/** Describes the [[SkyBox]] and [[GroundPlane]] associated with a [[DisplayStyle3dState]].
- * @public
- */
-class Environment {
-    /** Construct from JSON representation. */
-    constructor(json) {
-        this.sky = SkyBox.createFromJSON(undefined !== json ? json.sky : undefined);
-        this.ground = new core_common_1.GroundPlane(undefined !== json ? json.ground : undefined);
-    }
-    toJSON() {
-        return {
-            sky: this.sky.toJSON(),
-            ground: this.ground.toJSON(),
-        };
-    }
-}
-exports.Environment = Environment;
-function isSameSkyBox(a, b) {
-    if (undefined === a || undefined === b)
-        return undefined === a && undefined === b;
-    return JSON.stringify(a) === JSON.stringify(b);
-}
 /** A [[DisplayStyleState]] that can be applied to spatial views.
  * @public
  */
 class DisplayStyle3dState extends DisplayStyleState {
     constructor(props, iModel, source) {
         super(props, iModel, source);
-        if (source && source.iModel === this.iModel) {
-            this._skyBoxParams = source._skyBoxParams;
-            this._skyBoxParamsLoaded = source._skyBoxParamsLoaded;
-        }
         this._settings = new core_common_1.DisplayStyle3dSettings(this.jsonProperties, { createContextRealityModel: (modelProps) => this.createRealityModel(modelProps) });
         this.registerSettingsEventListeners();
     }
     /** @internal */
     static get className() { return "DisplayStyle3d"; }
     get settings() { return this._settings; }
-    /** The [[SkyBox]] and [[GroundPlane]] settings for this style. */
     get environment() {
-        if (undefined === this._environment)
-            this._environment = new Environment(this.settings.environment);
-        return this._environment;
+        return this.settings.environment;
     }
     set environment(env) {
-        this.changeEnvironment(env);
-        this.settings.environment = env.toJSON();
-    }
-    changeEnvironment(env) {
-        const prevEnv = this.settings.environment;
-        this._environment = undefined;
-        // Regenerate the skybox if the sky settings have changed
-        if (undefined !== this._skyBoxParamsLoaded && !isSameSkyBox(env.sky, prevEnv.sky)) {
-            // NB: We only reset _skyBoxParamsLoaded - keep the previous skybox (if any) to continue drawing until the new one (if any) is ready
-            this._skyBoxParamsLoaded = undefined;
-        }
+        this.settings.environment = env;
     }
     get lights() { return this.settings.lights; }
     set lights(lights) { this.settings.lights = lights; }
-    onLoadSkyBoxParams(params, vp) {
-        this._skyBoxParams = params;
-        this._skyBoxParamsLoaded = true;
-        if (undefined !== vp)
-            vp.invalidateDecorations();
-    }
-    /** Attempts to create textures for the sky of the environment, and load it into the sky. Returns true on success, and false otherwise.
-     * @internal
-     */
-    loadSkyBoxParams(system, vp) {
-        if (undefined === this._skyBoxParamsLoaded) {
-            const params = this.environment.sky.loadParams(system, this.iModel);
-            if (undefined === params || params instanceof SkyBox.CreateParams) {
-                this.onLoadSkyBoxParams(params, vp);
-            }
-            else {
-                this._skyBoxParamsLoaded = false; // indicates we're currently loading them.
-                params.then((result) => this.onLoadSkyBoxParams(result, vp)).catch((_err) => this.onLoadSkyBoxParams(undefined));
-            }
-        }
-        return this._skyBoxParams;
-    }
     /** The direction of the solar light. */
     get sunDirection() {
         return this.settings.lights.solar.direction;
@@ -954,9 +676,6 @@ class DisplayStyle3dState extends DisplayStyleState {
     /** @internal */
     registerSettingsEventListeners() {
         super.registerSettingsEventListeners();
-        this.settings.onEnvironmentChanged.addListener((env) => {
-            this.changeEnvironment(new Environment(env));
-        });
         this.settings.onOverridesApplied.addListener((overrides) => {
             if (overrides.thematic && this.settings.thematic.displayMode === core_common_1.ThematicDisplayMode.Height && undefined === overrides.thematic.range) {
                 // Use the project extents as reasonable default height range.