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

package/lib/cjs/MassProperties.js.map

@@ -1 +1 @@
-{"version":3,"file":"MassProperties.js","sourceRoot":"","sources":["../../src/MassProperties.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH;;;GAGG;AACH,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,wDAAwD;IACxD,+FAAqB,CAAA;IACrB,kEAAkE;IAClE,2FAAmB,CAAA;IACnB,mDAAmD;IACnD,+FAAqB,CAAA;AACvB,CAAC,EAPW,uBAAuB,uCAAvB,uBAAuB,QAOlC","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, CompressedId64Set, Id64Array, Id64String } from \"@itwin/core-bentley\";\nimport { XYZProps } from \"@itwin/core-geometry\";\n\n/** Specify whether to accumulate volumes, areas, or lengths for the supplied elements.\n * @public\n * @extensions\n */\nexport enum MassPropertiesOperation {\n  /** Return lengths for open paths and planar regions. */\n  AccumulateLengths = 0,\n  /** Return areas and perimeters for solid and surface geometry. */\n  AccumulateAreas = 1,\n  /** Return volumes and areas for solid geometry. */\n  AccumulateVolumes = 2,\n}\n\n/** Information required to request mass properties for elements from the front end to the back end.\n * @public\n * @extensions\n */\nexport interface MassPropertiesRequestProps {\n  operation: MassPropertiesOperation;\n  candidates?: Id64Array;\n}\n\n/** Information required to request mass properties for each element separately from the front end to the back end.\n * @public\n * @deprecated in 4.11 - will not be removed until after 2026-06-13. Use [[MassPropertiesRequestProps]].\n */\nexport interface MassPropertiesPerCandidateRequestProps {\n  operations: MassPropertiesOperation[];\n  candidates: CompressedId64Set;\n}\n\n/** Information returned from the back end to the front end holding the result of the mass properties calculation.\n * @public\n * @extensions\n */\nexport interface MassPropertiesResponseProps {\n  /** Success if requested [[MassPropertiesOperation]] could be evaluated for the specified elements */\n  status: BentleyStatus;\n  /** Volume of solids when [[MassPropertiesOperation.AccumulateVolumes]] requested */\n  volume?: number;\n  /** Surface area of solids and surfaces when [[MassPropertiesOperation.AccumulateVolumes]] or [[MassPropertiesOperation.AccumulateAreas]] requested */\n  area?: number;\n  /** Perimeter of surfaces and planar regions when [[MassPropertiesOperation.AccumulateAreas]] requested */\n  perimeter?: number;\n  /** Length of curves or perimeter of planar regions when [[MassPropertiesOperation.AccumulateAreas]] or [[MassPropertiesOperation.AccumulateLength]] requested */\n  length?: number;\n  /** Centroid of geometry */\n  centroid?: XYZProps;\n  /** Product of inertia with respect to xy plane */\n  ixy?: number;\n  /** Product of inertia with respect to xz plane */\n  ixz?: number;\n  /** Product of inertia with respect to yz plane */\n  iyz?: number;\n  /** Moments of inertia */\n  moments?: XYZProps;\n}\n\n/** Information returned from the back end to the front end holding the result of the mass properties calculation for a single candidate.\n * @public\n * @deprecated in 4.11 - will not be removed until after 2026-06-13. Use [[MassPropertiesResponseProps]].\n */\nexport interface MassPropertiesPerCandidateResponseProps extends MassPropertiesResponseProps {\n  candidate: Id64String;\n}\n"]}
+{"version":3,"file":"MassProperties.js","sourceRoot":"","sources":["../../src/MassProperties.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH;;;GAGG;AACH,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,wDAAwD;IACxD,+FAAqB,CAAA;IACrB,kEAAkE;IAClE,2FAAmB,CAAA;IACnB,mDAAmD;IACnD,+FAAqB,CAAA;AACvB,CAAC,EAPW,uBAAuB,uCAAvB,uBAAuB,QAOlC","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, CompressedId64Set, Id64Array, Id64String } from \"@itwin/core-bentley\";\r\nimport { XYZProps } from \"@itwin/core-geometry\";\r\n\r\n/** Specify whether to accumulate volumes, areas, or lengths for the supplied elements.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum MassPropertiesOperation {\r\n  /** Return lengths for open paths and planar regions. */\r\n  AccumulateLengths = 0,\r\n  /** Return areas and perimeters for solid and surface geometry. */\r\n  AccumulateAreas = 1,\r\n  /** Return volumes and areas for solid geometry. */\r\n  AccumulateVolumes = 2,\r\n}\r\n\r\n/** Information required to request mass properties for elements from the front end to the back end.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface MassPropertiesRequestProps {\r\n  operation: MassPropertiesOperation;\r\n  candidates?: Id64Array;\r\n}\r\n\r\n/** Information required to request mass properties for each element separately from the front end to the back end.\r\n * @public\r\n * @deprecated in 4.11 - will not be removed until after 2026-06-13. Use [[MassPropertiesRequestProps]].\r\n */\r\nexport interface MassPropertiesPerCandidateRequestProps {\r\n  operations: MassPropertiesOperation[];\r\n  candidates: CompressedId64Set;\r\n}\r\n\r\n/** Information returned from the back end to the front end holding the result of the mass properties calculation.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface MassPropertiesResponseProps {\r\n  /** Success if requested [[MassPropertiesOperation]] could be evaluated for the specified elements */\r\n  status: BentleyStatus;\r\n  /** Volume of solids when [[MassPropertiesOperation.AccumulateVolumes]] requested */\r\n  volume?: number;\r\n  /** Surface area of solids and surfaces when [[MassPropertiesOperation.AccumulateVolumes]] or [[MassPropertiesOperation.AccumulateAreas]] requested */\r\n  area?: number;\r\n  /** Perimeter of surfaces and planar regions when [[MassPropertiesOperation.AccumulateAreas]] requested */\r\n  perimeter?: number;\r\n  /** Length of curves or perimeter of planar regions when [[MassPropertiesOperation.AccumulateAreas]] or [[MassPropertiesOperation.AccumulateLength]] requested */\r\n  length?: number;\r\n  /** Centroid of geometry */\r\n  centroid?: XYZProps;\r\n  /** Product of inertia with respect to xy plane */\r\n  ixy?: number;\r\n  /** Product of inertia with respect to xz plane */\r\n  ixz?: number;\r\n  /** Product of inertia with respect to yz plane */\r\n  iyz?: number;\r\n  /** Moments of inertia */\r\n  moments?: XYZProps;\r\n}\r\n\r\n/** Information returned from the back end to the front end holding the result of the mass properties calculation for a single candidate.\r\n * @public\r\n * @deprecated in 4.11 - will not be removed until after 2026-06-13. Use [[MassPropertiesResponseProps]].\r\n */\r\nexport interface MassPropertiesPerCandidateResponseProps extends MassPropertiesResponseProps {\r\n  candidate: Id64String;\r\n}\r\n"]}

package/lib/cjs/MaterialProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"MaterialProps.js","sourceRoot":"","sources":["../../src/MaterialProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAqBH;;;GAGG;AACH,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,wCAAwC;IACxC,6DAAY,CAAA;IACZ,yDAAU,CAAA;IACV,mEAAe,CAAA;IACf,qDAAQ,CAAA;IACR,yDAAU,CAAA;AACZ,CAAC,EAPW,eAAe,+BAAf,eAAe,QAO1B;AA4CD;;GAEG;AACH,IAAY,cASX;AATD,WAAY,cAAc;IACxB,wBAAwB;IACxB,mDAAQ,CAAA;IACR;;OAEG;IACH,yDAAgB,CAAA;IAChB,uFAAuF;IACvF,uEAAuB,CAAA;AACzB,CAAC,EATW,cAAc,8BAAd,cAAc,QASzB","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 Rendering\n */\n\nimport { Id64String } from \"@itwin/core-bentley\";\nimport { DefinitionElementProps } from \"./ElementProps\";\nimport { TextureMapping } from \"./TextureMapping\";\n\n/** Describes a color as an array of three numbers ranging from 0 to 1 where the first entry corresponds to the color's red component,\n * the second to green, and the third to blue.\n * @see usage in [[RenderMaterialAssetProps]].\n * @public\n * @extensions\n */\nexport type RgbFactorProps = number[];\n\n/** A 2d point specified as an array of 2 numbers [x, y].\n * @see usage in [[TextureMapProps]].\n * @public\n * @extensions\n */\nexport type Point2dProps = number[];\n\n/** Describes the units in which a [[TextureMapProps]]' scale is expressed.\n * @public\n * @extensions\n */\nexport enum TextureMapUnits {\n  /** Indicates the scale has no units. */\n  Relative = 0,\n  Meters = 3,\n  Millimeters = 4,\n  Feet = 5,\n  Inches = 6,\n}\n\n/* eslint-disable @typescript-eslint/naming-convention */\n\n/** As part of a [[RenderMaterialAssetProps]], describes how to map a [[RenderTexture]]'s image to the triangles of a mesh to which the material is applied.\n * @see [[RenderMaterialAssetMapsProps]] for the supported types of texture mappings.\n * @public\n * @extensions\n */\nexport interface TextureMapProps {\n  /** Angle in degrees to rotate texture when applying; defaults to 0.0 if undefined */\n  pattern_angle?: number;\n  /** If true, flip the pattern map in U; if undefined, defaults to false */\n  pattern_u_flip?: boolean;\n  /** If true, flip the pattern map in V; if undefined, defaults to false */\n  pattern_flip?: boolean;\n  /** X, Y scale to apply to the pattern map; if undefined, defaults to {0,0}, which is almost never useful. */\n  pattern_scale?: Point2dProps;\n  /** X, Y offset to apply to the pattern map; if undefined, defaults to {0,0} */\n  pattern_offset?: Point2dProps;\n  /** Units to use when applying the scaling; if undefined, defaults to [[TextureMapUnits.Relative]] */\n  pattern_scalemode?: TextureMapUnits;\n  /** Mapping mode to use for the texture application; if undefined, defaults to [[TextureMapping.Mode.Parametric]] */\n  pattern_mapping?: TextureMapping.Mode;\n  /** Weight at which to combine diffuse image and color; if undefined, defaults to 1.0 */\n  pattern_weight?: number;\n  /** If true, override the mapping mode with constant LOD mapping for the normal map, defaults to false.\n   * @deprecated in 4.4 - will not be removed until after 2026-06-13. It never functioned properly - use [[pattern_useconstantlod]] instead.\n   */\n  pattern_useConstantLod?: boolean;\n  /** If true, override the mapping mode with constant LOD mapping for the normal map, defaults to false. */\n  pattern_useconstantlod?: boolean;\n  /** The number of times the texture is repeated if pattern_useconstantlod is true.  Increasing this will make the texture pattern appear smaller, decreasing it will make it larger. Defaults to 1.*/\n  pattern_constantlod_repetitions?: number;\n  /** An offset in world units used to shift the texture when pattern_useconstantlod is true. Defaults to (0, 0). */\n  pattern_constantlod_offset?: Point2dProps;\n  /** The minimum distance (from the eye to the surface) at which to clamp the texture size when pattern_useconstantlod is true. Defaults to 1. */\n  pattern_constantlod_mindistanceclamp?: number;\n  /** The maximum distance (from the eye to the surface) at which to clamp the texture size when pattern_useconstantlod is true. Defaults to 2^32. */\n  pattern_constantlod_maxdistanceclamp?: number;\n  /** The Id of the persistent [Texture]($backend) element defining the texture image. */\n  TextureId: Id64String;\n}\n\n/** Flags applied to a [[NormalMapProps]]. The enum values can be combined using bitwise operators.\n * @public\n */\nexport enum NormalMapFlags {\n  /** No special flags. */\n  None = 0,\n  /** Indicates that the Y component of each vector - stored in the texture's green channel - points upward along the positive Y axis and should\n   * be negated. By default it points downward.\n   */\n  GreenUp = 1 << 0,\n  /** If true, override the mapping mode with constant LOD mapping for the normal map. */\n  UseConstantLod = 1 << 1,\n}\n\n/** Describes how to apply [normal mapping](https://en.wikipedia.org/wiki/Normal_mapping) to a surface material.\n * @see [[RenderMaterialAssetMapsProps.Normal]] to define a normal map for a [[RenderMaterialAssetProps]].\n * @public\n */\nexport interface NormalMapProps extends TextureMapProps {\n  /** Flags controlling how the normal map is applied. Default: [[NormalMapFlags.None]]. */\n  NormalFlags?: NormalMapFlags;\n}\n\n/** Describes different types of textures to be applied to a surface material to alter its appearance.\n * @note While technically both [[Pattern]] and [[Normal]] can define their own mapping parameters (`pattern_angle`, `pattern_mapping`, etc), in practice\n * if both maps are present they are expected to have identical mapping parameters, with the exception of `TextureId`.\n * @see [[RenderMaterialAssetProps.Map]] to define the texture maps for a material asset.\n * @public\n */\nexport interface RenderMaterialAssetMapsProps {\n  /** Maps an image describing the diffuse color of the surface, replacing or mixing with the surface's own color. */\n  Pattern?: TextureMapProps;\n  /** Maps a [normal map](https://en.wikipedia.org/wiki/Normal_mapping) to the surface, simulating more complex surface details than are\n   * present in the surface's geometry.\n   */\n  Normal?: NormalMapProps;\n  /** Maps an image describing detailed minor height variation of the surface geometry. */\n  Bump?: TextureMapProps;\n  /** Maps an image describing the diffuse color of the surface, replacing or mixing with the surface's own color. */\n  Diffuse?: TextureMapProps;\n  /** Maps an image describing the glossiness of the surface's finish */\n  Finish?: TextureMapProps;\n  /** Maps an image describing glowing parts of the surface */\n  GlowColor?: TextureMapProps;\n  /** Maps an image describing the reflectiveness of the surface */\n  Reflect?: TextureMapProps;\n  /** Maps an image describing the specular component of the surface */\n  Specular?: TextureMapProps;\n  /** Maps an image describing the translucency of the surface, how much light comes out the back of the surface */\n  TranslucencyColor?: TextureMapProps;\n  /** Maps an image describing the transparency of the surface, how visible objects behind this object are */\n  TransparentColor?: TextureMapProps;\n  /** Maps an image describing the displacement of the surface geometry */\n  Displacement?: TextureMapProps;\n}\n\n/** Describes the graphical properties of a [RenderMaterialElement]($backend) as part of a [[RenderMaterialProps]].\n * This representation is used to persist the material properties into the [IModelDb]($backend), but is unwieldy and verbose.\n * @see [RenderMaterialElementParams]($backend) for a somewhat more ergonomic representation.\n * @public\n * @extensions\n */\nexport interface RenderMaterialAssetProps {\n  /** If true, this material has a fill/diffuse color; if undefined, defaults to false */\n  HasBaseColor?: boolean;\n  /** Surface color used for fill or diffuse illumination; if undefined, defaults to black */\n  color?: RgbFactorProps;\n  /** If true, this material has a specular color; if undefined, defaults to false */\n  HasSpecularColor?: boolean;\n  /** Surface color used for specular illumination; if undefined, defaults to black */\n  specular_color?: RgbFactorProps;\n  /** If true, this material has a specular exponent; if undefined, defaults to false */\n  HasFinish?: boolean;\n  /** Specular exponent (surface shininess); range is 0 to 128; if undefined, defaults to 13.5 */\n  finish?: number;\n  /** If true, then this material overrides the surface transparency to be the value of [[transmit]].\n   * If false, then this material overrides the surface to be fully opaque.\n   * If undefined, then this material does not override the surface transparency at all.\n   */\n  HasTransmit?: boolean;\n  /** Surface transparency; if undefined, defaults to 0.0. Has no effect unless [[HasTransmit]] is true. */\n  transmit?: number;\n  /** If true, this material has a value for diffuse reflectivity; if undefined, defaults to false */\n  HasDiffuse?: boolean;\n  /** Surface diffuse reflectivity; if undefined, defaults to 0.6 */\n  diffuse?: number;\n  /** If true, this material has a value for specular reflectivity; if undefined, defaults to false.  If false, specular value is actually set to 0.0 */\n  HasSpecular?: boolean;\n  /** Surface specular reflectivity; if undefined, defaults to 0.4 */\n  specular?: number;\n  /** If true, this material has a value for environmental reflectivity; if undefined, defaults to false */\n  HasReflect?: boolean;\n  /** Surface environmental reflectivity; stored as fraction of specular in V8 material settings; if undefined defaults to 0.0 */\n  reflect?: number;\n  /** If true, this material has a surface reflectance color; if undefined, defaults to false.  If false, reflectance color is actually set to specular color */\n  HasReflectColor?: boolean;\n  /** Surface reflectance color; if undefined, defaults to black */\n  reflect_color?: RgbFactorProps;\n  /** A scale by which to multiply the components of the normals read from [[Map.Normal]], if a normal map is defined.\n   * Default: 1.0\n   */\n  pbr_normal?: number;\n  /** An optional set of texture maps associated with this material. */\n  Map?: RenderMaterialAssetMapsProps;\n}\n\n/** Properties that define a [RenderMaterialElement]($backend).\n * @see [[RenderMaterial]] for the representation used by the display system.\n * @public\n * @extensions\n */\nexport interface RenderMaterialProps extends DefinitionElementProps {\n  /** The name of a palette that can be used to categorize multiple materials. */\n  paletteName: string;\n  /** An optional description of the material. */\n  description?: string;\n  jsonProperties?: {\n    /** A container for various \"assets\" describing aspects of the material. */\n    materialAssets?: {\n      /** Properties of the material describing how it is displayed. */\n      renderMaterial?: RenderMaterialAssetProps;\n    };\n  };\n}\n"]}
+{"version":3,"file":"MaterialProps.js","sourceRoot":"","sources":["../../src/MaterialProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAqBH;;;GAGG;AACH,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,wCAAwC;IACxC,6DAAY,CAAA;IACZ,yDAAU,CAAA;IACV,mEAAe,CAAA;IACf,qDAAQ,CAAA;IACR,yDAAU,CAAA;AACZ,CAAC,EAPW,eAAe,+BAAf,eAAe,QAO1B;AA4CD;;GAEG;AACH,IAAY,cASX;AATD,WAAY,cAAc;IACxB,wBAAwB;IACxB,mDAAQ,CAAA;IACR;;OAEG;IACH,yDAAgB,CAAA;IAChB,uFAAuF;IACvF,uEAAuB,CAAA;AACzB,CAAC,EATW,cAAc,8BAAd,cAAc,QASzB","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 Rendering\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { DefinitionElementProps } from \"./ElementProps\";\r\nimport { TextureMapping } from \"./TextureMapping\";\r\n\r\n/** Describes a color as an array of three numbers ranging from 0 to 1 where the first entry corresponds to the color's red component,\r\n * the second to green, and the third to blue.\r\n * @see usage in [[RenderMaterialAssetProps]].\r\n * @public\r\n * @extensions\r\n */\r\nexport type RgbFactorProps = number[];\r\n\r\n/** A 2d point specified as an array of 2 numbers [x, y].\r\n * @see usage in [[TextureMapProps]].\r\n * @public\r\n * @extensions\r\n */\r\nexport type Point2dProps = number[];\r\n\r\n/** Describes the units in which a [[TextureMapProps]]' scale is expressed.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum TextureMapUnits {\r\n  /** Indicates the scale has no units. */\r\n  Relative = 0,\r\n  Meters = 3,\r\n  Millimeters = 4,\r\n  Feet = 5,\r\n  Inches = 6,\r\n}\r\n\r\n/* eslint-disable @typescript-eslint/naming-convention */\r\n\r\n/** As part of a [[RenderMaterialAssetProps]], describes how to map a [[RenderTexture]]'s image to the triangles of a mesh to which the material is applied.\r\n * @see [[RenderMaterialAssetMapsProps]] for the supported types of texture mappings.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface TextureMapProps {\r\n  /** Angle in degrees to rotate texture when applying; defaults to 0.0 if undefined */\r\n  pattern_angle?: number;\r\n  /** If true, flip the pattern map in U; if undefined, defaults to false */\r\n  pattern_u_flip?: boolean;\r\n  /** If true, flip the pattern map in V; if undefined, defaults to false */\r\n  pattern_flip?: boolean;\r\n  /** X, Y scale to apply to the pattern map; if undefined, defaults to {0,0}, which is almost never useful. */\r\n  pattern_scale?: Point2dProps;\r\n  /** X, Y offset to apply to the pattern map; if undefined, defaults to {0,0} */\r\n  pattern_offset?: Point2dProps;\r\n  /** Units to use when applying the scaling; if undefined, defaults to [[TextureMapUnits.Relative]] */\r\n  pattern_scalemode?: TextureMapUnits;\r\n  /** Mapping mode to use for the texture application; if undefined, defaults to [[TextureMapping.Mode.Parametric]] */\r\n  pattern_mapping?: TextureMapping.Mode;\r\n  /** Weight at which to combine diffuse image and color; if undefined, defaults to 1.0 */\r\n  pattern_weight?: number;\r\n  /** If true, override the mapping mode with constant LOD mapping for the normal map, defaults to false.\r\n   * @deprecated in 4.4 - will not be removed until after 2026-06-13. It never functioned properly - use [[pattern_useconstantlod]] instead.\r\n   */\r\n  pattern_useConstantLod?: boolean;\r\n  /** If true, override the mapping mode with constant LOD mapping for the normal map, defaults to false. */\r\n  pattern_useconstantlod?: boolean;\r\n  /** The number of times the texture is repeated if pattern_useconstantlod is true.  Increasing this will make the texture pattern appear smaller, decreasing it will make it larger. Defaults to 1.*/\r\n  pattern_constantlod_repetitions?: number;\r\n  /** An offset in world units used to shift the texture when pattern_useconstantlod is true. Defaults to (0, 0). */\r\n  pattern_constantlod_offset?: Point2dProps;\r\n  /** The minimum distance (from the eye to the surface) at which to clamp the texture size when pattern_useconstantlod is true. Defaults to 1. */\r\n  pattern_constantlod_mindistanceclamp?: number;\r\n  /** The maximum distance (from the eye to the surface) at which to clamp the texture size when pattern_useconstantlod is true. Defaults to 2^32. */\r\n  pattern_constantlod_maxdistanceclamp?: number;\r\n  /** The Id of the persistent [Texture]($backend) element defining the texture image. */\r\n  TextureId: Id64String;\r\n}\r\n\r\n/** Flags applied to a [[NormalMapProps]]. The enum values can be combined using bitwise operators.\r\n * @public\r\n */\r\nexport enum NormalMapFlags {\r\n  /** No special flags. */\r\n  None = 0,\r\n  /** Indicates that the Y component of each vector - stored in the texture's green channel - points upward along the positive Y axis and should\r\n   * be negated. By default it points downward.\r\n   */\r\n  GreenUp = 1 << 0,\r\n  /** If true, override the mapping mode with constant LOD mapping for the normal map. */\r\n  UseConstantLod = 1 << 1,\r\n}\r\n\r\n/** Describes how to apply [normal mapping](https://en.wikipedia.org/wiki/Normal_mapping) to a surface material.\r\n * @see [[RenderMaterialAssetMapsProps.Normal]] to define a normal map for a [[RenderMaterialAssetProps]].\r\n * @public\r\n */\r\nexport interface NormalMapProps extends TextureMapProps {\r\n  /** Flags controlling how the normal map is applied. Default: [[NormalMapFlags.None]]. */\r\n  NormalFlags?: NormalMapFlags;\r\n}\r\n\r\n/** Describes different types of textures to be applied to a surface material to alter its appearance.\r\n * @note While technically both [[Pattern]] and [[Normal]] can define their own mapping parameters (`pattern_angle`, `pattern_mapping`, etc), in practice\r\n * if both maps are present they are expected to have identical mapping parameters, with the exception of `TextureId`.\r\n * @see [[RenderMaterialAssetProps.Map]] to define the texture maps for a material asset.\r\n * @public\r\n */\r\nexport interface RenderMaterialAssetMapsProps {\r\n  /** Maps an image describing the diffuse color of the surface, replacing or mixing with the surface's own color. */\r\n  Pattern?: TextureMapProps;\r\n  /** Maps a [normal map](https://en.wikipedia.org/wiki/Normal_mapping) to the surface, simulating more complex surface details than are\r\n   * present in the surface's geometry.\r\n   */\r\n  Normal?: NormalMapProps;\r\n  /** Maps an image describing detailed minor height variation of the surface geometry. */\r\n  Bump?: TextureMapProps;\r\n  /** Maps an image describing the diffuse color of the surface, replacing or mixing with the surface's own color. */\r\n  Diffuse?: TextureMapProps;\r\n  /** Maps an image describing the glossiness of the surface's finish */\r\n  Finish?: TextureMapProps;\r\n  /** Maps an image describing glowing parts of the surface */\r\n  GlowColor?: TextureMapProps;\r\n  /** Maps an image describing the reflectiveness of the surface */\r\n  Reflect?: TextureMapProps;\r\n  /** Maps an image describing the specular component of the surface */\r\n  Specular?: TextureMapProps;\r\n  /** Maps an image describing the translucency of the surface, how much light comes out the back of the surface */\r\n  TranslucencyColor?: TextureMapProps;\r\n  /** Maps an image describing the transparency of the surface, how visible objects behind this object are */\r\n  TransparentColor?: TextureMapProps;\r\n  /** Maps an image describing the displacement of the surface geometry */\r\n  Displacement?: TextureMapProps;\r\n}\r\n\r\n/** Describes the graphical properties of a [RenderMaterialElement]($backend) as part of a [[RenderMaterialProps]].\r\n * This representation is used to persist the material properties into the [IModelDb]($backend), but is unwieldy and verbose.\r\n * @see [RenderMaterialElementParams]($backend) for a somewhat more ergonomic representation.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface RenderMaterialAssetProps {\r\n  /** If true, this material has a fill/diffuse color; if undefined, defaults to false */\r\n  HasBaseColor?: boolean;\r\n  /** Surface color used for fill or diffuse illumination; if undefined, defaults to black */\r\n  color?: RgbFactorProps;\r\n  /** If true, this material has a specular color; if undefined, defaults to false */\r\n  HasSpecularColor?: boolean;\r\n  /** Surface color used for specular illumination; if undefined, defaults to black */\r\n  specular_color?: RgbFactorProps;\r\n  /** If true, this material has a specular exponent; if undefined, defaults to false */\r\n  HasFinish?: boolean;\r\n  /** Specular exponent (surface shininess); range is 0 to 128; if undefined, defaults to 13.5 */\r\n  finish?: number;\r\n  /** If true, then this material overrides the surface transparency to be the value of [[transmit]].\r\n   * If false, then this material overrides the surface to be fully opaque.\r\n   * If undefined, then this material does not override the surface transparency at all.\r\n   */\r\n  HasTransmit?: boolean;\r\n  /** Surface transparency; if undefined, defaults to 0.0. Has no effect unless [[HasTransmit]] is true. */\r\n  transmit?: number;\r\n  /** If true, this material has a value for diffuse reflectivity; if undefined, defaults to false */\r\n  HasDiffuse?: boolean;\r\n  /** Surface diffuse reflectivity; if undefined, defaults to 0.6 */\r\n  diffuse?: number;\r\n  /** If true, this material has a value for specular reflectivity; if undefined, defaults to false.  If false, specular value is actually set to 0.0 */\r\n  HasSpecular?: boolean;\r\n  /** Surface specular reflectivity; if undefined, defaults to 0.4 */\r\n  specular?: number;\r\n  /** If true, this material has a value for environmental reflectivity; if undefined, defaults to false */\r\n  HasReflect?: boolean;\r\n  /** Surface environmental reflectivity; stored as fraction of specular in V8 material settings; if undefined defaults to 0.0 */\r\n  reflect?: number;\r\n  /** If true, this material has a surface reflectance color; if undefined, defaults to false.  If false, reflectance color is actually set to specular color */\r\n  HasReflectColor?: boolean;\r\n  /** Surface reflectance color; if undefined, defaults to black */\r\n  reflect_color?: RgbFactorProps;\r\n  /** A scale by which to multiply the components of the normals read from [[Map.Normal]], if a normal map is defined.\r\n   * Default: 1.0\r\n   */\r\n  pbr_normal?: number;\r\n  /** An optional set of texture maps associated with this material. */\r\n  Map?: RenderMaterialAssetMapsProps;\r\n}\r\n\r\n/** Properties that define a [RenderMaterialElement]($backend).\r\n * @see [[RenderMaterial]] for the representation used by the display system.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface RenderMaterialProps extends DefinitionElementProps {\r\n  /** The name of a palette that can be used to categorize multiple materials. */\r\n  paletteName: string;\r\n  /** An optional description of the material. */\r\n  description?: string;\r\n  jsonProperties?: {\r\n    /** A container for various \"assets\" describing aspects of the material. */\r\n    materialAssets?: {\r\n      /** Properties of the material describing how it is displayed. */\r\n      renderMaterial?: RenderMaterialAssetProps;\r\n    };\r\n  };\r\n}\r\n"]}

package/lib/cjs/ModelClipGroup.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelClipGroup.js","sourceRoot":"","sources":["../../src/ModelClipGroup.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,wDAAmE;AAanE;;;GAGG;AACH,MAAa,cAAc;IACzB,0FAA0F;IAC1E,MAAM,CAAa;IACnC,2GAA2G;IAC3F,IAAI,CAAc;IAElC,YAAoB,MAA6B,EAAE,IAA4B;QAC7E,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,2HAA2H;IACpH,MAAM,CAAC,MAAM,CAAC,IAA4B,EAAE,MAAkB;QACnE,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,wCAAwC;IACjC,KAAK;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1D,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,oEAAoE;IAC7D,aAAa,CAAC,OAAmB;QACtC,OAAO,SAAS,KAAK,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACpE,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAA0B;QAC/C,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5D,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,0BAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtE,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC3F,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,CAAC;QACtC,IAAI,IAAI,CAAC,MAAM;YACb,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAElC,IAAI,IAAI,CAAC,IAAI;YACX,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAElC,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA7CD,wCA6CC;AAED;;;;;;;;GAQG;AACH,MAAa,eAAe;IAC1B,uDAAuD;IACvC,MAAM,CAAmB;IAEzC;;OAEG;IACH,YAAmB,SAA2B,EAAE;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,kDAAkD;IAC3C,KAAK;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QACzD,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,4EAA4E;IACrE,SAAS,CAAC,OAAmB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IACnE,CAAC;IAED,yHAAyH;IAClH,cAAc,CAAC,OAAmB;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,OAAmB;QACxC,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC;IACvC,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAwC;QAC7D,MAAM,MAAM,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QACnE,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACpD,CAAC;CACF;AA5CD,0CA4CC","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 Views\n */\n\nimport { Id64Array, Id64String } from \"@itwin/core-bentley\";\nimport { ClipVector, ClipVectorProps } from \"@itwin/core-geometry\";\n\n/** JSON representation of a [[ModelClipGroup]].\n * @public\n * @extensions\n */\nexport interface ModelClipGroupProps {\n  /** The Ids of the models in the group. */\n  models?: Id64Array;\n  /** JSON representation of the [ClipVector]($core-geometry) applied to the group. */\n  clip?: ClipVectorProps;\n}\n\n/** Describes how to clip a group of models in the context of a [ViewDefinition3d]($backend) by applying a single [ClipVector]($core-geometry] to each model in the group.\n * @see [[ModelClipGroups]] to define multiple groups of models with different clip vectors.\n * @public\n */\nexport class ModelClipGroup {\n  /** The Ids of the models to be clipped, or undefined if the group includes all models. */\n  public readonly models?: Id64Array;\n  /** The clip to apply to the group of models. `undefined` indicates the models are exempt from clipping. */\n  public readonly clip?: ClipVector;\n\n  private constructor(models: Id64Array | undefined, clip: ClipVector | undefined) {\n    this.models = models;\n    this.clip = clip;\n  }\n\n  /** Create a new ModelClipGroup. The input arguments are captured as references and should not be subsequently modified. */\n  public static create(clip: ClipVector | undefined, models?: Id64Array): ModelClipGroup {\n    return new ModelClipGroup(models, clip);\n  }\n\n  /** Create a deep copy of this group. */\n  public clone(): ModelClipGroup {\n    const models = this.models ? [...this.models] : undefined;\n    return new ModelClipGroup(models, this.clip?.clone());\n  }\n\n  /** Returns whether the specified model Id belongs to this group. */\n  public includesModel(modelId: Id64String): boolean {\n    return undefined === this.models || this.models.includes(modelId);\n  }\n\n  /** Create from JSON representation. */\n  public static fromJSON(props: ModelClipGroupProps): ModelClipGroup {\n    const models = props.models ? [...props.models] : undefined;\n    const clip = props.clip ? ClipVector.fromJSON(props.clip) : undefined;\n    return new ModelClipGroup(models, undefined !== clip && clip.isValid ? clip : undefined);\n  }\n\n  /** Convert to JSON representation. */\n  public toJSON(): ModelClipGroupProps {\n    const props: ModelClipGroupProps = {};\n    if (this.models)\n      props.models = [...this.models];\n\n    if (this.clip)\n      props.clip = this.clip.toJSON();\n\n    return props;\n  }\n}\n\n/** Describes how to clip groups of models in the context of a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).\n * Each group will be clipped by the [ClipVector]($core-geometry) associated with the group to which it belongs.\n * A model belongs to the first group in the list for which `ModelClipGroup.includesModel()` returns `true`.\n * A catch-all group can be defined by a ModelClipGroup with an `undefined` array of model Ids; any model whose Id does not appear in any group's list would belong to this group. If a catch-all group exists, it should appear last in the list.\n * A group of models can be exempted from clipping by a ModelClipGroup with an `undefined` ClipVector.\n * @note A ModelClipGroups obtained from a [[ViewDetails3d]] should **not** be modified directly. Clone it instead and modify the clone.\n * @see [[ViewDetails3d.modelClipGroups]] to define the clip groups for a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).\n * @public\n */\nexport class ModelClipGroups {\n  /** The groups of models and their associated clips. */\n  public readonly groups: ModelClipGroup[];\n\n  /** Create a new ModelClipGroups.\n   * @note The ModelClipGroup takes ownership of the input array, which should not be subsequently modified.\n   */\n  public constructor(groups: ModelClipGroup[] = []) {\n    this.groups = groups;\n  }\n\n  /** Create a deep copy of this ModelClipGroups. */\n  public clone(): ModelClipGroups {\n    const groups = this.groups.map((group) => group.clone());\n    return new ModelClipGroups(groups);\n  }\n\n  /** Find the first group to which the specified model Id belongs, if any. */\n  public findGroup(modelId: Id64String): ModelClipGroup | undefined {\n    return this.groups.find((group) => group.includesModel(modelId));\n  }\n\n  /** Returns the array index of the group to which the specified model belongs, or -1 if the model belongs to no group. */\n  public findGroupIndex(modelId: Id64String): number {\n    return this.groups.findIndex((group) => group.includesModel(modelId));\n  }\n\n  /** Find the clip that should be applied to the specified model.\n   * @note This may return `undefined` if the model belongs to no group, **or** it belongs to a group that should not be clipped.\n   */\n  public getClipForModel(modelId: Id64String): ClipVector | undefined {\n    return this.findGroup(modelId)?.clip;\n  }\n\n  /** Create from JSON representation. */\n  public static fromJSON(props: ModelClipGroupProps[] | undefined): ModelClipGroups {\n    const groups = props?.map((prop) => ModelClipGroup.fromJSON(prop));\n    return new ModelClipGroups(groups);\n  }\n\n  /** Convert to JSON representation. */\n  public toJSON(): ModelClipGroupProps[] {\n    return this.groups.map((group) => group.toJSON());\n  }\n}\n"]}
+{"version":3,"file":"ModelClipGroup.js","sourceRoot":"","sources":["../../src/ModelClipGroup.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,wDAAmE;AAanE;;;GAGG;AACH,MAAa,cAAc;IACzB,0FAA0F;IAC1E,MAAM,CAAa;IACnC,2GAA2G;IAC3F,IAAI,CAAc;IAElC,YAAoB,MAA6B,EAAE,IAA4B;QAC7E,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,2HAA2H;IACpH,MAAM,CAAC,MAAM,CAAC,IAA4B,EAAE,MAAkB;QACnE,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED,wCAAwC;IACjC,KAAK;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1D,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,oEAAoE;IAC7D,aAAa,CAAC,OAAmB;QACtC,OAAO,SAAS,KAAK,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACpE,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAA0B;QAC/C,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5D,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,0BAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtE,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC3F,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,CAAC;QACtC,IAAI,IAAI,CAAC,MAAM;YACb,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAElC,IAAI,IAAI,CAAC,IAAI;YACX,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QAElC,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA7CD,wCA6CC;AAED;;;;;;;;GAQG;AACH,MAAa,eAAe;IAC1B,uDAAuD;IACvC,MAAM,CAAmB;IAEzC;;OAEG;IACH,YAAmB,SAA2B,EAAE;QAC9C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,kDAAkD;IAC3C,KAAK;QACV,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QACzD,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,4EAA4E;IACrE,SAAS,CAAC,OAAmB;QAClC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IACnE,CAAC;IAED,yHAAyH;IAClH,cAAc,CAAC,OAAmB;QACvC,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACI,eAAe,CAAC,OAAmB;QACxC,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC;IACvC,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAwC;QAC7D,MAAM,MAAM,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QACnE,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACpD,CAAC;CACF;AA5CD,0CA4CC","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 Views\r\n */\r\n\r\nimport { Id64Array, Id64String } from \"@itwin/core-bentley\";\r\nimport { ClipVector, ClipVectorProps } from \"@itwin/core-geometry\";\r\n\r\n/** JSON representation of a [[ModelClipGroup]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelClipGroupProps {\r\n  /** The Ids of the models in the group. */\r\n  models?: Id64Array;\r\n  /** JSON representation of the [ClipVector]($core-geometry) applied to the group. */\r\n  clip?: ClipVectorProps;\r\n}\r\n\r\n/** Describes how to clip a group of models in the context of a [ViewDefinition3d]($backend) by applying a single [ClipVector]($core-geometry] to each model in the group.\r\n * @see [[ModelClipGroups]] to define multiple groups of models with different clip vectors.\r\n * @public\r\n */\r\nexport class ModelClipGroup {\r\n  /** The Ids of the models to be clipped, or undefined if the group includes all models. */\r\n  public readonly models?: Id64Array;\r\n  /** The clip to apply to the group of models. `undefined` indicates the models are exempt from clipping. */\r\n  public readonly clip?: ClipVector;\r\n\r\n  private constructor(models: Id64Array | undefined, clip: ClipVector | undefined) {\r\n    this.models = models;\r\n    this.clip = clip;\r\n  }\r\n\r\n  /** Create a new ModelClipGroup. The input arguments are captured as references and should not be subsequently modified. */\r\n  public static create(clip: ClipVector | undefined, models?: Id64Array): ModelClipGroup {\r\n    return new ModelClipGroup(models, clip);\r\n  }\r\n\r\n  /** Create a deep copy of this group. */\r\n  public clone(): ModelClipGroup {\r\n    const models = this.models ? [...this.models] : undefined;\r\n    return new ModelClipGroup(models, this.clip?.clone());\r\n  }\r\n\r\n  /** Returns whether the specified model Id belongs to this group. */\r\n  public includesModel(modelId: Id64String): boolean {\r\n    return undefined === this.models || this.models.includes(modelId);\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props: ModelClipGroupProps): ModelClipGroup {\r\n    const models = props.models ? [...props.models] : undefined;\r\n    const clip = props.clip ? ClipVector.fromJSON(props.clip) : undefined;\r\n    return new ModelClipGroup(models, undefined !== clip && clip.isValid ? clip : undefined);\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): ModelClipGroupProps {\r\n    const props: ModelClipGroupProps = {};\r\n    if (this.models)\r\n      props.models = [...this.models];\r\n\r\n    if (this.clip)\r\n      props.clip = this.clip.toJSON();\r\n\r\n    return props;\r\n  }\r\n}\r\n\r\n/** Describes how to clip groups of models in the context of a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).\r\n * Each group will be clipped by the [ClipVector]($core-geometry) associated with the group to which it belongs.\r\n * A model belongs to the first group in the list for which `ModelClipGroup.includesModel()` returns `true`.\r\n * A catch-all group can be defined by a ModelClipGroup with an `undefined` array of model Ids; any model whose Id does not appear in any group's list would belong to this group. If a catch-all group exists, it should appear last in the list.\r\n * A group of models can be exempted from clipping by a ModelClipGroup with an `undefined` ClipVector.\r\n * @note A ModelClipGroups obtained from a [[ViewDetails3d]] should **not** be modified directly. Clone it instead and modify the clone.\r\n * @see [[ViewDetails3d.modelClipGroups]] to define the clip groups for a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).\r\n * @public\r\n */\r\nexport class ModelClipGroups {\r\n  /** The groups of models and their associated clips. */\r\n  public readonly groups: ModelClipGroup[];\r\n\r\n  /** Create a new ModelClipGroups.\r\n   * @note The ModelClipGroup takes ownership of the input array, which should not be subsequently modified.\r\n   */\r\n  public constructor(groups: ModelClipGroup[] = []) {\r\n    this.groups = groups;\r\n  }\r\n\r\n  /** Create a deep copy of this ModelClipGroups. */\r\n  public clone(): ModelClipGroups {\r\n    const groups = this.groups.map((group) => group.clone());\r\n    return new ModelClipGroups(groups);\r\n  }\r\n\r\n  /** Find the first group to which the specified model Id belongs, if any. */\r\n  public findGroup(modelId: Id64String): ModelClipGroup | undefined {\r\n    return this.groups.find((group) => group.includesModel(modelId));\r\n  }\r\n\r\n  /** Returns the array index of the group to which the specified model belongs, or -1 if the model belongs to no group. */\r\n  public findGroupIndex(modelId: Id64String): number {\r\n    return this.groups.findIndex((group) => group.includesModel(modelId));\r\n  }\r\n\r\n  /** Find the clip that should be applied to the specified model.\r\n   * @note This may return `undefined` if the model belongs to no group, **or** it belongs to a group that should not be clipped.\r\n   */\r\n  public getClipForModel(modelId: Id64String): ClipVector | undefined {\r\n    return this.findGroup(modelId)?.clip;\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props: ModelClipGroupProps[] | undefined): ModelClipGroups {\r\n    const groups = props?.map((prop) => ModelClipGroup.fromJSON(prop));\r\n    return new ModelClipGroups(groups);\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): ModelClipGroupProps[] {\r\n    return this.groups.map((group) => group.toJSON());\r\n  }\r\n}\r\n"]}

package/lib/cjs/ModelGeometryChanges.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelGeometryChanges.js","sourceRoot":"","sources":["../../src/ModelGeometryChanges.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkG;AAClG,wDAA6D;AAwE7D;;GAEG;AACH,IAAiB,qBAAqB,CAiCrC;AAjCD,WAAiB,qBAAqB;IACpC,QAAQ,CAAC,CAAC,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC/F,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,GAAG,GAAG,gCAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClD,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;YACrB,IAAA,qBAAM,EAAC,SAAS,KAAK,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1C,MAAM,KAAK,GAAG,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACpD,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,SAAS,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC9F,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;IAClE,CAAC;IAED,sIAAsI;IACtI,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAuC;QAC/D,IAAI,YAAY,CAAC,QAAQ;YACvB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,QAAQ,EAAE,uBAAQ,CAAC,MAAM,CAAC,CAAC;QAEhE,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,uBAAQ,CAAC,MAAM,CAAC,CAAC;QAE/D,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,MAAM,EAAE,IAAI,gCAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC;gBAC/D,MAAM,EAAE,IAAI,EAAE,uBAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC;IAC1C,CAAC;IAVgB,8BAAQ,WAUxB,CAAA;IAED,sIAAsI;IACtI,SAAgB,QAAQ,CAAC,YAAuC;QAC9D,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,8BAAQ,WAEvB,CAAA;AACH,CAAC,EAjCgB,qBAAqB,qCAArB,qBAAqB,QAiCrC;AAiBD;;;GAGG;AACH,IAAiB,oBAAoB,CA8BpC;AA9BD,WAAiB,oBAAoB;IACnC,gHAAgH;IAChH,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAyC;QACjE,KAAK,MAAM,KAAK,IAAI,YAAY;YAC9B,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAHgB,6BAAQ,WAGxB,CAAA;IAED,gHAAgH;IAChH,SAAgB,QAAQ,CAAC,YAAyC;QAChE,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,6BAAQ,WAEvB,CAAA;IAED,oCAAoC;IACpC,SAAgB,QAAQ,CAAC,KAAgC;QACvD,OAAO;YACL,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,YAAY,EAAE,KAAK,CAAC,IAAI;YACxB,KAAK,EAAE,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;YACpC,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC;SAChD,CAAC;IACJ,CAAC;IAPe,6BAAQ,WAOvB,CAAA;IAED,kEAAkE;IAClE,SAAgB,aAAa,CAAC,OAAuC,EAAE,OAAmB;QACxF,KAAK,MAAM,MAAM,IAAI,OAAO;YAC1B,IAAI,MAAM,CAAC,EAAE,KAAK,OAAO;gBACvB,OAAO,MAAM,CAAC;QAElB,OAAO,SAAS,CAAC;IACnB,CAAC;IANe,kCAAa,gBAM5B,CAAA;AACH,CAAC,EA9BgB,oBAAoB,oCAApB,oBAAoB,QA8BpC","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 { assert, CompressedId64Set, DbOpcode, GuidString, Id64String } from \"@itwin/core-bentley\";\nimport { Range3d, Range3dProps } from \"@itwin/core-geometry\";\n\n/** Compact wire format representing geometric changes to a set of elements as part of a [[ModelGeometryChangesProps]].\n * All of the elements belong to the same model.\n * The number of [[ids]] and [[ranges]] are guaranteed to be the same.\n * @see [[ElementGeometryChange]] for a more useful representation of an individual element change.\n * @see [[ModelGeometryChanges.iterable]] to iterate over [[ElementGeometryChange]]s.\n * @public\n * @extensions\n */\nexport interface ElementIdsAndRangesProps {\n  /** The Ids of the elements, compressed and sorted in ascending order. */\n  readonly ids: CompressedId64Set;\n  /** The range of each element, indexed by the position of the corresponding element's Id in [[ids]]. */\n  readonly ranges: Range3dProps[];\n}\n\n/** Compact wire format representing geometric changes to [GeometricElement]($backend)s within a [GeometricModel]($backend).\n * A given element Id will appear in no more than one of [[inserted]], [[updated]], or [[deleted]].\n * @see [[ModelGeometryChanges]] for a more useful representation.\n * @public\n * @extensions\n */\nexport interface ModelGeometryChangesProps {\n  /** The Id of the model. */\n  readonly id: Id64String;\n  /** The range of the model, computed as the union of the ranges of all geometric elements within the model. */\n  readonly range: Range3dProps;\n  /** The geometry GUID of the model. */\n  readonly guid: GuidString;\n  /** If defined, the Ids and ranges of newly-inserted [GeometricElement]($backend)s. */\n  readonly inserted?: ElementIdsAndRangesProps;\n  /** If defined, the Ids and ranges of [GeometricElement]($backend)s whose geometric properties were modified. */\n  readonly updated?: ElementIdsAndRangesProps;\n  /** If defined, the Ids of deleted [GeometricElement]($backend)s. */\n  readonly deleted?: CompressedId64Set;\n}\n\n/** Represents the insertion of a new [GeometricElement]($backend), or a change to the geometric properties of an existing [GeometricElement]($backend).\n * @see [[ElementGeometryChange]].\n * @public\n * @extensions\n */\nexport interface ExtantElementGeometryChange {\n  /** Indicates whether this change resulted from the insertion of a new element or modification of an existing one.\n   * Used as discriminant for [[ElementGeometryChange]] union.\n   */\n  readonly type: DbOpcode.Insert | DbOpcode.Update;\n  /** The element's Id. */\n  readonly id: Id64String;\n  /** The element's range. */\n  readonly range: Range3d;\n}\n\n/** Represents the deletion of a [GeometricElement]($backend).\n * @see [[ElementGeometryChange]].\n * @public\n * @extensions\n */\nexport interface DeletedElementGeometryChange {\n  /** Discriminant for [[ElementGeometryChange]] union. */\n  readonly type: DbOpcode.Delete;\n  /** The element's Id. */\n  readonly id: Id64String;\n}\n\n/**\n * @public\n * @extensions\n */\nexport type ElementGeometryChange = ExtantElementGeometryChange | DeletedElementGeometryChange;\n\n/** Represents a change to the geometry of a [GeometricElement]($backend), as exposed by [[ModelGeometryChanges.elements]].\n * @public\n */\nexport namespace ElementGeometryChange { // eslint-disable-line @typescript-eslint/no-redeclare\n  function* extantIterator(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterator<ElementGeometryChange> {\n    let index = 0;\n    const ids = CompressedId64Set.iterable(props.ids);\n    for (const id of ids) {\n      assert(undefined !== props.ranges[index]);\n      const range = Range3d.fromJSON(props.ranges[index]);\n      index++;\n      yield { type, id, range };\n    }\n  }\n\n  function extantIterable(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterable<ElementGeometryChange> {\n    return { [Symbol.iterator]: () => extantIterator(props, type) };\n  }\n\n  /** Obtain an iterator over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\n  export function* iterator(modelChanges: ModelGeometryChangesProps): Iterator<ElementGeometryChange> {\n    if (modelChanges.inserted)\n      yield* extantIterable(modelChanges.inserted, DbOpcode.Insert);\n\n    if (modelChanges.updated)\n      yield* extantIterable(modelChanges.updated, DbOpcode.Update);\n\n    if (modelChanges.deleted)\n      for (const id of CompressedId64Set.iterable(modelChanges.deleted))\n        yield { type: DbOpcode.Delete, id };\n  }\n\n  /** Obtain an iterable over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\n  export function iterable(modelChanges: ModelGeometryChangesProps): Iterable<ElementGeometryChange> {\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\n  }\n}\n\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\n * @public\n * @extensions\n */\nexport interface ModelGeometryChanges {\n  /** The model's Id. */\n  readonly id: Id64String;\n  /** The model's geometry GUID. */\n  readonly geometryGuid: GuidString;\n  /** The model's range. */\n  readonly range: Range3d;\n  /** The individual geometric element changes. */\n  readonly elements: Iterable<ElementGeometryChange>;\n}\n\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\n * @see [GraphicalEditingScope]($frontend) to monitor these changes.\n * @public\n */\nexport namespace ModelGeometryChanges {\n  /** Obtain an iterator over the geometry changes for a set of models. A given model will appear at most once. */\n  export function* iterator(modelChanges: ModelGeometryChangesProps[]): Iterator<ModelGeometryChanges> {\n    for (const props of modelChanges)\n      yield fromJSON(props);\n  }\n\n  /** Obtain an iterable over the geometry changes for a set of models. A given model will appear at most once. */\n  export function iterable(modelChanges: ModelGeometryChangesProps[]): Iterable<ModelGeometryChanges> {\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\n  }\n\n  /** Instantiate from wire format. */\n  export function fromJSON(props: ModelGeometryChangesProps): ModelGeometryChanges {\n    return {\n      id: props.id,\n      geometryGuid: props.guid,\n      range: Range3d.fromJSON(props.range),\n      elements: ElementGeometryChange.iterable(props),\n    };\n  }\n\n  /** Obtain the ModelGeometryChanges for the specified model Id. */\n  export function findByModelId(changes: Iterable<ModelGeometryChanges>, modelId: Id64String): ModelGeometryChanges | undefined {\n    for (const change of changes)\n      if (change.id === modelId)\n        return change;\n\n    return undefined;\n  }\n}\n"]}
+{"version":3,"file":"ModelGeometryChanges.js","sourceRoot":"","sources":["../../src/ModelGeometryChanges.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAkG;AAClG,wDAA6D;AAwE7D;;GAEG;AACH,IAAiB,qBAAqB,CAiCrC;AAjCD,WAAiB,qBAAqB;IACpC,QAAQ,CAAC,CAAC,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC/F,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,GAAG,GAAG,gCAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClD,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;YACrB,IAAA,qBAAM,EAAC,SAAS,KAAK,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1C,MAAM,KAAK,GAAG,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACpD,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,SAAS,cAAc,CAAC,KAA+B,EAAE,IAAuC;QAC9F,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;IAClE,CAAC;IAED,sIAAsI;IACtI,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAuC;QAC/D,IAAI,YAAY,CAAC,QAAQ;YACvB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,QAAQ,EAAE,uBAAQ,CAAC,MAAM,CAAC,CAAC;QAEhE,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,OAAO,EAAE,uBAAQ,CAAC,MAAM,CAAC,CAAC;QAE/D,IAAI,YAAY,CAAC,OAAO;YACtB,KAAK,MAAM,EAAE,IAAI,gCAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC;gBAC/D,MAAM,EAAE,IAAI,EAAE,uBAAQ,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC;IAC1C,CAAC;IAVgB,8BAAQ,WAUxB,CAAA;IAED,sIAAsI;IACtI,SAAgB,QAAQ,CAAC,YAAuC;QAC9D,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,8BAAQ,WAEvB,CAAA;AACH,CAAC,EAjCgB,qBAAqB,qCAArB,qBAAqB,QAiCrC;AAiBD;;;GAGG;AACH,IAAiB,oBAAoB,CA8BpC;AA9BD,WAAiB,oBAAoB;IACnC,gHAAgH;IAChH,QAAe,CAAC,CAAC,QAAQ,CAAC,YAAyC;QACjE,KAAK,MAAM,KAAK,IAAI,YAAY;YAC9B,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAHgB,6BAAQ,WAGxB,CAAA;IAED,gHAAgH;IAChH,SAAgB,QAAQ,CAAC,YAAyC;QAChE,OAAO,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;IAC7D,CAAC;IAFe,6BAAQ,WAEvB,CAAA;IAED,oCAAoC;IACpC,SAAgB,QAAQ,CAAC,KAAgC;QACvD,OAAO;YACL,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,YAAY,EAAE,KAAK,CAAC,IAAI;YACxB,KAAK,EAAE,uBAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;YACpC,QAAQ,EAAE,qBAAqB,CAAC,QAAQ,CAAC,KAAK,CAAC;SAChD,CAAC;IACJ,CAAC;IAPe,6BAAQ,WAOvB,CAAA;IAED,kEAAkE;IAClE,SAAgB,aAAa,CAAC,OAAuC,EAAE,OAAmB;QACxF,KAAK,MAAM,MAAM,IAAI,OAAO;YAC1B,IAAI,MAAM,CAAC,EAAE,KAAK,OAAO;gBACvB,OAAO,MAAM,CAAC;QAElB,OAAO,SAAS,CAAC;IACnB,CAAC;IANe,kCAAa,gBAM5B,CAAA;AACH,CAAC,EA9BgB,oBAAoB,oCAApB,oBAAoB,QA8BpC","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 { assert, CompressedId64Set, DbOpcode, GuidString, Id64String } from \"@itwin/core-bentley\";\r\nimport { Range3d, Range3dProps } from \"@itwin/core-geometry\";\r\n\r\n/** Compact wire format representing geometric changes to a set of elements as part of a [[ModelGeometryChangesProps]].\r\n * All of the elements belong to the same model.\r\n * The number of [[ids]] and [[ranges]] are guaranteed to be the same.\r\n * @see [[ElementGeometryChange]] for a more useful representation of an individual element change.\r\n * @see [[ModelGeometryChanges.iterable]] to iterate over [[ElementGeometryChange]]s.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ElementIdsAndRangesProps {\r\n  /** The Ids of the elements, compressed and sorted in ascending order. */\r\n  readonly ids: CompressedId64Set;\r\n  /** The range of each element, indexed by the position of the corresponding element's Id in [[ids]]. */\r\n  readonly ranges: Range3dProps[];\r\n}\r\n\r\n/** Compact wire format representing geometric changes to [GeometricElement]($backend)s within a [GeometricModel]($backend).\r\n * A given element Id will appear in no more than one of [[inserted]], [[updated]], or [[deleted]].\r\n * @see [[ModelGeometryChanges]] for a more useful representation.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelGeometryChangesProps {\r\n  /** The Id of the model. */\r\n  readonly id: Id64String;\r\n  /** The range of the model, computed as the union of the ranges of all geometric elements within the model. */\r\n  readonly range: Range3dProps;\r\n  /** The geometry GUID of the model. */\r\n  readonly guid: GuidString;\r\n  /** If defined, the Ids and ranges of newly-inserted [GeometricElement]($backend)s. */\r\n  readonly inserted?: ElementIdsAndRangesProps;\r\n  /** If defined, the Ids and ranges of [GeometricElement]($backend)s whose geometric properties were modified. */\r\n  readonly updated?: ElementIdsAndRangesProps;\r\n  /** If defined, the Ids of deleted [GeometricElement]($backend)s. */\r\n  readonly deleted?: CompressedId64Set;\r\n}\r\n\r\n/** Represents the insertion of a new [GeometricElement]($backend), or a change to the geometric properties of an existing [GeometricElement]($backend).\r\n * @see [[ElementGeometryChange]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ExtantElementGeometryChange {\r\n  /** Indicates whether this change resulted from the insertion of a new element or modification of an existing one.\r\n   * Used as discriminant for [[ElementGeometryChange]] union.\r\n   */\r\n  readonly type: DbOpcode.Insert | DbOpcode.Update;\r\n  /** The element's Id. */\r\n  readonly id: Id64String;\r\n  /** The element's range. */\r\n  readonly range: Range3d;\r\n}\r\n\r\n/** Represents the deletion of a [GeometricElement]($backend).\r\n * @see [[ElementGeometryChange]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface DeletedElementGeometryChange {\r\n  /** Discriminant for [[ElementGeometryChange]] union. */\r\n  readonly type: DbOpcode.Delete;\r\n  /** The element's Id. */\r\n  readonly id: Id64String;\r\n}\r\n\r\n/**\r\n * @public\r\n * @extensions\r\n */\r\nexport type ElementGeometryChange = ExtantElementGeometryChange | DeletedElementGeometryChange;\r\n\r\n/** Represents a change to the geometry of a [GeometricElement]($backend), as exposed by [[ModelGeometryChanges.elements]].\r\n * @public\r\n */\r\nexport namespace ElementGeometryChange { // eslint-disable-line @typescript-eslint/no-redeclare\r\n  function* extantIterator(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterator<ElementGeometryChange> {\r\n    let index = 0;\r\n    const ids = CompressedId64Set.iterable(props.ids);\r\n    for (const id of ids) {\r\n      assert(undefined !== props.ranges[index]);\r\n      const range = Range3d.fromJSON(props.ranges[index]);\r\n      index++;\r\n      yield { type, id, range };\r\n    }\r\n  }\r\n\r\n  function extantIterable(props: ElementIdsAndRangesProps, type: DbOpcode.Insert | DbOpcode.Update): Iterable<ElementGeometryChange> {\r\n    return { [Symbol.iterator]: () => extantIterator(props, type) };\r\n  }\r\n\r\n  /** Obtain an iterator over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\r\n  export function* iterator(modelChanges: ModelGeometryChangesProps): Iterator<ElementGeometryChange> {\r\n    if (modelChanges.inserted)\r\n      yield* extantIterable(modelChanges.inserted, DbOpcode.Insert);\r\n\r\n    if (modelChanges.updated)\r\n      yield* extantIterable(modelChanges.updated, DbOpcode.Update);\r\n\r\n    if (modelChanges.deleted)\r\n      for (const id of CompressedId64Set.iterable(modelChanges.deleted))\r\n        yield { type: DbOpcode.Delete, id };\r\n  }\r\n\r\n  /** Obtain an iterable over the geometry changes for a single [GeometricModel]($backend). A given element will appear at most once. */\r\n  export function iterable(modelChanges: ModelGeometryChangesProps): Iterable<ElementGeometryChange> {\r\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\r\n  }\r\n}\r\n\r\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelGeometryChanges {\r\n  /** The model's Id. */\r\n  readonly id: Id64String;\r\n  /** The model's geometry GUID. */\r\n  readonly geometryGuid: GuidString;\r\n  /** The model's range. */\r\n  readonly range: Range3d;\r\n  /** The individual geometric element changes. */\r\n  readonly elements: Iterable<ElementGeometryChange>;\r\n}\r\n\r\n/** Represents geometric changes to a set of [GeometricElement]($backend)s belonging to a single [GeometricModel]($backend).\r\n * @see [GraphicalEditingScope]($frontend) to monitor these changes.\r\n * @public\r\n */\r\nexport namespace ModelGeometryChanges {\r\n  /** Obtain an iterator over the geometry changes for a set of models. A given model will appear at most once. */\r\n  export function* iterator(modelChanges: ModelGeometryChangesProps[]): Iterator<ModelGeometryChanges> {\r\n    for (const props of modelChanges)\r\n      yield fromJSON(props);\r\n  }\r\n\r\n  /** Obtain an iterable over the geometry changes for a set of models. A given model will appear at most once. */\r\n  export function iterable(modelChanges: ModelGeometryChangesProps[]): Iterable<ModelGeometryChanges> {\r\n    return { [Symbol.iterator]: () => iterator(modelChanges) };\r\n  }\r\n\r\n  /** Instantiate from wire format. */\r\n  export function fromJSON(props: ModelGeometryChangesProps): ModelGeometryChanges {\r\n    return {\r\n      id: props.id,\r\n      geometryGuid: props.guid,\r\n      range: Range3d.fromJSON(props.range),\r\n      elements: ElementGeometryChange.iterable(props),\r\n    };\r\n  }\r\n\r\n  /** Obtain the ModelGeometryChanges for the specified model Id. */\r\n  export function findByModelId(changes: Iterable<ModelGeometryChanges>, modelId: Id64String): ModelGeometryChanges | undefined {\r\n    for (const change of changes)\r\n      if (change.id === modelId)\r\n        return change;\r\n\r\n    return undefined;\r\n  }\r\n}\r\n"]}

package/lib/cjs/ModelProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModelProps.js","sourceRoot":"","sources":["../../src/ModelProps.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 Entities\n */\n\nimport { GuidString, Id64String } from \"@itwin/core-bentley\";\nimport { XYProps } from \"@itwin/core-geometry\";\nimport { CodeProps } from \"./Code\";\nimport { RelatedElementProps } from \"./ElementProps\";\nimport { EntityProps, EntityQueryParams } from \"./EntityProps\";\n\n/** Properties that define a [Model]($docs/bis/guide/fundamentals/model-fundamentals)\n * @public\n * @extensions\n */\nexport interface ModelProps extends EntityProps {\n  modeledElement: RelatedElementProps;\n  name?: string;\n  /** @note must always match the model of the [[ModelProps.modeledElement]] */\n  parentModel?: Id64String;\n  isPrivate?: boolean;\n  isTemplate?: boolean;\n  jsonProperties?: any;\n}\n\n/** Properties that specify what model should be loaded.\n * @public\n * @extensions\n */\nexport interface ModelLoadProps {\n  id?: Id64String;\n  code?: CodeProps;\n}\n\n/** Parameters for performing a query on [Model]($backend) classes.\n * @public\n * @extensions\n */\nexport interface ModelQueryParams extends EntityQueryParams {\n  wantTemplate?: boolean;\n  wantPrivate?: boolean;\n}\n\n/** Properties that describe a [GeometricModel]($backend)\n * @public\n * @extensions\n */\nexport interface GeometricModelProps extends ModelProps {\n  /** A unique identifier that is updated each time a change affecting the appearance of a geometric element within this model\n   * is committed to the iModel. In other words, between versions of the iModel, if this value is the same you can\n   * assume the appearance of all of the geometry in the model is the same (Note: other properties of elements may have changed.)\n   * If undefined, the state of the geometry is unknown.\n   */\n  geometryGuid?: GuidString;\n}\n\n/** Properties that define a [GeometricModel2d]($backend)\n * @public\n * @extensions\n */\nexport interface GeometricModel2dProps extends GeometricModelProps {\n  /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */\n  globalOrigin?: XYProps;\n}\n\n/** Properties that define a [GeometricModel3d]($backend)\n * @public\n * @extensions\n */\nexport interface GeometricModel3dProps extends GeometricModelProps {\n  /** If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index. */\n  isNotSpatiallyLocated?: boolean;\n  /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane. */\n  isPlanProjection?: boolean;\n}\n"]}
+{"version":3,"file":"ModelProps.js","sourceRoot":"","sources":["../../src/ModelProps.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 Entities\r\n */\r\n\r\nimport { GuidString, Id64String } from \"@itwin/core-bentley\";\r\nimport { XYProps } from \"@itwin/core-geometry\";\r\nimport { CodeProps } from \"./Code\";\r\nimport { RelatedElementProps } from \"./ElementProps\";\r\nimport { EntityProps, EntityQueryParams } from \"./EntityProps\";\r\n\r\n/** Properties that define a [Model]($docs/bis/guide/fundamentals/model-fundamentals)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelProps extends EntityProps {\r\n  modeledElement: RelatedElementProps;\r\n  name?: string;\r\n  /** @note must always match the model of the [[ModelProps.modeledElement]] */\r\n  parentModel?: Id64String;\r\n  isPrivate?: boolean;\r\n  isTemplate?: boolean;\r\n  jsonProperties?: any;\r\n}\r\n\r\n/** Properties that specify what model should be loaded.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelLoadProps {\r\n  id?: Id64String;\r\n  code?: CodeProps;\r\n}\r\n\r\n/** Parameters for performing a query on [Model]($backend) classes.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelQueryParams extends EntityQueryParams {\r\n  wantTemplate?: boolean;\r\n  wantPrivate?: boolean;\r\n}\r\n\r\n/** Properties that describe a [GeometricModel]($backend)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface GeometricModelProps extends ModelProps {\r\n  /** A unique identifier that is updated each time a change affecting the appearance of a geometric element within this model\r\n   * is committed to the iModel. In other words, between versions of the iModel, if this value is the same you can\r\n   * assume the appearance of all of the geometry in the model is the same (Note: other properties of elements may have changed.)\r\n   * If undefined, the state of the geometry is unknown.\r\n   */\r\n  geometryGuid?: GuidString;\r\n}\r\n\r\n/** Properties that define a [GeometricModel2d]($backend)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface GeometricModel2dProps extends GeometricModelProps {\r\n  /** The actual coordinates of (0,0) in modeling coordinates. An offset applied to all modeling coordinates. */\r\n  globalOrigin?: XYProps;\r\n}\r\n\r\n/** Properties that define a [GeometricModel3d]($backend)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface GeometricModel3dProps extends GeometricModelProps {\r\n  /** If true, then the elements in this GeometricModel3d are not in real-world coordinates and will not be in the spatial index. */\r\n  isNotSpatiallyLocated?: boolean;\r\n  /** If true, then the elements in this GeometricModel3d are expected to be in an XY plane. */\r\n  isPlanProjection?: boolean;\r\n}\r\n"]}

package/lib/cjs/NativeAppProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"NativeAppProps.js","sourceRoot":"","sources":["../../src/NativeAppProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH,gBAAgB;AACH,QAAA,mBAAmB,GAAG;IACjC,WAAW,EAAE,wBAAwB;IACrC,aAAa,EAAE,+BAA+B;CACtC,CAAC;AAQX;;GAEG;AACH,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IACpC,+EAAM,CAAA;IACN,iFAAO,CAAA;AACT,CAAC,EAHW,0BAA0B,0CAA1B,0BAA0B,QAGrC;AAED;;GAEG;AACH,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,qDAAO,CAAA;IACP,+CAAI,CAAA;AACN,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB","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 NativeApp\n */\n\nimport { AccessToken, GuidString } from \"@itwin/core-bentley\";\nimport { BriefcaseProps, LocalBriefcaseProps, RequestNewBriefcaseProps } from \"./BriefcaseTypes\";\n\n/** @internal */\nexport const nativeAppIpcStrings = {\n  channelName: \"itwinjs-core/nativeApp\",\n  notifyChannel: \"itwinjs-core/nativeApp-notify\",\n} as const;\n\n/**\n * Type of value for storage values\n * @beta\n */\nexport type StorageValue = string | number | boolean | undefined | Uint8Array;\n\n/** Indicates whether or not the computer is currently connected to the internet.\n * @beta\n */\nexport enum InternetConnectivityStatus {\n  Online,\n  Offline,\n}\n\n/** Describes whether the user or the browser overrode the internet connectivity status.\n * @beta\n */\nexport enum OverriddenBy {\n  Browser,\n  User,\n}\n\n/**\n * Interface implemented by the frontend [NotificationHandler]($common) to be notified of events from NativeApp backend.\n * @internal\n */\nexport interface NativeAppNotifications {\n  notifyInternetConnectivityChanged(status: InternetConnectivityStatus): void;\n}\n\n/**\n * The methods that may be invoked via Ipc from the frontend of a Native App and are implemented on its backend.\n * @internal\n */\nexport interface NativeAppFunctions {\n\n  /** If the user is signed in a valid access token will be returned. */\n  getAccessToken: () => Promise<AccessToken | undefined>;\n\n  /** Check if the internet is reachable. */\n  checkInternetConnectivity(): Promise<InternetConnectivityStatus>;\n\n  /** Manually override internet reachability for testing purposes.\n   * @param _status New status to set on backend.\n   */\n  overrideInternetConnectivity(_overriddenBy: OverriddenBy, _status: InternetConnectivityStatus): Promise<void>;\n\n  /** Acquire a new BriefcaseId for the supplied iModelId from iModelHub */\n  acquireNewBriefcaseId(_iModelId: GuidString): Promise<number>;\n\n  /** Get the filename in the briefcase cache for the supplied BriefcaseId and iModelId.\n   * @note this merely returns the full path fileName. It does not test for the existence of the file.\n    */\n  getBriefcaseFileName(_props: BriefcaseProps): Promise<string>;\n\n  /** Download a briefcase file for the supplied briefcase properties. */\n  downloadBriefcase(_requestProps: RequestNewBriefcaseProps, _reportProgress: boolean, _interval?: number): Promise<LocalBriefcaseProps>;\n\n  /**\n   * Cancels the previously requested download of a briefcase\n   * @param _key Key to locate the briefcase in the disk cache\n   * @note returns true if the cancel request was acknowledged. false otherwise\n   */\n  requestCancelDownloadBriefcase(_fileName: string): Promise<boolean>;\n\n  /**\n   * Delete a previously downloaded briefcase. The briefcase must be closed.\n   * @param _fileName the Briefcase to delete\n   */\n  deleteBriefcaseFiles(_fileName: string): Promise<void>;\n\n  /**\n   * Gets a list of all briefcases that were previously downloaded to the system briefcase cache.\n   * @note returns array of LocalBriefcaseProps.\n   */\n  getCachedBriefcases(_iModelId?: GuidString): Promise<LocalBriefcaseProps[]>;\n\n  /**\n   * Open a key/value pair base storage\n   * @param _storageId string identifier of storage\n   */\n  storageMgrOpen(_storageId: string): Promise<string>;\n\n  /**\n   * Close a key/value pair base storage\n   * @param _storageId string identifier of storage\n   * @param _deleteOnClose delete the storage on close\n   */\n  storageMgrClose(_storageId: string, _deleteOnClose: boolean): Promise<void>;\n\n  /**\n   * Get the names of available storages\n   * @note returns list of storage names\n   */\n  storageMgrNames(): Promise<string[]>;\n\n  /**\n   * Get the value associated with a key.\n   * @param _storageId string identifier of storage\n   * @param _key key identifier for value\n   * @note returns key value or undefined\n   */\n  storageGet(_storageId: string, _key: string): Promise<StorageValue | undefined>;\n\n  /**\n   * Set a value for a key.\n   * @param _storageId string identifier of storage\n   * @param _key key identifier for value\n   * @param _value value to be set\n   */\n  storageSet(_storageId: string, _key: string, _value: StorageValue): Promise<void>;\n\n  /**\n   * Remove a key/value pair.\n   * @param _storageId string identifier of storage\n   * @param _key key identifier for value\n   */\n  storageRemove(_storageId: string, _key: string): Promise<void>;\n\n  /**\n   * Get list of keys in a storage.\n   * @param _storageId string identifier of storage\n   * @note returns list of storage ids\n   */\n  storageKeys(_storageId: string): Promise<string[]>;\n\n  /**\n   * Delete all key/value pairs.\n   * @param _storageId string identifier of storage\n   */\n  storageRemoveAll(_storageId: string): Promise<void>;\n\n  /** get the type of a value for a key, or undefined if not present. */\n  storageGetValueType(_storageId: string, _key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined>;\n}\n"]}
+{"version":3,"file":"NativeAppProps.js","sourceRoot":"","sources":["../../src/NativeAppProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH,gBAAgB;AACH,QAAA,mBAAmB,GAAG;IACjC,WAAW,EAAE,wBAAwB;IACrC,aAAa,EAAE,+BAA+B;CACtC,CAAC;AAQX;;GAEG;AACH,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IACpC,+EAAM,CAAA;IACN,iFAAO,CAAA;AACT,CAAC,EAHW,0BAA0B,0CAA1B,0BAA0B,QAGrC;AAED;;GAEG;AACH,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,qDAAO,CAAA;IACP,+CAAI,CAAA;AACN,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB","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 NativeApp\r\n */\r\n\r\nimport { AccessToken, GuidString } from \"@itwin/core-bentley\";\r\nimport { BriefcaseProps, LocalBriefcaseProps, RequestNewBriefcaseProps } from \"./BriefcaseTypes\";\r\n\r\n/** @internal */\r\nexport const nativeAppIpcStrings = {\r\n  channelName: \"itwinjs-core/nativeApp\",\r\n  notifyChannel: \"itwinjs-core/nativeApp-notify\",\r\n} as const;\r\n\r\n/**\r\n * Type of value for storage values\r\n * @beta\r\n */\r\nexport type StorageValue = string | number | boolean | undefined | Uint8Array;\r\n\r\n/** Indicates whether or not the computer is currently connected to the internet.\r\n * @beta\r\n */\r\nexport enum InternetConnectivityStatus {\r\n  Online,\r\n  Offline,\r\n}\r\n\r\n/** Describes whether the user or the browser overrode the internet connectivity status.\r\n * @beta\r\n */\r\nexport enum OverriddenBy {\r\n  Browser,\r\n  User,\r\n}\r\n\r\n/**\r\n * Interface implemented by the frontend [NotificationHandler]($common) to be notified of events from NativeApp backend.\r\n * @internal\r\n */\r\nexport interface NativeAppNotifications {\r\n  notifyInternetConnectivityChanged(status: InternetConnectivityStatus): void;\r\n}\r\n\r\n/**\r\n * The methods that may be invoked via Ipc from the frontend of a Native App and are implemented on its backend.\r\n * @internal\r\n */\r\nexport interface NativeAppFunctions {\r\n\r\n  /** If the user is signed in a valid access token will be returned. */\r\n  getAccessToken: () => Promise<AccessToken | undefined>;\r\n\r\n  /** Check if the internet is reachable. */\r\n  checkInternetConnectivity(): Promise<InternetConnectivityStatus>;\r\n\r\n  /** Manually override internet reachability for testing purposes.\r\n   * @param _status New status to set on backend.\r\n   */\r\n  overrideInternetConnectivity(_overriddenBy: OverriddenBy, _status: InternetConnectivityStatus): Promise<void>;\r\n\r\n  /** Acquire a new BriefcaseId for the supplied iModelId from iModelHub */\r\n  acquireNewBriefcaseId(_iModelId: GuidString): Promise<number>;\r\n\r\n  /** Get the filename in the briefcase cache for the supplied BriefcaseId and iModelId.\r\n   * @note this merely returns the full path fileName. It does not test for the existence of the file.\r\n    */\r\n  getBriefcaseFileName(_props: BriefcaseProps): Promise<string>;\r\n\r\n  /** Download a briefcase file for the supplied briefcase properties. */\r\n  downloadBriefcase(_requestProps: RequestNewBriefcaseProps, _reportProgress: boolean, _interval?: number): Promise<LocalBriefcaseProps>;\r\n\r\n  /**\r\n   * Cancels the previously requested download of a briefcase\r\n   * @param _key Key to locate the briefcase in the disk cache\r\n   * @note returns true if the cancel request was acknowledged. false otherwise\r\n   */\r\n  requestCancelDownloadBriefcase(_fileName: string): Promise<boolean>;\r\n\r\n  /**\r\n   * Delete a previously downloaded briefcase. The briefcase must be closed.\r\n   * @param _fileName the Briefcase to delete\r\n   */\r\n  deleteBriefcaseFiles(_fileName: string): Promise<void>;\r\n\r\n  /**\r\n   * Gets a list of all briefcases that were previously downloaded to the system briefcase cache.\r\n   * @note returns array of LocalBriefcaseProps.\r\n   */\r\n  getCachedBriefcases(_iModelId?: GuidString): Promise<LocalBriefcaseProps[]>;\r\n\r\n  /**\r\n   * Open a key/value pair base storage\r\n   * @param _storageId string identifier of storage\r\n   */\r\n  storageMgrOpen(_storageId: string): Promise<string>;\r\n\r\n  /**\r\n   * Close a key/value pair base storage\r\n   * @param _storageId string identifier of storage\r\n   * @param _deleteOnClose delete the storage on close\r\n   */\r\n  storageMgrClose(_storageId: string, _deleteOnClose: boolean): Promise<void>;\r\n\r\n  /**\r\n   * Get the names of available storages\r\n   * @note returns list of storage names\r\n   */\r\n  storageMgrNames(): Promise<string[]>;\r\n\r\n  /**\r\n   * Get the value associated with a key.\r\n   * @param _storageId string identifier of storage\r\n   * @param _key key identifier for value\r\n   * @note returns key value or undefined\r\n   */\r\n  storageGet(_storageId: string, _key: string): Promise<StorageValue | undefined>;\r\n\r\n  /**\r\n   * Set a value for a key.\r\n   * @param _storageId string identifier of storage\r\n   * @param _key key identifier for value\r\n   * @param _value value to be set\r\n   */\r\n  storageSet(_storageId: string, _key: string, _value: StorageValue): Promise<void>;\r\n\r\n  /**\r\n   * Remove a key/value pair.\r\n   * @param _storageId string identifier of storage\r\n   * @param _key key identifier for value\r\n   */\r\n  storageRemove(_storageId: string, _key: string): Promise<void>;\r\n\r\n  /**\r\n   * Get list of keys in a storage.\r\n   * @param _storageId string identifier of storage\r\n   * @note returns list of storage ids\r\n   */\r\n  storageKeys(_storageId: string): Promise<string[]>;\r\n\r\n  /**\r\n   * Delete all key/value pairs.\r\n   * @param _storageId string identifier of storage\r\n   */\r\n  storageRemoveAll(_storageId: string): Promise<void>;\r\n\r\n  /** get the type of a value for a key, or undefined if not present. */\r\n  storageGetValueType(_storageId: string, _key: string): Promise<\"number\" | \"string\" | \"boolean\" | \"Uint8Array\" | \"null\" | undefined>;\r\n}\r\n"]}

package/lib/cjs/OctEncodedNormal.js.map

@@ -1 +1 @@
-{"version":3,"file":"OctEncodedNormal.js","sourceRoot":"","sources":["../../src/OctEncodedNormal.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAwD;AAExD,MAAM,aAAa,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;AAEzC,SAAS,KAAK,CAAC,GAAW,EAAE,MAAc,EAAE,MAAc;IACxD,OAAO,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,UAAU,CAAC,GAAW;IAC7B,OAAO,WAAW,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,aAAa,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;IACvB,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,OAAO,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,MAAa,gBAAgB;IAC3B,0BAA0B;IACV,KAAK,CAAS;IAE9B;;;OAGG;IACH,YAAmB,GAAW;QAC5B,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAED,0EAA0E;IACnE,MAAM,CAAC,MAAM,CAAC,GAAW;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,qFAAqF;IAC9E,MAAM,CAAC,SAAS,CAAC,EAAU,EAAE,EAAU,EAAE,EAAU;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACzD,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;QACpB,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;QACpB,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;YACX,MAAM,CAAC,GAAG,EAAE,CAAC;YACb,MAAM,CAAC,GAAG,EAAE,CAAC;YACb,EAAE,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YACxC,EAAE,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC;QACD,OAAO,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,UAAU,CAAC,GAAW;QAClC,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,+DAA+D;IACxD,MAAM;QACX,OAAO,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,8DAA8D;IACvD,MAAM,CAAC,WAAW,CAAC,GAAW,EAAE,MAAiB;QACtD,IAAI,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC;QACpB,IAAI,EAAE,GAAG,GAAG,IAAI,CAAC,CAAC;QAClB,EAAE,GAAG,EAAE,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,CAAC;QAC5B,EAAE,GAAG,EAAE,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,CAAC;QAC5B,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7C,IAAI,CAAC,CAAC;QACN,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,CAAC,GAAG,IAAI,wBAAQ,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACN,CAAC,GAAG,MAAM,CAAC;YACX,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;YACT,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;YACT,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;QACX,CAAC;QAED,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;YACZ,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACd,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACd,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YACzC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;QAC3C,CAAC;QAED,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACrB,OAAO,CAAC,CAAC;IACX,CAAC;CACF;AApED,4CAoEC;AAED,gBAAgB;AAChB,MAAa,oBAAoB;IACZ;IAAgC;IAAnD,YAAmB,KAAuB,EAAS,MAAwB;QAAxD,UAAK,GAAL,KAAK,CAAkB;QAAS,WAAM,GAAN,MAAM,CAAkB;IAAI,CAAC;CACjF;AAFD,oDAEC","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 Rendering\n */\n\nimport { Vector3d, XYAndZ } from \"@itwin/core-geometry\";\n\nconst scratchUInt16 = new Uint16Array(1);\n\nfunction clamp(val: number, minVal: number, maxVal: number): number {\n  return val < minVal ? minVal : (val > maxVal ? maxVal : val);\n}\n\nfunction clampUint8(val: number): number {\n  return roundUint16(0.5 + (clamp(val, -1, 1) * 0.5 + 0.5) * 255);\n}\n\nfunction roundUint16(val: number): number {\n  scratchUInt16[0] = val;\n  return scratchUInt16[0];\n}\n\nfunction signNotZero(val: number): number {\n  return val < 0.0 ? -1.0 : 1.0;\n}\n\n/** Represents a 3d normal vector compressed into a single 16-bit integer using [oct-encoding](http://jcgt.org/published/0003/02/01/paper.pdf).\n * These are chiefly used to reduce the space required to store normal vectors for [RenderGraphic]($frontend)s.\n * @public\n */\nexport class OctEncodedNormal {\n  /** The encoded normal. */\n  public readonly value: number;\n\n  /** Construct directly from a 16-bit encoded value.\n   * @see [[encode]] to compute the encoded value.\n   * @see [[fromVector]] to construct from a vector.\n   */\n  public constructor(val: number) {\n    this.value = roundUint16(val);\n  }\n\n  /** Compute the encoded 16-bit value of the supplied normalized vector. */\n  public static encode(vec: XYAndZ): number {\n    return this.encodeXYZ(vec.x, vec.y, vec.z);\n  }\n\n  /** Compute the encoded 16-bit value of the supplied normalized vector components. */\n  public static encodeXYZ(nx: number, ny: number, nz: number): number {\n    const denom = Math.abs(nx) + Math.abs(ny) + Math.abs(nz);\n    let rx = nx / denom;\n    let ry = ny / denom;\n    if (nz < 0) {\n      const x = rx;\n      const y = ry;\n      rx = (1 - Math.abs(y)) * signNotZero(x);\n      ry = (1 - Math.abs(x)) * signNotZero(y);\n    }\n    return clampUint8(ry) << 8 | clampUint8(rx);\n  }\n\n  /** Create an OctEncodedNormal from a normalized vector. */\n  public static fromVector(val: XYAndZ): OctEncodedNormal {\n    return new OctEncodedNormal(this.encode(val));\n  }\n\n  /** Decode this oct-encoded normal into a normalized vector. */\n  public decode(): Vector3d {\n    return OctEncodedNormal.decodeValue(this.value);\n  }\n\n  /** Decode a 16-bit encoded value into a normalized vector. */\n  public static decodeValue(val: number, result?: Vector3d): Vector3d {\n    let ex = val & 0xff;\n    let ey = val >> 8;\n    ex = ex / 255.0 * 2.0 - 1.0;\n    ey = ey / 255.0 * 2.0 - 1.0;\n    const ez = 1 - (Math.abs(ex) + Math.abs(ey));\n    let n;\n    if (result === undefined) {\n      n = new Vector3d(ex, ey, ez);\n    } else {\n      n = result;\n      n.x = ex;\n      n.y = ey;\n      n.z = ez;\n    }\n\n    if (n.z < 0) {\n      const x = n.x;\n      const y = n.y;\n      n.x = (1 - Math.abs(y)) * signNotZero(x);\n      n.y = (1 - Math.abs(x)) * signNotZero(y);\n    }\n\n    n.normalizeInPlace();\n    return n;\n  }\n}\n\n/** @internal */\nexport class OctEncodedNormalPair {\n  constructor(public first: OctEncodedNormal, public second: OctEncodedNormal) { }\n}\n"]}
+{"version":3,"file":"OctEncodedNormal.js","sourceRoot":"","sources":["../../src/OctEncodedNormal.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,wDAAwD;AAExD,MAAM,aAAa,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;AAEzC,SAAS,KAAK,CAAC,GAAW,EAAE,MAAc,EAAE,MAAc;IACxD,OAAO,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,UAAU,CAAC,GAAW;IAC7B,OAAO,WAAW,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,aAAa,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;IACvB,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,WAAW,CAAC,GAAW;IAC9B,OAAO,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,MAAa,gBAAgB;IAC3B,0BAA0B;IACV,KAAK,CAAS;IAE9B;;;OAGG;IACH,YAAmB,GAAW;QAC5B,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAED,0EAA0E;IACnE,MAAM,CAAC,MAAM,CAAC,GAAW;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,qFAAqF;IAC9E,MAAM,CAAC,SAAS,CAAC,EAAU,EAAE,EAAU,EAAE,EAAU;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACzD,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;QACpB,IAAI,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;QACpB,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;YACX,MAAM,CAAC,GAAG,EAAE,CAAC;YACb,MAAM,CAAC,GAAG,EAAE,CAAC;YACb,EAAE,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YACxC,EAAE,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC;QACD,OAAO,UAAU,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,UAAU,CAAC,GAAW;QAClC,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,+DAA+D;IACxD,MAAM;QACX,OAAO,gBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,8DAA8D;IACvD,MAAM,CAAC,WAAW,CAAC,GAAW,EAAE,MAAiB;QACtD,IAAI,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC;QACpB,IAAI,EAAE,GAAG,GAAG,IAAI,CAAC,CAAC;QAClB,EAAE,GAAG,EAAE,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,CAAC;QAC5B,EAAE,GAAG,EAAE,GAAG,KAAK,GAAG,GAAG,GAAG,GAAG,CAAC;QAC5B,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7C,IAAI,CAAC,CAAC;QACN,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,CAAC,GAAG,IAAI,wBAAQ,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACN,CAAC,GAAG,MAAM,CAAC;YACX,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;YACT,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;YACT,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;QACX,CAAC;QAED,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;YACZ,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACd,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACd,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YACzC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;QAC3C,CAAC;QAED,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACrB,OAAO,CAAC,CAAC;IACX,CAAC;CACF;AApED,4CAoEC;AAED,gBAAgB;AAChB,MAAa,oBAAoB;IACZ;IAAgC;IAAnD,YAAmB,KAAuB,EAAS,MAAwB;QAAxD,UAAK,GAAL,KAAK,CAAkB;QAAS,WAAM,GAAN,MAAM,CAAkB;IAAI,CAAC;CACjF;AAFD,oDAEC","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 Rendering\r\n */\r\n\r\nimport { Vector3d, XYAndZ } from \"@itwin/core-geometry\";\r\n\r\nconst scratchUInt16 = new Uint16Array(1);\r\n\r\nfunction clamp(val: number, minVal: number, maxVal: number): number {\r\n  return val < minVal ? minVal : (val > maxVal ? maxVal : val);\r\n}\r\n\r\nfunction clampUint8(val: number): number {\r\n  return roundUint16(0.5 + (clamp(val, -1, 1) * 0.5 + 0.5) * 255);\r\n}\r\n\r\nfunction roundUint16(val: number): number {\r\n  scratchUInt16[0] = val;\r\n  return scratchUInt16[0];\r\n}\r\n\r\nfunction signNotZero(val: number): number {\r\n  return val < 0.0 ? -1.0 : 1.0;\r\n}\r\n\r\n/** Represents a 3d normal vector compressed into a single 16-bit integer using [oct-encoding](http://jcgt.org/published/0003/02/01/paper.pdf).\r\n * These are chiefly used to reduce the space required to store normal vectors for [RenderGraphic]($frontend)s.\r\n * @public\r\n */\r\nexport class OctEncodedNormal {\r\n  /** The encoded normal. */\r\n  public readonly value: number;\r\n\r\n  /** Construct directly from a 16-bit encoded value.\r\n   * @see [[encode]] to compute the encoded value.\r\n   * @see [[fromVector]] to construct from a vector.\r\n   */\r\n  public constructor(val: number) {\r\n    this.value = roundUint16(val);\r\n  }\r\n\r\n  /** Compute the encoded 16-bit value of the supplied normalized vector. */\r\n  public static encode(vec: XYAndZ): number {\r\n    return this.encodeXYZ(vec.x, vec.y, vec.z);\r\n  }\r\n\r\n  /** Compute the encoded 16-bit value of the supplied normalized vector components. */\r\n  public static encodeXYZ(nx: number, ny: number, nz: number): number {\r\n    const denom = Math.abs(nx) + Math.abs(ny) + Math.abs(nz);\r\n    let rx = nx / denom;\r\n    let ry = ny / denom;\r\n    if (nz < 0) {\r\n      const x = rx;\r\n      const y = ry;\r\n      rx = (1 - Math.abs(y)) * signNotZero(x);\r\n      ry = (1 - Math.abs(x)) * signNotZero(y);\r\n    }\r\n    return clampUint8(ry) << 8 | clampUint8(rx);\r\n  }\r\n\r\n  /** Create an OctEncodedNormal from a normalized vector. */\r\n  public static fromVector(val: XYAndZ): OctEncodedNormal {\r\n    return new OctEncodedNormal(this.encode(val));\r\n  }\r\n\r\n  /** Decode this oct-encoded normal into a normalized vector. */\r\n  public decode(): Vector3d {\r\n    return OctEncodedNormal.decodeValue(this.value);\r\n  }\r\n\r\n  /** Decode a 16-bit encoded value into a normalized vector. */\r\n  public static decodeValue(val: number, result?: Vector3d): Vector3d {\r\n    let ex = val & 0xff;\r\n    let ey = val >> 8;\r\n    ex = ex / 255.0 * 2.0 - 1.0;\r\n    ey = ey / 255.0 * 2.0 - 1.0;\r\n    const ez = 1 - (Math.abs(ex) + Math.abs(ey));\r\n    let n;\r\n    if (result === undefined) {\r\n      n = new Vector3d(ex, ey, ez);\r\n    } else {\r\n      n = result;\r\n      n.x = ex;\r\n      n.y = ey;\r\n      n.z = ez;\r\n    }\r\n\r\n    if (n.z < 0) {\r\n      const x = n.x;\r\n      const y = n.y;\r\n      n.x = (1 - Math.abs(y)) * signNotZero(x);\r\n      n.y = (1 - Math.abs(x)) * signNotZero(y);\r\n    }\r\n\r\n    n.normalizeInPlace();\r\n    return n;\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class OctEncodedNormalPair {\r\n  constructor(public first: OctEncodedNormal, public second: OctEncodedNormal) { }\r\n}\r\n"]}

package/lib/cjs/PlanProjectionSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"PlanProjectionSettings.js","sourceRoot":"","sources":["../../src/PlanProjectionSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAqBH;;;;;;GAMG;AACH,MAAa,sBAAsB;IACjC,oDAAoD;IACpC,SAAS,CAAU;IACnC,uDAAuD;IACvC,YAAY,CAAU;IACtC,kDAAkD;IAClC,OAAO,CAAU;IACjC,iEAAiE;IACjD,sBAAsB,CAAW;IAE1C,MAAM;QACX,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,OAAO,EAAE,IAAI,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YACjD,sBAAsB,EAAE,IAAI,KAAK,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SAChF,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAA8C;QACnE,IAAI,SAAS,KAAK,KAAK;YACrB,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,SAAS,KAAK,KAAK,CAAC,YAAY,IAAI,SAAS,KAAK,KAAK,CAAC,OAAO,IAAI,SAAS,KAAK,KAAK,CAAC,sBAAsB;YAChJ,OAAO,SAAS,CAAC;QAEnB,OAAO,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,YAAoB,KAAkC;QACpD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,IAAI,KAAK,KAAK,CAAC,OAAO,CAAC;QACtC,IAAI,CAAC,sBAAsB,GAAG,IAAI,KAAK,KAAK,CAAC,sBAAsB,CAAC;QAEpE,IAAI,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QACtC,IAAI,SAAS,KAAK,YAAY;YAC5B,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;QAExD,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAA0C;QACrD,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAgC,IAAI,CAAC,MAAM,EAAE,CAAC;QACzD,IAAI,SAAS,KAAK,YAAY,CAAC,SAAS;YACtC,KAAK,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC;QAE3C,IAAI,SAAS,KAAK,YAAY,CAAC,YAAY;YACzC,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC;QAEjD,IAAI,SAAS,KAAK,YAAY,CAAC,OAAO;YACpC,KAAK,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC;QAEvC,IAAI,SAAS,KAAK,YAAY,CAAC,sBAAsB;YACnD,KAAK,CAAC,sBAAsB,GAAG,YAAY,CAAC,sBAAsB,CAAC;QAErE,OAAO,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,8EAA8E;IACvE,MAAM,CAAC,KAA6B;QACzC,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,sBAAsB,KAAK,KAAK,CAAC,sBAAsB,CAAC;IAC1L,CAAC;CACF;AAxED,wDAwEC","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 DisplayStyles\n */\n\n/** Wire format describing [[PlanProjectionSettings]].\n * @public\n * @extensions\n */\nexport interface PlanProjectionSettingsProps {\n  /** If defined, the absolute height in meters at which to display the model. */\n  elevation?: number;\n  /** If defined, specifies a uniform transparency applied to all of the geometry in the model, in the range 0.0 (fully opaque) to 1.0 (fully transparent). */\n  transparency?: number;\n  /** If defined and true, the model is displayed as an overlay in the view (without depth testing) so that it is always visible behind other geometry. */\n  overlay?: boolean;\n  /** If defined and true, subcategory display priority is used to specify the draw order of portions of the model. Geometry belonging to a subcategory with a higher priority\n   * value is drawn on top of coincident geometry belonging to a subcategory with a lower priority value. The priorities can be modified at display time using\n   * [FeatureSymbology.Overrides]($frontend). Note that subcategory \"layers\" cross model boundaries; that is, geometry belonging to the same subcategory in different models\n   * are drawn as part of the same layer.\n   */\n  enforceDisplayPriority?: boolean;\n}\n\n/** Describes how to draw a plan projection model. A plan projection model is a [GeometricModel3d]($backend) whose geometry all lies in\n * a single XY plane, wherein the Z coordinate of the plane may be arbitrary or flexible. Multiple plan projection models can be combined into one view\n * and drawn as \"layers\" with relative priorities.\n * @see [[DisplayStyle3dSettings.setPlanProjectionSettings]] to define plan projection settings for a [DisplayStyle3dState]($frontend).\n * @see [GeometricModel3d.isPlanProjection]($backend).\n * @public\n */\nexport class PlanProjectionSettings {\n  /** See [[PlanProjectionSettingsProps.elevation]] */\n  public readonly elevation?: number;\n  /** See [[PlanProjectionSettingsProps.transparency]] */\n  public readonly transparency?: number;\n  /** See [[PlanProjectionSettingsProps.overlay]] */\n  public readonly overlay: boolean;\n  /** See [[PlanProjectionSettingsProps.enforceDisplayPriority]] */\n  public readonly enforceDisplayPriority?: boolean;\n\n  public toJSON(): PlanProjectionSettingsProps {\n    return {\n      elevation: this.elevation,\n      transparency: this.transparency,\n      overlay: true === this.overlay ? true : undefined,\n      enforceDisplayPriority: true === this.enforceDisplayPriority ? true : undefined,\n    };\n  }\n\n  public static fromJSON(props: PlanProjectionSettingsProps | undefined): PlanProjectionSettings | undefined {\n    if (undefined === props)\n      return undefined;\n\n    if (undefined === props.elevation && undefined === props.transparency && undefined === props.overlay && undefined === props.enforceDisplayPriority)\n      return undefined;\n\n    return new PlanProjectionSettings(props);\n  }\n\n  private constructor(props: PlanProjectionSettingsProps) {\n    this.elevation = props.elevation;\n    this.overlay = true === props.overlay;\n    this.enforceDisplayPriority = true === props.enforceDisplayPriority;\n\n    let transparency = props.transparency;\n    if (undefined !== transparency)\n      transparency = Math.max(0, Math.min(1, transparency));\n\n    this.transparency = transparency;\n  }\n\n  /** Create a copy of this PlanProjectionSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A PlanProjectionSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: PlanProjectionSettingsProps): PlanProjectionSettings {\n    if (undefined === changedProps)\n      return this;\n\n    const props: PlanProjectionSettingsProps = this.toJSON();\n    if (undefined !== changedProps.elevation)\n      props.elevation = changedProps.elevation;\n\n    if (undefined !== changedProps.transparency)\n      props.transparency = changedProps.transparency;\n\n    if (undefined !== changedProps.overlay)\n      props.overlay = changedProps.overlay;\n\n    if (undefined !== changedProps.enforceDisplayPriority)\n      props.enforceDisplayPriority = changedProps.enforceDisplayPriority;\n\n    return new PlanProjectionSettings(props);\n  }\n\n  /** Return true if these settings are equivalent to the specified settings. */\n  public equals(other: PlanProjectionSettings): boolean {\n    if (this === other)\n      return true;\n\n    return this.elevation === other.elevation && this.transparency === other.transparency && this.overlay === other.overlay && this.enforceDisplayPriority === other.enforceDisplayPriority;\n  }\n}\n"]}
+{"version":3,"file":"PlanProjectionSettings.js","sourceRoot":"","sources":["../../src/PlanProjectionSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAqBH;;;;;;GAMG;AACH,MAAa,sBAAsB;IACjC,oDAAoD;IACpC,SAAS,CAAU;IACnC,uDAAuD;IACvC,YAAY,CAAU;IACtC,kDAAkD;IAClC,OAAO,CAAU;IACjC,iEAAiE;IACjD,sBAAsB,CAAW;IAE1C,MAAM;QACX,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,OAAO,EAAE,IAAI,KAAK,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;YACjD,sBAAsB,EAAE,IAAI,KAAK,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;SAChF,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAA8C;QACnE,IAAI,SAAS,KAAK,KAAK;YACrB,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,SAAS,KAAK,KAAK,CAAC,YAAY,IAAI,SAAS,KAAK,KAAK,CAAC,OAAO,IAAI,SAAS,KAAK,KAAK,CAAC,sBAAsB;YAChJ,OAAO,SAAS,CAAC;QAEnB,OAAO,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,YAAoB,KAAkC;QACpD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,IAAI,KAAK,KAAK,CAAC,OAAO,CAAC;QACtC,IAAI,CAAC,sBAAsB,GAAG,IAAI,KAAK,KAAK,CAAC,sBAAsB,CAAC;QAEpE,IAAI,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QACtC,IAAI,SAAS,KAAK,YAAY;YAC5B,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;QAExD,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAA0C;QACrD,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAgC,IAAI,CAAC,MAAM,EAAE,CAAC;QACzD,IAAI,SAAS,KAAK,YAAY,CAAC,SAAS;YACtC,KAAK,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC;QAE3C,IAAI,SAAS,KAAK,YAAY,CAAC,YAAY;YACzC,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC;QAEjD,IAAI,SAAS,KAAK,YAAY,CAAC,OAAO;YACpC,KAAK,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC;QAEvC,IAAI,SAAS,KAAK,YAAY,CAAC,sBAAsB;YACnD,KAAK,CAAC,sBAAsB,GAAG,YAAY,CAAC,sBAAsB,CAAC;QAErE,OAAO,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,8EAA8E;IACvE,MAAM,CAAC,KAA6B;QACzC,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,sBAAsB,KAAK,KAAK,CAAC,sBAAsB,CAAC;IAC1L,CAAC;CACF;AAxED,wDAwEC","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 DisplayStyles\r\n */\r\n\r\n/** Wire format describing [[PlanProjectionSettings]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface PlanProjectionSettingsProps {\r\n  /** If defined, the absolute height in meters at which to display the model. */\r\n  elevation?: number;\r\n  /** If defined, specifies a uniform transparency applied to all of the geometry in the model, in the range 0.0 (fully opaque) to 1.0 (fully transparent). */\r\n  transparency?: number;\r\n  /** If defined and true, the model is displayed as an overlay in the view (without depth testing) so that it is always visible behind other geometry. */\r\n  overlay?: boolean;\r\n  /** If defined and true, subcategory display priority is used to specify the draw order of portions of the model. Geometry belonging to a subcategory with a higher priority\r\n   * value is drawn on top of coincident geometry belonging to a subcategory with a lower priority value. The priorities can be modified at display time using\r\n   * [FeatureSymbology.Overrides]($frontend). Note that subcategory \"layers\" cross model boundaries; that is, geometry belonging to the same subcategory in different models\r\n   * are drawn as part of the same layer.\r\n   */\r\n  enforceDisplayPriority?: boolean;\r\n}\r\n\r\n/** Describes how to draw a plan projection model. A plan projection model is a [GeometricModel3d]($backend) whose geometry all lies in\r\n * a single XY plane, wherein the Z coordinate of the plane may be arbitrary or flexible. Multiple plan projection models can be combined into one view\r\n * and drawn as \"layers\" with relative priorities.\r\n * @see [[DisplayStyle3dSettings.setPlanProjectionSettings]] to define plan projection settings for a [DisplayStyle3dState]($frontend).\r\n * @see [GeometricModel3d.isPlanProjection]($backend).\r\n * @public\r\n */\r\nexport class PlanProjectionSettings {\r\n  /** See [[PlanProjectionSettingsProps.elevation]] */\r\n  public readonly elevation?: number;\r\n  /** See [[PlanProjectionSettingsProps.transparency]] */\r\n  public readonly transparency?: number;\r\n  /** See [[PlanProjectionSettingsProps.overlay]] */\r\n  public readonly overlay: boolean;\r\n  /** See [[PlanProjectionSettingsProps.enforceDisplayPriority]] */\r\n  public readonly enforceDisplayPriority?: boolean;\r\n\r\n  public toJSON(): PlanProjectionSettingsProps {\r\n    return {\r\n      elevation: this.elevation,\r\n      transparency: this.transparency,\r\n      overlay: true === this.overlay ? true : undefined,\r\n      enforceDisplayPriority: true === this.enforceDisplayPriority ? true : undefined,\r\n    };\r\n  }\r\n\r\n  public static fromJSON(props: PlanProjectionSettingsProps | undefined): PlanProjectionSettings | undefined {\r\n    if (undefined === props)\r\n      return undefined;\r\n\r\n    if (undefined === props.elevation && undefined === props.transparency && undefined === props.overlay && undefined === props.enforceDisplayPriority)\r\n      return undefined;\r\n\r\n    return new PlanProjectionSettings(props);\r\n  }\r\n\r\n  private constructor(props: PlanProjectionSettingsProps) {\r\n    this.elevation = props.elevation;\r\n    this.overlay = true === props.overlay;\r\n    this.enforceDisplayPriority = true === props.enforceDisplayPriority;\r\n\r\n    let transparency = props.transparency;\r\n    if (undefined !== transparency)\r\n      transparency = Math.max(0, Math.min(1, transparency));\r\n\r\n    this.transparency = transparency;\r\n  }\r\n\r\n  /** Create a copy of this PlanProjectionSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A PlanProjectionSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps?: PlanProjectionSettingsProps): PlanProjectionSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    const props: PlanProjectionSettingsProps = this.toJSON();\r\n    if (undefined !== changedProps.elevation)\r\n      props.elevation = changedProps.elevation;\r\n\r\n    if (undefined !== changedProps.transparency)\r\n      props.transparency = changedProps.transparency;\r\n\r\n    if (undefined !== changedProps.overlay)\r\n      props.overlay = changedProps.overlay;\r\n\r\n    if (undefined !== changedProps.enforceDisplayPriority)\r\n      props.enforceDisplayPriority = changedProps.enforceDisplayPriority;\r\n\r\n    return new PlanProjectionSettings(props);\r\n  }\r\n\r\n  /** Return true if these settings are equivalent to the specified settings. */\r\n  public equals(other: PlanProjectionSettings): boolean {\r\n    if (this === other)\r\n      return true;\r\n\r\n    return this.elevation === other.elevation && this.transparency === other.transparency && this.overlay === other.overlay && this.enforceDisplayPriority === other.enforceDisplayPriority;\r\n  }\r\n}\r\n"]}

package/lib/cjs/PlanarClipMask.js.map

@@ -1 +1 @@
-{"version":3,"file":"PlanarClipMask.js","sourceRoot":"","sources":["../../src/PlanarClipMask.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAyF;AAEzF;;;GAGG;AACH,IAAY,kBAyBX;AAzBD,WAAY,kBAAkB;IAC5B,kBAAkB;IAClB,2DAAQ,CAAA;IACR;;;;OAIG;IACH,mEAAY,CAAA;IACZ;;OAEG;IACH,+DAAU,CAAA;IACV;;OAEG;IACH,2FAAwB,CAAA;IACxB;;OAEG;IACH,iFAAmB,CAAA;IACnB;;OAEG;IACH,iFAAmB,CAAA;AACrB,CAAC,EAzBW,kBAAkB,kCAAlB,kBAAkB,QAyB7B;AAED;;;;GAIG;AACH,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,sBAAsB;IACtB,yFAAqB,CAAA;IACrB,6EAA6E;IAC7E,mGAA0B,CAAA;IAC1B,4CAA4C;IAC5C,mFAAgB,CAAA;IAChB,yDAAyD;IACzD,oFAAkB,CAAA;AACpB,CAAC,EATW,sBAAsB,sCAAtB,sBAAsB,QASjC;AAkFD;;;;;;;;GAQG;AACH,MAAa,sBAAsB;IACjC,mDAAmD;IACnC,IAAI,CAAqB;IACzC;;;OAGG;IACa,QAAQ,CAAuB;IAC/C;;;OAGG;IACa,uBAAuB,CAAuB;IAC9D,+DAA+D;IAC/C,QAAQ,CAAU;IAClC;;OAEG;IACa,YAAY,CAAU;IACtC,iMAAiM;IACjL,MAAM,CAAU;IACf,SAAS,CAAqB;IAC9B,wBAAwB,CAAqB;IAE9D,qDAAqD;IACrD,IAAW,kBAAkB;QAC3B,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,mFAAmF;IAC5E,MAAM,CAAC,QAAQ,CAAC,IAA0B;QAC/C,IAAI,CAAC,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI;YAClC,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3I,CAAC;IAED,2CAA2C;IACpC,MAAM,CAAC,MAAM,CAAC,IAAsH;QACzI,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,gCAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9F,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACjI,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc;YACxC,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,gCAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACrL,IAAI,SAAS,KAAK,IAAI,CAAC,UAAU;YACpC,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC,kBAAkB,CAAC,eAAe,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,gCAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;;YAEnO,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACjI,CAAC;IAED,sEAAsE;IAC/D,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QACvD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAElC,IAAI,SAAS,KAAK,IAAI,CAAC,wBAAwB;YAC7C,KAAK,CAAC,uBAAuB,GAAG,IAAI,CAAC,wBAAwB,CAAC;QAEhE,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY;YACjC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,IAAI,IAAI,CAAC,MAAM;YACb,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;QAEtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,0CAA0C;IAC1C,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,IAAI,CAAC;IAC/C,CAAC;IAEM,MAAM,CAAC,KAA6B;QACzC,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;YAC7B,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAChC,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;YACxC,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;YAClC,IAAI,CAAC,wBAAwB,KAAK,KAAK,CAAC,wBAAwB,CAAC;IACrE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAkC;QAC7C,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,OAAO,sBAAsB,CAAC,QAAQ,CAAC;YACrC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;IAED,YAAoB,IAAwB,EAAE,YAAqB,EAAE,QAA4B,EAAE,uBAA2C,EAAE,QAAiB,EAAE,MAAgB;QACjL,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,wBAAwB,GAAG,uBAAuB,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,IAAI,KAAK,MAAM,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,SAAS,KAAK,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAEpG,IAAI,QAAQ;YACV,IAAI,CAAC,QAAQ,GAAG,gCAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEvD,IAAI,uBAAuB;YACzB,IAAI,CAAC,uBAAuB,GAAG,gCAAiB,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAAC;IACvF,CAAC;IAED,oDAAoD;IAC7C,MAAM,CAAC,QAAQ,GAAG,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;;AAnH/E,wDAoHC","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 DisplayStyles\n */\n\nimport { CompressedId64Set, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\n\n/** The different modes by which a [[PlanarClipMaskSettings]] collects the geometry used to mask a model.\n * @public\n * @extensions\n */\nexport enum PlanarClipMaskMode {\n  /** No masking. */\n  None = 0,\n  /** Mask based on priority. Different types of models have different default priorities as enumerated by [[PlanarClipMaskPriority]].\n   * For example, background maps have the lowest priority, so they are masked by all other types, while design models have the highest priority and are therefore never masked.\n   * The priority of a reality model can be overridden by [[PlanarClipMaskSettings.priority]]. This is useful to allow one reality model to mask another overlapping one.\n   * Everything visible in the view creates the mask, so turning off models, categories, or elements (via fully transparent overrides) will make things not be in the mask.\n   */\n  Priority = 1,\n  /** Indicates that masks should be produced from the geometry in a set of [GeometricModel]($backend)s, regardless of what model is on or off in the view.\n   * However, things that are off from category settings or element feature overrides in the view will not be in the mask for these models.\n   */\n  Models = 2,\n  /** Indicates that masks should be produced from geometry belonging to a set of subcategories.\n   * View settings do not affect what is in the mask, unless [[PlanarClipMaskSettings.subCategoryOrElementIds]] is undefined, in which case it behaves like Models mode.\n   */\n  IncludeSubCategories = 3,\n  /** Indicates that masks should be produced from the geometry of a set of [GeometricElement]($backend)s.\n   * View settings do not affect what is in the mask, unless [[PlanarClipMaskSettings.subCategoryOrElementIds]] is undefined, in which case it behaves like Models mode.\n   */\n  IncludeElements = 4,\n  /** Indicates that masks should be produced from the geometry of all [GeometricElement]($backend)s in a view, **except** for a specified set of excluded elements.\n   * View settings do not affect what is in the mask, unless [[PlanarClipMaskSettings.subCategoryOrElementIds]] is undefined, in which case it behaves like Models mode.\n   */\n  ExcludeElements = 5,\n}\n\n/** The default priority values for a [[PlanarClipMaskSettings]], based on model type. Models with a lower priority are masked by models with a higher priority.\n * The default can be overridden by [[PlanarClipMaskSettings.priority]].\n *  @public\n * @extensions\n */\nexport enum PlanarClipMaskPriority {\n  /** Background map. */\n  BackgroundMap = -2048,\n  /** A reality model that spans the globe - e.g., OpenStreetMaps Buildings. */\n  GlobalRealityModel = -1024,\n  /** A reality model with a bounded range. */\n  RealityModel = 0,\n  /** A design model stored in the [IModelDb]($backend). */\n  DesignModel = 2048,\n}\n\n/** JSON representation of a [[PlanarClipMaskSettings]].\n * @see [[DisplayStyleSettingsProps.planarClipOvr]] and [[ContextRealityModelProps.planarClipMask]].\n * @public\n * @extensions\n */\nexport interface PlanarClipMaskProps {\n  /** Controls how the mask geometry is collected */\n  mode: PlanarClipMaskMode;\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\n  modelIds?: CompressedId64Set;\n  /** See [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\n  subCategoryOrElementIds?: CompressedId64Set;\n  /** See [[PlanarClipMaskSettings.priority]]. */\n  priority?: number;\n  /** See [[PlanarClipMaskSettings.transparency]]. */\n  transparency?: number;\n  /** See PlanarClipMaskSettings.invert */\n  invert?: boolean;\n}\n\n/** Basic arguments supplied to [[PlanarClipMaskSettings.create]].\n * @public\n */\nexport interface BasicPlanarClipMaskArgs {\n  /** See [[PlanarClipMaskSettings.transparency]]. */\n  transparency?: number;\n  /** See [[PlanarClipMaskSettings.invert]]. */\n  invert?: boolean;\n}\n\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Models]].\n * @public\n */\nexport interface ModelPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\n  modelIds?: Iterable<Id64String>;\n  exclude?: never;\n  elementIds?: never;\n  subCategoryIds?: never;\n  priority?: never;\n}\n\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludeElements]].\n * @public\n */\nexport interface ElementPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\n  modelIds?: Iterable<Id64String>;\n  /** The elements used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\n  elementIds: Iterable<Id64String>;\n  /** If true, creates a mask of [[PlanarClipMaskMode.ExcludeElements]]; otherwise, [[PlanarClipMaskMode.IncludeElements]]. */\n  exclude?: boolean;\n  subCategoryIds?: never;\n  priority?: never;\n}\n\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeSubCategories]].\n * @public\n */\nexport interface SubCategoryPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\n  modelIds?: Iterable<Id64String>;\n  /** The subcategories used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\n  subCategoryIds: Iterable<Id64String>;\n  exclude?: never;\n  elementIds?: never;\n  priority?: never;\n}\n\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Priority]].\n * @public\n */\nexport interface PriorityPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\n  /** See [[PlanarClipMaskSettings.priority]]. */\n  priority: number;\n  exclude?: never;\n  elementIds?: never;\n  modelIds?: never;\n}\n\n/** Describes how to mask the geometry of one [GeometricModel]($backend) for display. The mask is produced by projecting geometry from any number of other models -\n * optionally filtered by [SubCategory]($backend) or by a set of specific [GeometricElement]($backend)s - onto a plane. Regions of the masked model that intersect the\n * mask are rendered partially or completely transparent. This is useful for, e.g., making subsurface geometry visible below the background map, or clipping out portions\n * of a reality model that intersect a design model.\n * @note Currently reality models (including background maps and terrain) can be masked, but design models can only produce masks.\n * @see [[DisplayStyleSettings.planarClipMasks]] to define clip masks for a [DisplayStyle]($backend).\n * @see [[ContextRealityModel.planarClipMaskSettings]] to apply a clip mask to a context reality model.\n * @public\n */\nexport class PlanarClipMaskSettings {\n  /** Specifies how the mask geometry is produced. */\n  public readonly mode: PlanarClipMaskMode;\n  /** For any mode other than [[PlanarClipMaskMode.Priority]], the Ids of the [GeometricModel]($backend)s containing the geometry used to produce the mask,\n   * and if `undefined`, no mask geometry will be created.\n   * The mask geometry can be filtered by [[subCategoryOrElementIds]].\n   */\n  public readonly modelIds?: OrderedId64Iterable;\n  /** For [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludedElements]], the Ids of the [GeometricElement]($backend)s to include or exclude from masking;\n   * for [[PlanarClipMaskMode.IncludeSubCategories]], the Ids of the subcategories whose geometry contributes to the mask.\n   * If undefined, Modes IncludeSubCategories, IncludeElements, and ExcludeElements behave like Models mode.\n   */\n  public readonly subCategoryOrElementIds?: OrderedId64Iterable;\n  /** For [[PlanarClipMaskMode.Priority]], the priority value. */\n  public readonly priority?: number;\n  /** A value between 0 and 1 indicating an override for mask transparency. A transparency of 0 indicates complete masking. 1 is completely transparent (no masking).\n   If no transparency is defined then the transparencies of the mask elements are used.\n   */\n  public readonly transparency?: number;\n  /** A value of true indicates that the mask should be inverted and only content within the mask should be displayed, in other words the area inside the mask is displayed rather than outside. */\n  public readonly invert: boolean;\n  private readonly _modelIds?: CompressedId64Set;\n  private readonly _subCategoryOrElementIds?: CompressedId64Set;\n\n  /** The compressed representation of [[modelIds]]. */\n  public get compressedModelIds(): CompressedId64Set | undefined {\n    return this._modelIds;\n  }\n\n  /** Create a new [[PlanarClipMaskSettings]] object from its JSON representation. */\n  public static fromJSON(json?: PlanarClipMaskProps): PlanarClipMaskSettings {\n    if (!json || undefined === json.mode)\n      return this.defaults;\n\n    return new PlanarClipMaskSettings(json.mode, json.transparency, json.modelIds, json.subCategoryOrElementIds, json.priority, json.invert);\n  }\n\n  /** Create a new PlanarClipMaskSettings. */\n  public static create(args: ModelPlanarClipMaskArgs | ElementPlanarClipMaskArgs | SubCategoryPlanarClipMaskArgs | PriorityPlanarClipMaskArgs): PlanarClipMaskSettings {\n    const modelIds = args.modelIds ? CompressedId64Set.sortAndCompress(args.modelIds) : undefined;\n    if (undefined !== args.priority)\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.Priority, args.transparency, undefined, undefined, args.priority, args.invert);\n    else if (undefined !== args.subCategoryIds)\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.IncludeSubCategories, args.transparency, modelIds, CompressedId64Set.sortAndCompress(args.subCategoryIds), undefined, args.invert);\n    else if (undefined !== args.elementIds)\n      return new PlanarClipMaskSettings(args.exclude ? PlanarClipMaskMode.ExcludeElements : PlanarClipMaskMode.IncludeElements, args.transparency, modelIds, CompressedId64Set.sortAndCompress(args.elementIds), undefined, args.invert);\n    else\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.Models, args.transparency, modelIds, undefined, undefined, args.invert);\n  }\n\n  /** Create JSON object representing this [[PlanarClipMaskSettings]] */\n  public toJSON(): PlanarClipMaskProps {\n    const props: PlanarClipMaskProps = { mode: this.mode };\n    if (undefined !== this._modelIds)\n      props.modelIds = this._modelIds;\n\n    if (undefined !== this._subCategoryOrElementIds)\n      props.subCategoryOrElementIds = this._subCategoryOrElementIds;\n\n    if (undefined !== this.priority)\n      props.priority = this.priority;\n\n    if (undefined !== this.transparency)\n      props.transparency = this.transparency;\n\n    if (this.invert)\n      props.invert = true;\n\n    return props;\n  }\n\n  /** Returns true if masking is enabled. */\n  public get isValid(): boolean {\n    return this.mode !== PlanarClipMaskMode.None;\n  }\n\n  public equals(other: PlanarClipMaskSettings): boolean {\n    return this.mode === other.mode &&\n      this.priority === other.priority &&\n      this.transparency === other.transparency &&\n      this.invert === other.invert &&\n      this._modelIds === other._modelIds &&\n      this._subCategoryOrElementIds === other._subCategoryOrElementIds;\n  }\n\n  /** Create a copy of this TerrainSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A PlanarClipMaskSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: PlanarClipMaskProps): PlanarClipMaskSettings {\n    if (undefined === changedProps)\n      return this;\n\n    return PlanarClipMaskSettings.fromJSON({\n      ...this.toJSON(),\n      ...changedProps,\n    });\n  }\n\n  private constructor(mode: PlanarClipMaskMode, transparency?: number, modelIds?: CompressedId64Set, subCategoryOrElementIds?: CompressedId64Set, priority?: number, invert?: boolean) {\n    this.mode = mode;\n    this._modelIds = modelIds;\n    this._subCategoryOrElementIds = subCategoryOrElementIds;\n    this.priority = priority;\n    this.invert = true === invert;\n    this.transparency = undefined !== transparency ? Math.max(0, Math.min(1, transparency)) : undefined;\n\n    if (modelIds)\n      this.modelIds = CompressedId64Set.iterable(modelIds);\n\n    if (subCategoryOrElementIds)\n      this.subCategoryOrElementIds = CompressedId64Set.iterable(subCategoryOrElementIds);\n  }\n\n  /** A default PlanarClipMask which masks nothing. */\n  public static defaults = new PlanarClipMaskSettings(PlanarClipMaskMode.None);\n}\n"]}
+{"version":3,"file":"PlanarClipMask.js","sourceRoot":"","sources":["../../src/PlanarClipMask.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAyF;AAEzF;;;GAGG;AACH,IAAY,kBAyBX;AAzBD,WAAY,kBAAkB;IAC5B,kBAAkB;IAClB,2DAAQ,CAAA;IACR;;;;OAIG;IACH,mEAAY,CAAA;IACZ;;OAEG;IACH,+DAAU,CAAA;IACV;;OAEG;IACH,2FAAwB,CAAA;IACxB;;OAEG;IACH,iFAAmB,CAAA;IACnB;;OAEG;IACH,iFAAmB,CAAA;AACrB,CAAC,EAzBW,kBAAkB,kCAAlB,kBAAkB,QAyB7B;AAED;;;;GAIG;AACH,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,sBAAsB;IACtB,yFAAqB,CAAA;IACrB,6EAA6E;IAC7E,mGAA0B,CAAA;IAC1B,4CAA4C;IAC5C,mFAAgB,CAAA;IAChB,yDAAyD;IACzD,oFAAkB,CAAA;AACpB,CAAC,EATW,sBAAsB,sCAAtB,sBAAsB,QASjC;AAkFD;;;;;;;;GAQG;AACH,MAAa,sBAAsB;IACjC,mDAAmD;IACnC,IAAI,CAAqB;IACzC;;;OAGG;IACa,QAAQ,CAAuB;IAC/C;;;OAGG;IACa,uBAAuB,CAAuB;IAC9D,+DAA+D;IAC/C,QAAQ,CAAU;IAClC;;OAEG;IACa,YAAY,CAAU;IACtC,iMAAiM;IACjL,MAAM,CAAU;IACf,SAAS,CAAqB;IAC9B,wBAAwB,CAAqB;IAE9D,qDAAqD;IACrD,IAAW,kBAAkB;QAC3B,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,mFAAmF;IAC5E,MAAM,CAAC,QAAQ,CAAC,IAA0B;QAC/C,IAAI,CAAC,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC,IAAI;YAClC,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3I,CAAC;IAED,2CAA2C;IACpC,MAAM,CAAC,MAAM,CAAC,IAAsH;QACzI,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,gCAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9F,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACjI,IAAI,SAAS,KAAK,IAAI,CAAC,cAAc;YACxC,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,oBAAoB,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,gCAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;aACrL,IAAI,SAAS,KAAK,IAAI,CAAC,UAAU;YACpC,OAAO,IAAI,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,CAAC,kBAAkB,CAAC,eAAe,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,gCAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;;YAEnO,OAAO,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACjI,CAAC;IAED,sEAAsE;IAC/D,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;QACvD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAElC,IAAI,SAAS,KAAK,IAAI,CAAC,wBAAwB;YAC7C,KAAK,CAAC,uBAAuB,GAAG,IAAI,CAAC,wBAAwB,CAAC;QAEhE,IAAI,SAAS,KAAK,IAAI,CAAC,QAAQ;YAC7B,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,SAAS,KAAK,IAAI,CAAC,YAAY;YACjC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QAEzC,IAAI,IAAI,CAAC,MAAM;YACb,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;QAEtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,0CAA0C;IAC1C,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,IAAI,CAAC;IAC/C,CAAC;IAEM,MAAM,CAAC,KAA6B;QACzC,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;YAC7B,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;YAChC,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;YACxC,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAC5B,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;YAClC,IAAI,CAAC,wBAAwB,KAAK,KAAK,CAAC,wBAAwB,CAAC;IACrE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAkC;QAC7C,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,OAAO,sBAAsB,CAAC,QAAQ,CAAC;YACrC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;IAED,YAAoB,IAAwB,EAAE,YAAqB,EAAE,QAA4B,EAAE,uBAA2C,EAAE,QAAiB,EAAE,MAAgB;QACjL,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,wBAAwB,GAAG,uBAAuB,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,IAAI,KAAK,MAAM,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,SAAS,KAAK,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAEpG,IAAI,QAAQ;YACV,IAAI,CAAC,QAAQ,GAAG,gCAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEvD,IAAI,uBAAuB;YACzB,IAAI,CAAC,uBAAuB,GAAG,gCAAiB,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAAC;IACvF,CAAC;IAED,oDAAoD;IAC7C,MAAM,CAAC,QAAQ,GAAG,IAAI,sBAAsB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;;AAnH/E,wDAoHC","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 DisplayStyles\r\n */\r\n\r\nimport { CompressedId64Set, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\r\n\r\n/** The different modes by which a [[PlanarClipMaskSettings]] collects the geometry used to mask a model.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum PlanarClipMaskMode {\r\n  /** No masking. */\r\n  None = 0,\r\n  /** Mask based on priority. Different types of models have different default priorities as enumerated by [[PlanarClipMaskPriority]].\r\n   * For example, background maps have the lowest priority, so they are masked by all other types, while design models have the highest priority and are therefore never masked.\r\n   * The priority of a reality model can be overridden by [[PlanarClipMaskSettings.priority]]. This is useful to allow one reality model to mask another overlapping one.\r\n   * Everything visible in the view creates the mask, so turning off models, categories, or elements (via fully transparent overrides) will make things not be in the mask.\r\n   */\r\n  Priority = 1,\r\n  /** Indicates that masks should be produced from the geometry in a set of [GeometricModel]($backend)s, regardless of what model is on or off in the view.\r\n   * However, things that are off from category settings or element feature overrides in the view will not be in the mask for these models.\r\n   */\r\n  Models = 2,\r\n  /** Indicates that masks should be produced from geometry belonging to a set of subcategories.\r\n   * View settings do not affect what is in the mask, unless [[PlanarClipMaskSettings.subCategoryOrElementIds]] is undefined, in which case it behaves like Models mode.\r\n   */\r\n  IncludeSubCategories = 3,\r\n  /** Indicates that masks should be produced from the geometry of a set of [GeometricElement]($backend)s.\r\n   * View settings do not affect what is in the mask, unless [[PlanarClipMaskSettings.subCategoryOrElementIds]] is undefined, in which case it behaves like Models mode.\r\n   */\r\n  IncludeElements = 4,\r\n  /** Indicates that masks should be produced from the geometry of all [GeometricElement]($backend)s in a view, **except** for a specified set of excluded elements.\r\n   * View settings do not affect what is in the mask, unless [[PlanarClipMaskSettings.subCategoryOrElementIds]] is undefined, in which case it behaves like Models mode.\r\n   */\r\n  ExcludeElements = 5,\r\n}\r\n\r\n/** The default priority values for a [[PlanarClipMaskSettings]], based on model type. Models with a lower priority are masked by models with a higher priority.\r\n * The default can be overridden by [[PlanarClipMaskSettings.priority]].\r\n *  @public\r\n * @extensions\r\n */\r\nexport enum PlanarClipMaskPriority {\r\n  /** Background map. */\r\n  BackgroundMap = -2048,\r\n  /** A reality model that spans the globe - e.g., OpenStreetMaps Buildings. */\r\n  GlobalRealityModel = -1024,\r\n  /** A reality model with a bounded range. */\r\n  RealityModel = 0,\r\n  /** A design model stored in the [IModelDb]($backend). */\r\n  DesignModel = 2048,\r\n}\r\n\r\n/** JSON representation of a [[PlanarClipMaskSettings]].\r\n * @see [[DisplayStyleSettingsProps.planarClipOvr]] and [[ContextRealityModelProps.planarClipMask]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface PlanarClipMaskProps {\r\n  /** Controls how the mask geometry is collected */\r\n  mode: PlanarClipMaskMode;\r\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\r\n  modelIds?: CompressedId64Set;\r\n  /** See [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\r\n  subCategoryOrElementIds?: CompressedId64Set;\r\n  /** See [[PlanarClipMaskSettings.priority]]. */\r\n  priority?: number;\r\n  /** See [[PlanarClipMaskSettings.transparency]]. */\r\n  transparency?: number;\r\n  /** See PlanarClipMaskSettings.invert */\r\n  invert?: boolean;\r\n}\r\n\r\n/** Basic arguments supplied to [[PlanarClipMaskSettings.create]].\r\n * @public\r\n */\r\nexport interface BasicPlanarClipMaskArgs {\r\n  /** See [[PlanarClipMaskSettings.transparency]]. */\r\n  transparency?: number;\r\n  /** See [[PlanarClipMaskSettings.invert]]. */\r\n  invert?: boolean;\r\n}\r\n\r\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Models]].\r\n * @public\r\n */\r\nexport interface ModelPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\r\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\r\n  modelIds?: Iterable<Id64String>;\r\n  exclude?: never;\r\n  elementIds?: never;\r\n  subCategoryIds?: never;\r\n  priority?: never;\r\n}\r\n\r\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludeElements]].\r\n * @public\r\n */\r\nexport interface ElementPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\r\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\r\n  modelIds?: Iterable<Id64String>;\r\n  /** The elements used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\r\n  elementIds: Iterable<Id64String>;\r\n  /** If true, creates a mask of [[PlanarClipMaskMode.ExcludeElements]]; otherwise, [[PlanarClipMaskMode.IncludeElements]]. */\r\n  exclude?: boolean;\r\n  subCategoryIds?: never;\r\n  priority?: never;\r\n}\r\n\r\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.IncludeSubCategories]].\r\n * @public\r\n */\r\nexport interface SubCategoryPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\r\n  /** See [[PlanarClipMaskSettings.modelIds]]. */\r\n  modelIds?: Iterable<Id64String>;\r\n  /** The subcategories used by the mask. @see [[PlanarClipMaskSettings.subCategoryOrElementIds]]. */\r\n  subCategoryIds: Iterable<Id64String>;\r\n  exclude?: never;\r\n  elementIds?: never;\r\n  priority?: never;\r\n}\r\n\r\n/** Arguments supplied to [[PlanarClipMaskSettings.create]] to create a mask of [[PlanarClipMaskMode.Priority]].\r\n * @public\r\n */\r\nexport interface PriorityPlanarClipMaskArgs extends BasicPlanarClipMaskArgs {\r\n  /** See [[PlanarClipMaskSettings.priority]]. */\r\n  priority: number;\r\n  exclude?: never;\r\n  elementIds?: never;\r\n  modelIds?: never;\r\n}\r\n\r\n/** Describes how to mask the geometry of one [GeometricModel]($backend) for display. The mask is produced by projecting geometry from any number of other models -\r\n * optionally filtered by [SubCategory]($backend) or by a set of specific [GeometricElement]($backend)s - onto a plane. Regions of the masked model that intersect the\r\n * mask are rendered partially or completely transparent. This is useful for, e.g., making subsurface geometry visible below the background map, or clipping out portions\r\n * of a reality model that intersect a design model.\r\n * @note Currently reality models (including background maps and terrain) can be masked, but design models can only produce masks.\r\n * @see [[DisplayStyleSettings.planarClipMasks]] to define clip masks for a [DisplayStyle]($backend).\r\n * @see [[ContextRealityModel.planarClipMaskSettings]] to apply a clip mask to a context reality model.\r\n * @public\r\n */\r\nexport class PlanarClipMaskSettings {\r\n  /** Specifies how the mask geometry is produced. */\r\n  public readonly mode: PlanarClipMaskMode;\r\n  /** For any mode other than [[PlanarClipMaskMode.Priority]], the Ids of the [GeometricModel]($backend)s containing the geometry used to produce the mask,\r\n   * and if `undefined`, no mask geometry will be created.\r\n   * The mask geometry can be filtered by [[subCategoryOrElementIds]].\r\n   */\r\n  public readonly modelIds?: OrderedId64Iterable;\r\n  /** For [[PlanarClipMaskMode.IncludeElements]] or [[PlanarClipMaskMode.ExcludedElements]], the Ids of the [GeometricElement]($backend)s to include or exclude from masking;\r\n   * for [[PlanarClipMaskMode.IncludeSubCategories]], the Ids of the subcategories whose geometry contributes to the mask.\r\n   * If undefined, Modes IncludeSubCategories, IncludeElements, and ExcludeElements behave like Models mode.\r\n   */\r\n  public readonly subCategoryOrElementIds?: OrderedId64Iterable;\r\n  /** For [[PlanarClipMaskMode.Priority]], the priority value. */\r\n  public readonly priority?: number;\r\n  /** A value between 0 and 1 indicating an override for mask transparency. A transparency of 0 indicates complete masking. 1 is completely transparent (no masking).\r\n   If no transparency is defined then the transparencies of the mask elements are used.\r\n   */\r\n  public readonly transparency?: number;\r\n  /** A value of true indicates that the mask should be inverted and only content within the mask should be displayed, in other words the area inside the mask is displayed rather than outside. */\r\n  public readonly invert: boolean;\r\n  private readonly _modelIds?: CompressedId64Set;\r\n  private readonly _subCategoryOrElementIds?: CompressedId64Set;\r\n\r\n  /** The compressed representation of [[modelIds]]. */\r\n  public get compressedModelIds(): CompressedId64Set | undefined {\r\n    return this._modelIds;\r\n  }\r\n\r\n  /** Create a new [[PlanarClipMaskSettings]] object from its JSON representation. */\r\n  public static fromJSON(json?: PlanarClipMaskProps): PlanarClipMaskSettings {\r\n    if (!json || undefined === json.mode)\r\n      return this.defaults;\r\n\r\n    return new PlanarClipMaskSettings(json.mode, json.transparency, json.modelIds, json.subCategoryOrElementIds, json.priority, json.invert);\r\n  }\r\n\r\n  /** Create a new PlanarClipMaskSettings. */\r\n  public static create(args: ModelPlanarClipMaskArgs | ElementPlanarClipMaskArgs | SubCategoryPlanarClipMaskArgs | PriorityPlanarClipMaskArgs): PlanarClipMaskSettings {\r\n    const modelIds = args.modelIds ? CompressedId64Set.sortAndCompress(args.modelIds) : undefined;\r\n    if (undefined !== args.priority)\r\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.Priority, args.transparency, undefined, undefined, args.priority, args.invert);\r\n    else if (undefined !== args.subCategoryIds)\r\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.IncludeSubCategories, args.transparency, modelIds, CompressedId64Set.sortAndCompress(args.subCategoryIds), undefined, args.invert);\r\n    else if (undefined !== args.elementIds)\r\n      return new PlanarClipMaskSettings(args.exclude ? PlanarClipMaskMode.ExcludeElements : PlanarClipMaskMode.IncludeElements, args.transparency, modelIds, CompressedId64Set.sortAndCompress(args.elementIds), undefined, args.invert);\r\n    else\r\n      return new PlanarClipMaskSettings(PlanarClipMaskMode.Models, args.transparency, modelIds, undefined, undefined, args.invert);\r\n  }\r\n\r\n  /** Create JSON object representing this [[PlanarClipMaskSettings]] */\r\n  public toJSON(): PlanarClipMaskProps {\r\n    const props: PlanarClipMaskProps = { mode: this.mode };\r\n    if (undefined !== this._modelIds)\r\n      props.modelIds = this._modelIds;\r\n\r\n    if (undefined !== this._subCategoryOrElementIds)\r\n      props.subCategoryOrElementIds = this._subCategoryOrElementIds;\r\n\r\n    if (undefined !== this.priority)\r\n      props.priority = this.priority;\r\n\r\n    if (undefined !== this.transparency)\r\n      props.transparency = this.transparency;\r\n\r\n    if (this.invert)\r\n      props.invert = true;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if masking is enabled. */\r\n  public get isValid(): boolean {\r\n    return this.mode !== PlanarClipMaskMode.None;\r\n  }\r\n\r\n  public equals(other: PlanarClipMaskSettings): boolean {\r\n    return this.mode === other.mode &&\r\n      this.priority === other.priority &&\r\n      this.transparency === other.transparency &&\r\n      this.invert === other.invert &&\r\n      this._modelIds === other._modelIds &&\r\n      this._subCategoryOrElementIds === other._subCategoryOrElementIds;\r\n  }\r\n\r\n  /** Create a copy of this TerrainSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A PlanarClipMaskSettings with all of its properties set to match those of`this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps?: PlanarClipMaskProps): PlanarClipMaskSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    return PlanarClipMaskSettings.fromJSON({\r\n      ...this.toJSON(),\r\n      ...changedProps,\r\n    });\r\n  }\r\n\r\n  private constructor(mode: PlanarClipMaskMode, transparency?: number, modelIds?: CompressedId64Set, subCategoryOrElementIds?: CompressedId64Set, priority?: number, invert?: boolean) {\r\n    this.mode = mode;\r\n    this._modelIds = modelIds;\r\n    this._subCategoryOrElementIds = subCategoryOrElementIds;\r\n    this.priority = priority;\r\n    this.invert = true === invert;\r\n    this.transparency = undefined !== transparency ? Math.max(0, Math.min(1, transparency)) : undefined;\r\n\r\n    if (modelIds)\r\n      this.modelIds = CompressedId64Set.iterable(modelIds);\r\n\r\n    if (subCategoryOrElementIds)\r\n      this.subCategoryOrElementIds = CompressedId64Set.iterable(subCategoryOrElementIds);\r\n  }\r\n\r\n  /** A default PlanarClipMask which masks nothing. */\r\n  public static defaults = new PlanarClipMaskSettings(PlanarClipMaskMode.None);\r\n}\r\n"]}