@itwin/core-common 3.4.0-dev.42 → 3.4.0-dev.44

package/lib/cjs/GeometryContainment.d.ts

@@ -1,29 +1,29 @@
-/** @packageDocumentation
- * @module Geometry
- */
-import { BentleyStatus, Id64Array } from "@itwin/core-bentley";
-import { ViewFlagProps } from "./ViewFlags";
-import { ClipPlaneContainment, ClipVectorProps } from "@itwin/core-geometry";
-/** Information required to request clip containment status for elements from the front end to the back end.
- * @public
- * @extensions
- */
-export interface GeometryContainmentRequestProps {
-    candidates: Id64Array;
-    clip: ClipVectorProps;
-    allowOverlaps?: boolean;
-    viewFlags?: ViewFlagProps;
-    offSubCategories?: Id64Array;
-}
-/** Information returned from the back end to the front end holding the result of the geometry containment query.
- * @public
- * @extensions
- */
-export interface GeometryContainmentResponseProps {
-    status: BentleyStatus;
-    candidatesContainment?: ClipPlaneContainment[];
-    numInside?: number;
-    numOutside?: number;
-    numOverlap?: number;
-}
+/** @packageDocumentation
+ * @module Geometry
+ */
+import { BentleyStatus, Id64Array } from "@itwin/core-bentley";
+import { ViewFlagProps } from "./ViewFlags";
+import { ClipPlaneContainment, ClipVectorProps } from "@itwin/core-geometry";
+/** Information required to request clip containment status for elements from the front end to the back end.
+ * @public
+ * @extensions
+ */
+export interface GeometryContainmentRequestProps {
+    candidates: Id64Array;
+    clip: ClipVectorProps;
+    allowOverlaps?: boolean;
+    viewFlags?: ViewFlagProps;
+    offSubCategories?: Id64Array;
+}
+/** Information returned from the back end to the front end holding the result of the geometry containment query.
+ * @public
+ * @extensions
+ */
+export interface GeometryContainmentResponseProps {
+    status: BentleyStatus;
+    candidatesContainment?: ClipPlaneContainment[];
+    numInside?: number;
+    numOutside?: number;
+    numOverlap?: number;
+}
 //# sourceMappingURL=GeometryContainment.d.ts.map

package/lib/cjs/GeometryContainment.js

@@ -1,10 +1,10 @@
-"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 Geometry
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"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 Geometry
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=GeometryContainment.js.map

package/lib/cjs/GeometryContainment.js.map

@@ -1 +1 @@
-{"version":3,"file":"GeometryContainment.js","sourceRoot":"","sources":["../../src/GeometryContainment.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Geometry\r\n */\r\n\r\nimport { BentleyStatus, Id64Array } from \"@itwin/core-bentley\";\r\nimport { ViewFlagProps } from \"./ViewFlags\";\r\nimport { ClipPlaneContainment, ClipVectorProps } from \"@itwin/core-geometry\";\r\n\r\n/** Information required to request clip containment status for elements from the front end to the back end.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface GeometryContainmentRequestProps {\r\n  candidates: Id64Array;\r\n  clip: ClipVectorProps;\r\n  allowOverlaps?: boolean;\r\n  viewFlags?: ViewFlagProps;\r\n  offSubCategories?: Id64Array;\r\n}\r\n\r\n/** Information returned from the back end to the front end holding the result of the geometry containment query.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface GeometryContainmentResponseProps {\r\n  status: BentleyStatus;\r\n  candidatesContainment?: ClipPlaneContainment[]; // status for candidate array entry at the same index.\r\n  numInside?: number;\r\n  numOutside?: number;\r\n  numOverlap?: number;\r\n}\r\n"]}
+{"version":3,"file":"GeometryContainment.js","sourceRoot":"","sources":["../../src/GeometryContainment.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Geometry\n */\n\nimport { BentleyStatus, Id64Array } from \"@itwin/core-bentley\";\nimport { ViewFlagProps } from \"./ViewFlags\";\nimport { ClipPlaneContainment, ClipVectorProps } from \"@itwin/core-geometry\";\n\n/** Information required to request clip containment status for elements from the front end to the back end.\n * @public\n * @extensions\n */\nexport interface GeometryContainmentRequestProps {\n  candidates: Id64Array;\n  clip: ClipVectorProps;\n  allowOverlaps?: boolean;\n  viewFlags?: ViewFlagProps;\n  offSubCategories?: Id64Array;\n}\n\n/** Information returned from the back end to the front end holding the result of the geometry containment query.\n * @public\n * @extensions\n */\nexport interface GeometryContainmentResponseProps {\n  status: BentleyStatus;\n  candidatesContainment?: ClipPlaneContainment[]; // status for candidate array entry at the same index.\n  numInside?: number;\n  numOutside?: number;\n  numOverlap?: number;\n}\n"]}

package/lib/cjs/GeometryParams.d.ts

@@ -1,131 +1,131 @@
-/** @packageDocumentation
- * @module Symbology
- */
-import { Id64String } from "@itwin/core-bentley";
-import { ColorDef } from "./ColorDef";
-import { AreaPattern } from "./geometry/AreaPattern";
-import { LineStyle } from "./geometry/LineStyle";
-import { Gradient } from "./Gradient";
-/** Whether a closed region should be drawn for wireframe display with its internal area filled or not.
- * @public
- * @extensions
- */
-export declare enum FillDisplay {
-    /** don't fill, even if fill attribute is on for the viewport */
-    Never = 0,
-    /** fill if the fill attribute is on for the viewport */
-    ByView = 1,
-    /** always fill, even if the fill attribute is off for the viewport */
-    Always = 2,
-    /** always fill, fill will always be behind other geometry */
-    Blanking = 3
-}
-/** Describes how a view's background color affects the interior area of a closed region.
- * @public
- * @extensions
- */
-export declare enum BackgroundFill {
-    /** single color fill uses the fill color and line color to draw either a solid or outline fill */
-    None = 0,
-    /** single color fill uses the view's background color to draw a solid fill */
-    Solid = 1,
-    /** single color fill uses the view's background color and line color to draw an outline fill */
-    Outline = 2
-}
-/** Categorizes a piece of geometry within a GeometryStream. Visibility of classes of geometry can be toggled
- * within a view using [[ViewFlags]].
- * @see [[GeometryStreamProps]].
- * @see [[Feature]].
- * @public
- * @extensions
- */
-export declare enum GeometryClass {
-    /** Used to classify the "real" geometry within a model. Most geometry falls within this class. */
-    Primary = 0,
-    /** Used to classify geometry used as a drawing aid in constructing the Primary geometry. For example, grid lines. */
-    Construction = 1,
-    /** Used to classify annotations which dimension (measure) the Primary geometry. */
-    Dimension = 2,
-    /** Used to classify geometry used to fill planar regions with a 2d pattern (e.g., hatch lines). */
-    Pattern = 3
-}
-/** Describes the display properties of graphics in a persistent element's GeometryStream that aren't inherited from [[SubCategoryAppearance]].
- * @see [[GeometryStreamProps]].
- * @public
- */
-export declare class GeometryParams {
-    categoryId: Id64String;
-    subCategoryId: string;
-    /** Optional render material to override [[SubCategoryAppearance.materialId]].
-     * Specify an invalid [[Id64]] to override [[SubCategoryAppearance.materialId]] with no material.
-     */
-    materialId?: Id64String;
-    /** Optional display priority added to [[SubCategoryAppearance.priority]].
-     * The net display priority value is used to control z ordering when drawing to 2d views.
-     */
-    elmPriority?: number;
-    /** Optional line weight to override [[SubCategoryAppearance.weight]].
-     * The weight is an integer in the range of [0,31] that by default corresponds to a pixel width of weight+1.
-     */
-    weight?: number;
-    /** Optional line color to override [[SubCategoryAppearance.color]].
-     * The transparency component is ignored and should instead be specified using [[elmTransparency]].
-     */
-    lineColor?: ColorDef;
-    /** Optional fill color for region interiors. Set the same as [[lineColor]] for an opaque fill.
-     * Valid when [[fillDisplay]] is not [[FillDisplay.Never]], [[gradient]] is undefined, and [[backgroundFill]] is [[BackgroundFill.None]].
-     * The transparency component is ignored and should instead be specified using [[fillTransparency]].
-     */
-    fillColor?: ColorDef;
-    /** Optional fill using the current view background color for region interiors.
-     * Valid when [[fillDisplay]] is not [[FillDisplay.Never]] and [[gradient]] is undefined. Default is [[BackgroundFill.None]].
-     */
-    backgroundFill?: BackgroundFill;
-    /** Optional fill specification that determines when and if a region interior will display using [[gradient]], [[backgroundFill]], or [[fillColor]] in that order of preference.
-     * Fill only applies to [[RenderMode.Wireframe]] views. In a [[RenderMode.SmoothShade]] or [[RenderMode.SolidFill]] view, regions will always display as surfaces preferring [[fillColor]] when present over [[lineColor]].
-     * Default is [[FillDisplay.Never]].
-     */
-    fillDisplay?: FillDisplay;
-    /** Optional line color transparency to combine with [[SubCategoryAppearance.transparency]].
-     * Transparency values are combined by multiplying the opaqueness. A 50% transparent element on a 50% transparent sub-category creates a 75% transparent result (1 - ((1 - .5) * (1 - .5)) = 0.75).
-     * Value range is [0.0,1.0]. Pass 0.0 for completely opaque and 1.0 for completely transparent.
-     */
-    elmTransparency?: number;
-    /** Optional fill color transparency to combine with [[SubCategoryAppearance.transparency]].
-     * Transparency values are combined by multiplying the opaqueness. A 50% transparent fill on a 50% transparent sub-category creates a 75% transparent result (1 - ((1 - .5) * (1 - .5)) = 0.75).
-     * Value range is [0.0,1.0]. Pass 0.0 for completely opaque, 1.0 for completely transparent, or leave undefined to use [[elmTransparency]].
-     */
-    fillTransparency?: number;
-    /** Optional geometry classification that can be toggled off with a [[ViewFlags]] independent of [[SubCategoryAppearance.invisible]].
-     * Default is [[GeometryClass.Primary]].
-     */
-    geometryClass?: GeometryClass;
-    /** Optional line style to override [[SubCategoryAppearance.styleId]] plus modifiers to override the line style definition.
-     * Specify an invalid [[Id64]] to override [[SubCategoryAppearance.styleId]] with a solid line.
-     */
-    styleInfo?: LineStyle.Info;
-    /** Optional gradient fill settings for region interiors.
-     * Valid when [[fillDisplay]] is not [[FillDisplay.Never]].
-     */
-    gradient?: Gradient.Symb;
-    /** Optional area pattern settings for region interiors.
-     * Independent of fill, a region can have both fill and pattern.
-     */
-    pattern?: AreaPattern.Params;
-    /** Create a GeometryParams given a [[Category]] Id for a [[GeometricElement]] and optional [[SubCategory]] Id. The [[SubCategory.appearance]] establishes the non-overriden display properties of
-     * graphics in a GeometricElement's [[GeometryStreamProps]]. A GeometricElement refers to a single Category through [[GeometricElement.category]], while it's graphics can appear on multiple SubCategories
-     * by adding a [[GeometryAppearanceProps]] with a SubCategory change to the GeometryStream.
-     * @note If a valid SubCategory Id is not supplied, the default SubCategory for the parent Category is used. To be considered valid, [[SubCategory.getCategoryId]] must refer to the specified Category Id.
-     */
-    constructor(categoryId: Id64String, subCategoryId?: string);
-    clone(): GeometryParams;
-    /** Clears [[SubCategoryAppearance]] overrides while preserving [[categoryId]] and [[subCategoryId]]. */
-    resetAppearance(): void;
-    /** Compare two [[GeometryParams]] for equivalence, i.e. both values are undefined and inherited from [[SubCategoryAppearance]] or have the same override. */
-    isEquivalent(other: GeometryParams): boolean;
-    /** Change [[categoryId]] to the supplied id, [[subCategoryId]] to the supplied category's the default subCategory, and optionally clear any [[SubCategoryAppearance]] overrides. */
-    setCategoryId(categoryId: Id64String, clearAppearanceOverrides?: boolean): void;
-    /** Change [[subCategoryId]] to the supplied id and optionally clear any [[SubCategoryAppearance]] overrides. */
-    setSubCategoryId(subCategoryId: Id64String, clearAppearanceOverrides?: boolean): void;
-}
+/** @packageDocumentation
+ * @module Symbology
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { ColorDef } from "./ColorDef";
+import { AreaPattern } from "./geometry/AreaPattern";
+import { LineStyle } from "./geometry/LineStyle";
+import { Gradient } from "./Gradient";
+/** Whether a closed region should be drawn for wireframe display with its internal area filled or not.
+ * @public
+ * @extensions
+ */
+export declare enum FillDisplay {
+    /** don't fill, even if fill attribute is on for the viewport */
+    Never = 0,
+    /** fill if the fill attribute is on for the viewport */
+    ByView = 1,
+    /** always fill, even if the fill attribute is off for the viewport */
+    Always = 2,
+    /** always fill, fill will always be behind other geometry */
+    Blanking = 3
+}
+/** Describes how a view's background color affects the interior area of a closed region.
+ * @public
+ * @extensions
+ */
+export declare enum BackgroundFill {
+    /** single color fill uses the fill color and line color to draw either a solid or outline fill */
+    None = 0,
+    /** single color fill uses the view's background color to draw a solid fill */
+    Solid = 1,
+    /** single color fill uses the view's background color and line color to draw an outline fill */
+    Outline = 2
+}
+/** Categorizes a piece of geometry within a GeometryStream. Visibility of classes of geometry can be toggled
+ * within a view using [[ViewFlags]].
+ * @see [[GeometryStreamProps]].
+ * @see [[Feature]].
+ * @public
+ * @extensions
+ */
+export declare enum GeometryClass {
+    /** Used to classify the "real" geometry within a model. Most geometry falls within this class. */
+    Primary = 0,
+    /** Used to classify geometry used as a drawing aid in constructing the Primary geometry. For example, grid lines. */
+    Construction = 1,
+    /** Used to classify annotations which dimension (measure) the Primary geometry. */
+    Dimension = 2,
+    /** Used to classify geometry used to fill planar regions with a 2d pattern (e.g., hatch lines). */
+    Pattern = 3
+}
+/** Describes the display properties of graphics in a persistent element's GeometryStream that aren't inherited from [[SubCategoryAppearance]].
+ * @see [[GeometryStreamProps]].
+ * @public
+ */
+export declare class GeometryParams {
+    categoryId: Id64String;
+    subCategoryId: string;
+    /** Optional render material to override [[SubCategoryAppearance.materialId]].
+     * Specify an invalid [[Id64]] to override [[SubCategoryAppearance.materialId]] with no material.
+     */
+    materialId?: Id64String;
+    /** Optional display priority added to [[SubCategoryAppearance.priority]].
+     * The net display priority value is used to control z ordering when drawing to 2d views.
+     */
+    elmPriority?: number;
+    /** Optional line weight to override [[SubCategoryAppearance.weight]].
+     * The weight is an integer in the range of [0,31] that by default corresponds to a pixel width of weight+1.
+     */
+    weight?: number;
+    /** Optional line color to override [[SubCategoryAppearance.color]].
+     * The transparency component is ignored and should instead be specified using [[elmTransparency]].
+     */
+    lineColor?: ColorDef;
+    /** Optional fill color for region interiors. Set the same as [[lineColor]] for an opaque fill.
+     * Valid when [[fillDisplay]] is not [[FillDisplay.Never]], [[gradient]] is undefined, and [[backgroundFill]] is [[BackgroundFill.None]].
+     * The transparency component is ignored and should instead be specified using [[fillTransparency]].
+     */
+    fillColor?: ColorDef;
+    /** Optional fill using the current view background color for region interiors.
+     * Valid when [[fillDisplay]] is not [[FillDisplay.Never]] and [[gradient]] is undefined. Default is [[BackgroundFill.None]].
+     */
+    backgroundFill?: BackgroundFill;
+    /** Optional fill specification that determines when and if a region interior will display using [[gradient]], [[backgroundFill]], or [[fillColor]] in that order of preference.
+     * Fill only applies to [[RenderMode.Wireframe]] views. In a [[RenderMode.SmoothShade]] or [[RenderMode.SolidFill]] view, regions will always display as surfaces preferring [[fillColor]] when present over [[lineColor]].
+     * Default is [[FillDisplay.Never]].
+     */
+    fillDisplay?: FillDisplay;
+    /** Optional line color transparency to combine with [[SubCategoryAppearance.transparency]].
+     * Transparency values are combined by multiplying the opaqueness. A 50% transparent element on a 50% transparent sub-category creates a 75% transparent result (1 - ((1 - .5) * (1 - .5)) = 0.75).
+     * Value range is [0.0,1.0]. Pass 0.0 for completely opaque and 1.0 for completely transparent.
+     */
+    elmTransparency?: number;
+    /** Optional fill color transparency to combine with [[SubCategoryAppearance.transparency]].
+     * Transparency values are combined by multiplying the opaqueness. A 50% transparent fill on a 50% transparent sub-category creates a 75% transparent result (1 - ((1 - .5) * (1 - .5)) = 0.75).
+     * Value range is [0.0,1.0]. Pass 0.0 for completely opaque, 1.0 for completely transparent, or leave undefined to use [[elmTransparency]].
+     */
+    fillTransparency?: number;
+    /** Optional geometry classification that can be toggled off with a [[ViewFlags]] independent of [[SubCategoryAppearance.invisible]].
+     * Default is [[GeometryClass.Primary]].
+     */
+    geometryClass?: GeometryClass;
+    /** Optional line style to override [[SubCategoryAppearance.styleId]] plus modifiers to override the line style definition.
+     * Specify an invalid [[Id64]] to override [[SubCategoryAppearance.styleId]] with a solid line.
+     */
+    styleInfo?: LineStyle.Info;
+    /** Optional gradient fill settings for region interiors.
+     * Valid when [[fillDisplay]] is not [[FillDisplay.Never]].
+     */
+    gradient?: Gradient.Symb;
+    /** Optional area pattern settings for region interiors.
+     * Independent of fill, a region can have both fill and pattern.
+     */
+    pattern?: AreaPattern.Params;
+    /** Create a GeometryParams given a [[Category]] Id for a [[GeometricElement]] and optional [[SubCategory]] Id. The [[SubCategory.appearance]] establishes the non-overriden display properties of
+     * graphics in a GeometricElement's [[GeometryStreamProps]]. A GeometricElement refers to a single Category through [[GeometricElement.category]], while it's graphics can appear on multiple SubCategories
+     * by adding a [[GeometryAppearanceProps]] with a SubCategory change to the GeometryStream.
+     * @note If a valid SubCategory Id is not supplied, the default SubCategory for the parent Category is used. To be considered valid, [[SubCategory.getCategoryId]] must refer to the specified Category Id.
+     */
+    constructor(categoryId: Id64String, subCategoryId?: string);
+    clone(): GeometryParams;
+    /** Clears [[SubCategoryAppearance]] overrides while preserving [[categoryId]] and [[subCategoryId]]. */
+    resetAppearance(): void;
+    /** Compare two [[GeometryParams]] for equivalence, i.e. both values are undefined and inherited from [[SubCategoryAppearance]] or have the same override. */
+    isEquivalent(other: GeometryParams): boolean;
+    /** Change [[categoryId]] to the supplied id, [[subCategoryId]] to the supplied category's the default subCategory, and optionally clear any [[SubCategoryAppearance]] overrides. */
+    setCategoryId(categoryId: Id64String, clearAppearanceOverrides?: boolean): void;
+    /** Change [[subCategoryId]] to the supplied id and optionally clear any [[SubCategoryAppearance]] overrides. */
+    setSubCategoryId(subCategoryId: Id64String, clearAppearanceOverrides?: boolean): void;
+}
 //# sourceMappingURL=GeometryParams.d.ts.map