@itwin/core-backend 3.0.0-dev.100

package/lib/cjs/LineStyle.js

@@ -0,0 +1,296 @@
+"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 Symbology
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LineStyleDefinition = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const Element_1 = require("./Element");
+/** A line style definition is a uniquely named pattern that repeats as it is displayed along a curve path. In the absence of a line style, curve display is limited to solid lines with a width in pixels.
+ * There are three varieties of line styles:
+ * - A style described by a stroke pattern (series of dashes and gaps) that may also include symbol graphics.
+ * - A style using pre-defined pixel bit patterns [[LinePixels]] for dashed display (Code1-Code7).
+ * - A style that uses a texture.
+ *
+ * A definition is defined by one or more components. A component is saved as a "file property" and can be referenced by other components. The line style definition references a component
+ * by file property id and type and is saved as a dictionary element.
+ * @public
+ */
+var LineStyleDefinition;
+(function (LineStyleDefinition) {
+    /** Line style component type identifiers */
+    let ComponentType;
+    (function (ComponentType) {
+        /** Component type for [[LineStyleDefinition.PointSymbolProps]] */
+        ComponentType[ComponentType["PointSymbol"] = 1] = "PointSymbol";
+        /** Component type for [[LineStyleDefinition.CompoundProps]] */
+        ComponentType[ComponentType["Compound"] = 2] = "Compound";
+        /** Component type for [[LineStyleDefinition.StrokePatternProps]] */
+        ComponentType[ComponentType["StrokePattern"] = 3] = "StrokePattern";
+        /** Component type for [[LineStyleDefinition.StrokePointProps]] */
+        ComponentType[ComponentType["StrokePoint"] = 4] = "StrokePoint";
+        /** Component type for [[LinePixels]], never saved as a file property */
+        ComponentType[ComponentType["Internal"] = 6] = "Internal";
+        /** Component type for [[LineStyleDefinition.RasterImageProps]] */
+        ComponentType[ComponentType["RasterImage"] = 7] = "RasterImage";
+    })(ComponentType = LineStyleDefinition.ComponentType || (LineStyleDefinition.ComponentType = {}));
+    /** Mask of values for StrokeMode */
+    let StrokeMode;
+    (function (StrokeMode) {
+        /** Stroke represents a blank space */
+        StrokeMode[StrokeMode["Gap"] = 0] = "Gap";
+        /** Stroke represents a solid dash */
+        StrokeMode[StrokeMode["Dash"] = 1] = "Dash";
+        /** Treat stroke as rigid and continue past a corner to complete the stroke as opposed to breaking at the corner */
+        StrokeMode[StrokeMode["Ray"] = 2] = "Ray";
+        /** Stroke length can be stretched when [[LineStyleDefinition.StrokePatternOptions.Iteration]] and [[LineStyleDefinition.StrokePatternOptions.AutoPhase]] options are set, applicable to both Gap and Dash strokes */
+        StrokeMode[StrokeMode["Scale"] = 4] = "Scale";
+        /** Invert stroke in first stroke pattern */
+        StrokeMode[StrokeMode["FirstInvert"] = 8] = "FirstInvert";
+        /** Invert stroke in last stroke pattern */
+        StrokeMode[StrokeMode["LastInvert"] = 16] = "LastInvert";
+    })(StrokeMode = LineStyleDefinition.StrokeMode || (LineStyleDefinition.StrokeMode = {}));
+    /** Define constant width or tapered strokes with distance specified in meters */
+    let StrokeWidth;
+    (function (StrokeWidth) {
+        /** Stroke draws as one pixel wide line */
+        StrokeWidth[StrokeWidth["None"] = 0] = "None";
+        /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to left side of stroke */
+        StrokeWidth[StrokeWidth["Left"] = 1] = "Left";
+        /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to right side of stroke */
+        StrokeWidth[StrokeWidth["Right"] = 2] = "Right";
+        /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to both sides of stroke */
+        StrokeWidth[StrokeWidth["Full"] = 3] = "Full";
+    })(StrokeWidth = LineStyleDefinition.StrokeWidth || (LineStyleDefinition.StrokeWidth = {}));
+    /** Controls appearance of stroke end caps. If StrokeCap is >= Hexagon, the end cap is stroked as an arc and the value of
+     * StrokeCap indicates the number of vectors in the arc.
+     */
+    let StrokeCap;
+    (function (StrokeCap) {
+        /** Stroke displays as a closed polygon */
+        StrokeCap[StrokeCap["Closed"] = 0] = "Closed";
+        /** Stroke displays lines at specified width instead of a polygon */
+        StrokeCap[StrokeCap["Open"] = 1] = "Open";
+        /** Stroke length extended by half the stroke width */
+        StrokeCap[StrokeCap["Extended"] = 2] = "Extended";
+        /** Stroke end cap is a hexagon */
+        StrokeCap[StrokeCap["Hexagon"] = 3] = "Hexagon";
+        /** Stroke end cap is an octagon */
+        StrokeCap[StrokeCap["Octagon"] = 4] = "Octagon";
+        /** Stroke end cap is a decagon */
+        StrokeCap[StrokeCap["Decagon"] = 5] = "Decagon";
+        /** Stroke end cap is an arc */
+        StrokeCap[StrokeCap["Arc"] = 30] = "Arc";
+    })(StrokeCap = LineStyleDefinition.StrokeCap || (LineStyleDefinition.StrokeCap = {}));
+    /** Options to control how stroke pattern is applied to underlying curve */
+    let StrokePatternOptions;
+    (function (StrokePatternOptions) {
+        /** Use default stroke behavior */
+        StrokePatternOptions[StrokePatternOptions["None"] = 0] = "None";
+        /** [[LineStyleDefinition.StrokePatternProps.phase]] represents fractional distance into first stroke of pattern */
+        StrokePatternOptions[StrokePatternOptions["AutoPhase"] = 1] = "AutoPhase";
+        /** Use [[LineStyleDefinition.StrokePatternProps.maxIter]] to limit the number of iterations of the stroke pattern */
+        StrokePatternOptions[StrokePatternOptions["Iteration"] = 8] = "Iteration";
+        /** Single segment mode restarts the stroke pattern at corners instead of continuing around corners */
+        StrokePatternOptions[StrokePatternOptions["Segment"] = 16] = "Segment";
+        /** Center the line style and stretch the ends */
+        StrokePatternOptions[StrokePatternOptions["CenterStretch"] = 32] = "CenterStretch";
+    })(StrokePatternOptions = LineStyleDefinition.StrokePatternOptions || (LineStyleDefinition.StrokePatternOptions = {}));
+    /** Flags to identify point symbol behavior */
+    let PointSymbolFlags;
+    (function (PointSymbolFlags) {
+        /** Default symbol behavior */
+        PointSymbolFlags[PointSymbolFlags["None"] = 0] = "None";
+        /** Symbol includes 3d geometry */
+        PointSymbolFlags[PointSymbolFlags["Is3d"] = 1] = "Is3d";
+        /** Symbol does not allow scaling */
+        PointSymbolFlags[PointSymbolFlags["NoScale"] = 2] = "NoScale";
+    })(PointSymbolFlags = LineStyleDefinition.PointSymbolFlags || (LineStyleDefinition.PointSymbolFlags = {}));
+    /** Symbol options for location, orientation, and behavior */
+    let SymbolOptions;
+    (function (SymbolOptions) {
+        /** No point symbol */
+        SymbolOptions[SymbolOptions["None"] = 0] = "None";
+        /** Symbol at origin of stroke */
+        SymbolOptions[SymbolOptions["Origin"] = 1] = "Origin";
+        /** Symbol at end of stroke */
+        SymbolOptions[SymbolOptions["End"] = 2] = "End";
+        /** symbol at center of stroke */
+        SymbolOptions[SymbolOptions["Center"] = 3] = "Center";
+        /** Symbol at curve start point */
+        SymbolOptions[SymbolOptions["CurveOrigin"] = 4] = "CurveOrigin";
+        /** Symbol at curve end point */
+        SymbolOptions[SymbolOptions["CurveEnd"] = 8] = "CurveEnd";
+        /** Symbol at each vertex */
+        SymbolOptions[SymbolOptions["CurveVertex"] = 16] = "CurveVertex";
+        /** Adjust symbol rotation left->right */
+        SymbolOptions[SymbolOptions["AdjustRotation"] = 32] = "AdjustRotation";
+        /** Angle of symbol not relative to stroke direction */
+        SymbolOptions[SymbolOptions["AbsoluteRotation"] = 64] = "AbsoluteRotation";
+        /** No scale on variable strokes */
+        SymbolOptions[SymbolOptions["NoScale"] = 256] = "NoScale";
+        /** No clip on partial strokes */
+        SymbolOptions[SymbolOptions["NoClip"] = 512] = "NoClip";
+        /** No partial strokes */
+        SymbolOptions[SymbolOptions["NoPartial"] = 1024] = "NoPartial";
+        /** Project partial origin */
+        SymbolOptions[SymbolOptions["ProjectOrigin"] = 2048] = "ProjectOrigin";
+        /** Use color from symbol instead of inheriting curve color */
+        SymbolOptions[SymbolOptions["UseColor"] = 16384] = "UseColor";
+        /** Use weight from symbol instead of inheriting curve weight */
+        SymbolOptions[SymbolOptions["UseWeight"] = 32768] = "UseWeight";
+    })(SymbolOptions = LineStyleDefinition.SymbolOptions || (LineStyleDefinition.SymbolOptions = {}));
+    /** Flags to describe a style or control style behavior */
+    let StyleFlags;
+    (function (StyleFlags) {
+        /** Use defaults */
+        StyleFlags[StyleFlags["None"] = 0] = "None";
+        /** Only snap to center line and not individual strokes and symbols of line style */
+        StyleFlags[StyleFlags["NoSnap"] = 4] = "NoSnap";
+        /** Style represents a continuous line with width (determined by looking at components if not set) */
+        StyleFlags[StyleFlags["Continuous"] = 8] = "Continuous";
+        /** Style represents physical geometry and should be scaled as such */
+        StyleFlags[StyleFlags["Physical"] = 128] = "Physical";
+    })(StyleFlags = LineStyleDefinition.StyleFlags || (LineStyleDefinition.StyleFlags = {}));
+    /** Helper methods for creating and querying line styles */
+    class Utils {
+        /** Create a file property for a new stroke pattern component. */
+        static createStrokePatternComponent(iModel, props) {
+            const fileProps = { name: "LineCodeV1", namespace: "dgn_LStyle" };
+            fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);
+            iModel.saveFileProperty(fileProps, JSON.stringify(props));
+            return { compId: fileProps.id, compType: ComponentType.StrokePattern };
+        }
+        /** Create a file property for a new point symbol component.
+         * If base and size parameters are not supplied, queries GeometryPart by id to set them.
+         */
+        static createPointSymbolComponent(iModel, props) {
+            // if part extents weren't supplied, set them up now.
+            if (!props.baseX && !props.baseY && !props.baseZ && !props.sizeX && !props.sizeY && !props.sizeZ) {
+                const geomPart = iModel.elements.getElement(props.geomPartId);
+                if (!geomPart)
+                    return undefined;
+                props.baseX = geomPart.bbox.low.x;
+                props.baseY = geomPart.bbox.low.y;
+                props.baseZ = geomPart.bbox.low.z;
+                props.sizeX = geomPart.bbox.high.x;
+                props.sizeY = geomPart.bbox.high.y;
+                props.sizeZ = geomPart.bbox.high.z;
+            }
+            const fileProps = { name: "PointSymV1", namespace: "dgn_LStyle" };
+            fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);
+            iModel.saveFileProperty(fileProps, JSON.stringify(props));
+            return { compId: fileProps.id, compType: ComponentType.PointSymbol };
+        }
+        /** Create a file property for a new stroke point component. */
+        static createStrokePointComponent(iModel, props) {
+            const fileProps = { name: "LinePointV1", namespace: "dgn_LStyle" };
+            fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);
+            iModel.saveFileProperty(fileProps, JSON.stringify(props));
+            return { compId: fileProps.id, compType: ComponentType.StrokePoint };
+        }
+        /** Create a file property for a new compound component. */
+        static createCompoundComponent(iModel, props) {
+            const fileProps = { name: "CompoundV1", namespace: "dgn_LStyle" };
+            fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);
+            iModel.saveFileProperty(fileProps, JSON.stringify(props));
+            return { compId: fileProps.id, compType: ComponentType.Compound };
+        }
+        /** Create a file property for a new raster image component. */
+        static createRasterComponent(iModel, props, image) {
+            const rasterFileProps = { name: "RasterImageV1", namespace: "dgn_LStyle" };
+            rasterFileProps.id = iModel.queryNextAvailableFileProperty(rasterFileProps);
+            iModel.saveFileProperty(rasterFileProps, undefined, image);
+            props.imageId = rasterFileProps.id;
+            const fileProps = { name: "RasterComponentV1", namespace: "dgn_LStyle" };
+            fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);
+            iModel.saveFileProperty(fileProps, JSON.stringify(props));
+            return { compId: fileProps.id, compType: ComponentType.RasterImage };
+        }
+        /** Query for an existing line style with the supplied name. */
+        static queryStyle(imodel, scopeModelId, name) {
+            return imodel.elements.queryElementIdByCode(Element_1.LineStyle.createCode(imodel, scopeModelId, name));
+        }
+        /** Insert a new line style with the supplied name.
+         * @throws [[IModelError]] if unable to insert the line style definition element.
+         */
+        static createStyle(imodel, scopeModelId, name, props) {
+            if (undefined === props.flags)
+                props.flags = StyleFlags.NoSnap; // If flags weren't supplied, default to not snapping to stroke geometry.
+            const lsProps = {
+                classFullName: "BisCore:LineStyle",
+                model: scopeModelId,
+                code: Element_1.LineStyle.createCode(imodel, scopeModelId, name),
+                data: JSON.stringify(props),
+            };
+            return imodel.elements.insertElement(lsProps);
+        }
+        /** Query for a continuous line style that can be used to create curves with physical width instead of weight in pixels and create one if it does not already exist.
+         * There are 2 ways to define a continuous line style:
+         * - Width is not specified in the style itself and instead will be supplied as an override for each curve that is drawn.
+         *  - Defined using [[LineStyleDefinition.ComponentType.Internal]] with component id 0 [[LinePixels.Solid]] which has special behavior of being affected by width overrides.
+         * - Width is specified in the style.
+         *  - Defined using a single stroke component that is a long dash.
+         *
+         * @throws [[IModelError]] if unable to insert the line style definition element.
+         */
+        static getOrCreateContinuousStyle(imodel, scopeModelId, width) {
+            if (width === undefined) {
+                const name0 = "Continuous";
+                const lsId0 = this.queryStyle(imodel, scopeModelId, name0);
+                return (undefined === lsId0 ? this.createStyle(imodel, scopeModelId, name0, { compId: 0, compType: ComponentType.Internal, flags: StyleFlags.Continuous | StyleFlags.NoSnap }) : lsId0);
+            }
+            const name = `Continuous-${width}`;
+            const lsId = this.queryStyle(imodel, scopeModelId, name);
+            if (undefined !== lsId)
+                return lsId;
+            const strokePatternData = this.createStrokePatternComponent(imodel, { descr: name, strokes: [{ length: 1e37, orgWidth: width, strokeMode: StrokeMode.Dash, widthMode: StrokeWidth.Full }] });
+            if (undefined === strokePatternData)
+                throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, "Unable to insert stroke component");
+            return this.createStyle(imodel, scopeModelId, name, { compId: strokePatternData.compId, compType: strokePatternData.compType, flags: StyleFlags.Continuous | StyleFlags.NoSnap });
+        }
+        /** Query for a line style using the supplied [[LinePixels]] value (Code1-Code7) and create one if it does not already exist.
+         * Most applications should instead use [[createStrokePatternComponent]] to define a style with physical dash and gap lengths.
+         * Unlike other components, [[LineStyleDefinition.ComponentType.Internal]] uses the line code as the compId instead of a file property id.
+         * @throws [[IModelError]] if supplied an invalid [[LinePixels]] value or if unable to insert the line style definition element.
+         */
+        static getOrCreateLinePixelsStyle(imodel, scopeModelId, linePixels) {
+            let lineCode;
+            switch (linePixels) {
+                case core_common_1.LinePixels.Code1:
+                    lineCode = 1;
+                    break;
+                case core_common_1.LinePixels.Code2:
+                    lineCode = 2;
+                    break;
+                case core_common_1.LinePixels.Code3:
+                    lineCode = 3;
+                    break;
+                case core_common_1.LinePixels.Code4:
+                    lineCode = 4;
+                    break;
+                case core_common_1.LinePixels.Code5:
+                    lineCode = 5;
+                    break;
+                case core_common_1.LinePixels.Code6:
+                    lineCode = 6;
+                    break;
+                case core_common_1.LinePixels.Code7:
+                    lineCode = 7;
+                    break;
+                default:
+                    throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, "Invalid LinePixels");
+            }
+            const name = `LinePixelsCodeNumber-${lineCode}`;
+            const lsId = this.queryStyle(imodel, scopeModelId, name);
+            return (undefined === lsId ? this.createStyle(imodel, scopeModelId, name, { compId: lineCode, compType: ComponentType.Internal }) : lsId);
+        }
+    }
+    LineStyleDefinition.Utils = Utils;
+})(LineStyleDefinition = exports.LineStyleDefinition || (exports.LineStyleDefinition = {}));
+//# sourceMappingURL=LineStyle.js.map

package/lib/cjs/LineStyle.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LineStyle.js","sourceRoot":"","sources":["../../src/LineStyle.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA+D;AAC/D,oDAAgG;AAChG,uCAAoD;AAGpD;;;;;;;;;GASG;AACH,IAAiB,mBAAmB,CA6anC;AA7aD,WAAiB,mBAAmB;IAElC,4CAA4C;IAC5C,IAAY,aAaX;IAbD,WAAY,aAAa;QACvB,kEAAkE;QAClE,+DAAe,CAAA;QACf,+DAA+D;QAC/D,yDAAY,CAAA;QACZ,oEAAoE;QACpE,mEAAiB,CAAA;QACjB,kEAAkE;QAClE,+DAAe,CAAA;QACf,wEAAwE;QACxE,yDAAY,CAAA;QACZ,kEAAkE;QAClE,+DAAe,CAAA;IACjB,CAAC,EAbW,aAAa,GAAb,iCAAa,KAAb,iCAAa,QAaxB;IAED,oCAAoC;IACpC,IAAY,UAaX;IAbD,WAAY,UAAU;QACpB,sCAAsC;QACtC,yCAAU,CAAA;QACV,qCAAqC;QACrC,2CAAW,CAAA;QACX,mHAAmH;QACnH,yCAAU,CAAA;QACV,qNAAqN;QACrN,6CAAY,CAAA;QACZ,4CAA4C;QAC5C,yDAAkB,CAAA;QAClB,2CAA2C;QAC3C,wDAAiB,CAAA;IACnB,CAAC,EAbW,UAAU,GAAV,8BAAU,KAAV,8BAAU,QAarB;IAED,iFAAiF;IACjF,IAAY,WASX;IATD,WAAY,WAAW;QACrB,0CAA0C;QAC1C,6CAAQ,CAAA;QACR,wIAAwI;QACxI,6CAAQ,CAAA;QACR,yIAAyI;QACzI,+CAAS,CAAA;QACT,yIAAyI;QACzI,6CAAQ,CAAA;IACV,CAAC,EATW,WAAW,GAAX,+BAAW,KAAX,+BAAW,QAStB;IAED;;OAEG;IACH,IAAY,SAeX;IAfD,WAAY,SAAS;QACnB,0CAA0C;QAC1C,6CAAU,CAAA;QACV,oEAAoE;QACpE,yCAAQ,CAAA;QACR,sDAAsD;QACtD,iDAAY,CAAA;QACZ,kCAAkC;QAClC,+CAAW,CAAA;QACX,mCAAmC;QACnC,+CAAW,CAAA;QACX,kCAAkC;QAClC,+CAAW,CAAA;QACX,+BAA+B;QAC/B,wCAAQ,CAAA;IACV,CAAC,EAfW,SAAS,GAAT,6BAAS,KAAT,6BAAS,QAepB;IAoBD,2EAA2E;IAC3E,IAAY,oBAWX;IAXD,WAAY,oBAAoB;QAC9B,kCAAkC;QAClC,+DAAW,CAAA;QACX,mHAAmH;QACnH,yEAAgB,CAAA;QAChB,qHAAqH;QACrH,yEAAgB,CAAA;QAChB,sGAAsG;QACtG,sEAAc,CAAA;QACd,iDAAiD;QACjD,kFAAoB,CAAA;IACtB,CAAC,EAXW,oBAAoB,GAApB,wCAAoB,KAApB,wCAAoB,QAW/B;IAmBD,8CAA8C;IAC9C,IAAY,gBAOX;IAPD,WAAY,gBAAgB;QAC1B,8BAA8B;QAC9B,uDAAU,CAAA;QACV,kCAAkC;QAClC,uDAAW,CAAA;QACX,oCAAoC;QACpC,6DAAc,CAAA;IAChB,CAAC,EAPW,gBAAgB,GAAhB,oCAAgB,KAAhB,oCAAgB,QAO3B;IA0BD,6DAA6D;IAC7D,IAAY,aA+BX;IA/BD,WAAY,aAAa;QACvB,sBAAsB;QACtB,iDAAW,CAAA;QACX,iCAAiC;QACjC,qDAAa,CAAA;QACb,8BAA8B;QAC9B,+CAAU,CAAA;QACV,iCAAiC;QACjC,qDAAa,CAAA;QACb,kCAAkC;QAClC,+DAAoB,CAAA;QACpB,gCAAgC;QAChC,yDAAiB,CAAA;QACjB,4BAA4B;QAC5B,gEAAoB,CAAA;QACpB,yCAAyC;QACzC,sEAAuB,CAAA;QACvB,uDAAuD;QACvD,0EAAyB,CAAA;QACzB,mCAAmC;QACnC,yDAAgB,CAAA;QAChB,iCAAiC;QACjC,uDAAe,CAAA;QACf,yBAAyB;QACzB,8DAAkB,CAAA;QAClB,6BAA6B;QAC7B,sEAAsB,CAAA;QACtB,8DAA8D;QAC9D,6DAAiB,CAAA;QACjB,gEAAgE;QAChE,+DAAkB,CAAA;IACpB,CAAC,EA/BW,aAAa,GAAb,iCAAa,KAAb,iCAAa,QA+BxB;IAyED,0DAA0D;IAC1D,IAAY,UASX;IATD,WAAY,UAAU;QACpB,mBAAmB;QACnB,2CAAW,CAAA;QACX,oFAAoF;QACpF,+CAAa,CAAA;QACb,qGAAqG;QACrG,uDAAiB,CAAA;QACjB,sEAAsE;QACtE,qDAAe,CAAA;IACjB,CAAC,EATW,UAAU,GAAV,8BAAU,KAAV,8BAAU,QASrB;IAcD,2DAA2D;IAC3D,MAAa,KAAK;QAEhB,iEAAiE;QAC1D,MAAM,CAAC,4BAA4B,CAAC,MAAgB,EAAE,KAAyB;YACpF,MAAM,SAAS,GAAsB,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;YACrF,SAAS,CAAC,EAAE,GAAG,MAAM,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAC;YAChE,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1D,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,aAAa,CAAC,aAAa,EAAE,CAAC;QACzE,CAAC;QAED;;WAEG;QACI,MAAM,CAAC,0BAA0B,CAAC,MAAgB,EAAE,KAAuB;YAChF,qDAAqD;YACrD,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE;gBAChG,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAe,KAAK,CAAC,UAAU,CAAC,CAAC;gBAC5E,IAAI,CAAC,QAAQ;oBACX,OAAO,SAAS,CAAC;gBAEnB,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBAClC,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBAClC,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBAElC,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;gBACnC,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;gBACnC,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;aACpC;YAED,MAAM,SAAS,GAAsB,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;YACrF,SAAS,CAAC,EAAE,GAAG,MAAM,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAC;YAChE,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1D,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,aAAa,CAAC,WAAW,EAAE,CAAC;QACvE,CAAC;QAED,+DAA+D;QACxD,MAAM,CAAC,0BAA0B,CAAC,MAAgB,EAAE,KAAuB;YAChF,MAAM,SAAS,GAAsB,EAAE,IAAI,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;YACtF,SAAS,CAAC,EAAE,GAAG,MAAM,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAC;YAChE,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1D,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,aAAa,CAAC,WAAW,EAAE,CAAC;QACvE,CAAC;QAED,2DAA2D;QACpD,MAAM,CAAC,uBAAuB,CAAC,MAAgB,EAAE,KAAoB;YAC1E,MAAM,SAAS,GAAsB,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;YACrF,SAAS,CAAC,EAAE,GAAG,MAAM,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAC;YAChE,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1D,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,aAAa,CAAC,QAAQ,EAAE,CAAC;QACpE,CAAC;QAED,+DAA+D;QACxD,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,KAAuB,EAAE,KAAiB;YAC9F,MAAM,eAAe,GAAsB,EAAE,IAAI,EAAE,eAAe,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;YAC9F,eAAe,CAAC,EAAE,GAAG,MAAM,CAAC,8BAA8B,CAAC,eAAe,CAAC,CAAC;YAC5E,MAAM,CAAC,gBAAgB,CAAC,eAAe,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;YAC3D,KAAK,CAAC,OAAO,GAAG,eAAe,CAAC,EAAE,CAAC;YACnC,MAAM,SAAS,GAAsB,EAAE,IAAI,EAAE,mBAAmB,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;YAC5F,SAAS,CAAC,EAAE,GAAG,MAAM,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAC;YAChE,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1D,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,aAAa,CAAC,WAAW,EAAE,CAAC;QACvE,CAAC;QAED,+DAA+D;QACxD,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAAwB,EAAE,IAAY;YAC/E,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,mBAAS,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC;QAChG,CAAC;QAED;;WAEG;QACI,MAAM,CAAC,WAAW,CAAC,MAAgB,EAAE,YAAwB,EAAE,IAAY,EAAE,KAAiB;YACnG,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK;gBAC3B,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,yEAAyE;YAE5G,MAAM,OAAO,GAAmB;gBAC9B,aAAa,EAAE,mBAAmB;gBAClC,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,mBAAS,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC;gBACtD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;aAC5B,CAAC;YAEF,OAAO,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAChD,CAAC;QAED;;;;;;;;WAQG;QACI,MAAM,CAAC,0BAA0B,CAAC,MAAgB,EAAE,YAAwB,EAAE,KAAc;YACjG,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,MAAM,KAAK,GAAG,YAAY,CAAC;gBAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;gBAC3D,OAAO,CAAC,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,aAAa,CAAC,QAAQ,EAAE,KAAK,EAAE,UAAU,CAAC,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;aACzL;YAED,MAAM,IAAI,GAAG,cAAc,KAAK,EAAE,CAAC;YACnC,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;YACzD,IAAI,SAAS,KAAK,IAAI;gBACpB,OAAO,IAAI,CAAC;YAEd,MAAM,iBAAiB,GAAG,IAAI,CAAC,4BAA4B,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;YAC7L,IAAI,SAAS,KAAK,iBAAiB;gBACjC,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,mCAAmC,CAAC,CAAC;YAElF,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,iBAAiB,CAAC,MAAM,EAAE,QAAQ,EAAE,iBAAiB,CAAC,QAAQ,EAAE,KAAK,EAAE,UAAU,CAAC,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;QACpL,CAAC;QAED;;;;WAIG;QACI,MAAM,CAAC,0BAA0B,CAAC,MAAgB,EAAE,YAAwB,EAAE,UAAsB;YACzG,IAAI,QAAQ,CAAC;YACb,QAAQ,UAAU,EAAE;gBAClB,KAAK,wBAAU,CAAC,KAAK;oBACnB,QAAQ,GAAG,CAAC,CAAC;oBACb,MAAM;gBACR,KAAK,wBAAU,CAAC,KAAK;oBACnB,QAAQ,GAAG,CAAC,CAAC;oBACb,MAAM;gBACR,KAAK,wBAAU,CAAC,KAAK;oBACnB,QAAQ,GAAG,CAAC,CAAC;oBACb,MAAM;gBACR,KAAK,wBAAU,CAAC,KAAK;oBACnB,QAAQ,GAAG,CAAC,CAAC;oBACb,MAAM;gBACR,KAAK,wBAAU,CAAC,KAAK;oBACnB,QAAQ,GAAG,CAAC,CAAC;oBACb,MAAM;gBACR,KAAK,wBAAU,CAAC,KAAK;oBACnB,QAAQ,GAAG,CAAC,CAAC;oBACb,MAAM;gBACR,KAAK,wBAAU,CAAC,KAAK;oBACnB,QAAQ,GAAG,CAAC,CAAC;oBACb,MAAM;gBACR;oBACE,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;aACpE;YACD,MAAM,IAAI,GAAG,wBAAwB,QAAQ,EAAE,CAAC;YAChD,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;YACzD,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5I,CAAC;KACF;IArJY,yBAAK,QAqJjB,CAAA;AACH,CAAC,EA7agB,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QA6anC","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 Symbology\r\n */\r\n\r\nimport { Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport { FilePropertyProps, IModelError, LinePixels, LineStyleProps } from \"@itwin/core-common\";\r\nimport { GeometryPart, LineStyle } from \"./Element\";\r\nimport { IModelDb } from \"./IModelDb\";\r\n\r\n/** A line style definition is a uniquely named pattern that repeats as it is displayed along a curve path. In the absence of a line style, curve display is limited to solid lines with a width in pixels.\r\n * There are three varieties of line styles:\r\n * - A style described by a stroke pattern (series of dashes and gaps) that may also include symbol graphics.\r\n * - A style using pre-defined pixel bit patterns [[LinePixels]] for dashed display (Code1-Code7).\r\n * - A style that uses a texture.\r\n *\r\n * A definition is defined by one or more components. A component is saved as a \"file property\" and can be referenced by other components. The line style definition references a component\r\n * by file property id and type and is saved as a dictionary element.\r\n * @public\r\n */\r\nexport namespace LineStyleDefinition {\r\n\r\n  /** Line style component type identifiers */\r\n  export enum ComponentType {\r\n    /** Component type for [[LineStyleDefinition.PointSymbolProps]] */\r\n    PointSymbol = 1,\r\n    /** Component type for [[LineStyleDefinition.CompoundProps]] */\r\n    Compound = 2,\r\n    /** Component type for [[LineStyleDefinition.StrokePatternProps]] */\r\n    StrokePattern = 3,\r\n    /** Component type for [[LineStyleDefinition.StrokePointProps]] */\r\n    StrokePoint = 4,\r\n    /** Component type for [[LinePixels]], never saved as a file property */\r\n    Internal = 6,\r\n    /** Component type for [[LineStyleDefinition.RasterImageProps]] */\r\n    RasterImage = 7,\r\n  }\r\n\r\n  /** Mask of values for StrokeMode */\r\n  export enum StrokeMode {\r\n    /** Stroke represents a blank space */\r\n    Gap = 0x00,\r\n    /** Stroke represents a solid dash */\r\n    Dash = 0x01,\r\n    /** Treat stroke as rigid and continue past a corner to complete the stroke as opposed to breaking at the corner */\r\n    Ray = 0x02,\r\n    /** Stroke length can be stretched when [[LineStyleDefinition.StrokePatternOptions.Iteration]] and [[LineStyleDefinition.StrokePatternOptions.AutoPhase]] options are set, applicable to both Gap and Dash strokes */\r\n    Scale = 0x04,\r\n    /** Invert stroke in first stroke pattern */\r\n    FirstInvert = 0x08,\r\n    /** Invert stroke in last stroke pattern */\r\n    LastInvert = 0x10,\r\n  }\r\n\r\n  /** Define constant width or tapered strokes with distance specified in meters */\r\n  export enum StrokeWidth {\r\n    /** Stroke draws as one pixel wide line */\r\n    None = 0,\r\n    /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to left side of stroke */\r\n    Left = 1,\r\n    /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to right side of stroke */\r\n    Right = 2,\r\n    /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to both sides of stroke */\r\n    Full = 3,\r\n  }\r\n\r\n  /** Controls appearance of stroke end caps. If StrokeCap is >= Hexagon, the end cap is stroked as an arc and the value of\r\n   * StrokeCap indicates the number of vectors in the arc.\r\n   */\r\n  export enum StrokeCap {\r\n    /** Stroke displays as a closed polygon */\r\n    Closed = 0,\r\n    /** Stroke displays lines at specified width instead of a polygon */\r\n    Open = 1,\r\n    /** Stroke length extended by half the stroke width */\r\n    Extended = 2,\r\n    /** Stroke end cap is a hexagon */\r\n    Hexagon = 3,\r\n    /** Stroke end cap is an octagon */\r\n    Octagon = 4,\r\n    /** Stroke end cap is a decagon */\r\n    Decagon = 5,\r\n    /** Stroke end cap is an arc */\r\n    Arc = 30,\r\n  }\r\n\r\n  /** A stroke representing either a dash or gap in a stroke pattern */\r\n  export interface StrokeProps {\r\n    /** Length of stroke in meters */\r\n    length: number;\r\n    /** Width at start of stroke. Behavior controlled by [[LineStyleDefinition.StrokeWidth]], choose value other than [[LineStyleDefinition.StrokeWidth.None]] */\r\n    orgWidth?: number;\r\n    /** Width at end of stroke, same as start width if not present. Behavior controlled by [[LineStyleDefinition.StrokeWidth]], choose value other than [[LineStyleDefinition.StrokeWidth.None]] */\r\n    endWidth?: number;\r\n    /** Type and behavior of stroke */\r\n    strokeMode?: StrokeMode;\r\n    /** How to apply orgWidth and endWidth to stroke */\r\n    widthMode?: StrokeWidth;\r\n    /** Appearance of stroke end cap */\r\n    capMode?: StrokeCap;\r\n  }\r\n\r\n  export type Strokes = StrokeProps[];\r\n\r\n  /** Options to control how stroke pattern is applied to underlying curve */\r\n  export enum StrokePatternOptions {\r\n    /** Use default stroke behavior */\r\n    None = 0x00,\r\n    /** [[LineStyleDefinition.StrokePatternProps.phase]] represents fractional distance into first stroke of pattern */\r\n    AutoPhase = 0x01,\r\n    /** Use [[LineStyleDefinition.StrokePatternProps.maxIter]] to limit the number of iterations of the stroke pattern */\r\n    Iteration = 0x08,\r\n    /** Single segment mode restarts the stroke pattern at corners instead of continuing around corners */\r\n    Segment = 0x10,\r\n    /** Center the line style and stretch the ends */\r\n    CenterStretch = 0x20,\r\n  }\r\n\r\n  /** Stroke pattern component definition [[LineStyleDefinition.ComponentType.StrokePattern]].\r\n   * A stroke pattern component consists of a series of dashes and gaps having specified lengths and widths in meters. Simple dash-dot type line styles that do not\r\n   * include point symbols can be created by referencing a stroke pattern component by its file property id.\r\n   */\r\n  export interface StrokePatternProps {\r\n    /** Name for this stroke pattern */\r\n    descr: string;\r\n    /** Skip into the pattern before starting to draw. Value treated as fraction of the first stroke when [[LineStyleDefinition.StrokePatternOptions.AutoPhase]] set. Value used as distance when [[LineStyleDefinition.StrokePatternOptions.CenterStretch]] is not set. */\r\n    phase?: number;\r\n    /** Options mask for this stroke pattern */\r\n    options?: StrokePatternOptions;\r\n    /** The entire stroke pattern will be repeated no more than maxIter on curve or segment when [[LineStyleDefinition.StrokePatternOptions.Iteration]] is set and stroke pattern includes stretchable strokes. */\r\n    maxIter?: number;\r\n    /** Array of strokes, maximum number that will be used is 32 */\r\n    strokes: Strokes;\r\n  }\r\n\r\n  /** Flags to identify point symbol behavior */\r\n  export enum PointSymbolFlags {\r\n    /** Default symbol behavior */\r\n    None = 0x0,\r\n    /** Symbol includes 3d geometry */\r\n    Is3d = 0x01,\r\n    /** Symbol does not allow scaling */\r\n    NoScale = 0x02,\r\n  }\r\n\r\n  /** Point symbol component definition [[LineStyleDefinition.ComponentType.PointSymbol]].\r\n   * A point symbol component identifies a GeometryPart for reference by a [[LineStyleDefinition.SymbolProps]].\r\n   */\r\n  export interface PointSymbolProps {\r\n    /** GeometryPart Id to use as a pattern symbol */\r\n    geomPartId: Id64String;\r\n    /** GeometryPart.bbox.low.x */\r\n    baseX?: number;\r\n    /** GeometryPart.bbox.low.y */\r\n    baseY?: number;\r\n    /** GeometryPart.bbox.low.z */\r\n    baseZ?: number;\r\n    /** GeometryPart.bbox.high.x */\r\n    sizeX?: number;\r\n    /** GeometryPart.bbox.high.y */\r\n    sizeY?: number;\r\n    /** GeometryPart.bbox.high.z */\r\n    sizeZ?: number;\r\n    /** Symbol behavior flags */\r\n    symFlags?: PointSymbolFlags;\r\n    /** Symbol scale, defaults to 1 */\r\n    scale?: number;\r\n  }\r\n\r\n  /** Symbol options for location, orientation, and behavior */\r\n  export enum SymbolOptions {\r\n    /** No point symbol */\r\n    None = 0x00,\r\n    /** Symbol at origin of stroke */\r\n    Origin = 0x01,\r\n    /** Symbol at end of stroke */\r\n    End = 0x02,\r\n    /** symbol at center of stroke */\r\n    Center = 0x03,\r\n    /** Symbol at curve start point */\r\n    CurveOrigin = 0x0004,\r\n    /** Symbol at curve end point */\r\n    CurveEnd = 0x0008,\r\n    /** Symbol at each vertex */\r\n    CurveVertex = 0x0010,\r\n    /** Adjust symbol rotation left->right */\r\n    AdjustRotation = 0x0020,\r\n    /** Angle of symbol not relative to stroke direction */\r\n    AbsoluteRotation = 0x0040,\r\n    /** No scale on variable strokes */\r\n    NoScale = 0x0100,\r\n    /** No clip on partial strokes */\r\n    NoClip = 0x0200,\r\n    /** No partial strokes */\r\n    NoPartial = 0x0400,\r\n    /** Project partial origin */\r\n    ProjectOrigin = 0x0800,\r\n    /** Use color from symbol instead of inheriting curve color */\r\n    UseColor = 0x4000,\r\n    /** Use weight from symbol instead of inheriting curve weight */\r\n    UseWeight = 0x8000,\r\n  }\r\n\r\n  /** Identifies a symbol and its location and orientation relative to a stroke pattern */\r\n  export interface SymbolProps {\r\n    /** The file property id of the symbol component, assumed to be [[LineStyleDefinition.ComponentType.PointSymbol]] if symType is undefined. */\r\n    symId: number;\r\n    /** The component type, leave undefined if symId is a [[LineStyleDefinition.ComponentType.PointSymbol]] */\r\n    symType?: ComponentType;\r\n    /** The 0 based stroke index for base stroke pattern [[LineStyleDefinition.ComponentType.StrokePattern]] component */\r\n    strokeNum?: number;\r\n    /** Symbol x offset distance in meters */\r\n    xOffset?: number;\r\n    /** Symbol y offset distance in meters */\r\n    yOffset?: number;\r\n    /** Symbol rotation in radians */\r\n    angle?: number;\r\n    /** Must set location for symbol as default value is [[LineStyleDefinition.SymbolOptions.None]] */\r\n    mod1?: SymbolOptions;\r\n  }\r\n\r\n  export type Symbols = SymbolProps[];\r\n\r\n  /** Stroke point component definition [[LineStyleDefinition.ComponentType.StrokePoint]].\r\n   * A stroke point component identifies the locations of point symbol components relative to a base stroke pattern component.\r\n   */\r\n  export interface StrokePointProps {\r\n    /** Name for this stroke point component */\r\n    descr: string;\r\n    /** The file property id of the stroke component, assumed to be [[LineStyleDefinition.ComponentType.StrokePattern]] if lcType is undefined */\r\n    lcId: number;\r\n    /** The component type, leave undefined if lcId is a [[LineStyleDefinition.ComponentType.StrokePattern]] */\r\n    lcType?: ComponentType;\r\n    /** Array of symbols */\r\n    symbols: Symbols;\r\n  }\r\n\r\n  /** Raster component definition [[LineStyleDefinition.ComponentType.RasterImage]].\r\n   * A raster component identifies a texture for a line style.\r\n   */\r\n  export interface RasterImageProps {\r\n    /** Name for this raster image component */\r\n    descr: string;\r\n    /** Raster width */\r\n    x: number;\r\n    /** Raster height */\r\n    y: number;\r\n    /** True width flag */\r\n    trueWidth?: number;\r\n    /** Raster flags */\r\n    flags?: number;\r\n    /** The file property id of raster image */\r\n    imageId?: number;\r\n  }\r\n\r\n  /** Identifies a component by file property id and type */\r\n  export interface ComponentProps {\r\n    /** The file property id of [[LineStyleDefinition.ComponentType.StrokePattern]] or [[LineStyleDefinition.ComponentType.StrokePoint]] component */\r\n    id: number;\r\n    /** The type of component for specified file property id */\r\n    type: ComponentType;\r\n    /** Offset distance for this component, default is 0 */\r\n    offset?: number;\r\n  }\r\n\r\n  export type Components = ComponentProps[];\r\n\r\n  /** Compound component definition [[LineStyleDefinition.ComponentType.Compound]].\r\n   * A compound component is used to link stroke pattern and stroke point components to create a style that displays dashes, gaps, and symbols.\r\n   */\r\n  export interface CompoundProps {\r\n    comps: Components;\r\n  }\r\n\r\n  /** Flags to describe a style or control style behavior */\r\n  export enum StyleFlags {\r\n    /** Use defaults */\r\n    None = 0x00,\r\n    /** Only snap to center line and not individual strokes and symbols of line style */\r\n    NoSnap = 0x04,\r\n    /** Style represents a continuous line with width (determined by looking at components if not set) */\r\n    Continuous = 0x08,\r\n    /** Style represents physical geometry and should be scaled as such */\r\n    Physical = 0x80,\r\n  }\r\n\r\n  /** The line style definition element data */\r\n  export interface StyleProps {\r\n    /** The file property id for either a [[LineStyleDefinition.ComponentType.StrokePattern]] or [[LineStyleDefinition.ComponentType.Compound]] component */\r\n    compId: number;\r\n    /** The type of component for specified file property id */\r\n    compType: ComponentType;\r\n    /** Style behavior flags. Defaults to [[LineStyleDefinition.StyleFlags.NoSnap]] if left undefined */\r\n    flags?: StyleFlags;\r\n    /** Style scale, defaults to 1 */\r\n    unitDef?: number;\r\n  }\r\n\r\n  /** Helper methods for creating and querying line styles */\r\n  export class Utils {\r\n\r\n    /** Create a file property for a new stroke pattern component. */\r\n    public static createStrokePatternComponent(iModel: IModelDb, props: StrokePatternProps): StyleProps {\r\n      const fileProps: FilePropertyProps = { name: \"LineCodeV1\", namespace: \"dgn_LStyle\" };\r\n      fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);\r\n      iModel.saveFileProperty(fileProps, JSON.stringify(props));\r\n      return { compId: fileProps.id, compType: ComponentType.StrokePattern };\r\n    }\r\n\r\n    /** Create a file property for a new point symbol component.\r\n     * If base and size parameters are not supplied, queries GeometryPart by id to set them.\r\n     */\r\n    public static createPointSymbolComponent(iModel: IModelDb, props: PointSymbolProps): StyleProps | undefined {\r\n      // if part extents weren't supplied, set them up now.\r\n      if (!props.baseX && !props.baseY && !props.baseZ && !props.sizeX && !props.sizeY && !props.sizeZ) {\r\n        const geomPart = iModel.elements.getElement<GeometryPart>(props.geomPartId);\r\n        if (!geomPart)\r\n          return undefined;\r\n\r\n        props.baseX = geomPart.bbox.low.x;\r\n        props.baseY = geomPart.bbox.low.y;\r\n        props.baseZ = geomPart.bbox.low.z;\r\n\r\n        props.sizeX = geomPart.bbox.high.x;\r\n        props.sizeY = geomPart.bbox.high.y;\r\n        props.sizeZ = geomPart.bbox.high.z;\r\n      }\r\n\r\n      const fileProps: FilePropertyProps = { name: \"PointSymV1\", namespace: \"dgn_LStyle\" };\r\n      fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);\r\n      iModel.saveFileProperty(fileProps, JSON.stringify(props));\r\n      return { compId: fileProps.id, compType: ComponentType.PointSymbol };\r\n    }\r\n\r\n    /** Create a file property for a new stroke point component. */\r\n    public static createStrokePointComponent(iModel: IModelDb, props: StrokePointProps): StyleProps {\r\n      const fileProps: FilePropertyProps = { name: \"LinePointV1\", namespace: \"dgn_LStyle\" };\r\n      fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);\r\n      iModel.saveFileProperty(fileProps, JSON.stringify(props));\r\n      return { compId: fileProps.id, compType: ComponentType.StrokePoint };\r\n    }\r\n\r\n    /** Create a file property for a new compound component. */\r\n    public static createCompoundComponent(iModel: IModelDb, props: CompoundProps): StyleProps {\r\n      const fileProps: FilePropertyProps = { name: \"CompoundV1\", namespace: \"dgn_LStyle\" };\r\n      fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);\r\n      iModel.saveFileProperty(fileProps, JSON.stringify(props));\r\n      return { compId: fileProps.id, compType: ComponentType.Compound };\r\n    }\r\n\r\n    /** Create a file property for a new raster image component. */\r\n    public static createRasterComponent(iModel: IModelDb, props: RasterImageProps, image: Uint8Array): StyleProps | undefined {\r\n      const rasterFileProps: FilePropertyProps = { name: \"RasterImageV1\", namespace: \"dgn_LStyle\" };\r\n      rasterFileProps.id = iModel.queryNextAvailableFileProperty(rasterFileProps);\r\n      iModel.saveFileProperty(rasterFileProps, undefined, image);\r\n      props.imageId = rasterFileProps.id;\r\n      const fileProps: FilePropertyProps = { name: \"RasterComponentV1\", namespace: \"dgn_LStyle\" };\r\n      fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);\r\n      iModel.saveFileProperty(fileProps, JSON.stringify(props));\r\n      return { compId: fileProps.id, compType: ComponentType.RasterImage };\r\n    }\r\n\r\n    /** Query for an existing line style with the supplied name. */\r\n    public static queryStyle(imodel: IModelDb, scopeModelId: Id64String, name: string): Id64String | undefined {\r\n      return imodel.elements.queryElementIdByCode(LineStyle.createCode(imodel, scopeModelId, name));\r\n    }\r\n\r\n    /** Insert a new line style with the supplied name.\r\n     * @throws [[IModelError]] if unable to insert the line style definition element.\r\n     */\r\n    public static createStyle(imodel: IModelDb, scopeModelId: Id64String, name: string, props: StyleProps): Id64String {\r\n      if (undefined === props.flags)\r\n        props.flags = StyleFlags.NoSnap; // If flags weren't supplied, default to not snapping to stroke geometry.\r\n\r\n      const lsProps: LineStyleProps = {\r\n        classFullName: \"BisCore:LineStyle\",\r\n        model: scopeModelId,\r\n        code: LineStyle.createCode(imodel, scopeModelId, name),\r\n        data: JSON.stringify(props),\r\n      };\r\n\r\n      return imodel.elements.insertElement(lsProps);\r\n    }\r\n\r\n    /** Query for a continuous line style that can be used to create curves with physical width instead of weight in pixels and create one if it does not already exist.\r\n     * There are 2 ways to define a continuous line style:\r\n     * - Width is not specified in the style itself and instead will be supplied as an override for each curve that is drawn.\r\n     *  - Defined using [[LineStyleDefinition.ComponentType.Internal]] with component id 0 [[LinePixels.Solid]] which has special behavior of being affected by width overrides.\r\n     * - Width is specified in the style.\r\n     *  - Defined using a single stroke component that is a long dash.\r\n     *\r\n     * @throws [[IModelError]] if unable to insert the line style definition element.\r\n     */\r\n    public static getOrCreateContinuousStyle(imodel: IModelDb, scopeModelId: Id64String, width?: number): Id64String {\r\n      if (width === undefined) {\r\n        const name0 = \"Continuous\";\r\n        const lsId0 = this.queryStyle(imodel, scopeModelId, name0);\r\n        return (undefined === lsId0 ? this.createStyle(imodel, scopeModelId, name0, { compId: 0, compType: ComponentType.Internal, flags: StyleFlags.Continuous | StyleFlags.NoSnap }) : lsId0);\r\n      }\r\n\r\n      const name = `Continuous-${width}`;\r\n      const lsId = this.queryStyle(imodel, scopeModelId, name);\r\n      if (undefined !== lsId)\r\n        return lsId;\r\n\r\n      const strokePatternData = this.createStrokePatternComponent(imodel, { descr: name, strokes: [{ length: 1e37, orgWidth: width, strokeMode: StrokeMode.Dash, widthMode: StrokeWidth.Full }] });\r\n      if (undefined === strokePatternData)\r\n        throw new IModelError(IModelStatus.BadArg, \"Unable to insert stroke component\");\r\n\r\n      return this.createStyle(imodel, scopeModelId, name, { compId: strokePatternData.compId, compType: strokePatternData.compType, flags: StyleFlags.Continuous | StyleFlags.NoSnap });\r\n    }\r\n\r\n    /** Query for a line style using the supplied [[LinePixels]] value (Code1-Code7) and create one if it does not already exist.\r\n     * Most applications should instead use [[createStrokePatternComponent]] to define a style with physical dash and gap lengths.\r\n     * Unlike other components, [[LineStyleDefinition.ComponentType.Internal]] uses the line code as the compId instead of a file property id.\r\n     * @throws [[IModelError]] if supplied an invalid [[LinePixels]] value or if unable to insert the line style definition element.\r\n     */\r\n    public static getOrCreateLinePixelsStyle(imodel: IModelDb, scopeModelId: Id64String, linePixels: LinePixels): Id64String {\r\n      let lineCode;\r\n      switch (linePixels) {\r\n        case LinePixels.Code1:\r\n          lineCode = 1;\r\n          break;\r\n        case LinePixels.Code2:\r\n          lineCode = 2;\r\n          break;\r\n        case LinePixels.Code3:\r\n          lineCode = 3;\r\n          break;\r\n        case LinePixels.Code4:\r\n          lineCode = 4;\r\n          break;\r\n        case LinePixels.Code5:\r\n          lineCode = 5;\r\n          break;\r\n        case LinePixels.Code6:\r\n          lineCode = 6;\r\n          break;\r\n        case LinePixels.Code7:\r\n          lineCode = 7;\r\n          break;\r\n        default:\r\n          throw new IModelError(IModelStatus.BadArg, \"Invalid LinePixels\");\r\n      }\r\n      const name = `LinePixelsCodeNumber-${lineCode}`;\r\n      const lsId = this.queryStyle(imodel, scopeModelId, name);\r\n      return (undefined === lsId ? this.createStyle(imodel, scopeModelId, name, { compId: lineCode, compType: ComponentType.Internal }) : lsId);\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/cjs/LocalhostIpcHost.d.ts

@@ -0,0 +1,19 @@
+/** @packageDocumentation
+ * @module IModelHost
+ */
+import * as ws from "ws";
+import { IModelHostConfiguration } from "./IModelHost";
+/** @internal */
+export interface LocalhostIpcHostOpts {
+    socketPort?: number;
+    noServer?: boolean;
+}
+/** @internal */
+export declare class LocalhostIpcHost {
+    static connect(connection: ws): void;
+    static startup(opts?: {
+        localhostIpcHost?: LocalhostIpcHostOpts;
+        iModelHost?: IModelHostConfiguration;
+    }): Promise<void>;
+}
+//# sourceMappingURL=LocalhostIpcHost.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LocalhostIpcHost.d.ts","sourceRoot":"","sources":["../../src/LocalhostIpcHost.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAGzB,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAEvD,gBAAgB;AAChB,MAAM,WAAW,oBAAoB;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAkCD,gBAAgB;AAChB,qBAAa,gBAAgB;WACb,OAAO,CAAC,UAAU,EAAE,EAAE;WAIhB,OAAO,CAAC,IAAI,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,oBAAoB,CAAC;QAAC,UAAU,CAAC,EAAE,uBAAuB,CAAA;KAAE;CAKrH"}

package/lib/cjs/LocalhostIpcHost.js

@@ -0,0 +1,52 @@
+"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 IModelHost
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalhostIpcHost = void 0;
+const ws = require("ws");
+const core_common_1 = require("@itwin/core-common");
+const IpcHost_1 = require("./IpcHost");
+class LocalTransport extends core_common_1.IpcWebSocketTransport {
+    constructor(opts) {
+        var _a;
+        super();
+        this._connections = new Set();
+        if (!opts.noServer) {
+            this._server = new ws.Server({ port: (_a = opts.socketPort) !== null && _a !== void 0 ? _a : 3002 });
+            this._server.on("connection", (connection) => LocalhostIpcHost.connect(connection));
+        }
+    }
+    send(message) {
+        this._connections.forEach((connection) => connection.send(JSON.stringify(message)));
+    }
+    connect(connection) {
+        this._connections.add(connection);
+        connection.on("message", (data) => {
+            for (const listener of core_common_1.IpcWebSocket.receivers) {
+                listener({}, JSON.parse(data));
+            }
+        });
+        connection.on("close", () => {
+            this._connections.delete(connection);
+        });
+    }
+}
+/** @internal */
+class LocalhostIpcHost {
+    static connect(connection) {
+        core_common_1.IpcWebSocket.transport.connect(connection);
+    }
+    static async startup(opts) {
+        var _a;
+        core_common_1.IpcWebSocket.transport = new LocalTransport((_a = opts === null || opts === void 0 ? void 0 : opts.localhostIpcHost) !== null && _a !== void 0 ? _a : {});
+        const socket = new core_common_1.IpcWebSocketBackend();
+        await IpcHost_1.IpcHost.startup({ ipcHost: { socket }, iModelHost: opts === null || opts === void 0 ? void 0 : opts.iModelHost });
+    }
+}
+exports.LocalhostIpcHost = LocalhostIpcHost;
+//# sourceMappingURL=LocalhostIpcHost.js.map

package/lib/cjs/LocalhostIpcHost.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalhostIpcHost.js","sourceRoot":"","sources":["../../src/LocalhostIpcHost.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yBAAyB;AACzB,oDAAmH;AACnH,uCAAoC;AASpC,MAAM,cAAe,SAAQ,mCAAqB;IAIhD,YAAmB,IAA0B;;QAC3C,KAAK,EAAE,CAAC;QAHF,iBAAY,GAAY,IAAI,GAAG,EAAE,CAAC;QAKxC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAA,IAAI,CAAC,UAAU,mCAAI,IAAI,EAAE,CAAC,CAAC;YAChE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;SACrF;IACH,CAAC;IAEM,IAAI,CAAC,OAA4B;QACtC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACtF,CAAC;IAEM,OAAO,CAAC,UAAc;QAC3B,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAElC,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;YAChC,KAAK,MAAM,QAAQ,IAAI,0BAAY,CAAC,SAAS,EAAE;gBAC7C,QAAQ,CAAC,EAAW,EAAE,IAAI,CAAC,KAAK,CAAC,IAAc,CAAC,CAAC,CAAC;aACnD;QACH,CAAC,CAAC,CAAC;QAEH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAC1B,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,gBAAgB;AAChB,MAAa,gBAAgB;IACpB,MAAM,CAAC,OAAO,CAAC,UAAc;QACjC,0BAAY,CAAC,SAA4B,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACjE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAwF;;QAClH,0BAAY,CAAC,SAAS,GAAG,IAAI,cAAc,CAAC,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,mCAAI,EAAE,CAAC,CAAC;QAC1E,MAAM,MAAM,GAAG,IAAI,iCAAmB,EAAE,CAAC;QACzC,MAAM,iBAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU,EAAE,CAAC,CAAC;IAC/E,CAAC;CACF;AAVD,4CAUC","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 IModelHost\r\n */\r\n\r\nimport * as ws from \"ws\";\r\nimport { IpcWebSocket, IpcWebSocketBackend, IpcWebSocketMessage, IpcWebSocketTransport } from \"@itwin/core-common\";\r\nimport { IpcHost } from \"./IpcHost\";\r\nimport { IModelHostConfiguration } from \"./IModelHost\";\r\n\r\n/** @internal */\r\nexport interface LocalhostIpcHostOpts {\r\n  socketPort?: number;\r\n  noServer?: boolean;\r\n}\r\n\r\nclass LocalTransport extends IpcWebSocketTransport {\r\n  private _server: ws.Server | undefined;\r\n  private _connections: Set<ws> = new Set();\r\n\r\n  public constructor(opts: LocalhostIpcHostOpts) {\r\n    super();\r\n\r\n    if (!opts.noServer) {\r\n      this._server = new ws.Server({ port: opts.socketPort ?? 3002 });\r\n      this._server.on(\"connection\", (connection) => LocalhostIpcHost.connect(connection));\r\n    }\r\n  }\r\n\r\n  public send(message: IpcWebSocketMessage): void {\r\n    this._connections.forEach((connection) => connection.send(JSON.stringify(message)));\r\n  }\r\n\r\n  public connect(connection: ws) {\r\n    this._connections.add(connection);\r\n\r\n    connection.on(\"message\", (data) => {\r\n      for (const listener of IpcWebSocket.receivers) {\r\n        listener({} as Event, JSON.parse(data as string));\r\n      }\r\n    });\r\n\r\n    connection.on(\"close\", () => {\r\n      this._connections.delete(connection);\r\n    });\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class LocalhostIpcHost {\r\n  public static connect(connection: ws) {\r\n    (IpcWebSocket.transport as LocalTransport).connect(connection);\r\n  }\r\n\r\n  public static async startup(opts?: { localhostIpcHost?: LocalhostIpcHostOpts, iModelHost?: IModelHostConfiguration }) {\r\n    IpcWebSocket.transport = new LocalTransport(opts?.localhostIpcHost ?? {});\r\n    const socket = new IpcWebSocketBackend();\r\n    await IpcHost.startup({ ipcHost: { socket }, iModelHost: opts?.iModelHost });\r\n  }\r\n}\r\n"]}

package/lib/cjs/Material.d.ts

@@ -0,0 +1,102 @@
+/** @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 implements RenderMaterialProps {
+    /** @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);
+    }
+}
+//# sourceMappingURL=Material.d.ts.map

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

@@ -0,0 +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,iBAAkB,YAAW,mBAAmB;IACzF,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"}