@itwin/core-common 4.6.0-dev.9 → 4.7.0-dev.3

package/lib/esm/ViewDetails.js.map

@@ -1 +1 @@
-{"version":3,"file":"ViewDetails.js","sourceRoot":"","sources":["../../src/ViewDetails.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAc,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACnF,OAAO,EAAE,UAAU,EAAmB,QAAQ,EAAS,MAAM,sBAAsB,CAAC;AACpF,OAAO,EAAuB,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAyBxE;;;GAGG;AACH,MAAM,CAAN,IAAY,mBAWX;AAXD,WAAY,mBAAmB;IAC7B,8BAA8B;IAC9B,6DAAQ,CAAA;IACR,UAAU;IACV,mEAAW,CAAA;IACX,YAAY;IACZ,mEAAW,CAAA;IACX,YAAY;IACZ,mEAAW,CAAA;IACX,mDAAmD;IACnD,qEAAY,CAAA;AACd,CAAC,EAXW,mBAAmB,KAAnB,mBAAmB,QAW9B;AAcD;;;;GAIG;AACH,MAAa,WAAW;IAQtB,gBAAgB;IAChB,YAAmB,cAAkD;QAJrE,0EAA0E;QAC1D,wBAAmB,GAAG,IAAI,OAAO,EAA6C,CAAC;QAI7F,IAAI,CAAC,cAAc,CAAC,WAAW;YAC7B,cAAc,CAAC,WAAW,GAAG,EAAE,CAAC;QAElC,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC,WAAW,CAAC;IAC1C,CAAC;IAED,8DAA8D;IAC9D,IAAW,2BAA2B;QACpC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACvC,CAAC;IACD,IAAW,2BAA2B,CAAC,EAAc;QACnD,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IACzD,CAAC;IAKD,0FAA0F;IAC1F,IAAW,eAAe;QACxB,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC;QACpC,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QAC5D,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IACD,IAAW,eAAe,CAAC,IAAY;QACrC,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1D,CAAC;IAED,0CAA0C;IAC1C,IAAW,eAAe;QACxB,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC7E,CAAC;IACD,IAAW,eAAe,CAAC,WAAgC;QACzD,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,mBAAmB,CAAC,OAAO,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC;IAChG,CAAC;IAED,gDAAgD;IAChD,IAAW,WAAW;QACpB,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IACpD,CAAC;IACD,IAAW,WAAW,CAAC,WAAmB;QACxC,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,EAAE,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC;IACvE,CAAC;IAED,qCAAqC;IACrC,IAAW,WAAW;QACpB,MAAM,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;QACvD,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IAClB,CAAC;IACD,IAAW,WAAW,CAAC,OAAc;QACnC,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAClE,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,OAAO,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW,EAAE;YAClC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAC7B,IAAI,CAAC,WAAW,GAAG,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;SAChG;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;IACjE,CAAC;IACD,IAAW,UAAU,CAAC,IAA4B;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC;QAChC,IAAI,OAAO,KAAK,IAAI;YAClB,OAAO;QAET,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC;YAE3B,0CAA0C;YAC1C,IAAI,CAAC,IAAI,CAAC,OAAO;gBACf,OAAO;SACV;QAED,IAAI,GAAG,IAAI,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC;QAExC,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAErE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,IAAI,CAAC,OAAO;YACd,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;;YAEhC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;;AAhFD,+EAA+E;AACjE,mBAAO,GAAG,EAAE,AAAL,CAAM;SAzBhB,WAAW;AA2GxB;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAG5C,IAAY,OAAO;QACjB,OAAO,IAAI,CAAC,KAA2B,CAAC;IAC1C,CAAC;IAKD,gBAAgB;IAChB,YAAmB,cAAoD;QACrE,KAAK,CAAC,cAAc,CAAC,CAAC;QALxB,oFAAoF;QACpE,6BAAwB,GAAG,IAAI,OAAO,EAAwC,CAAC;IAK/F,CAAC;IAED,yFAAyF;IACzF,IAAW,oBAAoB;QAC7B,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC;IACvE,CAAC;IACD,IAAW,oBAAoB,CAAC,KAAc;QAC5C,IAAI,CAAC,OAAO,CAAC,sBAAsB,GAAG,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACH,IAAW,eAAe;QACxB,IAAI,CAAC,IAAI,CAAC,gBAAgB;YACxB,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAEjF,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IACD,IAAW,eAAe,CAAC,MAAuB;QAChD,IAAI,CAAC,wBAAwB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACjD,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC;QAC/B,IAAI,CAAC,OAAO,CAAC,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;IACjD,CAAC;IAED;;OAEG;IACa,OAAO;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Views\r\n */\r\n\r\nimport { assert, BeEvent, Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\r\nimport { ClipVector, ClipVectorProps, Geometry, XAndY } from \"@itwin/core-geometry\";\r\nimport { ModelClipGroupProps, ModelClipGroups } from \"./ModelClipGroup\";\r\n\r\n/** Properties of a [[ViewDefinitionProps]] stored as JSON.\r\n * @see [[ViewDefinitionProps.jsonProperties]].\r\n * @see [[ViewDetails3dProps]] for additional properties specific to 3d views.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ViewDetailsProps {\r\n  /** Id of the aux coord system. Default: invalid. */\r\n  acs?: Id64String;\r\n  /** Aspect ratio skew (x/y) used to exaggerate the y axis of the view. Default: 1.0. */\r\n  aspectSkew?: number;\r\n  /** Grid orientation. Default: WorldXY. */\r\n  gridOrient?: GridOrientationType;\r\n  /** Default: 10. */\r\n  gridPerRef?: number;\r\n  /** Default: 1.0. */\r\n  gridSpaceX?: number;\r\n  /** Default: same as gridSpaceX. */\r\n  gridSpaceY?: number;\r\n  /** Describes the [ClipVector]($core-geometry) applied to the view. */\r\n  clip?: ClipVectorProps;\r\n}\r\n\r\n/** Describes the orientation of the grid displayed within a [Viewport]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport enum GridOrientationType {\r\n  /** Oriented with the view. */\r\n  View = 0,\r\n  /** Top */\r\n  WorldXY = 1,\r\n  /** Right */\r\n  WorldYZ = 2,\r\n  /** Front */\r\n  WorldXZ = 3,\r\n  /** Oriented by the auxiliary coordinate system. */\r\n  AuxCoord = 4,\r\n}\r\n\r\n/** Properties of a [[ViewDefinition3dProps]] stored as JSON.\r\n * @see [[ViewDefinition3dProps.jsonProperties]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ViewDetails3dProps extends ViewDetailsProps {\r\n  /** Whether viewing tools are prohibited from operating in 3 dimensions on this view. Default: false. */\r\n  disable3dManipulations?: boolean;\r\n  /** Defines how to clip groups of models. */\r\n  modelClipGroups?: ModelClipGroupProps[];\r\n}\r\n\r\n/** Encapsulates access to optional view details stored in JSON properties.\r\n * @see [[ViewDetailsProps]] for the JSON representation.\r\n * @see [ViewDefinition.details]($backend) and [ViewState.details]($frontend).\r\n * @public\r\n */\r\nexport class ViewDetails {\r\n  /** @internal */\r\n  protected readonly _json: ViewDetailsProps;\r\n  private _clipVector?: ClipVector;\r\n\r\n  /** Event raised just before assignment to the [[clipVector]] property. */\r\n  public readonly onClipVectorChanged = new BeEvent<(newClip: ClipVector | undefined) => void>();\r\n\r\n  /** @internal */\r\n  public constructor(jsonProperties: { viewDetails?: ViewDetailsProps }) {\r\n    if (!jsonProperties.viewDetails)\r\n      jsonProperties.viewDetails = {};\r\n\r\n    this._json = jsonProperties.viewDetails;\r\n  }\r\n\r\n  /** The Id of the auxiliary coordinate system for the view. */\r\n  public get auxiliaryCoordinateSystemId(): Id64String {\r\n    return Id64.fromJSON(this._json.acs);\r\n  }\r\n  public set auxiliaryCoordinateSystemId(id: Id64String) {\r\n    this._json.acs = Id64.isValidId64(id) ? id : undefined;\r\n  }\r\n\r\n  /** Maximum aspect ratio skew. Apps can override this by changing its value. */\r\n  public static maxSkew = 25;\r\n\r\n  /** The aspect ratio skew (x/y, usually 1.0) used to exaggerate the y axis of the view. */\r\n  public get aspectRatioSkew(): number {\r\n    const maxSkew = ViewDetails.maxSkew;\r\n    const skew = JsonUtils.asDouble(this._json.aspectSkew, 1.0);\r\n    return Geometry.clamp(skew, 1 / maxSkew, maxSkew);\r\n  }\r\n  public set aspectRatioSkew(skew: number) {\r\n    this._json.aspectSkew = 1.0 !== skew ? skew : undefined;\r\n  }\r\n\r\n  /** The orientation of the view's grid. */\r\n  public get gridOrientation(): GridOrientationType {\r\n    return JsonUtils.asInt(this._json.gridOrient, GridOrientationType.WorldXY);\r\n  }\r\n  public set gridOrientation(orientation: GridOrientationType) {\r\n    this._json.gridOrient = GridOrientationType.WorldXY === orientation ? undefined : orientation;\r\n  }\r\n\r\n  /** The number of grids per ref for the view. */\r\n  public get gridsPerRef(): number {\r\n    return JsonUtils.asInt(this._json.gridPerRef, 10);\r\n  }\r\n  public set gridsPerRef(gridsPerRef: number) {\r\n    this._json.gridPerRef = 10 === gridsPerRef ? undefined : gridsPerRef;\r\n  }\r\n\r\n  /** The grid spacing for the view. */\r\n  public get gridSpacing(): XAndY {\r\n    const x = JsonUtils.asDouble(this._json.gridSpaceX, 1.0);\r\n    const y = JsonUtils.asDouble(this._json.gridSpaceY, x);\r\n    return { x, y };\r\n  }\r\n  public set gridSpacing(spacing: XAndY) {\r\n    this._json.gridSpaceX = 1.0 !== spacing.x ? spacing.x : undefined;\r\n    this._json.gridSpaceY = spacing.x !== spacing.y ? spacing.y : undefined;\r\n  }\r\n\r\n  /** Clipping volume for the view.\r\n   * @note Do *not* modify the returned ClipVector. If you wish to change the ClipVector, clone the returned ClipVector, modify it as desired, and pass the clone back to the setter.\r\n   */\r\n  public get clipVector(): ClipVector | undefined {\r\n    if (undefined === this._clipVector) {\r\n      const clip = this._json.clip;\r\n      this._clipVector = (undefined !== clip ? ClipVector.fromJSON(clip) : ClipVector.createEmpty());\r\n    }\r\n\r\n    return this._clipVector.isValid ? this._clipVector : undefined;\r\n  }\r\n  public set clipVector(clip: ClipVector | undefined) {\r\n    const curClip = this.clipVector;\r\n    if (curClip === clip)\r\n      return;\r\n\r\n    if (!curClip) {\r\n      assert(undefined !== clip);\r\n\r\n      // An empty clip is equivalent to no clip.\r\n      if (!clip.isValid)\r\n        return;\r\n    }\r\n\r\n    clip = clip ?? ClipVector.createEmpty();\r\n\r\n    this.onClipVectorChanged.raiseEvent(clip.isValid ? clip : undefined);\r\n\r\n    this._clipVector = clip;\r\n    if (clip.isValid)\r\n      this._json.clip = clip.toJSON();\r\n    else\r\n      delete this._json.clip;\r\n  }\r\n\r\n  /** Returns the internal JSON representation. This is *not* a copy.\r\n   * @internal\r\n   */\r\n  public getJSON(): Readonly<ViewDetailsProps> {\r\n    return this._json;\r\n  }\r\n}\r\n\r\n/** Encapsulates access to optional 3d view details stored in JSON properties.\r\n * @see [[ViewDetails3dProps]] for the JSON representation.\r\n * @public\r\n */\r\nexport class ViewDetails3d extends ViewDetails {\r\n  private _modelClipGroups?: ModelClipGroups;\r\n\r\n  private get _json3d(): ViewDetails3dProps {\r\n    return this._json as ViewDetails3dProps;\r\n  }\r\n\r\n  /** Event raised when just before assignment to the [[modelClipGroups]] property. */\r\n  public readonly onModelClipGroupsChanged = new BeEvent<(newGroups: ModelClipGroups) => void>();\r\n\r\n  /** @internal */\r\n  public constructor(jsonProperties: { viewDetails?: ViewDetails3dProps }) {\r\n    super(jsonProperties);\r\n  }\r\n\r\n  /** Controls whether viewing tools are allowed to operate on the view in 3 dimensions. */\r\n  public get allow3dManipulations(): boolean {\r\n    return !JsonUtils.asBool(this._json3d.disable3dManipulations, false);\r\n  }\r\n  public set allow3dManipulations(allow: boolean) {\r\n    this._json3d.disable3dManipulations = allow ? undefined : true;\r\n  }\r\n\r\n  /** Groups of models associated with [ClipVector]($core-geometry)s by which those models should be clipped.\r\n   * If the view and the model both have a clip vector defined, geometry in the model will be clipped by the intersection of the two clip vectors.\r\n   * [[ViewFlags.clipVolume]] has no effect on model clips, only the view clip - model clips are always applied.\r\n   * @note Do **not** modify the returned object directly. Instead, clone it, modify the clone, and pass the clone to the property setter.\r\n   */\r\n  public get modelClipGroups(): ModelClipGroups {\r\n    if (!this._modelClipGroups)\r\n      this._modelClipGroups = ModelClipGroups.fromJSON(this._json3d.modelClipGroups);\r\n\r\n    return this._modelClipGroups;\r\n  }\r\n  public set modelClipGroups(groups: ModelClipGroups) {\r\n    this.onModelClipGroupsChanged.raiseEvent(groups);\r\n    this._modelClipGroups = groups;\r\n    this._json3d.modelClipGroups = groups.toJSON();\r\n  }\r\n\r\n  /** Returns the internal JSON representation. This is *not* a copy.\r\n   * @internal\r\n   */\r\n  public override getJSON(): Readonly<ViewDetails3dProps> {\r\n    return this._json3d;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ViewDetails.js","sourceRoot":"","sources":["../../src/ViewDetails.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAc,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACnF,OAAO,EAAE,UAAU,EAAmB,QAAQ,EAAS,MAAM,sBAAsB,CAAC;AACpF,OAAO,EAAuB,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAyBxE;;;GAGG;AACH,MAAM,CAAN,IAAY,mBAWX;AAXD,WAAY,mBAAmB;IAC7B,8BAA8B;IAC9B,6DAAQ,CAAA;IACR,UAAU;IACV,mEAAW,CAAA;IACX,YAAY;IACZ,mEAAW,CAAA;IACX,YAAY;IACZ,mEAAW,CAAA;IACX,mDAAmD;IACnD,qEAAY,CAAA;AACd,CAAC,EAXW,mBAAmB,KAAnB,mBAAmB,QAW9B;AAcD;;;;GAIG;AACH,MAAM,OAAO,WAAW;IAQtB,gBAAgB;IAChB,YAAmB,cAAkD;QAJrE,0EAA0E;QAC1D,wBAAmB,GAAG,IAAI,OAAO,EAA6C,CAAC;QAI7F,IAAI,CAAC,cAAc,CAAC,WAAW;YAC7B,cAAc,CAAC,WAAW,GAAG,EAAE,CAAC;QAElC,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC,WAAW,CAAC;IAC1C,CAAC;IAED,8DAA8D;IAC9D,IAAW,2BAA2B;QACpC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACvC,CAAC;IACD,IAAW,2BAA2B,CAAC,EAAc;QACnD,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IACzD,CAAC;IAKD,0FAA0F;IAC1F,IAAW,eAAe;QACxB,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC;QACpC,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QAC5D,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;IACD,IAAW,eAAe,CAAC,IAAY;QACrC,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1D,CAAC;IAED,0CAA0C;IAC1C,IAAW,eAAe;QACxB,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC7E,CAAC;IACD,IAAW,eAAe,CAAC,WAAgC;QACzD,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,mBAAmB,CAAC,OAAO,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC;IAChG,CAAC;IAED,gDAAgD;IAChD,IAAW,WAAW;QACpB,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IACpD,CAAC;IACD,IAAW,WAAW,CAAC,WAAmB;QACxC,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,EAAE,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC;IACvE,CAAC;IAED,qCAAqC;IACrC,IAAW,WAAW;QACpB,MAAM,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QACzD,MAAM,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;QACvD,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;IAClB,CAAC;IACD,IAAW,WAAW,CAAC,OAAc;QACnC,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,GAAG,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAClE,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,OAAO,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,IAAI,SAAS,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC;YACnC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAC7B,IAAI,CAAC,WAAW,GAAG,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;QACjG,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;IACjE,CAAC;IACD,IAAW,UAAU,CAAC,IAA4B;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC;QAChC,IAAI,OAAO,KAAK,IAAI;YAClB,OAAO;QAET,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC;YAE3B,0CAA0C;YAC1C,IAAI,CAAC,IAAI,CAAC,OAAO;gBACf,OAAO;QACX,CAAC;QAED,IAAI,GAAG,IAAI,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC;QAExC,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAErE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,IAAI,CAAC,OAAO;YACd,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;;YAEhC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;;AAhFD,+EAA+E;AACjE,mBAAO,GAAG,EAAE,AAAL,CAAM;AAkF7B;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAW;IAG5C,IAAY,OAAO;QACjB,OAAO,IAAI,CAAC,KAA2B,CAAC;IAC1C,CAAC;IAKD,gBAAgB;IAChB,YAAmB,cAAoD;QACrE,KAAK,CAAC,cAAc,CAAC,CAAC;QALxB,oFAAoF;QACpE,6BAAwB,GAAG,IAAI,OAAO,EAAwC,CAAC;IAK/F,CAAC;IAED,yFAAyF;IACzF,IAAW,oBAAoB;QAC7B,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC;IACvE,CAAC;IACD,IAAW,oBAAoB,CAAC,KAAc;QAC5C,IAAI,CAAC,OAAO,CAAC,sBAAsB,GAAG,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACH,IAAW,eAAe;QACxB,IAAI,CAAC,IAAI,CAAC,gBAAgB;YACxB,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAEjF,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IACD,IAAW,eAAe,CAAC,MAAuB;QAChD,IAAI,CAAC,wBAAwB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACjD,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC;QAC/B,IAAI,CAAC,OAAO,CAAC,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;IACjD,CAAC;IAED;;OAEG;IACa,OAAO;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Views\r\n */\r\n\r\nimport { assert, BeEvent, Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\r\nimport { ClipVector, ClipVectorProps, Geometry, XAndY } from \"@itwin/core-geometry\";\r\nimport { ModelClipGroupProps, ModelClipGroups } from \"./ModelClipGroup\";\r\n\r\n/** Properties of a [[ViewDefinitionProps]] stored as JSON.\r\n * @see [[ViewDefinitionProps.jsonProperties]].\r\n * @see [[ViewDetails3dProps]] for additional properties specific to 3d views.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ViewDetailsProps {\r\n  /** Id of the aux coord system. Default: invalid. */\r\n  acs?: Id64String;\r\n  /** Aspect ratio skew (x/y) used to exaggerate the y axis of the view. Default: 1.0. */\r\n  aspectSkew?: number;\r\n  /** Grid orientation. Default: WorldXY. */\r\n  gridOrient?: GridOrientationType;\r\n  /** Default: 10. */\r\n  gridPerRef?: number;\r\n  /** Default: 1.0. */\r\n  gridSpaceX?: number;\r\n  /** Default: same as gridSpaceX. */\r\n  gridSpaceY?: number;\r\n  /** Describes the [ClipVector]($core-geometry) applied to the view. */\r\n  clip?: ClipVectorProps;\r\n}\r\n\r\n/** Describes the orientation of the grid displayed within a [Viewport]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport enum GridOrientationType {\r\n  /** Oriented with the view. */\r\n  View = 0,\r\n  /** Top */\r\n  WorldXY = 1,\r\n  /** Right */\r\n  WorldYZ = 2,\r\n  /** Front */\r\n  WorldXZ = 3,\r\n  /** Oriented by the auxiliary coordinate system. */\r\n  AuxCoord = 4,\r\n}\r\n\r\n/** Properties of a [[ViewDefinition3dProps]] stored as JSON.\r\n * @see [[ViewDefinition3dProps.jsonProperties]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ViewDetails3dProps extends ViewDetailsProps {\r\n  /** Whether viewing tools are prohibited from operating in 3 dimensions on this view. Default: false. */\r\n  disable3dManipulations?: boolean;\r\n  /** Defines how to clip groups of models. */\r\n  modelClipGroups?: ModelClipGroupProps[];\r\n}\r\n\r\n/** Encapsulates access to optional view details stored in JSON properties.\r\n * @see [[ViewDetailsProps]] for the JSON representation.\r\n * @see [ViewDefinition.details]($backend) and [ViewState.details]($frontend).\r\n * @public\r\n */\r\nexport class ViewDetails {\r\n  /** @internal */\r\n  protected readonly _json: ViewDetailsProps;\r\n  private _clipVector?: ClipVector;\r\n\r\n  /** Event raised just before assignment to the [[clipVector]] property. */\r\n  public readonly onClipVectorChanged = new BeEvent<(newClip: ClipVector | undefined) => void>();\r\n\r\n  /** @internal */\r\n  public constructor(jsonProperties: { viewDetails?: ViewDetailsProps }) {\r\n    if (!jsonProperties.viewDetails)\r\n      jsonProperties.viewDetails = {};\r\n\r\n    this._json = jsonProperties.viewDetails;\r\n  }\r\n\r\n  /** The Id of the auxiliary coordinate system for the view. */\r\n  public get auxiliaryCoordinateSystemId(): Id64String {\r\n    return Id64.fromJSON(this._json.acs);\r\n  }\r\n  public set auxiliaryCoordinateSystemId(id: Id64String) {\r\n    this._json.acs = Id64.isValidId64(id) ? id : undefined;\r\n  }\r\n\r\n  /** Maximum aspect ratio skew. Apps can override this by changing its value. */\r\n  public static maxSkew = 25;\r\n\r\n  /** The aspect ratio skew (x/y, usually 1.0) used to exaggerate the y axis of the view. */\r\n  public get aspectRatioSkew(): number {\r\n    const maxSkew = ViewDetails.maxSkew;\r\n    const skew = JsonUtils.asDouble(this._json.aspectSkew, 1.0);\r\n    return Geometry.clamp(skew, 1 / maxSkew, maxSkew);\r\n  }\r\n  public set aspectRatioSkew(skew: number) {\r\n    this._json.aspectSkew = 1.0 !== skew ? skew : undefined;\r\n  }\r\n\r\n  /** The orientation of the view's grid. */\r\n  public get gridOrientation(): GridOrientationType {\r\n    return JsonUtils.asInt(this._json.gridOrient, GridOrientationType.WorldXY);\r\n  }\r\n  public set gridOrientation(orientation: GridOrientationType) {\r\n    this._json.gridOrient = GridOrientationType.WorldXY === orientation ? undefined : orientation;\r\n  }\r\n\r\n  /** The number of grids per ref for the view. */\r\n  public get gridsPerRef(): number {\r\n    return JsonUtils.asInt(this._json.gridPerRef, 10);\r\n  }\r\n  public set gridsPerRef(gridsPerRef: number) {\r\n    this._json.gridPerRef = 10 === gridsPerRef ? undefined : gridsPerRef;\r\n  }\r\n\r\n  /** The grid spacing for the view. */\r\n  public get gridSpacing(): XAndY {\r\n    const x = JsonUtils.asDouble(this._json.gridSpaceX, 1.0);\r\n    const y = JsonUtils.asDouble(this._json.gridSpaceY, x);\r\n    return { x, y };\r\n  }\r\n  public set gridSpacing(spacing: XAndY) {\r\n    this._json.gridSpaceX = 1.0 !== spacing.x ? spacing.x : undefined;\r\n    this._json.gridSpaceY = spacing.x !== spacing.y ? spacing.y : undefined;\r\n  }\r\n\r\n  /** Clipping volume for the view.\r\n   * @note Do *not* modify the returned ClipVector. If you wish to change the ClipVector, clone the returned ClipVector, modify it as desired, and pass the clone back to the setter.\r\n   */\r\n  public get clipVector(): ClipVector | undefined {\r\n    if (undefined === this._clipVector) {\r\n      const clip = this._json.clip;\r\n      this._clipVector = (undefined !== clip ? ClipVector.fromJSON(clip) : ClipVector.createEmpty());\r\n    }\r\n\r\n    return this._clipVector.isValid ? this._clipVector : undefined;\r\n  }\r\n  public set clipVector(clip: ClipVector | undefined) {\r\n    const curClip = this.clipVector;\r\n    if (curClip === clip)\r\n      return;\r\n\r\n    if (!curClip) {\r\n      assert(undefined !== clip);\r\n\r\n      // An empty clip is equivalent to no clip.\r\n      if (!clip.isValid)\r\n        return;\r\n    }\r\n\r\n    clip = clip ?? ClipVector.createEmpty();\r\n\r\n    this.onClipVectorChanged.raiseEvent(clip.isValid ? clip : undefined);\r\n\r\n    this._clipVector = clip;\r\n    if (clip.isValid)\r\n      this._json.clip = clip.toJSON();\r\n    else\r\n      delete this._json.clip;\r\n  }\r\n\r\n  /** Returns the internal JSON representation. This is *not* a copy.\r\n   * @internal\r\n   */\r\n  public getJSON(): Readonly<ViewDetailsProps> {\r\n    return this._json;\r\n  }\r\n}\r\n\r\n/** Encapsulates access to optional 3d view details stored in JSON properties.\r\n * @see [[ViewDetails3dProps]] for the JSON representation.\r\n * @public\r\n */\r\nexport class ViewDetails3d extends ViewDetails {\r\n  private _modelClipGroups?: ModelClipGroups;\r\n\r\n  private get _json3d(): ViewDetails3dProps {\r\n    return this._json as ViewDetails3dProps;\r\n  }\r\n\r\n  /** Event raised when just before assignment to the [[modelClipGroups]] property. */\r\n  public readonly onModelClipGroupsChanged = new BeEvent<(newGroups: ModelClipGroups) => void>();\r\n\r\n  /** @internal */\r\n  public constructor(jsonProperties: { viewDetails?: ViewDetails3dProps }) {\r\n    super(jsonProperties);\r\n  }\r\n\r\n  /** Controls whether viewing tools are allowed to operate on the view in 3 dimensions. */\r\n  public get allow3dManipulations(): boolean {\r\n    return !JsonUtils.asBool(this._json3d.disable3dManipulations, false);\r\n  }\r\n  public set allow3dManipulations(allow: boolean) {\r\n    this._json3d.disable3dManipulations = allow ? undefined : true;\r\n  }\r\n\r\n  /** Groups of models associated with [ClipVector]($core-geometry)s by which those models should be clipped.\r\n   * If the view and the model both have a clip vector defined, geometry in the model will be clipped by the intersection of the two clip vectors.\r\n   * [[ViewFlags.clipVolume]] has no effect on model clips, only the view clip - model clips are always applied.\r\n   * @note Do **not** modify the returned object directly. Instead, clone it, modify the clone, and pass the clone to the property setter.\r\n   */\r\n  public get modelClipGroups(): ModelClipGroups {\r\n    if (!this._modelClipGroups)\r\n      this._modelClipGroups = ModelClipGroups.fromJSON(this._json3d.modelClipGroups);\r\n\r\n    return this._modelClipGroups;\r\n  }\r\n  public set modelClipGroups(groups: ModelClipGroups) {\r\n    this.onModelClipGroupsChanged.raiseEvent(groups);\r\n    this._modelClipGroups = groups;\r\n    this._json3d.modelClipGroups = groups.toJSON();\r\n  }\r\n\r\n  /** Returns the internal JSON representation. This is *not* a copy.\r\n   * @internal\r\n   */\r\n  public override getJSON(): Readonly<ViewDetails3dProps> {\r\n    return this._json3d;\r\n  }\r\n}\r\n"]}

package/lib/esm/ViewFlags.js

@@ -64,7 +64,7 @@ function edgesRequired(renderMode, visibleEdges) {
  * @see [[DisplayStyleSettings.viewFlags]] to define the view flags for a [DisplayStyle]($backend).
  * @public
  */
-class ViewFlags {
+export class ViewFlags {
     /** Create a new ViewFlags.
      * @param flags The properties to initialize. Any properties not specified are initialized to their default values.
      */
@@ -361,5 +361,4 @@ class ViewFlags {
 }
 /** A ViewFlags object with all properties initialized to their default values. */
 ViewFlags.defaults = new ViewFlags();
-export { ViewFlags };
 //# sourceMappingURL=ViewFlags.js.map

package/lib/esm/ViewFlags.js.map

@@ -1 +1 @@
-{"version":3,"file":"ViewFlags.js","sourceRoot":"","sources":["../../src/ViewFlags.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,qBAAqB;AAErB,OAAO,EAAE,SAAS,EAAoC,MAAM,qBAAqB,CAAC;AAElF;;;;GAIG;AACH,MAAM,CAAN,IAAY,UAyBX;AAzBD,WAAY,UAAU;IACpB;;;;OAIG;IACH,qDAAa,CAAA;IACb;;;;OAIG;IACH,yDAAe,CAAA;IACf;;;;;OAKG;IACH,qDAAa,CAAA;IACb;;;OAGG;IACH,uDAAc,CAAA;AAChB,CAAC,EAzBW,UAAU,KAAV,UAAU,QAyBrB;AA0ED,SAAS,aAAa,CAAC,UAAsB,EAAE,YAAqB;IAClE,OAAO,YAAY,IAAI,UAAU,CAAC,WAAW,KAAK,UAAU,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,SAAS;IAsFpB;;OAEG;IACH,YAAmB,KAAoC;QACrD,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,UAAU,CAAC,SAAS,CAAC;QAC5D,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,IAAI,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,IAAI,IAAI,CAAC;QACxC,IAAI,CAAC,OAAO,GAAG,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,KAAK,EAAE,MAAM,IAAI,IAAI,CAAC;QACpC,IAAI,CAAC,YAAY,GAAG,KAAK,EAAE,YAAY,IAAI,IAAI,CAAC;QAChD,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,IAAI,IAAI,IAAI,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,IAAI,IAAI,CAAC;QACxC,IAAI,CAAC,SAAS,GAAG,KAAK,EAAE,SAAS,IAAI,IAAI,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,IAAI,KAAK,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,IAAI,IAAI,KAAK,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,KAAK,EAAE,YAAY,IAAI,KAAK,CAAC;QACjD,IAAI,CAAC,WAAW,GAAG,KAAK,EAAE,WAAW,IAAI,KAAK,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,KAAK,EAAE,OAAO,IAAI,KAAK,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,IAAI,CAAC;QAC5C,IAAI,CAAC,aAAa,GAAG,KAAK,EAAE,aAAa,IAAI,KAAK,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,KAAK,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,KAAK,EAAE,aAAa,IAAI,KAAK,CAAC;QACnD,IAAI,CAAC,gBAAgB,GAAG,KAAK,EAAE,gBAAgB,IAAI,KAAK,CAAC;QACzD,IAAI,CAAC,eAAe,GAAG,KAAK,EAAE,eAAe,IAAI,KAAK,CAAC;QACvD,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,IAAI,KAAK,CAAC;QACzC,IAAI,CAAC,mBAAmB,GAAG,KAAK,EAAE,mBAAmB,IAAI,KAAK,CAAC;QAC/D,IAAI,CAAC,oBAAoB,GAAG,KAAK,EAAE,oBAAoB,IAAI,IAAI,CAAC;QAChE,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,IAAI,KAAK,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAC,YAA0C;QACpD,OAAO,SAAS,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACvG,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,SAAuC;QACrD,6IAA6I;QAC7I,eAAe;QACf,wGAAwG;QACxG,uFAAuF;QACvF,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,IAAI,aAAa,GAAG,KAAK,CAAC;QAE1B,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC7C,MAAM,GAAG,GAAG,QAA8C,CAAC;YAC3D,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YACrC,IAAI,SAAS,KAAK,aAAa,EAAE;gBAC/B,IAAI,CAAC,MAAM,EAAE;oBACX,wBAAwB;oBACxB,SAAS,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC;oBAC7B,MAAM,GAAG,IAAI,CAAC;iBACf;gBAED,6CAA6C;gBAC7C,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;aACvB;iBAAM,IAAI,aAAa,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE;gBACtC,aAAa,GAAG,IAAI,CAAC;aACtB;SACF;QAED,OAAO,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACI,IAAI,CAAC,IAAmD,EAAE,KAAc;QAC7E,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK;YACtB,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAwB,EAAE,GAAG,IAAI,EAAE,CAAC;QAC/C,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACpB,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,UAAsB;QAC1C,OAAO,UAAU,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACI,SAAS;QACd,QAAQ,IAAI,CAAC,UAAU,EAAE;YACvB,KAAK,UAAU,CAAC,SAAS;gBACvB,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,WAAW;oBACvC,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;gBAChE,MAAM;YACR,KAAK,UAAU,CAAC,WAAW;gBACzB,IAAI,CAAC,IAAI,CAAC,YAAY;oBACpB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC3C,MAAM;YACR,KAAK,UAAU,CAAC,UAAU,CAAC;YAC3B,KAAK,UAAU,CAAC,SAAS;gBACvB,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;oBACzC,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;gBAChE,MAAM;SACT;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iHAAiH;IAC1G,kBAAkB;QACvB,QAAQ,IAAI,CAAC,UAAU,EAAE;YACvB,KAAK,UAAU,CAAC,SAAS,CAAC;YAC1B,KAAK,UAAU,CAAC,UAAU;gBACxB,OAAO,IAAI,CAAC,WAAW,CAAC;YAC1B,KAAK,UAAU,CAAC,WAAW;gBACzB,OAAO,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,WAAW,CAAC;SAChD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wHAAwH;IACjH,aAAa;QAClB,OAAO,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,GAAG,GAAkB,EAAE,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,aAAa;YACrB,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,IAAI,CAAC,QAAQ;YAChB,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,IAAI,CAAC,MAAM;YACd,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,YAAY;YACpB,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,IAAI,CAAC,IAAI;YACZ,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;QACpB,IAAI,IAAI,CAAC,IAAI;YACX,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;QAClB,IAAI,IAAI,CAAC,QAAQ;YACf,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,CAAC,QAAQ;YAChB,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI,CAAC,QAAQ;YAChB,GAAG,CAAC,cAAc,GAAG,GAAG,CAAC,cAAc,GAAG,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC;QACpE,IAAI,IAAI,CAAC,YAAY;YACnB,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QACtB,IAAI,IAAI,CAAC,WAAW;YAClB,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QACtB,IAAI,IAAI,CAAC,OAAO;YACd,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,UAAU;YACjB,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,UAAU;YACjB,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;QACxB,IAAI,IAAI,CAAC,aAAa;YACpB,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC;QAC3B,IAAI,IAAI,CAAC,gBAAgB;YACvB,GAAG,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC9B,IAAI,IAAI,CAAC,eAAe;YACtB,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC;QAC7B,IAAI,IAAI,CAAC,QAAQ;YACf,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QACtB,IAAI,IAAI,CAAC,mBAAmB;YAC1B,GAAG,CAAC,mBAAmB,GAAG,IAAI,CAAC;QACjC,IAAI,CAAC,IAAI,CAAC,oBAAoB;YAC5B,GAAG,CAAC,sBAAsB,GAAG,IAAI,CAAC;QAEpC,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACjC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,sDAAsD;IAC/C,kBAAkB;QACvB,OAAO;YACL,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,WAAW,EAAE,CAAC,IAAI,CAAC,aAAa;YAChC,KAAK,EAAE,CAAC,IAAI,CAAC,UAAU;YACvB,SAAS,EAAE,CAAC,IAAI,CAAC,QAAQ;YACzB,QAAQ,EAAE,CAAC,IAAI,CAAC,OAAO;YACvB,OAAO,EAAE,CAAC,IAAI,CAAC,MAAM;YACrB,QAAQ,EAAE,CAAC,IAAI,CAAC,YAAY;YAC5B,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI;YAClB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,GAAG,EAAE,IAAI,CAAC,QAAQ;YAClB,SAAS,EAAE,CAAC,IAAI,CAAC,QAAQ;YACzB,UAAU,EAAE,CAAC,IAAI,CAAC,SAAS;YAC3B,cAAc,EAAE,CAAC,IAAI,CAAC,QAAQ;YAC9B,cAAc,EAAE,CAAC,IAAI,CAAC,QAAQ;YAC9B,YAAY,EAAE,CAAC,IAAI,CAAC,QAAQ;YAC5B,QAAQ,EAAE,IAAI,CAAC,YAAY;YAC3B,QAAQ,EAAE,IAAI,CAAC,WAAW;YAC1B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,UAAU;YACxB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;YAC7C,sBAAsB,EAAE,CAAC,IAAI,CAAC,oBAAoB;SACnD,CAAC;IACJ,CAAC;IAKD;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,KAAoC;QACvD,OAAO,KAAK,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACzF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAoB;QACzC,IAAI,CAAC,IAAI;YACP,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,IAAI,UAAsB,CAAC;QAC3B,MAAM,eAAe,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACzD,IAAI,eAAe,GAAG,UAAU,CAAC,UAAU;YACzC,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC;aAC/B,IAAI,eAAe,GAAG,UAAU,CAAC,SAAS;YAC7C,UAAU,GAAG,UAAU,CAAC,WAAW,CAAC;;YAEpC,UAAU,GAAG,eAAe,CAAC;QAE/B,MAAM,QAAQ,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1I,OAAO,IAAI,SAAS,CAAC;YACnB,UAAU;YACV,QAAQ;YACR,aAAa,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC;YAClD,UAAU,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;YACzC,QAAQ,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;YAC3C,OAAO,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YACzC,MAAM,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YACvC,YAAY,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC9C,IAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;YACpC,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;YACjC,QAAQ,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;YACpC,QAAQ,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;YAC3C,SAAS,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;YAC7C,YAAY,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC7C,WAAW,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC5C,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YACvC,UAAU,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YAC1C,UAAU,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;YAC7C,aAAa,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;YACnD,gBAAgB,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC;YACzD,eAAe,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC;YACvD,QAAQ,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YACzC,mBAAmB,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC;YAC/D,oBAAoB,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC;SACrE,CAAC,CAAC;IACL,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,KAAoC;QAChD,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;eACtC,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;eACpC,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChC,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO;eAC9B,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;eAC5B,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eACxC,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;eACxB,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChC,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;eAClC,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChC,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;eACxB,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eACxC,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;eACtC,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChC,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO;eAC9B,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;eACpC,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;eAC1C,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;eACpC,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;eAC1C,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB;eAChD,IAAI,CAAC,eAAe,KAAK,KAAK,CAAC,eAAe;eAC9C,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChC,IAAI,CAAC,mBAAmB,KAAK,KAAK,CAAC,mBAAmB;eACtD,IAAI,CAAC,oBAAoB,KAAK,KAAK,CAAC,oBAAoB,CAAC;IAChE,CAAC;;AAzFD,kFAAkF;AAC3D,kBAAQ,GAAG,IAAI,SAAS,EAAE,CAAC;SAzTvC,SAAS","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// cspell:ignore ovrs\r\n\r\nimport { JsonUtils, Mutable, NonFunctionPropertiesOf } from \"@itwin/core-bentley\";\r\n\r\n/** Enumerates the available basic rendering modes, as part of a [DisplayStyle]($backend)'s [[ViewFlags]].\r\n * The rendering mode broadly affects various aspects of the display style - in particular, whether and how surfaces and their edges are drawn.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum RenderMode {\r\n  /** Renders only the edges of surfaces, with exceptions for planar regions based on their [[FillFlags]].\r\n   * Lighting (and by extension, shadows) is not applied.\r\n   * [[HiddenLine.Settings]] are not applied - edges use the elements' width, style, and color.\r\n   * [[ViewFlags.hiddenEdges]] is ignored - hidden edges are never displayed in wireframe mode.\r\n   */\r\n  Wireframe = 0,\r\n  /** By default, renders surfaces without their edges.\r\n   * Lighting and shadows can be applied using [[ViewFlags.lighting]] and [[ViewFlags.shadows]].\r\n   * Edges can be enabled using [[ViewFlags.visibleEdges]] and [[ViewFlags.hiddenEdges]], and their appearance customized using [[HiddenLine.Settings]].\r\n   * Surfaces can be drawn with transparency, based on [[ViewFlags.transparency]].\r\n   */\r\n  SmoothShade = 6,\r\n  /** Renders surfaces and their edges. By default, edges are drawn in white; this can be overridden using [[HiddenLine.Settings]].\r\n   * All surfaces are rendered opaque. If a surface's transparency is below that specified by [[HiddenLine.Settings.transparencyThreshold]], it is not rendered.\r\n   * Materials and textures are not applied - surfaces are drawn in their actual colors.\r\n   * [[ViewFlags.visibleEdges]] is ignored - visible edges are always drawn. Hidden edges can be enabled using [[ViewFlags.hiddenEdges]].\r\n   * Lighting (and by extension, shadows) is not applied.\r\n   */\r\n  SolidFill = 4,\r\n  /** Identical to [[RenderMode.SolidFill]], except:\r\n   *  - Surfaces are drawn using the [DisplayStyle]($backend)'s background color.\r\n   *  - Edges are drawn using their surface's colors; this can be overridden using [[HiddenLine.Settings]].\r\n   */\r\n  HiddenLine = 3,\r\n}\r\n\r\n/** JSON representation of [[ViewFlags]].\r\n * This is a persistence format with some unfortunate quirks that have been retained for backwards compatibility.\r\n * In particular, it supplies three separate flags intended to control lighting - [[noCameraLights]], [[noSourceLights]], and [[noSolarLight]] -\r\n * but there exists only a single [[ViewFlags.lighting]] flag. [[ViewFlags.lighting]] is set to true unless all three of the \"no lighting\" flags are true.\r\n * It also uses awkward negative ([[noConstruct]], [[noTransp]]) and/or abbreviated ([[clipVol]], [[visEdges]]) property names that differ from\r\n * those of the corresponding [[ViewFlags]] properties, making usage of this type in code error-prone.\r\n * Prefer to use [[ViewFlagsProperties]] unless you need to work directly with the persistence format.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ViewFlagProps {\r\n  /** If true, don't display geometry of class [[GeometryClass.Construction]]. */\r\n  noConstruct?: boolean;\r\n  /** If true, don't display geometry of class [[GeometryClass.Dimension]]. */\r\n  noDim?: boolean;\r\n  /** If true, don't display geometry of class [[GeometryClass.Pattern]]. */\r\n  noPattern?: boolean;\r\n  /** If true, all lines are drawn with a width of 1 pixel. */\r\n  noWeight?: boolean;\r\n  /** If true, don't apply [[LinePixels]] styles. */\r\n  noStyle?: boolean;\r\n  /** If true, display transparency geometry as opaque. */\r\n  noTransp?: boolean;\r\n  /** If true, don't show filled planar regions, unless they use [[FillFlags.Always]]. */\r\n  noFill?: boolean;\r\n  /** If true, display a grid in the view. */\r\n  grid?: boolean;\r\n  /** If true, display graphics representing the [AuxCoordSystem]($backend). */\r\n  acs?: boolean;\r\n  /** If true, don't apply [[RenderTexture]]s to surfaces. */\r\n  noTexture?: boolean;\r\n  /** If true, don't apply [[RenderMaterial]]s to surfaces. */\r\n  noMaterial?: boolean;\r\n  /** See [[ViewFlagProps]] for how this affects [[ViewFlags.lighting]]. */\r\n  noCameraLights?: boolean;\r\n  /** See [[ViewFlagProps]] for how this affects [[ViewFlags.lighting]]. */\r\n  noSourceLights?: boolean;\r\n  /** See [[ViewFlagProps]] for how this affects [[ViewFlags.lighting]]. */\r\n  noSolarLight?: boolean;\r\n  /** If true, display the edges of surfaces. */\r\n  visEdges?: boolean;\r\n  /** If true, display the edges of surfaces, even if they are behind other geometry. */\r\n  hidEdges?: boolean;\r\n  /** If true, display shadows. */\r\n  shadows?: boolean;\r\n  /** If true, apply the view's clipping volume. Has no effect on other types of clips like [[ModelClipGroups]]. */\r\n  clipVol?: boolean;\r\n  /** If true, apply the view's [[DisplayStyleSettings.monochromeColor]] and [[DisplayStyleSettings.monochromeMode]] to produce a monochrome image. */\r\n  monochrome?: boolean;\r\n  /** The basic rendering mode, which affects the behavior of other flags. */\r\n  renderMode?: RenderMode;\r\n  /** Display a background map. */\r\n  backgroundMap?: boolean;\r\n  /** If true, apply [[AmbientOcclusion]]. */\r\n  ambientOcclusion?: boolean;\r\n  /** If true, apply [[ThematicDisplay]]. */\r\n  thematicDisplay?: boolean;\r\n  /** If true, overlay surfaces with wiremesh to reveal their triangulation. */\r\n  wiremesh?: boolean;\r\n  /** Controls whether surface discard is always applied regardless of other ViewFlags.\r\n   * 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\r\n   * non-planar surfaces always draw in front of those non-planar surfaces.\r\n   * When this view flag is set to false (the default), then for 3d views if the render mode is wireframe (only edges are displayed) or smooth shader with visible edges turned off (only surfaces are displayed),\r\n   * that logic does not execute, potentially improving performance for no degradation in visual quality. In some scenarios - such as wireframe views containing many planar regions with interior fill, or smooth views containing many coincident planar and non-planar surfaces - enabling this view flag improves display quality by forcing that logic to execute.\r\n   */\r\n  forceSurfaceDiscard?: boolean;\r\n  /** Disables the \"white-on-white reversal\" employed by some CAD applications.\r\n   * @see [[ViewFlags.whiteOnWhiteReversal]].\r\n   */\r\n  noWhiteOnWhiteReversal?: boolean;\r\n}\r\n\r\nfunction edgesRequired(renderMode: RenderMode, visibleEdges: boolean): boolean {\r\n  return visibleEdges || RenderMode.SmoothShade !== renderMode;\r\n}\r\n\r\n/** Flags controlling how graphics appear within a view.\r\n * A [[ViewFlags]] object is immutable. There are several ways to produce a modified copy of a ViewFlags object:\r\n * ```ts\r\n *  // Start with the default values for all properties.\r\n *  let vf = ViewFlags.defaults;\r\n *  // Change a single boolean property:\r\n *  vf = vf.with(\"visibleEdges\", true);\r\n *  // Change only the render mode:\r\n *  vf = vf.withRenderMode(RenderMode.HiddenLine);\r\n *  // Change multiple properties:\r\n *  vf = vf.copy({ renderMode: RenderMode.SmoothShade, visibleEdges: true });\r\n *  // Reset multiple properties to their default values:\r\n *  vf = vf.copy({ renderMode: undefined, visibleEdges: undefined });\r\n *\r\n * ```\r\n * [[with]] and [[withRenderMode]] should be preferred if you only need to change a single property, as they will not create a new object unless\r\n * the new value differs from the current value.\r\n * [[copy]] and [[override]] should be preferred if you need to change multiple properties, as they will create no more than one new object, vs\r\n * each call to [[with]] or [[withRenderMode]] potentially creating a new object.\r\n * @see [[DisplayStyleSettings.viewFlags]] to define the view flags for a [DisplayStyle]($backend).\r\n * @public\r\n */\r\nexport class ViewFlags {\r\n  /** The basic rendering mode applied to the view. This modulates the behavior of some of the other flags.\r\n   * Default: [[RenderMode.Wireframe]].\r\n   * @see [[RenderMode]] for details.\r\n   */\r\n  public readonly renderMode: RenderMode;\r\n  /** Whether to display geometry of class [[GeometryClass.Dimension]]. Default: true. */\r\n  public readonly dimensions: boolean;\r\n  /** Whether to display geometry of class [[GeometryClass.Pattern]]. Default: true. */\r\n  public readonly patterns: boolean;\r\n  /** Whether to allow lines and edges to draw with width greater than one pixel. Default: true. */\r\n  public readonly weights: boolean;\r\n  /** Whether [[LinePixels]] are allowed to apply patterns to lines and edges. If false, they all draw as solid lines. Default: true. */\r\n  public readonly styles: boolean;\r\n  /** Whether element transparency is applied. If false, transparent geometry is drawn opaque. Default: true.\r\n   * @see [[RenderMode]] for render mode-specific behavior.\r\n   */\r\n  public readonly transparency: boolean;\r\n  /** In [[RenderMode.Wireframe]] only, whether to display the interiors of planar regions with [[FillFlags.ByView]]. Default: true. */\r\n  public readonly fill: boolean;\r\n  /** In [[RenderMode.SmoothShade]], whether to apply [[RenderTexture]]s to surfaces. Default: true. */\r\n  public readonly textures: boolean;\r\n  /** In [[RenderMode.SmoothShade]], whether to apply [[RenderMaterial]]s to surfaces. Default: true. */\r\n  public readonly materials: boolean;\r\n  /** Whether to display a graphical representation of the view's [AuxCoordSystem]($backend). Default: false. */\r\n  public readonly acsTriad: boolean;\r\n  /** Whether to display a grid. Default: false. */\r\n  public readonly grid: boolean;\r\n  /** In [[RenderMode.SmoothShade]], whether to display the edges of surfaces. Default: false.\r\n   * @see [[HiddenLine.Settings]] to customize the appearance of the edges.\r\n   */\r\n  public readonly visibleEdges: boolean;\r\n  /** In any mode except [[RenderMode.Wireframe]], whether to display the edges of surfaces occluded by other geometry.\r\n   * This has no effect unless [[visibleEdges]] is also true.\r\n   * Default: false.\r\n   * @see [[HiddenLine.Settings]] to customize the appearance of the edges.\r\n   */\r\n  public readonly hiddenEdges: boolean;\r\n  /** In [[RenderMode.SmoothShade]], whether to display solar shadows. This has no effect unless [[lighting]] is also true. Default: false.\r\n   * @note Rendering shadows can reduce framerate, particularly on less capable graphics hardware or in complex scenes.\r\n   */\r\n  public readonly shadows: boolean;\r\n  /** Whether to apply the view's clip volume to the geometry in the scene.\r\n   * Default: true, except when using [[fromJSON]].\r\n   * @see [[ViewDetails.clipVector]] to define the view's clip volume.\r\n   */\r\n  public readonly clipVolume: boolean;\r\n  /** Whether to display geometry of class [[GeometryClass.Construction]].\r\n   * Default: false, except when using [[fromJSON]].\r\n   */\r\n  public readonly constructions: boolean;\r\n  /** Whether to produce a monochrome image. Default: false.\r\n   * @see [DisplayStyleSettings.monochromeColor]($common) to define the monochrome color.\r\n   * @see [DisplayStyleSettings.monochromeMode]($common) to define how the monochrome image is produced.\r\n   */\r\n  public readonly monochrome: boolean;\r\n  /** Whether to display background map imagery. Default: false.\r\n   * @see [[DisplayStyleSettings.backgroundMap]] to customize the map settings.\r\n   */\r\n  public readonly backgroundMap: boolean;\r\n  /** In [[RenderMode.SmoothShade]], whether to apply [[AmbientOcclusion]]. Default: false. */\r\n  public readonly ambientOcclusion: boolean;\r\n  /** Whether to apply [[ThematicDisplay]]. Default: false. */\r\n  public readonly thematicDisplay: boolean;\r\n  /** If true, overlay surfaces with wiremesh to reveal their triangulation. */\r\n  public readonly wiremesh: boolean;\r\n  /** Controls whether surface discard is always applied regardless of other ViewFlags.\r\n   * 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\r\n   * non-planar surfaces always draw in front of those non-planar surfaces.\r\n   * When this view flag is set to false (the default), then for 3d views if the render mode is wireframe (only edges are displayed) or smooth shader with visible edges turned off (only surfaces are displayed),\r\n   * that logic does not execute, potentially improving performance for no degradation in visual quality. In some scenarios - such as wireframe views containing many planar regions with interior fill, or smooth views containing many coincident planar and non-planar surfaces - enabling this view flag improves display quality by forcing that logic to execute.\r\n   */\r\n  public readonly forceSurfaceDiscard: boolean;\r\n  /** Whether to apply white-on-white reversal.\r\n   * Some CAD applications use this to cause white geometry to be drawn as black if the view's background color is white.\r\n   * When enabled, the [[DisplayStyleSettings]]' [[WhiteOnWhiteReversalSettings]] control how white-on-white reversal is applied.\r\n   * Default: true.\r\n   */\r\n  public readonly whiteOnWhiteReversal: boolean;\r\n\r\n  /** In [[RenderMode.SmoothShade]], whether to apply lighting to surfaces.\r\n   * Default: false, except when using [[fromJSON]].\r\n   * @see [[DisplayStyleSettings.lights]] to customize the light settings.\r\n   */\r\n  public readonly lighting: boolean;\r\n\r\n  /** Create a new ViewFlags.\r\n   * @param flags The properties to initialize. Any properties not specified are initialized to their default values.\r\n   */\r\n  public constructor(flags?: Partial<ViewFlagsProperties>) {\r\n    this.renderMode = flags?.renderMode ?? RenderMode.Wireframe;\r\n    this.dimensions = flags?.dimensions ?? true;\r\n    this.patterns = flags?.patterns ?? true;\r\n    this.weights = flags?.weights ?? true;\r\n    this.styles = flags?.styles ?? true;\r\n    this.transparency = flags?.transparency ?? true;\r\n    this.fill = flags?.fill ?? true;\r\n    this.textures = flags?.textures ?? true;\r\n    this.materials = flags?.materials ?? true;\r\n    this.acsTriad = flags?.acsTriad ?? false;\r\n    this.grid = flags?.grid ?? false;\r\n    this.visibleEdges = flags?.visibleEdges ?? false;\r\n    this.hiddenEdges = flags?.hiddenEdges ?? false;\r\n    this.shadows = flags?.shadows ?? false;\r\n    this.clipVolume = flags?.clipVolume ?? true;\r\n    this.constructions = flags?.constructions ?? false;\r\n    this.monochrome = flags?.monochrome ?? false;\r\n    this.backgroundMap = flags?.backgroundMap ?? false;\r\n    this.ambientOcclusion = flags?.ambientOcclusion ?? false;\r\n    this.thematicDisplay = flags?.thematicDisplay ?? false;\r\n    this.wiremesh = flags?.wiremesh ?? false;\r\n    this.forceSurfaceDiscard = flags?.forceSurfaceDiscard ?? false;\r\n    this.whiteOnWhiteReversal = flags?.whiteOnWhiteReversal ?? true;\r\n    this.lighting = flags?.lighting ?? false;\r\n  }\r\n\r\n  /** Produce a copy of these ViewFlags with some modified properties. Any properties not explicitly specified by `changedFlags` will retain their current values.\r\n   * @param changedFlags Properties to modify.\r\n   * @returns A copy of these ViewFlags modified according to the supplied properties.\r\n   * @note Any explicitly `undefined` property of `changedFlags` will be set to its default value in the returned ViewFlags.\r\n   * @see [[override]] to have `undefined` properties retain their current values.\r\n   */\r\n  public copy(changedFlags: Partial<ViewFlagsProperties>): ViewFlags {\r\n    return JsonUtils.isNonEmptyObject(changedFlags) ? new ViewFlags({ ...this, ...changedFlags }) : this;\r\n  }\r\n\r\n  /** Produce a copy of these ViewFlags, overriding some of its properties. Any properties not explicitly specified by `overrides` will retain their current values,\r\n   * as will any property explicitly set to `undefined`.\r\n   * @param overrides The properties to override.\r\n   * @see [[copy]] to have `undefined` properties reset to their default values.\r\n   */\r\n  public override(overrides: Partial<ViewFlagsProperties>): ViewFlags {\r\n    // This method can get called very frequently when a RenderTimeline script is applied to the view. Often `overrides` will be an empty object.\r\n    // To optimize:\r\n    //  - Bail as quickly as possible if nothing is actually overridden, without allocating a new ViewFlags.\r\n    //  - Only make a copy of the input if at least one property is explicitly `undefined`.\r\n    let copied = false;\r\n    let anyOverridden = false;\r\n\r\n    for (const propName of Object.keys(overrides)) {\r\n      const key = propName as keyof Partial<ViewFlagsProperties>;\r\n      const overrideValue = overrides[key];\r\n      if (undefined === overrideValue) {\r\n        if (!copied) {\r\n          // Don't modify input...\r\n          overrides = { ...overrides };\r\n          copied = true;\r\n        }\r\n\r\n        // `undefined` means \"retain existing value\".\r\n        delete overrides[key];\r\n      } else if (overrideValue !== this[key]) {\r\n        anyOverridden = true;\r\n      }\r\n    }\r\n\r\n    return anyOverridden ? this.copy(overrides) : this;\r\n  }\r\n\r\n  /** Produce a copy of these ViewFlags with a single boolean property changed.\r\n   * @param flag The name of the property.\r\n   * @param value The value to change the property to.\r\n   * @returns A new ViewFlags with the property changed as specified, or `this` if the property already has the specified value.\r\n   * @see [[withRenderMode]] to change the [[renderMode]] property.\r\n   * @see [[copy]] and [[override]] to change multiple properties.\r\n   */\r\n  public with(flag: keyof Omit<ViewFlagsProperties, \"renderMode\">, value: boolean): ViewFlags {\r\n    if (this[flag] === value)\r\n      return this;\r\n\r\n    const props: ViewFlagsProperties = { ...this };\r\n    props[flag] = value;\r\n    return new ViewFlags(props);\r\n  }\r\n\r\n  /** Produce a copy of these ViewFlags with a different [[renderMode]].\r\n   * @param renderMode The new render mode.\r\n   * @returns A new ViewFlags with the render mode changed as specified, or `this` if the render mode is already set to the requested value.\r\n   * @see [[copy]] and [[override]] to change multiple properties.\r\n   */\r\n  public withRenderMode(renderMode: RenderMode): ViewFlags {\r\n    return renderMode === this.renderMode ? this : this.copy({ renderMode });\r\n  }\r\n\r\n  /** Adjust view flags for renderer.\r\n   * @internal\r\n   */\r\n  public normalize(): ViewFlags {\r\n    switch (this.renderMode) {\r\n      case RenderMode.Wireframe:\r\n        if (this.visibleEdges || this.hiddenEdges)\r\n          return this.copy({ visibleEdges: false, hiddenEdges: false });\r\n        break;\r\n      case RenderMode.SmoothShade:\r\n        if (!this.visibleEdges)\r\n          return this.copy({ hiddenEdges: false });\r\n        break;\r\n      case RenderMode.HiddenLine:\r\n      case RenderMode.SolidFill:\r\n        if (!this.visibleEdges || this.transparency)\r\n          return this.copy({ visibleEdges: true, transparency: false });\r\n        break;\r\n    }\r\n\r\n    return this;\r\n  }\r\n\r\n  /** Returns true if edges that could be occluded by other geometry are visible for the current [[RenderMode]]. */\r\n  public hiddenEdgesVisible(): boolean {\r\n    switch (this.renderMode) {\r\n      case RenderMode.SolidFill:\r\n      case RenderMode.HiddenLine:\r\n        return this.hiddenEdges;\r\n      case RenderMode.SmoothShade:\r\n        return this.visibleEdges && this.hiddenEdges;\r\n    }\r\n    return true;\r\n  }\r\n\r\n  /** Returns true if the edges of surfaces should be displayed, based on [[RenderMode]] and the [[visibleEdges]] flag. */\r\n  public edgesRequired(): boolean {\r\n    return edgesRequired(this.renderMode, this.visibleEdges);\r\n  }\r\n\r\n  /** Convert to JSON representation.\r\n   * Properties are omitted if they match the default values.\r\n   */\r\n  public toJSON(): ViewFlagProps {\r\n    const out: ViewFlagProps = {};\r\n    if (!this.constructions)\r\n      out.noConstruct = true;\r\n    if (!this.dimensions)\r\n      out.noDim = true;\r\n    if (!this.patterns)\r\n      out.noPattern = true;\r\n    if (!this.weights)\r\n      out.noWeight = true;\r\n    if (!this.styles)\r\n      out.noStyle = true;\r\n    if (!this.transparency)\r\n      out.noTransp = true;\r\n    if (!this.fill)\r\n      out.noFill = true;\r\n    if (this.grid)\r\n      out.grid = true;\r\n    if (this.acsTriad)\r\n      out.acs = true;\r\n    if (!this.textures)\r\n      out.noTexture = true;\r\n    if (!this.materials)\r\n      out.noMaterial = true;\r\n    if (!this.lighting)\r\n      out.noCameraLights = out.noSourceLights = out.noSolarLight = true;\r\n    if (this.visibleEdges)\r\n      out.visEdges = true;\r\n    if (this.hiddenEdges)\r\n      out.hidEdges = true;\r\n    if (this.shadows)\r\n      out.shadows = true;\r\n    if (this.clipVolume)\r\n      out.clipVol = true;\r\n    if (this.monochrome)\r\n      out.monochrome = true;\r\n    if (this.backgroundMap)\r\n      out.backgroundMap = true;\r\n    if (this.ambientOcclusion)\r\n      out.ambientOcclusion = true;\r\n    if (this.thematicDisplay)\r\n      out.thematicDisplay = true;\r\n    if (this.wiremesh)\r\n      out.wiremesh = true;\r\n    if (this.forceSurfaceDiscard)\r\n      out.forceSurfaceDiscard = true;\r\n    if (!this.whiteOnWhiteReversal)\r\n      out.noWhiteOnWhiteReversal = true;\r\n\r\n    out.renderMode = this.renderMode;\r\n    return out;\r\n  }\r\n\r\n  /** Like [[toJSON]], but no properties are omitted. */\r\n  public toFullyDefinedJSON(): Required<ViewFlagProps> {\r\n    return {\r\n      renderMode: this.renderMode,\r\n      noConstruct: !this.constructions,\r\n      noDim: !this.dimensions,\r\n      noPattern: !this.patterns,\r\n      noWeight: !this.weights,\r\n      noStyle: !this.styles,\r\n      noTransp: !this.transparency,\r\n      noFill: !this.fill,\r\n      grid: this.grid,\r\n      acs: this.acsTriad,\r\n      noTexture: !this.textures,\r\n      noMaterial: !this.materials,\r\n      noCameraLights: !this.lighting,\r\n      noSourceLights: !this.lighting,\r\n      noSolarLight: !this.lighting,\r\n      visEdges: this.visibleEdges,\r\n      hidEdges: this.hiddenEdges,\r\n      shadows: this.shadows,\r\n      clipVol: this.clipVolume,\r\n      monochrome: this.monochrome,\r\n      backgroundMap: this.backgroundMap,\r\n      ambientOcclusion: this.ambientOcclusion,\r\n      thematicDisplay: this.thematicDisplay,\r\n      wiremesh: this.wiremesh,\r\n      forceSurfaceDiscard: this.forceSurfaceDiscard,\r\n      noWhiteOnWhiteReversal: !this.whiteOnWhiteReversal,\r\n    };\r\n  }\r\n\r\n  /** A ViewFlags object with all properties initialized to their default values. */\r\n  public static readonly defaults = new ViewFlags();\r\n\r\n  /** Create a ViewFlags.\r\n   * @param flags The properties to initialize. Any properties not specified are initialized to their default values.\r\n   */\r\n  public static create(flags?: Partial<ViewFlagsProperties>): ViewFlags {\r\n    return flags && !JsonUtils.isEmptyObject(flags) ? new ViewFlags(flags) : this.defaults;\r\n  }\r\n\r\n  /** Create a ViewFlags from its JSON representation.\r\n   * @note As described in [[ViewFlagProps]], the JSON representation is awkward and error-prone. Prefer to use [[create]] unless you\r\n   * need to deal with the persistence format directly.\r\n   * @note The default values differ slightly from those used by the constructor and [[create]]:\r\n   *  - [[clipVolume]] defaults to false.\r\n   *  - [[constructions]] defaults to true.\r\n   *  - [[lighting]] defaults to true unless all of [[ViewFlagProps.noSolarLight]], [[ViewFlagProps.noCameraLights]], and [[ViewFlagProps.noSourceLights]] are true.\r\n   */\r\n  public static fromJSON(json?: ViewFlagProps): ViewFlags {\r\n    if (!json)\r\n      return this.defaults;\r\n\r\n    let renderMode: RenderMode;\r\n    const renderModeValue = JsonUtils.asInt(json.renderMode);\r\n    if (renderModeValue < RenderMode.HiddenLine)\r\n      renderMode = RenderMode.Wireframe;\r\n    else if (renderModeValue > RenderMode.SolidFill)\r\n      renderMode = RenderMode.SmoothShade;\r\n    else\r\n      renderMode = renderModeValue;\r\n\r\n    const lighting = !JsonUtils.asBool(json.noCameraLights) || !JsonUtils.asBool(json.noSourceLights) || !JsonUtils.asBool(json.noSolarLight);\r\n    return new ViewFlags({\r\n      renderMode,\r\n      lighting,\r\n      constructions: !JsonUtils.asBool(json.noConstruct),\r\n      dimensions: !JsonUtils.asBool(json.noDim),\r\n      patterns: !JsonUtils.asBool(json.noPattern),\r\n      weights: !JsonUtils.asBool(json.noWeight),\r\n      styles: !JsonUtils.asBool(json.noStyle),\r\n      transparency: !JsonUtils.asBool(json.noTransp),\r\n      fill: !JsonUtils.asBool(json.noFill),\r\n      grid: JsonUtils.asBool(json.grid),\r\n      acsTriad: JsonUtils.asBool(json.acs),\r\n      textures: !JsonUtils.asBool(json.noTexture),\r\n      materials: !JsonUtils.asBool(json.noMaterial),\r\n      visibleEdges: JsonUtils.asBool(json.visEdges),\r\n      hiddenEdges: JsonUtils.asBool(json.hidEdges),\r\n      shadows: JsonUtils.asBool(json.shadows),\r\n      clipVolume: JsonUtils.asBool(json.clipVol),\r\n      monochrome: JsonUtils.asBool(json.monochrome),\r\n      backgroundMap: JsonUtils.asBool(json.backgroundMap),\r\n      ambientOcclusion: JsonUtils.asBool(json.ambientOcclusion),\r\n      thematicDisplay: JsonUtils.asBool(json.thematicDisplay),\r\n      wiremesh: JsonUtils.asBool(json.wiremesh),\r\n      forceSurfaceDiscard: JsonUtils.asBool(json.forceSurfaceDiscard),\r\n      whiteOnWhiteReversal: !JsonUtils.asBool(json.noWhiteOnWhiteReversal),\r\n    });\r\n  }\r\n\r\n  /** Returns true if `this` and `other` are equivalent. */\r\n  public equals(other: Readonly<ViewFlagsProperties>): boolean {\r\n    if (this === other)\r\n      return true;\r\n\r\n    return this.renderMode === other.renderMode\r\n      && this.dimensions === other.dimensions\r\n      && this.patterns === other.patterns\r\n      && this.weights === other.weights\r\n      && this.styles === other.styles\r\n      && this.transparency === other.transparency\r\n      && this.fill === other.fill\r\n      && this.textures === other.textures\r\n      && this.materials === other.materials\r\n      && this.acsTriad === other.acsTriad\r\n      && this.grid === other.grid\r\n      && this.visibleEdges === other.visibleEdges\r\n      && this.hiddenEdges === other.hiddenEdges\r\n      && this.lighting === other.lighting\r\n      && this.shadows === other.shadows\r\n      && this.clipVolume === other.clipVolume\r\n      && this.constructions === other.constructions\r\n      && this.monochrome === other.monochrome\r\n      && this.backgroundMap === other.backgroundMap\r\n      && this.ambientOcclusion === other.ambientOcclusion\r\n      && this.thematicDisplay === other.thematicDisplay\r\n      && this.wiremesh === other.wiremesh\r\n      && this.forceSurfaceDiscard === other.forceSurfaceDiscard\r\n      && this.whiteOnWhiteReversal === other.whiteOnWhiteReversal;\r\n  }\r\n}\r\n\r\n/** A type containing all of the properties of [[ViewFlags]] with none of the methods and with the `readonly` modifiers removed.\r\n * @see [[ViewFlags.create]], [[ViewFlags.copy]], and [[ViewFlags.override]] for methods accepting an object of this type.\r\n * @public\r\n * @extensions\r\n */\r\nexport type ViewFlagsProperties = Mutable<NonFunctionPropertiesOf<ViewFlags>>;\r\n\r\n/** A type that describes how to override selected properties of a [[ViewFlags]].\r\n * @see [[ViewFlags.override]] to apply the overrides to a ViewFlags object.\r\n * @public\r\n * @extensions\r\n */\r\nexport type ViewFlagOverrides = Partial<ViewFlagsProperties>;\r\n"]}
+{"version":3,"file":"ViewFlags.js","sourceRoot":"","sources":["../../src/ViewFlags.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,qBAAqB;AAErB,OAAO,EAAE,SAAS,EAAoC,MAAM,qBAAqB,CAAC;AAElF;;;;GAIG;AACH,MAAM,CAAN,IAAY,UAyBX;AAzBD,WAAY,UAAU;IACpB;;;;OAIG;IACH,qDAAa,CAAA;IACb;;;;OAIG;IACH,yDAAe,CAAA;IACf;;;;;OAKG;IACH,qDAAa,CAAA;IACb;;;OAGG;IACH,uDAAc,CAAA;AAChB,CAAC,EAzBW,UAAU,KAAV,UAAU,QAyBrB;AA0ED,SAAS,aAAa,CAAC,UAAsB,EAAE,YAAqB;IAClE,OAAO,YAAY,IAAI,UAAU,CAAC,WAAW,KAAK,UAAU,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,SAAS;IAsFpB;;OAEG;IACH,YAAmB,KAAoC;QACrD,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,UAAU,CAAC,SAAS,CAAC;QAC5D,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,IAAI,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,IAAI,IAAI,CAAC;QACxC,IAAI,CAAC,OAAO,GAAG,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,KAAK,EAAE,MAAM,IAAI,IAAI,CAAC;QACpC,IAAI,CAAC,YAAY,GAAG,KAAK,EAAE,YAAY,IAAI,IAAI,CAAC;QAChD,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,IAAI,IAAI,IAAI,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,IAAI,IAAI,CAAC;QACxC,IAAI,CAAC,SAAS,GAAG,KAAK,EAAE,SAAS,IAAI,IAAI,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,IAAI,KAAK,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,IAAI,IAAI,KAAK,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,KAAK,EAAE,YAAY,IAAI,KAAK,CAAC;QACjD,IAAI,CAAC,WAAW,GAAG,KAAK,EAAE,WAAW,IAAI,KAAK,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,KAAK,EAAE,OAAO,IAAI,KAAK,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,IAAI,CAAC;QAC5C,IAAI,CAAC,aAAa,GAAG,KAAK,EAAE,aAAa,IAAI,KAAK,CAAC;QACnD,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,UAAU,IAAI,KAAK,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,KAAK,EAAE,aAAa,IAAI,KAAK,CAAC;QACnD,IAAI,CAAC,gBAAgB,GAAG,KAAK,EAAE,gBAAgB,IAAI,KAAK,CAAC;QACzD,IAAI,CAAC,eAAe,GAAG,KAAK,EAAE,eAAe,IAAI,KAAK,CAAC;QACvD,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,IAAI,KAAK,CAAC;QACzC,IAAI,CAAC,mBAAmB,GAAG,KAAK,EAAE,mBAAmB,IAAI,KAAK,CAAC;QAC/D,IAAI,CAAC,oBAAoB,GAAG,KAAK,EAAE,oBAAoB,IAAI,IAAI,CAAC;QAChE,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,IAAI,KAAK,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAC,YAA0C;QACpD,OAAO,SAAS,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACvG,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,SAAuC;QACrD,6IAA6I;QAC7I,eAAe;QACf,wGAAwG;QACxG,uFAAuF;QACvF,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,IAAI,aAAa,GAAG,KAAK,CAAC;QAE1B,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9C,MAAM,GAAG,GAAG,QAA8C,CAAC;YAC3D,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YACrC,IAAI,SAAS,KAAK,aAAa,EAAE,CAAC;gBAChC,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,wBAAwB;oBACxB,SAAS,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC;oBAC7B,MAAM,GAAG,IAAI,CAAC;gBAChB,CAAC;gBAED,6CAA6C;gBAC7C,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;YACxB,CAAC;iBAAM,IAAI,aAAa,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvC,aAAa,GAAG,IAAI,CAAC;YACvB,CAAC;QACH,CAAC;QAED,OAAO,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACI,IAAI,CAAC,IAAmD,EAAE,KAAc;QAC7E,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK;YACtB,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAwB,EAAE,GAAG,IAAI,EAAE,CAAC;QAC/C,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACpB,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,UAAsB;QAC1C,OAAO,UAAU,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;OAEG;IACI,SAAS;QACd,QAAQ,IAAI,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,UAAU,CAAC,SAAS;gBACvB,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,WAAW;oBACvC,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;gBAChE,MAAM;YACR,KAAK,UAAU,CAAC,WAAW;gBACzB,IAAI,CAAC,IAAI,CAAC,YAAY;oBACpB,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC3C,MAAM;YACR,KAAK,UAAU,CAAC,UAAU,CAAC;YAC3B,KAAK,UAAU,CAAC,SAAS;gBACvB,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;oBACzC,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;gBAChE,MAAM;QACV,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iHAAiH;IAC1G,kBAAkB;QACvB,QAAQ,IAAI,CAAC,UAAU,EAAE,CAAC;YACxB,KAAK,UAAU,CAAC,SAAS,CAAC;YAC1B,KAAK,UAAU,CAAC,UAAU;gBACxB,OAAO,IAAI,CAAC,WAAW,CAAC;YAC1B,KAAK,UAAU,CAAC,WAAW;gBACzB,OAAO,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,WAAW,CAAC;QACjD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wHAAwH;IACjH,aAAa;QAClB,OAAO,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,GAAG,GAAkB,EAAE,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,aAAa;YACrB,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,IAAI,CAAC,QAAQ;YAChB,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,IAAI,CAAC,MAAM;YACd,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,YAAY;YACpB,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,IAAI,CAAC,IAAI;YACZ,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC;QACpB,IAAI,IAAI,CAAC,IAAI;YACX,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;QAClB,IAAI,IAAI,CAAC,QAAQ;YACf,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,CAAC,QAAQ;YAChB,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI,CAAC,QAAQ;YAChB,GAAG,CAAC,cAAc,GAAG,GAAG,CAAC,cAAc,GAAG,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC;QACpE,IAAI,IAAI,CAAC,YAAY;YACnB,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QACtB,IAAI,IAAI,CAAC,WAAW;YAClB,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QACtB,IAAI,IAAI,CAAC,OAAO;YACd,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,UAAU;YACjB,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,UAAU;YACjB,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;QACxB,IAAI,IAAI,CAAC,aAAa;YACpB,GAAG,CAAC,aAAa,GAAG,IAAI,CAAC;QAC3B,IAAI,IAAI,CAAC,gBAAgB;YACvB,GAAG,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC9B,IAAI,IAAI,CAAC,eAAe;YACtB,GAAG,CAAC,eAAe,GAAG,IAAI,CAAC;QAC7B,IAAI,IAAI,CAAC,QAAQ;YACf,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;QACtB,IAAI,IAAI,CAAC,mBAAmB;YAC1B,GAAG,CAAC,mBAAmB,GAAG,IAAI,CAAC;QACjC,IAAI,CAAC,IAAI,CAAC,oBAAoB;YAC5B,GAAG,CAAC,sBAAsB,GAAG,IAAI,CAAC;QAEpC,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACjC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,sDAAsD;IAC/C,kBAAkB;QACvB,OAAO;YACL,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,WAAW,EAAE,CAAC,IAAI,CAAC,aAAa;YAChC,KAAK,EAAE,CAAC,IAAI,CAAC,UAAU;YACvB,SAAS,EAAE,CAAC,IAAI,CAAC,QAAQ;YACzB,QAAQ,EAAE,CAAC,IAAI,CAAC,OAAO;YACvB,OAAO,EAAE,CAAC,IAAI,CAAC,MAAM;YACrB,QAAQ,EAAE,CAAC,IAAI,CAAC,YAAY;YAC5B,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI;YAClB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,GAAG,EAAE,IAAI,CAAC,QAAQ;YAClB,SAAS,EAAE,CAAC,IAAI,CAAC,QAAQ;YACzB,UAAU,EAAE,CAAC,IAAI,CAAC,SAAS;YAC3B,cAAc,EAAE,CAAC,IAAI,CAAC,QAAQ;YAC9B,cAAc,EAAE,CAAC,IAAI,CAAC,QAAQ;YAC9B,YAAY,EAAE,CAAC,IAAI,CAAC,QAAQ;YAC5B,QAAQ,EAAE,IAAI,CAAC,YAAY;YAC3B,QAAQ,EAAE,IAAI,CAAC,WAAW;YAC1B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,UAAU;YACxB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;YAC7C,sBAAsB,EAAE,CAAC,IAAI,CAAC,oBAAoB;SACnD,CAAC;IACJ,CAAC;IAKD;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,KAAoC;QACvD,OAAO,KAAK,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACzF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAoB;QACzC,IAAI,CAAC,IAAI;YACP,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,IAAI,UAAsB,CAAC;QAC3B,MAAM,eAAe,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACzD,IAAI,eAAe,GAAG,UAAU,CAAC,UAAU;YACzC,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC;aAC/B,IAAI,eAAe,GAAG,UAAU,CAAC,SAAS;YAC7C,UAAU,GAAG,UAAU,CAAC,WAAW,CAAC;;YAEpC,UAAU,GAAG,eAAe,CAAC;QAE/B,MAAM,QAAQ,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1I,OAAO,IAAI,SAAS,CAAC;YACnB,UAAU;YACV,QAAQ;YACR,aAAa,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC;YAClD,UAAU,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;YACzC,QAAQ,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;YAC3C,OAAO,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YACzC,MAAM,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YACvC,YAAY,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC9C,IAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;YACpC,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;YACjC,QAAQ,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;YACpC,QAAQ,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;YAC3C,SAAS,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;YAC7C,YAAY,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC7C,WAAW,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC5C,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YACvC,UAAU,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YAC1C,UAAU,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;YAC7C,aAAa,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;YACnD,gBAAgB,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC;YACzD,eAAe,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC;YACvD,QAAQ,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YACzC,mBAAmB,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC;YAC/D,oBAAoB,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC;SACrE,CAAC,CAAC;IACL,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,KAAoC;QAChD,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;eACtC,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;eACpC,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChC,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO;eAC9B,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;eAC5B,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eACxC,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;eACxB,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChC,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS;eAClC,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChC,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;eACxB,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eACxC,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW;eACtC,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChC,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO;eAC9B,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;eACpC,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;eAC1C,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU;eACpC,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa;eAC1C,IAAI,CAAC,gBAAgB,KAAK,KAAK,CAAC,gBAAgB;eAChD,IAAI,CAAC,eAAe,KAAK,KAAK,CAAC,eAAe;eAC9C,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ;eAChC,IAAI,CAAC,mBAAmB,KAAK,KAAK,CAAC,mBAAmB;eACtD,IAAI,CAAC,oBAAoB,KAAK,KAAK,CAAC,oBAAoB,CAAC;IAChE,CAAC;;AAzFD,kFAAkF;AAC3D,kBAAQ,GAAG,IAAI,SAAS,EAAE,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// cspell:ignore ovrs\r\n\r\nimport { JsonUtils, Mutable, NonFunctionPropertiesOf } from \"@itwin/core-bentley\";\r\n\r\n/** Enumerates the available basic rendering modes, as part of a [DisplayStyle]($backend)'s [[ViewFlags]].\r\n * The rendering mode broadly affects various aspects of the display style - in particular, whether and how surfaces and their edges are drawn.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum RenderMode {\r\n  /** Renders only the edges of surfaces, with exceptions for planar regions based on their [[FillFlags]].\r\n   * Lighting (and by extension, shadows) is not applied.\r\n   * [[HiddenLine.Settings]] are not applied - edges use the elements' width, style, and color.\r\n   * [[ViewFlags.hiddenEdges]] is ignored - hidden edges are never displayed in wireframe mode.\r\n   */\r\n  Wireframe = 0,\r\n  /** By default, renders surfaces without their edges.\r\n   * Lighting and shadows can be applied using [[ViewFlags.lighting]] and [[ViewFlags.shadows]].\r\n   * Edges can be enabled using [[ViewFlags.visibleEdges]] and [[ViewFlags.hiddenEdges]], and their appearance customized using [[HiddenLine.Settings]].\r\n   * Surfaces can be drawn with transparency, based on [[ViewFlags.transparency]].\r\n   */\r\n  SmoothShade = 6,\r\n  /** Renders surfaces and their edges. By default, edges are drawn in white; this can be overridden using [[HiddenLine.Settings]].\r\n   * All surfaces are rendered opaque. If a surface's transparency is below that specified by [[HiddenLine.Settings.transparencyThreshold]], it is not rendered.\r\n   * Materials and textures are not applied - surfaces are drawn in their actual colors.\r\n   * [[ViewFlags.visibleEdges]] is ignored - visible edges are always drawn. Hidden edges can be enabled using [[ViewFlags.hiddenEdges]].\r\n   * Lighting (and by extension, shadows) is not applied.\r\n   */\r\n  SolidFill = 4,\r\n  /** Identical to [[RenderMode.SolidFill]], except:\r\n   *  - Surfaces are drawn using the [DisplayStyle]($backend)'s background color.\r\n   *  - Edges are drawn using their surface's colors; this can be overridden using [[HiddenLine.Settings]].\r\n   */\r\n  HiddenLine = 3,\r\n}\r\n\r\n/** JSON representation of [[ViewFlags]].\r\n * This is a persistence format with some unfortunate quirks that have been retained for backwards compatibility.\r\n * In particular, it supplies three separate flags intended to control lighting - [[noCameraLights]], [[noSourceLights]], and [[noSolarLight]] -\r\n * but there exists only a single [[ViewFlags.lighting]] flag. [[ViewFlags.lighting]] is set to true unless all three of the \"no lighting\" flags are true.\r\n * It also uses awkward negative ([[noConstruct]], [[noTransp]]) and/or abbreviated ([[clipVol]], [[visEdges]]) property names that differ from\r\n * those of the corresponding [[ViewFlags]] properties, making usage of this type in code error-prone.\r\n * Prefer to use [[ViewFlagsProperties]] unless you need to work directly with the persistence format.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ViewFlagProps {\r\n  /** If true, don't display geometry of class [[GeometryClass.Construction]]. */\r\n  noConstruct?: boolean;\r\n  /** If true, don't display geometry of class [[GeometryClass.Dimension]]. */\r\n  noDim?: boolean;\r\n  /** If true, don't display geometry of class [[GeometryClass.Pattern]]. */\r\n  noPattern?: boolean;\r\n  /** If true, all lines are drawn with a width of 1 pixel. */\r\n  noWeight?: boolean;\r\n  /** If true, don't apply [[LinePixels]] styles. */\r\n  noStyle?: boolean;\r\n  /** If true, display transparency geometry as opaque. */\r\n  noTransp?: boolean;\r\n  /** If true, don't show filled planar regions, unless they use [[FillFlags.Always]]. */\r\n  noFill?: boolean;\r\n  /** If true, display a grid in the view. */\r\n  grid?: boolean;\r\n  /** If true, display graphics representing the [AuxCoordSystem]($backend). */\r\n  acs?: boolean;\r\n  /** If true, don't apply [[RenderTexture]]s to surfaces. */\r\n  noTexture?: boolean;\r\n  /** If true, don't apply [[RenderMaterial]]s to surfaces. */\r\n  noMaterial?: boolean;\r\n  /** See [[ViewFlagProps]] for how this affects [[ViewFlags.lighting]]. */\r\n  noCameraLights?: boolean;\r\n  /** See [[ViewFlagProps]] for how this affects [[ViewFlags.lighting]]. */\r\n  noSourceLights?: boolean;\r\n  /** See [[ViewFlagProps]] for how this affects [[ViewFlags.lighting]]. */\r\n  noSolarLight?: boolean;\r\n  /** If true, display the edges of surfaces. */\r\n  visEdges?: boolean;\r\n  /** If true, display the edges of surfaces, even if they are behind other geometry. */\r\n  hidEdges?: boolean;\r\n  /** If true, display shadows. */\r\n  shadows?: boolean;\r\n  /** If true, apply the view's clipping volume. Has no effect on other types of clips like [[ModelClipGroups]]. */\r\n  clipVol?: boolean;\r\n  /** If true, apply the view's [[DisplayStyleSettings.monochromeColor]] and [[DisplayStyleSettings.monochromeMode]] to produce a monochrome image. */\r\n  monochrome?: boolean;\r\n  /** The basic rendering mode, which affects the behavior of other flags. */\r\n  renderMode?: RenderMode;\r\n  /** Display a background map. */\r\n  backgroundMap?: boolean;\r\n  /** If true, apply [[AmbientOcclusion]]. */\r\n  ambientOcclusion?: boolean;\r\n  /** If true, apply [[ThematicDisplay]]. */\r\n  thematicDisplay?: boolean;\r\n  /** If true, overlay surfaces with wiremesh to reveal their triangulation. */\r\n  wiremesh?: boolean;\r\n  /** Controls whether surface discard is always applied regardless of other ViewFlags.\r\n   * 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\r\n   * non-planar surfaces always draw in front of those non-planar surfaces.\r\n   * When this view flag is set to false (the default), then for 3d views if the render mode is wireframe (only edges are displayed) or smooth shader with visible edges turned off (only surfaces are displayed),\r\n   * that logic does not execute, potentially improving performance for no degradation in visual quality. In some scenarios - such as wireframe views containing many planar regions with interior fill, or smooth views containing many coincident planar and non-planar surfaces - enabling this view flag improves display quality by forcing that logic to execute.\r\n   */\r\n  forceSurfaceDiscard?: boolean;\r\n  /** Disables the \"white-on-white reversal\" employed by some CAD applications.\r\n   * @see [[ViewFlags.whiteOnWhiteReversal]].\r\n   */\r\n  noWhiteOnWhiteReversal?: boolean;\r\n}\r\n\r\nfunction edgesRequired(renderMode: RenderMode, visibleEdges: boolean): boolean {\r\n  return visibleEdges || RenderMode.SmoothShade !== renderMode;\r\n}\r\n\r\n/** Flags controlling how graphics appear within a view.\r\n * A [[ViewFlags]] object is immutable. There are several ways to produce a modified copy of a ViewFlags object:\r\n * ```ts\r\n *  // Start with the default values for all properties.\r\n *  let vf = ViewFlags.defaults;\r\n *  // Change a single boolean property:\r\n *  vf = vf.with(\"visibleEdges\", true);\r\n *  // Change only the render mode:\r\n *  vf = vf.withRenderMode(RenderMode.HiddenLine);\r\n *  // Change multiple properties:\r\n *  vf = vf.copy({ renderMode: RenderMode.SmoothShade, visibleEdges: true });\r\n *  // Reset multiple properties to their default values:\r\n *  vf = vf.copy({ renderMode: undefined, visibleEdges: undefined });\r\n *\r\n * ```\r\n * [[with]] and [[withRenderMode]] should be preferred if you only need to change a single property, as they will not create a new object unless\r\n * the new value differs from the current value.\r\n * [[copy]] and [[override]] should be preferred if you need to change multiple properties, as they will create no more than one new object, vs\r\n * each call to [[with]] or [[withRenderMode]] potentially creating a new object.\r\n * @see [[DisplayStyleSettings.viewFlags]] to define the view flags for a [DisplayStyle]($backend).\r\n * @public\r\n */\r\nexport class ViewFlags {\r\n  /** The basic rendering mode applied to the view. This modulates the behavior of some of the other flags.\r\n   * Default: [[RenderMode.Wireframe]].\r\n   * @see [[RenderMode]] for details.\r\n   */\r\n  public readonly renderMode: RenderMode;\r\n  /** Whether to display geometry of class [[GeometryClass.Dimension]]. Default: true. */\r\n  public readonly dimensions: boolean;\r\n  /** Whether to display geometry of class [[GeometryClass.Pattern]]. Default: true. */\r\n  public readonly patterns: boolean;\r\n  /** Whether to allow lines and edges to draw with width greater than one pixel. Default: true. */\r\n  public readonly weights: boolean;\r\n  /** Whether [[LinePixels]] are allowed to apply patterns to lines and edges. If false, they all draw as solid lines. Default: true. */\r\n  public readonly styles: boolean;\r\n  /** Whether element transparency is applied. If false, transparent geometry is drawn opaque. Default: true.\r\n   * @see [[RenderMode]] for render mode-specific behavior.\r\n   */\r\n  public readonly transparency: boolean;\r\n  /** In [[RenderMode.Wireframe]] only, whether to display the interiors of planar regions with [[FillFlags.ByView]]. Default: true. */\r\n  public readonly fill: boolean;\r\n  /** In [[RenderMode.SmoothShade]], whether to apply [[RenderTexture]]s to surfaces. Default: true. */\r\n  public readonly textures: boolean;\r\n  /** In [[RenderMode.SmoothShade]], whether to apply [[RenderMaterial]]s to surfaces. Default: true. */\r\n  public readonly materials: boolean;\r\n  /** Whether to display a graphical representation of the view's [AuxCoordSystem]($backend). Default: false. */\r\n  public readonly acsTriad: boolean;\r\n  /** Whether to display a grid. Default: false. */\r\n  public readonly grid: boolean;\r\n  /** In [[RenderMode.SmoothShade]], whether to display the edges of surfaces. Default: false.\r\n   * @see [[HiddenLine.Settings]] to customize the appearance of the edges.\r\n   */\r\n  public readonly visibleEdges: boolean;\r\n  /** In any mode except [[RenderMode.Wireframe]], whether to display the edges of surfaces occluded by other geometry.\r\n   * This has no effect unless [[visibleEdges]] is also true.\r\n   * Default: false.\r\n   * @see [[HiddenLine.Settings]] to customize the appearance of the edges.\r\n   */\r\n  public readonly hiddenEdges: boolean;\r\n  /** In [[RenderMode.SmoothShade]], whether to display solar shadows. This has no effect unless [[lighting]] is also true. Default: false.\r\n   * @note Rendering shadows can reduce framerate, particularly on less capable graphics hardware or in complex scenes.\r\n   */\r\n  public readonly shadows: boolean;\r\n  /** Whether to apply the view's clip volume to the geometry in the scene.\r\n   * Default: true, except when using [[fromJSON]].\r\n   * @see [[ViewDetails.clipVector]] to define the view's clip volume.\r\n   */\r\n  public readonly clipVolume: boolean;\r\n  /** Whether to display geometry of class [[GeometryClass.Construction]].\r\n   * Default: false, except when using [[fromJSON]].\r\n   */\r\n  public readonly constructions: boolean;\r\n  /** Whether to produce a monochrome image. Default: false.\r\n   * @see [DisplayStyleSettings.monochromeColor]($common) to define the monochrome color.\r\n   * @see [DisplayStyleSettings.monochromeMode]($common) to define how the monochrome image is produced.\r\n   */\r\n  public readonly monochrome: boolean;\r\n  /** Whether to display background map imagery. Default: false.\r\n   * @see [[DisplayStyleSettings.backgroundMap]] to customize the map settings.\r\n   */\r\n  public readonly backgroundMap: boolean;\r\n  /** In [[RenderMode.SmoothShade]], whether to apply [[AmbientOcclusion]]. Default: false. */\r\n  public readonly ambientOcclusion: boolean;\r\n  /** Whether to apply [[ThematicDisplay]]. Default: false. */\r\n  public readonly thematicDisplay: boolean;\r\n  /** If true, overlay surfaces with wiremesh to reveal their triangulation. */\r\n  public readonly wiremesh: boolean;\r\n  /** Controls whether surface discard is always applied regardless of other ViewFlags.\r\n   * 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\r\n   * non-planar surfaces always draw in front of those non-planar surfaces.\r\n   * When this view flag is set to false (the default), then for 3d views if the render mode is wireframe (only edges are displayed) or smooth shader with visible edges turned off (only surfaces are displayed),\r\n   * that logic does not execute, potentially improving performance for no degradation in visual quality. In some scenarios - such as wireframe views containing many planar regions with interior fill, or smooth views containing many coincident planar and non-planar surfaces - enabling this view flag improves display quality by forcing that logic to execute.\r\n   */\r\n  public readonly forceSurfaceDiscard: boolean;\r\n  /** Whether to apply white-on-white reversal.\r\n   * Some CAD applications use this to cause white geometry to be drawn as black if the view's background color is white.\r\n   * When enabled, the [[DisplayStyleSettings]]' [[WhiteOnWhiteReversalSettings]] control how white-on-white reversal is applied.\r\n   * Default: true.\r\n   */\r\n  public readonly whiteOnWhiteReversal: boolean;\r\n\r\n  /** In [[RenderMode.SmoothShade]], whether to apply lighting to surfaces.\r\n   * Default: false, except when using [[fromJSON]].\r\n   * @see [[DisplayStyleSettings.lights]] to customize the light settings.\r\n   */\r\n  public readonly lighting: boolean;\r\n\r\n  /** Create a new ViewFlags.\r\n   * @param flags The properties to initialize. Any properties not specified are initialized to their default values.\r\n   */\r\n  public constructor(flags?: Partial<ViewFlagsProperties>) {\r\n    this.renderMode = flags?.renderMode ?? RenderMode.Wireframe;\r\n    this.dimensions = flags?.dimensions ?? true;\r\n    this.patterns = flags?.patterns ?? true;\r\n    this.weights = flags?.weights ?? true;\r\n    this.styles = flags?.styles ?? true;\r\n    this.transparency = flags?.transparency ?? true;\r\n    this.fill = flags?.fill ?? true;\r\n    this.textures = flags?.textures ?? true;\r\n    this.materials = flags?.materials ?? true;\r\n    this.acsTriad = flags?.acsTriad ?? false;\r\n    this.grid = flags?.grid ?? false;\r\n    this.visibleEdges = flags?.visibleEdges ?? false;\r\n    this.hiddenEdges = flags?.hiddenEdges ?? false;\r\n    this.shadows = flags?.shadows ?? false;\r\n    this.clipVolume = flags?.clipVolume ?? true;\r\n    this.constructions = flags?.constructions ?? false;\r\n    this.monochrome = flags?.monochrome ?? false;\r\n    this.backgroundMap = flags?.backgroundMap ?? false;\r\n    this.ambientOcclusion = flags?.ambientOcclusion ?? false;\r\n    this.thematicDisplay = flags?.thematicDisplay ?? false;\r\n    this.wiremesh = flags?.wiremesh ?? false;\r\n    this.forceSurfaceDiscard = flags?.forceSurfaceDiscard ?? false;\r\n    this.whiteOnWhiteReversal = flags?.whiteOnWhiteReversal ?? true;\r\n    this.lighting = flags?.lighting ?? false;\r\n  }\r\n\r\n  /** Produce a copy of these ViewFlags with some modified properties. Any properties not explicitly specified by `changedFlags` will retain their current values.\r\n   * @param changedFlags Properties to modify.\r\n   * @returns A copy of these ViewFlags modified according to the supplied properties.\r\n   * @note Any explicitly `undefined` property of `changedFlags` will be set to its default value in the returned ViewFlags.\r\n   * @see [[override]] to have `undefined` properties retain their current values.\r\n   */\r\n  public copy(changedFlags: Partial<ViewFlagsProperties>): ViewFlags {\r\n    return JsonUtils.isNonEmptyObject(changedFlags) ? new ViewFlags({ ...this, ...changedFlags }) : this;\r\n  }\r\n\r\n  /** Produce a copy of these ViewFlags, overriding some of its properties. Any properties not explicitly specified by `overrides` will retain their current values,\r\n   * as will any property explicitly set to `undefined`.\r\n   * @param overrides The properties to override.\r\n   * @see [[copy]] to have `undefined` properties reset to their default values.\r\n   */\r\n  public override(overrides: Partial<ViewFlagsProperties>): ViewFlags {\r\n    // This method can get called very frequently when a RenderTimeline script is applied to the view. Often `overrides` will be an empty object.\r\n    // To optimize:\r\n    //  - Bail as quickly as possible if nothing is actually overridden, without allocating a new ViewFlags.\r\n    //  - Only make a copy of the input if at least one property is explicitly `undefined`.\r\n    let copied = false;\r\n    let anyOverridden = false;\r\n\r\n    for (const propName of Object.keys(overrides)) {\r\n      const key = propName as keyof Partial<ViewFlagsProperties>;\r\n      const overrideValue = overrides[key];\r\n      if (undefined === overrideValue) {\r\n        if (!copied) {\r\n          // Don't modify input...\r\n          overrides = { ...overrides };\r\n          copied = true;\r\n        }\r\n\r\n        // `undefined` means \"retain existing value\".\r\n        delete overrides[key];\r\n      } else if (overrideValue !== this[key]) {\r\n        anyOverridden = true;\r\n      }\r\n    }\r\n\r\n    return anyOverridden ? this.copy(overrides) : this;\r\n  }\r\n\r\n  /** Produce a copy of these ViewFlags with a single boolean property changed.\r\n   * @param flag The name of the property.\r\n   * @param value The value to change the property to.\r\n   * @returns A new ViewFlags with the property changed as specified, or `this` if the property already has the specified value.\r\n   * @see [[withRenderMode]] to change the [[renderMode]] property.\r\n   * @see [[copy]] and [[override]] to change multiple properties.\r\n   */\r\n  public with(flag: keyof Omit<ViewFlagsProperties, \"renderMode\">, value: boolean): ViewFlags {\r\n    if (this[flag] === value)\r\n      return this;\r\n\r\n    const props: ViewFlagsProperties = { ...this };\r\n    props[flag] = value;\r\n    return new ViewFlags(props);\r\n  }\r\n\r\n  /** Produce a copy of these ViewFlags with a different [[renderMode]].\r\n   * @param renderMode The new render mode.\r\n   * @returns A new ViewFlags with the render mode changed as specified, or `this` if the render mode is already set to the requested value.\r\n   * @see [[copy]] and [[override]] to change multiple properties.\r\n   */\r\n  public withRenderMode(renderMode: RenderMode): ViewFlags {\r\n    return renderMode === this.renderMode ? this : this.copy({ renderMode });\r\n  }\r\n\r\n  /** Adjust view flags for renderer.\r\n   * @internal\r\n   */\r\n  public normalize(): ViewFlags {\r\n    switch (this.renderMode) {\r\n      case RenderMode.Wireframe:\r\n        if (this.visibleEdges || this.hiddenEdges)\r\n          return this.copy({ visibleEdges: false, hiddenEdges: false });\r\n        break;\r\n      case RenderMode.SmoothShade:\r\n        if (!this.visibleEdges)\r\n          return this.copy({ hiddenEdges: false });\r\n        break;\r\n      case RenderMode.HiddenLine:\r\n      case RenderMode.SolidFill:\r\n        if (!this.visibleEdges || this.transparency)\r\n          return this.copy({ visibleEdges: true, transparency: false });\r\n        break;\r\n    }\r\n\r\n    return this;\r\n  }\r\n\r\n  /** Returns true if edges that could be occluded by other geometry are visible for the current [[RenderMode]]. */\r\n  public hiddenEdgesVisible(): boolean {\r\n    switch (this.renderMode) {\r\n      case RenderMode.SolidFill:\r\n      case RenderMode.HiddenLine:\r\n        return this.hiddenEdges;\r\n      case RenderMode.SmoothShade:\r\n        return this.visibleEdges && this.hiddenEdges;\r\n    }\r\n    return true;\r\n  }\r\n\r\n  /** Returns true if the edges of surfaces should be displayed, based on [[RenderMode]] and the [[visibleEdges]] flag. */\r\n  public edgesRequired(): boolean {\r\n    return edgesRequired(this.renderMode, this.visibleEdges);\r\n  }\r\n\r\n  /** Convert to JSON representation.\r\n   * Properties are omitted if they match the default values.\r\n   */\r\n  public toJSON(): ViewFlagProps {\r\n    const out: ViewFlagProps = {};\r\n    if (!this.constructions)\r\n      out.noConstruct = true;\r\n    if (!this.dimensions)\r\n      out.noDim = true;\r\n    if (!this.patterns)\r\n      out.noPattern = true;\r\n    if (!this.weights)\r\n      out.noWeight = true;\r\n    if (!this.styles)\r\n      out.noStyle = true;\r\n    if (!this.transparency)\r\n      out.noTransp = true;\r\n    if (!this.fill)\r\n      out.noFill = true;\r\n    if (this.grid)\r\n      out.grid = true;\r\n    if (this.acsTriad)\r\n      out.acs = true;\r\n    if (!this.textures)\r\n      out.noTexture = true;\r\n    if (!this.materials)\r\n      out.noMaterial = true;\r\n    if (!this.lighting)\r\n      out.noCameraLights = out.noSourceLights = out.noSolarLight = true;\r\n    if (this.visibleEdges)\r\n      out.visEdges = true;\r\n    if (this.hiddenEdges)\r\n      out.hidEdges = true;\r\n    if (this.shadows)\r\n      out.shadows = true;\r\n    if (this.clipVolume)\r\n      out.clipVol = true;\r\n    if (this.monochrome)\r\n      out.monochrome = true;\r\n    if (this.backgroundMap)\r\n      out.backgroundMap = true;\r\n    if (this.ambientOcclusion)\r\n      out.ambientOcclusion = true;\r\n    if (this.thematicDisplay)\r\n      out.thematicDisplay = true;\r\n    if (this.wiremesh)\r\n      out.wiremesh = true;\r\n    if (this.forceSurfaceDiscard)\r\n      out.forceSurfaceDiscard = true;\r\n    if (!this.whiteOnWhiteReversal)\r\n      out.noWhiteOnWhiteReversal = true;\r\n\r\n    out.renderMode = this.renderMode;\r\n    return out;\r\n  }\r\n\r\n  /** Like [[toJSON]], but no properties are omitted. */\r\n  public toFullyDefinedJSON(): Required<ViewFlagProps> {\r\n    return {\r\n      renderMode: this.renderMode,\r\n      noConstruct: !this.constructions,\r\n      noDim: !this.dimensions,\r\n      noPattern: !this.patterns,\r\n      noWeight: !this.weights,\r\n      noStyle: !this.styles,\r\n      noTransp: !this.transparency,\r\n      noFill: !this.fill,\r\n      grid: this.grid,\r\n      acs: this.acsTriad,\r\n      noTexture: !this.textures,\r\n      noMaterial: !this.materials,\r\n      noCameraLights: !this.lighting,\r\n      noSourceLights: !this.lighting,\r\n      noSolarLight: !this.lighting,\r\n      visEdges: this.visibleEdges,\r\n      hidEdges: this.hiddenEdges,\r\n      shadows: this.shadows,\r\n      clipVol: this.clipVolume,\r\n      monochrome: this.monochrome,\r\n      backgroundMap: this.backgroundMap,\r\n      ambientOcclusion: this.ambientOcclusion,\r\n      thematicDisplay: this.thematicDisplay,\r\n      wiremesh: this.wiremesh,\r\n      forceSurfaceDiscard: this.forceSurfaceDiscard,\r\n      noWhiteOnWhiteReversal: !this.whiteOnWhiteReversal,\r\n    };\r\n  }\r\n\r\n  /** A ViewFlags object with all properties initialized to their default values. */\r\n  public static readonly defaults = new ViewFlags();\r\n\r\n  /** Create a ViewFlags.\r\n   * @param flags The properties to initialize. Any properties not specified are initialized to their default values.\r\n   */\r\n  public static create(flags?: Partial<ViewFlagsProperties>): ViewFlags {\r\n    return flags && !JsonUtils.isEmptyObject(flags) ? new ViewFlags(flags) : this.defaults;\r\n  }\r\n\r\n  /** Create a ViewFlags from its JSON representation.\r\n   * @note As described in [[ViewFlagProps]], the JSON representation is awkward and error-prone. Prefer to use [[create]] unless you\r\n   * need to deal with the persistence format directly.\r\n   * @note The default values differ slightly from those used by the constructor and [[create]]:\r\n   *  - [[clipVolume]] defaults to false.\r\n   *  - [[constructions]] defaults to true.\r\n   *  - [[lighting]] defaults to true unless all of [[ViewFlagProps.noSolarLight]], [[ViewFlagProps.noCameraLights]], and [[ViewFlagProps.noSourceLights]] are true.\r\n   */\r\n  public static fromJSON(json?: ViewFlagProps): ViewFlags {\r\n    if (!json)\r\n      return this.defaults;\r\n\r\n    let renderMode: RenderMode;\r\n    const renderModeValue = JsonUtils.asInt(json.renderMode);\r\n    if (renderModeValue < RenderMode.HiddenLine)\r\n      renderMode = RenderMode.Wireframe;\r\n    else if (renderModeValue > RenderMode.SolidFill)\r\n      renderMode = RenderMode.SmoothShade;\r\n    else\r\n      renderMode = renderModeValue;\r\n\r\n    const lighting = !JsonUtils.asBool(json.noCameraLights) || !JsonUtils.asBool(json.noSourceLights) || !JsonUtils.asBool(json.noSolarLight);\r\n    return new ViewFlags({\r\n      renderMode,\r\n      lighting,\r\n      constructions: !JsonUtils.asBool(json.noConstruct),\r\n      dimensions: !JsonUtils.asBool(json.noDim),\r\n      patterns: !JsonUtils.asBool(json.noPattern),\r\n      weights: !JsonUtils.asBool(json.noWeight),\r\n      styles: !JsonUtils.asBool(json.noStyle),\r\n      transparency: !JsonUtils.asBool(json.noTransp),\r\n      fill: !JsonUtils.asBool(json.noFill),\r\n      grid: JsonUtils.asBool(json.grid),\r\n      acsTriad: JsonUtils.asBool(json.acs),\r\n      textures: !JsonUtils.asBool(json.noTexture),\r\n      materials: !JsonUtils.asBool(json.noMaterial),\r\n      visibleEdges: JsonUtils.asBool(json.visEdges),\r\n      hiddenEdges: JsonUtils.asBool(json.hidEdges),\r\n      shadows: JsonUtils.asBool(json.shadows),\r\n      clipVolume: JsonUtils.asBool(json.clipVol),\r\n      monochrome: JsonUtils.asBool(json.monochrome),\r\n      backgroundMap: JsonUtils.asBool(json.backgroundMap),\r\n      ambientOcclusion: JsonUtils.asBool(json.ambientOcclusion),\r\n      thematicDisplay: JsonUtils.asBool(json.thematicDisplay),\r\n      wiremesh: JsonUtils.asBool(json.wiremesh),\r\n      forceSurfaceDiscard: JsonUtils.asBool(json.forceSurfaceDiscard),\r\n      whiteOnWhiteReversal: !JsonUtils.asBool(json.noWhiteOnWhiteReversal),\r\n    });\r\n  }\r\n\r\n  /** Returns true if `this` and `other` are equivalent. */\r\n  public equals(other: Readonly<ViewFlagsProperties>): boolean {\r\n    if (this === other)\r\n      return true;\r\n\r\n    return this.renderMode === other.renderMode\r\n      && this.dimensions === other.dimensions\r\n      && this.patterns === other.patterns\r\n      && this.weights === other.weights\r\n      && this.styles === other.styles\r\n      && this.transparency === other.transparency\r\n      && this.fill === other.fill\r\n      && this.textures === other.textures\r\n      && this.materials === other.materials\r\n      && this.acsTriad === other.acsTriad\r\n      && this.grid === other.grid\r\n      && this.visibleEdges === other.visibleEdges\r\n      && this.hiddenEdges === other.hiddenEdges\r\n      && this.lighting === other.lighting\r\n      && this.shadows === other.shadows\r\n      && this.clipVolume === other.clipVolume\r\n      && this.constructions === other.constructions\r\n      && this.monochrome === other.monochrome\r\n      && this.backgroundMap === other.backgroundMap\r\n      && this.ambientOcclusion === other.ambientOcclusion\r\n      && this.thematicDisplay === other.thematicDisplay\r\n      && this.wiremesh === other.wiremesh\r\n      && this.forceSurfaceDiscard === other.forceSurfaceDiscard\r\n      && this.whiteOnWhiteReversal === other.whiteOnWhiteReversal;\r\n  }\r\n}\r\n\r\n/** A type containing all of the properties of [[ViewFlags]] with none of the methods and with the `readonly` modifiers removed.\r\n * @see [[ViewFlags.create]], [[ViewFlags.copy]], and [[ViewFlags.override]] for methods accepting an object of this type.\r\n * @public\r\n * @extensions\r\n */\r\nexport type ViewFlagsProperties = Mutable<NonFunctionPropertiesOf<ViewFlags>>;\r\n\r\n/** A type that describes how to override selected properties of a [[ViewFlags]].\r\n * @see [[ViewFlags.override]] to apply the overrides to a ViewFlags object.\r\n * @public\r\n * @extensions\r\n */\r\nexport type ViewFlagOverrides = Partial<ViewFlagsProperties>;\r\n"]}

package/lib/esm/WhiteOnWhiteReversalSettings.js

@@ -12,7 +12,7 @@
  * @see [[DisplayStyleSettings.whiteOnWhiteReversal]] to change these settings for a display style.
  * @public
  */
-class WhiteOnWhiteReversalSettings {
+export class WhiteOnWhiteReversalSettings {
     constructor(ignoreBackground) {
         this.ignoreBackgroundColor = ignoreBackground;
     }
@@ -31,5 +31,4 @@ class WhiteOnWhiteReversalSettings {
 }
 WhiteOnWhiteReversalSettings._noIgnore = new WhiteOnWhiteReversalSettings(true);
 WhiteOnWhiteReversalSettings._ignore = new WhiteOnWhiteReversalSettings(false);
-export { WhiteOnWhiteReversalSettings };
 //# sourceMappingURL=WhiteOnWhiteReversalSettings.js.map

package/lib/esm/WhiteOnWhiteReversalSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"WhiteOnWhiteReversalSettings.js","sourceRoot":"","sources":["../../src/WhiteOnWhiteReversalSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAaH;;;;;;GAMG;AACH,MAAa,4BAA4B;IAOvC,YAAoB,gBAAyB;QAC3C,IAAI,CAAC,qBAAqB,GAAG,gBAAgB,CAAC;IAChD,CAAC;IAKD,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,OAAO,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACtE,CAAC;IAED,mHAAmH;IAC5G,MAAM;QACX,OAAO,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAClF,CAAC;IAED,uDAAuD;IAChD,MAAM,CAAC,KAAmC;QAC/C,OAAO,IAAI,KAAK,KAAK,CAAC;IACxB,CAAC;;AAhBc,sCAAS,GAAG,IAAI,4BAA4B,CAAC,IAAI,CAAC,CAAC;AACnD,oCAAO,GAAG,IAAI,4BAA4B,CAAC,KAAK,CAAC,CAAC;SAZtD,4BAA4B","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/** JSON representation of a [[WhiteOnWhiteReversalSettings]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface WhiteOnWhiteReversalProps {\r\n  /** Default: false.\r\n   * @see [[WhiteOnWhiteReversalSettings.ignoreBackgroundColor]].\r\n   */\r\n  ignoreBackgroundColor?: boolean;\r\n}\r\n\r\n/** As part of a [[DisplayStyleSettings]], controls how white-on-white reversal is applied to make white geometry more\r\n * visible in the view.\r\n * By default, pure white geometry is displayed as black instead if the [[DisplayStyleSettings.backgroundColor]] is also pure white.\r\n * These settings are only applied if the display style's [[ViewFlags.whiteOnWhiteReversal]] flag is enabled.\r\n * @see [[DisplayStyleSettings.whiteOnWhiteReversal]] to change these settings for a display style.\r\n * @public\r\n */\r\nexport class WhiteOnWhiteReversalSettings {\r\n  /** If true, white-on-white reversal ignores the display style's background color; otherwise, white-on-white reversal applies only\r\n   * if the background color is pure white.\r\n   * @see [[DisplayStyleSettings.backgroundColor]] to change the background color.\r\n   */\r\n  public readonly ignoreBackgroundColor: boolean;\r\n\r\n  private constructor(ignoreBackground: boolean) {\r\n    this.ignoreBackgroundColor = ignoreBackground;\r\n  }\r\n\r\n  private static _noIgnore = new WhiteOnWhiteReversalSettings(true);\r\n  private static _ignore = new WhiteOnWhiteReversalSettings(false);\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props?: WhiteOnWhiteReversalProps): WhiteOnWhiteReversalSettings {\r\n    return props?.ignoreBackgroundColor ? this._noIgnore : this._ignore;\r\n  }\r\n\r\n  /** Convert to JSON representation. The JSON representation is `undefined` if these settings match the defaults. */\r\n  public toJSON(): WhiteOnWhiteReversalProps | undefined {\r\n    return this.ignoreBackgroundColor ? { ignoreBackgroundColor: true } : undefined;\r\n  }\r\n\r\n  /** Returns true if `this` is equivalent to `other`. */\r\n  public equals(other: WhiteOnWhiteReversalSettings): boolean {\r\n    return this === other;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"WhiteOnWhiteReversalSettings.js","sourceRoot":"","sources":["../../src/WhiteOnWhiteReversalSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAaH;;;;;;GAMG;AACH,MAAM,OAAO,4BAA4B;IAOvC,YAAoB,gBAAyB;QAC3C,IAAI,CAAC,qBAAqB,GAAG,gBAAgB,CAAC;IAChD,CAAC;IAKD,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,OAAO,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;IACtE,CAAC;IAED,mHAAmH;IAC5G,MAAM;QACX,OAAO,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAClF,CAAC;IAED,uDAAuD;IAChD,MAAM,CAAC,KAAmC;QAC/C,OAAO,IAAI,KAAK,KAAK,CAAC;IACxB,CAAC;;AAhBc,sCAAS,GAAG,IAAI,4BAA4B,CAAC,IAAI,CAAC,CAAC;AACnD,oCAAO,GAAG,IAAI,4BAA4B,CAAC,KAAK,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/** JSON representation of a [[WhiteOnWhiteReversalSettings]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface WhiteOnWhiteReversalProps {\r\n  /** Default: false.\r\n   * @see [[WhiteOnWhiteReversalSettings.ignoreBackgroundColor]].\r\n   */\r\n  ignoreBackgroundColor?: boolean;\r\n}\r\n\r\n/** As part of a [[DisplayStyleSettings]], controls how white-on-white reversal is applied to make white geometry more\r\n * visible in the view.\r\n * By default, pure white geometry is displayed as black instead if the [[DisplayStyleSettings.backgroundColor]] is also pure white.\r\n * These settings are only applied if the display style's [[ViewFlags.whiteOnWhiteReversal]] flag is enabled.\r\n * @see [[DisplayStyleSettings.whiteOnWhiteReversal]] to change these settings for a display style.\r\n * @public\r\n */\r\nexport class WhiteOnWhiteReversalSettings {\r\n  /** If true, white-on-white reversal ignores the display style's background color; otherwise, white-on-white reversal applies only\r\n   * if the background color is pure white.\r\n   * @see [[DisplayStyleSettings.backgroundColor]] to change the background color.\r\n   */\r\n  public readonly ignoreBackgroundColor: boolean;\r\n\r\n  private constructor(ignoreBackground: boolean) {\r\n    this.ignoreBackgroundColor = ignoreBackground;\r\n  }\r\n\r\n  private static _noIgnore = new WhiteOnWhiteReversalSettings(true);\r\n  private static _ignore = new WhiteOnWhiteReversalSettings(false);\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props?: WhiteOnWhiteReversalProps): WhiteOnWhiteReversalSettings {\r\n    return props?.ignoreBackgroundColor ? this._noIgnore : this._ignore;\r\n  }\r\n\r\n  /** Convert to JSON representation. The JSON representation is `undefined` if these settings match the defaults. */\r\n  public toJSON(): WhiteOnWhiteReversalProps | undefined {\r\n    return this.ignoreBackgroundColor ? { ignoreBackgroundColor: true } : undefined;\r\n  }\r\n\r\n  /** Returns true if `this` is equivalent to `other`. */\r\n  public equals(other: WhiteOnWhiteReversalSettings): boolean {\r\n    return this === other;\r\n  }\r\n}\r\n"]}

package/lib/esm/annotation/TextAnnotation.d.ts

@@ -0,0 +1,107 @@
+/** @packageDocumentation
+ * @module Annotation
+ */
+import { Point3d, Transform, XAndY, XYZProps, YawPitchRollAngles, YawPitchRollProps } from "@itwin/core-geometry";
+import { TextBlock, TextBlockProps } from "./TextBlock";
+/** Describes how to compute the "anchor point" for a [[TextAnnotation]].
+ * The anchor point is a point on or inside of the 2d bounding box enclosing the contents of the annotation's [[TextBlock]].
+ * The annotation can be rotated and translated relative to the anchor point. The anchor point also serves as the snap point
+ * when [AccuSnap]($frontend) is set to [SnapMode.Origin]($frontend).
+ * @see [[TextAnnotation]] for a description of how the anchor point is computed.
+ * @beta
+ */
+export interface TextAnnotationAnchor {
+    /**
+     * The vertical alignment of the anchor point.
+     * "top" aligns the anchor point with the top of the text's bounding box.
+     * "middle" aligns the anchor point with the middle of the text's bounding box.
+     * "bottom" aligns the anchor point with the bottom of the text's bounding box.
+     */
+    vertical: "top" | "middle" | "bottom";
+    /**
+     * The horizontal alignment of the anchor point.
+     * "left" aligns the anchor point with left side of the text's bounding box.
+     * "center" aligns the anchor point with center of the text with's bounding box.
+     * "right" aligns the anchor point with right side of the text's bounding box.
+     */
+    horizontal: "left" | "center" | "right";
+}
+/**
+ * JSON representation of a [[TextAnnotation]].
+ * @beta
+ */
+export interface TextAnnotationProps {
+    /** See [[TextAnnotation.offset]]. Default: [0, 0, 0]. */
+    offset?: XYZProps;
+    /** See [[TextAnnotation.orientation]]. Default: no rotation. */
+    orientation?: YawPitchRollProps;
+    /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */
+    textBlock?: TextBlockProps;
+    /** See [[TextAnnotation.anchor]]. Default: top-left. */
+    anchor?: TextAnnotationAnchor;
+}
+/** Arguments supplied to [[TextAnnotation.create]].
+ * @beta
+ */
+export interface TextAnnotationCreateArgs {
+    /** See [[TextAnnotation.offset]]. Default: (0, 0, 0). */
+    offset?: Point3d;
+    /** See [[TextAnnotation.orientation]]. Default: no rotation. */
+    orientation?: YawPitchRollAngles;
+    /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */
+    textBlock?: TextBlock;
+    /** See [[TextAnnotation.anchor]]. Default: top-left. */
+    anchor?: TextAnnotationAnchor;
+}
+/**
+ * Represents a formatted block of text positioned in 2d or 3d space.
+ * [TextAnnotation2d]($backend) and [TextAnnotation3d]($backend) elements store a single TextAnnotation from which their geometric representation is generated.
+ * Other types of elements may store multiple TextAnnotations, positioned relative to one another.
+ * The annotation's position and orientation relative to the host element's [Placement]($common) is determined as follows:
+ * - First, the width and height of a box enclosing the contents of the [[textBlock]] must be computed using [computeTextBlockExtents]($backend). This yields a box with the top-left
+ * corner at (0, 0) and the bottom-right corner at (width, -height).
+ * - Then, an "anchor point" is computed based on the text box and the [[anchor]] property. For example, if the annotation is anchored at the center-left, the anchor point will be (width/2, -height).
+ * - The [[orientation]] is applied to rotate the box around the anchor point.
+ * - Finally, the [[offset]] is added to the anchor point to apply translation.
+ * @see [produceTextAnnotationGeometry]($backend) to decompose the annotation into a set of geometric primitives suitable for use with [[GeometryStreamBuilder.appendTextBlock]].
+ * @beta
+ */
+export declare class TextAnnotation {
+    /** The rotation of the annotation.
+     * @note When defining an annotation for a [TextAnnotation2d]($backend), only the `yaw` component (rotation around the Z axis) is used.
+     */
+    orientation: YawPitchRollAngles;
+    /** The formatted document. */
+    textBlock: TextBlock;
+    /** Describes how to compute the [[textBlock]]'s anchor point. */
+    anchor: TextAnnotationAnchor;
+    /** An offset applied to the anchor point that can be used to position annotations within the same geometry stream relative to one another. */
+    offset: Point3d;
+    private constructor();
+    /** Creates a new TextAnnotation. */
+    static create(args?: TextAnnotationCreateArgs): TextAnnotation;
+    /**
+     * Creates a new TextAnnotation instance from its JSON representation.
+     */
+    static fromJSON(props: TextAnnotationProps | undefined): TextAnnotation;
+    /**
+     * Converts this annotation to its JSON representation.
+     */
+    toJSON(): TextAnnotationProps;
+    /** Compute the transform that positions and orients this annotation relative to its anchor point, based on the [[textBlock]]'s computed bounding box.
+     * The anchor point is computed as specified by this annotation's [[anchor]] setting. For example, if the text block is anchored
+     * at the bottom left, then the transform will be relative to the bottom-left corner of `textBlockExtents`.
+     * The text block will be rotated around the fixed anchor point according to [[orientation]], then the anchor point will be translated by [[offset]].
+     * @param textBlockDimensions The width and height of the bounding box containing the text block. You can compute this using [computeTextBlockExtents]($common).
+     * @see [[computeAnchorPoint]] to compute the transform's anchor point.
+     */
+    computeTransform(textBlockDimensions: XAndY): Transform;
+    /** Compute the anchor point of this annotation as specified by [[anchor]].
+     * @param textBlockDimensions The width and height of the bounding box containing the [[textBlock]]. You can compute this using [computeTextBlockExtents]($common).
+     * @see [[computeTransform]] to compute the transform relative to the anchor point.
+     */
+    computeAnchorPoint(textBlockDimensions: XAndY): Point3d;
+    /** Returns true if this annotation is logically equivalent to `other`. */
+    equals(other: TextAnnotation): boolean;
+}
+//# sourceMappingURL=TextAnnotation.d.ts.map

package/lib/esm/annotation/TextAnnotation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextAnnotation.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAClH,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAExD;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEtC;;;;;OAKG;IACH,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,yDAAyD;IACzD,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,gEAAgE;IAChE,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,sEAAsE;IACtE,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,gEAAgE;IAChE,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,sEAAsE;IACtE,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,wDAAwD;IACxD,MAAM,CAAC,EAAE,oBAAoB,CAAC;CAC/B;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IACzB;;OAEG;IACI,WAAW,EAAE,kBAAkB,CAAC;IACvC,8BAA8B;IACvB,SAAS,EAAE,SAAS,CAAC;IAC5B,iEAAiE;IAC1D,MAAM,EAAE,oBAAoB,CAAC;IACpC,8IAA8I;IACvI,MAAM,EAAE,OAAO,CAAC;IAEvB,OAAO;IAOP,oCAAoC;WACtB,MAAM,CAAC,IAAI,CAAC,EAAE,wBAAwB,GAAG,cAAc;IASrE;;OAEG;WACW,QAAQ,CAAC,KAAK,EAAE,mBAAmB,GAAG,SAAS,GAAG,cAAc;IAS9E;;OAEG;IACI,MAAM,IAAI,mBAAmB;IAsBpC;;;;;;OAMG;IACI,gBAAgB,CAAC,mBAAmB,EAAE,KAAK,GAAG,SAAS;IAS9D;;;OAGG;IACI,kBAAkB,CAAC,mBAAmB,EAAE,KAAK,GAAG,OAAO;IAyB9D,0EAA0E;IACnE,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO;CAK9C"}

package/lib/esm/annotation/TextAnnotation.js

@@ -0,0 +1,114 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Annotation
+ */
+import { Point3d, Transform, YawPitchRollAngles } from "@itwin/core-geometry";
+import { TextBlock } from "./TextBlock";
+/**
+ * Represents a formatted block of text positioned in 2d or 3d space.
+ * [TextAnnotation2d]($backend) and [TextAnnotation3d]($backend) elements store a single TextAnnotation from which their geometric representation is generated.
+ * Other types of elements may store multiple TextAnnotations, positioned relative to one another.
+ * The annotation's position and orientation relative to the host element's [Placement]($common) is determined as follows:
+ * - First, the width and height of a box enclosing the contents of the [[textBlock]] must be computed using [computeTextBlockExtents]($backend). This yields a box with the top-left
+ * corner at (0, 0) and the bottom-right corner at (width, -height).
+ * - Then, an "anchor point" is computed based on the text box and the [[anchor]] property. For example, if the annotation is anchored at the center-left, the anchor point will be (width/2, -height).
+ * - The [[orientation]] is applied to rotate the box around the anchor point.
+ * - Finally, the [[offset]] is added to the anchor point to apply translation.
+ * @see [produceTextAnnotationGeometry]($backend) to decompose the annotation into a set of geometric primitives suitable for use with [[GeometryStreamBuilder.appendTextBlock]].
+ * @beta
+ */
+export class TextAnnotation {
+    constructor(offset, angles, textBlock, anchor) {
+        this.offset = offset;
+        this.orientation = angles;
+        this.textBlock = textBlock;
+        this.anchor = anchor;
+    }
+    /** Creates a new TextAnnotation. */
+    static create(args) {
+        const offset = args?.offset ?? new Point3d();
+        const angles = args?.orientation ?? new YawPitchRollAngles();
+        const textBlock = args?.textBlock ?? TextBlock.createEmpty();
+        const anchor = args?.anchor ?? { vertical: "top", horizontal: "left" };
+        return new TextAnnotation(offset, angles, textBlock, anchor);
+    }
+    /**
+     * Creates a new TextAnnotation instance from its JSON representation.
+     */
+    static fromJSON(props) {
+        return TextAnnotation.create({
+            offset: props?.offset ? Point3d.fromJSON(props.offset) : undefined,
+            orientation: props?.orientation ? YawPitchRollAngles.fromJSON(props.orientation) : undefined,
+            textBlock: props?.textBlock ? TextBlock.create(props.textBlock) : undefined,
+            anchor: props?.anchor ? { ...props.anchor } : undefined,
+        });
+    }
+    /**
+     * Converts this annotation to its JSON representation.
+     */
+    toJSON() {
+        const props = {};
+        // Even if the text block is empty, we want to record its style name and overrides, e.g.,
+        // so the user can pick up where they left off editing it next time.
+        props.textBlock = this.textBlock.toJSON();
+        if (!this.offset.isZero) {
+            props.offset = this.offset.toJSON();
+        }
+        if (!this.orientation.isIdentity()) {
+            props.orientation = this.orientation.toJSON();
+        }
+        if (this.anchor.vertical !== "top" || this.anchor.horizontal !== "left") {
+            props.anchor = { ...this.anchor };
+        }
+        return props;
+    }
+    /** Compute the transform that positions and orients this annotation relative to its anchor point, based on the [[textBlock]]'s computed bounding box.
+     * The anchor point is computed as specified by this annotation's [[anchor]] setting. For example, if the text block is anchored
+     * at the bottom left, then the transform will be relative to the bottom-left corner of `textBlockExtents`.
+     * The text block will be rotated around the fixed anchor point according to [[orientation]], then the anchor point will be translated by [[offset]].
+     * @param textBlockDimensions The width and height of the bounding box containing the text block. You can compute this using [computeTextBlockExtents]($common).
+     * @see [[computeAnchorPoint]] to compute the transform's anchor point.
+     */
+    computeTransform(textBlockDimensions) {
+        const anchorPt = this.computeAnchorPoint(textBlockDimensions);
+        const matrix = this.orientation.toMatrix3d();
+        const rotation = Transform.createFixedPointAndMatrix(anchorPt, matrix);
+        const translation = Transform.createTranslation(this.offset);
+        return translation.multiplyTransformTransform(rotation, rotation);
+    }
+    /** Compute the anchor point of this annotation as specified by [[anchor]].
+     * @param textBlockDimensions The width and height of the bounding box containing the [[textBlock]]. You can compute this using [computeTextBlockExtents]($common).
+     * @see [[computeTransform]] to compute the transform relative to the anchor point.
+     */
+    computeAnchorPoint(textBlockDimensions) {
+        let x = 0;
+        let y = 0;
+        switch (this.anchor.horizontal) {
+            case "center":
+                x += textBlockDimensions.x / 2;
+                break;
+            case "right":
+                x += textBlockDimensions.x;
+                break;
+        }
+        switch (this.anchor.vertical) {
+            case "middle":
+                y -= textBlockDimensions.y / 2;
+                break;
+            case "bottom":
+                y -= textBlockDimensions.y;
+                break;
+        }
+        return new Point3d(x, y, 0);
+    }
+    /** Returns true if this annotation is logically equivalent to `other`. */
+    equals(other) {
+        return this.anchor.horizontal === other.anchor.horizontal && this.anchor.vertical === other.anchor.vertical
+            && this.orientation.isAlmostEqual(other.orientation) && this.offset.isAlmostEqual(other.offset)
+            && this.textBlock.equals(other.textBlock);
+    }
+}
+//# sourceMappingURL=TextAnnotation.js.map

package/lib/esm/annotation/TextAnnotation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextAnnotation.js","sourceRoot":"","sources":["../../../src/annotation/TextAnnotation.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,SAAS,EAAmB,kBAAkB,EAAqB,MAAM,sBAAsB,CAAC;AAClH,OAAO,EAAE,SAAS,EAAkB,MAAM,aAAa,CAAC;AAwDxD;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,cAAc;IAYzB,YAAoB,MAAe,EAAE,MAA0B,EAAE,SAAoB,EAAE,MAA4B;QACjH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,oCAAoC;IAC7B,MAAM,CAAC,MAAM,CAAC,IAA+B;QAClD,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC7C,MAAM,MAAM,GAAG,IAAI,EAAE,WAAW,IAAI,IAAI,kBAAkB,EAAE,CAAC;QAC7D,MAAM,SAAS,GAAG,IAAI,EAAE,SAAS,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAC7D,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;QAEvE,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAsC;QAC3D,OAAO,cAAc,CAAC,MAAM,CAAC;YAC3B,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;YAClE,WAAW,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;YAC5F,SAAS,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;YAC3E,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS;SACxD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAwB,EAAE,CAAC;QAEtC,yFAAyF;QACzF,oEAAoE;QACpE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QAE1C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACxB,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,EAAE,CAAC;YACnC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAChD,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,MAAM,EAAE,CAAC;YACxE,KAAK,CAAC,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACpC,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACI,gBAAgB,CAAC,mBAA0B;QAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,CAAC;QAC9D,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAE7C,MAAM,QAAQ,GAAG,SAAS,CAAC,yBAAyB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACvE,MAAM,WAAW,GAAG,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC7D,OAAO,WAAW,CAAC,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,kBAAkB,CAAC,mBAA0B;QAClD,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,IAAI,CAAC,GAAG,CAAC,CAAC;QAEV,QAAQ,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YAC/B,KAAK,QAAQ;gBACX,CAAC,IAAI,mBAAmB,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,OAAO;gBACV,CAAC,IAAI,mBAAmB,CAAC,CAAC,CAAC;gBAC3B,MAAM;QACV,CAAC;QAED,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC7B,KAAK,QAAQ;gBACX,CAAC,IAAI,mBAAmB,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,QAAQ;gBACX,CAAC,IAAI,mBAAmB,CAAC,CAAC,CAAC;gBAC3B,MAAM;QACV,CAAC;QAED,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED,0EAA0E;IACnE,MAAM,CAAC,KAAqB;QACjC,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,KAAK,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,KAAK,KAAK,CAAC,MAAM,CAAC,QAAQ;eACtG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC;eAC5F,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;CACF","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 Annotation\r\n */\r\n\r\nimport { Point3d, Transform, XAndY, XYZProps, YawPitchRollAngles, YawPitchRollProps } from \"@itwin/core-geometry\";\r\nimport { TextBlock, TextBlockProps } from \"./TextBlock\";\r\n\r\n/** Describes how to compute the \"anchor point\" for a [[TextAnnotation]].\r\n * The anchor point is a point on or inside of the 2d bounding box enclosing the contents of the annotation's [[TextBlock]].\r\n * The annotation can be rotated and translated relative to the anchor point. The anchor point also serves as the snap point\r\n * when [AccuSnap]($frontend) is set to [SnapMode.Origin]($frontend).\r\n * @see [[TextAnnotation]] for a description of how the anchor point is computed.\r\n * @beta\r\n */\r\nexport interface TextAnnotationAnchor {\r\n  /**\r\n   * The vertical alignment of the anchor point.\r\n   * \"top\" aligns the anchor point with the top of the text's bounding box.\r\n   * \"middle\" aligns the anchor point with the middle of the text's bounding box.\r\n   * \"bottom\" aligns the anchor point with the bottom of the text's bounding box.\r\n   */\r\n  vertical: \"top\" | \"middle\" | \"bottom\";\r\n\r\n  /**\r\n   * The horizontal alignment of the anchor point.\r\n   * \"left\" aligns the anchor point with left side of the text's bounding box.\r\n   * \"center\" aligns the anchor point with center of the text with's bounding box.\r\n   * \"right\" aligns the anchor point with right side of the text's bounding box.\r\n   */\r\n  horizontal: \"left\" | \"center\" | \"right\";\r\n}\r\n\r\n/**\r\n * JSON representation of a [[TextAnnotation]].\r\n * @beta\r\n */\r\nexport interface TextAnnotationProps {\r\n  /** See [[TextAnnotation.offset]]. Default: [0, 0, 0]. */\r\n  offset?: XYZProps;\r\n  /** See [[TextAnnotation.orientation]]. Default: no rotation. */\r\n  orientation?: YawPitchRollProps;\r\n  /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */\r\n  textBlock?: TextBlockProps;\r\n  /** See [[TextAnnotation.anchor]]. Default: top-left. */\r\n  anchor?: TextAnnotationAnchor;\r\n}\r\n\r\n/** Arguments supplied to [[TextAnnotation.create]].\r\n * @beta\r\n */\r\nexport interface TextAnnotationCreateArgs {\r\n  /** See [[TextAnnotation.offset]]. Default: (0, 0, 0). */\r\n  offset?: Point3d;\r\n  /** See [[TextAnnotation.orientation]]. Default: no rotation. */\r\n  orientation?: YawPitchRollAngles;\r\n  /** See [[TextAnnotation.textBlock]]. Default: an empty text block. */\r\n  textBlock?: TextBlock;\r\n  /** See [[TextAnnotation.anchor]]. Default: top-left. */\r\n  anchor?: TextAnnotationAnchor;\r\n}\r\n\r\n/**\r\n * Represents a formatted block of text positioned in 2d or 3d space.\r\n * [TextAnnotation2d]($backend) and [TextAnnotation3d]($backend) elements store a single TextAnnotation from which their geometric representation is generated.\r\n * Other types of elements may store multiple TextAnnotations, positioned relative to one another.\r\n * The annotation's position and orientation relative to the host element's [Placement]($common) is determined as follows:\r\n * - First, the width and height of a box enclosing the contents of the [[textBlock]] must be computed using [computeTextBlockExtents]($backend). This yields a box with the top-left\r\n * corner at (0, 0) and the bottom-right corner at (width, -height).\r\n * - Then, an \"anchor point\" is computed based on the text box and the [[anchor]] property. For example, if the annotation is anchored at the center-left, the anchor point will be (width/2, -height).\r\n * - The [[orientation]] is applied to rotate the box around the anchor point.\r\n * - Finally, the [[offset]] is added to the anchor point to apply translation.\r\n * @see [produceTextAnnotationGeometry]($backend) to decompose the annotation into a set of geometric primitives suitable for use with [[GeometryStreamBuilder.appendTextBlock]].\r\n * @beta\r\n */\r\nexport class TextAnnotation {\r\n  /** The rotation of the annotation.\r\n   * @note When defining an annotation for a [TextAnnotation2d]($backend), only the `yaw` component (rotation around the Z axis) is used.\r\n   */\r\n  public orientation: YawPitchRollAngles;\r\n  /** The formatted document. */\r\n  public textBlock: TextBlock;\r\n  /** Describes how to compute the [[textBlock]]'s anchor point. */\r\n  public anchor: TextAnnotationAnchor;\r\n  /** An offset applied to the anchor point that can be used to position annotations within the same geometry stream relative to one another. */\r\n  public offset: Point3d;\r\n\r\n  private constructor(offset: Point3d, angles: YawPitchRollAngles, textBlock: TextBlock, anchor: TextAnnotationAnchor) {\r\n    this.offset = offset;\r\n    this.orientation = angles;\r\n    this.textBlock = textBlock;\r\n    this.anchor = anchor;\r\n  }\r\n\r\n  /** Creates a new TextAnnotation. */\r\n  public static create(args?: TextAnnotationCreateArgs): TextAnnotation {\r\n    const offset = args?.offset ?? new Point3d();\r\n    const angles = args?.orientation ?? new YawPitchRollAngles();\r\n    const textBlock = args?.textBlock ?? TextBlock.createEmpty();\r\n    const anchor = args?.anchor ?? { vertical: \"top\", horizontal: \"left\" };\r\n\r\n    return new TextAnnotation(offset, angles, textBlock, anchor);\r\n  }\r\n\r\n  /**\r\n   * Creates a new TextAnnotation instance from its JSON representation.\r\n   */\r\n  public static fromJSON(props: TextAnnotationProps | undefined): TextAnnotation {\r\n    return TextAnnotation.create({\r\n      offset: props?.offset ? Point3d.fromJSON(props.offset) : undefined,\r\n      orientation: props?.orientation ? YawPitchRollAngles.fromJSON(props.orientation) : undefined,\r\n      textBlock: props?.textBlock ? TextBlock.create(props.textBlock) : undefined,\r\n      anchor: props?.anchor ? { ...props.anchor } : undefined,\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Converts this annotation to its JSON representation.\r\n   */\r\n  public toJSON(): TextAnnotationProps {\r\n    const props: TextAnnotationProps = {};\r\n\r\n    // Even if the text block is empty, we want to record its style name and overrides, e.g.,\r\n    // so the user can pick up where they left off editing it next time.\r\n    props.textBlock = this.textBlock.toJSON();\r\n\r\n    if (!this.offset.isZero) {\r\n      props.offset = this.offset.toJSON();\r\n    }\r\n\r\n    if (!this.orientation.isIdentity()) {\r\n      props.orientation = this.orientation.toJSON();\r\n    }\r\n\r\n    if (this.anchor.vertical !== \"top\" || this.anchor.horizontal !== \"left\") {\r\n      props.anchor = { ...this.anchor };\r\n    }\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Compute the transform that positions and orients this annotation relative to its anchor point, based on the [[textBlock]]'s computed bounding box.\r\n   * The anchor point is computed as specified by this annotation's [[anchor]] setting. For example, if the text block is anchored\r\n   * at the bottom left, then the transform will be relative to the bottom-left corner of `textBlockExtents`.\r\n   * The text block will be rotated around the fixed anchor point according to [[orientation]], then the anchor point will be translated by [[offset]].\r\n   * @param textBlockDimensions The width and height of the bounding box containing the text block. You can compute this using [computeTextBlockExtents]($common).\r\n   * @see [[computeAnchorPoint]] to compute the transform's anchor point.\r\n   */\r\n  public computeTransform(textBlockDimensions: XAndY): Transform {\r\n    const anchorPt = this.computeAnchorPoint(textBlockDimensions);\r\n    const matrix = this.orientation.toMatrix3d();\r\n\r\n    const rotation = Transform.createFixedPointAndMatrix(anchorPt, matrix);\r\n    const translation = Transform.createTranslation(this.offset);\r\n    return translation.multiplyTransformTransform(rotation, rotation);\r\n  }\r\n\r\n  /** Compute the anchor point of this annotation as specified by [[anchor]].\r\n   * @param textBlockDimensions The width and height of the bounding box containing the [[textBlock]]. You can compute this using [computeTextBlockExtents]($common).\r\n   * @see [[computeTransform]] to compute the transform relative to the anchor point.\r\n   */\r\n  public computeAnchorPoint(textBlockDimensions: XAndY): Point3d {\r\n    let x = 0;\r\n    let y = 0;\r\n\r\n    switch (this.anchor.horizontal) {\r\n      case \"center\":\r\n        x += textBlockDimensions.x / 2;\r\n        break;\r\n      case \"right\":\r\n        x += textBlockDimensions.x;\r\n        break;\r\n    }\r\n\r\n    switch (this.anchor.vertical) {\r\n      case \"middle\":\r\n        y -= textBlockDimensions.y / 2;\r\n        break;\r\n      case \"bottom\":\r\n        y -= textBlockDimensions.y;\r\n        break;\r\n    }\r\n\r\n    return new Point3d(x, y, 0);\r\n  }\r\n\r\n  /** Returns true if this annotation is logically equivalent to `other`. */\r\n  public equals(other: TextAnnotation): boolean {\r\n    return this.anchor.horizontal === other.anchor.horizontal && this.anchor.vertical === other.anchor.vertical\r\n      && this.orientation.isAlmostEqual(other.orientation) && this.offset.isAlmostEqual(other.offset)\r\n      && this.textBlock.equals(other.textBlock);\r\n  }\r\n}\r\n"]}