@itwin/core-backend 5.0.0-dev.9 → 5.0.0-dev.92

package/lib/esm/Material.js

@@ -0,0 +1,235 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { Id64 } from "@itwin/core-bentley";
+import { BisCodeSpec, Code, } from "@itwin/core-common";
+import { DefinitionElement } from "./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
+ */
+export class PhysicalMaterial extends DefinitionElement {
+    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(BisCodeSpec.physicalMaterial);
+        return new 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);
+    }
+}
+/** Defines a rendering material.
+ * @note See [[PhysicalMaterial]] for the DefinitionElement used to define the matter that makes up physical elements.
+ * @public
+ */
+export class RenderMaterialElement extends DefinitionElement {
+    static get className() { return "RenderMaterial"; }
+    /** The name of a palette that can be used to categorize multiple materials. */
+    paletteName;
+    /** An optional description of the material. */
+    description;
+    constructor(props, iModel) {
+        super(props, iModel);
+        this.paletteName = props.paletteName;
+        this.description = props.description;
+    }
+    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(BisCodeSpec.renderMaterial);
+        return 0 === name.length ? Code.createEmpty() : new 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) {
+        let maps;
+        const pbr_normal = params.normalMap?.scale;
+        if (params.patternMap || params.normalMap) {
+            function choose(obj, key) {
+                const pat = params.patternMap;
+                if (pat && undefined !== pat[key])
+                    obj[key] = pat[key];
+                else if (params.normalMap && undefined !== params.normalMap[key])
+                    obj[key] = params.normalMap[key];
+            }
+            const baseProps = {};
+            choose(baseProps, "pattern_angle");
+            choose(baseProps, "pattern_u_flip");
+            choose(baseProps, "pattern_flip");
+            choose(baseProps, "pattern_scale");
+            choose(baseProps, "pattern_offset");
+            choose(baseProps, "pattern_scalemode");
+            choose(baseProps, "pattern_mapping");
+            choose(baseProps, "pattern_weight");
+            choose(baseProps, "pattern_useconstantlod");
+            choose(baseProps, "pattern_constantlod_repetitions");
+            choose(baseProps, "pattern_constantlod_offset");
+            choose(baseProps, "pattern_constantlod_mindistanceclamp");
+            choose(baseProps, "pattern_constantlod_maxdistanceclamp");
+            maps = {};
+            if (params.patternMap)
+                maps.Pattern = { ...params.patternMap, ...baseProps };
+            if (params.normalMap) {
+                maps.Normal = {
+                    ...params.normalMap,
+                    ...baseProps,
+                };
+                delete maps.Normal.scale;
+            }
+        }
+        // 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: maps,
+                        pbr_normal,
+                    },
+                },
+            },
+            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());
+    }
+    /** @beta */
+    static onCloned(context, sourceProps, targetProps) {
+        super.onCloned(context, sourceProps, targetProps);
+        for (const mapName in sourceProps.jsonProperties?.materialAssets?.renderMaterial?.Map ?? {}) {
+            if (typeof mapName !== "string")
+                continue;
+            const sourceMap = sourceProps.jsonProperties.materialAssets.renderMaterial.Map[mapName];
+            // sourceMap could be null/undefined, keep it the same in targetProps
+            if (!sourceMap) {
+                targetProps.jsonProperties.materialAssets.renderMaterial.Map[mapName] = sourceMap;
+                continue;
+            }
+            if (!Id64.isValid(sourceMap.TextureId) || sourceMap.TextureId === undefined)
+                continue;
+            targetProps.jsonProperties.materialAssets.renderMaterial.Map[mapName].TextureId = context.findTargetElementId(sourceMap.TextureId ?? Id64.invalid);
+        }
+    }
+}
+/** @public */
+(function (RenderMaterialElement) {
+    /** Parameters used to construct a [[RenderMaterial]].
+     * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.
+     * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.
+     * @deprecated in 3.6 because it is not useful to use a `class` - just use [[RenderMaterialElementParams]] directly instead.
+     */
+    class Params {
+        /** A required palette name that categorizes this RenderMaterial */
+        paletteName;
+        /** An optional description of this RenderMaterial */
+        description;
+        /** If defined, the color to use for surface fill or diffuse illumination, overriding the surface's own color. */
+        color;
+        /** The color to use for specular illumination. Default: black. */
+        specularColor;
+        /** The specular exponent describing the surface's shininess, in the range 0 through 128.
+         * Default: 0.
+         */
+        finish;
+        /** A transparency to be applied to the surface, ranging from 0 (fully opaque) to 1 (fully transparent).
+         * The surface's own transparency will be multiplied by `(1 - transmit)`. permitting the material to increase but not decrease the surface transparency.
+         * Default: 13.5.
+         */
+        transmit;
+        /** The surface's diffuse reflectivity from 0.0 to 1.0. Default: 0.6. */
+        diffuse;
+        /** The surface's specular reflectivity from 0.0 to 1.0. Default: 0.0. */
+        specular;
+        /** Currently unused. */
+        reflect;
+        /** Currently unused. */
+        reflectColor;
+        /** Specifies a texture image to map onto the surface, replacing or mixing with the surface's own color and transparency.
+         * @note With the exception of `TextureId`, the [TextureMapProps]($common) of [[patternMap]] and [[normalMap]] are expected to be identical. If a property is defined in both
+         * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.
+         */
+        patternMap;
+        /** Specifies a [normal map](https://en.wikipedia.org/wiki/Normal_mapping) to apply to the surface to simulate more surface detail than is present in the
+         * surface's geometry.
+         * @note With the exception of `TextureId`, the [TextureMapProps]($common) of [[patternMap]] and [[normalMap]] are expected to be identical. If a property is defined in both
+         * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.
+         */
+        normalMap;
+        /** 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 || (RenderMaterialElement = {}));
+//# sourceMappingURL=Material.js.map

package/lib/esm/Material.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Material.js","sourceRoot":"","sources":["../../src/Material.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,MAAM,qBAAqB,CAAC;AACvD,OAAO,EACL,WAAW,EAAE,IAAI,GAClB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAI9C,yDAAyD;AAEzD;;;GAGG;AACH,MAAM,OAAgB,gBAAiB,SAAQ,iBAAiB;IACvD,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,WAAW,CAAC,gBAAgB,CAAC,CAAC;QACpF,OAAO,IAAI,IAAI,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;AAED;;;GAGG;AACH,MAAM,OAAO,qBAAsB,SAAQ,iBAAiB;IACnD,MAAM,KAAc,SAAS,KAAa,OAAO,gBAAgB,CAAC,CAAC,CAAC;IAE3E,+EAA+E;IACxE,WAAW,CAAS;IAC3B,+CAA+C;IACxC,WAAW,CAAU;IAE5B,YAAoB,KAA0B,EAAE,MAAgB;QAC9D,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;IAEe,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,WAAW,CAAC,cAAc,CAAC,CAAC;QAClF,OAAO,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,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,MAAmC;QAC/H,IAAI,IAA8C,CAAC;QACnD,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC;QAC3C,IAAI,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YAG1C,SAAS,MAAM,CAAyB,GAAW,EAAE,GAAM;gBACzD,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC;gBAC9B,IAAI,GAAG,IAAI,SAAS,KAAK,GAAG,CAAC,GAAG,CAAC;oBAC/B,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;qBACjB,IAAI,MAAM,CAAC,SAAS,IAAI,SAAS,KAAK,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;oBAC9D,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACrC,CAAC;YAED,MAAM,SAAS,GAAW,EAAE,CAAC;YAC7B,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YACnC,MAAM,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YACpC,MAAM,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;YAClC,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YACnC,MAAM,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YACpC,MAAM,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;YACvC,MAAM,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;YACrC,MAAM,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YACpC,MAAM,CAAC,SAAS,EAAE,wBAAwB,CAAC,CAAC;YAC5C,MAAM,CAAC,SAAS,EAAE,iCAAiC,CAAC,CAAC;YACrD,MAAM,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAC;YAChD,MAAM,CAAC,SAAS,EAAE,sCAAsC,CAAC,CAAC;YAC1D,MAAM,CAAC,SAAS,EAAE,sCAAsC,CAAC,CAAC;YAE1D,IAAI,GAAG,EAAE,CAAC;YACV,IAAI,MAAM,CAAC,UAAU;gBACnB,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,MAAM,CAAC,UAAU,EAAE,GAAG,SAAS,EAAE,CAAC;YAExD,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;gBACrB,IAAI,CAAC,MAAM,GAAG;oBACZ,GAAG,MAAM,CAAC,SAAS;oBACnB,GAAG,SAAS;iBACb,CAAC;gBAEF,OAAQ,IAAI,CAAC,MAAc,CAAC,KAAK,CAAC;YACpC,CAAC;QACH,CAAC;QAED,4FAA4F;QAC5F,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,IAAI;wBACT,UAAU;qBACX;iBACF;aACF;YACD,KAAK,EAAE,iBAAiB;YACxB,SAAS,EAAE,KAAK;SACjB,CAAC;QAEF,OAAO,IAAI,qBAAqB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,YAAoB,EAAE,MAAmC;QAC/H,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;IAED,YAAY;IACF,MAAM,CAAU,QAAQ,CAAC,OAAkC,EAAE,WAAyB,EAAE,WAAyB;QACzH,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;QAClD,KAAK,MAAM,OAAO,IAAI,WAAW,CAAC,cAAc,EAAE,cAAc,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC;YAC5F,IAAI,OAAO,OAAO,KAAK,QAAQ;gBAC7B,SAAS;YACX,MAAM,SAAS,GAAG,WAAW,CAAC,cAAc,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACxF,qEAAqE;YACrE,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,WAAW,CAAC,cAAc,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;gBAClF,SAAS;YACX,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,KAAK,SAAS;gBACzE,SAAS;YACX,WAAW,CAAC,cAAc,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;QACrJ,CAAC;IACH,CAAC;CACF;AAED,cAAc;AACd,WAAiB,qBAAqB;IACpC;;;;OAIG;IACH,MAAa,MAAM;QACjB,mEAAmE;QAC5D,WAAW,CAAS;QAC3B,qDAAqD;QAC9C,WAAW,CAAU;QAC5B,iHAAiH;QAC1G,KAAK,CAAkB;QAC9B,kEAAkE;QAC3D,aAAa,CAAkB;QACtC;;WAEG;QACI,MAAM,CAAU;QACvB;;;WAGG;QACI,QAAQ,CAAU;QACzB,wEAAwE;QACjE,OAAO,CAAU;QACxB,yEAAyE;QAClE,QAAQ,CAAU;QACzB,wBAAwB;QACjB,OAAO,CAAU;QACxB,wBAAwB;QACjB,YAAY,CAAY;QAC/B;;;WAGG;QACI,UAAU,CAAmB;QACpC;;;;WAIG;QACI,SAAS,CAKd;QAEF,gJAAgJ;QAChJ,YAAmB,WAAmB;YACpC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QACjC,CAAC;KACF;IA/CY,4BAAM,SA+ClB,CAAA;AACH,CAAC,EAtDgB,qBAAqB,KAArB,qBAAqB,QAsDrC","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 { Id64, Id64String } from \"@itwin/core-bentley\";\nimport {\n  BisCodeSpec, Code, CodeScopeProps, CodeSpec, DefinitionElementProps, ElementProps, NormalMapProps, RenderMaterialAssetMapsProps, RenderMaterialProps, RgbFactorProps, TextureMapProps,\n} from \"@itwin/core-common\";\nimport { DefinitionElement } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { IModelElementCloneContext } from \"./IModelElementCloneContext\";\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  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  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\n  private constructor(props: RenderMaterialProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.paletteName = props.paletteName;\n    this.description = props.description;\n  }\n\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.renderMaterial);\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: RenderMaterialElementParams): RenderMaterialElement {\n    let maps: RenderMaterialAssetMapsProps | undefined;\n    const pbr_normal = params.normalMap?.scale;\n    if (params.patternMap || params.normalMap) {\n      // If both normal and pattern map are present, their texture mapping modes, angles, scales, etc are expected to match.\n      type TexMap = Omit<TextureMapProps, \"TextureId\">;\n      function choose<K extends keyof TexMap>(obj: TexMap, key: K): void {\n        const pat = params.patternMap;\n        if (pat && undefined !== pat[key])\n          obj[key] = pat[key];\n        else if (params.normalMap && undefined !== params.normalMap[key])\n          obj[key] = params.normalMap[key];\n      }\n\n      const baseProps: TexMap = {};\n      choose(baseProps, \"pattern_angle\");\n      choose(baseProps, \"pattern_u_flip\");\n      choose(baseProps, \"pattern_flip\");\n      choose(baseProps, \"pattern_scale\");\n      choose(baseProps, \"pattern_offset\");\n      choose(baseProps, \"pattern_scalemode\");\n      choose(baseProps, \"pattern_mapping\");\n      choose(baseProps, \"pattern_weight\");\n      choose(baseProps, \"pattern_useconstantlod\");\n      choose(baseProps, \"pattern_constantlod_repetitions\");\n      choose(baseProps, \"pattern_constantlod_offset\");\n      choose(baseProps, \"pattern_constantlod_mindistanceclamp\");\n      choose(baseProps, \"pattern_constantlod_maxdistanceclamp\");\n\n      maps = {};\n      if (params.patternMap)\n        maps.Pattern = { ...params.patternMap, ...baseProps };\n\n      if (params.normalMap) {\n        maps.Normal = {\n          ...params.normalMap,\n          ...baseProps,\n        };\n\n        delete (maps.Normal as any).scale;\n      }\n    }\n\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: maps,\n            pbr_normal,\n          },\n        },\n      },\n      model: definitionModelId,\n      isPrivate: false,\n    };\n\n    return new RenderMaterialElement(renderMaterialProps, iModelDb);\n  }\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: RenderMaterialElementParams): Id64String {\n    const renderMaterial = this.create(iModelDb, definitionModelId, materialName, params);\n    return iModelDb.elements.insertElement(renderMaterial.toJSON());\n  }\n\n  /** @beta */\n  protected static override onCloned(context: IModelElementCloneContext, sourceProps: ElementProps, targetProps: ElementProps) {\n    super.onCloned(context, sourceProps, targetProps);\n    for (const mapName in sourceProps.jsonProperties?.materialAssets?.renderMaterial?.Map ?? {}) {\n      if (typeof mapName !== \"string\")\n        continue;\n      const sourceMap = sourceProps.jsonProperties.materialAssets.renderMaterial.Map[mapName];\n      // sourceMap could be null/undefined, keep it the same in targetProps\n      if (!sourceMap) {\n        targetProps.jsonProperties.materialAssets.renderMaterial.Map[mapName] = sourceMap;\n        continue;\n      }\n      if (!Id64.isValid(sourceMap.TextureId) || sourceMap.TextureId === undefined)\n        continue;\n      targetProps.jsonProperties.materialAssets.renderMaterial.Map[mapName].TextureId = context.findTargetElementId(sourceMap.TextureId ?? Id64.invalid);\n    }\n  }\n}\n\n/** @public */\nexport namespace RenderMaterialElement {\n  /** Parameters used to construct a [[RenderMaterial]].\n   * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.\n   * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.\n   * @deprecated in 3.6 because it is not useful to use a `class` - just use [[RenderMaterialElementParams]] directly instead.\n   */\n  export class Params {\n    /** A required palette name that categorizes this RenderMaterial */\n    public paletteName: string;\n    /** An optional description of this RenderMaterial */\n    public description?: string;\n    /** If defined, the color to use for surface fill or diffuse illumination, overriding the surface's own color. */\n    public color?: RgbFactorProps;\n    /** The color to use for specular illumination. Default: black. */\n    public specularColor?: RgbFactorProps;\n    /** The specular exponent describing the surface's shininess, in the range 0 through 128.\n     * Default: 0.\n     */\n    public finish?: number;\n    /** A transparency to be applied to the surface, ranging from 0 (fully opaque) to 1 (fully transparent).\n     * The surface's own transparency will be multiplied by `(1 - transmit)`. permitting the material to increase but not decrease the surface transparency.\n     * Default: 13.5.\n     */\n    public transmit?: number;\n    /** The surface's diffuse reflectivity from 0.0 to 1.0. Default: 0.6. */\n    public diffuse?: number;\n    /** The surface's specular reflectivity from 0.0 to 1.0. Default: 0.0. */\n    public specular?: number;\n    /** Currently unused. */\n    public reflect?: number;\n    /** Currently unused. */\n    public reflectColor?: number[];\n    /** Specifies a texture image to map onto the surface, replacing or mixing with the surface's own color and transparency.\n     * @note With the exception of `TextureId`, the [TextureMapProps]($common) of [[patternMap]] and [[normalMap]] are expected to be identical. If a property is defined in both\n     * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.\n     */\n    public patternMap?: TextureMapProps;\n    /** Specifies a [normal map](https://en.wikipedia.org/wiki/Normal_mapping) to apply to the surface to simulate more surface detail than is present in the\n     * surface's geometry.\n     * @note With the exception of `TextureId`, the [TextureMapProps]($common) of [[patternMap]] and [[normalMap]] are expected to be identical. If a property is defined in both\n     * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.\n     */\n    public normalMap?: NormalMapProps & {\n      /** A factor by which to multiply the components of the normal vectors read from the texture.\n       * Default: 1.\n       */\n      scale?: number;\n    };\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\n/** Parameters used to create a [[RenderMaterial]] element.\n * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.\n * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.\n * @public\n */\nexport interface RenderMaterialElementParams extends RenderMaterialElement.Params { // eslint-disable-line @typescript-eslint/no-deprecated, @typescript-eslint/no-empty-object-type\n}\n"]}

package/lib/esm/Model.d.ts

@@ -0,0 +1,375 @@
+/** @packageDocumentation
+ * @module Models
+ */
+import { GuidString, Id64String } from "@itwin/core-bentley";
+import { Point2d } from "@itwin/core-geometry";
+import { AxisAlignedBox3d, ElementProps, EntityReferenceSet, GeometricModel2dProps, GeometricModel3dProps, GeometricModelProps, ModelProps, RelatedElement } from "@itwin/core-common";
+import { Entity } from "./Entity";
+import { IModelDb } from "./IModelDb";
+/** Argument for the `Model.onXxx` static methods
+ * @beta
+ */
+export interface OnModelArg {
+    /** The iModel for the Model affected. */
+    iModel: IModelDb;
+}
+/** Argument for the `Model.onXxx` static methods that supply the properties of a Model to be inserted or updated.
+ * @beta
+ */
+export interface OnModelPropsArg extends OnModelArg {
+    /** The new properties of the Model affected. */
+    props: Readonly<ModelProps>;
+}
+/** Argument for the `Model.onXxx` static methods that only supply the Id of the affected Model.
+ * @beta
+ */
+export interface OnModelIdArg extends OnModelArg {
+    /** The Id of the Model affected */
+    id: Id64String;
+}
+/** Argument for the `Model.onXxxElement` static methods that supply the properties of an Element for a Model.
+ * @beta
+ */
+export interface OnElementInModelPropsArg extends OnModelIdArg {
+    /** The new properties of an Element for the affected Model */
+    elementProps: Readonly<ElementProps>;
+}
+/** Argument for the `Model.onXxxElement` static methods that supply the Id of an Element for a Model.
+ * @beta
+ */
+export interface OnElementInModelIdArg extends OnModelIdArg {
+    /** The Id of the Element for the affected Model */
+    elementId: Id64String;
+}
+/** A Model is a container for persisting a collection of related elements within an iModel.
+ * See [[IModelDb.Models]] for how to query and manage the Models in an IModelDb.
+ * See [Creating models]($docs/learning/backend/CreateModels.md)
+ * @public
+ */
+export declare class Model extends Entity {
+    static get className(): string;
+    /** @internal */
+    static get protectedOperations(): string[];
+    readonly modeledElement: RelatedElement;
+    readonly name: string;
+    readonly parentModel?: Id64String;
+    readonly jsonProperties: {
+        [key: string]: any;
+    };
+    isPrivate: boolean;
+    isTemplate: boolean;
+    protected constructor(props: ModelProps, iModel: IModelDb);
+    toJSON(): ModelProps;
+    /** Called before a new Model is inserted.
+     * @note throw an exception to disallow the insert
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model to be inserted
+     * @beta
+     */
+    protected static onInsert(arg: OnModelPropsArg): void;
+    /** Called after a new Model is inserted.
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model that was inserted
+     * @beta
+     */
+    protected static onInserted(_arg: OnModelIdArg): void;
+    /** Called before a Model is updated.
+     * @note throw an exception to disallow the update
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model to be updated
+     * @beta
+     */
+    protected static onUpdate(arg: OnModelPropsArg): void;
+    /** Called after a Model is updated.
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model that was updated.
+     * @beta
+     */
+    protected static onUpdated(_arg: OnModelIdArg): void;
+    /** Called before a Model is deleted.
+     * @note throw an exception to disallow the delete
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model to be deleted
+     * @beta
+     */
+    protected static onDelete(arg: OnModelIdArg): void;
+    /** Called after a Model was deleted.
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model that was deleted
+     * @beta
+     */
+    protected static onDeleted(_arg: OnModelIdArg): void;
+    /** Called before a prospective Element is to be inserted into an instance of a Model of this class.
+     * @note throw an exception to disallow the insert
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model to hold the element
+     * @beta
+     */
+    protected static onInsertElement(_arg: OnElementInModelPropsArg): void;
+    /** Called after an Element has been inserted into an instance of a Model of this class.
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model holding the element
+     * @beta
+     */
+    protected static onInsertedElement(_arg: OnElementInModelIdArg): void;
+    /** Called when an Element in an instance of a Model of this class is about to be updated.
+     * @note throw an exception to disallow the update
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model holding the element
+     * @beta
+     */
+    protected static onUpdateElement(_arg: OnElementInModelPropsArg): void;
+    /** Called after an Element in an instance of a Model of this class has been updated.
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model holding the element
+     * @beta
+     */
+    protected static onUpdatedElement(_arg: OnElementInModelIdArg): void;
+    /** Called when an Element in an instance of a Model of this class is about to be deleted.
+     * @note throw an exception to disallow the delete
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model holding the element
+     * @beta
+     */
+    protected static onDeleteElement(_arg: OnElementInModelIdArg): void;
+    /** Called after an Element in an instance of a Model of this class has been deleted.
+     * @note If you override this method, you must call super.
+     * @note `this` is the class of the Model that held the element
+     * @beta
+     */
+    protected static onDeletedElement(_arg: OnElementInModelIdArg): void;
+    private getAllUserProperties;
+    /** Get a set of JSON user properties by namespace */
+    getUserProperties(namespace: string): any;
+    /** Change a set of user JSON properties of this Element by namespace. */
+    setUserProperties(nameSpace: string, value: any): void;
+    /** Remove a set of JSON user properties, specified by namespace, from this Element */
+    removeUserProperties(nameSpace: string): void;
+    getJsonProperty(name: string): any;
+    setJsonProperty(name: string, value: any): void;
+    /** Insert this Model in the iModel */
+    insert(): string;
+    /** Update this Model in the iModel. */
+    update(): void;
+    /** Delete this Model from the iModel. */
+    delete(): void;
+    protected collectReferenceIds(referenceIds: EntityReferenceSet): void;
+}
+/** A container for persisting geometric elements.
+ * @public
+ */
+export declare class GeometricModel extends Model {
+    geometryGuid?: GuidString;
+    static get className(): string;
+    protected constructor(props: GeometricModelProps, iModel: IModelDb);
+    /** Query for the union of the extents of the elements contained by this model.
+     * @note This function blocks the JavaScript event loop. Consider using [[queryRange]] instead.
+     */
+    queryExtents(): AxisAlignedBox3d;
+    /** Query for the union of the extents of all elements contained within this model. */
+    queryRange(): Promise<AxisAlignedBox3d>;
+}
+/** A container for persisting 3d geometric elements.
+ * @public
+ */
+export declare abstract class GeometricModel3d extends GeometricModel {
+    /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane.
+     * @note The associated ECProperty was added to the BisCore schema in version 1.0.8
+     */
+    readonly isPlanProjection: boolean;
+    /** If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index.
+     * @note The associated ECProperty was added to the BisCore schema in version 1.0.8
+     */
+    readonly isNotSpatiallyLocated: boolean;
+    /** If true, then the elements in this GeometricModel3d are in real-world coordinates and will be in the spatial index. */
+    get isSpatiallyLocated(): boolean;
+    static get className(): string;
+    protected constructor(props: GeometricModel3dProps, iModel: IModelDb);
+    toJSON(): GeometricModel3dProps;
+}
+/** A container for persisting 2d geometric elements.
+ * @public
+ */
+export declare abstract class GeometricModel2d extends GeometricModel {
+    /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */
+    globalOrigin?: Point2d;
+    static get className(): string;
+    protected constructor(props: GeometricModel2dProps, iModel: IModelDb);
+    toJSON(): GeometricModel2dProps;
+}
+/** A container for persisting 2d graphical elements.
+ * @public
+ */
+export declare abstract class GraphicalModel2d extends GeometricModel2d {
+    static get className(): string;
+}
+/** A container for persisting GraphicalElement3d instances.
+ * @note The associated ECClass was added to the BisCore schema in version 1.0.8
+ * @see [[GraphicalPartition3d]]
+ * @public
+ */
+export declare abstract class GraphicalModel3d extends GeometricModel3d {
+    static get className(): string;
+}
+/** A container for persisting 3d geometric elements that are spatially located.
+ * @public
+ */
+export declare abstract class SpatialModel extends GeometricModel3d {
+    static get className(): string;
+}
+/** A container for persisting physical elements that model physical space.
+ * @see [[PhysicalPartition]]
+ * @public
+ */
+export declare class PhysicalModel extends SpatialModel {
+    static get className(): string;
+    /** Insert a PhysicalPartition and a PhysicalModel that sub-models it.
+     * @param iModelDb Insert into this iModel
+     * @param parentSubjectId The PhysicalPartition will be inserted as a child of this Subject element.
+     * @param name The name of the PhysicalPartition that the new PhysicalModel will sub-model.
+     * @param isPlanProjection Optional value (default is false) that indicates if the contents of this model are expected to be in an XY plane.
+     * @returns The Id of the newly inserted PhysicalPartition and PhysicalModel (same value).
+     * @throws [[IModelError]] if there is an insert problem.
+     */
+    static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string, isPlanProjection?: boolean): Id64String;
+}
+/** A container for persisting spatial location elements.
+ * @see [[SpatialLocationPartition]]
+ * @public
+ */
+export declare class SpatialLocationModel extends SpatialModel {
+    static get className(): string;
+    /** Insert a SpatialLocationPartition and a SpatialLocationModel that sub-models it.
+     * @param iModelDb Insert into this iModel
+     * @param parentSubjectId The SpatialLocationPartition will be inserted as a child of this Subject element.
+     * @param name The name of the SpatialLocationPartition that the new SpatialLocationModel will sub-model.
+     * @param isPlanProjection Optional value (default is false) that indicates if the contents of this model are expected to be in an XY plane.
+     * @returns The Id of the newly inserted SpatialLocationPartition and SpatialLocationModel (same value).
+     * @throws [[IModelError]] if there is an insert problem.
+     */
+    static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string, isPlanProjection?: boolean): Id64String;
+}
+/** A 2d model that holds [[DrawingGraphic]]s. DrawingModels may be dimensional or non-dimensional.
+ * @public
+ */
+export declare class DrawingModel extends GraphicalModel2d {
+    static get className(): string;
+}
+/** A container for persisting section [[DrawingGraphic]]s.
+ * @public
+ */
+export declare class SectionDrawingModel extends DrawingModel {
+    static get className(): string;
+}
+/** A container for persisting [[ViewAttachment]]s and [[DrawingGraphic]]s.
+ * A SheetModel is a digital representation of a *sheet of paper*. SheetModels are 2d models in bounded paper coordinates.
+ * SheetModels may contain annotation Elements as well as references to 2d or 3d Views.
+ * @public
+ */
+export declare class SheetModel extends GraphicalModel2d {
+    static get className(): string;
+}
+/** A container for persisting role elements.
+ * @public
+ */
+export declare class RoleModel extends Model {
+    static get className(): string;
+}
+/** A container for persisting information elements.
+ * @public
+ */
+export declare abstract class InformationModel extends Model {
+    static get className(): string;
+}
+/** A container for persisting group information elements.
+ * @see [[GroupInformationPartition]]
+ * @public
+ */
+export declare abstract class GroupInformationModel extends InformationModel {
+    static get className(): string;
+}
+/** A sub-model of a [[SheetIndexPartition]] serving as a container for persisting [[SheetIndexEntry]] and [[SheetIndex]] elements.
+ * @beta
+ */
+export declare class SheetIndexModel extends InformationModel {
+    static get className(): string;
+    /** Insert a SheetIndex and a SheetIndexModel that sub-models it.
+   * @param iModelDb Insert into this iModel
+   * @param parentSubjectId The SheetIndex will be inserted as a child of this Subject element.
+   * @param name The name of the SheetIndex that the new SheetIndexModel will sub-model.
+   * @returns The Id of the newly inserted SheetIndexModel.
+   * @throws [[IModelError]] if there is an insert problem.
+   */
+    static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string): Id64String;
+}
+/** A container for persisting Information Record Elements
+ * @see [[InformationRecordPartition]]
+ * @public
+ */
+export declare class InformationRecordModel extends InformationModel {
+    static get className(): string;
+    /** Insert a InformationRecordPartition and a InformationRecordModel that sub-models it.
+     * @param iModelDb Insert into this iModel
+     * @param parentSubjectId The InformationRecordPartition will be inserted as a child of this Subject element.
+     * @param name The name of the InformationRecordPartition that the new InformationRecordModel will sub-model.
+     * @returns The Id of the newly inserted InformationRecordModel.
+     * @throws [[IModelError]] if there is an insert problem.
+     */
+    static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string): Id64String;
+}
+/** A container for persisting definition elements.
+ * @see [[DefinitionPartition]]
+ * @public
+ */
+export declare class DefinitionModel extends InformationModel {
+    static get className(): string;
+    /** Insert a DefinitionPartition and a DefinitionModel that sub-models it.
+     * @param iModelDb Insert into this iModel
+     * @param parentSubjectId The DefinitionPartition will be inserted as a child of this Subject element.
+     * @param name The name of the DefinitionPartition that the new DefinitionModel will sub-model.
+     * @returns The Id of the newly inserted DefinitionModel.
+     * @throws [[IModelError]] if there is an insert problem.
+     */
+    static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string): Id64String;
+}
+/** The singleton container of repository-related information elements.
+ * @public
+ */
+export declare class RepositoryModel extends DefinitionModel {
+    static get className(): string;
+}
+/** Contains a list of document elements.
+ * @see [[DocumentPartition]]
+ * @public
+ */
+export declare class DocumentListModel extends InformationModel {
+    static get className(): string;
+    /** Insert a DocumentPartition and a DocumentListModel that sub-models it.
+     * @param iModelDb Insert into this iModel
+     * @param parentSubjectId The DocumentPartition will be inserted as a child of this Subject element.
+     * @param name The name of the DocumentPartition that the new DocumentListModel will sub-model.
+     * @returns The Id of the newly inserted DocumentPartition and DocumentListModel (same value)
+     * @throws [[IModelError]] if there is an insert problem.
+     */
+    static insert(iModelDb: IModelDb, parentSubjectId: Id64String, name: string): Id64String;
+}
+/** A container for persisting link elements.
+ * @see [[LinkPartition]]
+ * @public
+ */
+export declare class LinkModel extends InformationModel {
+    static get className(): string;
+}
+/** The singleton container for repository-specific definition elements.
+ * @public
+ */
+export declare class DictionaryModel extends DefinitionModel {
+    static get className(): string;
+}
+/** Obtains and displays multi-resolution tiled raster organized according to the WebMercator tiling system.
+ * @public
+ */
+export declare class WebMercatorModel extends SpatialModel {
+    static get className(): string;
+}
+//# sourceMappingURL=Model.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Model.d.ts","sourceRoot":"","sources":["../../src/Model.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAa,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAE,OAAO,EAAW,MAAM,sBAAsB,CAAC;AACxD,OAAO,EACL,gBAAgB,EAAE,YAAY,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,mBAAmB,EACnF,UAAU,EAAE,cAAc,EAC7D,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,yCAAyC;IACzC,MAAM,EAAE,QAAQ,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,gDAAgD;IAChD,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,mCAAmC;IACnC,EAAE,EAAE,UAAU,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,YAAY;IAC5D,8DAA8D;IAC9D,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,mDAAmD;IACnD,SAAS,EAAE,UAAU,CAAC;CACvB;AAED;;;;GAIG;AACH,qBAAa,KAAM,SAAQ,MAAM;IAC/B,WAA2B,SAAS,IAAI,MAAM,CAAoB;IAClE,gBAAgB;IAChB,WAA2B,mBAAmB,aAAmD;IACjG,SAAgB,cAAc,EAAE,cAAc,CAAC;IAC/C,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,WAAW,CAAC,EAAE,UAAU,CAAC;IACzC,SAAgB,cAAc,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAChD,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IAE3B,SAAS,aAAa,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ;IAUzC,MAAM,IAAI,UAAU;IAMpC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAOrD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAIrD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,eAAe,GAAG,IAAI;IAMrD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAGpD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI;IAKlD;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI;IAEpD;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,wBAAwB,GAAG,IAAI;IAEtE;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAErE;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,wBAAwB,GAAG,IAAI;IAEtE;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAEpE;;;;;OAKG;IACH,SAAS,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAEnE;;;;OAIG;IACH,SAAS,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAEpE,OAAO,CAAC,oBAAoB;IAO5B,qDAAqD;IAC9C,iBAAiB,CAAC,SAAS,EAAE,MAAM;IAE1C,yEAAyE;IAClE,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAEtD,sFAAsF;IAC/E,oBAAoB,CAAC,SAAS,EAAE,MAAM;IAEtC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG;IAClC,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG;IAE/C,sCAAsC;IAC/B,MAAM;IACb,uCAAuC;IAChC,MAAM;IACb,yCAAyC;IAClC,MAAM;cAEM,mBAAmB,CAAC,YAAY,EAAE,kBAAkB,GAAG,IAAI;CAM/E;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,KAAK;IAChC,YAAY,CAAC,EAAE,UAAU,CAAC;IAEjC,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAE3E,SAAS,aAAa,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAKlE;;OAEG;IACI,YAAY,IAAI,gBAAgB;IAKvC,sFAAsF;IACzE,UAAU,IAAI,OAAO,CAAC,gBAAgB,CAAC;CAGrD;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,cAAc;IAC3D;;OAEG;IACH,SAAgB,gBAAgB,EAAE,OAAO,CAAC;IAC1C;;OAEG;IACH,SAAgB,qBAAqB,EAAE,OAAO,CAAC;IAC/C,0HAA0H;IAC1H,IAAW,kBAAkB,IAAI,OAAO,CAAwC;IAEhF,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAE7E,SAAS,aAAa,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAMpD,MAAM,IAAI,qBAAqB;CAUhD;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,cAAc;IAC3D,8GAA8G;IACvG,YAAY,CAAC,EAAE,OAAO,CAAC;IAC9B,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAE7E,SAAS,aAAa,KAAK,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ;IAKpD,MAAM,IAAI,qBAAqB;CAOhD;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E;AAED;;;;GAIG;AACH,8BAAsB,gBAAiB,SAAQ,gBAAgB;IAC7D,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E;AAED;;GAEG;AACH,8BAAsB,YAAa,SAAQ,gBAAgB;IACzD,WAA2B,SAAS,IAAI,MAAM,CAA2B;CAC1E;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C,WAA2B,SAAS,IAAI,MAAM,CAA4B;IAC1E;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,UAAU;CAe5H;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IACpD,WAA2B,SAAS,IAAI,MAAM,CAAmC;IACjF;;;;;;;OAOG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,UAAU;CAe5H;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAChD,WAA2B,SAAS,IAAI,MAAM,CAA2B;CAC1E;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;IACnD,WAA2B,SAAS,IAAI,MAAM,CAAkC;CACjF;AAED;;;;GAIG;AACH,qBAAa,UAAW,SAAQ,gBAAgB;IAC9C,WAA2B,SAAS,IAAI,MAAM,CAAyB;CACxE;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC,WAA2B,SAAS,IAAI,MAAM,CAAwB;CACvE;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,KAAK;IAClD,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E;AAED;;;GAGG;AACH,8BAAsB,qBAAsB,SAAQ,gBAAgB;IAClE,WAA2B,SAAS,IAAI,MAAM,CAAoC;CACnF;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB;IACnD,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAE5E;;;;;;KAMC;WACa,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,gBAAgB;IAC1D,WAA2B,SAAS,IAAI,MAAM,CAAqC;IAEnF;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB;IACnD,WAA2B,SAAS,IAAI,MAAM,CAA8B;IAE5E;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,eAAe;IAClD,WAA2B,SAAS,IAAI,MAAM,CAA8B;CAC7E;AAED;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,gBAAgB;IACrD,WAA2B,SAAS,IAAI,MAAM,CAAgC;IAC9E;;;;;;OAMG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU;CAahG;AAED;;;GAGG;AACH,qBAAa,SAAU,SAAQ,gBAAgB;IAC7C,WAA2B,SAAS,IAAI,MAAM,CAAwB;CACvE;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,eAAe;IAClD,WAA2B,SAAS,IAAI,MAAM,CAA8B;CAC7E;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAChD,WAA2B,SAAS,IAAI,MAAM,CAA+B;CAC9E"}