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

package/lib/esm/SkyBox.d.ts

@@ -1,49 +1,70 @@
 /** @packageDocumentation
  * @module DisplayStyles
  */
-import { Id64String } from "@itwin/core-bentley";
-import { ColorDefProps } from "./ColorDef";
-/** Enumerates the supported types of [SkyBox]($frontend) images.
+import { Id64String, NonFunctionPropertiesOf } from "@itwin/core-bentley";
+import { ColorDef, ColorDefProps } from "./ColorDef";
+import { TextureImageSpec } from "./RenderTexture";
+/** Supported types of [[SkyBox]] images.
+ * @see [[SkyBoxImageProps]].
  * @public
  */
 export declare enum SkyBoxImageType {
+    /** No image, indicating a [[SkyGradient]] should be displayed. */
     None = 0,
-    /** A single image mapped to the surface of a sphere. @see [SkySphere]($frontend) */
+    /** A single image mapped to the surface of a sphere.
+     * @see [[SkySphere]].
+     */
     Spherical = 1,
-    /** 6 images mapped to the faces of a cube. @see [SkyCube]($frontend) */
-    Cube = 2,
     /** @internal not yet supported */
-    Cylindrical = 3
+    Cylindrical = 2,
+    /** Six images mapped to the faces of a cube.
+     * @see [[SkyCube]].
+     */
+    Cube = 3
 }
-/** JSON representation of a set of images used by a [SkyCube]($frontend). Each property specifies the element ID of a texture associated with one face of the cube.
+/** JSON representation of the six images used by a [[SkyCube]].
+ * Each property specifies the image for a face of the cube as either an image URL, or the Id of a [Texture]($backend) element.
+ * Each image must be square and have the same dimensions as all the other images.
  * @public
  */
 export interface SkyCubeProps {
-    /** Id of a persistent texture element stored in the iModel to use for the front side of the skybox cube. */
-    front?: Id64String;
-    /** Id of a persistent texture element stored in the iModel to use for the back side of the skybox cube. */
-    back?: Id64String;
-    /** Id of a persistent texture element stored in the iModel to use for the top of the skybox cube. */
-    top?: Id64String;
-    /** Id of a persistent texture element stored in the iModel to use for the bottom of the skybox cube. */
-    bottom?: Id64String;
-    /** Id of a persistent texture element stored in the iModel to use for the right side of the skybox cube. */
-    right?: Id64String;
-    /** Id of a persistent texture element stored in the iModel to use for the left side of the skybox cube. */
-    left?: Id64String;
+    front: TextureImageSpec;
+    back: TextureImageSpec;
+    top: TextureImageSpec;
+    bottom: TextureImageSpec;
+    right: TextureImageSpec;
+    left: TextureImageSpec;
 }
-/** JSON representation of an image or images used by a [SkySphere]($frontend) or [SkyCube]($frontend).
+/** JSON representation of the image used for a [[SkySphere]].
+ * @see [[SkyBoxProps.image]].
  * @public
  */
-export interface SkyBoxImageProps {
-    /** The type of skybox image. */
-    type?: SkyBoxImageType;
-    /** For [[SkyBoxImageType.Spherical]], the Id of a persistent texture element stored in the iModel to be drawn as the "sky". */
-    texture?: Id64String;
-    /** For [[SkyBoxImageType.Cube]], the Ids of persistent texture elements stored in the iModel drawn on each face of the cube. */
-    textures?: SkyCubeProps;
+export interface SkySphereImageProps {
+    type: SkyBoxImageType.Spherical;
+    texture: TextureImageSpec;
+    /** @internal */
+    textures?: never;
 }
-/** JSON representation of a [SkyBox]($frontend) that can be drawn as the background of a [ViewState3d]($frontend).
+/** JSON representation of the images used for a [[SkyCube]].
+ * @see [[SkyBoxProps.image]].
+ * @public
+ */
+export interface SkyCubeImageProps {
+    type: SkyBoxImageType.Cube;
+    textures: SkyCubeProps;
+    /** @internal */
+    texture?: never;
+}
+/** JSON representation of the image(s) to be mapped to the surfaces of a [[SkyBox]].
+ * @see [[SkyBoxProps.image]].
+ * @public
+ */
+export declare type SkyBoxImageProps = SkySphereImageProps | SkyCubeImageProps | {
+    type?: SkyBoxImageType;
+    texture?: never;
+    textures?: never;
+};
+/** JSON representation of a [[SkyBox]] that can be drawn as the background of a [ViewState3d]($frontend).
  * An object of this type can describe one of several types of sky box:
  *  - A cube with a texture image mapped to each face; or
  *  - A sphere with a single texture image mapped to its surface; or
@@ -68,15 +89,15 @@ export interface SkyBoxProps {
      * Default: false.
      */
     display?: boolean;
-    /** For a [SkyGradient]($frontend), if true, a 2-color gradient skybox is used instead of a 4-color.
+    /** For a [[SkyGradient]], if true, a 2-color gradient skybox is used instead of a 4-color.
      * Default: false.
      */
     twoColor?: boolean;
-    /** The color of the sky at the horizon. Unused unless this is a four-color [SkyGradient]($frontend).
+    /** The color of the sky at the horizon. Unused unless this is a four-color [[SkyGradient]].
      * Default: (143, 205, 255).
      */
     skyColor?: ColorDefProps;
-    /** The color of the ground at the horizon. Unused unless this is a four-color [SkyGradient]($frontend).
+    /** The color of the ground at the horizon. Unused unless this is a four-color [[SkyGradient]].
      * Default: (120, 143, 125).
      */
     groundColor?: ColorDefProps;
@@ -88,11 +109,11 @@ export interface SkyBoxProps {
      * Default: (40, 15, 0).
      */
     nadirColor?: ColorDefProps;
-    /** For a 4-color [SkyGradient]($frontend), controls speed of change from sky color to zenith color; otherwise unused.
+    /** For a 4-color [[SkyGradient]], controls speed of change from sky color to zenith color; otherwise unused.
      * Default: 4.0.
      */
     skyExponent?: number;
-    /** For a 4-color [SkyGradient]($frontend), controls speed of change from ground color to nadir color; otherwise unused.
+    /** For a 4-color [[SkyGradient]], controls speed of change from ground color to nadir color; otherwise unused.
      * Default: 4.0.
      */
     groundExponent?: number;
@@ -101,4 +122,91 @@ export interface SkyBoxProps {
      */
     image?: SkyBoxImageProps;
 }
+/** A type containing all of the properties and none of the methods of [[SkyGradient]] with `readonly` modifiers removed.
+ * @see [[SkyGradient.create]] and [[SkyGradient.clone]].
+ * @public
+ */
+export declare type SkyGradientProperties = NonFunctionPropertiesOf<SkyGradient>;
+/** Describes how to map a two- or four-color [[Gradient]] to the interior of a sphere to produce a [[SkyBox]].
+ * @see [[SkyBox.gradient]].
+ * @public
+ */
+export declare class SkyGradient {
+    readonly twoColor: boolean;
+    readonly skyColor: ColorDef;
+    readonly groundColor: ColorDef;
+    readonly zenithColor: ColorDef;
+    readonly nadirColor: ColorDef;
+    readonly skyExponent: number;
+    readonly groundExponent: number;
+    private constructor();
+    /** Default settings for a four-color gradient. */
+    static readonly defaults: SkyGradient;
+    /** Create a new gradient. Any properties not specified by `props` are initialized to their default values. */
+    static create(props?: Partial<SkyGradientProperties>): SkyGradient;
+    /** Create from JSON representation. */
+    static fromJSON(props?: SkyBoxProps): SkyGradient;
+    /** Create ea copy of this gradient, identical except for any properties explicitly specified by `changedProps`.
+     * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.
+     */
+    clone(changedProps: SkyGradientProperties): SkyGradient;
+    /** Convert to JSON representation. */
+    toJSON(): SkyBoxProps;
+    /** Returns true if this gradient is equivalent to the supplied gradient. */
+    equals(other: SkyGradient): boolean;
+}
+/** Describes how to draw a representation of a sky, as part of an [[Environment]].
+ * @see [[SkyBoxProps]].
+ * @public
+ */
+export declare class SkyBox {
+    /** The gradient settings, used if no cube or sphere images are supplied, or if the images cannot be loaded. */
+    readonly gradient: SkyGradient;
+    protected constructor(gradient: SkyGradient);
+    /** Default settings for a four-color gradient. */
+    static readonly defaults: SkyBox;
+    /** Create a skybox that displays the specified gradient, or the default gradient if none is supplied. */
+    static createGradient(gradient?: SkyGradient): SkyBox;
+    /** Create from JSON representation. */
+    static fromJSON(props?: SkyBoxProps): SkyBox;
+    /** Convert to JSON representation.
+     * @param display If defined, the value to use for [[SkyBoxProps.display]]; otherwise, that property will be left undefined.
+     */
+    toJSON(display?: boolean): SkyBoxProps;
+    /** @internal */
+    get textureIds(): Iterable<Id64String>;
+}
+/** Describes how to draw a representation of a sky by mapping a single image to the interior of a sphere.
+ * @public
+ */
+export declare class SkySphere extends SkyBox {
+    /** The image to map to the interior of the sphere. */
+    readonly image: TextureImageSpec;
+    /** Create a new sky sphere using the specified image.
+     * @param image The image to map to the interior of the sphere.
+     * @param gradient Optionally overrides the default gradient settings used if the image cannot be obtained.
+     */
+    constructor(image: TextureImageSpec, gradient?: SkyGradient);
+    /** @internal override */
+    toJSON(display?: boolean): SkyBoxProps;
+    /** @internal */
+    get textureIds(): Iterable<Id64String>;
+}
+/** Describes how to draw a representation of a sky by mapping images to the interior faces of a cube.
+ * The images are required to be *square*, and each image must have the same dimensions as the other images.
+ * @public
+ */
+export declare class SkyCube extends SkyBox {
+    /** The images to map to each face of the cube. */
+    readonly images: SkyCubeProps;
+    /** Create a new sky cube using the specified images.
+     * @param images The images to map to each face of the cube.
+     * @param Optionally overrides  the default gradient settings used if the images cannot be obtained.
+     */
+    constructor(images: SkyCubeProps, gradient?: SkyGradient);
+    /** @internal override */
+    toJSON(display?: boolean): SkyBoxProps;
+    /** @internal */
+    get textureIds(): Iterable<Id64String>;
+}
 //# sourceMappingURL=SkyBox.d.ts.map

package/lib/esm/SkyBox.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SkyBox.d.ts","sourceRoot":"","sources":["../../src/SkyBox.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C;;GAEG;AACH,oBAAY,eAAe;IACzB,IAAI,IAAA;IACJ,oFAAoF;IACpF,SAAS,IAAA;IACT,wEAAwE;IACxE,IAAI,IAAA;IACJ,kCAAkC;IAClC,WAAW,IAAA;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,4GAA4G;IAC5G,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,2GAA2G;IAC3G,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,qGAAqG;IACrG,GAAG,CAAC,EAAE,UAAU,CAAC;IACjB,wGAAwG;IACxG,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,4GAA4G;IAC5G,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,2GAA2G;IAC3G,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gCAAgC;IAChC,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,+HAA+H;IAC/H,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,gIAAgI;IAChI,QAAQ,CAAC,EAAE,YAAY,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;CAC1B"}
+{"version":3,"file":"SkyBox.d.ts","sourceRoot":"","sources":["../../src/SkyBox.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnD;;;GAGG;AACH,oBAAY,eAAe;IACzB,kEAAkE;IAClE,IAAI,IAAI;IACR;;OAEG;IACH,SAAS,IAAI;IACb,kCAAkC;IAClC,WAAW,IAAI;IACf;;OAEG;IACH,IAAI,IAAI;CACT;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,gBAAgB,CAAC;IACxB,IAAI,EAAE,gBAAgB,CAAC;IACvB,GAAG,EAAE,gBAAgB,CAAC;IACtB,MAAM,EAAE,gBAAgB,CAAC;IACzB,KAAK,EAAE,gBAAgB,CAAC;IACxB,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC;IAChC,OAAO,EAAE,gBAAgB,CAAC;IAC1B,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC;IAC3B,QAAQ,EAAE,YAAY,CAAC;IACvB,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB;AAED;;;GAGG;AACH,oBAAY,gBAAgB,GAAG,mBAAmB,GAAG,iBAAiB,GAAG;IAAE,IAAI,CAAC,EAAE,eAAe,CAAC;IAAC,OAAO,CAAC,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAEvI;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;CAC1B;AAYD;;;GAGG;AACH,oBAAY,qBAAqB,GAAG,uBAAuB,CAAC,WAAW,CAAC,CAAC;AAEzE;;;GAGG;AACH,qBAAa,WAAW;IACtB,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,SAAgB,WAAW,EAAE,QAAQ,CAAC;IACtC,SAAgB,WAAW,EAAE,QAAQ,CAAC;IACtC,SAAgB,UAAU,EAAE,QAAQ,CAAC;IACrC,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,SAAgB,cAAc,EAAE,MAAM,CAAC;IAEvC,OAAO;IAUP,kDAAkD;IAClD,gBAAuB,QAAQ,cAAuB;IAEtD,8GAA8G;WAChG,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,WAAW;IAIzE,uCAAuC;WACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,WAAW;IAexD;;OAEG;IACI,KAAK,CAAC,YAAY,EAAE,qBAAqB,GAAG,WAAW;IAI9D,sCAAsC;IAC/B,MAAM,IAAI,WAAW;IAoB5B,4EAA4E;IACrE,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;CAO3C;AAED;;;GAGG;AACH,qBAAa,MAAM;IACjB,+GAA+G;IAC/G,SAAgB,QAAQ,EAAE,WAAW,CAAC;IAEtC,SAAS,aAAa,QAAQ,EAAE,WAAW;IAI3C,kDAAkD;IAClD,gBAAuB,QAAQ,SAAoC;IAEnE,yGAAyG;WAC3F,cAAc,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,MAAM;IAI5D,uCAAuC;WACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,MAAM;IAuBnD;;OAEG;IACI,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW;IAQ7C,gBAAgB;IAChB,IAAW,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,CAE5C;CACF;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,MAAM;IACnC,sDAAsD;IACtD,SAAgB,KAAK,EAAE,gBAAgB,CAAC;IAExC;;;OAGG;gBACgB,KAAK,EAAE,gBAAgB,EAAE,QAAQ,CAAC,EAAE,WAAW;IAKlE,yBAAyB;IACT,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW;IAUtD,gBAAgB;IAChB,IAAoB,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,CAErD;CACF;AAED;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,MAAM;IACjC,kDAAkD;IAClD,SAAgB,MAAM,EAAE,YAAY,CAAC;IAErC;;;OAGG;gBACgB,MAAM,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,WAAW;IAK/D,yBAAyB;IACT,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW;IAUtD,gBAAgB;IAChB,IAAoB,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,CAGrD;CACF"}

package/lib/esm/SkyBox.js

@@ -5,17 +5,199 @@
 /** @packageDocumentation
  * @module DisplayStyles
  */
-/** Enumerates the supported types of [SkyBox]($frontend) images.
+import { Id64 } from "@itwin/core-bentley";
+import { ColorDef } from "./ColorDef";
+/** Supported types of [[SkyBox]] images.
+ * @see [[SkyBoxImageProps]].
  * @public
  */
 export var SkyBoxImageType;
 (function (SkyBoxImageType) {
+    /** No image, indicating a [[SkyGradient]] should be displayed. */
     SkyBoxImageType[SkyBoxImageType["None"] = 0] = "None";
-    /** A single image mapped to the surface of a sphere. @see [SkySphere]($frontend) */
+    /** A single image mapped to the surface of a sphere.
+     * @see [[SkySphere]].
+     */
     SkyBoxImageType[SkyBoxImageType["Spherical"] = 1] = "Spherical";
-    /** 6 images mapped to the faces of a cube. @see [SkyCube]($frontend) */
-    SkyBoxImageType[SkyBoxImageType["Cube"] = 2] = "Cube";
     /** @internal not yet supported */
-    SkyBoxImageType[SkyBoxImageType["Cylindrical"] = 3] = "Cylindrical";
+    SkyBoxImageType[SkyBoxImageType["Cylindrical"] = 2] = "Cylindrical";
+    /** Six images mapped to the faces of a cube.
+     * @see [[SkyCube]].
+     */
+    SkyBoxImageType[SkyBoxImageType["Cube"] = 3] = "Cube";
 })(SkyBoxImageType || (SkyBoxImageType = {}));
+const defaultGroundColor = ColorDef.from(143, 205, 125);
+const defaultZenithColor = ColorDef.from(54, 117, 255);
+const defaultNadirColor = ColorDef.from(40, 125, 0);
+const defaultSkyColor = ColorDef.from(142, 205, 255);
+const defaultExponent = 4.0;
+function colorDefFromJson(props) {
+    return undefined !== props ? ColorDef.fromJSON(props) : undefined;
+}
+/** Describes how to map a two- or four-color [[Gradient]] to the interior of a sphere to produce a [[SkyBox]].
+ * @see [[SkyBox.gradient]].
+ * @public
+ */
+export class SkyGradient {
+    constructor(args) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        this.twoColor = (_a = args.twoColor) !== null && _a !== void 0 ? _a : false;
+        this.skyColor = (_b = args.skyColor) !== null && _b !== void 0 ? _b : defaultSkyColor;
+        this.groundColor = (_c = args.groundColor) !== null && _c !== void 0 ? _c : defaultGroundColor;
+        this.nadirColor = (_d = args.nadirColor) !== null && _d !== void 0 ? _d : defaultNadirColor;
+        this.zenithColor = (_e = args.zenithColor) !== null && _e !== void 0 ? _e : defaultZenithColor;
+        this.skyExponent = (_f = args.skyExponent) !== null && _f !== void 0 ? _f : defaultExponent;
+        this.groundExponent = (_g = args.groundExponent) !== null && _g !== void 0 ? _g : defaultExponent;
+    }
+    /** Create a new gradient. Any properties not specified by `props` are initialized to their default values. */
+    static create(props) {
+        return props ? new this(props) : this.defaults;
+    }
+    /** Create from JSON representation. */
+    static fromJSON(props) {
+        if (!props)
+            return this.defaults;
+        return new this({
+            twoColor: props.twoColor,
+            skyExponent: props.skyExponent,
+            groundExponent: props.groundExponent,
+            skyColor: colorDefFromJson(props.skyColor),
+            groundColor: colorDefFromJson(props.groundColor),
+            nadirColor: colorDefFromJson(props.nadirColor),
+            zenithColor: colorDefFromJson(props.zenithColor),
+        });
+    }
+    /** Create ea copy of this gradient, identical except for any properties explicitly specified by `changedProps`.
+     * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.
+     */
+    clone(changedProps) {
+        return new SkyGradient({ ...this, ...changedProps });
+    }
+    /** Convert to JSON representation. */
+    toJSON() {
+        const props = {
+            skyColor: this.skyColor.toJSON(),
+            groundColor: this.groundColor.toJSON(),
+            nadirColor: this.nadirColor.toJSON(),
+            zenithColor: this.zenithColor.toJSON(),
+        };
+        if (this.groundExponent !== defaultExponent)
+            props.groundExponent = this.groundExponent;
+        if (this.skyExponent !== defaultExponent)
+            props.skyExponent = this.skyExponent;
+        if (this.twoColor)
+            props.twoColor = this.twoColor;
+        return props;
+    }
+    /** Returns true if this gradient is equivalent to the supplied gradient. */
+    equals(other) {
+        if (this === other)
+            return true;
+        return this.twoColor === other.twoColor && this.skyColor.equals(other.skyColor) && this.groundColor.equals(other.groundColor) &&
+            this.zenithColor.equals(other.zenithColor) && this.nadirColor.equals(other.nadirColor);
+    }
+}
+/** Default settings for a four-color gradient. */
+SkyGradient.defaults = new SkyGradient({});
+/** Describes how to draw a representation of a sky, as part of an [[Environment]].
+ * @see [[SkyBoxProps]].
+ * @public
+ */
+export class SkyBox {
+    constructor(gradient) {
+        this.gradient = gradient;
+    }
+    /** Create a skybox that displays the specified gradient, or the default gradient if none is supplied. */
+    static createGradient(gradient) {
+        return gradient ? new this(gradient) : this.defaults;
+    }
+    /** Create from JSON representation. */
+    static fromJSON(props) {
+        const gradient = SkyGradient.fromJSON(props);
+        if (props === null || props === void 0 ? void 0 : props.image) {
+            switch (props.image.type) {
+                case SkyBoxImageType.Spherical:
+                    if (undefined !== props.image.texture)
+                        return new SkySphere(props.image.texture, gradient);
+                    break;
+                case SkyBoxImageType.Cube: {
+                    const tx = props.image.textures;
+                    if (tx && undefined !== tx.top && undefined !== tx.bottom && undefined !== tx.right && undefined !== tx.left && undefined !== tx.front && undefined !== tx.back)
+                        return new SkyCube(tx, gradient);
+                    break;
+                }
+            }
+        }
+        return this.createGradient(gradient);
+    }
+    /** Convert to JSON representation.
+     * @param display If defined, the value to use for [[SkyBoxProps.display]]; otherwise, that property will be left undefined.
+     */
+    toJSON(display) {
+        const props = this.gradient.toJSON();
+        if (undefined !== display)
+            props.display = display;
+        return props;
+    }
+    /** @internal */
+    get textureIds() {
+        return [];
+    }
+}
+/** Default settings for a four-color gradient. */
+SkyBox.defaults = new SkyBox(SkyGradient.defaults);
+/** Describes how to draw a representation of a sky by mapping a single image to the interior of a sphere.
+ * @public
+ */
+export class SkySphere extends SkyBox {
+    /** Create a new sky sphere using the specified image.
+     * @param image The image to map to the interior of the sphere.
+     * @param gradient Optionally overrides the default gradient settings used if the image cannot be obtained.
+     */
+    constructor(image, gradient) {
+        super(gradient !== null && gradient !== void 0 ? gradient : SkyGradient.defaults);
+        this.image = image;
+    }
+    /** @internal override */
+    toJSON(display) {
+        const props = super.toJSON(display);
+        props.image = {
+            type: SkyBoxImageType.Spherical,
+            texture: this.image,
+        };
+        return props;
+    }
+    /** @internal */
+    get textureIds() {
+        return Id64.isValidId64(this.image) ? [this.image] : [];
+    }
+}
+/** Describes how to draw a representation of a sky by mapping images to the interior faces of a cube.
+ * The images are required to be *square*, and each image must have the same dimensions as the other images.
+ * @public
+ */
+export class SkyCube extends SkyBox {
+    /** Create a new sky cube using the specified images.
+     * @param images The images to map to each face of the cube.
+     * @param Optionally overrides  the default gradient settings used if the images cannot be obtained.
+     */
+    constructor(images, gradient) {
+        super(gradient !== null && gradient !== void 0 ? gradient : SkyGradient.defaults);
+        this.images = { ...images };
+    }
+    /** @internal override */
+    toJSON(display) {
+        const props = super.toJSON(display);
+        props.image = {
+            type: SkyBoxImageType.Cube,
+            textures: { ...this.images },
+        };
+        return props;
+    }
+    /** @internal */
+    get textureIds() {
+        const imgs = this.images;
+        return [imgs.front, imgs.back, imgs.top, imgs.bottom, imgs.left, imgs.right].filter((x) => Id64.isValidId64(x));
+    }
+}
 //# sourceMappingURL=SkyBox.js.map

package/lib/esm/SkyBox.js.map

@@ -1 +1 @@
-{"version":3,"file":"SkyBox.js","sourceRoot":"","sources":["../../src/SkyBox.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH;;GAEG;AACH,MAAM,CAAN,IAAY,eAQX;AARD,WAAY,eAAe;IACzB,qDAAI,CAAA;IACJ,oFAAoF;IACpF,+DAAS,CAAA;IACT,wEAAwE;IACxE,qDAAI,CAAA;IACJ,kCAAkC;IAClC,mEAAW,CAAA;AACb,CAAC,EARW,eAAe,KAAf,eAAe,QAQ1B","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 DisplayStyles\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { ColorDefProps } from \"./ColorDef\";\r\n\r\n/** Enumerates the supported types of [SkyBox]($frontend) images.\r\n * @public\r\n */\r\nexport enum SkyBoxImageType {\r\n  None,\r\n  /** A single image mapped to the surface of a sphere. @see [SkySphere]($frontend) */\r\n  Spherical,\r\n  /** 6 images mapped to the faces of a cube. @see [SkyCube]($frontend) */\r\n  Cube,\r\n  /** @internal not yet supported */\r\n  Cylindrical,\r\n}\r\n\r\n/** JSON representation of a set of images used by a [SkyCube]($frontend). Each property specifies the element ID of a texture associated with one face of the cube.\r\n * @public\r\n */\r\nexport interface SkyCubeProps {\r\n  /** Id of a persistent texture element stored in the iModel to use for the front side of the skybox cube. */\r\n  front?: Id64String;\r\n  /** Id of a persistent texture element stored in the iModel to use for the back side of the skybox cube. */\r\n  back?: Id64String;\r\n  /** Id of a persistent texture element stored in the iModel to use for the top of the skybox cube. */\r\n  top?: Id64String;\r\n  /** Id of a persistent texture element stored in the iModel to use for the bottom of the skybox cube. */\r\n  bottom?: Id64String;\r\n  /** Id of a persistent texture element stored in the iModel to use for the right side of the skybox cube. */\r\n  right?: Id64String;\r\n  /** Id of a persistent texture element stored in the iModel to use for the left side of the skybox cube. */\r\n  left?: Id64String;\r\n}\r\n\r\n/** JSON representation of an image or images used by a [SkySphere]($frontend) or [SkyCube]($frontend).\r\n * @public\r\n */\r\nexport interface SkyBoxImageProps {\r\n  /** The type of skybox image. */\r\n  type?: SkyBoxImageType;\r\n  /** For [[SkyBoxImageType.Spherical]], the Id of a persistent texture element stored in the iModel to be drawn as the \"sky\". */\r\n  texture?: Id64String;\r\n  /** For [[SkyBoxImageType.Cube]], the Ids of persistent texture elements stored in the iModel drawn on each face of the cube. */\r\n  textures?: SkyCubeProps;\r\n}\r\n\r\n/** JSON representation of a [SkyBox]($frontend) that can be drawn as the background of a [ViewState3d]($frontend).\r\n * An object of this type can describe one of several types of sky box:\r\n *  - A cube with a texture image mapped to each face; or\r\n *  - A sphere with a single texture image mapped to its surface; or\r\n *  - A sphere with a two- or four-color vertical [[Gradient]] mapped to its surface.\r\n *\r\n * Whether cuboid or spherical, the skybox is drawn as if the viewer and the contents of the view are contained within its interior.\r\n *\r\n * For a two-color gradient, the gradient transitions smoothly from the nadir color at the bottom of the sphere to the zenith color at the top of the sphere.\r\n * The sky and ground colors are unused, as are the sky and ground exponents.\r\n *\r\n * For a four-color gradient, a \"horizon\" is produced on the equator of the sphere, where the ground color and sky color meet. The lower half of the sphere transitions\r\n * smoothly from the ground color at the equator to the nadir color at the bottom, and the upper half transitions from the sky color at the equator to the zenith color at\r\n * the top of the sphere.\r\n *\r\n * The color and exponent properties are unused if one or more texture images are supplied.\r\n *\r\n * @see [[DisplayStyle3dSettings.environment]] to define the skybox for a display style.\r\n * @public\r\n */\r\nexport interface SkyBoxProps {\r\n  /** Whether or not the skybox should be displayed.\r\n   * Default: false.\r\n   */\r\n  display?: boolean;\r\n  /** For a [SkyGradient]($frontend), if true, a 2-color gradient skybox is used instead of a 4-color.\r\n   * Default: false.\r\n   */\r\n  twoColor?: boolean;\r\n  /** The color of the sky at the horizon. Unused unless this is a four-color [SkyGradient]($frontend).\r\n   * Default: (143, 205, 255).\r\n   */\r\n  skyColor?: ColorDefProps;\r\n  /** The color of the ground at the horizon. Unused unless this is a four-color [SkyGradient]($frontend).\r\n   * Default: (120, 143, 125).\r\n   */\r\n  groundColor?: ColorDefProps;\r\n  /** The color of the top of the sphere.\r\n   * Default: (54, 117, 255).\r\n   */\r\n  zenithColor?: ColorDefProps;\r\n  /** The color of the bottom of the sphere.\r\n   * Default: (40, 15, 0).\r\n   */\r\n  nadirColor?: ColorDefProps;\r\n  /** For a 4-color [SkyGradient]($frontend), controls speed of change from sky color to zenith color; otherwise unused.\r\n   * Default: 4.0.\r\n   */\r\n  skyExponent?: number;\r\n  /** For a 4-color [SkyGradient]($frontend), controls speed of change from ground color to nadir color; otherwise unused.\r\n   * Default: 4.0.\r\n   */\r\n  groundExponent?: number;\r\n  /** The image(s), if any, to be mapped to the surfaces of the sphere or cube. If undefined, the skybox will be displayed as a gradient instead.\r\n   * Default: undefined.\r\n   */\r\n  image?: SkyBoxImageProps;\r\n}\r\n"]}
+{"version":3,"file":"SkyBox.js","sourceRoot":"","sources":["../../src/SkyBox.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAuC,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAiB,MAAM,YAAY,CAAC;AAGrD;;;GAGG;AACH,MAAM,CAAN,IAAY,eAaX;AAbD,WAAY,eAAe;IACzB,kEAAkE;IAClE,qDAAQ,CAAA;IACR;;OAEG;IACH,+DAAa,CAAA;IACb,kCAAkC;IAClC,mEAAe,CAAA;IACf;;OAEG;IACH,qDAAQ,CAAA;AACV,CAAC,EAbW,eAAe,KAAf,eAAe,QAa1B;AAuGD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACxD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACvD,MAAM,iBAAiB,GAAG,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AACpD,MAAM,eAAe,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACrD,MAAM,eAAe,GAAG,GAAG,CAAC;AAE5B,SAAS,gBAAgB,CAAC,KAAqB;IAC7C,OAAO,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACpE,CAAC;AAQD;;;GAGG;AACH,MAAM,OAAO,WAAW;IAStB,YAAoB,IAAoC;;QACtD,IAAI,CAAC,QAAQ,GAAG,MAAA,IAAI,CAAC,QAAQ,mCAAI,KAAK,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,MAAA,IAAI,CAAC,QAAQ,mCAAI,eAAe,CAAC;QACjD,IAAI,CAAC,WAAW,GAAG,MAAA,IAAI,CAAC,WAAW,mCAAI,kBAAkB,CAAC;QAC1D,IAAI,CAAC,UAAU,GAAG,MAAA,IAAI,CAAC,UAAU,mCAAI,iBAAiB,CAAC;QACvD,IAAI,CAAC,WAAW,GAAG,MAAA,IAAI,CAAC,WAAW,mCAAI,kBAAkB,CAAC;QAC1D,IAAI,CAAC,WAAW,GAAG,MAAA,IAAI,CAAC,WAAW,mCAAI,eAAe,CAAC;QACvD,IAAI,CAAC,cAAc,GAAG,MAAA,IAAI,CAAC,cAAc,mCAAI,eAAe,CAAC;IAC/D,CAAC;IAKD,8GAA8G;IACvG,MAAM,CAAC,MAAM,CAAC,KAAsC;QACzD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjD,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAmB;QACxC,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,IAAI,CAAC;YACd,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,cAAc,EAAE,KAAK,CAAC,cAAc;YACpC,QAAQ,EAAE,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC1C,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,WAAW,CAAC;YAChD,UAAU,EAAE,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC;YAC9C,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,WAAW,CAAC;SACjD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAmC;QAC9C,OAAO,IAAI,WAAW,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAAgB;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YAChC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;YACtC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;YACpC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;SACvC,CAAC;QAEF,IAAI,IAAI,CAAC,cAAc,KAAK,eAAe;YACzC,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAE7C,IAAI,IAAI,CAAC,WAAW,KAAK,eAAe;YACtC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAEvC,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4EAA4E;IACrE,MAAM,CAAC,KAAkB;QAC9B,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;YAC3H,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC3F,CAAC;;AA3DD,kDAAkD;AAC3B,oBAAQ,GAAG,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC;AA6DxD;;;GAGG;AACH,MAAM,OAAO,MAAM;IAIjB,YAAsB,QAAqB;QACzC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAKD,yGAAyG;IAClG,MAAM,CAAC,cAAc,CAAC,QAAsB;QACjD,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACvD,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAmB;QACxC,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE7C,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE;YAChB,QAAQ,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE;gBACxB,KAAK,eAAe,CAAC,SAAS;oBAC5B,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK,CAAC,OAAO;wBACnC,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;oBAEtD,MAAM;gBACR,KAAK,eAAe,CAAC,IAAI,CAAC,CAAC;oBACzB,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;oBAChC,IAAI,EAAE,IAAI,SAAS,KAAK,EAAE,CAAC,GAAG,IAAI,SAAS,KAAK,EAAE,CAAC,MAAM,IAAI,SAAS,KAAK,EAAE,CAAC,KAAK,IAAI,SAAS,KAAK,EAAE,CAAC,IAAI,IAAI,SAAS,KAAK,EAAE,CAAC,KAAK,IAAI,SAAS,KAAK,EAAE,CAAC,IAAI;wBAC7J,OAAO,IAAI,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;oBAEnC,MAAM;iBACP;aACF;SACF;QAED,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,OAAiB;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACrC,IAAI,SAAS,KAAK,OAAO;YACvB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAE1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAW,UAAU;QACnB,OAAO,EAAE,CAAC;IACZ,CAAC;;AA9CD,kDAAkD;AAC3B,eAAQ,GAAG,IAAI,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;AAgDrE;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,MAAM;IAInC;;;OAGG;IACH,YAAmB,KAAuB,EAAE,QAAsB;QAChE,KAAK,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,yBAAyB;IACT,MAAM,CAAC,OAAiB;QACtC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACpC,KAAK,CAAC,KAAK,GAAG;YACZ,IAAI,EAAE,eAAe,CAAC,SAAS;YAC/B,OAAO,EAAE,IAAI,CAAC,KAAK;SACpB,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAoB,UAAU;QAC5B,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1D,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,OAAQ,SAAQ,MAAM;IAIjC;;;OAGG;IACH,YAAmB,MAAoB,EAAE,QAAsB;QAC7D,KAAK,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;IAC9B,CAAC;IAED,yBAAyB;IACT,MAAM,CAAC,OAAiB;QACtC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACpC,KAAK,CAAC,KAAK,GAAG;YACZ,IAAI,EAAE,eAAe,CAAC,IAAI;YAC1B,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE;SAC7B,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAoB,UAAU;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAClH,CAAC;CACF","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 DisplayStyles\r\n */\r\n\r\nimport { Id64, Id64String, NonFunctionPropertiesOf } from \"@itwin/core-bentley\";\r\nimport { ColorDef, ColorDefProps } from \"./ColorDef\";\r\nimport { TextureImageSpec } from \"./RenderTexture\";\r\n\r\n/** Supported types of [[SkyBox]] images.\r\n * @see [[SkyBoxImageProps]].\r\n * @public\r\n */\r\nexport enum SkyBoxImageType {\r\n  /** No image, indicating a [[SkyGradient]] should be displayed. */\r\n  None = 0,\r\n  /** A single image mapped to the surface of a sphere.\r\n   * @see [[SkySphere]].\r\n   */\r\n  Spherical = 1,\r\n  /** @internal not yet supported */\r\n  Cylindrical = 2,\r\n  /** Six images mapped to the faces of a cube.\r\n   * @see [[SkyCube]].\r\n   */\r\n  Cube = 3,\r\n}\r\n\r\n/** JSON representation of the six images used by a [[SkyCube]].\r\n * Each property specifies the image for a face of the cube as either an image URL, or the Id of a [Texture]($backend) element.\r\n * Each image must be square and have the same dimensions as all the other images.\r\n * @public\r\n */\r\nexport interface SkyCubeProps {\r\n  front: TextureImageSpec;\r\n  back: TextureImageSpec;\r\n  top: TextureImageSpec;\r\n  bottom: TextureImageSpec;\r\n  right: TextureImageSpec;\r\n  left: TextureImageSpec;\r\n}\r\n\r\n/** JSON representation of the image used for a [[SkySphere]].\r\n * @see [[SkyBoxProps.image]].\r\n * @public\r\n */\r\nexport interface SkySphereImageProps {\r\n  type: SkyBoxImageType.Spherical;\r\n  texture: TextureImageSpec;\r\n  /** @internal */\r\n  textures?: never;\r\n}\r\n\r\n/** JSON representation of the images used for a [[SkyCube]].\r\n * @see [[SkyBoxProps.image]].\r\n * @public\r\n */\r\nexport interface SkyCubeImageProps {\r\n  type: SkyBoxImageType.Cube;\r\n  textures: SkyCubeProps;\r\n  /** @internal */\r\n  texture?: never;\r\n}\r\n\r\n/** JSON representation of the image(s) to be mapped to the surfaces of a [[SkyBox]].\r\n * @see [[SkyBoxProps.image]].\r\n * @public\r\n */\r\nexport type SkyBoxImageProps = SkySphereImageProps | SkyCubeImageProps | { type?: SkyBoxImageType, texture?: never, textures?: never };\r\n\r\n/** JSON representation of a [[SkyBox]] that can be drawn as the background of a [ViewState3d]($frontend).\r\n * An object of this type can describe one of several types of sky box:\r\n *  - A cube with a texture image mapped to each face; or\r\n *  - A sphere with a single texture image mapped to its surface; or\r\n *  - A sphere with a two- or four-color vertical [[Gradient]] mapped to its surface.\r\n *\r\n * Whether cuboid or spherical, the skybox is drawn as if the viewer and the contents of the view are contained within its interior.\r\n *\r\n * For a two-color gradient, the gradient transitions smoothly from the nadir color at the bottom of the sphere to the zenith color at the top of the sphere.\r\n * The sky and ground colors are unused, as are the sky and ground exponents.\r\n *\r\n * For a four-color gradient, a \"horizon\" is produced on the equator of the sphere, where the ground color and sky color meet. The lower half of the sphere transitions\r\n * smoothly from the ground color at the equator to the nadir color at the bottom, and the upper half transitions from the sky color at the equator to the zenith color at\r\n * the top of the sphere.\r\n *\r\n * The color and exponent properties are unused if one or more texture images are supplied.\r\n *\r\n * @see [[DisplayStyle3dSettings.environment]] to define the skybox for a display style.\r\n * @public\r\n */\r\nexport interface SkyBoxProps {\r\n  /** Whether or not the skybox should be displayed.\r\n   * Default: false.\r\n   */\r\n  display?: boolean;\r\n  /** For a [[SkyGradient]], if true, a 2-color gradient skybox is used instead of a 4-color.\r\n   * Default: false.\r\n   */\r\n  twoColor?: boolean;\r\n  /** The color of the sky at the horizon. Unused unless this is a four-color [[SkyGradient]].\r\n   * Default: (143, 205, 255).\r\n   */\r\n  skyColor?: ColorDefProps;\r\n  /** The color of the ground at the horizon. Unused unless this is a four-color [[SkyGradient]].\r\n   * Default: (120, 143, 125).\r\n   */\r\n  groundColor?: ColorDefProps;\r\n  /** The color of the top of the sphere.\r\n   * Default: (54, 117, 255).\r\n   */\r\n  zenithColor?: ColorDefProps;\r\n  /** The color of the bottom of the sphere.\r\n   * Default: (40, 15, 0).\r\n   */\r\n  nadirColor?: ColorDefProps;\r\n  /** For a 4-color [[SkyGradient]], controls speed of change from sky color to zenith color; otherwise unused.\r\n   * Default: 4.0.\r\n   */\r\n  skyExponent?: number;\r\n  /** For a 4-color [[SkyGradient]], controls speed of change from ground color to nadir color; otherwise unused.\r\n   * Default: 4.0.\r\n   */\r\n  groundExponent?: number;\r\n  /** The image(s), if any, to be mapped to the surfaces of the sphere or cube. If undefined, the skybox will be displayed as a gradient instead.\r\n   * Default: undefined.\r\n   */\r\n  image?: SkyBoxImageProps;\r\n}\r\n\r\nconst defaultGroundColor = ColorDef.from(143, 205, 125);\r\nconst defaultZenithColor = ColorDef.from(54, 117, 255);\r\nconst defaultNadirColor = ColorDef.from(40, 125, 0);\r\nconst defaultSkyColor = ColorDef.from(142, 205, 255);\r\nconst defaultExponent = 4.0;\r\n\r\nfunction colorDefFromJson(props?: ColorDefProps): ColorDef | undefined {\r\n  return undefined !== props ? ColorDef.fromJSON(props) : undefined;\r\n}\r\n\r\n/** A type containing all of the properties and none of the methods of [[SkyGradient]] with `readonly` modifiers removed.\r\n * @see [[SkyGradient.create]] and [[SkyGradient.clone]].\r\n * @public\r\n */\r\nexport type SkyGradientProperties = NonFunctionPropertiesOf<SkyGradient>;\r\n\r\n/** Describes how to map a two- or four-color [[Gradient]] to the interior of a sphere to produce a [[SkyBox]].\r\n * @see [[SkyBox.gradient]].\r\n * @public\r\n */\r\nexport class SkyGradient {\r\n  public readonly twoColor: boolean;\r\n  public readonly skyColor: ColorDef;\r\n  public readonly groundColor: ColorDef;\r\n  public readonly zenithColor: ColorDef;\r\n  public readonly nadirColor: ColorDef;\r\n  public readonly skyExponent: number;\r\n  public readonly groundExponent: number;\r\n\r\n  private constructor(args: Partial<SkyGradientProperties>) {\r\n    this.twoColor = args.twoColor ?? false;\r\n    this.skyColor = args.skyColor ?? defaultSkyColor;\r\n    this.groundColor = args.groundColor ?? defaultGroundColor;\r\n    this.nadirColor = args.nadirColor ?? defaultNadirColor;\r\n    this.zenithColor = args.zenithColor ?? defaultZenithColor;\r\n    this.skyExponent = args.skyExponent ?? defaultExponent;\r\n    this.groundExponent = args.groundExponent ?? defaultExponent;\r\n  }\r\n\r\n  /** Default settings for a four-color gradient. */\r\n  public static readonly defaults = new SkyGradient({});\r\n\r\n  /** Create a new gradient. Any properties not specified by `props` are initialized to their default values. */\r\n  public static create(props?: Partial<SkyGradientProperties>): SkyGradient {\r\n    return props ? new this(props) : this.defaults;\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props?: SkyBoxProps): SkyGradient {\r\n    if (!props)\r\n      return this.defaults;\r\n\r\n    return new this({\r\n      twoColor: props.twoColor,\r\n      skyExponent: props.skyExponent,\r\n      groundExponent: props.groundExponent,\r\n      skyColor: colorDefFromJson(props.skyColor),\r\n      groundColor: colorDefFromJson(props.groundColor),\r\n      nadirColor: colorDefFromJson(props.nadirColor),\r\n      zenithColor: colorDefFromJson(props.zenithColor),\r\n    });\r\n  }\r\n\r\n  /** Create ea copy of this gradient, identical except for any properties explicitly specified by `changedProps`.\r\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\r\n   */\r\n  public clone(changedProps: SkyGradientProperties): SkyGradient {\r\n    return new SkyGradient({ ...this, ...changedProps });\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): SkyBoxProps {\r\n    const props: SkyBoxProps = {\r\n      skyColor: this.skyColor.toJSON(),\r\n      groundColor: this.groundColor.toJSON(),\r\n      nadirColor: this.nadirColor.toJSON(),\r\n      zenithColor: this.zenithColor.toJSON(),\r\n    };\r\n\r\n    if (this.groundExponent !== defaultExponent)\r\n      props.groundExponent = this.groundExponent;\r\n\r\n    if (this.skyExponent !== defaultExponent)\r\n      props.skyExponent = this.skyExponent;\r\n\r\n    if (this.twoColor)\r\n      props.twoColor = this.twoColor;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if this gradient is equivalent to the supplied gradient. */\r\n  public equals(other: SkyGradient): boolean {\r\n    if (this === other)\r\n      return true;\r\n\r\n    return this.twoColor === other.twoColor && this.skyColor.equals(other.skyColor) && this.groundColor.equals(other.groundColor) &&\r\n      this.zenithColor.equals(other.zenithColor) && this.nadirColor.equals(other.nadirColor);\r\n  }\r\n}\r\n\r\n/** Describes how to draw a representation of a sky, as part of an [[Environment]].\r\n * @see [[SkyBoxProps]].\r\n * @public\r\n */\r\nexport class SkyBox {\r\n  /** The gradient settings, used if no cube or sphere images are supplied, or if the images cannot be loaded. */\r\n  public readonly gradient: SkyGradient;\r\n\r\n  protected constructor(gradient: SkyGradient) {\r\n    this.gradient = gradient;\r\n  }\r\n\r\n  /** Default settings for a four-color gradient. */\r\n  public static readonly defaults = new SkyBox(SkyGradient.defaults);\r\n\r\n  /** Create a skybox that displays the specified gradient, or the default gradient if none is supplied. */\r\n  public static createGradient(gradient?: SkyGradient): SkyBox {\r\n    return gradient ? new this(gradient) : this.defaults;\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props?: SkyBoxProps): SkyBox {\r\n    const gradient = SkyGradient.fromJSON(props);\r\n\r\n    if (props?.image) {\r\n      switch (props.image.type) {\r\n        case SkyBoxImageType.Spherical:\r\n          if (undefined !== props.image.texture)\r\n            return new SkySphere(props.image.texture, gradient);\r\n\r\n          break;\r\n        case SkyBoxImageType.Cube: {\r\n          const tx = props.image.textures;\r\n          if (tx && undefined !== tx.top && undefined !== tx.bottom && undefined !== tx.right && undefined !== tx.left && undefined !== tx.front && undefined !== tx.back)\r\n            return new SkyCube(tx, gradient);\r\n\r\n          break;\r\n        }\r\n      }\r\n    }\r\n\r\n    return this.createGradient(gradient);\r\n  }\r\n\r\n  /** Convert to JSON representation.\r\n   * @param display If defined, the value to use for [[SkyBoxProps.display]]; otherwise, that property will be left undefined.\r\n   */\r\n  public toJSON(display?: boolean): SkyBoxProps {\r\n    const props = this.gradient.toJSON();\r\n    if (undefined !== display)\r\n      props.display = display;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public get textureIds(): Iterable<Id64String> {\r\n    return [];\r\n  }\r\n}\r\n\r\n/** Describes how to draw a representation of a sky by mapping a single image to the interior of a sphere.\r\n * @public\r\n */\r\nexport class SkySphere extends SkyBox {\r\n  /** The image to map to the interior of the sphere. */\r\n  public readonly image: TextureImageSpec;\r\n\r\n  /** Create a new sky sphere using the specified image.\r\n   * @param image The image to map to the interior of the sphere.\r\n   * @param gradient Optionally overrides the default gradient settings used if the image cannot be obtained.\r\n   */\r\n  public constructor(image: TextureImageSpec, gradient?: SkyGradient) {\r\n    super(gradient ?? SkyGradient.defaults);\r\n    this.image = image;\r\n  }\r\n\r\n  /** @internal override */\r\n  public override toJSON(display?: boolean): SkyBoxProps {\r\n    const props = super.toJSON(display);\r\n    props.image = {\r\n      type: SkyBoxImageType.Spherical,\r\n      texture: this.image,\r\n    };\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override get textureIds(): Iterable<Id64String> {\r\n    return Id64.isValidId64(this.image) ? [this.image] : [];\r\n  }\r\n}\r\n\r\n/** Describes how to draw a representation of a sky by mapping images to the interior faces of a cube.\r\n * The images are required to be *square*, and each image must have the same dimensions as the other images.\r\n * @public\r\n */\r\nexport class SkyCube extends SkyBox {\r\n  /** The images to map to each face of the cube. */\r\n  public readonly images: SkyCubeProps;\r\n\r\n  /** Create a new sky cube using the specified images.\r\n   * @param images The images to map to each face of the cube.\r\n   * @param Optionally overrides  the default gradient settings used if the images cannot be obtained.\r\n   */\r\n  public constructor(images: SkyCubeProps, gradient?: SkyGradient) {\r\n    super(gradient ?? SkyGradient.defaults);\r\n    this.images = { ...images };\r\n  }\r\n\r\n  /** @internal override */\r\n  public override toJSON(display?: boolean): SkyBoxProps {\r\n    const props = super.toJSON(display);\r\n    props.image = {\r\n      type: SkyBoxImageType.Cube,\r\n      textures: { ...this.images },\r\n    };\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override get textureIds(): Iterable<Id64String> {\r\n    const imgs = this.images;\r\n    return [imgs.front, imgs.back, imgs.top, imgs.bottom, imgs.left, imgs.right].filter((x) => Id64.isValidId64(x));\r\n  }\r\n}\r\n"]}

package/lib/esm/TextureMapping.d.ts

@@ -53,6 +53,8 @@ export declare namespace TextureMapping {
          * ```
          */
         constructor(m00?: number, m01?: number, originX?: number, m10?: number, m11?: number, originY?: number);
+        /** An immutable 2x3 identity matrix. */
+        static readonly identity: Trans2x3;
     }
     /** Properties used to construct a [[TextureMapping.Params]]. */
     interface ParamProps {
@@ -83,7 +85,7 @@ export declare namespace TextureMapping {
         mode: TextureMapping.Mode;
         /** @internal */
         worldMapping: boolean;
-        constructor(props?: ParamProps);
+        constructor(props?: TextureMapping.ParamProps);
         /**
          * Generates UV parameters for textured surfaces. Returns undefined on failure.
          * @internal

package/lib/esm/TextureMapping.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextureMapping.d.ts","sourceRoot":"","sources":["../../src/TextureMapping.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAY,OAAO,EAAW,eAAe,EAAE,SAAS,EAAY,MAAM,sBAAsB,CAAC;AAChI,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;GAEG;AACH,qBAAa,cAAc;IACzB,+CAA+C;IAC/C,SAAgB,OAAO,EAAE,aAAa,CAAC;IACvC,gFAAgF;IAChF,SAAgB,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC;gBAE3B,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,cAAc,CAAC,MAAM;IAKnE,gBAAgB;IACT,eAAe,CAAC,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS;CAGtG;AAED,cAAc;AACd,yBAAiB,cAAc,CAAC;IAC9B,qDAAqD;IACrD,KAAY,IAAI;QACd,IAAI,KAAK;QACT,UAAU,IAAI;QACd,cAAc,IAAI;QAClB,MAAM,IAAI;QACV,gBAAgB;QAChB,gBAAgB,IAAI;QACpB,gBAAgB;QAChB,KAAK,IAAI;QACT,gBAAgB;QAChB,SAAS,IAAI;QACb,gBAAgB;QAChB,WAAW,IAAI;QACf,gBAAgB;QAChB,KAAK,IAAI;QACT,sCAAsC;QACtC,YAAY,IAAI;KACjB;IAED,6DAA6D;IAC7D,MAAa,QAAQ;QACnB,sDAAsD;QACtD,SAAgB,SAAS,EAAE,SAAS,CAAC;QAErC;;;;;;;;;;;WAWG;oBACgB,GAAG,SAAI,EAAE,GAAG,SAAI,EAAE,OAAO,SAAI,EAAE,GAAG,SAAI,EAAE,GAAG,SAAI,EAAE,OAAO,SAAI;KAKhF;IAED,gEAAgE;IAChE,UAAiB,UAAU;QACzB,qDAAqD;QACrD,aAAa,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC;QACxC;;;;WAIG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB;;WAEG;QACH,OAAO,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC;QAC9B,gBAAgB;QAChB,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB;IAED,oFAAoF;IACpF,MAAa,MAAM;QACjB,qDAAqD;QAC9C,aAAa,EAAE,cAAc,CAAC,QAAQ,CAAC;QAC9C;;WAEG;QACI,MAAM,EAAE,MAAM,CAAC;QACtB,uDAAuD;QAChD,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC;QACjC,gBAAgB;QACT,YAAY,EAAE,OAAO,CAAC;oBAEjB,KAAK,aAAkC;QAKnD;;;WAGG;QACI,eAAe,CAAC,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS;QAwB5G,yEAAyE;QACzE,OAAO,CAAC,yBAAyB;QAiBjC,sHAAsH;QACtH,OAAO,CAAC,qBAAqB;QA+C7B,+HAA+H;QAC/H,OAAO,CAAC,6BAA6B;KActC;CACF"}
+{"version":3,"file":"TextureMapping.d.ts","sourceRoot":"","sources":["../../src/TextureMapping.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,sBAAsB,EAAY,OAAO,EAAW,eAAe,EAAE,SAAS,EAAY,MAAM,sBAAsB,CAAC;AAChI,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;GAEG;AACH,qBAAa,cAAc;IACzB,+CAA+C;IAC/C,SAAgB,OAAO,EAAE,aAAa,CAAC;IACvC,gFAAgF;IAChF,SAAgB,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC;gBAE3B,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,cAAc,CAAC,MAAM;IAKnE,gBAAgB;IACT,eAAe,CAAC,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS;CAGtG;AAED,cAAc;AACd,yBAAiB,cAAc,CAAC;IAC9B,qDAAqD;IACrD,KAAY,IAAI;QACd,IAAI,KAAK;QACT,UAAU,IAAI;QACd,cAAc,IAAI;QAClB,MAAM,IAAI;QACV,gBAAgB;QAChB,gBAAgB,IAAI;QACpB,gBAAgB;QAChB,KAAK,IAAI;QACT,gBAAgB;QAChB,SAAS,IAAI;QACb,gBAAgB;QAChB,WAAW,IAAI;QACf,gBAAgB;QAChB,KAAK,IAAI;QACT,sCAAsC;QACtC,YAAY,IAAI;KACjB;IAED,6DAA6D;IAC7D,MAAa,QAAQ;QACnB,sDAAsD;QACtD,SAAgB,SAAS,EAAE,SAAS,CAAC;QAErC;;;;;;;;;;;WAWG;oBACgB,GAAG,SAAI,EAAE,GAAG,SAAI,EAAE,OAAO,SAAI,EAAE,GAAG,SAAI,EAAE,GAAG,SAAI,EAAE,OAAO,SAAI;QAM/E,wCAAwC;QACxC,gBAAuB,QAAQ,WAAkB;KAClD;IAED,gEAAgE;IAChE,UAAiB,UAAU;QACzB,qDAAqD;QACrD,aAAa,CAAC,EAAE,cAAc,CAAC,QAAQ,CAAC;QACxC;;;;WAIG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB;;WAEG;QACH,OAAO,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC;QAC9B,gBAAgB;QAChB,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB;IAED,oFAAoF;IACpF,MAAa,MAAM;QACjB,qDAAqD;QAC9C,aAAa,EAAE,cAAc,CAAC,QAAQ,CAAC;QAC9C;;WAEG;QACI,MAAM,EAAE,MAAM,CAAC;QACtB,uDAAuD;QAChD,IAAI,EAAE,cAAc,CAAC,IAAI,CAAC;QACjC,gBAAgB;QACT,YAAY,EAAE,OAAO,CAAC;oBAEV,KAAK,CAAC,EAAE,cAAc,CAAC,UAAU;QAOpD;;;WAGG;QACI,eAAe,CAAC,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS;QAwB5G,yEAAyE;QACzE,OAAO,CAAC,yBAAyB;QAiBjC,sHAAsH;QACtH,OAAO,CAAC,qBAAqB;QA+C7B,+HAA+H;QAC/H,OAAO,CAAC,6BAA6B;KActC;CACF"}

package/lib/esm/TextureMapping.js

@@ -61,15 +61,17 @@ export class TextureMapping {
             this.transform = Transform.createRefs(origin, matrix);
         }
     }
+    /** An immutable 2x3 identity matrix. */
+    Trans2x3.identity = new Trans2x3();
     TextureMapping.Trans2x3 = Trans2x3;
     /** Parameters describing how a [[RenderTexture]]'s image is mapped to a surface. */
     class Params {
-        constructor(props = {}) {
-            const { textureMat2x3 = new Trans2x3(), textureWeight = 1.0, mapMode = Mode.Parametric, worldMapping = false } = props;
-            this.textureMatrix = textureMat2x3;
-            this.weight = textureWeight;
-            this.mode = mapMode;
-            this.worldMapping = worldMapping;
+        constructor(props) {
+            var _a, _b, _c, _d;
+            this.textureMatrix = (_a = props === null || props === void 0 ? void 0 : props.textureMat2x3) !== null && _a !== void 0 ? _a : Trans2x3.identity;
+            this.weight = (_b = props === null || props === void 0 ? void 0 : props.textureWeight) !== null && _b !== void 0 ? _b : 1;
+            this.mode = (_c = props === null || props === void 0 ? void 0 : props.mapMode) !== null && _c !== void 0 ? _c : Mode.Parametric;
+            this.worldMapping = (_d = props === null || props === void 0 ? void 0 : props.worldMapping) !== null && _d !== void 0 ? _d : false;
         }
         /**
          * Generates UV parameters for textured surfaces. Returns undefined on failure.
@@ -165,4 +167,5 @@ export class TextureMapping {
     }
     TextureMapping.Params = Params;
 })(TextureMapping || (TextureMapping = {}));
+Object.freeze(TextureMapping.Trans2x3.identity);
 //# sourceMappingURL=TextureMapping.js.map

package/lib/esm/TextureMapping.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextureMapping.js","sourceRoot":"","sources":["../../src/TextureMapping.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAA0B,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAmB,SAAS,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAGhI;;GAEG;AACH,MAAM,OAAO,cAAc;IAMzB,YAAmB,EAAiB,EAAE,MAA6B;QACjE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,gBAAgB;IACT,eAAe,CAAC,OAAwB,EAAE,iBAA4B;QAC3E,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAiC,EAAE,iBAAiB,CAAC,CAAC;IAC3F,CAAC;CACF;AAED,cAAc;AACd,WAAiB,cAAc;IAC7B,qDAAqD;IACrD,IAAY,IAiBX;IAjBD,WAAY,IAAI;QACd,gCAAS,CAAA;QACT,2CAAc,CAAA;QACd,mDAAkB,CAAA;QAClB,mCAAU,CAAA;QACV,gBAAgB;QAChB,uDAAoB,CAAA;QACpB,gBAAgB;QAChB,iCAAS,CAAA;QACT,gBAAgB;QAChB,yCAAa,CAAA;QACb,gBAAgB;QAChB,6CAAe,CAAA;QACf,gBAAgB;QAChB,iCAAS,CAAA;QACT,sCAAsC;QACtC,+CAAgB,CAAA;IAClB,CAAC,EAjBW,IAAI,GAAJ,mBAAI,KAAJ,mBAAI,QAiBf;IAED,6DAA6D;IAC7D,MAAa,QAAQ;QAInB;;;;;;;;;;;WAWG;QACH,YAAmB,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,OAAO,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,OAAO,GAAG,CAAC;YAC7E,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,QAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3E,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACxD,CAAC;KACF;IArBY,uBAAQ,WAqBpB,CAAA;IAoBD,oFAAoF;IACpF,MAAa,MAAM;QAYjB,YAAY,QAAQ,EAA+B;YACjD,MAAM,EAAE,aAAa,GAAG,IAAI,QAAQ,EAAE,EAAE,aAAa,GAAG,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,YAAY,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC;YACvH,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;YAAC,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC;YAAC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;YAAC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACzH,CAAC;QAED;;;WAGG;QACI,eAAe,CAAC,OAA+B,EAAE,iBAA4B;YAClF,QAAQ,IAAI,CAAC,IAAI,EAAE;gBACjB,QAAQ,CAAE,6CAA6C;gBACvD,KAAK,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACnC,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;iBAClG;gBACD,KAAK,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAC/B,MAAM,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC;oBAC1C,IAAI,CAAC,aAAa;wBAChB,OAAO,SAAS,CAAC;oBAEnB,kFAAkF;oBAClF,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;wBACjJ,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;qBAClG;yBAAM;wBACL,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;qBAC1E;iBACF;gBACD,KAAK,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;oBACvC,OAAO,IAAI,CAAC,6BAA6B,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;iBACrG;aACF;QACH,CAAC;QAED,yEAAyE;QACjE,yBAAyB,CAAC,OAA+B,EAAE,WAAsB,EAAE,eAAwB;YACjH,MAAM,MAAM,GAAc,EAAE,CAAC;YAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,EAAE,EAAE;gBAClD,IAAI,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;gBAE7B,IAAI,eAAe,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE;oBACjE,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE;wBAChD,wGAAwG;wBACxG,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAE,CAAC;qBAC9B;iBACF;gBAED,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;aACjD;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,sHAAsH;QAC9G,qBAAqB,CAAC,OAA+B,EAAE,WAAsB;YACnF,MAAM,MAAM,GAAc,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAC7B,IAAI,MAAgB,CAAC;YAErB,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS;gBAC9B,MAAM,GAAG,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,CAAC;;gBAE9J,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAE,CAAC;YAE9D,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC;gBAC3B,OAAO,SAAS,CAAC;YAEnB,wEAAwE;YACxE,wEAAwE;YAExE,sGAAsG;YACtG,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAE3B,+BAA+B;YAC/B,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAE7D,sEAAsE;YACtE,0EAA0E;YAE1E,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,EAAE,CAAC;YACzC,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,4DAA4D;YAE9F,IAAI,SAAS,GAAG,IAAI,EAAE;gBACpB,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACrB,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;aACzB;YAED,MAAM,QAAQ,GAAG,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,CAAC;YAC7D,IAAI,CAAC,QAAQ;gBACX,OAAO,SAAS,CAAC;YAEnB,MAAM,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;YAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE;gBACjC,MAAM,MAAM,GAAG,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE9E,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;gBACxF,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;aACnD;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,+HAA+H;QACvH,6BAA6B,CAAC,OAA+B,EAAE,WAAsB,EAAE,iBAA6B;YAC1H,MAAM,MAAM,GAAc,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;YAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE;gBACjC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC;gBAE/D,IAAI,iBAAiB,KAAK,SAAS;oBACjC,iBAAiB,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAElD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;gBACvC,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;aACnD;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KACF;IA9HY,qBAAM,SA8HlB,CAAA;AACH,CAAC,EA/LgB,cAAc,KAAd,cAAc,QA+L9B","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 Rendering\r\n */\r\n\r\nimport { IndexedPolyfaceVisitor, Matrix3d, Point2d, Point3d, PolyfaceVisitor, Transform, Vector3d } from \"@itwin/core-geometry\";\r\nimport { RenderTexture } from \"./RenderTexture\";\r\n\r\n/** Describes how to map a [[RenderTexture]]'s image onto a surface as part of a [[RenderMaterial]].\r\n * @public\r\n */\r\nexport class TextureMapping {\r\n  /** The texture to be mapped to the surface. */\r\n  public readonly texture: RenderTexture;\r\n  /** The parameters describing how the texture image is mapped to the surface. */\r\n  public readonly params: TextureMapping.Params;\r\n\r\n  public constructor(tx: RenderTexture, params: TextureMapping.Params) {\r\n    this.texture = tx;\r\n    this.params = params;\r\n  }\r\n\r\n  /** @internal */\r\n  public computeUVParams(visitor: PolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined {\r\n    return this.params.computeUVParams(visitor as IndexedPolyfaceVisitor, transformToImodel);\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace TextureMapping { // eslint-disable-line no-redeclare\r\n  /** Enumerates the possible texture mapping modes. */\r\n  export enum Mode {\r\n    None = -1,\r\n    Parametric = 0,\r\n    ElevationDrape = 1,\r\n    Planar = 2,\r\n    /** @internal */\r\n    DirectionalDrape = 3,\r\n    /** @internal */\r\n    Cubic = 4,\r\n    /** @internal */\r\n    Spherical = 5,\r\n    /** @internal */\r\n    Cylindrical = 6,\r\n    /** @internal */\r\n    Solid = 7,\r\n    /** @internal Only valid for lights */\r\n    FrontProject = 8,\r\n  }\r\n\r\n  /** A 2x3 matrix for mapping a texture image to a surface. */\r\n  export class Trans2x3 {\r\n    /** The 3x4 transform produced from the 2x3 matrix. */\r\n    public readonly transform: Transform;\r\n\r\n    /** Construct from the two rows of the matrix:\r\n     * ```\r\n     *  | m00 m01 originX |\r\n     *  | m10 m11 originY |\r\n     * ```\r\n     * Producing the [Transform]($core-geometry):\r\n     * ```\r\n     *  | m00 m01 0 originX |\r\n     *  | m10 m11 0 originY |\r\n     *  | 0   0   1 0       |\r\n     * ```\r\n     */\r\n    public constructor(m00 = 1, m01 = 0, originX = 0, m10 = 0, m11 = 1, originY = 0) {\r\n      const origin = new Point3d(originX, originY, 0);\r\n      const matrix = Matrix3d.createRowValues(m00, m01, 0, m10, m11, 0, 0, 0, 1);\r\n      this.transform = Transform.createRefs(origin, matrix);\r\n    }\r\n  }\r\n\r\n  /** Properties used to construct a [[TextureMapping.Params]]. */\r\n  export interface ParamProps {\r\n    /** The matrix used to map the image to a surface. */\r\n    textureMat2x3?: TextureMapping.Trans2x3;\r\n    /** The ratio in [0, 1] with which to mix the color sampled from the texture with the surface's color.\r\n     * A value of 0.0 uses only the surface color. A value of 1.0 uses only the texture color. A value of 0.5 uses an even mix of both.\r\n     * @note This affects only the red, green, and blue components of the color. The alpha sampled from the texture is always multiplied by the surface color's alpha.\r\n     * @note Defaults to 1.0\r\n     */\r\n    textureWeight?: number;\r\n    /** The mode by which to map the image to a surface.\r\n     * @note Defaults to [[TextureMapping.Mode.Parametric]].\r\n     */\r\n    mapMode?: TextureMapping.Mode;\r\n    /** @internal */\r\n    worldMapping?: boolean;\r\n  }\r\n\r\n  /** Parameters describing how a [[RenderTexture]]'s image is mapped to a surface. */\r\n  export class Params {\r\n    /** The matrix used to map the image to a surface. */\r\n    public textureMatrix: TextureMapping.Trans2x3;\r\n    /** The ratio in [0, 1] with which to mix the color sampled from the texture with the element's color.\r\n     * A value of 0.0 uses only the element color. A value of 1.0 uses only the texture color.\r\n     */\r\n    public weight: number;\r\n    /** The mode by which to map the image to a surface. */\r\n    public mode: TextureMapping.Mode;\r\n    /** @internal */\r\n    public worldMapping: boolean;\r\n\r\n    constructor(props = {} as TextureMapping.ParamProps) {\r\n      const { textureMat2x3 = new Trans2x3(), textureWeight = 1.0, mapMode = Mode.Parametric, worldMapping = false } = props;\r\n      this.textureMatrix = textureMat2x3; this.weight = textureWeight; this.mode = mapMode; this.worldMapping = worldMapping;\r\n    }\r\n\r\n    /**\r\n     * Generates UV parameters for textured surfaces. Returns undefined on failure.\r\n     * @internal\r\n     */\r\n    public computeUVParams(visitor: IndexedPolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined {\r\n      switch (this.mode) {\r\n        default:  // Fall through to parametric in default case\r\n        case TextureMapping.Mode.Parametric: {\r\n          return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\r\n        }\r\n        case TextureMapping.Mode.Planar: {\r\n          const normalIndices = visitor.normalIndex;\r\n          if (!normalIndices)\r\n            return undefined;\r\n\r\n          // Ignore planar mode unless master or sub units for scaleMode and facet is planar\r\n          if (!this.worldMapping || (visitor.normalIndex !== undefined && (normalIndices[0] !== normalIndices[1] || normalIndices[0] !== normalIndices[2]))) {\r\n            return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\r\n          } else {\r\n            return this.computePlanarUVParams(visitor, this.textureMatrix.transform);\r\n          }\r\n        }\r\n        case TextureMapping.Mode.ElevationDrape: {\r\n          return this.computeElevationDrapeUVParams(visitor, this.textureMatrix.transform, transformToImodel);\r\n        }\r\n      }\r\n    }\r\n\r\n    /** Computes UV parameters given a texture mapping mode of parametric. */\r\n    private computeParametricUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, isRelativeUnits: boolean): Point2d[] {\r\n      const params: Point2d[] = [];\r\n      for (let i = 0; i < visitor.numEdgesThisFacet; i++) {\r\n        let param = Point2d.create();\r\n\r\n        if (isRelativeUnits || !visitor.tryGetDistanceParameter(i, param)) {\r\n          if (!visitor.tryGetNormalizedParameter(i, param)) {\r\n            // If mesh does not have facetFaceData, we still want to use the texture coordinates if they are present\r\n            param = visitor.getParam(i)!;\r\n          }\r\n        }\r\n\r\n        params.push(uvTransform.multiplyPoint2d(param));\r\n      }\r\n      return params;\r\n    }\r\n\r\n    /** Computes UV parameters given a texture mapping mode of planar. The result is stored in the Point2d array given. */\r\n    private computePlanarUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform): Point2d[] | undefined {\r\n      const params: Point2d[] = [];\r\n      const points = visitor.point;\r\n      let normal: Vector3d;\r\n\r\n      if (visitor.normal === undefined)\r\n        normal = points.getPoint3dAtUncheckedPointIndex(0).crossProductToPoints(points.getPoint3dAtUncheckedPointIndex(1), points.getPoint3dAtUncheckedPointIndex(2));\r\n      else\r\n        normal = visitor.normal.getVector3dAtCheckedVectorIndex(0)!;\r\n\r\n      if (!normal.normalize(normal))\r\n        return undefined;\r\n\r\n      // adjust U texture coordinate to be a continuous length starting at the\r\n      // origin. V coordinate stays the same. This mode assumes Z is up vector\r\n\r\n      // Flipping normal puts us in a planar coordinate system consistent with MicroStation's display system\r\n      normal.scale(-1.0, normal);\r\n\r\n      // pick the first vertex normal\r\n      const sideVector = Vector3d.create(normal.y, -normal.x, 0.0);\r\n\r\n      // if the magnitude of the normal is near zero, the real normal points\r\n      // almost straighten up.. In this case, use Y as the up vector to match QV\r\n\r\n      const magnitude = sideVector.magnitude();\r\n      sideVector.normalize(sideVector); // won't remain undefined if failed due to following check..\r\n\r\n      if (magnitude < 1e-3) {\r\n        normal.set(0, 0, -1);\r\n        sideVector.set(1, 0, 0);\r\n      }\r\n\r\n      const upVector = sideVector.crossProduct(normal).normalize();\r\n      if (!upVector)\r\n        return undefined;\r\n\r\n      const numEdges = visitor.numEdgesThisFacet;\r\n      for (let i = 0; i < numEdges; i++) {\r\n        const vector = Vector3d.createFrom(points.getPoint3dAtUncheckedPointIndex(i));\r\n\r\n        params.push(Point2d.create(vector.dotProduct(sideVector), vector.dotProduct(upVector)));\r\n        uvTransform.multiplyPoint2d(params[i], params[i]);\r\n      }\r\n      return params;\r\n    }\r\n\r\n    /** Computes UV parameters given a texture mapping mode of elevation drape. The result is stored in the Point2d array given. */\r\n    private computeElevationDrapeUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, transformToIModel?: Transform): Point2d[] {\r\n      const params: Point2d[] = [];\r\n      const numEdges = visitor.numEdgesThisFacet;\r\n      for (let i = 0; i < numEdges; i++) {\r\n        const point = visitor.point.getPoint3dAtUncheckedPointIndex(i);\r\n\r\n        if (transformToIModel !== undefined)\r\n          transformToIModel.multiplyPoint3d(point, point);\r\n\r\n        params.push(Point2d.createFrom(point));\r\n        uvTransform.multiplyPoint2d(params[i], params[i]);\r\n      }\r\n      return params;\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"TextureMapping.js","sourceRoot":"","sources":["../../src/TextureMapping.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAA0B,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAmB,SAAS,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAGhI;;GAEG;AACH,MAAM,OAAO,cAAc;IAMzB,YAAmB,EAAiB,EAAE,MAA6B;QACjE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,gBAAgB;IACT,eAAe,CAAC,OAAwB,EAAE,iBAA4B;QAC3E,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAiC,EAAE,iBAAiB,CAAC,CAAC;IAC3F,CAAC;CACF;AAED,cAAc;AACd,WAAiB,cAAc;IAC7B,qDAAqD;IACrD,IAAY,IAiBX;IAjBD,WAAY,IAAI;QACd,gCAAS,CAAA;QACT,2CAAc,CAAA;QACd,mDAAkB,CAAA;QAClB,mCAAU,CAAA;QACV,gBAAgB;QAChB,uDAAoB,CAAA;QACpB,gBAAgB;QAChB,iCAAS,CAAA;QACT,gBAAgB;QAChB,yCAAa,CAAA;QACb,gBAAgB;QAChB,6CAAe,CAAA;QACf,gBAAgB;QAChB,iCAAS,CAAA;QACT,sCAAsC;QACtC,+CAAgB,CAAA;IAClB,CAAC,EAjBW,IAAI,GAAJ,mBAAI,KAAJ,mBAAI,QAiBf;IAED,6DAA6D;IAC7D,MAAa,QAAQ;QAInB;;;;;;;;;;;WAWG;QACH,YAAmB,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,OAAO,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,OAAO,GAAG,CAAC;YAC7E,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,QAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3E,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACxD,CAAC;;IAED,wCAAwC;IACjB,iBAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAvBtC,uBAAQ,WAwBpB,CAAA;IAoBD,oFAAoF;IACpF,MAAa,MAAM;QAYjB,YAAmB,KAAiC;;YAClD,IAAI,CAAC,aAAa,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,aAAa,mCAAI,QAAQ,CAAC,QAAQ,CAAC;YAC/D,IAAI,CAAC,MAAM,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,aAAa,mCAAI,CAAC,CAAC;YACxC,IAAI,CAAC,IAAI,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,mCAAI,IAAI,CAAC,UAAU,CAAC;YAC9C,IAAI,CAAC,YAAY,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,mCAAI,KAAK,CAAC;QACnD,CAAC;QAED;;;WAGG;QACI,eAAe,CAAC,OAA+B,EAAE,iBAA4B;YAClF,QAAQ,IAAI,CAAC,IAAI,EAAE;gBACjB,QAAQ,CAAE,6CAA6C;gBACvD,KAAK,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACnC,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;iBAClG;gBACD,KAAK,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAC/B,MAAM,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC;oBAC1C,IAAI,CAAC,aAAa;wBAChB,OAAO,SAAS,CAAC;oBAEnB,kFAAkF;oBAClF,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,KAAK,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;wBACjJ,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;qBAClG;yBAAM;wBACL,OAAO,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;qBAC1E;iBACF;gBACD,KAAK,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;oBACvC,OAAO,IAAI,CAAC,6BAA6B,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;iBACrG;aACF;QACH,CAAC;QAED,yEAAyE;QACjE,yBAAyB,CAAC,OAA+B,EAAE,WAAsB,EAAE,eAAwB;YACjH,MAAM,MAAM,GAAc,EAAE,CAAC;YAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,EAAE,EAAE;gBAClD,IAAI,KAAK,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;gBAE7B,IAAI,eAAe,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE;oBACjE,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE;wBAChD,wGAAwG;wBACxG,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAE,CAAC;qBAC9B;iBACF;gBAED,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;aACjD;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,sHAAsH;QAC9G,qBAAqB,CAAC,OAA+B,EAAE,WAAsB;YACnF,MAAM,MAAM,GAAc,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAC7B,IAAI,MAAgB,CAAC;YAErB,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS;gBAC9B,MAAM,GAAG,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,CAAC;;gBAE9J,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAE,CAAC;YAE9D,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC;gBAC3B,OAAO,SAAS,CAAC;YAEnB,wEAAwE;YACxE,wEAAwE;YAExE,sGAAsG;YACtG,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAE3B,+BAA+B;YAC/B,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAE7D,sEAAsE;YACtE,0EAA0E;YAE1E,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,EAAE,CAAC;YACzC,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,4DAA4D;YAE9F,IAAI,SAAS,GAAG,IAAI,EAAE;gBACpB,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACrB,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;aACzB;YAED,MAAM,QAAQ,GAAG,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,CAAC;YAC7D,IAAI,CAAC,QAAQ;gBACX,OAAO,SAAS,CAAC;YAEnB,MAAM,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;YAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE;gBACjC,MAAM,MAAM,GAAG,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE9E,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;gBACxF,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;aACnD;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,+HAA+H;QACvH,6BAA6B,CAAC,OAA+B,EAAE,WAAsB,EAAE,iBAA6B;YAC1H,MAAM,MAAM,GAAc,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;YAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE;gBACjC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC,CAAC,CAAC;gBAE/D,IAAI,iBAAiB,KAAK,SAAS;oBACjC,iBAAiB,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAElD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;gBACvC,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;aACnD;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KACF;IAhIY,qBAAM,SAgIlB,CAAA;AACH,CAAC,EApMgB,cAAc,KAAd,cAAc,QAoM9B;AAED,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC","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 Rendering\r\n */\r\n\r\nimport { IndexedPolyfaceVisitor, Matrix3d, Point2d, Point3d, PolyfaceVisitor, Transform, Vector3d } from \"@itwin/core-geometry\";\r\nimport { RenderTexture } from \"./RenderTexture\";\r\n\r\n/** Describes how to map a [[RenderTexture]]'s image onto a surface as part of a [[RenderMaterial]].\r\n * @public\r\n */\r\nexport class TextureMapping {\r\n  /** The texture to be mapped to the surface. */\r\n  public readonly texture: RenderTexture;\r\n  /** The parameters describing how the texture image is mapped to the surface. */\r\n  public readonly params: TextureMapping.Params;\r\n\r\n  public constructor(tx: RenderTexture, params: TextureMapping.Params) {\r\n    this.texture = tx;\r\n    this.params = params;\r\n  }\r\n\r\n  /** @internal */\r\n  public computeUVParams(visitor: PolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined {\r\n    return this.params.computeUVParams(visitor as IndexedPolyfaceVisitor, transformToImodel);\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace TextureMapping { // eslint-disable-line no-redeclare\r\n  /** Enumerates the possible texture mapping modes. */\r\n  export enum Mode {\r\n    None = -1,\r\n    Parametric = 0,\r\n    ElevationDrape = 1,\r\n    Planar = 2,\r\n    /** @internal */\r\n    DirectionalDrape = 3,\r\n    /** @internal */\r\n    Cubic = 4,\r\n    /** @internal */\r\n    Spherical = 5,\r\n    /** @internal */\r\n    Cylindrical = 6,\r\n    /** @internal */\r\n    Solid = 7,\r\n    /** @internal Only valid for lights */\r\n    FrontProject = 8,\r\n  }\r\n\r\n  /** A 2x3 matrix for mapping a texture image to a surface. */\r\n  export class Trans2x3 {\r\n    /** The 3x4 transform produced from the 2x3 matrix. */\r\n    public readonly transform: Transform;\r\n\r\n    /** Construct from the two rows of the matrix:\r\n     * ```\r\n     *  | m00 m01 originX |\r\n     *  | m10 m11 originY |\r\n     * ```\r\n     * Producing the [Transform]($core-geometry):\r\n     * ```\r\n     *  | m00 m01 0 originX |\r\n     *  | m10 m11 0 originY |\r\n     *  | 0   0   1 0       |\r\n     * ```\r\n     */\r\n    public constructor(m00 = 1, m01 = 0, originX = 0, m10 = 0, m11 = 1, originY = 0) {\r\n      const origin = new Point3d(originX, originY, 0);\r\n      const matrix = Matrix3d.createRowValues(m00, m01, 0, m10, m11, 0, 0, 0, 1);\r\n      this.transform = Transform.createRefs(origin, matrix);\r\n    }\r\n\r\n    /** An immutable 2x3 identity matrix. */\r\n    public static readonly identity = new Trans2x3();\r\n  }\r\n\r\n  /** Properties used to construct a [[TextureMapping.Params]]. */\r\n  export interface ParamProps {\r\n    /** The matrix used to map the image to a surface. */\r\n    textureMat2x3?: TextureMapping.Trans2x3;\r\n    /** The ratio in [0, 1] with which to mix the color sampled from the texture with the surface's color.\r\n     * A value of 0.0 uses only the surface color. A value of 1.0 uses only the texture color. A value of 0.5 uses an even mix of both.\r\n     * @note This affects only the red, green, and blue components of the color. The alpha sampled from the texture is always multiplied by the surface color's alpha.\r\n     * @note Defaults to 1.0\r\n     */\r\n    textureWeight?: number;\r\n    /** The mode by which to map the image to a surface.\r\n     * @note Defaults to [[TextureMapping.Mode.Parametric]].\r\n     */\r\n    mapMode?: TextureMapping.Mode;\r\n    /** @internal */\r\n    worldMapping?: boolean;\r\n  }\r\n\r\n  /** Parameters describing how a [[RenderTexture]]'s image is mapped to a surface. */\r\n  export class Params {\r\n    /** The matrix used to map the image to a surface. */\r\n    public textureMatrix: TextureMapping.Trans2x3;\r\n    /** The ratio in [0, 1] with which to mix the color sampled from the texture with the element's color.\r\n     * A value of 0.0 uses only the element color. A value of 1.0 uses only the texture color.\r\n     */\r\n    public weight: number;\r\n    /** The mode by which to map the image to a surface. */\r\n    public mode: TextureMapping.Mode;\r\n    /** @internal */\r\n    public worldMapping: boolean;\r\n\r\n    public constructor(props?: TextureMapping.ParamProps) {\r\n      this.textureMatrix = props?.textureMat2x3 ?? Trans2x3.identity;\r\n      this.weight = props?.textureWeight ?? 1;\r\n      this.mode = props?.mapMode ?? Mode.Parametric;\r\n      this.worldMapping = props?.worldMapping ?? false;\r\n    }\r\n\r\n    /**\r\n     * Generates UV parameters for textured surfaces. Returns undefined on failure.\r\n     * @internal\r\n     */\r\n    public computeUVParams(visitor: IndexedPolyfaceVisitor, transformToImodel: Transform): Point2d[] | undefined {\r\n      switch (this.mode) {\r\n        default:  // Fall through to parametric in default case\r\n        case TextureMapping.Mode.Parametric: {\r\n          return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\r\n        }\r\n        case TextureMapping.Mode.Planar: {\r\n          const normalIndices = visitor.normalIndex;\r\n          if (!normalIndices)\r\n            return undefined;\r\n\r\n          // Ignore planar mode unless master or sub units for scaleMode and facet is planar\r\n          if (!this.worldMapping || (visitor.normalIndex !== undefined && (normalIndices[0] !== normalIndices[1] || normalIndices[0] !== normalIndices[2]))) {\r\n            return this.computeParametricUVParams(visitor, this.textureMatrix.transform, !this.worldMapping);\r\n          } else {\r\n            return this.computePlanarUVParams(visitor, this.textureMatrix.transform);\r\n          }\r\n        }\r\n        case TextureMapping.Mode.ElevationDrape: {\r\n          return this.computeElevationDrapeUVParams(visitor, this.textureMatrix.transform, transformToImodel);\r\n        }\r\n      }\r\n    }\r\n\r\n    /** Computes UV parameters given a texture mapping mode of parametric. */\r\n    private computeParametricUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, isRelativeUnits: boolean): Point2d[] {\r\n      const params: Point2d[] = [];\r\n      for (let i = 0; i < visitor.numEdgesThisFacet; i++) {\r\n        let param = Point2d.create();\r\n\r\n        if (isRelativeUnits || !visitor.tryGetDistanceParameter(i, param)) {\r\n          if (!visitor.tryGetNormalizedParameter(i, param)) {\r\n            // If mesh does not have facetFaceData, we still want to use the texture coordinates if they are present\r\n            param = visitor.getParam(i)!;\r\n          }\r\n        }\r\n\r\n        params.push(uvTransform.multiplyPoint2d(param));\r\n      }\r\n      return params;\r\n    }\r\n\r\n    /** Computes UV parameters given a texture mapping mode of planar. The result is stored in the Point2d array given. */\r\n    private computePlanarUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform): Point2d[] | undefined {\r\n      const params: Point2d[] = [];\r\n      const points = visitor.point;\r\n      let normal: Vector3d;\r\n\r\n      if (visitor.normal === undefined)\r\n        normal = points.getPoint3dAtUncheckedPointIndex(0).crossProductToPoints(points.getPoint3dAtUncheckedPointIndex(1), points.getPoint3dAtUncheckedPointIndex(2));\r\n      else\r\n        normal = visitor.normal.getVector3dAtCheckedVectorIndex(0)!;\r\n\r\n      if (!normal.normalize(normal))\r\n        return undefined;\r\n\r\n      // adjust U texture coordinate to be a continuous length starting at the\r\n      // origin. V coordinate stays the same. This mode assumes Z is up vector\r\n\r\n      // Flipping normal puts us in a planar coordinate system consistent with MicroStation's display system\r\n      normal.scale(-1.0, normal);\r\n\r\n      // pick the first vertex normal\r\n      const sideVector = Vector3d.create(normal.y, -normal.x, 0.0);\r\n\r\n      // if the magnitude of the normal is near zero, the real normal points\r\n      // almost straighten up.. In this case, use Y as the up vector to match QV\r\n\r\n      const magnitude = sideVector.magnitude();\r\n      sideVector.normalize(sideVector); // won't remain undefined if failed due to following check..\r\n\r\n      if (magnitude < 1e-3) {\r\n        normal.set(0, 0, -1);\r\n        sideVector.set(1, 0, 0);\r\n      }\r\n\r\n      const upVector = sideVector.crossProduct(normal).normalize();\r\n      if (!upVector)\r\n        return undefined;\r\n\r\n      const numEdges = visitor.numEdgesThisFacet;\r\n      for (let i = 0; i < numEdges; i++) {\r\n        const vector = Vector3d.createFrom(points.getPoint3dAtUncheckedPointIndex(i));\r\n\r\n        params.push(Point2d.create(vector.dotProduct(sideVector), vector.dotProduct(upVector)));\r\n        uvTransform.multiplyPoint2d(params[i], params[i]);\r\n      }\r\n      return params;\r\n    }\r\n\r\n    /** Computes UV parameters given a texture mapping mode of elevation drape. The result is stored in the Point2d array given. */\r\n    private computeElevationDrapeUVParams(visitor: IndexedPolyfaceVisitor, uvTransform: Transform, transformToIModel?: Transform): Point2d[] {\r\n      const params: Point2d[] = [];\r\n      const numEdges = visitor.numEdgesThisFacet;\r\n      for (let i = 0; i < numEdges; i++) {\r\n        const point = visitor.point.getPoint3dAtUncheckedPointIndex(i);\r\n\r\n        if (transformToIModel !== undefined)\r\n          transformToIModel.multiplyPoint3d(point, point);\r\n\r\n        params.push(Point2d.createFrom(point));\r\n        uvTransform.multiplyPoint2d(params[i], params[i]);\r\n      }\r\n      return params;\r\n    }\r\n  }\r\n}\r\n\r\nObject.freeze(TextureMapping.Trans2x3.identity);\r\n"]}