@itwin/core-common 3.7.0-dev.2 → 3.7.0-dev.5

package/lib/esm/tile/ElementGraphics.d.ts

@@ -1,146 +1,146 @@
-/** @packageDocumentation
- * @module Tile
- */
-import { Id64String } from "@itwin/core-bentley";
-import { TransformProps } from "@itwin/core-geometry";
-import { Placement2dProps, Placement3dProps } from "../ElementProps";
-import { ElementGeometryDataEntry } from "../geometry/ElementGeometry";
-import { GeometryStreamProps } from "../geometry/GeometryStream";
-import { ContentFlags, TreeFlags } from "../tile/TileMetadata";
-/** Wire format describing properties common to [[PersistentGraphicsRequestProps]] and [[DynamicGraphicsRequestProps]].
- * @see [[ElementGraphicsRequestProps]] for more details.
- * @public
- * @extensions
- */
-export interface GraphicsRequestProps {
-    /** Uniquely identifies this request among all [[ElementGraphicsRequestProps]] for a given [[IModel]]. */
-    readonly id: string;
-    /** Log10 of the chord tolerance with which to stroke the element's geometry. e.g., for a chord tolerance of 0.01 (10^-2) meters, supply -2. */
-    readonly toleranceLog10: number;
-    /** The major version of the "iMdl" format to use when producing the iMdl representation of the element's geometry.
-     * If omitted, the most recent version known to the backend will be used.
-     * @alpha
-     */
-    readonly formatVersion?: number;
-    /** Optional flags. [[TreeFlags.UseProjectExtents]] has no effect. [[TreeFlags.EnforceDisplayPriority]] is not yet implemented. @alpha */
-    readonly treeFlags?: TreeFlags;
-    /** Optional flags. [[ContentFlags.ImprovedElision]] has no effect. @alpha */
-    readonly contentFlags?: ContentFlags;
-    /** Transform from element graphics to world coordinates. Defaults to identity. */
-    readonly location?: TransformProps;
-    /** If true, surface edges will be omitted from the graphics. */
-    readonly omitEdges?: boolean;
-    /** If omitEdges is false, specifies the type of edges to produce. Generally determined by TileAdmin.requestElementGraphics.
-     * @note This uses the deleted EdgeType enum where 1 indicates non-indexed edges and 2 indicates indexed edges, to avoid breaking the RPC API.
-     * @internal
-     */
-    readonly edgeType?: 1 | 2;
-    /** If true, and omitEdges is false, a polyface with no edge visibility info will display edges for all faces;
-     * if false, edges will be inferred from the polyface's topology.
-     * @internal
-     */
-    readonly smoothPolyfaceEdges?: boolean;
-    /** If true, the element's graphics will be clipped against the iModel's project extents. */
-    readonly clipToProjectExtents?: boolean;
-    /** If defined, the compact string representation of a [ClipVector]($core-geometry) to be applied to the geometry to produce section-cut
-     * geometry at the intersections with the clip planes. Any geometry *not* intersecting the clip planes is omitted from the tiles.
-     * @see [ClipVector.toCompactString]($core-geometry) to produce the string representation.
-     */
-    readonly sectionCut?: string;
-    /** If true, vertex positions will be quantized to [[QPoint3d]]s to conserve space; otherwise, vertex positions will use 32-bit float precision.
-     * Quantization may produce perceptible inaccuracies when producing graphics for large and/or highly-detailed elements. It is not generally recommended.
-     * Note that 32-bit precision is also susceptible to inaccuracies, to a lesser extent; see [[useAbsolutePositions]] to mitigate them.
-     * Default: false.
-     */
-    quantizePositions?: boolean;
-    /** Determines whether unquantized positions are specified in relative or absolute coordinates.
-     * Coordinates very far from the origin can produce precision errors resulting in visual artifacts. If `useAbsolutePositions` is `false`, then
-     * these precision errors are mitigated by applying a translation to the vertex positions to move them closer to the origin, and then applying the inverse
-     * translation (using 64-bit precision) when drawing the graphics.
-     * Using absolute positions is not generally recommended.
-     * Default: false.
-     * @note This property has no effect if [[quantizePositions]] is `true`.
-     */
-    useAbsolutePositions?: boolean;
-}
-/** Wire format describing a request to produce graphics in "iMdl" format for a single element.
- * @see [[ElementGraphicsRequestProps]] for more details.
- * @public
- * @extensions
- */
-export interface PersistentGraphicsRequestProps extends GraphicsRequestProps {
-    /** The element whose geometry is to be used to generate the graphics. */
-    readonly elementId: Id64String;
-}
-/** As part of a [[DynamicGraphicsRequestProps]], specifies the geometry from which to generate the graphics in JSON format.
- * @public
- * @extensions
- */
-export interface JsonGeometryStream {
-    /** Discriminator for [[DynamicGraphicsRequestProps.geometry]]. */
-    format: "json";
-    /** The geometry stream in JSON format. */
-    data: GeometryStreamProps;
-}
-/** As part of a [[DynamicGraphicsRequestProps]], specifies the geometry from which to generate the graphics in binary flatbuffer-encoded format.
- * @public
- * @extensions
- */
-export interface FlatBufferGeometryStream {
-    /** Discriminator for [[DynamicGraphicsRequestProps.geometry]]. */
-    format: "flatbuffer";
-    /** The geometry stream in flatbuffer format. */
-    data: ElementGeometryDataEntry[];
-}
-/** Wire format describing a request to produce graphics in "iMdl" format for a single geometry stream.
- * @see [[DynamicGraphicsRequest2dProps]] and [[DynamicGraphicsRequest3dProps]].
- * @see [[ElementGraphicsRequestProps]] for more details.
- * @public
- * @extensions
- */
-export interface DynamicGraphicsRequestProps extends GraphicsRequestProps {
-    /** The geometry from which to generate the graphics. */
-    readonly geometry: JsonGeometryStream | FlatBufferGeometryStream;
-    /** The category to which the geometry belongs. This is required to identify a persistent [SpatialCategory]($backend) for 3d geometry or
-     * [DrawingCategory]($backend) for 2d geometry.
-     */
-    readonly categoryId: Id64String;
-    /** If specified, tools will recognize the generated graphics as being associated with this element. */
-    readonly elementId?: Id64String;
-    /** If specified, tools will recognize the generated graphics as being associated with this model.
-     * It should identify a 3d model for 3d geometry or a 2d model for 2d geometry.
-     * It needn't identify a persistent model - it can be a transient Id.
-     */
-    readonly modelId?: Id64String;
-}
-/** Wire format describing a request to produce graphics in "iMdl" format for a 2d geometry stream.
- * @see [[ElementGraphicsRequestProps]] for more details.
- * @public
- * @extensions
- */
-export interface DynamicGraphicsRequest2dProps extends DynamicGraphicsRequestProps {
-    /** Specifies the geometry is 2d. */
-    readonly type: "2d";
-    /** The origin and rotation of the geometry. */
-    readonly placement: Omit<Placement2dProps, "bbox">;
-}
-/** Wire format describing a request to produce graphics in "iMdl" format for a 3d geometry stream.
- * @see [[ElementGraphicsRequestProps]] for more details.
- * @public
- * @extensions
- */
-export interface DynamicGraphicsRequest3dProps extends DynamicGraphicsRequestProps {
-    /** Specifies the geometry is 3d. */
-    readonly type: "3d";
-    /** The origin and rotation of the geometry. */
-    readonly placement: Omit<Placement3dProps, "bbox">;
-}
-/** Wire format describing a request to produce graphics in "iMdl" format for a single element or geometry stream.
- * @note Every request must have an `id` that is unique amongst all extant requests for a given [[IModel]].
- * @see [TileAdmin.requestElementGraphics]($frontend) and [IModelDb.generateElementGraphics]($backend) to fulfill such a request.
- * @see [readElementGraphics]($frontend) to convert the result of a request to a [RenderGraphic]($frontend) for display.
- * @public
- * @extensions
- */
-export declare type ElementGraphicsRequestProps = PersistentGraphicsRequestProps | DynamicGraphicsRequest2dProps | DynamicGraphicsRequest3dProps;
+/** @packageDocumentation
+ * @module Tile
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { TransformProps } from "@itwin/core-geometry";
+import { Placement2dProps, Placement3dProps } from "../ElementProps";
+import { ElementGeometryDataEntry } from "../geometry/ElementGeometry";
+import { GeometryStreamProps } from "../geometry/GeometryStream";
+import { ContentFlags, TreeFlags } from "../tile/TileMetadata";
+/** Wire format describing properties common to [[PersistentGraphicsRequestProps]] and [[DynamicGraphicsRequestProps]].
+ * @see [[ElementGraphicsRequestProps]] for more details.
+ * @public
+ * @extensions
+ */
+export interface GraphicsRequestProps {
+    /** Uniquely identifies this request among all [[ElementGraphicsRequestProps]] for a given [[IModel]]. */
+    readonly id: string;
+    /** Log10 of the chord tolerance with which to stroke the element's geometry. e.g., for a chord tolerance of 0.01 (10^-2) meters, supply -2. */
+    readonly toleranceLog10: number;
+    /** The major version of the "iMdl" format to use when producing the iMdl representation of the element's geometry.
+     * If omitted, the most recent version known to the backend will be used.
+     * @alpha
+     */
+    readonly formatVersion?: number;
+    /** Optional flags. [[TreeFlags.UseProjectExtents]] has no effect. [[TreeFlags.EnforceDisplayPriority]] is not yet implemented. @alpha */
+    readonly treeFlags?: TreeFlags;
+    /** Optional flags. [[ContentFlags.ImprovedElision]] has no effect. @alpha */
+    readonly contentFlags?: ContentFlags;
+    /** Transform from element graphics to world coordinates. Defaults to identity. */
+    readonly location?: TransformProps;
+    /** If true, surface edges will be omitted from the graphics. */
+    readonly omitEdges?: boolean;
+    /** If omitEdges is false, specifies the type of edges to produce. Generally determined by TileAdmin.requestElementGraphics.
+     * @note This uses the deleted EdgeType enum where 1 indicates non-indexed edges and 2 indicates indexed edges, to avoid breaking the RPC API.
+     * @internal
+     */
+    readonly edgeType?: 1 | 2;
+    /** If true, and omitEdges is false, a polyface with no edge visibility info will display edges for all faces;
+     * if false, edges will be inferred from the polyface's topology.
+     * @internal
+     */
+    readonly smoothPolyfaceEdges?: boolean;
+    /** If true, the element's graphics will be clipped against the iModel's project extents. */
+    readonly clipToProjectExtents?: boolean;
+    /** If defined, the compact string representation of a [ClipVector]($core-geometry) to be applied to the geometry to produce section-cut
+     * geometry at the intersections with the clip planes. Any geometry *not* intersecting the clip planes is omitted from the tiles.
+     * @see [ClipVector.toCompactString]($core-geometry) to produce the string representation.
+     */
+    readonly sectionCut?: string;
+    /** If true, vertex positions will be quantized to [[QPoint3d]]s to conserve space; otherwise, vertex positions will use 32-bit float precision.
+     * Quantization may produce perceptible inaccuracies when producing graphics for large and/or highly-detailed elements. It is not generally recommended.
+     * Note that 32-bit precision is also susceptible to inaccuracies, to a lesser extent; see [[useAbsolutePositions]] to mitigate them.
+     * Default: false.
+     */
+    quantizePositions?: boolean;
+    /** Determines whether unquantized positions are specified in relative or absolute coordinates.
+     * Coordinates very far from the origin can produce precision errors resulting in visual artifacts. If `useAbsolutePositions` is `false`, then
+     * these precision errors are mitigated by applying a translation to the vertex positions to move them closer to the origin, and then applying the inverse
+     * translation (using 64-bit precision) when drawing the graphics.
+     * Using absolute positions is not generally recommended.
+     * Default: false.
+     * @note This property has no effect if [[quantizePositions]] is `true`.
+     */
+    useAbsolutePositions?: boolean;
+}
+/** Wire format describing a request to produce graphics in "iMdl" format for a single element.
+ * @see [[ElementGraphicsRequestProps]] for more details.
+ * @public
+ * @extensions
+ */
+export interface PersistentGraphicsRequestProps extends GraphicsRequestProps {
+    /** The element whose geometry is to be used to generate the graphics. */
+    readonly elementId: Id64String;
+}
+/** As part of a [[DynamicGraphicsRequestProps]], specifies the geometry from which to generate the graphics in JSON format.
+ * @public
+ * @extensions
+ */
+export interface JsonGeometryStream {
+    /** Discriminator for [[DynamicGraphicsRequestProps.geometry]]. */
+    format: "json";
+    /** The geometry stream in JSON format. */
+    data: GeometryStreamProps;
+}
+/** As part of a [[DynamicGraphicsRequestProps]], specifies the geometry from which to generate the graphics in binary flatbuffer-encoded format.
+ * @public
+ * @extensions
+ */
+export interface FlatBufferGeometryStream {
+    /** Discriminator for [[DynamicGraphicsRequestProps.geometry]]. */
+    format: "flatbuffer";
+    /** The geometry stream in flatbuffer format. */
+    data: ElementGeometryDataEntry[];
+}
+/** Wire format describing a request to produce graphics in "iMdl" format for a single geometry stream.
+ * @see [[DynamicGraphicsRequest2dProps]] and [[DynamicGraphicsRequest3dProps]].
+ * @see [[ElementGraphicsRequestProps]] for more details.
+ * @public
+ * @extensions
+ */
+export interface DynamicGraphicsRequestProps extends GraphicsRequestProps {
+    /** The geometry from which to generate the graphics. */
+    readonly geometry: JsonGeometryStream | FlatBufferGeometryStream;
+    /** The category to which the geometry belongs. This is required to identify a persistent [SpatialCategory]($backend) for 3d geometry or
+     * [DrawingCategory]($backend) for 2d geometry.
+     */
+    readonly categoryId: Id64String;
+    /** If specified, tools will recognize the generated graphics as being associated with this element. */
+    readonly elementId?: Id64String;
+    /** If specified, tools will recognize the generated graphics as being associated with this model.
+     * It should identify a 3d model for 3d geometry or a 2d model for 2d geometry.
+     * It needn't identify a persistent model - it can be a transient Id.
+     */
+    readonly modelId?: Id64String;
+}
+/** Wire format describing a request to produce graphics in "iMdl" format for a 2d geometry stream.
+ * @see [[ElementGraphicsRequestProps]] for more details.
+ * @public
+ * @extensions
+ */
+export interface DynamicGraphicsRequest2dProps extends DynamicGraphicsRequestProps {
+    /** Specifies the geometry is 2d. */
+    readonly type: "2d";
+    /** The origin and rotation of the geometry. */
+    readonly placement: Omit<Placement2dProps, "bbox">;
+}
+/** Wire format describing a request to produce graphics in "iMdl" format for a 3d geometry stream.
+ * @see [[ElementGraphicsRequestProps]] for more details.
+ * @public
+ * @extensions
+ */
+export interface DynamicGraphicsRequest3dProps extends DynamicGraphicsRequestProps {
+    /** Specifies the geometry is 3d. */
+    readonly type: "3d";
+    /** The origin and rotation of the geometry. */
+    readonly placement: Omit<Placement3dProps, "bbox">;
+}
+/** Wire format describing a request to produce graphics in "iMdl" format for a single element or geometry stream.
+ * @note Every request must have an `id` that is unique amongst all extant requests for a given [[IModel]].
+ * @see [TileAdmin.requestElementGraphics]($frontend) and [IModelDb.generateElementGraphics]($backend) to fulfill such a request.
+ * @see [readElementGraphics]($frontend) to convert the result of a request to a [RenderGraphic]($frontend) for display.
+ * @public
+ * @extensions
+ */
+export declare type ElementGraphicsRequestProps = PersistentGraphicsRequestProps | DynamicGraphicsRequest2dProps | DynamicGraphicsRequest3dProps;
 //# sourceMappingURL=ElementGraphics.d.ts.map

package/lib/esm/tile/ElementGraphics.js

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Tile
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Tile
+ */
+export {};
 //# sourceMappingURL=ElementGraphics.js.map

package/lib/esm/tile/ElementGraphics.js.map

@@ -1 +1 @@
-{"version":3,"file":"ElementGraphics.js","sourceRoot":"","sources":["../../../src/tile/ElementGraphics.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 Tile\n */\n\nimport { Id64String } from \"@itwin/core-bentley\";\nimport { TransformProps } from \"@itwin/core-geometry\";\nimport { Placement2dProps, Placement3dProps } from \"../ElementProps\";\nimport { ElementGeometryDataEntry } from \"../geometry/ElementGeometry\";\nimport { GeometryStreamProps } from \"../geometry/GeometryStream\";\nimport { ContentFlags, TreeFlags } from \"../tile/TileMetadata\";\n\n/** Wire format describing properties common to [[PersistentGraphicsRequestProps]] and [[DynamicGraphicsRequestProps]].\n * @see [[ElementGraphicsRequestProps]] for more details.\n * @public\n * @extensions\n */\nexport interface GraphicsRequestProps {\n  /** Uniquely identifies this request among all [[ElementGraphicsRequestProps]] for a given [[IModel]]. */\n  readonly id: string;\n  /** Log10 of the chord tolerance with which to stroke the element's geometry. e.g., for a chord tolerance of 0.01 (10^-2) meters, supply -2. */\n  readonly toleranceLog10: number;\n  /** The major version of the \"iMdl\" format to use when producing the iMdl representation of the element's geometry.\n   * If omitted, the most recent version known to the backend will be used.\n   * @alpha\n   */\n  readonly formatVersion?: number;\n  /** Optional flags. [[TreeFlags.UseProjectExtents]] has no effect. [[TreeFlags.EnforceDisplayPriority]] is not yet implemented. @alpha */\n  readonly treeFlags?: TreeFlags;\n  /** Optional flags. [[ContentFlags.ImprovedElision]] has no effect. @alpha */\n  readonly contentFlags?: ContentFlags;\n  /** Transform from element graphics to world coordinates. Defaults to identity. */\n  readonly location?: TransformProps;\n  /** If true, surface edges will be omitted from the graphics. */\n  readonly omitEdges?: boolean;\n  /** If omitEdges is false, specifies the type of edges to produce. Generally determined by TileAdmin.requestElementGraphics.\n   * @note This uses the deleted EdgeType enum where 1 indicates non-indexed edges and 2 indicates indexed edges, to avoid breaking the RPC API.\n   * @internal\n   */\n  readonly edgeType?: 1 | 2;\n  /** If true, and omitEdges is false, a polyface with no edge visibility info will display edges for all faces;\n   * if false, edges will be inferred from the polyface's topology.\n   * @internal\n   */\n  readonly smoothPolyfaceEdges?: boolean;\n  /** If true, the element's graphics will be clipped against the iModel's project extents. */\n  readonly clipToProjectExtents?: boolean;\n  /** If defined, the compact string representation of a [ClipVector]($core-geometry) to be applied to the geometry to produce section-cut\n   * geometry at the intersections with the clip planes. Any geometry *not* intersecting the clip planes is omitted from the tiles.\n   * @see [ClipVector.toCompactString]($core-geometry) to produce the string representation.\n   */\n  readonly sectionCut?: string;\n  /** If true, vertex positions will be quantized to [[QPoint3d]]s to conserve space; otherwise, vertex positions will use 32-bit float precision.\n   * Quantization may produce perceptible inaccuracies when producing graphics for large and/or highly-detailed elements. It is not generally recommended.\n   * Note that 32-bit precision is also susceptible to inaccuracies, to a lesser extent; see [[useAbsolutePositions]] to mitigate them.\n   * Default: false.\n   */\n  quantizePositions?: boolean;\n  /** Determines whether unquantized positions are specified in relative or absolute coordinates.\n   * Coordinates very far from the origin can produce precision errors resulting in visual artifacts. If `useAbsolutePositions` is `false`, then\n   * these precision errors are mitigated by applying a translation to the vertex positions to move them closer to the origin, and then applying the inverse\n   * translation (using 64-bit precision) when drawing the graphics.\n   * Using absolute positions is not generally recommended.\n   * Default: false.\n   * @note This property has no effect if [[quantizePositions]] is `true`.\n   */\n  useAbsolutePositions?: boolean;\n}\n\n/** Wire format describing a request to produce graphics in \"iMdl\" format for a single element.\n * @see [[ElementGraphicsRequestProps]] for more details.\n * @public\n * @extensions\n */\nexport interface PersistentGraphicsRequestProps extends GraphicsRequestProps {\n  /** The element whose geometry is to be used to generate the graphics. */\n  readonly elementId: Id64String;\n}\n\n/** As part of a [[DynamicGraphicsRequestProps]], specifies the geometry from which to generate the graphics in JSON format.\n * @public\n * @extensions\n */\nexport interface JsonGeometryStream {\n  /** Discriminator for [[DynamicGraphicsRequestProps.geometry]]. */\n  format: \"json\";\n  /** The geometry stream in JSON format. */\n  data: GeometryStreamProps;\n}\n\n/** As part of a [[DynamicGraphicsRequestProps]], specifies the geometry from which to generate the graphics in binary flatbuffer-encoded format.\n * @public\n * @extensions\n */\nexport interface FlatBufferGeometryStream {\n  /** Discriminator for [[DynamicGraphicsRequestProps.geometry]]. */\n  format: \"flatbuffer\";\n  /** The geometry stream in flatbuffer format. */\n  data: ElementGeometryDataEntry[];\n}\n\n/** Wire format describing a request to produce graphics in \"iMdl\" format for a single geometry stream.\n * @see [[DynamicGraphicsRequest2dProps]] and [[DynamicGraphicsRequest3dProps]].\n * @see [[ElementGraphicsRequestProps]] for more details.\n * @public\n * @extensions\n */\nexport interface DynamicGraphicsRequestProps extends GraphicsRequestProps {\n  /** The geometry from which to generate the graphics. */\n  readonly geometry: JsonGeometryStream | FlatBufferGeometryStream;\n  /** The category to which the geometry belongs. This is required to identify a persistent [SpatialCategory]($backend) for 3d geometry or\n   * [DrawingCategory]($backend) for 2d geometry.\n   */\n  readonly categoryId: Id64String;\n  /** If specified, tools will recognize the generated graphics as being associated with this element. */\n  readonly elementId?: Id64String;\n  /** If specified, tools will recognize the generated graphics as being associated with this model.\n   * It should identify a 3d model for 3d geometry or a 2d model for 2d geometry.\n   * It needn't identify a persistent model - it can be a transient Id.\n   */\n  readonly modelId?: Id64String;\n}\n\n/** Wire format describing a request to produce graphics in \"iMdl\" format for a 2d geometry stream.\n * @see [[ElementGraphicsRequestProps]] for more details.\n * @public\n * @extensions\n */\nexport interface DynamicGraphicsRequest2dProps extends DynamicGraphicsRequestProps {\n  /** Specifies the geometry is 2d. */\n  readonly type: \"2d\";\n  /** The origin and rotation of the geometry. */\n  readonly placement: Omit<Placement2dProps, \"bbox\">;\n}\n\n/** Wire format describing a request to produce graphics in \"iMdl\" format for a 3d geometry stream.\n * @see [[ElementGraphicsRequestProps]] for more details.\n * @public\n * @extensions\n */\nexport interface DynamicGraphicsRequest3dProps extends DynamicGraphicsRequestProps {\n  /** Specifies the geometry is 3d. */\n  readonly type: \"3d\";\n  /** The origin and rotation of the geometry. */\n  readonly placement: Omit<Placement3dProps, \"bbox\">;\n}\n\n/** Wire format describing a request to produce graphics in \"iMdl\" format for a single element or geometry stream.\n * @note Every request must have an `id` that is unique amongst all extant requests for a given [[IModel]].\n * @see [TileAdmin.requestElementGraphics]($frontend) and [IModelDb.generateElementGraphics]($backend) to fulfill such a request.\n * @see [readElementGraphics]($frontend) to convert the result of a request to a [RenderGraphic]($frontend) for display.\n * @public\n * @extensions\n */\nexport type ElementGraphicsRequestProps = PersistentGraphicsRequestProps | DynamicGraphicsRequest2dProps | DynamicGraphicsRequest3dProps;\n"]}
+{"version":3,"file":"ElementGraphics.js","sourceRoot":"","sources":["../../../src/tile/ElementGraphics.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 Tile\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { TransformProps } from \"@itwin/core-geometry\";\r\nimport { Placement2dProps, Placement3dProps } from \"../ElementProps\";\r\nimport { ElementGeometryDataEntry } from \"../geometry/ElementGeometry\";\r\nimport { GeometryStreamProps } from \"../geometry/GeometryStream\";\r\nimport { ContentFlags, TreeFlags } from \"../tile/TileMetadata\";\r\n\r\n/** Wire format describing properties common to [[PersistentGraphicsRequestProps]] and [[DynamicGraphicsRequestProps]].\r\n * @see [[ElementGraphicsRequestProps]] for more details.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface GraphicsRequestProps {\r\n  /** Uniquely identifies this request among all [[ElementGraphicsRequestProps]] for a given [[IModel]]. */\r\n  readonly id: string;\r\n  /** Log10 of the chord tolerance with which to stroke the element's geometry. e.g., for a chord tolerance of 0.01 (10^-2) meters, supply -2. */\r\n  readonly toleranceLog10: number;\r\n  /** The major version of the \"iMdl\" format to use when producing the iMdl representation of the element's geometry.\r\n   * If omitted, the most recent version known to the backend will be used.\r\n   * @alpha\r\n   */\r\n  readonly formatVersion?: number;\r\n  /** Optional flags. [[TreeFlags.UseProjectExtents]] has no effect. [[TreeFlags.EnforceDisplayPriority]] is not yet implemented. @alpha */\r\n  readonly treeFlags?: TreeFlags;\r\n  /** Optional flags. [[ContentFlags.ImprovedElision]] has no effect. @alpha */\r\n  readonly contentFlags?: ContentFlags;\r\n  /** Transform from element graphics to world coordinates. Defaults to identity. */\r\n  readonly location?: TransformProps;\r\n  /** If true, surface edges will be omitted from the graphics. */\r\n  readonly omitEdges?: boolean;\r\n  /** If omitEdges is false, specifies the type of edges to produce. Generally determined by TileAdmin.requestElementGraphics.\r\n   * @note This uses the deleted EdgeType enum where 1 indicates non-indexed edges and 2 indicates indexed edges, to avoid breaking the RPC API.\r\n   * @internal\r\n   */\r\n  readonly edgeType?: 1 | 2;\r\n  /** If true, and omitEdges is false, a polyface with no edge visibility info will display edges for all faces;\r\n   * if false, edges will be inferred from the polyface's topology.\r\n   * @internal\r\n   */\r\n  readonly smoothPolyfaceEdges?: boolean;\r\n  /** If true, the element's graphics will be clipped against the iModel's project extents. */\r\n  readonly clipToProjectExtents?: boolean;\r\n  /** If defined, the compact string representation of a [ClipVector]($core-geometry) to be applied to the geometry to produce section-cut\r\n   * geometry at the intersections with the clip planes. Any geometry *not* intersecting the clip planes is omitted from the tiles.\r\n   * @see [ClipVector.toCompactString]($core-geometry) to produce the string representation.\r\n   */\r\n  readonly sectionCut?: string;\r\n  /** If true, vertex positions will be quantized to [[QPoint3d]]s to conserve space; otherwise, vertex positions will use 32-bit float precision.\r\n   * Quantization may produce perceptible inaccuracies when producing graphics for large and/or highly-detailed elements. It is not generally recommended.\r\n   * Note that 32-bit precision is also susceptible to inaccuracies, to a lesser extent; see [[useAbsolutePositions]] to mitigate them.\r\n   * Default: false.\r\n   */\r\n  quantizePositions?: boolean;\r\n  /** Determines whether unquantized positions are specified in relative or absolute coordinates.\r\n   * Coordinates very far from the origin can produce precision errors resulting in visual artifacts. If `useAbsolutePositions` is `false`, then\r\n   * these precision errors are mitigated by applying a translation to the vertex positions to move them closer to the origin, and then applying the inverse\r\n   * translation (using 64-bit precision) when drawing the graphics.\r\n   * Using absolute positions is not generally recommended.\r\n   * Default: false.\r\n   * @note This property has no effect if [[quantizePositions]] is `true`.\r\n   */\r\n  useAbsolutePositions?: boolean;\r\n}\r\n\r\n/** Wire format describing a request to produce graphics in \"iMdl\" format for a single element.\r\n * @see [[ElementGraphicsRequestProps]] for more details.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface PersistentGraphicsRequestProps extends GraphicsRequestProps {\r\n  /** The element whose geometry is to be used to generate the graphics. */\r\n  readonly elementId: Id64String;\r\n}\r\n\r\n/** As part of a [[DynamicGraphicsRequestProps]], specifies the geometry from which to generate the graphics in JSON format.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface JsonGeometryStream {\r\n  /** Discriminator for [[DynamicGraphicsRequestProps.geometry]]. */\r\n  format: \"json\";\r\n  /** The geometry stream in JSON format. */\r\n  data: GeometryStreamProps;\r\n}\r\n\r\n/** As part of a [[DynamicGraphicsRequestProps]], specifies the geometry from which to generate the graphics in binary flatbuffer-encoded format.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface FlatBufferGeometryStream {\r\n  /** Discriminator for [[DynamicGraphicsRequestProps.geometry]]. */\r\n  format: \"flatbuffer\";\r\n  /** The geometry stream in flatbuffer format. */\r\n  data: ElementGeometryDataEntry[];\r\n}\r\n\r\n/** Wire format describing a request to produce graphics in \"iMdl\" format for a single geometry stream.\r\n * @see [[DynamicGraphicsRequest2dProps]] and [[DynamicGraphicsRequest3dProps]].\r\n * @see [[ElementGraphicsRequestProps]] for more details.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface DynamicGraphicsRequestProps extends GraphicsRequestProps {\r\n  /** The geometry from which to generate the graphics. */\r\n  readonly geometry: JsonGeometryStream | FlatBufferGeometryStream;\r\n  /** The category to which the geometry belongs. This is required to identify a persistent [SpatialCategory]($backend) for 3d geometry or\r\n   * [DrawingCategory]($backend) for 2d geometry.\r\n   */\r\n  readonly categoryId: Id64String;\r\n  /** If specified, tools will recognize the generated graphics as being associated with this element. */\r\n  readonly elementId?: Id64String;\r\n  /** If specified, tools will recognize the generated graphics as being associated with this model.\r\n   * It should identify a 3d model for 3d geometry or a 2d model for 2d geometry.\r\n   * It needn't identify a persistent model - it can be a transient Id.\r\n   */\r\n  readonly modelId?: Id64String;\r\n}\r\n\r\n/** Wire format describing a request to produce graphics in \"iMdl\" format for a 2d geometry stream.\r\n * @see [[ElementGraphicsRequestProps]] for more details.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface DynamicGraphicsRequest2dProps extends DynamicGraphicsRequestProps {\r\n  /** Specifies the geometry is 2d. */\r\n  readonly type: \"2d\";\r\n  /** The origin and rotation of the geometry. */\r\n  readonly placement: Omit<Placement2dProps, \"bbox\">;\r\n}\r\n\r\n/** Wire format describing a request to produce graphics in \"iMdl\" format for a 3d geometry stream.\r\n * @see [[ElementGraphicsRequestProps]] for more details.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface DynamicGraphicsRequest3dProps extends DynamicGraphicsRequestProps {\r\n  /** Specifies the geometry is 3d. */\r\n  readonly type: \"3d\";\r\n  /** The origin and rotation of the geometry. */\r\n  readonly placement: Omit<Placement3dProps, \"bbox\">;\r\n}\r\n\r\n/** Wire format describing a request to produce graphics in \"iMdl\" format for a single element or geometry stream.\r\n * @note Every request must have an `id` that is unique amongst all extant requests for a given [[IModel]].\r\n * @see [TileAdmin.requestElementGraphics]($frontend) and [IModelDb.generateElementGraphics]($backend) to fulfill such a request.\r\n * @see [readElementGraphics]($frontend) to convert the result of a request to a [RenderGraphic]($frontend) for display.\r\n * @public\r\n * @extensions\r\n */\r\nexport type ElementGraphicsRequestProps = PersistentGraphicsRequestProps | DynamicGraphicsRequest2dProps | DynamicGraphicsRequest3dProps;\r\n"]}

package/lib/esm/tile/GltfTileIO.d.ts

@@ -1,46 +1,46 @@
-/** @packageDocumentation
- * @module Tile
- */
-import { ByteStream } from "@itwin/core-bentley";
-import { TileHeader } from "./TileIO";
-/** Known version of the [glTF format](https://www.khronos.org/gltf/).
- * @internal
- */
-export declare enum GltfVersions {
-    Version1 = 1,
-    Version2 = 2,
-    CurrentVersion = 1,
-    Gltf1SceneFormat = 0
-}
-/** @internal */
-export declare enum GltfV2ChunkTypes {
-    JSON = 1313821514,
-    Binary = 5130562
-}
-/** A chunk of a glb file.
- * @internal
- */
-export interface GltfChunk {
-    /** Offset of the first byte of the chunk's data relative to the beginning of the glb data.
-     * This excludes the 8-byte chunk header containing the length and type fields.
-     */
-    offset: number;
-    /** The number of bytes in the chunk's data. */
-    length: number;
-}
-/** Describes a glTF chunk's data along with its type.
- * @internal
- */
-export declare type TypedGltfChunk = GltfChunk & {
-    type: number;
-};
-/** @internal */
-export declare class GlbHeader extends TileHeader {
-    readonly gltfLength: number;
-    readonly jsonChunk: GltfChunk;
-    readonly binaryChunk?: GltfChunk;
-    readonly additionalChunks: TypedGltfChunk[];
-    get isValid(): boolean;
-    constructor(stream: ByteStream);
-}
+/** @packageDocumentation
+ * @module Tile
+ */
+import { ByteStream } from "@itwin/core-bentley";
+import { TileHeader } from "./TileIO";
+/** Known version of the [glTF format](https://www.khronos.org/gltf/).
+ * @internal
+ */
+export declare enum GltfVersions {
+    Version1 = 1,
+    Version2 = 2,
+    CurrentVersion = 1,
+    Gltf1SceneFormat = 0
+}
+/** @internal */
+export declare enum GltfV2ChunkTypes {
+    JSON = 1313821514,
+    Binary = 5130562
+}
+/** A chunk of a glb file.
+ * @internal
+ */
+export interface GltfChunk {
+    /** Offset of the first byte of the chunk's data relative to the beginning of the glb data.
+     * This excludes the 8-byte chunk header containing the length and type fields.
+     */
+    offset: number;
+    /** The number of bytes in the chunk's data. */
+    length: number;
+}
+/** Describes a glTF chunk's data along with its type.
+ * @internal
+ */
+export declare type TypedGltfChunk = GltfChunk & {
+    type: number;
+};
+/** @internal */
+export declare class GlbHeader extends TileHeader {
+    readonly gltfLength: number;
+    readonly jsonChunk: GltfChunk;
+    readonly binaryChunk?: GltfChunk;
+    readonly additionalChunks: TypedGltfChunk[];
+    get isValid(): boolean;
+    constructor(stream: ByteStream);
+}
 //# sourceMappingURL=GltfTileIO.d.ts.map