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

package/lib/cjs/Material.d.ts

@@ -1,102 +1,104 @@
-/** @packageDocumentation
- * @module Elements
- */
-import { Id64String } from "@itwin/core-bentley";
-import { Code, CodeScopeProps, RenderMaterialProps, TextureMapProps } from "@itwin/core-common";
-import { DefinitionElement } from "./Element";
-import { IModelDb } from "./IModelDb";
-/** A PhysicalMaterial defines the matter that makes up physical elements.
- * @note See [[RenderMaterialElement]] for the DefinitionElement used to define rendering characteristics.
- * @public
- */
-export declare abstract class PhysicalMaterial extends DefinitionElement {
-    /** @internal */
-    static get className(): string;
-    /** Create a Code for a PhysicalMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
-     * @param iModel  The IModelDb
-     * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
-     * @param name The name (codeValue) of the PhysicalMaterial
-     */
-    static createCode(iModel: IModelDb, definitionModelId: CodeScopeProps, name: string): Code;
-    /** Create a PhysicalMaterial
-     * @param iModelDb The IModelDb
-     * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
-     * @param name The name (codeValue) of the PhysicalMaterial
-     * @returns The newly constructed PhysicalMaterial
-     * @throws [[IModelError]] if there is a problem creating the PhysicalMaterial
-     */
-    static create<T extends PhysicalMaterial>(iModelDb: IModelDb, definitionModelId: CodeScopeProps, name: string): T;
-}
-/** Defines a rendering material.
- * @note See [[PhysicalMaterial]] for the DefinitionElement used to define the matter that makes up physical elements.
- * @public
- */
-export declare class RenderMaterialElement extends DefinitionElement {
-    /** @internal */
-    static get className(): string;
-    /** The name of a palette that can be used to categorize multiple materials. */
-    paletteName: string;
-    /** An optional description of the material. */
-    description?: string;
-    /** @internal */
-    constructor(props: RenderMaterialProps, iModel: IModelDb);
-    /** @internal */
-    toJSON(): RenderMaterialProps;
-    /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
-     * @param iModel  The IModelDb
-     * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.
-     * @param name The RenderMaterial name
-     */
-    static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, name: string): Code;
-    /**
-     * Create a RenderMaterial with given parameters.
-     * @param iModelDb The iModel
-     * @param definitionModelId The [[DefinitionModel]]
-     * @param materialName The name/CodeValue of the RenderMaterial
-     * @param params Parameters object which describes how to construct the RenderMaterial
-     * @returns The newly constructed RenderMaterial element.
-     * @throws [[IModelError]] if unable to create the element.
-     */
-    static create(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElement.Params): RenderMaterialElement;
-    /**
-     * Insert a new RenderMaterial into a model.
-     * @param iModelDb Insert into this iModel
-     * @param definitionModelId Insert the new Texture into this DefinitionModel
-     * @param materialName The name/CodeValue of the RenderMaterial
-     * @param params Parameters object which describes how to construct the RenderMaterial
-     * @returns The Id of the newly inserted RenderMaterial element.
-     * @throws [[IModelError]] if unable to insert the element.
-     */
-    static insert(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElement.Params): Id64String;
-}
-/** @public */
-export declare namespace RenderMaterialElement {
-    /** Parameters used to construct a [[RenderMaterial]]. */
-    class Params {
-        /** The palette name which categorizes this RenderMaterial */
-        paletteName: string;
-        /** The optional description for this RenderMaterial */
-        description?: string;
-        /** If defined, use this color for surface fill or diffuse illumination; if undefined, defaults to black */
-        color?: number[];
-        /** If defined, use this color for surface specular illumination; if undefined, defaults to black */
-        specularColor?: number[];
-        /** If defined, apply this specular exponent(surface shininess); range is 0 to 128; if undefined, defaults to 15.0 * 0.9  */
-        finish?: number;
-        /** If defined, apply this surface transparency; if undefined, defaults to 0.0 */
-        transmit?: number;
-        /** If defined, apply this surface diffuse reflectivity; if undefined, defaults to 0.6 */
-        diffuse?: number;
-        /** If defined, apply this surface specular reflectivity; if undefined, defaults to 0.0.  NOTE: The actual JSON allows a HasSpecular property to be true and the specular value itself undefined, in which case the value 0.4 would be used.  This API does not allow this case. */
-        specular?: number;
-        /** If defined, apply this surface environmental reflectivity; stored as fraction of specular in V8 material settings; if undefined, defaults to 0.0 */
-        reflect?: number;
-        /** If defined, apply this surface reflectance color; if undefined, defaults to whatever the specularColor is */
-        reflectColor?: number[];
-        /** If defined, specifies the pattern mapping. */
-        patternMap?: TextureMapProps;
-        /** Construct a new RenderMaterial.Params object with the specified paletteName.  Alter the public members on that object to specify settings. */
-        constructor(paletteName: string);
-    }
-}
+/** @packageDocumentation
+ * @module Elements
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { Code, CodeScopeProps, RenderMaterialProps, TextureMapProps } from "@itwin/core-common";
+import { DefinitionElement } from "./Element";
+import { IModelDb } from "./IModelDb";
+/** A PhysicalMaterial defines the matter that makes up physical elements.
+ * @note See [[RenderMaterialElement]] for the DefinitionElement used to define rendering characteristics.
+ * @public
+ */
+export declare abstract class PhysicalMaterial extends DefinitionElement {
+    /** @internal */
+    static get className(): string;
+    /** Create a Code for a PhysicalMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModelDb
+     * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
+     * @param name The name (codeValue) of the PhysicalMaterial
+     */
+    static createCode(iModel: IModelDb, definitionModelId: CodeScopeProps, name: string): Code;
+    /** Create a PhysicalMaterial
+     * @param iModelDb The IModelDb
+     * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
+     * @param name The name (codeValue) of the PhysicalMaterial
+     * @returns The newly constructed PhysicalMaterial
+     * @throws [[IModelError]] if there is a problem creating the PhysicalMaterial
+     */
+    static create<T extends PhysicalMaterial>(iModelDb: IModelDb, definitionModelId: CodeScopeProps, name: string): T;
+}
+/** Defines a rendering material.
+ * @note See [[PhysicalMaterial]] for the DefinitionElement used to define the matter that makes up physical elements.
+ * @public
+ */
+export declare class RenderMaterialElement extends DefinitionElement {
+    /** @internal */
+    static get className(): string;
+    /** The name of a palette that can be used to categorize multiple materials. */
+    paletteName: string;
+    /** An optional description of the material. */
+    description?: string;
+    /** @internal */
+    constructor(props: RenderMaterialProps, iModel: IModelDb);
+    /** @internal */
+    toJSON(): RenderMaterialProps;
+    /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModelDb
+     * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.
+     * @param name The RenderMaterial name
+     */
+    static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, name: string): Code;
+    /**
+     * Create a RenderMaterial with given parameters.
+     * @param iModelDb The iModel
+     * @param definitionModelId The [[DefinitionModel]]
+     * @param materialName The name/CodeValue of the RenderMaterial
+     * @param params Parameters object which describes how to construct the RenderMaterial
+     * @returns The newly constructed RenderMaterial element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElement.Params): RenderMaterialElement;
+    /**
+     * Insert a new RenderMaterial into a model.
+     * @param iModelDb Insert into this iModel
+     * @param definitionModelId Insert the new Texture into this DefinitionModel
+     * @param materialName The name/CodeValue of the RenderMaterial
+     * @param params Parameters object which describes how to construct the RenderMaterial
+     * @returns The Id of the newly inserted RenderMaterial element.
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    static insert(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElement.Params): Id64String;
+}
+/** @public
+ * @note color, specularColor and reflectColor are stored as [R,G,B] where each value is between 0 and 1
+*/
+export declare namespace RenderMaterialElement {
+    /** Parameters used to construct a [[RenderMaterial]]. */
+    class Params {
+        /** The palette name which categorizes this RenderMaterial */
+        paletteName: string;
+        /** The optional description for this RenderMaterial */
+        description?: string;
+        /** If defined, use this color for surface fill or diffuse illumination; if undefined, defaults to black */
+        color?: number[];
+        /** If defined, use this color for surface specular illumination; if undefined, defaults to black */
+        specularColor?: number[];
+        /** If defined, apply this specular exponent(surface shininess); range is 0 to 128; if undefined, defaults to 15.0 * 0.9  */
+        finish?: number;
+        /** If defined, apply this surface transparency; if undefined, defaults to 0.0 */
+        transmit?: number;
+        /** If defined, apply this surface diffuse reflectivity; if undefined, defaults to 0.6 */
+        diffuse?: number;
+        /** If defined, apply this surface specular reflectivity; if undefined, defaults to 0.0.  NOTE: The actual JSON allows a HasSpecular property to be true and the specular value itself undefined, in which case the value 0.4 would be used.  This API does not allow this case. */
+        specular?: number;
+        /** If defined, apply this surface environmental reflectivity; stored as fraction of specular in V8 material settings; if undefined, defaults to 0.0 */
+        reflect?: number;
+        /** If defined, apply this surface reflectance color; if undefined, defaults to whatever the specularColor is */
+        reflectColor?: number[];
+        /** If defined, specifies the pattern mapping. */
+        patternMap?: TextureMapProps;
+        /** Construct a new RenderMaterial.Params object with the specified paletteName.  Alter the public members on that object to specify settings. */
+        constructor(paletteName: string);
+    }
+}
 //# sourceMappingURL=Material.d.ts.map

package/lib/cjs/Material.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Material.d.ts","sourceRoot":"","sources":["../../src/Material.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAe,IAAI,EAAE,cAAc,EAAoC,mBAAmB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC/I,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;;GAGG;AACH,8BAAsB,gBAAiB,SAAQ,iBAAiB;IAC9D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAIjG;;;;;;OAMG;WACW,MAAM,CAAC,CAAC,SAAS,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;CAQzH;AAED;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,iBAAiB;IAC1D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAE3E,+EAA+E;IACxE,WAAW,EAAE,MAAM,CAAC;IAC3B,+CAA+C;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB;gBACJ,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAKxD,gBAAgB;IACA,MAAM,IAAI,mBAAmB;IAM7C;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAI5F;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,CAAC,MAAM,GAAG,qBAAqB;IAmC1J;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,CAAC,MAAM,GAAG,UAAU;CAIhJ;AAED,cAAc;AACd,yBAAiB,qBAAqB,CAAC;IACrC,yDAAyD;IACzD,MAAa,MAAM;QACjB,6DAA6D;QACtD,WAAW,EAAE,MAAM,CAAC;QAC3B,uDAAuD;QAChD,WAAW,CAAC,EAAE,MAAM,CAAC;QAC5B,2GAA2G;QACpG,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACxB,oGAAoG;QAC7F,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;QAChC,4HAA4H;QACrH,MAAM,CAAC,EAAE,MAAM,CAAC;QACvB,iFAAiF;QAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;QACzB,yFAAyF;QAClF,OAAO,CAAC,EAAE,MAAM,CAAC;QACxB,mRAAmR;QAC5Q,QAAQ,CAAC,EAAE,MAAM,CAAC;QACzB,uJAAuJ;QAChJ,OAAO,CAAC,EAAE,MAAM,CAAC;QACxB,gHAAgH;QACzG,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;QAC/B,iDAAiD;QAC1C,UAAU,CAAC,EAAE,eAAe,CAAC;QAEpC,iJAAiJ;oBAC9H,WAAW,EAAE,MAAM;KAGvC;CACF"}
+{"version":3,"file":"Material.d.ts","sourceRoot":"","sources":["../../src/Material.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAe,IAAI,EAAE,cAAc,EAAoC,mBAAmB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC/I,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;;GAGG;AACH,8BAAsB,gBAAiB,SAAQ,iBAAiB;IAC9D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAIjG;;;;;;OAMG;WACW,MAAM,CAAC,CAAC,SAAS,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;CAQzH;AAED;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,iBAAiB;IAC1D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAE3E,+EAA+E;IACxE,WAAW,EAAE,MAAM,CAAC;IAC3B,+CAA+C;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB;gBACJ,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAKxD,gBAAgB;IACA,MAAM,IAAI,mBAAmB;IAM7C;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAI5F;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,CAAC,MAAM,GAAG,qBAAqB;IAmC1J;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,CAAC,MAAM,GAAG,UAAU;CAIhJ;AAED;;EAEE;AACF,yBAAiB,qBAAqB,CAAC;IACrC,yDAAyD;IACzD,MAAa,MAAM;QACjB,6DAA6D;QACtD,WAAW,EAAE,MAAM,CAAC;QAC3B,uDAAuD;QAChD,WAAW,CAAC,EAAE,MAAM,CAAC;QAC5B,2GAA2G;QACpG,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACxB,oGAAoG;QAC7F,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;QAChC,4HAA4H;QACrH,MAAM,CAAC,EAAE,MAAM,CAAC;QACvB,iFAAiF;QAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;QACzB,yFAAyF;QAClF,OAAO,CAAC,EAAE,MAAM,CAAC;QACxB,mRAAmR;QAC5Q,QAAQ,CAAC,EAAE,MAAM,CAAC;QACzB,uJAAuJ;QAChJ,OAAO,CAAC,EAAE,MAAM,CAAC;QACxB,gHAAgH;QACzG,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;QAC/B,iDAAiD;QAC1C,UAAU,CAAC,EAAE,eAAe,CAAC;QAEpC,iJAAiJ;oBAC9H,WAAW,EAAE,MAAM;KAGvC;CACF"}

package/lib/cjs/Material.js

@@ -1,146 +1,148 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Elements
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RenderMaterialElement = exports.PhysicalMaterial = void 0;
-const core_common_1 = require("@itwin/core-common");
-const Element_1 = require("./Element");
-/* eslint-disable @typescript-eslint/naming-convention */
-/** A PhysicalMaterial defines the matter that makes up physical elements.
- * @note See [[RenderMaterialElement]] for the DefinitionElement used to define rendering characteristics.
- * @public
- */
-class PhysicalMaterial extends Element_1.DefinitionElement {
-    /** @internal */
-    static get className() { return "PhysicalMaterial"; }
-    /** Create a Code for a PhysicalMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
-     * @param iModel  The IModelDb
-     * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
-     * @param name The name (codeValue) of the PhysicalMaterial
-     */
-    static createCode(iModel, definitionModelId, name) {
-        const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.physicalMaterial);
-        return new core_common_1.Code({ spec: codeSpec.id, scope: definitionModelId, value: name });
-    }
-    /** Create a PhysicalMaterial
-     * @param iModelDb The IModelDb
-     * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
-     * @param name The name (codeValue) of the PhysicalMaterial
-     * @returns The newly constructed PhysicalMaterial
-     * @throws [[IModelError]] if there is a problem creating the PhysicalMaterial
-     */
-    static create(iModelDb, definitionModelId, name) {
-        const elementProps = {
-            classFullName: this.classFullName,
-            model: definitionModelId,
-            code: this.createCode(iModelDb, definitionModelId, name),
-        };
-        return iModelDb.elements.createElement(elementProps);
-    }
-}
-exports.PhysicalMaterial = PhysicalMaterial;
-/** Defines a rendering material.
- * @note See [[PhysicalMaterial]] for the DefinitionElement used to define the matter that makes up physical elements.
- * @public
- */
-class RenderMaterialElement extends Element_1.DefinitionElement {
-    /** @internal */
-    constructor(props, iModel) {
-        super(props, iModel);
-        this.paletteName = props.paletteName;
-        this.description = props.description;
-    }
-    /** @internal */
-    static get className() { return "RenderMaterial"; }
-    /** @internal */
-    toJSON() {
-        const val = super.toJSON();
-        val.paletteName = this.paletteName;
-        val.description = this.description;
-        return val;
-    }
-    /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
-     * @param iModel  The IModelDb
-     * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.
-     * @param name The RenderMaterial name
-     */
-    static createCode(iModel, scopeModelId, name) {
-        const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.texture);
-        return 0 === name.length ? core_common_1.Code.createEmpty() : new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: name });
-    }
-    /**
-     * Create a RenderMaterial with given parameters.
-     * @param iModelDb The iModel
-     * @param definitionModelId The [[DefinitionModel]]
-     * @param materialName The name/CodeValue of the RenderMaterial
-     * @param params Parameters object which describes how to construct the RenderMaterial
-     * @returns The newly constructed RenderMaterial element.
-     * @throws [[IModelError]] if unable to create the element.
-     */
-    static create(iModelDb, definitionModelId, materialName, params) {
-        const map = undefined !== params.patternMap ? { Pattern: params.patternMap } : undefined;
-        const renderMaterialProps = {
-            classFullName: this.classFullName,
-            code: this.createCode(iModelDb, definitionModelId, materialName),
-            paletteName: params.paletteName,
-            description: params.description,
-            jsonProperties: {
-                materialAssets: {
-                    renderMaterial: {
-                        HasBaseColor: params.color !== undefined,
-                        color: params.color,
-                        HasSpecularColor: params.specularColor !== undefined,
-                        specular_color: params.specularColor,
-                        HasFinish: params.finish !== undefined,
-                        finish: params.finish,
-                        HasTransmit: params.transmit !== undefined,
-                        transmit: params.transmit,
-                        HasDiffuse: params.diffuse !== undefined,
-                        diffuse: params.diffuse,
-                        HasSpecular: params.specular !== undefined,
-                        specular: params.specular,
-                        HasReflect: params.reflect !== undefined,
-                        reflect: params.reflect,
-                        HasReflectColor: params.reflectColor !== undefined,
-                        reflect_color: params.reflectColor,
-                        Map: map,
-                    },
-                },
-            },
-            model: definitionModelId,
-            isPrivate: false,
-        };
-        return new RenderMaterialElement(renderMaterialProps, iModelDb);
-    }
-    /**
-     * Insert a new RenderMaterial into a model.
-     * @param iModelDb Insert into this iModel
-     * @param definitionModelId Insert the new Texture into this DefinitionModel
-     * @param materialName The name/CodeValue of the RenderMaterial
-     * @param params Parameters object which describes how to construct the RenderMaterial
-     * @returns The Id of the newly inserted RenderMaterial element.
-     * @throws [[IModelError]] if unable to insert the element.
-     */
-    static insert(iModelDb, definitionModelId, materialName, params) {
-        const renderMaterial = this.create(iModelDb, definitionModelId, materialName, params);
-        return iModelDb.elements.insertElement(renderMaterial.toJSON());
-    }
-}
-exports.RenderMaterialElement = RenderMaterialElement;
-/** @public */
-(function (RenderMaterialElement) {
-    /** Parameters used to construct a [[RenderMaterial]]. */
-    class Params {
-        /** Construct a new RenderMaterial.Params object with the specified paletteName.  Alter the public members on that object to specify settings. */
-        constructor(paletteName) {
-            this.paletteName = paletteName;
-        }
-    }
-    RenderMaterialElement.Params = Params;
-})(RenderMaterialElement = exports.RenderMaterialElement || (exports.RenderMaterialElement = {}));
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Elements
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RenderMaterialElement = exports.PhysicalMaterial = void 0;
+const core_common_1 = require("@itwin/core-common");
+const Element_1 = require("./Element");
+/* eslint-disable @typescript-eslint/naming-convention */
+/** A PhysicalMaterial defines the matter that makes up physical elements.
+ * @note See [[RenderMaterialElement]] for the DefinitionElement used to define rendering characteristics.
+ * @public
+ */
+class PhysicalMaterial extends Element_1.DefinitionElement {
+    /** @internal */
+    static get className() { return "PhysicalMaterial"; }
+    /** Create a Code for a PhysicalMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModelDb
+     * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
+     * @param name The name (codeValue) of the PhysicalMaterial
+     */
+    static createCode(iModel, definitionModelId, name) {
+        const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.physicalMaterial);
+        return new core_common_1.Code({ spec: codeSpec.id, scope: definitionModelId, value: name });
+    }
+    /** Create a PhysicalMaterial
+     * @param iModelDb The IModelDb
+     * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
+     * @param name The name (codeValue) of the PhysicalMaterial
+     * @returns The newly constructed PhysicalMaterial
+     * @throws [[IModelError]] if there is a problem creating the PhysicalMaterial
+     */
+    static create(iModelDb, definitionModelId, name) {
+        const elementProps = {
+            classFullName: this.classFullName,
+            model: definitionModelId,
+            code: this.createCode(iModelDb, definitionModelId, name),
+        };
+        return iModelDb.elements.createElement(elementProps);
+    }
+}
+exports.PhysicalMaterial = PhysicalMaterial;
+/** Defines a rendering material.
+ * @note See [[PhysicalMaterial]] for the DefinitionElement used to define the matter that makes up physical elements.
+ * @public
+ */
+class RenderMaterialElement extends Element_1.DefinitionElement {
+    /** @internal */
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.paletteName = props.paletteName;
+        this.description = props.description;
+    }
+    /** @internal */
+    static get className() { return "RenderMaterial"; }
+    /** @internal */
+    toJSON() {
+        const val = super.toJSON();
+        val.paletteName = this.paletteName;
+        val.description = this.description;
+        return val;
+    }
+    /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModelDb
+     * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.
+     * @param name The RenderMaterial name
+     */
+    static createCode(iModel, scopeModelId, name) {
+        const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.texture);
+        return 0 === name.length ? core_common_1.Code.createEmpty() : new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: name });
+    }
+    /**
+     * Create a RenderMaterial with given parameters.
+     * @param iModelDb The iModel
+     * @param definitionModelId The [[DefinitionModel]]
+     * @param materialName The name/CodeValue of the RenderMaterial
+     * @param params Parameters object which describes how to construct the RenderMaterial
+     * @returns The newly constructed RenderMaterial element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(iModelDb, definitionModelId, materialName, params) {
+        const map = undefined !== params.patternMap ? { Pattern: params.patternMap } : undefined;
+        const renderMaterialProps = {
+            classFullName: this.classFullName,
+            code: this.createCode(iModelDb, definitionModelId, materialName),
+            paletteName: params.paletteName,
+            description: params.description,
+            jsonProperties: {
+                materialAssets: {
+                    renderMaterial: {
+                        HasBaseColor: params.color !== undefined,
+                        color: params.color,
+                        HasSpecularColor: params.specularColor !== undefined,
+                        specular_color: params.specularColor,
+                        HasFinish: params.finish !== undefined,
+                        finish: params.finish,
+                        HasTransmit: params.transmit !== undefined,
+                        transmit: params.transmit,
+                        HasDiffuse: params.diffuse !== undefined,
+                        diffuse: params.diffuse,
+                        HasSpecular: params.specular !== undefined,
+                        specular: params.specular,
+                        HasReflect: params.reflect !== undefined,
+                        reflect: params.reflect,
+                        HasReflectColor: params.reflectColor !== undefined,
+                        reflect_color: params.reflectColor,
+                        Map: map,
+                    },
+                },
+            },
+            model: definitionModelId,
+            isPrivate: false,
+        };
+        return new RenderMaterialElement(renderMaterialProps, iModelDb);
+    }
+    /**
+     * Insert a new RenderMaterial into a model.
+     * @param iModelDb Insert into this iModel
+     * @param definitionModelId Insert the new Texture into this DefinitionModel
+     * @param materialName The name/CodeValue of the RenderMaterial
+     * @param params Parameters object which describes how to construct the RenderMaterial
+     * @returns The Id of the newly inserted RenderMaterial element.
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    static insert(iModelDb, definitionModelId, materialName, params) {
+        const renderMaterial = this.create(iModelDb, definitionModelId, materialName, params);
+        return iModelDb.elements.insertElement(renderMaterial.toJSON());
+    }
+}
+exports.RenderMaterialElement = RenderMaterialElement;
+/** @public
+ * @note color, specularColor and reflectColor are stored as [R,G,B] where each value is between 0 and 1
+*/
+(function (RenderMaterialElement) {
+    /** Parameters used to construct a [[RenderMaterial]]. */
+    class Params {
+        /** Construct a new RenderMaterial.Params object with the specified paletteName.  Alter the public members on that object to specify settings. */
+        constructor(paletteName) {
+            this.paletteName = paletteName;
+        }
+    }
+    RenderMaterialElement.Params = Params;
+})(RenderMaterialElement = exports.RenderMaterialElement || (exports.RenderMaterialElement = {}));
 //# sourceMappingURL=Material.js.map

package/lib/cjs/Material.js.map

@@ -1 +1 @@
-{"version":3,"file":"Material.js","sourceRoot":"","sources":["../../src/Material.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,oDAA+I;AAC/I,uCAA8C;AAG9C,yDAAyD;AAEzD;;;GAGG;AACH,MAAsB,gBAAiB,SAAQ,2BAAiB;IAC9D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAC7E;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,iBAAiC,EAAE,IAAY;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,gBAAgB,CAAC,CAAC;QACpF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,iBAAiB,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAChF,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAA6B,QAAkB,EAAE,iBAAiC,EAAE,IAAY;QAClH,MAAM,YAAY,GAA2B;YAC3C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;SACzD,CAAC;QACF,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IACvD,CAAC;CACF;AA3BD,4CA2BC;AAED;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,2BAAiB;IAQ1D,gBAAgB;IAChB,YAAY,KAA0B,EAAE,MAAgB;QACtD,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IACvC,CAAC;IAZD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAY3E,gBAAgB;IACA,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAyB,CAAC;QAClD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACnC,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACnC,OAAO,GAAG,CAAC;IACb,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,IAAY;QACnF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,OAAO,CAAC,CAAC;QAC3E,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,kBAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACpH,CAAC;IACD;;;;;;;;OAQG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,YAAoB,EAAE,MAAoC;QAChI,MAAM,GAAG,GAAG,SAAS,KAAK,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzF,MAAM,mBAAmB,GAAwB;YAC/C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,YAAY,CAAC;YAChE,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,cAAc,EAAE;gBACd,cAAc,EAAE;oBACd,cAAc,EAAE;wBACd,YAAY,EAAE,MAAM,CAAC,KAAK,KAAK,SAAS;wBACxC,KAAK,EAAE,MAAM,CAAC,KAAK;wBACnB,gBAAgB,EAAE,MAAM,CAAC,aAAa,KAAK,SAAS;wBACpD,cAAc,EAAE,MAAM,CAAC,aAAa;wBACpC,SAAS,EAAE,MAAM,CAAC,MAAM,KAAK,SAAS;wBACtC,MAAM,EAAE,MAAM,CAAC,MAAM;wBACrB,WAAW,EAAE,MAAM,CAAC,QAAQ,KAAK,SAAS;wBAC1C,QAAQ,EAAE,MAAM,CAAC,QAAQ;wBACzB,UAAU,EAAE,MAAM,CAAC,OAAO,KAAK,SAAS;wBACxC,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,WAAW,EAAE,MAAM,CAAC,QAAQ,KAAK,SAAS;wBAC1C,QAAQ,EAAE,MAAM,CAAC,QAAQ;wBACzB,UAAU,EAAE,MAAM,CAAC,OAAO,KAAK,SAAS;wBACxC,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,eAAe,EAAE,MAAM,CAAC,YAAY,KAAK,SAAS;wBAClD,aAAa,EAAE,MAAM,CAAC,YAAY;wBAClC,GAAG,EAAE,GAAG;qBACT;iBACF;aACF;YACD,KAAK,EAAE,iBAAiB;YACxB,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,qBAAqB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;IAClE,CAAC;IACD;;;;;;;;OAQG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,YAAoB,EAAE,MAAoC;QAChI,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;QACtF,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AAvFD,sDAuFC;AAED,cAAc;AACd,WAAiB,qBAAqB;IACpC,yDAAyD;IACzD,MAAa,MAAM;QAwBjB,iJAAiJ;QACjJ,YAAmB,WAAmB;YACpC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QACjC,CAAC;KACF;IA5BY,4BAAM,SA4BlB,CAAA;AACH,CAAC,EA/BgB,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QA+BrC","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 Elements\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { BisCodeSpec, Code, CodeScopeProps, CodeSpec, DefinitionElementProps, RenderMaterialProps, TextureMapProps } from \"@itwin/core-common\";\r\nimport { DefinitionElement } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\n\r\n/* eslint-disable @typescript-eslint/naming-convention */\r\n\r\n/** A PhysicalMaterial defines the matter that makes up physical elements.\r\n * @note See [[RenderMaterialElement]] for the DefinitionElement used to define rendering characteristics.\r\n * @public\r\n */\r\nexport abstract class PhysicalMaterial extends DefinitionElement {\r\n  /** @internal */\r\n  public static override get className(): string { return \"PhysicalMaterial\"; }\r\n  /** Create a Code for a PhysicalMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModelDb\r\n   * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.\r\n   * @param name The name (codeValue) of the PhysicalMaterial\r\n   */\r\n  public static createCode(iModel: IModelDb, definitionModelId: CodeScopeProps, name: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.physicalMaterial);\r\n    return new Code({ spec: codeSpec.id, scope: definitionModelId, value: name });\r\n  }\r\n  /** Create a PhysicalMaterial\r\n   * @param iModelDb The IModelDb\r\n   * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.\r\n   * @param name The name (codeValue) of the PhysicalMaterial\r\n   * @returns The newly constructed PhysicalMaterial\r\n   * @throws [[IModelError]] if there is a problem creating the PhysicalMaterial\r\n   */\r\n  public static create<T extends PhysicalMaterial>(iModelDb: IModelDb, definitionModelId: CodeScopeProps, name: string): T {\r\n    const elementProps: DefinitionElementProps = {\r\n      classFullName: this.classFullName,\r\n      model: definitionModelId,\r\n      code: this.createCode(iModelDb, definitionModelId, name),\r\n    };\r\n    return iModelDb.elements.createElement(elementProps);\r\n  }\r\n}\r\n\r\n/** Defines a rendering material.\r\n * @note See [[PhysicalMaterial]] for the DefinitionElement used to define the matter that makes up physical elements.\r\n * @public\r\n */\r\nexport class RenderMaterialElement extends DefinitionElement {\r\n  /** @internal */\r\n  public static override get className(): string { return \"RenderMaterial\"; }\r\n\r\n  /** The name of a palette that can be used to categorize multiple materials. */\r\n  public paletteName: string;\r\n  /** An optional description of the material. */\r\n  public description?: string;\r\n  /** @internal */\r\n  constructor(props: RenderMaterialProps, iModel: IModelDb) {\r\n    super(props, iModel);\r\n    this.paletteName = props.paletteName;\r\n    this.description = props.description;\r\n  }\r\n  /** @internal */\r\n  public override toJSON(): RenderMaterialProps {\r\n    const val = super.toJSON() as RenderMaterialProps;\r\n    val.paletteName = this.paletteName;\r\n    val.description = this.description;\r\n    return val;\r\n  }\r\n  /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.\r\n   * @param iModel  The IModelDb\r\n   * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.\r\n   * @param name The RenderMaterial name\r\n   */\r\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, name: string): Code {\r\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.texture);\r\n    return 0 === name.length ? Code.createEmpty() : new Code({ spec: codeSpec.id, scope: scopeModelId, value: name });\r\n  }\r\n  /**\r\n   * Create a RenderMaterial with given parameters.\r\n   * @param iModelDb The iModel\r\n   * @param definitionModelId The [[DefinitionModel]]\r\n   * @param materialName The name/CodeValue of the RenderMaterial\r\n   * @param params Parameters object which describes how to construct the RenderMaterial\r\n   * @returns The newly constructed RenderMaterial element.\r\n   * @throws [[IModelError]] if unable to create the element.\r\n   */\r\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElement.Params): RenderMaterialElement {\r\n    const map = undefined !== params.patternMap ? { Pattern: params.patternMap } : undefined;\r\n    const renderMaterialProps: RenderMaterialProps = {\r\n      classFullName: this.classFullName,\r\n      code: this.createCode(iModelDb, definitionModelId, materialName),\r\n      paletteName: params.paletteName,\r\n      description: params.description,\r\n      jsonProperties: {\r\n        materialAssets: {\r\n          renderMaterial: {\r\n            HasBaseColor: params.color !== undefined,\r\n            color: params.color,\r\n            HasSpecularColor: params.specularColor !== undefined,\r\n            specular_color: params.specularColor,\r\n            HasFinish: params.finish !== undefined,\r\n            finish: params.finish,\r\n            HasTransmit: params.transmit !== undefined,\r\n            transmit: params.transmit,\r\n            HasDiffuse: params.diffuse !== undefined,\r\n            diffuse: params.diffuse,\r\n            HasSpecular: params.specular !== undefined,\r\n            specular: params.specular,\r\n            HasReflect: params.reflect !== undefined,\r\n            reflect: params.reflect,\r\n            HasReflectColor: params.reflectColor !== undefined,\r\n            reflect_color: params.reflectColor,\r\n            Map: map,\r\n          },\r\n        },\r\n      },\r\n      model: definitionModelId,\r\n      isPrivate: false,\r\n    };\r\n    return new RenderMaterialElement(renderMaterialProps, iModelDb);\r\n  }\r\n  /**\r\n   * Insert a new RenderMaterial into a model.\r\n   * @param iModelDb Insert into this iModel\r\n   * @param definitionModelId Insert the new Texture into this DefinitionModel\r\n   * @param materialName The name/CodeValue of the RenderMaterial\r\n   * @param params Parameters object which describes how to construct the RenderMaterial\r\n   * @returns The Id of the newly inserted RenderMaterial element.\r\n   * @throws [[IModelError]] if unable to insert the element.\r\n   */\r\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElement.Params): Id64String {\r\n    const renderMaterial = this.create(iModelDb, definitionModelId, materialName, params);\r\n    return iModelDb.elements.insertElement(renderMaterial.toJSON());\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace RenderMaterialElement { // eslint-disable-line no-redeclare\r\n  /** Parameters used to construct a [[RenderMaterial]]. */\r\n  export class Params {\r\n    /** The palette name which categorizes this RenderMaterial */\r\n    public paletteName: string;\r\n    /** The optional description for this RenderMaterial */\r\n    public description?: string;\r\n    /** If defined, use this color for surface fill or diffuse illumination; if undefined, defaults to black */\r\n    public color?: number[];\r\n    /** If defined, use this color for surface specular illumination; if undefined, defaults to black */\r\n    public specularColor?: number[];\r\n    /** If defined, apply this specular exponent(surface shininess); range is 0 to 128; if undefined, defaults to 15.0 * 0.9  */\r\n    public finish?: number;\r\n    /** If defined, apply this surface transparency; if undefined, defaults to 0.0 */\r\n    public transmit?: number;\r\n    /** If defined, apply this surface diffuse reflectivity; if undefined, defaults to 0.6 */\r\n    public diffuse?: number;\r\n    /** If defined, apply this surface specular reflectivity; if undefined, defaults to 0.0.  NOTE: The actual JSON allows a HasSpecular property to be true and the specular value itself undefined, in which case the value 0.4 would be used.  This API does not allow this case. */\r\n    public specular?: number;\r\n    /** If defined, apply this surface environmental reflectivity; stored as fraction of specular in V8 material settings; if undefined, defaults to 0.0 */\r\n    public reflect?: number;\r\n    /** If defined, apply this surface reflectance color; if undefined, defaults to whatever the specularColor is */\r\n    public reflectColor?: number[];\r\n    /** If defined, specifies the pattern mapping. */\r\n    public patternMap?: TextureMapProps;\r\n\r\n    /** Construct a new RenderMaterial.Params object with the specified paletteName.  Alter the public members on that object to specify settings. */\r\n    public constructor(paletteName: string) {\r\n      this.paletteName = paletteName;\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Material.js","sourceRoot":"","sources":["../../src/Material.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,oDAA+I;AAC/I,uCAA8C;AAG9C,yDAAyD;AAEzD;;;GAGG;AACH,MAAsB,gBAAiB,SAAQ,2BAAiB;IAC9D,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,kBAAkB,CAAC,CAAC,CAAC;IAC7E;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,iBAAiC,EAAE,IAAY;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,gBAAgB,CAAC,CAAC;QACpF,OAAO,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,iBAAiB,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAChF,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAA6B,QAAkB,EAAE,iBAAiC,EAAE,IAAY;QAClH,MAAM,YAAY,GAA2B;YAC3C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;SACzD,CAAC;QACF,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IACvD,CAAC;CACF;AA3BD,4CA2BC;AAED;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,2BAAiB;IAQ1D,gBAAgB;IAChB,YAAY,KAA0B,EAAE,MAAgB;QACtD,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IACvC,CAAC;IAZD,gBAAgB;IACT,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAY3E,gBAAgB;IACA,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAyB,CAAC;QAClD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACnC,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACnC,OAAO,GAAG,CAAC;IACb,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,IAAY;QACnF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,yBAAW,CAAC,OAAO,CAAC,CAAC;QAC3E,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,kBAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,kBAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACpH,CAAC;IACD;;;;;;;;OAQG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,YAAoB,EAAE,MAAoC;QAChI,MAAM,GAAG,GAAG,SAAS,KAAK,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzF,MAAM,mBAAmB,GAAwB;YAC/C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,YAAY,CAAC;YAChE,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,cAAc,EAAE;gBACd,cAAc,EAAE;oBACd,cAAc,EAAE;wBACd,YAAY,EAAE,MAAM,CAAC,KAAK,KAAK,SAAS;wBACxC,KAAK,EAAE,MAAM,CAAC,KAAK;wBACnB,gBAAgB,EAAE,MAAM,CAAC,aAAa,KAAK,SAAS;wBACpD,cAAc,EAAE,MAAM,CAAC,aAAa;wBACpC,SAAS,EAAE,MAAM,CAAC,MAAM,KAAK,SAAS;wBACtC,MAAM,EAAE,MAAM,CAAC,MAAM;wBACrB,WAAW,EAAE,MAAM,CAAC,QAAQ,KAAK,SAAS;wBAC1C,QAAQ,EAAE,MAAM,CAAC,QAAQ;wBACzB,UAAU,EAAE,MAAM,CAAC,OAAO,KAAK,SAAS;wBACxC,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,WAAW,EAAE,MAAM,CAAC,QAAQ,KAAK,SAAS;wBAC1C,QAAQ,EAAE,MAAM,CAAC,QAAQ;wBACzB,UAAU,EAAE,MAAM,CAAC,OAAO,KAAK,SAAS;wBACxC,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,eAAe,EAAE,MAAM,CAAC,YAAY,KAAK,SAAS;wBAClD,aAAa,EAAE,MAAM,CAAC,YAAY;wBAClC,GAAG,EAAE,GAAG;qBACT;iBACF;aACF;YACD,KAAK,EAAE,iBAAiB;YACxB,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,qBAAqB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;IAClE,CAAC;IACD;;;;;;;;OAQG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,YAAoB,EAAE,MAAoC;QAChI,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;QACtF,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AAvFD,sDAuFC;AAED;;EAEE;AACF,WAAiB,qBAAqB;IACpC,yDAAyD;IACzD,MAAa,MAAM;QAwBjB,iJAAiJ;QACjJ,YAAmB,WAAmB;YACpC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QACjC,CAAC;KACF;IA5BY,4BAAM,SA4BlB,CAAA;AACH,CAAC,EA/BgB,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QA+BrC","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 Elements\n */\n\nimport { Id64String } from \"@itwin/core-bentley\";\nimport { BisCodeSpec, Code, CodeScopeProps, CodeSpec, DefinitionElementProps, RenderMaterialProps, TextureMapProps } from \"@itwin/core-common\";\nimport { DefinitionElement } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\n\n/* eslint-disable @typescript-eslint/naming-convention */\n\n/** A PhysicalMaterial defines the matter that makes up physical elements.\n * @note See [[RenderMaterialElement]] for the DefinitionElement used to define rendering characteristics.\n * @public\n */\nexport abstract class PhysicalMaterial extends DefinitionElement {\n  /** @internal */\n  public static override get className(): string { return \"PhysicalMaterial\"; }\n  /** Create a Code for a PhysicalMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModelDb\n   * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.\n   * @param name The name (codeValue) of the PhysicalMaterial\n   */\n  public static createCode(iModel: IModelDb, definitionModelId: CodeScopeProps, name: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.physicalMaterial);\n    return new Code({ spec: codeSpec.id, scope: definitionModelId, value: name });\n  }\n  /** Create a PhysicalMaterial\n   * @param iModelDb The IModelDb\n   * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.\n   * @param name The name (codeValue) of the PhysicalMaterial\n   * @returns The newly constructed PhysicalMaterial\n   * @throws [[IModelError]] if there is a problem creating the PhysicalMaterial\n   */\n  public static create<T extends PhysicalMaterial>(iModelDb: IModelDb, definitionModelId: CodeScopeProps, name: string): T {\n    const elementProps: DefinitionElementProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n    };\n    return iModelDb.elements.createElement(elementProps);\n  }\n}\n\n/** Defines a rendering material.\n * @note See [[PhysicalMaterial]] for the DefinitionElement used to define the matter that makes up physical elements.\n * @public\n */\nexport class RenderMaterialElement extends DefinitionElement {\n  /** @internal */\n  public static override get className(): string { return \"RenderMaterial\"; }\n\n  /** The name of a palette that can be used to categorize multiple materials. */\n  public paletteName: string;\n  /** An optional description of the material. */\n  public description?: string;\n  /** @internal */\n  constructor(props: RenderMaterialProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.paletteName = props.paletteName;\n    this.description = props.description;\n  }\n  /** @internal */\n  public override toJSON(): RenderMaterialProps {\n    const val = super.toJSON() as RenderMaterialProps;\n    val.paletteName = this.paletteName;\n    val.description = this.description;\n    return val;\n  }\n  /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModelDb\n   * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.\n   * @param name The RenderMaterial name\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, name: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.texture);\n    return 0 === name.length ? Code.createEmpty() : new Code({ spec: codeSpec.id, scope: scopeModelId, value: name });\n  }\n  /**\n   * Create a RenderMaterial with given parameters.\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param materialName The name/CodeValue of the RenderMaterial\n   * @param params Parameters object which describes how to construct the RenderMaterial\n   * @returns The newly constructed RenderMaterial element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElement.Params): RenderMaterialElement {\n    const map = undefined !== params.patternMap ? { Pattern: params.patternMap } : undefined;\n    const renderMaterialProps: RenderMaterialProps = {\n      classFullName: this.classFullName,\n      code: this.createCode(iModelDb, definitionModelId, materialName),\n      paletteName: params.paletteName,\n      description: params.description,\n      jsonProperties: {\n        materialAssets: {\n          renderMaterial: {\n            HasBaseColor: params.color !== undefined,\n            color: params.color,\n            HasSpecularColor: params.specularColor !== undefined,\n            specular_color: params.specularColor,\n            HasFinish: params.finish !== undefined,\n            finish: params.finish,\n            HasTransmit: params.transmit !== undefined,\n            transmit: params.transmit,\n            HasDiffuse: params.diffuse !== undefined,\n            diffuse: params.diffuse,\n            HasSpecular: params.specular !== undefined,\n            specular: params.specular,\n            HasReflect: params.reflect !== undefined,\n            reflect: params.reflect,\n            HasReflectColor: params.reflectColor !== undefined,\n            reflect_color: params.reflectColor,\n            Map: map,\n          },\n        },\n      },\n      model: definitionModelId,\n      isPrivate: false,\n    };\n    return new RenderMaterialElement(renderMaterialProps, iModelDb);\n  }\n  /**\n   * Insert a new RenderMaterial into a model.\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new Texture into this DefinitionModel\n   * @param materialName The name/CodeValue of the RenderMaterial\n   * @param params Parameters object which describes how to construct the RenderMaterial\n   * @returns The Id of the newly inserted RenderMaterial element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElement.Params): Id64String {\n    const renderMaterial = this.create(iModelDb, definitionModelId, materialName, params);\n    return iModelDb.elements.insertElement(renderMaterial.toJSON());\n  }\n}\n\n/** @public\n * @note color, specularColor and reflectColor are stored as [R,G,B] where each value is between 0 and 1\n*/\nexport namespace RenderMaterialElement { // eslint-disable-line no-redeclare\n  /** Parameters used to construct a [[RenderMaterial]]. */\n  export class Params {\n    /** The palette name which categorizes this RenderMaterial */\n    public paletteName: string;\n    /** The optional description for this RenderMaterial */\n    public description?: string;\n    /** If defined, use this color for surface fill or diffuse illumination; if undefined, defaults to black */\n    public color?: number[];\n    /** If defined, use this color for surface specular illumination; if undefined, defaults to black */\n    public specularColor?: number[];\n    /** If defined, apply this specular exponent(surface shininess); range is 0 to 128; if undefined, defaults to 15.0 * 0.9  */\n    public finish?: number;\n    /** If defined, apply this surface transparency; if undefined, defaults to 0.0 */\n    public transmit?: number;\n    /** If defined, apply this surface diffuse reflectivity; if undefined, defaults to 0.6 */\n    public diffuse?: number;\n    /** If defined, apply this surface specular reflectivity; if undefined, defaults to 0.0.  NOTE: The actual JSON allows a HasSpecular property to be true and the specular value itself undefined, in which case the value 0.4 would be used.  This API does not allow this case. */\n    public specular?: number;\n    /** If defined, apply this surface environmental reflectivity; stored as fraction of specular in V8 material settings; if undefined, defaults to 0.0 */\n    public reflect?: number;\n    /** If defined, apply this surface reflectance color; if undefined, defaults to whatever the specularColor is */\n    public reflectColor?: number[];\n    /** If defined, specifies the pattern mapping. */\n    public patternMap?: TextureMapProps;\n\n    /** Construct a new RenderMaterial.Params object with the specified paletteName.  Alter the public members on that object to specify settings. */\n    public constructor(paletteName: string) {\n      this.paletteName = paletteName;\n    }\n  }\n}\n"]}