@itwin/core-common 3.6.0-dev.5 → 3.6.0-dev.50

package/lib/cjs/EntityProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"EntityProps.js","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAuD;AACvD,wDAAwD;AACxD,iDAAgD;AA6DhD;;GAEG;AACH,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,2EAAoB,CAAA;IACpB,+DAAc,CAAA;IACd,iEAAe,CAAA;IACf,mEAAgB,CAAA;IAChB,gEAAc,CAAA;IACd,kEAAe,CAAA;IACf,4DAAY,CAAA;IACZ,kEAAe,CAAA;IACf,kEAAe,CAAA;IACf,gEAAc,CAAA;AAChB,CAAC,EAXW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAW5B;AAyCD;;GAEG;AACH,MAAa,gBAAgB;IAoB3B,YAAmB,OAA8B;QAC/C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC3C,IAAI,OAAO,CAAC,UAAU;YACpB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IACnD,CAAC;IAED,mFAAmF;IAC3E,kBAAkB,CAAC,IAAiB,EAAE,OAAY;QACxD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;QAEvC,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,OAAO,CAAC,OAAO,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3D,OAAO,GAAG,CAAC;IACb,CAAC;IAED,kFAAkF;IAC3E,cAAc,CAAC,OAAY;QAChC,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,EAAE;YACpC,QAAQ,IAAI,CAAC,aAAa,EAAE;gBAC1B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM,CAAC;gBAC9B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM;oBAC3B,OAAO,OAAO,CAAC,CAAC,wGAAwG;gBAE1H,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,uBAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAE5D,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,uBAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;aAC7D;SACF;QACD,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO,OAAO,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,6BAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,mBAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEzF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,8DAA8D;IAC9D,IAAW,YAAY;QACrB,OAAO,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,gEAAgE;IACzG,CAAC;CACF;AAvFD,4CAuFC;AAgBD;;GAEG;AACH,MAAa,cAAc;IAazB,YAAmB,OAA4B;QAC7C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QAErB,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE,EAAE,mCAAmC;YAC9E,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;SAChF;IACH,CAAC;CACF;AA1BD,wCA0BC","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 { Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { Point2d, Point3d } from \"@itwin/core-geometry\";\r\nimport { RelatedElement } from \"./ElementProps\";\r\n\r\n/** The persistent format of an [Entity]($backend), also used as the \"wire format\" when transmitting information about entities\r\n * between the backend and frontend.\r\n * EntityProps and all of its sub-types like [[ElementProps]] are \"plain old Javascript objects\" - that is, objects containing\r\n * no methods and no properties of `class` type.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface EntityProps {\r\n  /** A non-existent property used to discriminate between [[EntityProps]] and [Entity]($backend).\r\n   * @see [Entity.isInstanceOfEntity]($backend).\r\n   */\r\n  readonly isInstanceOfEntity?: never;\r\n  /** The full name of the [ECClass]($docs/bis/guide/references/glossary/#ecclass) for this entity, in the form \"Schema:ClassName\" */\r\n  classFullName: string;\r\n  /** The Id of the entity. Must be present for SELECT, UPDATE, or DELETE, ignored for INSERT. */\r\n  id?: Id64String;\r\n  /** Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this Entity. */\r\n  jsonProperties?: { [key: string]: any };\r\n}\r\n\r\n/** Specifies the source and target elements of a [[Relationship]] instance.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SourceAndTarget {\r\n  sourceId: Id64String;\r\n  targetId: Id64String;\r\n}\r\n\r\n/** Properties that are common to all types of link table ECRelationships\r\n * @public\r\n * @extensions\r\n */\r\nexport interface RelationshipProps extends EntityProps, SourceAndTarget {\r\n}\r\n\r\n/** Parameters for performing a query on [Entity]($backend) classes.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface EntityQueryParams {\r\n  /** The sql className, in the form \"Schema.ClassName\", of the class to search. */\r\n  from?: string;\r\n  /** Set to true to limit results to *not* include sub-classes of \"from\" class */\r\n  only?: boolean;\r\n  /** Optional \"WHERE\" clause to filter entities. Note: do *not* include the \"WHERE\" keyword. */\r\n  where?: string;\r\n  /** Optional \"ORDERBY\" clause to sort results. Note: do *not* include the \"ORDERBY\" keyword. */\r\n  orderBy?: string;\r\n  /** Optional \"LIMIT\" clause to limit the number of rows returned. */\r\n  limit?: number;\r\n  /** Optional \"OFFSET\" clause. Only valid if Limit is also present. */\r\n  offset?: number;\r\n  /** Bindings for parameterized values.\r\n   * @see [[ECSqlStatement.bindValues]]\r\n   */\r\n  bindings?: any[] | object;\r\n}\r\n\r\n/** The primitive types of an Entity property.\r\n * @beta\r\n */\r\nexport enum PrimitiveTypeCode {\r\n  Uninitialized = 0x00,\r\n  Binary = 0x101,\r\n  Boolean = 0x201,\r\n  DateTime = 0x301,\r\n  Double = 0x401,\r\n  Integer = 0x501,\r\n  Long = 0x601,\r\n  Point2d = 0x701, // eslint-disable-line @typescript-eslint/no-shadow\r\n  Point3d = 0x801, // eslint-disable-line @typescript-eslint/no-shadow\r\n  String = 0x901,\r\n}\r\n\r\n/** A callback function to process properties of an Entity\r\n * @beta\r\n */\r\nexport type PropertyCallback = (name: string, meta: PropertyMetaData) => void;\r\n\r\n/** A custom attribute instance\r\n * @beta\r\n */\r\nexport interface CustomAttribute {\r\n  /** The class of the CustomAttribute */\r\n  ecclass: string;\r\n  /** An object whose properties correspond by name to the properties of this custom attribute instance. */\r\n  properties: { [propName: string]: any };\r\n}\r\n\r\ntype FactoryFunc = (jsonObj: any) => any;\r\n\r\n/** @beta */\r\nexport interface PropertyMetaDataProps {\r\n  primitiveType?: number;\r\n  structName?: string;\r\n  extendedType?: string;\r\n  description?: string;\r\n  displayLabel?: string;\r\n  minimumValue?: any;\r\n  maximumValue?: any;\r\n  minimumLength?: number;\r\n  maximumLength?: number;\r\n  readOnly?: boolean;\r\n  kindOfQuantity?: string;\r\n  isCustomHandled?: boolean;\r\n  isCustomHandledOrphan?: boolean;\r\n  minOccurs?: number;\r\n  maxOccurs?: number;\r\n  direction?: string;\r\n  relationshipClass?: string;\r\n  customAttributes?: CustomAttribute[];\r\n}\r\n\r\n/** Metadata for a property.\r\n * @beta\r\n */\r\nexport class PropertyMetaData implements PropertyMetaDataProps {\r\n  public primitiveType?: PrimitiveTypeCode;\r\n  public structName?: string;\r\n  public extendedType?: string;\r\n  public description?: string;\r\n  public displayLabel?: string;\r\n  public minimumValue?: any;\r\n  public maximumValue?: any;\r\n  public minimumLength?: number;\r\n  public maximumLength?: number;\r\n  public readOnly?: boolean;\r\n  public kindOfQuantity?: string;\r\n  public isCustomHandled?: boolean;\r\n  public isCustomHandledOrphan?: boolean;\r\n  public minOccurs?: number;\r\n  public maxOccurs?: number;\r\n  public direction?: string;\r\n  public relationshipClass?: string;\r\n  public customAttributes?: CustomAttribute[];\r\n\r\n  public constructor(jsonObj: PropertyMetaDataProps) {\r\n    this.primitiveType = jsonObj.primitiveType;\r\n    if (jsonObj.structName)\r\n      this.structName = jsonObj.structName;\r\n    this.extendedType = jsonObj.extendedType;\r\n    this.description = jsonObj.description;\r\n    this.displayLabel = jsonObj.displayLabel;\r\n    if (undefined !== jsonObj.minimumValue)\r\n      this.minimumValue = jsonObj.minimumValue;\r\n    if (undefined !== jsonObj.maximumValue)\r\n      this.maximumValue = jsonObj.maximumValue;\r\n    if (undefined !== jsonObj.minimumLength)\r\n      this.minimumLength = jsonObj.minimumLength;\r\n    if (undefined !== jsonObj.maximumLength)\r\n      this.maximumLength = jsonObj.maximumLength;\r\n    this.readOnly = jsonObj.readOnly;\r\n    this.kindOfQuantity = jsonObj.kindOfQuantity;\r\n    this.isCustomHandled = jsonObj.isCustomHandled;\r\n    if (undefined !== jsonObj.minOccurs)\r\n      this.minOccurs = jsonObj.minOccurs;\r\n    if (undefined !== jsonObj.maxOccurs)\r\n      this.maxOccurs = jsonObj.maxOccurs;\r\n    this.direction = jsonObj.direction;\r\n    this.relationshipClass = jsonObj.relationshipClass;\r\n    this.customAttributes = jsonObj.customAttributes;\r\n  }\r\n\r\n  /** Create a typed value, or array of values, from a factory and an input object */\r\n  private createValueOrArray(func: FactoryFunc, jsonObj: any) {\r\n    if (undefined === this.minOccurs)\r\n      return func(jsonObj); // not an array\r\n\r\n    const val: any = [];\r\n    jsonObj.forEach((element: any) => val.push(func(element)));\r\n    return val;\r\n  }\r\n\r\n  /** construct a single property from an input object according to this metadata */\r\n  public createProperty(jsonObj: any): any {\r\n    if (jsonObj === undefined)\r\n      return undefined;\r\n\r\n    if (undefined !== this.primitiveType) {\r\n      switch (this.primitiveType) {\r\n        case PrimitiveTypeCode.Boolean:\r\n        case PrimitiveTypeCode.Double:\r\n        case PrimitiveTypeCode.Integer:\r\n        case PrimitiveTypeCode.String:\r\n          return jsonObj; // this works even for arrays or strings that are JSON because the parsed JSON is already the right type\r\n\r\n        case PrimitiveTypeCode.Point2d:\r\n          return this.createValueOrArray(Point2d.fromJSON, jsonObj);\r\n\r\n        case PrimitiveTypeCode.Point3d:\r\n          return this.createValueOrArray(Point3d.fromJSON, jsonObj);\r\n      }\r\n    }\r\n    if (this.isNavigation)\r\n      return jsonObj.id !== undefined ? new RelatedElement(jsonObj) : Id64.fromJSON(jsonObj);\r\n\r\n    return jsonObj;\r\n  }\r\n\r\n  /** Return `true` if this property is a NavigationProperty. */\r\n  public get isNavigation(): boolean {\r\n    return (this.direction !== undefined); // the presence of `direction` means it is a navigation property\r\n  }\r\n}\r\n\r\n/** @beta */\r\nexport interface EntityMetaDataProps {\r\n  ecclass: string;\r\n  description?: string;\r\n  modifier?: string;\r\n  displayLabel?: string;\r\n  /** The  base classes from which this class derives. If more than one, the first is the super class and the others are [mixins]($docs/bis/ec/ec-mixin-class). */\r\n  baseClasses: string[];\r\n  /** The Custom Attributes for this class */\r\n  customAttributes?: CustomAttribute[];\r\n  /** An object whose properties correspond by name to the properties of this class. */\r\n  properties: { [propName: string]: PropertyMetaData };\r\n}\r\n\r\n/** Metadata for an Entity.\r\n * @beta\r\n */\r\nexport class EntityMetaData implements EntityMetaDataProps {\r\n  /** The Entity name */\r\n  public readonly ecclass: string;\r\n  public readonly description?: string;\r\n  public readonly modifier?: string;\r\n  public readonly displayLabel?: string;\r\n  /** The  base class that this class is derives from. If more than one, the first is the actual base class and the others are mixins. */\r\n  public readonly baseClasses: string[];\r\n  /** The Custom Attributes for this class */\r\n  public readonly customAttributes?: CustomAttribute[];\r\n  /** An object whose properties correspond by name to the properties of this class. */\r\n  public readonly properties: { [propName: string]: PropertyMetaData };\r\n\r\n  public constructor(jsonObj: EntityMetaDataProps) {\r\n    this.ecclass = jsonObj.ecclass;\r\n    this.description = jsonObj.description;\r\n    this.modifier = jsonObj.modifier;\r\n    this.displayLabel = jsonObj.displayLabel;\r\n    this.baseClasses = jsonObj.baseClasses;\r\n    this.customAttributes = jsonObj.customAttributes;\r\n    this.properties = {};\r\n\r\n    for (const propName in jsonObj.properties) { // eslint-disable-line guard-for-in\r\n      this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"EntityProps.js","sourceRoot":"","sources":["../../src/EntityProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAuD;AACvD,wDAAwD;AACxD,iDAAgD;AA6DhD;;GAEG;AACH,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,2EAAoB,CAAA;IACpB,+DAAc,CAAA;IACd,iEAAe,CAAA;IACf,mEAAgB,CAAA;IAChB,gEAAc,CAAA;IACd,kEAAe,CAAA;IACf,4DAAY,CAAA;IACZ,kEAAe,CAAA;IACf,kEAAe,CAAA;IACf,gEAAc,CAAA;IACd,sEAAiB,CAAA;AACnB,CAAC,EAZW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAY5B;AAyCD;;GAEG;AACH,MAAa,gBAAgB;IAoB3B,YAAmB,OAA8B;QAC/C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC3C,IAAI,OAAO,CAAC,UAAU;YACpB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,YAAY;YACpC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,SAAS,KAAK,OAAO,CAAC,aAAa;YACrC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAC/C,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,SAAS,KAAK,OAAO,CAAC,SAAS;YACjC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IACnD,CAAC;IAED,mFAAmF;IAC3E,kBAAkB,CAAC,IAAiB,EAAE,OAAY;QACxD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe;QAEvC,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,OAAO,CAAC,OAAO,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3D,OAAO,GAAG,CAAC;IACb,CAAC;IAED,kFAAkF;IAC3E,cAAc,CAAC,OAAY;QAChC,IAAI,OAAO,KAAK,SAAS;YACvB,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,KAAK,IAAI,CAAC,aAAa,EAAE;YACpC,QAAQ,IAAI,CAAC,aAAa,EAAE;gBAC1B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM,CAAC;gBAC9B,KAAK,iBAAiB,CAAC,OAAO,CAAC;gBAC/B,KAAK,iBAAiB,CAAC,MAAM;oBAC3B,OAAO,OAAO,CAAC,CAAC,wGAAwG;gBAE1H,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,uBAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAE5D,KAAK,iBAAiB,CAAC,OAAO;oBAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,uBAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;aAC7D;SACF;QACD,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO,OAAO,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,6BAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,mBAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEzF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,8DAA8D;IAC9D,IAAW,YAAY;QACrB,OAAO,CAAC,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,gEAAgE;IACzG,CAAC;CACF;AAvFD,4CAuFC;AAgBD;;GAEG;AACH,MAAa,cAAc;IAazB,YAAmB,OAA4B;QAC7C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QAErB,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE,EAAE,mCAAmC;YAC9E,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;SAChF;IACH,CAAC;CACF;AA1BD,wCA0BC","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 { Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { Point2d, Point3d } from \"@itwin/core-geometry\";\r\nimport { RelatedElement } from \"./ElementProps\";\r\n\r\n/** The persistent format of an [Entity]($backend), also used as the \"wire format\" when transmitting information about entities\r\n * between the backend and frontend.\r\n * EntityProps and all of its sub-types like [[ElementProps]] are \"plain old Javascript objects\" - that is, objects containing\r\n * no methods and no properties of `class` type.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface EntityProps {\r\n  /** A non-existent property used to discriminate between [[EntityProps]] and [Entity]($backend).\r\n   * @see [Entity.isInstanceOfEntity]($backend).\r\n   */\r\n  readonly isInstanceOfEntity?: never;\r\n  /** The full name of the [ECClass]($docs/bis/guide/references/glossary/#ecclass) for this entity, in the form \"Schema:ClassName\" */\r\n  classFullName: string;\r\n  /** The Id of the entity. Must be present for SELECT, UPDATE, or DELETE, ignored for INSERT. */\r\n  id?: Id64String;\r\n  /** Optional [json properties]($docs/bis/guide/fundamentals/element-fundamentals.md#jsonproperties) of this Entity. */\r\n  jsonProperties?: { [key: string]: any };\r\n}\r\n\r\n/** Specifies the source and target elements of a [[Relationship]] instance.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SourceAndTarget {\r\n  sourceId: Id64String;\r\n  targetId: Id64String;\r\n}\r\n\r\n/** Properties that are common to all types of link table ECRelationships\r\n * @public\r\n * @extensions\r\n */\r\nexport interface RelationshipProps extends EntityProps, SourceAndTarget {\r\n}\r\n\r\n/** Parameters for performing a query on [Entity]($backend) classes.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface EntityQueryParams {\r\n  /** The sql className, in the form \"Schema.ClassName\", of the class to search. */\r\n  from?: string;\r\n  /** Set to true to limit results to *not* include sub-classes of \"from\" class */\r\n  only?: boolean;\r\n  /** Optional \"WHERE\" clause to filter entities. Note: do *not* include the \"WHERE\" keyword. */\r\n  where?: string;\r\n  /** Optional \"ORDERBY\" clause to sort results. Note: do *not* include the \"ORDERBY\" keyword. */\r\n  orderBy?: string;\r\n  /** Optional \"LIMIT\" clause to limit the number of rows returned. */\r\n  limit?: number;\r\n  /** Optional \"OFFSET\" clause. Only valid if Limit is also present. */\r\n  offset?: number;\r\n  /** Bindings for parameterized values.\r\n   * @see [[ECSqlStatement.bindValues]]\r\n   */\r\n  bindings?: any[] | object;\r\n}\r\n\r\n/** The primitive types of an Entity property.\r\n * @beta\r\n */\r\nexport enum PrimitiveTypeCode {\r\n  Uninitialized = 0x00,\r\n  Binary = 0x101,\r\n  Boolean = 0x201,\r\n  DateTime = 0x301,\r\n  Double = 0x401,\r\n  Integer = 0x501,\r\n  Long = 0x601,\r\n  Point2d = 0x701, // eslint-disable-line @typescript-eslint/no-shadow\r\n  Point3d = 0x801, // eslint-disable-line @typescript-eslint/no-shadow\r\n  String = 0x901,\r\n  IGeometry = 0xa01, // Used for Bentley.Geometry.Common.IGeometry types\r\n}\r\n\r\n/** A callback function to process properties of an Entity\r\n * @beta\r\n */\r\nexport type PropertyCallback = (name: string, meta: PropertyMetaData) => void;\r\n\r\n/** A custom attribute instance\r\n * @beta\r\n */\r\nexport interface CustomAttribute {\r\n  /** The class of the CustomAttribute */\r\n  ecclass: string;\r\n  /** An object whose properties correspond by name to the properties of this custom attribute instance. */\r\n  properties: { [propName: string]: any };\r\n}\r\n\r\ntype FactoryFunc = (jsonObj: any) => any;\r\n\r\n/** @beta */\r\nexport interface PropertyMetaDataProps {\r\n  primitiveType?: number;\r\n  structName?: string;\r\n  extendedType?: string;\r\n  description?: string;\r\n  displayLabel?: string;\r\n  minimumValue?: any;\r\n  maximumValue?: any;\r\n  minimumLength?: number;\r\n  maximumLength?: number;\r\n  readOnly?: boolean;\r\n  kindOfQuantity?: string;\r\n  isCustomHandled?: boolean;\r\n  isCustomHandledOrphan?: boolean;\r\n  minOccurs?: number;\r\n  maxOccurs?: number;\r\n  direction?: string;\r\n  relationshipClass?: string;\r\n  customAttributes?: CustomAttribute[];\r\n}\r\n\r\n/** Metadata for a property.\r\n * @beta\r\n */\r\nexport class PropertyMetaData implements PropertyMetaDataProps {\r\n  public primitiveType?: PrimitiveTypeCode;\r\n  public structName?: string;\r\n  public extendedType?: string;\r\n  public description?: string;\r\n  public displayLabel?: string;\r\n  public minimumValue?: any;\r\n  public maximumValue?: any;\r\n  public minimumLength?: number;\r\n  public maximumLength?: number;\r\n  public readOnly?: boolean;\r\n  public kindOfQuantity?: string;\r\n  public isCustomHandled?: boolean;\r\n  public isCustomHandledOrphan?: boolean;\r\n  public minOccurs?: number;\r\n  public maxOccurs?: number;\r\n  public direction?: string;\r\n  public relationshipClass?: string;\r\n  public customAttributes?: CustomAttribute[];\r\n\r\n  public constructor(jsonObj: PropertyMetaDataProps) {\r\n    this.primitiveType = jsonObj.primitiveType;\r\n    if (jsonObj.structName)\r\n      this.structName = jsonObj.structName;\r\n    this.extendedType = jsonObj.extendedType;\r\n    this.description = jsonObj.description;\r\n    this.displayLabel = jsonObj.displayLabel;\r\n    if (undefined !== jsonObj.minimumValue)\r\n      this.minimumValue = jsonObj.minimumValue;\r\n    if (undefined !== jsonObj.maximumValue)\r\n      this.maximumValue = jsonObj.maximumValue;\r\n    if (undefined !== jsonObj.minimumLength)\r\n      this.minimumLength = jsonObj.minimumLength;\r\n    if (undefined !== jsonObj.maximumLength)\r\n      this.maximumLength = jsonObj.maximumLength;\r\n    this.readOnly = jsonObj.readOnly;\r\n    this.kindOfQuantity = jsonObj.kindOfQuantity;\r\n    this.isCustomHandled = jsonObj.isCustomHandled;\r\n    if (undefined !== jsonObj.minOccurs)\r\n      this.minOccurs = jsonObj.minOccurs;\r\n    if (undefined !== jsonObj.maxOccurs)\r\n      this.maxOccurs = jsonObj.maxOccurs;\r\n    this.direction = jsonObj.direction;\r\n    this.relationshipClass = jsonObj.relationshipClass;\r\n    this.customAttributes = jsonObj.customAttributes;\r\n  }\r\n\r\n  /** Create a typed value, or array of values, from a factory and an input object */\r\n  private createValueOrArray(func: FactoryFunc, jsonObj: any) {\r\n    if (undefined === this.minOccurs)\r\n      return func(jsonObj); // not an array\r\n\r\n    const val: any = [];\r\n    jsonObj.forEach((element: any) => val.push(func(element)));\r\n    return val;\r\n  }\r\n\r\n  /** construct a single property from an input object according to this metadata */\r\n  public createProperty(jsonObj: any): any {\r\n    if (jsonObj === undefined)\r\n      return undefined;\r\n\r\n    if (undefined !== this.primitiveType) {\r\n      switch (this.primitiveType) {\r\n        case PrimitiveTypeCode.Boolean:\r\n        case PrimitiveTypeCode.Double:\r\n        case PrimitiveTypeCode.Integer:\r\n        case PrimitiveTypeCode.String:\r\n          return jsonObj; // this works even for arrays or strings that are JSON because the parsed JSON is already the right type\r\n\r\n        case PrimitiveTypeCode.Point2d:\r\n          return this.createValueOrArray(Point2d.fromJSON, jsonObj);\r\n\r\n        case PrimitiveTypeCode.Point3d:\r\n          return this.createValueOrArray(Point3d.fromJSON, jsonObj);\r\n      }\r\n    }\r\n    if (this.isNavigation)\r\n      return jsonObj.id !== undefined ? new RelatedElement(jsonObj) : Id64.fromJSON(jsonObj);\r\n\r\n    return jsonObj;\r\n  }\r\n\r\n  /** Return `true` if this property is a NavigationProperty. */\r\n  public get isNavigation(): boolean {\r\n    return (this.direction !== undefined); // the presence of `direction` means it is a navigation property\r\n  }\r\n}\r\n\r\n/** @beta */\r\nexport interface EntityMetaDataProps {\r\n  ecclass: string;\r\n  description?: string;\r\n  modifier?: string;\r\n  displayLabel?: string;\r\n  /** The  base classes from which this class derives. If more than one, the first is the super class and the others are [mixins]($docs/bis/ec/ec-mixin-class). */\r\n  baseClasses: string[];\r\n  /** The Custom Attributes for this class */\r\n  customAttributes?: CustomAttribute[];\r\n  /** An object whose properties correspond by name to the properties of this class. */\r\n  properties: { [propName: string]: PropertyMetaData };\r\n}\r\n\r\n/** Metadata for an Entity.\r\n * @beta\r\n */\r\nexport class EntityMetaData implements EntityMetaDataProps {\r\n  /** The Entity name */\r\n  public readonly ecclass: string;\r\n  public readonly description?: string;\r\n  public readonly modifier?: string;\r\n  public readonly displayLabel?: string;\r\n  /** The  base class that this class is derives from. If more than one, the first is the actual base class and the others are mixins. */\r\n  public readonly baseClasses: string[];\r\n  /** The Custom Attributes for this class */\r\n  public readonly customAttributes?: CustomAttribute[];\r\n  /** An object whose properties correspond by name to the properties of this class. */\r\n  public readonly properties: { [propName: string]: PropertyMetaData };\r\n\r\n  public constructor(jsonObj: EntityMetaDataProps) {\r\n    this.ecclass = jsonObj.ecclass;\r\n    this.description = jsonObj.description;\r\n    this.modifier = jsonObj.modifier;\r\n    this.displayLabel = jsonObj.displayLabel;\r\n    this.baseClasses = jsonObj.baseClasses;\r\n    this.customAttributes = jsonObj.customAttributes;\r\n    this.properties = {};\r\n\r\n    for (const propName in jsonObj.properties) { // eslint-disable-line guard-for-in\r\n      this.properties[propName] = new PropertyMetaData(jsonObj.properties[propName]);\r\n    }\r\n  }\r\n}\r\n"]}

package/lib/cjs/IModelError.d.ts

@@ -1,13 +1,19 @@
 /** @packageDocumentation
  * @module iModels
  */
-import { BentleyError, BentleyStatus, BriefcaseStatus, ChangeSetStatus, DbResult, GetMetaDataFunction, IModelStatus, RepositoryStatus, RpcInterfaceStatus } from "@itwin/core-bentley";
-export { BentleyStatus, BentleyError, IModelStatus, BriefcaseStatus, GetMetaDataFunction, LogFunction, DbResult, RepositoryStatus, ChangeSetStatus, RpcInterfaceStatus } from "@itwin/core-bentley";
-/** The error type thrown by this module. See [[IModelStatus]] for `errorNumber` values.
+import { BentleyError, BentleyStatus, BriefcaseStatus, ChangeSetStatus, DbResult, GetMetaDataFunction, IModelStatus } from "@itwin/core-bentley";
+export { BentleyStatus, BentleyError, IModelStatus, BriefcaseStatus, GetMetaDataFunction, LogFunction, DbResult, ChangeSetStatus, } from "@itwin/core-bentley";
+/** Numeric values for common errors produced by iTwin.js APIs, typically provided by [[IModelError]].
+ * The values within each of these `enum`s are guaranteed not to conflict with one another.
+ * @public
+ */
+export declare type IModelErrorNumber = IModelStatus | DbResult | BentleyStatus | BriefcaseStatus | ChangeSetStatus;
+/** The error type thrown by this module.
+ * @see [[IModelErrorNumber]] for commonly-used error codes.
  * @public
  */
 export declare class IModelError extends BentleyError {
-    constructor(errorNumber: number | IModelStatus | DbResult | BentleyStatus | BriefcaseStatus | RepositoryStatus | ChangeSetStatus | RpcInterfaceStatus, message: string, getMetaData?: GetMetaDataFunction);
+    constructor(errorNumber: IModelErrorNumber | number, message: string, getMetaData?: GetMetaDataFunction);
 }
 /** @public */
 export declare class ServerError extends IModelError {

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

@@ -1 +1 @@
-{"version":3,"file":"IModelError.d.ts","sourceRoot":"","sources":["../../src/IModelError.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,EAAE,QAAQ,EAAE,mBAAmB,EAAE,YAAY,EAAE,gBAAgB,EAC5H,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,mBAAmB,EAAE,WAAW,EAAE,QAAQ,EAAE,gBAAgB,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAEpM;;GAEG;AACH,qBAAa,WAAY,SAAQ,YAAY;gBACxB,WAAW,EAAE,MAAM,GAAG,YAAY,GAAG,QAAQ,GAAG,aAAa,GAAG,eAAe,GAAG,gBAAgB,GAAG,eAAe,GAAG,kBAAkB,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,mBAAmB;CAGjN;AAED,cAAc;AACd,qBAAa,WAAY,SAAQ,WAAW;gBACvB,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAIxD;AAED,cAAc;AACd,qBAAa,kBAAmB,SAAQ,WAAW;gBAC9B,OAAO,EAAE,MAAM;CAInC;AAED,cAAc;AACd,qBAAa,YAAa,SAAQ,WAAW;gBACxB,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,mBAAmB;CAIzG;AAED;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;gBAClC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,mBAAmB;CAGtE;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;;CAI9C"}
+{"version":3,"file":"IModelError.d.ts","sourceRoot":"","sources":["../../src/IModelError.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EACL,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,EAAE,QAAQ,EAAE,mBAAmB,EAAE,YAAY,EAC3G,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,eAAe,EAAE,mBAAmB,EAAE,WAAW,EAAE,QAAQ,EAAE,eAAe,GACxH,MAAM,qBAAqB,CAAC;AAE7B;;;GAGG;AACH,oBAAY,iBAAiB,GAAG,YAAY,GAAG,QAAQ,GAAG,aAAa,GAAG,eAAe,GAAG,eAAe,CAAC;AAE5G;;;GAGG;AACH,qBAAa,WAAY,SAAQ,YAAY;gBACxB,WAAW,EAAE,iBAAiB,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,mBAAmB;CAG/G;AAED,cAAc;AACd,qBAAa,WAAY,SAAQ,WAAW;gBACvB,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAIxD;AAED,cAAc;AACd,qBAAa,kBAAmB,SAAQ,WAAW;gBAC9B,OAAO,EAAE,MAAM;CAInC;AAED,cAAc;AACd,qBAAa,YAAa,SAAQ,WAAW;gBACxB,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,mBAAmB;CAIzG;AAED;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;gBAClC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,mBAAmB;CAGtE;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,WAAW;;CAI9C"}

package/lib/cjs/IModelError.js

@@ -7,7 +7,7 @@
  * @module iModels
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NoContentError = exports.ChannelConstraintError = exports.BackendError = exports.ServerTimeoutError = exports.ServerError = exports.IModelError = exports.RpcInterfaceStatus = exports.ChangeSetStatus = exports.RepositoryStatus = exports.DbResult = exports.BriefcaseStatus = exports.IModelStatus = exports.BentleyError = exports.BentleyStatus = void 0;
+exports.NoContentError = exports.ChannelConstraintError = exports.BackendError = exports.ServerTimeoutError = exports.ServerError = exports.IModelError = exports.ChangeSetStatus = exports.DbResult = exports.BriefcaseStatus = exports.IModelStatus = exports.BentleyError = exports.BentleyStatus = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
 var core_bentley_2 = require("@itwin/core-bentley");
 Object.defineProperty(exports, "BentleyStatus", { enumerable: true, get: function () { return core_bentley_2.BentleyStatus; } });
@@ -15,10 +15,9 @@ Object.defineProperty(exports, "BentleyError", { enumerable: true, get: function
 Object.defineProperty(exports, "IModelStatus", { enumerable: true, get: function () { return core_bentley_2.IModelStatus; } });
 Object.defineProperty(exports, "BriefcaseStatus", { enumerable: true, get: function () { return core_bentley_2.BriefcaseStatus; } });
 Object.defineProperty(exports, "DbResult", { enumerable: true, get: function () { return core_bentley_2.DbResult; } });
-Object.defineProperty(exports, "RepositoryStatus", { enumerable: true, get: function () { return core_bentley_2.RepositoryStatus; } });
 Object.defineProperty(exports, "ChangeSetStatus", { enumerable: true, get: function () { return core_bentley_2.ChangeSetStatus; } });
-Object.defineProperty(exports, "RpcInterfaceStatus", { enumerable: true, get: function () { return core_bentley_2.RpcInterfaceStatus; } });
-/** The error type thrown by this module. See [[IModelStatus]] for `errorNumber` values.
+/** The error type thrown by this module.
+ * @see [[IModelErrorNumber]] for commonly-used error codes.
  * @public
  */
 class IModelError extends core_bentley_1.BentleyError {

package/lib/cjs/IModelError.js.map

@@ -1 +1 @@
-{"version":3,"file":"IModelError.js","sourceRoot":"","sources":["../../src/IModelError.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAG6B;AAE7B,oDAAoM;AAA3L,6GAAA,aAAa,OAAA;AAAE,4GAAA,YAAY,OAAA;AAAE,4GAAA,YAAY,OAAA;AAAE,+GAAA,eAAe,OAAA;AAAoC,wGAAA,QAAQ,OAAA;AAAE,gHAAA,gBAAgB,OAAA;AAAE,+GAAA,eAAe,OAAA;AAAE,kHAAA,kBAAkB,OAAA;AAEtK;;GAEG;AACH,MAAa,WAAY,SAAQ,2BAAY;IAC3C,YAAmB,WAAyI,EAAE,OAAe,EAAE,WAAiC;QAC9M,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;CACF;AAJD,kCAIC;AAED,cAAc;AACd,MAAa,WAAY,SAAQ,WAAW;IAC1C,YAAmB,WAAmB,EAAE,OAAe;QACrD,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,iBAAiB,WAAW,GAAG,CAAC;IAC9C,CAAC;CACF;AALD,kCAKC;AAED,cAAc;AACd,MAAa,kBAAmB,SAAQ,WAAW;IACjD,YAAmB,OAAe;QAChC,KAAK,CAAC,2BAAY,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACrC,CAAC;CACF;AALD,gDAKC;AAED,cAAc;AACd,MAAa,YAAa,SAAQ,WAAW;IAC3C,YAAmB,WAAmB,EAAE,IAAY,EAAE,OAAe,EAAE,WAAiC;QACtG,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AALD,oCAKC;AAED;;;GAGG;AACH,MAAa,sBAAuB,SAAQ,WAAW;IACrD,YAAmB,OAAe,EAAE,WAAiC;QACnE,KAAK,CAAC,+BAAgB,CAAC,0BAA0B,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3E,CAAC;CACF;AAJD,wDAIC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,WAAW;IAC7C;QACE,KAAK,CAAC,2BAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;CACF;AAJD,wCAIC","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 iModels\r\n */\r\n\r\nimport {\r\n  BentleyError, BentleyStatus, BriefcaseStatus, ChangeSetStatus, DbResult, GetMetaDataFunction, IModelStatus, RepositoryStatus,\r\n  RpcInterfaceStatus,\r\n} from \"@itwin/core-bentley\";\r\n\r\nexport { BentleyStatus, BentleyError, IModelStatus, BriefcaseStatus, GetMetaDataFunction, LogFunction, DbResult, RepositoryStatus, ChangeSetStatus, RpcInterfaceStatus } from \"@itwin/core-bentley\";\r\n\r\n/** The error type thrown by this module. See [[IModelStatus]] for `errorNumber` values.\r\n * @public\r\n */\r\nexport class IModelError extends BentleyError {\r\n  public constructor(errorNumber: number | IModelStatus | DbResult | BentleyStatus | BriefcaseStatus | RepositoryStatus | ChangeSetStatus | RpcInterfaceStatus, message: string, getMetaData?: GetMetaDataFunction) {\r\n    super(errorNumber, message, getMetaData);\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport class ServerError extends IModelError {\r\n  public constructor(errorNumber: number, message: string) {\r\n    super(errorNumber, message);\r\n    this.name = `Server error (${errorNumber})`;\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport class ServerTimeoutError extends ServerError {\r\n  public constructor(message: string) {\r\n    super(IModelStatus.ServerTimeout, message);\r\n    this.name = \"Server timeout error\";\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport class BackendError extends IModelError {\r\n  public constructor(errorNumber: number, name: string, message: string, getMetaData?: GetMetaDataFunction) {\r\n    super(errorNumber, message, getMetaData);\r\n    this.name = name;\r\n  }\r\n}\r\n\r\n/**\r\n * Channel constraint error\r\n * @alpha\r\n */\r\nexport class ChannelConstraintError extends IModelError {\r\n  public constructor(message: string, getMetaData?: GetMetaDataFunction) {\r\n    super(RepositoryStatus.ChannelConstraintViolation, message, getMetaData);\r\n  }\r\n}\r\n\r\n/** Intended for API \"no content\" semantics where the error case should not trigger application failure monitoring systems.\r\n * @public\r\n */\r\nexport class NoContentError extends IModelError {\r\n  public constructor() {\r\n    super(IModelStatus.NoContent, \"No Content\");\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"IModelError.js","sourceRoot":"","sources":["../../src/IModelError.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAE6B;AAE7B,oDAE6B;AAD3B,6GAAA,aAAa,OAAA;AAAE,4GAAA,YAAY,OAAA;AAAE,4GAAA,YAAY,OAAA;AAAE,+GAAA,eAAe,OAAA;AAAoC,wGAAA,QAAQ,OAAA;AAAE,+GAAA,eAAe,OAAA;AASzH;;;GAGG;AACH,MAAa,WAAY,SAAQ,2BAAY;IAC3C,YAAmB,WAAuC,EAAE,OAAe,EAAE,WAAiC;QAC5G,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;CACF;AAJD,kCAIC;AAED,cAAc;AACd,MAAa,WAAY,SAAQ,WAAW;IAC1C,YAAmB,WAAmB,EAAE,OAAe;QACrD,KAAK,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,iBAAiB,WAAW,GAAG,CAAC;IAC9C,CAAC;CACF;AALD,kCAKC;AAED,cAAc;AACd,MAAa,kBAAmB,SAAQ,WAAW;IACjD,YAAmB,OAAe;QAChC,KAAK,CAAC,2BAAY,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACrC,CAAC;CACF;AALD,gDAKC;AAED,cAAc;AACd,MAAa,YAAa,SAAQ,WAAW;IAC3C,YAAmB,WAAmB,EAAE,IAAY,EAAE,OAAe,EAAE,WAAiC;QACtG,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AALD,oCAKC;AAED;;;GAGG;AACH,MAAa,sBAAuB,SAAQ,WAAW;IACrD,YAAmB,OAAe,EAAE,WAAiC;QACnE,KAAK,CAAC,+BAAgB,CAAC,0BAA0B,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAC3E,CAAC;CACF;AAJD,wDAIC;AAED;;GAEG;AACH,MAAa,cAAe,SAAQ,WAAW;IAC7C;QACE,KAAK,CAAC,2BAAY,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;CACF;AAJD,wCAIC","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 iModels\r\n */\r\n\r\nimport {\r\n  BentleyError, BentleyStatus, BriefcaseStatus, ChangeSetStatus, DbResult, GetMetaDataFunction, IModelStatus, RepositoryStatus,\r\n} from \"@itwin/core-bentley\";\r\n\r\nexport {\r\n  BentleyStatus, BentleyError, IModelStatus, BriefcaseStatus, GetMetaDataFunction, LogFunction, DbResult, ChangeSetStatus,\r\n} from \"@itwin/core-bentley\";\r\n\r\n/** Numeric values for common errors produced by iTwin.js APIs, typically provided by [[IModelError]].\r\n * The values within each of these `enum`s are guaranteed not to conflict with one another.\r\n * @public\r\n */\r\nexport type IModelErrorNumber = IModelStatus | DbResult | BentleyStatus | BriefcaseStatus | ChangeSetStatus;\r\n\r\n/** The error type thrown by this module.\r\n * @see [[IModelErrorNumber]] for commonly-used error codes.\r\n * @public\r\n */\r\nexport class IModelError extends BentleyError {\r\n  public constructor(errorNumber: IModelErrorNumber | number, message: string, getMetaData?: GetMetaDataFunction) {\r\n    super(errorNumber, message, getMetaData);\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport class ServerError extends IModelError {\r\n  public constructor(errorNumber: number, message: string) {\r\n    super(errorNumber, message);\r\n    this.name = `Server error (${errorNumber})`;\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport class ServerTimeoutError extends ServerError {\r\n  public constructor(message: string) {\r\n    super(IModelStatus.ServerTimeout, message);\r\n    this.name = \"Server timeout error\";\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport class BackendError extends IModelError {\r\n  public constructor(errorNumber: number, name: string, message: string, getMetaData?: GetMetaDataFunction) {\r\n    super(errorNumber, message, getMetaData);\r\n    this.name = name;\r\n  }\r\n}\r\n\r\n/**\r\n * Channel constraint error\r\n * @alpha\r\n */\r\nexport class ChannelConstraintError extends IModelError {\r\n  public constructor(message: string, getMetaData?: GetMetaDataFunction) {\r\n    super(RepositoryStatus.ChannelConstraintViolation, message, getMetaData);\r\n  }\r\n}\r\n\r\n/** Intended for API \"no content\" semantics where the error case should not trigger application failure monitoring systems.\r\n * @public\r\n */\r\nexport class NoContentError extends IModelError {\r\n  public constructor() {\r\n    super(IModelStatus.NoContent, \"No Content\");\r\n  }\r\n}\r\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"Localization.d.ts","sourceRoot":"","sources":["../../src/Localization.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,+BAA+B;IAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,GAAG,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;OAKG;IACH,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC;IACjF;;;;;;;OAOG;IACH,+BAA+B,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC;IACjH,wCAAwC;IACxC,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC;IAClG;;;;;;;;;;;;OAYG;IACH,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;IAE9C;;;;;;;OAOG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD,gBAAgB;IAChB,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7C,gBAAgB;IAChB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IAC7D,2DAA2D;IAC3D,eAAe,IAAI,SAAS,MAAM,EAAE,CAAC;IACrC,qGAAqG;IACrG,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjD;AAED;;GAEG;AACH,qBAAa,iBAAkB,YAAW,YAAY;IACvC,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IACjC,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM;IAClD,+BAA+B,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM;IACnF,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM;IACpE,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IACvC,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IACxC,mBAAmB,IAAI,IAAI;IAC3B,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS;IAChD,eAAe,IAAI,SAAS,MAAM,EAAE;IAC9B,cAAc;CAC5B"}
+{"version":3,"file":"Localization.d.ts","sourceRoot":"","sources":["../../src/Localization.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,+BAA+B;IAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,GAAG,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;OAKG;IACH,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC;IACjF;;;;;;;OAOG;IACH,+BAA+B,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC;IACjH,wCAAwC;IACxC,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC;IAClG;;;;;;;;;;;;OAYG;IACH,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;IAE9C;;;;;;;OAOG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD,gBAAgB;IAChB,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7C,gBAAgB;IAChB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IAC7D,2DAA2D;IAC3D,eAAe,IAAI,SAAS,MAAM,EAAE,CAAC;IACrC,qGAAqG;IACrG,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjD;AAED;;GAEG;AACH,qBAAa,iBAAkB,YAAW,YAAY;IACvC,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IACjC,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM;IAQlD,+BAA+B,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM;IACnF,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM;IACpE,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IACvC,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IACxC,mBAAmB,IAAI,IAAI;IAC3B,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS;IAChD,eAAe,IAAI,SAAS,MAAM,EAAE;IAC9B,cAAc;CAC5B"}

package/lib/cjs/Localization.js

@@ -13,7 +13,14 @@ exports.EmptyLocalization = void 0;
  */
 class EmptyLocalization {
     async initialize() { }
-    getLocalizedString(key) { return typeof (key) == "string" ? key : key[0]; }
+    getLocalizedString(key) {
+        if (typeof (key) !== "string") {
+            key = key[0];
+        }
+        // Simulate correct and simple usage of i18next's translation function
+        // Namely, remove the leading namespace substring if there is one
+        return key.split(":", 2).pop();
+    }
     getLocalizedStringWithNamespace(_namespace, key) { return this.getLocalizedString(key); }
     getEnglishString(_namespace, key) { return this.getLocalizedString(key); }
     getLocalizedKeys(inputString) { return inputString; }

package/lib/cjs/Localization.js.map

@@ -1 +1 @@
-{"version":3,"file":"Localization.js","sourceRoot":"","sources":["../../src/Localization.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAqGH;;GAEG;AACH,MAAa,iBAAiB;IACrB,KAAK,CAAC,UAAU,KAAoB,CAAC;IACrC,kBAAkB,CAAC,GAAsB,IAAY,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtG,+BAA+B,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC5H,gBAAgB,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7G,gBAAgB,CAAC,WAAmB,IAAY,OAAO,WAAW,CAAC,CAAC,CAAC;IACrE,KAAK,CAAC,iBAAiB,KAAoB,CAAC;IAC5C,mBAAmB,KAAW,CAAC;IAC/B,mBAAmB,KAAgC,OAAO,SAAS,CAAC,CAAC,CAAC;IACtE,eAAe,KAAwB,OAAO,EAAE,CAAC,CAAC,CAAC;IACnD,KAAK,CAAC,cAAc,KAAK,CAAC;CAClC;AAXD,8CAWC","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 Localization\r\n */\r\n\r\n/** Options for Localization\r\n * @public\r\n */\r\nexport interface TranslationOptions {\r\n  /** for interpolation values */\r\n  [key: string]: any;\r\n  /**\r\n   * defaultValue to return if a translation was not found\r\n   */\r\n  defaultValue?: any;\r\n  /**\r\n   * count value used for plurals\r\n   */\r\n  count?: number;\r\n  /**\r\n   * used for contexts (eg. male\\female)\r\n   */\r\n  context?: any;\r\n  /**\r\n   * override languages to use\r\n   */\r\n  lngs?: string[];\r\n  /**\r\n   * override language to lookup key if not found see fallbacks for details\r\n   */\r\n  fallbackLng?: string;\r\n}\r\n\r\n/** The interface defining the localization requirements of [IModelApp]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface Localization {\r\n  /** This method must be called and awaited before using an instance of Localization.\r\n   * @param namespaces an array of namespaces to load. There must be at least one namespace, and it\r\n   * becomes the default namespace.\r\n   * @note IModelApp.startup calls this internally, so you should not call this method directly\r\n   * except for Localization instances outside of IModelApp (e.g., for tests.)\r\n   */\r\n  initialize(namespaces: string[]): Promise<void>;\r\n\r\n  /** Return the translated value of a key.\r\n   * @param key - the key that matches a property in the JSON localization file.\r\n   * @note The key includes the namespace, which identifies the particular localization file that contains the property,\r\n   * followed by a colon, followed by the property in the JSON file.\r\n   * For example:\r\n   * ``` ts\r\n   * const dataString: string = IModelApp.localization.getLocalizedString(\"iModelJs:BackgroundMap.BingDataAttribution\");\r\n   *  ```\r\n   * assigns to dataString the string with property BackgroundMap.BingDataAttribution from the iModelJs.json localization file.\r\n   * @returns The string corresponding to the first key that resolves.\r\n   * @throws Error if no keys resolve to a string.\r\n   */\r\n  getLocalizedString(key: string | string[], options?: TranslationOptions): string;\r\n  /** Similar to `getLocalizedString` but the namespace is a separate param and the key does not include the namespace.\r\n   * @param namespace - the namespace that identifies the particular localization file that contains the property.\r\n   * @param key - the key that matches a property in the JSON localization file.\r\n   * @returns The string corresponding to the first key that resolves.\r\n   * @throws Error if no keys resolve to a string.\r\n   * @deprecated Use `getLocalizedString` instead; providing either a key with a namespace `<namespace>:<key>` or\r\n   * including `{ ns: <namespace> }` in the options.\r\n   */\r\n  getLocalizedStringWithNamespace(namespace: string, key: string | string[], options?: TranslationOptions): string;\r\n  /** get the English string for a key. */\r\n  getEnglishString(namespace: string, key: string | string[], options?: TranslationOptions): string;\r\n  /** Replace all instances of `%{key}` within a string with the translations of those keys.\r\n   * For example:\r\n   * ``` ts\r\n   * \"MyKeys\": {\r\n   *   \"Key1\": \"First value\",\r\n   *   \"Key2\": \"Second value\"\r\n   *  }\r\n   * ```\r\n   *\r\n   * ``` ts\r\n   * getLocalizedKeys(\"string with %{MyKeys.Key1} followed by %{MyKeys.Key2}!\"\") // returns \"string with First Value followed by Second Value!\"\r\n   * ```\r\n   */\r\n  getLocalizedKeys(inputString: string): string;\r\n\r\n  /** Register a new Namespace and return a Promise that is fulfilled when the content is loaded.\r\n   * If the namespace is already registered, its Promise will be returned.\r\n   * @param name - the name of the namespace.\r\n   * @note - The registerNamespace method starts fetching the appropriate version of the JSON localization file from the server,\r\n   * based on the current locale. To make sure that fetch is complete before performing translations from this namespace, await\r\n   * fulfillment of returned Promise.\r\n   * @see [Localization in iTwin.js]($docs/learning/frontend/Localization.md)\r\n   */\r\n  registerNamespace(namespace: string): Promise<void>;\r\n  /** @internal */\r\n  unregisterNamespace(namespace: string): void;\r\n  /** @internal */\r\n  getNamespacePromise(name: string): Promise<void> | undefined;\r\n  /** Get the list of available languages for translations */\r\n  getLanguageList(): readonly string[];\r\n  /** Change the language for translations. This overrides the language from the browser, for tests. */\r\n  changeLanguage(language: string): Promise<void>;\r\n}\r\n\r\n/** An empty [[Localization]] used if one is not provided to [IModelApp]($frontend). Does not perform localizations (merely returns the key.)\r\n * @public\r\n */\r\nexport class EmptyLocalization implements Localization {\r\n  public async initialize(): Promise<void> { }\r\n  public getLocalizedString(key: string | string[]): string { return typeof (key) == \"string\" ? key : key[0]; }\r\n  public getLocalizedStringWithNamespace(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\r\n  public getEnglishString(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\r\n  public getLocalizedKeys(inputString: string): string { return inputString; }\r\n  public async registerNamespace(): Promise<void> { }\r\n  public unregisterNamespace(): void { }\r\n  public getNamespacePromise(): Promise<void> | undefined { return undefined; }\r\n  public getLanguageList(): readonly string[] { return []; }\r\n  public async changeLanguage() { }\r\n}\r\n"]}
+{"version":3,"file":"Localization.js","sourceRoot":"","sources":["../../src/Localization.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAqGH;;GAEG;AACH,MAAa,iBAAiB;IACrB,KAAK,CAAC,UAAU,KAAoB,CAAC;IACrC,kBAAkB,CAAC,GAAsB;QAC9C,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE;YAC7B,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;SACd;QACD,sEAAsE;QACtE,iEAAiE;QACjE,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,EAAG,CAAC;IAClC,CAAC;IACM,+BAA+B,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC5H,gBAAgB,CAAC,UAAkB,EAAE,GAAsB,IAAY,OAAO,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC7G,gBAAgB,CAAC,WAAmB,IAAY,OAAO,WAAW,CAAC,CAAC,CAAC;IACrE,KAAK,CAAC,iBAAiB,KAAoB,CAAC;IAC5C,mBAAmB,KAAW,CAAC;IAC/B,mBAAmB,KAAgC,OAAO,SAAS,CAAC,CAAC,CAAC;IACtE,eAAe,KAAwB,OAAO,EAAE,CAAC,CAAC,CAAC;IACnD,KAAK,CAAC,cAAc,KAAK,CAAC;CAClC;AAlBD,8CAkBC","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 Localization\r\n */\r\n\r\n/** Options for Localization\r\n * @public\r\n */\r\nexport interface TranslationOptions {\r\n  /** for interpolation values */\r\n  [key: string]: any;\r\n  /**\r\n   * defaultValue to return if a translation was not found\r\n   */\r\n  defaultValue?: any;\r\n  /**\r\n   * count value used for plurals\r\n   */\r\n  count?: number;\r\n  /**\r\n   * used for contexts (eg. male\\female)\r\n   */\r\n  context?: any;\r\n  /**\r\n   * override languages to use\r\n   */\r\n  lngs?: string[];\r\n  /**\r\n   * override language to lookup key if not found see fallbacks for details\r\n   */\r\n  fallbackLng?: string;\r\n}\r\n\r\n/** The interface defining the localization requirements of [IModelApp]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface Localization {\r\n  /** This method must be called and awaited before using an instance of Localization.\r\n   * @param namespaces an array of namespaces to load. There must be at least one namespace, and it\r\n   * becomes the default namespace.\r\n   * @note IModelApp.startup calls this internally, so you should not call this method directly\r\n   * except for Localization instances outside of IModelApp (e.g., for tests.)\r\n   */\r\n  initialize(namespaces: string[]): Promise<void>;\r\n\r\n  /** Return the translated value of a key.\r\n   * @param key - the key that matches a property in the JSON localization file.\r\n   * @note The key includes the namespace, which identifies the particular localization file that contains the property,\r\n   * followed by a colon, followed by the property in the JSON file.\r\n   * For example:\r\n   * ``` ts\r\n   * const dataString: string = IModelApp.localization.getLocalizedString(\"iModelJs:BackgroundMap.BingDataAttribution\");\r\n   *  ```\r\n   * assigns to dataString the string with property BackgroundMap.BingDataAttribution from the iModelJs.json localization file.\r\n   * @returns The string corresponding to the first key that resolves.\r\n   * @throws Error if no keys resolve to a string.\r\n   */\r\n  getLocalizedString(key: string | string[], options?: TranslationOptions): string;\r\n  /** Similar to `getLocalizedString` but the namespace is a separate param and the key does not include the namespace.\r\n   * @param namespace - the namespace that identifies the particular localization file that contains the property.\r\n   * @param key - the key that matches a property in the JSON localization file.\r\n   * @returns The string corresponding to the first key that resolves.\r\n   * @throws Error if no keys resolve to a string.\r\n   * @deprecated Use `getLocalizedString` instead; providing either a key with a namespace `<namespace>:<key>` or\r\n   * including `{ ns: <namespace> }` in the options.\r\n   */\r\n  getLocalizedStringWithNamespace(namespace: string, key: string | string[], options?: TranslationOptions): string;\r\n  /** get the English string for a key. */\r\n  getEnglishString(namespace: string, key: string | string[], options?: TranslationOptions): string;\r\n  /** Replace all instances of `%{key}` within a string with the translations of those keys.\r\n   * For example:\r\n   * ``` ts\r\n   * \"MyKeys\": {\r\n   *   \"Key1\": \"First value\",\r\n   *   \"Key2\": \"Second value\"\r\n   *  }\r\n   * ```\r\n   *\r\n   * ``` ts\r\n   * getLocalizedKeys(\"string with %{MyKeys.Key1} followed by %{MyKeys.Key2}!\"\") // returns \"string with First Value followed by Second Value!\"\r\n   * ```\r\n   */\r\n  getLocalizedKeys(inputString: string): string;\r\n\r\n  /** Register a new Namespace and return a Promise that is fulfilled when the content is loaded.\r\n   * If the namespace is already registered, its Promise will be returned.\r\n   * @param name - the name of the namespace.\r\n   * @note - The registerNamespace method starts fetching the appropriate version of the JSON localization file from the server,\r\n   * based on the current locale. To make sure that fetch is complete before performing translations from this namespace, await\r\n   * fulfillment of returned Promise.\r\n   * @see [Localization in iTwin.js]($docs/learning/frontend/Localization.md)\r\n   */\r\n  registerNamespace(namespace: string): Promise<void>;\r\n  /** @internal */\r\n  unregisterNamespace(namespace: string): void;\r\n  /** @internal */\r\n  getNamespacePromise(name: string): Promise<void> | undefined;\r\n  /** Get the list of available languages for translations */\r\n  getLanguageList(): readonly string[];\r\n  /** Change the language for translations. This overrides the language from the browser, for tests. */\r\n  changeLanguage(language: string): Promise<void>;\r\n}\r\n\r\n/** An empty [[Localization]] used if one is not provided to [IModelApp]($frontend). Does not perform localizations (merely returns the key.)\r\n * @public\r\n */\r\nexport class EmptyLocalization implements Localization {\r\n  public async initialize(): Promise<void> { }\r\n  public getLocalizedString(key: string | string[]): string {\r\n    if (typeof (key) !== \"string\") {\r\n      key = key[0];\r\n    }\r\n    // Simulate correct and simple usage of i18next's translation function\r\n    // Namely, remove the leading namespace substring if there is one\r\n    return key.split(\":\", 2).pop()!;\r\n  }\r\n  public getLocalizedStringWithNamespace(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\r\n  public getEnglishString(_namespace: string, key: string | string[]): string { return this.getLocalizedString(key); }\r\n  public getLocalizedKeys(inputString: string): string { return inputString; }\r\n  public async registerNamespace(): Promise<void> { }\r\n  public unregisterNamespace(): void { }\r\n  public getNamespacePromise(): Promise<void> | undefined { return undefined; }\r\n  public getLanguageList(): readonly string[] { return []; }\r\n  public async changeLanguage() { }\r\n}\r\n"]}

package/lib/cjs/RealityModelDisplaySettings.d.ts

@@ -15,6 +15,14 @@ export declare type PointCloudSizeMode = "voxel" | "pixel";
  * @beta
  */
 export declare type PointCloudShape = "square" | "round";
+/** Specifies the Eye-Dome Lighting mode used for a point cloud.
+ *  - "off": EDL is not calculated
+ *  - "on": EDL is calculated using a single pass.
+ *  - "full" EDL is calculated with full algorithm including optional filtering
+ * @see [[PointCloudDisplaySettings.edlMode]].
+ * @beta
+ */
+export declare type PointCloudEDLMode = "off" | "on" | "full";
 /** The JSON representation of [[PointCloudDisplaySettings]].
  * @beta
  */
@@ -31,6 +39,20 @@ export interface PointCloudDisplayProps {
     pixelSize?: number;
     /** See [[PointCloudDisplaySettings.shape]]. */
     shape?: PointCloudShape;
+    /** See [[PointCloudDisplaySettings.edlMode]]. */
+    edlMode?: PointCloudEDLMode;
+    /** See [[PointCloudDisplaySettings.edlStrength]]. */
+    edlStrength?: number;
+    /** See [[PointCloudDisplaySettings.edlRadius]]. */
+    edlRadius?: number;
+    /** See [[PointCloudDisplaySettings.edlFilter]]. */
+    edlFilter?: number;
+    /** See [[PointCloudDisplaySettings.edlMixWts1]]. */
+    edlMixWts1?: number;
+    /** See [[PointCloudDisplaySettings.edlMixWts2]]. */
+    edlMixWts2?: number;
+    /** See [[PointCloudDisplaySettings.edlMixWts4]]. */
+    edlMixWts4?: number;
 }
 /** The JSON representation of [[RealityModelDisplaySettings]].
  * @beta
@@ -43,6 +65,10 @@ export interface RealityModelDisplayProps {
 }
 /** Settings that control how a point cloud reality model is displayed within a [Viewport]($frontend).
  * @note This is an immutable type - to modify its properties, use [[clone]].
+ * Eye-Dome Lighting (EDL) is a non-photorealistic, image-based shading technique that was designed to improve depth
+ * perception in scientific visualization. It is particularly useful for visualizing monochrome point cloud data, but
+ * also can be useful for point clouds with color information.
+ * @note EDL mode is ignored (off) if the view is not perspective (camera is off)
  * @see [[RealityModelDisplaySettings.pointCloud]].
  * @beta
  */
@@ -75,6 +101,45 @@ export declare class PointCloudDisplaySettings {
      * Default: 20.
      */
     readonly maxPixelsPerVoxel: number;
+    /** The mode for the Eye-Dome Lighting (EDL) effect.
+     * Default: "off"
+     * @note EDL mode is ignored (off) if the view is not perspective (camera is off)
+     */
+    readonly edlMode: PointCloudEDLMode;
+    /** A strength value for the Eye Dome Lighting (EDL) effect.
+     * The strength is expected to be a positive floating point number.
+     * Default: 5.0
+     */
+    readonly edlStrength: number;
+    /** A radius value for the Eye Dome Lighting (EDL) effect.
+     * The radius is expected to be a positive floating point number
+     * It is used to deterimine how far away in pixels to sample for depth change
+     * Default: 2.0
+     */
+    readonly edlRadius: number;
+    /** A flag for whether or not to apply filtering pass in the Eye Dome Lighting (EDL) effect.
+     * It only applies if edlMode is "full"
+     * Default: 1.0
+     */
+    readonly edlFilter?: number;
+    /** A weighting value to apply to the full image when combining it with the half and quarter sized ones
+     * It only applies if edlMode is "full"
+     * The strength is expected to be a floating point number between 0 and 1 inclusive.
+     * Default: 1.0
+     */
+    readonly edlMixWts1?: number;
+    /** A weighting value to apply to the half sized image when combining it with the full and quarter sized ones
+     * It only applies if edlMode is "full"
+     * The strength is expected to be a floating point number between 0 and 1 inclusive.
+     * Default: 0.5
+     */
+    readonly edlMixWts2?: number;
+    /** A weighting value to apply to the quarter sized image when combining it with the full and half sized ones
+     * It only applies if edlMode is "full"
+     * The strength is expected to be a floating point number between 0 and 1 inclusive.
+     * Default: 0.25
+     */
+    readonly edlMixWts4?: number;
     /** Settings with all properties initialized to their default values. */
     static defaults: PointCloudDisplaySettings;
     private constructor();

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

@@ -1 +1 @@
-{"version":3,"file":"RealityModelDisplaySettings.d.ts","sourceRoot":"","sources":["../../src/RealityModelDisplaySettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,oBAAY,kBAAkB,GAAG,OAAO,GAAG,OAAO,CAAC;AAEnD;;;;;GAKG;AACH,oBAAY,eAAe,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,kDAAkD;IAClD,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,2DAA2D;IAC3D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,sDAAsD;IACtD,UAAU,CAAC,EAAE,sBAAsB,CAAC;IACpC,8DAA8D;IAC9D,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAE7B;AAED;;;;GAIG;AACH,qBAAa,yBAAyB;IACpC;;OAEG;IACH,SAAgB,KAAK,EAAE,eAAe,CAAC;IACvC;;;;OAIG;IACH,SAAgB,QAAQ,EAAE,kBAAkB,CAAC;IAC7C;;;OAGG;IACH,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAE1C,wEAAwE;IACxE,OAAc,QAAQ,4BAAmC;IAEzD,OAAO;IAWP,4HAA4H;WAC9G,QAAQ,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,yBAAyB;IAIjF,2DAA2D;IACpD,MAAM,IAAI,sBAAsB,GAAG,SAAS;IA2BnD,mHAAmH;IAC5G,KAAK,CAAC,YAAY,EAAE,sBAAsB,GAAG,yBAAyB;IAO7E,+DAA+D;IACxD,MAAM,CAAC,KAAK,EAAE,yBAAyB,GAAG,OAAO;CAOzD;AAED;;;;;GAKG;AACH,qBAAa,2BAA2B;IACtC;;;;OAIG;IACH,SAAgB,kBAAkB,EAAE,MAAM,CAAC;IAC3C;;OAEG;IACH,SAAgB,UAAU,EAAE,yBAAyB,CAAC;IAEtD,wEAAwE;IACxE,OAAc,QAAQ,8BAAkF;IAExG,OAAO;IAKP,4HAA4H;WAC9G,QAAQ,CAAC,KAAK,CAAC,EAAE,wBAAwB,GAAG,2BAA2B;IAOrF,uIAAuI;IAChI,MAAM,IAAI,wBAAwB,GAAG,SAAS;IAiBrD,+DAA+D;IACxD,MAAM,CAAC,KAAK,EAAE,2BAA2B,GAAG,OAAO;IAO1D,mHAAmH;IAC5G,KAAK,CAAC,YAAY,EAAE,wBAAwB,GAAG,2BAA2B;CAKlF"}
+{"version":3,"file":"RealityModelDisplaySettings.d.ts","sourceRoot":"","sources":["../../src/RealityModelDisplaySettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,oBAAY,kBAAkB,GAAG,OAAO,GAAG,OAAO,CAAC;AAEnD;;;;;GAKG;AACH,oBAAY,eAAe,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEjD;;;;;;GAMG;AACH,oBAAY,iBAAiB,GAAG,KAAK,GAAG,IAAI,GAAG,MAAM,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,kDAAkD;IAClD,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,2DAA2D;IAC3D,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,iDAAiD;IACjD,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,sDAAsD;IACtD,UAAU,CAAC,EAAE,sBAAsB,CAAC;IACpC,8DAA8D;IAC9D,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAE7B;AAED;;;;;;;;GAQG;AACH,qBAAa,yBAAyB;IACpC;;OAEG;IACH,SAAgB,KAAK,EAAE,eAAe,CAAC;IACvC;;;;OAIG;IACH,SAAgB,QAAQ,EAAE,kBAAkB,CAAC;IAC7C;;;OAGG;IACH,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C;;;OAGG;IACH,SAAgB,OAAO,EAAE,iBAAiB,CAAC;IAC3C;;;OAGG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;;;OAIG;IACH,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,SAAgB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnC;;;;OAIG;IACH,SAAgB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpC;;;;OAIG;IACH,SAAgB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpC;;;;OAIG;IACH,SAAgB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpC,wEAAwE;IACxE,OAAc,QAAQ,4BAAmC;IAEzD,OAAO;IAkBP,4HAA4H;WAC9G,QAAQ,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,yBAAyB;IAIjF,2DAA2D;IACpD,MAAM,IAAI,sBAAsB,GAAG,SAAS;IAgDnD,mHAAmH;IAC5G,KAAK,CAAC,YAAY,EAAE,sBAAsB,GAAG,yBAAyB;IAO7E,+DAA+D;IACxD,MAAM,CAAC,KAAK,EAAE,yBAAyB,GAAG,OAAO;CAWzD;AAED;;;;;GAKG;AACH,qBAAa,2BAA2B;IACtC;;;;OAIG;IACH,SAAgB,kBAAkB,EAAE,MAAM,CAAC;IAC3C;;OAEG;IACH,SAAgB,UAAU,EAAE,yBAAyB,CAAC;IAEtD,wEAAwE;IACxE,OAAc,QAAQ,8BAAkF;IAExG,OAAO;IAKP,4HAA4H;WAC9G,QAAQ,CAAC,KAAK,CAAC,EAAE,wBAAwB,GAAG,2BAA2B;IAOrF,uIAAuI;IAChI,MAAM,IAAI,wBAAwB,GAAG,SAAS;IAiBrD,+DAA+D;IACxD,MAAM,CAAC,KAAK,EAAE,2BAA2B,GAAG,OAAO;IAO1D,mHAAmH;IAC5G,KAAK,CAAC,YAAY,EAAE,wBAAwB,GAAG,2BAA2B;CAKlF"}

package/lib/cjs/RealityModelDisplaySettings.js

@@ -10,12 +10,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RealityModelDisplaySettings = exports.PointCloudDisplaySettings = void 0;
 /** Settings that control how a point cloud reality model is displayed within a [Viewport]($frontend).
  * @note This is an immutable type - to modify its properties, use [[clone]].
+ * Eye-Dome Lighting (EDL) is a non-photorealistic, image-based shading technique that was designed to improve depth
+ * perception in scientific visualization. It is particularly useful for visualizing monochrome point cloud data, but
+ * also can be useful for point clouds with color information.
+ * @note EDL mode is ignored (off) if the view is not perspective (camera is off)
  * @see [[RealityModelDisplaySettings.pointCloud]].
  * @beta
  */
 class PointCloudDisplaySettings {
     constructor(props) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
         this.shape = (_a = props === null || props === void 0 ? void 0 : props.shape) !== null && _a !== void 0 ? _a : "round";
         this.sizeMode = (_b = props === null || props === void 0 ? void 0 : props.sizeMode) !== null && _b !== void 0 ? _b : "voxel";
         // No sanity checks here - e.g., min < max, pixelSize and voxelScale > 0, etc.
@@ -23,6 +27,13 @@ class PointCloudDisplaySettings {
         this.voxelScale = (_d = props === null || props === void 0 ? void 0 : props.voxelScale) !== null && _d !== void 0 ? _d : 1;
         this.minPixelsPerVoxel = (_e = props === null || props === void 0 ? void 0 : props.minPixelsPerVoxel) !== null && _e !== void 0 ? _e : 2;
         this.maxPixelsPerVoxel = (_f = props === null || props === void 0 ? void 0 : props.maxPixelsPerVoxel) !== null && _f !== void 0 ? _f : 20;
+        this.edlMode = (_g = props === null || props === void 0 ? void 0 : props.edlMode) !== null && _g !== void 0 ? _g : "off";
+        this.edlStrength = (_h = props === null || props === void 0 ? void 0 : props.edlStrength) !== null && _h !== void 0 ? _h : 5;
+        this.edlRadius = (_j = props === null || props === void 0 ? void 0 : props.edlRadius) !== null && _j !== void 0 ? _j : 2;
+        this.edlFilter = (_k = props === null || props === void 0 ? void 0 : props.edlFilter) !== null && _k !== void 0 ? _k : 1;
+        this.edlMixWts1 = (_l = props === null || props === void 0 ? void 0 : props.edlMixWts1) !== null && _l !== void 0 ? _l : 1.0;
+        this.edlMixWts2 = (_m = props === null || props === void 0 ? void 0 : props.edlMixWts2) !== null && _m !== void 0 ? _m : 0.5;
+        this.edlMixWts4 = (_o = props === null || props === void 0 ? void 0 : props.edlMixWts4) !== null && _o !== void 0 ? _o : 0.25;
     }
     /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */
     static fromJSON(props) {
@@ -46,6 +57,20 @@ class PointCloudDisplaySettings {
             props.minPixelsPerVoxel = this.minPixelsPerVoxel;
         if (this.maxPixelsPerVoxel !== defs.maxPixelsPerVoxel)
             props.maxPixelsPerVoxel = this.maxPixelsPerVoxel;
+        if (this.edlMode !== defs.edlMode)
+            props.edlMode = this.edlMode;
+        if (this.edlStrength !== defs.edlStrength)
+            props.edlStrength = this.edlStrength;
+        if (this.edlRadius !== defs.edlRadius)
+            props.edlRadius = this.edlRadius;
+        if (this.edlFilter !== defs.edlFilter)
+            props.edlFilter = this.edlFilter;
+        if (this.edlMixWts1 !== defs.edlMixWts1)
+            props.edlMixWts1 = this.edlMixWts1;
+        if (this.edlMixWts2 !== defs.edlMixWts2)
+            props.edlMixWts2 = this.edlMixWts2;
+        if (this.edlMixWts4 !== defs.edlMixWts4)
+            props.edlMixWts4 = this.edlMixWts4;
         return props;
     }
     /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */
@@ -60,7 +85,10 @@ class PointCloudDisplaySettings {
         if (this === other)
             return true;
         return this.shape === other.shape && this.sizeMode === other.sizeMode && this.pixelSize === other.pixelSize
-            && this.voxelScale === other.voxelScale && this.minPixelsPerVoxel === other.minPixelsPerVoxel && this.maxPixelsPerVoxel === other.maxPixelsPerVoxel;
+            && this.voxelScale === other.voxelScale && this.minPixelsPerVoxel === other.minPixelsPerVoxel && this.maxPixelsPerVoxel === other.maxPixelsPerVoxel
+            && this.edlMode === other.edlMode && this.edlStrength === other.edlStrength && this.edlRadius === other.edlRadius
+            && this.edlFilter === other.edlFilter
+            && this.edlMixWts1 === other.edlMixWts1 && this.edlMixWts2 === other.edlMixWts2 && this.edlMixWts4 === other.edlMixWts4;
     }
 }
 exports.PointCloudDisplaySettings = PointCloudDisplaySettings;

package/lib/cjs/RealityModelDisplaySettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"RealityModelDisplaySettings.js","sourceRoot":"","sources":["../../src/RealityModelDisplaySettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA+CH;;;;GAIG;AACH,MAAa,yBAAyB;IAiCpC,YAAoB,KAA8B;;QAChD,IAAI,CAAC,KAAK,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,mCAAI,OAAO,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,mCAAI,OAAO,CAAC;QAE3C,8EAA8E;QAC9E,IAAI,CAAC,SAAS,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,mCAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,mCAAI,CAAC,CAAC;QACzC,IAAI,CAAC,iBAAiB,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,mCAAI,CAAC,CAAC;QACvD,IAAI,CAAC,iBAAiB,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,mCAAI,EAAE,CAAC;IAC1D,CAAC;IAED,4HAA4H;IACrH,MAAM,CAAC,QAAQ,CAAC,KAA8B;QACnD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACtE,CAAC;IAED,2DAA2D;IACpD,MAAM;QACX,MAAM,IAAI,GAAG,yBAAyB,CAAC,QAAQ,CAAC;QAChD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACnB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAA2B,EAAG,CAAC;QAC1C,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK;YAC3B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ;YACjC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACnC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,UAAU;YACrC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAErC,IAAI,IAAI,CAAC,iBAAiB,KAAK,IAAI,CAAC,iBAAiB;YACnD,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEnD,IAAI,IAAI,CAAC,iBAAiB,KAAK,IAAI,CAAC,iBAAiB;YACnD,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEnD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mHAAmH;IAC5G,KAAK,CAAC,YAAoC;QAC/C,OAAO,yBAAyB,CAAC,QAAQ,CAAC;YACxC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;IAED,+DAA+D;IACxD,MAAM,CAAC,KAAgC;QAC5C,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;eACtG,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB,CAAC;IACxJ,CAAC;;AA5FH,8DA6FC;AA/DC,wEAAwE;AAC1D,kCAAQ,GAAG,IAAI,yBAAyB,EAAE,CAAC;AAgE3D;;;;;GAKG;AACH,MAAa,2BAA2B;IAetC,YAAoB,kBAAsC,EAAE,UAAqC;QAC/F,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,GAAG,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED,4HAA4H;IACrH,MAAM,CAAC,QAAQ,CAAC,KAAgC;QACrD,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,2BAA2B,CAAC,KAAK,CAAC,kBAAkB,EAAE,yBAAyB,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IACzH,CAAC;IAED,uIAAuI;IAChI,MAAM;QACX,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC5C,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,KAAK,2BAA2B,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;QAErJ,IAAI,SAAS,KAAK,UAAU,IAAI,SAAS,KAAK,kBAAkB;YAC9D,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAA6B,EAAG,CAAC;QAC5C,IAAI,SAAS,KAAK,UAAU;YAC1B,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC;QAEhC,IAAI,SAAS,KAAK,kBAAkB;YAClC,KAAK,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAEhD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+DAA+D;IACxD,MAAM,CAAC,KAAkC;QAC9C,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,kBAAkB,KAAK,KAAK,CAAC,kBAAkB,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC1G,CAAC;IAED,mHAAmH;IAC5G,KAAK,CAAC,YAAsC;QACjD,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;QAC9G,MAAM,UAAU,GAAG,YAAY,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;QACjI,OAAO,IAAI,2BAA2B,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACjE,CAAC;;AA3DH,kEA4DC;AAhDC,wEAAwE;AAC1D,oCAAQ,GAAG,IAAI,2BAA2B,CAAC,SAAS,EAAE,yBAAyB,CAAC,QAAQ,CAAC,CAAC","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/** Specifies how the sizes of the individual points within a point cloud are computed.\r\n *  - \"pixel\": Each point is an exact number of pixels in diameter, as specified by [[PointCloudDisplaySettings.pixelSize]].\r\n *  - \"voxel\": Each point is the size of a \"voxel\" in meters, as specified by the [Tile]($frontend) to which the point belongs.\r\n * @see [[PointCloudDisplaySettings.sizeMode]].\r\n * @beta\r\n */\r\nexport type PointCloudSizeMode = \"voxel\" | \"pixel\";\r\n\r\n/** Specifies the shape drawn for each individual point within a point cloud.\r\n *  - \"round\": Each point is drawn as a circle.\r\n *  - \"square\": Each point is drawn as a square.\r\n * @see [[PointCloudDisplaySettings.shape]].\r\n * @beta\r\n */\r\nexport type PointCloudShape = \"square\" | \"round\";\r\n\r\n/** The JSON representation of [[PointCloudDisplaySettings]].\r\n * @beta\r\n */\r\nexport interface PointCloudDisplayProps {\r\n  /** See [[PointCloudDisplaySettings.sizeMode]]. */\r\n  sizeMode?: PointCloudSizeMode;\r\n  /** See [[PointCloudDisplaySettings.voxelScale]]. */\r\n  voxelScale?: number;\r\n  /** See [[PointCloudDisplaySettings.minPixelsPerVoxel]]. */\r\n  minPixelsPerVoxel?: number;\r\n  /** See [[PointCloudDisplaySettings.maxPixelsPerVoxel]]. */\r\n  maxPixelsPerVoxel?: number;\r\n  /** See [[PointCloudDisplaySettings.pixelSize]]. */\r\n  pixelSize?: number;\r\n  /** See [[PointCloudDisplaySettings.shape]]. */\r\n  shape?: PointCloudShape;\r\n}\r\n\r\n/** The JSON representation of [[RealityModelDisplaySettings]].\r\n * @beta\r\n */\r\nexport interface RealityModelDisplayProps {\r\n  /** See [[RealityModelDisplaySettings.pointCloud]]. */\r\n  pointCloud?: PointCloudDisplayProps;\r\n  /** See [[RealityModelDisplaySettings.overrideColorRatio]]. */\r\n  overrideColorRatio?: number;\r\n  // ###TODO when we need it: mesh?: RealityMeshDisplayProps;\r\n}\r\n\r\n/** Settings that control how a point cloud reality model is displayed within a [Viewport]($frontend).\r\n * @note This is an immutable type - to modify its properties, use [[clone]].\r\n * @see [[RealityModelDisplaySettings.pointCloud]].\r\n * @beta\r\n */\r\nexport class PointCloudDisplaySettings {\r\n  /** The shape drawn for each point in the cloud.\r\n   * Default: \"round\".\r\n   */\r\n  public readonly shape: PointCloudShape;\r\n  /** The method by which the size of each individual point is computed.\r\n   * Default: \"voxel\".\r\n   * @see [[pixelSize]] to configure the size for \"pixel\" mode.\r\n   * @see [[voxelScale]], [[minPixelsPerVoxel]], and [[maxPixelsPerVoxel]] to configure the size for \"voxel\" mode.\r\n   */\r\n  public readonly sizeMode: PointCloudSizeMode;\r\n  /** The radius of each point in pixels, when [[sizeMode]] is \"pixel\".\r\n   * The size is expected to be a positive integer. The maximum size will vary based on the graphics hardware in use, but typically is limited to 32 or 64 pixels.\r\n   * Default: 1\r\n   */\r\n  public readonly pixelSize: number;\r\n  /** A scale factor applied to the size of each point, when [[sizeMode]] is \"voxel\".\r\n   * The scale is expected to be a positive floating point number.\r\n   * Default: 1.0\r\n   */\r\n  public readonly voxelScale: number;\r\n  /** If [[sizeMode]] is \"voxel\", the minimum radius of each point in pixels. It is expected to be a positive integer no greater than [[maxPixelsPerVoxel]].\r\n   * Default: 2\r\n   */\r\n  public readonly minPixelsPerVoxel: number;\r\n  /** If [[sizeMode]] is \"voxel\", the maximum radius of each point in pixels. It is expected to be a positive integer no less than [[minPixelsPerVoxel]].\r\n   * Default: 20.\r\n   */\r\n  public readonly maxPixelsPerVoxel: number;\r\n\r\n  /** Settings with all properties initialized to their default values. */\r\n  public static defaults = new PointCloudDisplaySettings();\r\n\r\n  private constructor(props?: PointCloudDisplayProps) {\r\n    this.shape = props?.shape ?? \"round\";\r\n    this.sizeMode = props?.sizeMode ?? \"voxel\";\r\n\r\n    // No sanity checks here - e.g., min < max, pixelSize and voxelScale > 0, etc.\r\n    this.pixelSize = props?.pixelSize ?? 1;\r\n    this.voxelScale = props?.voxelScale ?? 1;\r\n    this.minPixelsPerVoxel = props?.minPixelsPerVoxel ?? 2;\r\n    this.maxPixelsPerVoxel = props?.maxPixelsPerVoxel ?? 20;\r\n  }\r\n\r\n  /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */\r\n  public static fromJSON(props?: PointCloudDisplayProps): PointCloudDisplaySettings {\r\n    return props ? new PointCloudDisplaySettings(props) : this.defaults;\r\n  }\r\n\r\n  /** Convert these settings to their JSON representation. */\r\n  public toJSON(): PointCloudDisplayProps | undefined {\r\n    const defs = PointCloudDisplaySettings.defaults;\r\n    if (this.equals(defs))\r\n      return undefined;\r\n\r\n    const props: PointCloudDisplayProps = { };\r\n    if (this.shape !== defs.shape)\r\n      props.shape = this.shape;\r\n\r\n    if (this.sizeMode !== defs.sizeMode)\r\n      props.sizeMode = this.sizeMode;\r\n\r\n    if (this.pixelSize !== defs.pixelSize)\r\n      props.pixelSize = this.pixelSize;\r\n\r\n    if (this.voxelScale !== defs.voxelScale)\r\n      props.voxelScale = this.voxelScale;\r\n\r\n    if (this.minPixelsPerVoxel !== defs.minPixelsPerVoxel)\r\n      props.minPixelsPerVoxel = this.minPixelsPerVoxel;\r\n\r\n    if (this.maxPixelsPerVoxel !== defs.maxPixelsPerVoxel)\r\n      props.maxPixelsPerVoxel = this.maxPixelsPerVoxel;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */\r\n  public clone(changedProps: PointCloudDisplayProps): PointCloudDisplaySettings {\r\n    return PointCloudDisplaySettings.fromJSON({\r\n      ...this.toJSON(),\r\n      ...changedProps,\r\n    });\r\n  }\r\n\r\n  /** Returns true if these settings are identical to `other`. */\r\n  public equals(other: PointCloudDisplaySettings): boolean {\r\n    if (this === other)\r\n      return true;\r\n\r\n    return this.shape === other.shape && this.sizeMode === other.sizeMode && this.pixelSize === other.pixelSize\r\n      && this.voxelScale === other.voxelScale && this.minPixelsPerVoxel === other.minPixelsPerVoxel && this.maxPixelsPerVoxel === other.maxPixelsPerVoxel;\r\n  }\r\n}\r\n\r\n/** Settings that control how a reality model - whether a [[ContextRealityModel]] or a persistent reality [Model]($backend) - is displayed within a [Viewport]($frontend).\r\n * @see [[ContextRealityModel.displaySettings]] to apply these settings to a context reality model.\r\n * @see [[DisplayStyleSettings.setRealityModelDisplaySettings]] to apply these settings to a persistent reality model.\r\n * @note This is an immutable type - to modify its properties, use [[clone]].\r\n * @beta\r\n */\r\nexport class RealityModelDisplaySettings {\r\n  /** If the reality model's color is overridden with another color, a ratio in [0..1] with which to mix the two colors together.\r\n   * A ratio of 0 uses only the reality model's color, a ratio of 1 uses only the override color, and a ratio of 0.5 mixes the two colors equally.\r\n   * The color may be overridden using [[FeatureOverrides]] such as those supplied by a [FeatureOverrideProvider]($frontend), or by applying a [[SpatialClassifier]].\r\n   * Default: 0.5\r\n   */\r\n  public readonly overrideColorRatio: number;\r\n  /** Settings that apply specifically to point cloud reality models.\r\n   * Default: [[PointCloudDisplaySettings.defaults]].\r\n   */\r\n  public readonly pointCloud: PointCloudDisplaySettings;\r\n\r\n  /** Settings with all properties initialized to their default values. */\r\n  public static defaults = new RealityModelDisplaySettings(undefined, PointCloudDisplaySettings.defaults);\r\n\r\n  private constructor(overrideColorRatio: number | undefined, pointCloud: PointCloudDisplaySettings) {\r\n    this.overrideColorRatio = overrideColorRatio ?? 0.5;\r\n    this.pointCloud = pointCloud;\r\n  }\r\n\r\n  /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */\r\n  public static fromJSON(props?: RealityModelDisplayProps): RealityModelDisplaySettings {\r\n    if (!props)\r\n      return this.defaults;\r\n\r\n    return new RealityModelDisplaySettings(props.overrideColorRatio, PointCloudDisplaySettings.fromJSON(props.pointCloud));\r\n  }\r\n\r\n  /** Convert these settings to their JSON representation, which is `undefined` if all of their properties match the default settings. */\r\n  public toJSON(): RealityModelDisplayProps | undefined {\r\n    const pointCloud = this.pointCloud.toJSON();\r\n    const overrideColorRatio = this.overrideColorRatio === RealityModelDisplaySettings.defaults.overrideColorRatio ? undefined : this.overrideColorRatio;\r\n\r\n    if (undefined === pointCloud && undefined === overrideColorRatio)\r\n      return undefined;\r\n\r\n    const props: RealityModelDisplayProps = { };\r\n    if (undefined !== pointCloud)\r\n      props.pointCloud = pointCloud;\r\n\r\n    if (undefined !== overrideColorRatio)\r\n      props.overrideColorRatio = overrideColorRatio;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if these settings are identical to `other`. */\r\n  public equals(other: RealityModelDisplaySettings): boolean {\r\n    if (this === other)\r\n      return true;\r\n\r\n    return this.overrideColorRatio === other.overrideColorRatio && this.pointCloud.equals(other.pointCloud);\r\n  }\r\n\r\n  /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */\r\n  public clone(changedProps: RealityModelDisplayProps): RealityModelDisplaySettings {\r\n    const pointCloud = changedProps.pointCloud ? this.pointCloud.clone(changedProps.pointCloud) : this.pointCloud;\r\n    const colorRatio = changedProps.hasOwnProperty(\"overrideColorRatio\") ? changedProps.overrideColorRatio : this.overrideColorRatio;\r\n    return new RealityModelDisplaySettings(colorRatio, pointCloud);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"RealityModelDisplaySettings.js","sourceRoot":"","sources":["../../src/RealityModelDisplaySettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAsEH;;;;;;;;GAQG;AACH,MAAa,yBAAyB;IAwEpC,YAAoB,KAA8B;;QAChD,IAAI,CAAC,KAAK,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,mCAAI,OAAO,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,mCAAI,OAAO,CAAC;QAE3C,8EAA8E;QAC9E,IAAI,CAAC,SAAS,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,mCAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,mCAAI,CAAC,CAAC;QACzC,IAAI,CAAC,iBAAiB,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,mCAAI,CAAC,CAAC;QACvD,IAAI,CAAC,iBAAiB,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,mCAAI,EAAE,CAAC;QACxD,IAAI,CAAC,OAAO,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,mCAAI,KAAK,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,WAAW,mCAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,mCAAI,CAAC,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,mCAAI,CAAC,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,mCAAI,GAAG,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,mCAAI,GAAG,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,mCAAI,IAAI,CAAC;IAC9C,CAAC;IAED,4HAA4H;IACrH,MAAM,CAAC,QAAQ,CAAC,KAA8B;QACnD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,yBAAyB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACtE,CAAC;IAED,2DAA2D;IACpD,MAAM;QACX,MAAM,IAAI,GAAG,yBAAyB,CAAC,QAAQ,CAAC;QAChD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACnB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAA2B,EAAG,CAAC;QAC1C,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK;YAC3B,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QAE3B,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ;YACjC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACnC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,UAAU;YACrC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAErC,IAAI,IAAI,CAAC,iBAAiB,KAAK,IAAI,CAAC,iBAAiB;YACnD,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEnD,IAAI,IAAI,CAAC,iBAAiB,KAAK,IAAI,CAAC,iBAAiB;YACnD,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAEnD,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO;YAC/B,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAE/B,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,WAAW;YACvC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAEvC,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACnC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACnC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,UAAU;YACrC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAErC,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,UAAU;YACrC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAErC,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,UAAU;YACrC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAErC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mHAAmH;IAC5G,KAAK,CAAC,YAAoC;QAC/C,OAAO,yBAAyB,CAAC,QAAQ,CAAC;YACxC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;IAED,+DAA+D;IACxD,MAAM,CAAC,KAAgC;QAC5C,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;eACtG,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,CAAC,iBAAiB;eAChJ,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;eAC9G,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;eAClC,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,CACxH;IACH,CAAC;;AAnKH,8DAoKC;AA/FC,wEAAwE;AAC1D,kCAAQ,GAAG,IAAI,yBAAyB,EAAE,CAAC;AAgG3D;;;;;GAKG;AACH,MAAa,2BAA2B;IAetC,YAAoB,kBAAsC,EAAE,UAAqC;QAC/F,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,aAAlB,kBAAkB,cAAlB,kBAAkB,GAAI,GAAG,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAED,4HAA4H;IACrH,MAAM,CAAC,QAAQ,CAAC,KAAgC;QACrD,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,2BAA2B,CAAC,KAAK,CAAC,kBAAkB,EAAE,yBAAyB,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IACzH,CAAC;IAED,uIAAuI;IAChI,MAAM;QACX,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC5C,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,KAAK,2BAA2B,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;QAErJ,IAAI,SAAS,KAAK,UAAU,IAAI,SAAS,KAAK,kBAAkB;YAC9D,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAA6B,EAAG,CAAC;QAC5C,IAAI,SAAS,KAAK,UAAU;YAC1B,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC;QAEhC,IAAI,SAAS,KAAK,kBAAkB;YAClC,KAAK,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAEhD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+DAA+D;IACxD,MAAM,CAAC,KAAkC;QAC9C,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,kBAAkB,KAAK,KAAK,CAAC,kBAAkB,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC1G,CAAC;IAED,mHAAmH;IAC5G,KAAK,CAAC,YAAsC;QACjD,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;QAC9G,MAAM,UAAU,GAAG,YAAY,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;QACjI,OAAO,IAAI,2BAA2B,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACjE,CAAC;;AA3DH,kEA4DC;AAhDC,wEAAwE;AAC1D,oCAAQ,GAAG,IAAI,2BAA2B,CAAC,SAAS,EAAE,yBAAyB,CAAC,QAAQ,CAAC,CAAC","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/** Specifies how the sizes of the individual points within a point cloud are computed.\r\n *  - \"pixel\": Each point is an exact number of pixels in diameter, as specified by [[PointCloudDisplaySettings.pixelSize]].\r\n *  - \"voxel\": Each point is the size of a \"voxel\" in meters, as specified by the [Tile]($frontend) to which the point belongs.\r\n * @see [[PointCloudDisplaySettings.sizeMode]].\r\n * @beta\r\n */\r\nexport type PointCloudSizeMode = \"voxel\" | \"pixel\";\r\n\r\n/** Specifies the shape drawn for each individual point within a point cloud.\r\n *  - \"round\": Each point is drawn as a circle.\r\n *  - \"square\": Each point is drawn as a square.\r\n * @see [[PointCloudDisplaySettings.shape]].\r\n * @beta\r\n */\r\nexport type PointCloudShape = \"square\" | \"round\";\r\n\r\n/** Specifies the Eye-Dome Lighting mode used for a point cloud.\r\n *  - \"off\": EDL is not calculated\r\n *  - \"on\": EDL is calculated using a single pass.\r\n *  - \"full\" EDL is calculated with full algorithm including optional filtering\r\n * @see [[PointCloudDisplaySettings.edlMode]].\r\n * @beta\r\n */\r\nexport type PointCloudEDLMode = \"off\" | \"on\" | \"full\";\r\n\r\n/** The JSON representation of [[PointCloudDisplaySettings]].\r\n * @beta\r\n */\r\nexport interface PointCloudDisplayProps {\r\n  /** See [[PointCloudDisplaySettings.sizeMode]]. */\r\n  sizeMode?: PointCloudSizeMode;\r\n  /** See [[PointCloudDisplaySettings.voxelScale]]. */\r\n  voxelScale?: number;\r\n  /** See [[PointCloudDisplaySettings.minPixelsPerVoxel]]. */\r\n  minPixelsPerVoxel?: number;\r\n  /** See [[PointCloudDisplaySettings.maxPixelsPerVoxel]]. */\r\n  maxPixelsPerVoxel?: number;\r\n  /** See [[PointCloudDisplaySettings.pixelSize]]. */\r\n  pixelSize?: number;\r\n  /** See [[PointCloudDisplaySettings.shape]]. */\r\n  shape?: PointCloudShape;\r\n  /** See [[PointCloudDisplaySettings.edlMode]]. */\r\n  edlMode?: PointCloudEDLMode;\r\n  /** See [[PointCloudDisplaySettings.edlStrength]]. */\r\n  edlStrength?: number;\r\n  /** See [[PointCloudDisplaySettings.edlRadius]]. */\r\n  edlRadius?: number;\r\n  /** See [[PointCloudDisplaySettings.edlFilter]]. */\r\n  edlFilter?: number;\r\n  /** See [[PointCloudDisplaySettings.edlMixWts1]]. */\r\n  edlMixWts1?: number;\r\n  /** See [[PointCloudDisplaySettings.edlMixWts2]]. */\r\n  edlMixWts2?: number;\r\n  /** See [[PointCloudDisplaySettings.edlMixWts4]]. */\r\n  edlMixWts4?: number;\r\n}\r\n\r\n/** The JSON representation of [[RealityModelDisplaySettings]].\r\n * @beta\r\n */\r\nexport interface RealityModelDisplayProps {\r\n  /** See [[RealityModelDisplaySettings.pointCloud]]. */\r\n  pointCloud?: PointCloudDisplayProps;\r\n  /** See [[RealityModelDisplaySettings.overrideColorRatio]]. */\r\n  overrideColorRatio?: number;\r\n  // ###TODO when we need it: mesh?: RealityMeshDisplayProps;\r\n}\r\n\r\n/** Settings that control how a point cloud reality model is displayed within a [Viewport]($frontend).\r\n * @note This is an immutable type - to modify its properties, use [[clone]].\r\n * Eye-Dome Lighting (EDL) is a non-photorealistic, image-based shading technique that was designed to improve depth\r\n * perception in scientific visualization. It is particularly useful for visualizing monochrome point cloud data, but\r\n * also can be useful for point clouds with color information.\r\n * @note EDL mode is ignored (off) if the view is not perspective (camera is off)\r\n * @see [[RealityModelDisplaySettings.pointCloud]].\r\n * @beta\r\n */\r\nexport class PointCloudDisplaySettings {\r\n  /** The shape drawn for each point in the cloud.\r\n   * Default: \"round\".\r\n   */\r\n  public readonly shape: PointCloudShape;\r\n  /** The method by which the size of each individual point is computed.\r\n   * Default: \"voxel\".\r\n   * @see [[pixelSize]] to configure the size for \"pixel\" mode.\r\n   * @see [[voxelScale]], [[minPixelsPerVoxel]], and [[maxPixelsPerVoxel]] to configure the size for \"voxel\" mode.\r\n   */\r\n  public readonly sizeMode: PointCloudSizeMode;\r\n  /** The radius of each point in pixels, when [[sizeMode]] is \"pixel\".\r\n   * The size is expected to be a positive integer. The maximum size will vary based on the graphics hardware in use, but typically is limited to 32 or 64 pixels.\r\n   * Default: 1\r\n   */\r\n  public readonly pixelSize: number;\r\n  /** A scale factor applied to the size of each point, when [[sizeMode]] is \"voxel\".\r\n   * The scale is expected to be a positive floating point number.\r\n   * Default: 1.0\r\n   */\r\n  public readonly voxelScale: number;\r\n  /** If [[sizeMode]] is \"voxel\", the minimum radius of each point in pixels. It is expected to be a positive integer no greater than [[maxPixelsPerVoxel]].\r\n   * Default: 2\r\n   */\r\n  public readonly minPixelsPerVoxel: number;\r\n  /** If [[sizeMode]] is \"voxel\", the maximum radius of each point in pixels. It is expected to be a positive integer no less than [[minPixelsPerVoxel]].\r\n   * Default: 20.\r\n   */\r\n  public readonly maxPixelsPerVoxel: number;\r\n  /** The mode for the Eye-Dome Lighting (EDL) effect.\r\n   * Default: \"off\"\r\n   * @note EDL mode is ignored (off) if the view is not perspective (camera is off)\r\n   */\r\n  public readonly edlMode: PointCloudEDLMode;\r\n  /** A strength value for the Eye Dome Lighting (EDL) effect.\r\n   * The strength is expected to be a positive floating point number.\r\n   * Default: 5.0\r\n   */\r\n  public readonly edlStrength: number;\r\n  /** A radius value for the Eye Dome Lighting (EDL) effect.\r\n   * The radius is expected to be a positive floating point number\r\n   * It is used to deterimine how far away in pixels to sample for depth change\r\n   * Default: 2.0\r\n   */\r\n  public readonly edlRadius: number;\r\n  /** A flag for whether or not to apply filtering pass in the Eye Dome Lighting (EDL) effect.\r\n   * It only applies if edlMode is \"full\"\r\n   * Default: 1.0\r\n   */\r\n  public readonly edlFilter?: number;\r\n  /** A weighting value to apply to the full image when combining it with the half and quarter sized ones\r\n   * It only applies if edlMode is \"full\"\r\n   * The strength is expected to be a floating point number between 0 and 1 inclusive.\r\n   * Default: 1.0\r\n   */\r\n  public readonly edlMixWts1?: number;\r\n  /** A weighting value to apply to the half sized image when combining it with the full and quarter sized ones\r\n   * It only applies if edlMode is \"full\"\r\n   * The strength is expected to be a floating point number between 0 and 1 inclusive.\r\n   * Default: 0.5\r\n   */\r\n  public readonly edlMixWts2?: number;\r\n  /** A weighting value to apply to the quarter sized image when combining it with the full and half sized ones\r\n   * It only applies if edlMode is \"full\"\r\n   * The strength is expected to be a floating point number between 0 and 1 inclusive.\r\n   * Default: 0.25\r\n   */\r\n  public readonly edlMixWts4?: number;\r\n\r\n  /** Settings with all properties initialized to their default values. */\r\n  public static defaults = new PointCloudDisplaySettings();\r\n\r\n  private constructor(props?: PointCloudDisplayProps) {\r\n    this.shape = props?.shape ?? \"round\";\r\n    this.sizeMode = props?.sizeMode ?? \"voxel\";\r\n\r\n    // No sanity checks here - e.g., min < max, pixelSize and voxelScale > 0, etc.\r\n    this.pixelSize = props?.pixelSize ?? 1;\r\n    this.voxelScale = props?.voxelScale ?? 1;\r\n    this.minPixelsPerVoxel = props?.minPixelsPerVoxel ?? 2;\r\n    this.maxPixelsPerVoxel = props?.maxPixelsPerVoxel ?? 20;\r\n    this.edlMode = props?.edlMode ?? \"off\";\r\n    this.edlStrength = props?.edlStrength ?? 5;\r\n    this.edlRadius = props?.edlRadius ?? 2;\r\n    this.edlFilter = props?.edlFilter ?? 1;\r\n    this.edlMixWts1 = props?.edlMixWts1 ?? 1.0;\r\n    this.edlMixWts2 = props?.edlMixWts2 ?? 0.5;\r\n    this.edlMixWts4 = props?.edlMixWts4 ?? 0.25;\r\n  }\r\n\r\n  /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */\r\n  public static fromJSON(props?: PointCloudDisplayProps): PointCloudDisplaySettings {\r\n    return props ? new PointCloudDisplaySettings(props) : this.defaults;\r\n  }\r\n\r\n  /** Convert these settings to their JSON representation. */\r\n  public toJSON(): PointCloudDisplayProps | undefined {\r\n    const defs = PointCloudDisplaySettings.defaults;\r\n    if (this.equals(defs))\r\n      return undefined;\r\n\r\n    const props: PointCloudDisplayProps = { };\r\n    if (this.shape !== defs.shape)\r\n      props.shape = this.shape;\r\n\r\n    if (this.sizeMode !== defs.sizeMode)\r\n      props.sizeMode = this.sizeMode;\r\n\r\n    if (this.pixelSize !== defs.pixelSize)\r\n      props.pixelSize = this.pixelSize;\r\n\r\n    if (this.voxelScale !== defs.voxelScale)\r\n      props.voxelScale = this.voxelScale;\r\n\r\n    if (this.minPixelsPerVoxel !== defs.minPixelsPerVoxel)\r\n      props.minPixelsPerVoxel = this.minPixelsPerVoxel;\r\n\r\n    if (this.maxPixelsPerVoxel !== defs.maxPixelsPerVoxel)\r\n      props.maxPixelsPerVoxel = this.maxPixelsPerVoxel;\r\n\r\n    if (this.edlMode !== defs.edlMode)\r\n      props.edlMode = this.edlMode;\r\n\r\n    if (this.edlStrength !== defs.edlStrength)\r\n      props.edlStrength = this.edlStrength;\r\n\r\n    if (this.edlRadius !== defs.edlRadius)\r\n      props.edlRadius = this.edlRadius;\r\n\r\n    if (this.edlFilter !== defs.edlFilter)\r\n      props.edlFilter = this.edlFilter;\r\n\r\n    if (this.edlMixWts1 !== defs.edlMixWts1)\r\n      props.edlMixWts1 = this.edlMixWts1;\r\n\r\n    if (this.edlMixWts2 !== defs.edlMixWts2)\r\n      props.edlMixWts2 = this.edlMixWts2;\r\n\r\n    if (this.edlMixWts4 !== defs.edlMixWts4)\r\n      props.edlMixWts4 = this.edlMixWts4;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */\r\n  public clone(changedProps: PointCloudDisplayProps): PointCloudDisplaySettings {\r\n    return PointCloudDisplaySettings.fromJSON({\r\n      ...this.toJSON(),\r\n      ...changedProps,\r\n    });\r\n  }\r\n\r\n  /** Returns true if these settings are identical to `other`. */\r\n  public equals(other: PointCloudDisplaySettings): boolean {\r\n    if (this === other)\r\n      return true;\r\n\r\n    return this.shape === other.shape && this.sizeMode === other.sizeMode && this.pixelSize === other.pixelSize\r\n      && this.voxelScale === other.voxelScale && this.minPixelsPerVoxel === other.minPixelsPerVoxel && this.maxPixelsPerVoxel === other.maxPixelsPerVoxel\r\n      && this.edlMode === other.edlMode && this.edlStrength === other.edlStrength && this.edlRadius === other.edlRadius\r\n      && this.edlFilter === other.edlFilter\r\n      && this.edlMixWts1 === other.edlMixWts1 && this.edlMixWts2 === other.edlMixWts2 && this.edlMixWts4 === other.edlMixWts4\r\n    ;\r\n  }\r\n}\r\n\r\n/** Settings that control how a reality model - whether a [[ContextRealityModel]] or a persistent reality [Model]($backend) - is displayed within a [Viewport]($frontend).\r\n * @see [[ContextRealityModel.displaySettings]] to apply these settings to a context reality model.\r\n * @see [[DisplayStyleSettings.setRealityModelDisplaySettings]] to apply these settings to a persistent reality model.\r\n * @note This is an immutable type - to modify its properties, use [[clone]].\r\n * @beta\r\n */\r\nexport class RealityModelDisplaySettings {\r\n  /** If the reality model's color is overridden with another color, a ratio in [0..1] with which to mix the two colors together.\r\n   * A ratio of 0 uses only the reality model's color, a ratio of 1 uses only the override color, and a ratio of 0.5 mixes the two colors equally.\r\n   * The color may be overridden using [[FeatureOverrides]] such as those supplied by a [FeatureOverrideProvider]($frontend), or by applying a [[SpatialClassifier]].\r\n   * Default: 0.5\r\n   */\r\n  public readonly overrideColorRatio: number;\r\n  /** Settings that apply specifically to point cloud reality models.\r\n   * Default: [[PointCloudDisplaySettings.defaults]].\r\n   */\r\n  public readonly pointCloud: PointCloudDisplaySettings;\r\n\r\n  /** Settings with all properties initialized to their default values. */\r\n  public static defaults = new RealityModelDisplaySettings(undefined, PointCloudDisplaySettings.defaults);\r\n\r\n  private constructor(overrideColorRatio: number | undefined, pointCloud: PointCloudDisplaySettings) {\r\n    this.overrideColorRatio = overrideColorRatio ?? 0.5;\r\n    this.pointCloud = pointCloud;\r\n  }\r\n\r\n  /** Create display settings from their JSON representation. If `props` is `undefined`, the default settings are returned. */\r\n  public static fromJSON(props?: RealityModelDisplayProps): RealityModelDisplaySettings {\r\n    if (!props)\r\n      return this.defaults;\r\n\r\n    return new RealityModelDisplaySettings(props.overrideColorRatio, PointCloudDisplaySettings.fromJSON(props.pointCloud));\r\n  }\r\n\r\n  /** Convert these settings to their JSON representation, which is `undefined` if all of their properties match the default settings. */\r\n  public toJSON(): RealityModelDisplayProps | undefined {\r\n    const pointCloud = this.pointCloud.toJSON();\r\n    const overrideColorRatio = this.overrideColorRatio === RealityModelDisplaySettings.defaults.overrideColorRatio ? undefined : this.overrideColorRatio;\r\n\r\n    if (undefined === pointCloud && undefined === overrideColorRatio)\r\n      return undefined;\r\n\r\n    const props: RealityModelDisplayProps = { };\r\n    if (undefined !== pointCloud)\r\n      props.pointCloud = pointCloud;\r\n\r\n    if (undefined !== overrideColorRatio)\r\n      props.overrideColorRatio = overrideColorRatio;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if these settings are identical to `other`. */\r\n  public equals(other: RealityModelDisplaySettings): boolean {\r\n    if (this === other)\r\n      return true;\r\n\r\n    return this.overrideColorRatio === other.overrideColorRatio && this.pointCloud.equals(other.pointCloud);\r\n  }\r\n\r\n  /** Create a copy of these settings, identical except for any properties explicitly specified by `changedProps`. */\r\n  public clone(changedProps: RealityModelDisplayProps): RealityModelDisplaySettings {\r\n    const pointCloud = changedProps.pointCloud ? this.pointCloud.clone(changedProps.pointCloud) : this.pointCloud;\r\n    const colorRatio = changedProps.hasOwnProperty(\"overrideColorRatio\") ? changedProps.overrideColorRatio : this.overrideColorRatio;\r\n    return new RealityModelDisplaySettings(colorRatio, pointCloud);\r\n  }\r\n}\r\n"]}

package/lib/cjs/ViewFlags.d.ts

@@ -90,9 +90,7 @@ export interface ViewFlagProps {
     ambientOcclusion?: boolean;
     /** If true, apply [[ThematicDisplay]]. */
     thematicDisplay?: boolean;
-    /** If true, overlay surfaces with wiremesh to reveal their triangulation.
-     * @beta
-     */
+    /** If true, overlay surfaces with wiremesh to reveal their triangulation. */
     wiremesh?: boolean;
     /** Controls whether surface discard is always applied regardless of other ViewFlags.
      * Surface shaders contain complicated logic to ensure that the edges of a surface always draw in front of the surface, and that planar surfaces sketched coincident with
@@ -192,9 +190,7 @@ export declare class ViewFlags {
     readonly ambientOcclusion: boolean;
     /** Whether to apply [[ThematicDisplay]]. Default: false. */
     readonly thematicDisplay: boolean;
-    /** If true, overlay surfaces with wiremesh to reveal their triangulation.
-     * @beta
-     */
+    /** If true, overlay surfaces with wiremesh to reveal their triangulation. */
     readonly wiremesh: boolean;
     /** Controls whether surface discard is always applied regardless of other ViewFlags.
      * Surface shaders contain complicated logic to ensure that the edges of a surface always draw in front of the surface, and that planar surfaces sketched coincident with

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

@@ -1 +1 @@
-{"version":3,"file":"ViewFlags.d.ts","sourceRoot":"","sources":["../../src/ViewFlags.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAa,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAElF;;;;GAIG;AACH,oBAAY,UAAU;IACpB;;;;OAIG;IACH,SAAS,IAAI;IACb;;;;OAIG;IACH,WAAW,IAAI;IACf;;;;;OAKG;IACH,SAAS,IAAI;IACb;;;OAGG;IACH,UAAU,IAAI;CACf;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC5B,+EAA+E;IAC/E,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,4EAA4E;IAC5E,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kDAAkD;IAClD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,wDAAwD;IACxD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uFAAuF;IACvF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,2CAA2C;IAC3C,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,6EAA6E;IAC7E,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,2DAA2D;IAC3D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,yEAAyE;IACzE,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yEAAyE;IACzE,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yEAAyE;IACzE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sFAAsF;IACtF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gCAAgC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,iHAAiH;IACjH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oJAAoJ;IACpJ,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,2EAA2E;IAC3E,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,gCAAgC;IAChC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,0CAA0C;IAC1C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAMD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,SAAS;IACpB;;;OAGG;IACH,SAAgB,UAAU,EAAE,UAAU,CAAC;IACvC,uFAAuF;IACvF,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC,qFAAqF;IACrF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,iGAAiG;IACjG,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,sIAAsI;IACtI,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC,qIAAqI;IACrI,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B,qGAAqG;IACrG,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,sGAAsG;IACtG,SAAgB,SAAS,EAAE,OAAO,CAAC;IACnC,8GAA8G;IAC9G,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,iDAAiD;IACjD,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;;;OAIG;IACH,SAAgB,WAAW,EAAE,OAAO,CAAC;IACrC;;OAEG;IACH,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC;;;OAGG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,4FAA4F;IAC5F,SAAgB,gBAAgB,EAAE,OAAO,CAAC;IAC1C,4DAA4D;IAC5D,SAAgB,eAAe,EAAE,OAAO,CAAC;IACzC;;OAEG;IACH,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC;;;;;OAKG;IACH,SAAgB,mBAAmB,EAAE,OAAO,CAAC;IAC7C;;;;OAIG;IACH,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAE9C;;;OAGG;IACH,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAElC;;OAEG;gBACgB,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC;IA2BvD;;;;;OAKG;IACI,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IAIlE;;;;OAIG;IACI,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IA4BnE;;;;;;OAMG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,mBAAmB,EAAE,YAAY,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,SAAS;IAS3F;;;;OAIG;IACI,cAAc,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS;IAIxD;;OAEG;IACI,SAAS,IAAI,SAAS;IAoB7B,gBAAgB;IACT,kBAAkB,IAAI,OAAO;IAWpC,wHAAwH;IACjH,aAAa,IAAI,OAAO;IAI/B,sCAAsC;IAC/B,MAAM,IAAI,aAAa;IAqD9B;;OAEG;IACI,kBAAkB,IAAI,QAAQ,CAAC,aAAa,CAAC;IA+BpD,kFAAkF;IAClF,gBAAuB,QAAQ,YAAmB;IAElD;;OAEG;WACW,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IAIrE;;;;;;;OAOG;WACW,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,GAAG,SAAS;IA0CvD,yDAAyD;IAClD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,mBAAmB,CAAC,GAAG,OAAO;CA6B7D;AAED;;;;GAIG;AACH,oBAAY,mBAAmB,GAAG,OAAO,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,CAAC;AAE9E;;;;GAIG;AACH,oBAAY,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC"}
+{"version":3,"file":"ViewFlags.d.ts","sourceRoot":"","sources":["../../src/ViewFlags.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAa,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAElF;;;;GAIG;AACH,oBAAY,UAAU;IACpB;;;;OAIG;IACH,SAAS,IAAI;IACb;;;;OAIG;IACH,WAAW,IAAI;IACf;;;;;OAKG;IACH,SAAS,IAAI;IACb;;;OAGG;IACH,UAAU,IAAI;CACf;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa;IAC5B,+EAA+E;IAC/E,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,4EAA4E;IAC5E,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kDAAkD;IAClD,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,wDAAwD;IACxD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uFAAuF;IACvF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,2CAA2C;IAC3C,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,6EAA6E;IAC7E,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,2DAA2D;IAC3D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,4DAA4D;IAC5D,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,yEAAyE;IACzE,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yEAAyE;IACzE,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,yEAAyE;IACzE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,sFAAsF;IACtF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gCAAgC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,iHAAiH;IACjH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oJAAoJ;IACpJ,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,2EAA2E;IAC3E,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,gCAAgC;IAChC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,0CAA0C;IAC1C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CAClC;AAMD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,SAAS;IACpB;;;OAGG;IACH,SAAgB,UAAU,EAAE,UAAU,CAAC;IACvC,uFAAuF;IACvF,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC,qFAAqF;IACrF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,iGAAiG;IACjG,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,sIAAsI;IACtI,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC,qIAAqI;IACrI,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B,qGAAqG;IACrG,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,sGAAsG;IACtG,SAAgB,SAAS,EAAE,OAAO,CAAC;IACnC,8GAA8G;IAC9G,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,iDAAiD;IACjD,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;;;OAIG;IACH,SAAgB,WAAW,EAAE,OAAO,CAAC;IACrC;;OAEG;IACH,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC;;;OAGG;IACH,SAAgB,UAAU,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,4FAA4F;IAC5F,SAAgB,gBAAgB,EAAE,OAAO,CAAC;IAC1C,4DAA4D;IAC5D,SAAgB,eAAe,EAAE,OAAO,CAAC;IACzC,6EAA6E;IAC7E,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC;;;;;OAKG;IACH,SAAgB,mBAAmB,EAAE,OAAO,CAAC;IAC7C;;;;OAIG;IACH,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAE9C;;;OAGG;IACH,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAElC;;OAEG;gBACgB,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC;IA2BvD;;;;;OAKG;IACI,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IAIlE;;;;OAIG;IACI,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IA4BnE;;;;;;OAMG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,mBAAmB,EAAE,YAAY,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,SAAS;IAS3F;;;;OAIG;IACI,cAAc,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS;IAIxD;;OAEG;IACI,SAAS,IAAI,SAAS;IAoB7B,gBAAgB;IACT,kBAAkB,IAAI,OAAO;IAWpC,wHAAwH;IACjH,aAAa,IAAI,OAAO;IAI/B,sCAAsC;IAC/B,MAAM,IAAI,aAAa;IAqD9B;;OAEG;IACI,kBAAkB,IAAI,QAAQ,CAAC,aAAa,CAAC;IA+BpD,kFAAkF;IAClF,gBAAuB,QAAQ,YAAmB;IAElD;;OAEG;WACW,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,SAAS;IAIrE;;;;;;;OAOG;WACW,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,GAAG,SAAS;IA0CvD,yDAAyD;IAClD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,mBAAmB,CAAC,GAAG,OAAO;CA6B7D;AAED;;;;GAIG;AACH,oBAAY,mBAAmB,GAAG,OAAO,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,CAAC;AAE9E;;;;GAIG;AACH,oBAAY,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC"}