@itwin/core-common 4.0.0-dev.24 → 4.0.0-dev.28

package/lib/esm/RenderMaterial.js

@@ -1,73 +1,72 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Rendering
- */
-/** Represents a material which can be applied to a surface to control aspects of its appearance such as color, reflectivity, texture, and so on.
- * @public
- */
-export class RenderMaterial {
-    // eslint-disable-next-line deprecation/deprecation
-    constructor(params) {
-        this.key = params.key;
-        this.textureMapping = params.textureMapping;
-    }
-    get hasTexture() {
-        var _a;
-        return undefined !== ((_a = this.textureMapping) === null || _a === void 0 ? void 0 : _a.texture);
-    }
-}
-/** @public */
-(function (RenderMaterial) {
-    function clampToNormalizedRange(value) {
-        return Math.max(0.0, Math.min(1.0, value));
-    }
-    /** @deprecated in 3.x. Use [CreateRenderMaterialArgs]($frontend). */
-    class Params {
-        constructor(key) {
-            /** Diffuse weight in [0..1] */
-            this.diffuse = 0.6;
-            /** Specular weight in [0..1] */
-            this.specular = 0.4;
-            this.specularExponent = 13.5;
-            /** Currently unused. @alpha */
-            this.reflect = 0.0;
-            /** Currently unused. @alpha */
-            this.refract = 1.0;
-            /** Currently unused. @alpha */
-            this.ambient = .3;
-            /** Currently unused. @alpha */
-            this.shadows = true;
-            this.key = key;
-        }
-        /** A value from 0.0 (fully-transparent) to 1.0 (fully-opaque) controlling the transparency of surfaces to which this material is applied;
-         * or undefined if this material does not override surface transparency.
-         */
-        get alpha() { return this._alpha; }
-        set alpha(alpha) {
-            this._alpha = undefined !== alpha ? clampToNormalizedRange(alpha) : undefined;
-        }
-        /** Create a RenderMaterial params object using specified key and ColorDef values, as well as an optional texture mapping. */
-        // eslint-disable-next-line deprecation/deprecation
-        static fromColors(key, diffuseColor, specularColor, emissiveColor, reflectColor, textureMap) {
-            // eslint-disable-next-line deprecation/deprecation
-            const materialParams = new Params();
-            materialParams.key = key;
-            materialParams.diffuseColor = diffuseColor;
-            materialParams.specularColor = specularColor;
-            materialParams.emissiveColor = emissiveColor;
-            materialParams.reflectColor = reflectColor;
-            materialParams.textureMapping = textureMap;
-            return materialParams;
-        }
-    }
-    /** Obtain an immutable instance of a RenderMaterial with all default properties. */
-    // eslint-disable-next-line deprecation/deprecation
-    Params.defaults = new Params();
-    RenderMaterial.Params = Params;
-})(RenderMaterial || (RenderMaterial = {}));
-// eslint-disable-next-line deprecation/deprecation
-Object.freeze(RenderMaterial.Params.defaults);
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Rendering
+ */
+/** Represents a material which can be applied to a surface to control aspects of its appearance such as color, reflectivity, texture, and so on.
+ * @public
+ */
+export class RenderMaterial {
+    // eslint-disable-next-line deprecation/deprecation
+    constructor(params) {
+        this.key = params.key;
+        this.textureMapping = params.textureMapping;
+    }
+    get hasTexture() {
+        return undefined !== this.textureMapping?.texture;
+    }
+}
+/** @public */
+(function (RenderMaterial) {
+    function clampToNormalizedRange(value) {
+        return Math.max(0.0, Math.min(1.0, value));
+    }
+    /** @deprecated in 3.x. Use [CreateRenderMaterialArgs]($frontend). */
+    class Params {
+        constructor(key) {
+            /** Diffuse weight in [0..1] */
+            this.diffuse = 0.6;
+            /** Specular weight in [0..1] */
+            this.specular = 0.4;
+            this.specularExponent = 13.5;
+            /** Currently unused. @alpha */
+            this.reflect = 0.0;
+            /** Currently unused. @alpha */
+            this.refract = 1.0;
+            /** Currently unused. @alpha */
+            this.ambient = .3;
+            /** Currently unused. @alpha */
+            this.shadows = true;
+            this.key = key;
+        }
+        /** A value from 0.0 (fully-transparent) to 1.0 (fully-opaque) controlling the transparency of surfaces to which this material is applied;
+         * or undefined if this material does not override surface transparency.
+         */
+        get alpha() { return this._alpha; }
+        set alpha(alpha) {
+            this._alpha = undefined !== alpha ? clampToNormalizedRange(alpha) : undefined;
+        }
+        /** Create a RenderMaterial params object using specified key and ColorDef values, as well as an optional texture mapping. */
+        // eslint-disable-next-line deprecation/deprecation
+        static fromColors(key, diffuseColor, specularColor, emissiveColor, reflectColor, textureMap) {
+            // eslint-disable-next-line deprecation/deprecation
+            const materialParams = new Params();
+            materialParams.key = key;
+            materialParams.diffuseColor = diffuseColor;
+            materialParams.specularColor = specularColor;
+            materialParams.emissiveColor = emissiveColor;
+            materialParams.reflectColor = reflectColor;
+            materialParams.textureMapping = textureMap;
+            return materialParams;
+        }
+    }
+    /** Obtain an immutable instance of a RenderMaterial with all default properties. */
+    // eslint-disable-next-line deprecation/deprecation
+    Params.defaults = new Params();
+    RenderMaterial.Params = Params;
+})(RenderMaterial || (RenderMaterial = {}));
+// eslint-disable-next-line deprecation/deprecation
+Object.freeze(RenderMaterial.Params.defaults);
 //# sourceMappingURL=RenderMaterial.js.map

package/lib/esm/RenderMaterial.js.map

@@ -1 +1 @@
-{"version":3,"file":"RenderMaterial.js","sourceRoot":"","sources":["../../src/RenderMaterial.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH;;GAEG;AACH,MAAM,OAAgB,cAAc;IAMlC,mDAAmD;IACnD,YAAsB,MAA6B;QACjD,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;QACtB,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;IAC9C,CAAC;IAED,IAAW,UAAU;;QACnB,OAAO,SAAS,MAAK,MAAA,IAAI,CAAC,cAAc,0CAAE,OAAO,CAAA,CAAC;IACpD,CAAC;CACF;AAED,cAAc;AACd,WAAiB,cAAc;IAC7B,SAAS,sBAAsB,CAAC,KAAa;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,qEAAqE;IACrE,MAAa,MAAM;QA4BjB,YAAmB,GAAY;YAf/B,+BAA+B;YACxB,YAAO,GAAW,GAAG,CAAC;YAC7B,gCAAgC;YACzB,aAAQ,GAAW,GAAG,CAAC;YACvB,qBAAgB,GAAW,IAAI,CAAC;YACvC,+BAA+B;YACxB,YAAO,GAAW,GAAG,CAAC;YAC7B,+BAA+B;YACxB,YAAO,GAAW,GAAG,CAAC;YAC7B,+BAA+B;YACxB,YAAO,GAAW,EAAE,CAAC;YAC5B,+BAA+B;YACxB,YAAO,GAAG,IAAI,CAAC;YAGa,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QAAC,CAAC;QAMpD;;WAEG;QACH,IAAW,KAAK,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9D,IAAW,KAAK,CAAC,KAAyB;YACxC,IAAI,CAAC,MAAM,GAAG,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAChF,CAAC;QAED,6HAA6H;QAC7H,mDAAmD;QAC5C,MAAM,CAAC,UAAU,CAAC,GAAY,EAAE,YAAuB,EAAE,aAAwB,EAAE,aAAwB,EAAE,YAAuB,EAAE,UAA2B;YACtK,mDAAmD;YACnD,MAAM,cAAc,GAAG,IAAI,MAAM,EAAE,CAAC;YACpC,cAAc,CAAC,GAAG,GAAG,GAAG,CAAC;YACzB,cAAc,CAAC,YAAY,GAAG,YAAY,CAAC;YAC3C,cAAc,CAAC,aAAa,GAAG,aAAa,CAAC;YAC7C,cAAc,CAAC,aAAa,GAAG,aAAa,CAAC;YAC7C,cAAc,CAAC,YAAY,GAAG,YAAY,CAAC;YAC3C,cAAc,CAAC,cAAc,GAAG,UAAU,CAAC;YAC3C,OAAO,cAAc,CAAC;QACxB,CAAC;;IAxBD,oFAAoF;IACpF,mDAAmD;IAC5B,eAAQ,GAAG,IAAI,MAAM,EAAE,CAAC;IAhCpC,qBAAM,SAuDlB,CAAA;AACH,CAAC,EA9DgB,cAAc,KAAd,cAAc,QA8D9B;AAED,mDAAmD;AACnD,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,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 { ColorDef } from \"./ColorDef\";\r\nimport { TextureMapping } from \"./TextureMapping\";\r\n\r\n/** Represents a material which can be applied to a surface to control aspects of its appearance such as color, reflectivity, texture, and so on.\r\n * @public\r\n */\r\nexport abstract class RenderMaterial {\r\n  /** If the material originated from a Material element in the [[IModelDb]], the Id of that element. */\r\n  public readonly key?: string;\r\n  /** Describes how to map an image to a surface to which this material is applied. */\r\n  public readonly textureMapping?: TextureMapping;\r\n\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  protected constructor(params: RenderMaterial.Params) {\r\n    this.key = params.key;\r\n    this.textureMapping = params.textureMapping;\r\n  }\r\n\r\n  public get hasTexture(): boolean {\r\n    return undefined !== this.textureMapping?.texture;\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace RenderMaterial { // eslint-disable-line no-redeclare\r\n  function clampToNormalizedRange(value: number): number {\r\n    return Math.max(0.0, Math.min(1.0, value));\r\n  }\r\n\r\n  /** @deprecated in 3.x. Use [CreateRenderMaterialArgs]($frontend). */\r\n  export class Params {\r\n    /** If the material originates from a Material element in the [[IModel]], the Id of that element. */\r\n    public key?: string;\r\n    /** Diffuse color, or undefined if this material does not override the surface's own color. */\r\n    public diffuseColor?: ColorDef;\r\n    /** Specular color. Defaults to white if undefined. */\r\n    public specularColor?: ColorDef;\r\n    /** Currently unused. @alpha */\r\n    public emissiveColor?: ColorDef;\r\n    /** Currently unused. @alpha */\r\n    public reflectColor?: ColorDef;\r\n    /** Optional pattern mapping applied to the surface. */\r\n    public textureMapping?: TextureMapping;\r\n    /** Diffuse weight in [0..1] */\r\n    public diffuse: number = 0.6;\r\n    /** Specular weight in [0..1] */\r\n    public specular: number = 0.4;\r\n    public specularExponent: number = 13.5;\r\n    /** Currently unused. @alpha */\r\n    public reflect: number = 0.0;\r\n    /** Currently unused. @alpha */\r\n    public refract: number = 1.0;\r\n    /** Currently unused. @alpha */\r\n    public ambient: number = .3;\r\n    /** Currently unused. @alpha */\r\n    public shadows = true;\r\n    private _alpha?: number;\r\n\r\n    public constructor(key?: string) { this.key = key; }\r\n\r\n    /** Obtain an immutable instance of a RenderMaterial with all default properties. */\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    public static readonly defaults = new Params();\r\n\r\n    /** A value from 0.0 (fully-transparent) to 1.0 (fully-opaque) controlling the transparency of surfaces to which this material is applied;\r\n     * or undefined if this material does not override surface transparency.\r\n     */\r\n    public get alpha(): number | undefined { return this._alpha; }\r\n    public set alpha(alpha: number | undefined) {\r\n      this._alpha = undefined !== alpha ? clampToNormalizedRange(alpha) : undefined;\r\n    }\r\n\r\n    /** Create a RenderMaterial params object using specified key and ColorDef values, as well as an optional texture mapping. */\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    public static fromColors(key?: string, diffuseColor?: ColorDef, specularColor?: ColorDef, emissiveColor?: ColorDef, reflectColor?: ColorDef, textureMap?: TextureMapping): Params {\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      const materialParams = new Params();\r\n      materialParams.key = key;\r\n      materialParams.diffuseColor = diffuseColor;\r\n      materialParams.specularColor = specularColor;\r\n      materialParams.emissiveColor = emissiveColor;\r\n      materialParams.reflectColor = reflectColor;\r\n      materialParams.textureMapping = textureMap;\r\n      return materialParams;\r\n    }\r\n  }\r\n}\r\n\r\n// eslint-disable-next-line deprecation/deprecation\r\nObject.freeze(RenderMaterial.Params.defaults);\r\n"]}
+{"version":3,"file":"RenderMaterial.js","sourceRoot":"","sources":["../../src/RenderMaterial.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH;;GAEG;AACH,MAAM,OAAgB,cAAc;IAMlC,mDAAmD;IACnD,YAAsB,MAA6B;QACjD,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;QACtB,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;IAC9C,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,SAAS,KAAK,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC;IACpD,CAAC;CACF;AAED,cAAc;AACd,WAAiB,cAAc;IAC7B,SAAS,sBAAsB,CAAC,KAAa;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,qEAAqE;IACrE,MAAa,MAAM;QA4BjB,YAAmB,GAAY;YAf/B,+BAA+B;YACxB,YAAO,GAAW,GAAG,CAAC;YAC7B,gCAAgC;YACzB,aAAQ,GAAW,GAAG,CAAC;YACvB,qBAAgB,GAAW,IAAI,CAAC;YACvC,+BAA+B;YACxB,YAAO,GAAW,GAAG,CAAC;YAC7B,+BAA+B;YACxB,YAAO,GAAW,GAAG,CAAC;YAC7B,+BAA+B;YACxB,YAAO,GAAW,EAAE,CAAC;YAC5B,+BAA+B;YACxB,YAAO,GAAG,IAAI,CAAC;YAGa,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QAAC,CAAC;QAMpD;;WAEG;QACH,IAAW,KAAK,KAAyB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC9D,IAAW,KAAK,CAAC,KAAyB;YACxC,IAAI,CAAC,MAAM,GAAG,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAChF,CAAC;QAED,6HAA6H;QAC7H,mDAAmD;QAC5C,MAAM,CAAC,UAAU,CAAC,GAAY,EAAE,YAAuB,EAAE,aAAwB,EAAE,aAAwB,EAAE,YAAuB,EAAE,UAA2B;YACtK,mDAAmD;YACnD,MAAM,cAAc,GAAG,IAAI,MAAM,EAAE,CAAC;YACpC,cAAc,CAAC,GAAG,GAAG,GAAG,CAAC;YACzB,cAAc,CAAC,YAAY,GAAG,YAAY,CAAC;YAC3C,cAAc,CAAC,aAAa,GAAG,aAAa,CAAC;YAC7C,cAAc,CAAC,aAAa,GAAG,aAAa,CAAC;YAC7C,cAAc,CAAC,YAAY,GAAG,YAAY,CAAC;YAC3C,cAAc,CAAC,cAAc,GAAG,UAAU,CAAC;YAC3C,OAAO,cAAc,CAAC;QACxB,CAAC;;IAxBD,oFAAoF;IACpF,mDAAmD;IAC5B,eAAQ,GAAG,IAAI,MAAM,EAAE,CAAC;IAhCpC,qBAAM,SAuDlB,CAAA;AACH,CAAC,EA9DgB,cAAc,KAAd,cAAc,QA8D9B;AAED,mDAAmD;AACnD,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Rendering\n */\n\nimport { ColorDef } from \"./ColorDef\";\nimport { TextureMapping } from \"./TextureMapping\";\n\n/** Represents a material which can be applied to a surface to control aspects of its appearance such as color, reflectivity, texture, and so on.\n * @public\n */\nexport abstract class RenderMaterial {\n  /** If the material originated from a Material element in the [[IModelDb]], the Id of that element. */\n  public readonly key?: string;\n  /** Describes how to map an image to a surface to which this material is applied. */\n  public readonly textureMapping?: TextureMapping;\n\n  // eslint-disable-next-line deprecation/deprecation\n  protected constructor(params: RenderMaterial.Params) {\n    this.key = params.key;\n    this.textureMapping = params.textureMapping;\n  }\n\n  public get hasTexture(): boolean {\n    return undefined !== this.textureMapping?.texture;\n  }\n}\n\n/** @public */\nexport namespace RenderMaterial { // eslint-disable-line no-redeclare\n  function clampToNormalizedRange(value: number): number {\n    return Math.max(0.0, Math.min(1.0, value));\n  }\n\n  /** @deprecated in 3.x. Use [CreateRenderMaterialArgs]($frontend). */\n  export class Params {\n    /** If the material originates from a Material element in the [[IModel]], the Id of that element. */\n    public key?: string;\n    /** Diffuse color, or undefined if this material does not override the surface's own color. */\n    public diffuseColor?: ColorDef;\n    /** Specular color. Defaults to white if undefined. */\n    public specularColor?: ColorDef;\n    /** Currently unused. @alpha */\n    public emissiveColor?: ColorDef;\n    /** Currently unused. @alpha */\n    public reflectColor?: ColorDef;\n    /** Optional pattern mapping applied to the surface. */\n    public textureMapping?: TextureMapping;\n    /** Diffuse weight in [0..1] */\n    public diffuse: number = 0.6;\n    /** Specular weight in [0..1] */\n    public specular: number = 0.4;\n    public specularExponent: number = 13.5;\n    /** Currently unused. @alpha */\n    public reflect: number = 0.0;\n    /** Currently unused. @alpha */\n    public refract: number = 1.0;\n    /** Currently unused. @alpha */\n    public ambient: number = .3;\n    /** Currently unused. @alpha */\n    public shadows = true;\n    private _alpha?: number;\n\n    public constructor(key?: string) { this.key = key; }\n\n    /** Obtain an immutable instance of a RenderMaterial with all default properties. */\n    // eslint-disable-next-line deprecation/deprecation\n    public static readonly defaults = new Params();\n\n    /** A value from 0.0 (fully-transparent) to 1.0 (fully-opaque) controlling the transparency of surfaces to which this material is applied;\n     * or undefined if this material does not override surface transparency.\n     */\n    public get alpha(): number | undefined { return this._alpha; }\n    public set alpha(alpha: number | undefined) {\n      this._alpha = undefined !== alpha ? clampToNormalizedRange(alpha) : undefined;\n    }\n\n    /** Create a RenderMaterial params object using specified key and ColorDef values, as well as an optional texture mapping. */\n    // eslint-disable-next-line deprecation/deprecation\n    public static fromColors(key?: string, diffuseColor?: ColorDef, specularColor?: ColorDef, emissiveColor?: ColorDef, reflectColor?: ColorDef, textureMap?: TextureMapping): Params {\n      // eslint-disable-next-line deprecation/deprecation\n      const materialParams = new Params();\n      materialParams.key = key;\n      materialParams.diffuseColor = diffuseColor;\n      materialParams.specularColor = specularColor;\n      materialParams.emissiveColor = emissiveColor;\n      materialParams.reflectColor = reflectColor;\n      materialParams.textureMapping = textureMap;\n      return materialParams;\n    }\n  }\n}\n\n// eslint-disable-next-line deprecation/deprecation\nObject.freeze(RenderMaterial.Params.defaults);\n"]}