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

package/lib/esm/LineStyle.d.ts

@@ -0,0 +1,312 @@
+/** @packageDocumentation
+ * @module ElementGeometry
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { LinePixels } from "@itwin/core-common";
+import { IModelDb } from "./IModelDb";
+/** 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
+ */
+export declare namespace LineStyleDefinition {
+    /** Line style component type identifiers */
+    enum ComponentType {
+        /** Component type for [[LineStyleDefinition.PointSymbolProps]] */
+        PointSymbol = 1,
+        /** Component type for [[LineStyleDefinition.CompoundProps]] */
+        Compound = 2,
+        /** Component type for [[LineStyleDefinition.StrokePatternProps]] */
+        StrokePattern = 3,
+        /** Component type for [[LineStyleDefinition.StrokePointProps]] */
+        StrokePoint = 4,
+        /** Component type for [[LinePixels]], never saved as a file property */
+        Internal = 6,
+        /** Component type for [[LineStyleDefinition.RasterImageProps]] */
+        RasterImage = 7
+    }
+    /** Mask of values for StrokeMode */
+    enum StrokeMode {
+        /** Stroke represents a blank space */
+        Gap = 0,
+        /** Stroke represents a solid dash */
+        Dash = 1,
+        /** Treat stroke as rigid and continue past a corner to complete the stroke as opposed to breaking at the corner */
+        Ray = 2,
+        /** Stroke length can be stretched when [[LineStyleDefinition.StrokePatternOptions.Iteration]] and [[LineStyleDefinition.StrokePatternOptions.AutoPhase]] options are set, applicable to both Gap and Dash strokes */
+        Scale = 4,
+        /** Invert stroke in first stroke pattern */
+        FirstInvert = 8,
+        /** Invert stroke in last stroke pattern */
+        LastInvert = 16
+    }
+    /** Define constant width or tapered strokes with distance specified in meters */
+    enum StrokeWidth {
+        /** Stroke draws as one pixel wide line */
+        None = 0,
+        /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to left side of stroke */
+        Left = 1,
+        /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to right side of stroke */
+        Right = 2,
+        /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to both sides of stroke */
+        Full = 3
+    }
+    /** 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.
+     */
+    enum StrokeCap {
+        /** Stroke displays as a closed polygon */
+        Closed = 0,
+        /** Stroke displays lines at specified width instead of a polygon */
+        Open = 1,
+        /** Stroke length extended by half the stroke width */
+        Extended = 2,
+        /** Stroke end cap is a hexagon */
+        Hexagon = 3,
+        /** Stroke end cap is an octagon */
+        Octagon = 4,
+        /** Stroke end cap is a decagon */
+        Decagon = 5,
+        /** Stroke end cap is an arc */
+        Arc = 30
+    }
+    /** A stroke representing either a dash or gap in a stroke pattern */
+    interface StrokeProps {
+        /** Length of stroke in meters */
+        length: number;
+        /** Width at start of stroke. Behavior controlled by [[LineStyleDefinition.StrokeWidth]], choose value other than [[LineStyleDefinition.StrokeWidth.None]] */
+        orgWidth?: number;
+        /** Width at end of stroke, same as start width if not present. Behavior controlled by [[LineStyleDefinition.StrokeWidth]], choose value other than [[LineStyleDefinition.StrokeWidth.None]] */
+        endWidth?: number;
+        /** Type and behavior of stroke */
+        strokeMode?: StrokeMode;
+        /** How to apply orgWidth and endWidth to stroke */
+        widthMode?: StrokeWidth;
+        /** Appearance of stroke end cap */
+        capMode?: StrokeCap;
+    }
+    type Strokes = StrokeProps[];
+    /** Options to control how stroke pattern is applied to underlying curve */
+    enum StrokePatternOptions {
+        /** Use default stroke behavior */
+        None = 0,
+        /** [[LineStyleDefinition.StrokePatternProps.phase]] represents fractional distance into first stroke of pattern */
+        AutoPhase = 1,
+        /** Use [[LineStyleDefinition.StrokePatternProps.maxIter]] to limit the number of iterations of the stroke pattern */
+        Iteration = 8,
+        /** Single segment mode restarts the stroke pattern at corners instead of continuing around corners */
+        Segment = 16,
+        /** Center the line style and stretch the ends */
+        CenterStretch = 32
+    }
+    /** Stroke pattern component definition [[LineStyleDefinition.ComponentType.StrokePattern]].
+     * 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
+     * include point symbols can be created by referencing a stroke pattern component by its file property id.
+     */
+    interface StrokePatternProps {
+        /** Name for this stroke pattern */
+        descr: string;
+        /** 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. */
+        phase?: number;
+        /** Options mask for this stroke pattern */
+        options?: StrokePatternOptions;
+        /** 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. */
+        maxIter?: number;
+        /** Array of strokes, maximum number that will be used is 32 */
+        strokes: Strokes;
+    }
+    /** Flags to identify point symbol behavior */
+    enum PointSymbolFlags {
+        /** Default symbol behavior */
+        None = 0,
+        /** Symbol includes 3d geometry */
+        Is3d = 1,
+        /** Symbol does not allow scaling */
+        NoScale = 2
+    }
+    /** Point symbol component definition [[LineStyleDefinition.ComponentType.PointSymbol]].
+     * A point symbol component identifies a GeometryPart for reference by a [[LineStyleDefinition.SymbolProps]].
+     */
+    interface PointSymbolProps {
+        /** GeometryPart Id to use as a pattern symbol */
+        geomPartId: Id64String;
+        /** GeometryPart.bbox.low.x */
+        baseX?: number;
+        /** GeometryPart.bbox.low.y */
+        baseY?: number;
+        /** GeometryPart.bbox.low.z */
+        baseZ?: number;
+        /** GeometryPart.bbox.high.x */
+        sizeX?: number;
+        /** GeometryPart.bbox.high.y */
+        sizeY?: number;
+        /** GeometryPart.bbox.high.z */
+        sizeZ?: number;
+        /** Symbol behavior flags */
+        symFlags?: PointSymbolFlags;
+        /** Symbol scale, defaults to 1 */
+        scale?: number;
+    }
+    /** Symbol options for location, orientation, and behavior */
+    enum SymbolOptions {
+        /** No point symbol */
+        None = 0,
+        /** Symbol at origin of stroke */
+        Origin = 1,
+        /** Symbol at end of stroke */
+        End = 2,
+        /** symbol at center of stroke */
+        Center = 3,
+        /** Symbol at curve start point */
+        CurveOrigin = 4,
+        /** Symbol at curve end point */
+        CurveEnd = 8,
+        /** Symbol at each vertex */
+        CurveVertex = 16,
+        /** Adjust symbol rotation left->right */
+        AdjustRotation = 32,
+        /** Angle of symbol not relative to stroke direction */
+        AbsoluteRotation = 64,
+        /** No scale on variable strokes */
+        NoScale = 256,
+        /** No clip on partial strokes */
+        NoClip = 512,
+        /** No partial strokes */
+        NoPartial = 1024,
+        /** Project partial origin */
+        ProjectOrigin = 2048,
+        /** Use color from symbol instead of inheriting curve color */
+        UseColor = 16384,
+        /** Use weight from symbol instead of inheriting curve weight */
+        UseWeight = 32768
+    }
+    /** Identifies a symbol and its location and orientation relative to a stroke pattern */
+    interface SymbolProps {
+        /** The file property id of the symbol component, assumed to be [[LineStyleDefinition.ComponentType.PointSymbol]] if symType is undefined. */
+        symId: number;
+        /** The component type, leave undefined if symId is a [[LineStyleDefinition.ComponentType.PointSymbol]] */
+        symType?: ComponentType;
+        /** The 0 based stroke index for base stroke pattern [[LineStyleDefinition.ComponentType.StrokePattern]] component */
+        strokeNum?: number;
+        /** Symbol x offset distance in meters */
+        xOffset?: number;
+        /** Symbol y offset distance in meters */
+        yOffset?: number;
+        /** Symbol rotation in radians */
+        angle?: number;
+        /** Must set location for symbol as default value is [[LineStyleDefinition.SymbolOptions.None]] */
+        mod1?: SymbolOptions;
+    }
+    type Symbols = SymbolProps[];
+    /** Stroke point component definition [[LineStyleDefinition.ComponentType.StrokePoint]].
+     * A stroke point component identifies the locations of point symbol components relative to a base stroke pattern component.
+     */
+    interface StrokePointProps {
+        /** Name for this stroke point component */
+        descr: string;
+        /** The file property id of the stroke component, assumed to be [[LineStyleDefinition.ComponentType.StrokePattern]] if lcType is undefined */
+        lcId: number;
+        /** The component type, leave undefined if lcId is a [[LineStyleDefinition.ComponentType.StrokePattern]] */
+        lcType?: ComponentType;
+        /** Array of symbols */
+        symbols: Symbols;
+    }
+    /** Raster component definition [[LineStyleDefinition.ComponentType.RasterImage]].
+     * A raster component identifies a texture for a line style.
+     */
+    interface RasterImageProps {
+        /** Name for this raster image component */
+        descr: string;
+        /** Raster width */
+        x: number;
+        /** Raster height */
+        y: number;
+        /** True width flag */
+        trueWidth?: number;
+        /** Raster flags */
+        flags?: number;
+        /** The file property id of raster image */
+        imageId?: number;
+    }
+    /** Identifies a component by file property id and type */
+    interface ComponentProps {
+        /** The file property id of [[LineStyleDefinition.ComponentType.StrokePattern]] or [[LineStyleDefinition.ComponentType.StrokePoint]] component */
+        id: number;
+        /** The type of component for specified file property id */
+        type: ComponentType;
+        /** Offset distance for this component, default is 0 */
+        offset?: number;
+    }
+    type Components = ComponentProps[];
+    /** Compound component definition [[LineStyleDefinition.ComponentType.Compound]].
+     * A compound component is used to link stroke pattern and stroke point components to create a style that displays dashes, gaps, and symbols.
+     */
+    interface CompoundProps {
+        comps: Components;
+    }
+    /** Flags to describe a style or control style behavior */
+    enum StyleFlags {
+        /** Use defaults */
+        None = 0,
+        /** Only snap to center line and not individual strokes and symbols of line style */
+        NoSnap = 4,
+        /** Style represents a continuous line with width (determined by looking at components if not set) */
+        Continuous = 8,
+        /** Style represents physical geometry and should be scaled as such */
+        Physical = 128
+    }
+    /** The line style definition element data */
+    interface StyleProps {
+        /** The file property id for either a [[LineStyleDefinition.ComponentType.StrokePattern]] or [[LineStyleDefinition.ComponentType.Compound]] component */
+        compId: number;
+        /** The type of component for specified file property id */
+        compType: ComponentType;
+        /** Style behavior flags. Defaults to [[LineStyleDefinition.StyleFlags.NoSnap]] if left undefined */
+        flags?: StyleFlags;
+        /** Style scale, defaults to 1 */
+        unitDef?: number;
+    }
+    /** Helper methods for creating and querying line styles */
+    class Utils {
+        /** Create a file property for a new stroke pattern component. */
+        static createStrokePatternComponent(iModel: IModelDb, props: StrokePatternProps): StyleProps;
+        /** 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: IModelDb, props: PointSymbolProps): StyleProps | undefined;
+        /** Create a file property for a new stroke point component. */
+        static createStrokePointComponent(iModel: IModelDb, props: StrokePointProps): StyleProps;
+        /** Create a file property for a new compound component. */
+        static createCompoundComponent(iModel: IModelDb, props: CompoundProps): StyleProps;
+        /** Create a file property for a new raster image component. */
+        static createRasterComponent(iModel: IModelDb, props: RasterImageProps, image: Uint8Array): StyleProps | undefined;
+        /** Query for an existing line style with the supplied name. */
+        static queryStyle(imodel: IModelDb, scopeModelId: Id64String, name: string): Id64String | undefined;
+        /** Insert a new line style with the supplied name.
+         * @throws [[IModelError]] if unable to insert the line style definition element.
+         */
+        static createStyle(imodel: IModelDb, scopeModelId: Id64String, name: string, props: StyleProps): Id64String;
+        /** 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: IModelDb, scopeModelId: Id64String, width?: number): Id64String;
+        /** 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: IModelDb, scopeModelId: Id64String, linePixels: LinePixels): Id64String;
+    }
+}
+//# sourceMappingURL=LineStyle.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LineStyle.d.ts","sourceRoot":"","sources":["../../src/LineStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAgB,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAkC,UAAU,EAAkB,MAAM,oBAAoB,CAAC;AAEhG,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;;GASG;AACH,yBAAiB,mBAAmB,CAAC;IAEnC,4CAA4C;IAC5C,KAAY,aAAa;QACvB,kEAAkE;QAClE,WAAW,IAAI;QACf,+DAA+D;QAC/D,QAAQ,IAAI;QACZ,oEAAoE;QACpE,aAAa,IAAI;QACjB,kEAAkE;QAClE,WAAW,IAAI;QACf,wEAAwE;QACxE,QAAQ,IAAI;QACZ,kEAAkE;QAClE,WAAW,IAAI;KAChB;IAED,oCAAoC;IACpC,KAAY,UAAU;QACpB,sCAAsC;QACtC,GAAG,IAAO;QACV,qCAAqC;QACrC,IAAI,IAAO;QACX,mHAAmH;QACnH,GAAG,IAAO;QACV,qNAAqN;QACrN,KAAK,IAAO;QACZ,4CAA4C;QAC5C,WAAW,IAAO;QAClB,2CAA2C;QAC3C,UAAU,KAAO;KAClB;IAED,iFAAiF;IACjF,KAAY,WAAW;QACrB,0CAA0C;QAC1C,IAAI,IAAI;QACR,wIAAwI;QACxI,IAAI,IAAI;QACR,yIAAyI;QACzI,KAAK,IAAI;QACT,yIAAyI;QACzI,IAAI,IAAI;KACT;IAED;;OAEG;IACH,KAAY,SAAS;QACnB,0CAA0C;QAC1C,MAAM,IAAI;QACV,oEAAoE;QACpE,IAAI,IAAI;QACR,sDAAsD;QACtD,QAAQ,IAAI;QACZ,kCAAkC;QAClC,OAAO,IAAI;QACX,mCAAmC;QACnC,OAAO,IAAI;QACX,kCAAkC;QAClC,OAAO,IAAI;QACX,+BAA+B;QAC/B,GAAG,KAAK;KACT;IAED,qEAAqE;IACrE,UAAiB,WAAW;QAC1B,iCAAiC;QACjC,MAAM,EAAE,MAAM,CAAC;QACf,6JAA6J;QAC7J,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,+LAA+L;QAC/L,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,kCAAkC;QAClC,UAAU,CAAC,EAAE,UAAU,CAAC;QACxB,mDAAmD;QACnD,SAAS,CAAC,EAAE,WAAW,CAAC;QACxB,mCAAmC;QACnC,OAAO,CAAC,EAAE,SAAS,CAAC;KACrB;IAED,KAAY,OAAO,GAAG,WAAW,EAAE,CAAC;IAEpC,2EAA2E;IAC3E,KAAY,oBAAoB;QAC9B,kCAAkC;QAClC,IAAI,IAAO;QACX,mHAAmH;QACnH,SAAS,IAAO;QAChB,qHAAqH;QACrH,SAAS,IAAO;QAChB,sGAAsG;QACtG,OAAO,KAAO;QACd,iDAAiD;QACjD,aAAa,KAAO;KACrB;IAED;;;OAGG;IACH,UAAiB,kBAAkB;QACjC,mCAAmC;QACnC,KAAK,EAAE,MAAM,CAAC;QACd,uQAAuQ;QACvQ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,2CAA2C;QAC3C,OAAO,CAAC,EAAE,oBAAoB,CAAC;QAC/B,8MAA8M;QAC9M,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,+DAA+D;QAC/D,OAAO,EAAE,OAAO,CAAC;KAClB;IAED,8CAA8C;IAC9C,KAAY,gBAAgB;QAC1B,8BAA8B;QAC9B,IAAI,IAAM;QACV,kCAAkC;QAClC,IAAI,IAAO;QACX,oCAAoC;QACpC,OAAO,IAAO;KACf;IAED;;OAEG;IACH,UAAiB,gBAAgB;QAC/B,iDAAiD;QACjD,UAAU,EAAE,UAAU,CAAC;QACvB,8BAA8B;QAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,8BAA8B;QAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,8BAA8B;QAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,+BAA+B;QAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,+BAA+B;QAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,+BAA+B;QAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,4BAA4B;QAC5B,QAAQ,CAAC,EAAE,gBAAgB,CAAC;QAC5B,kCAAkC;QAClC,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED,6DAA6D;IAC7D,KAAY,aAAa;QACvB,sBAAsB;QACtB,IAAI,IAAO;QACX,iCAAiC;QACjC,MAAM,IAAO;QACb,8BAA8B;QAC9B,GAAG,IAAO;QACV,iCAAiC;QACjC,MAAM,IAAO;QACb,kCAAkC;QAClC,WAAW,IAAS;QACpB,gCAAgC;QAChC,QAAQ,IAAS;QACjB,4BAA4B;QAC5B,WAAW,KAAS;QACpB,yCAAyC;QACzC,cAAc,KAAS;QACvB,uDAAuD;QACvD,gBAAgB,KAAS;QACzB,mCAAmC;QACnC,OAAO,MAAS;QAChB,iCAAiC;QACjC,MAAM,MAAS;QACf,yBAAyB;QACzB,SAAS,OAAS;QAClB,6BAA6B;QAC7B,aAAa,OAAS;QACtB,8DAA8D;QAC9D,QAAQ,QAAS;QACjB,gEAAgE;QAChE,SAAS,QAAS;KACnB;IAED,wFAAwF;IACxF,UAAiB,WAAW;QAC1B,6IAA6I;QAC7I,KAAK,EAAE,MAAM,CAAC;QACd,0GAA0G;QAC1G,OAAO,CAAC,EAAE,aAAa,CAAC;QACxB,qHAAqH;QACrH,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,yCAAyC;QACzC,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,yCAAyC;QACzC,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,iCAAiC;QACjC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,kGAAkG;QAClG,IAAI,CAAC,EAAE,aAAa,CAAC;KACtB;IAED,KAAY,OAAO,GAAG,WAAW,EAAE,CAAC;IAEpC;;OAEG;IACH,UAAiB,gBAAgB;QAC/B,2CAA2C;QAC3C,KAAK,EAAE,MAAM,CAAC;QACd,6IAA6I;QAC7I,IAAI,EAAE,MAAM,CAAC;QACb,2GAA2G;QAC3G,MAAM,CAAC,EAAE,aAAa,CAAC;QACvB,uBAAuB;QACvB,OAAO,EAAE,OAAO,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,gBAAgB;QAC/B,2CAA2C;QAC3C,KAAK,EAAE,MAAM,CAAC;QACd,mBAAmB;QACnB,CAAC,EAAE,MAAM,CAAC;QACV,oBAAoB;QACpB,CAAC,EAAE,MAAM,CAAC;QACV,sBAAsB;QACtB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,mBAAmB;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,2CAA2C;QAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED,0DAA0D;IAC1D,UAAiB,cAAc;QAC7B,iJAAiJ;QACjJ,EAAE,EAAE,MAAM,CAAC;QACX,2DAA2D;QAC3D,IAAI,EAAE,aAAa,CAAC;QACpB,uDAAuD;QACvD,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IAED,KAAY,UAAU,GAAG,cAAc,EAAE,CAAC;IAE1C;;OAEG;IACH,UAAiB,aAAa;QAC5B,KAAK,EAAE,UAAU,CAAC;KACnB;IAED,0DAA0D;IAC1D,KAAY,UAAU;QACpB,mBAAmB;QACnB,IAAI,IAAO;QACX,oFAAoF;QACpF,MAAM,IAAO;QACb,qGAAqG;QACrG,UAAU,IAAO;QACjB,sEAAsE;QACtE,QAAQ,MAAO;KAChB;IAED,6CAA6C;IAC7C,UAAiB,UAAU;QACzB,wJAAwJ;QACxJ,MAAM,EAAE,MAAM,CAAC;QACf,2DAA2D;QAC3D,QAAQ,EAAE,aAAa,CAAC;QACxB,oGAAoG;QACpG,KAAK,CAAC,EAAE,UAAU,CAAC;QACnB,iCAAiC;QACjC,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED,2DAA2D;IAC3D,MAAa,KAAK;QAEhB,iEAAiE;eACnD,4BAA4B,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,kBAAkB,GAAG,UAAU;QAOnG;;WAEG;eACW,0BAA0B,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,gBAAgB,GAAG,UAAU,GAAG,SAAS;QAsB3G,+DAA+D;eACjD,0BAA0B,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,gBAAgB,GAAG,UAAU;QAO/F,2DAA2D;eAC7C,uBAAuB,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,aAAa,GAAG,UAAU;QAOzF,+DAA+D;eACjD,qBAAqB,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS;QAWzH,+DAA+D;eACjD,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;QAI1G;;WAEG;eACW,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,UAAU;QAclH;;;;;;;;WAQG;eACW,0BAA0B,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,UAAU;QAmBhH;;;;WAIG;eACW,0BAA0B,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,GAAG,UAAU;KA+BzH;CACF"}

package/lib/esm/LineStyle.js

@@ -0,0 +1,293 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ElementGeometry
+ */
+import { IModelStatus } from "@itwin/core-bentley";
+import { IModelError, LinePixels } from "@itwin/core-common";
+import { LineStyle } from "./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
+ */
+export 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(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: 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 IModelError(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 LinePixels.Code1:
+                    lineCode = 1;
+                    break;
+                case LinePixels.Code2:
+                    lineCode = 2;
+                    break;
+                case LinePixels.Code3:
+                    lineCode = 3;
+                    break;
+                case LinePixels.Code4:
+                    lineCode = 4;
+                    break;
+                case LinePixels.Code5:
+                    lineCode = 5;
+                    break;
+                case LinePixels.Code6:
+                    lineCode = 6;
+                    break;
+                case LinePixels.Code7:
+                    lineCode = 7;
+                    break;
+                default:
+                    throw new IModelError(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 || (LineStyleDefinition = {}));
+//# sourceMappingURL=LineStyle.js.map