@itwin/core-common 4.1.0-dev.8 → 4.1.0-dev.81

package/lib/cjs/RpcInterface.js

@@ -22,41 +22,42 @@ const core_bentley_1 = require("@itwin/core-bentley");
  */
 class RpcInterface {
     static findDiff(backend, frontend) {
-        return backend.major !== frontend.major ? "major" : backend.minor !== frontend.minor ? "minor" : backend.patch !== frontend.patch ? "patch" : backend.prerelease !== frontend.prerelease ? "prerelease" : "same";
+        return backend.major !== frontend.major ? "major" :
+            backend.minor !== frontend.minor ? "minor" :
+                backend.patch !== frontend.patch ? "patch" :
+                    backend.prerelease !== frontend.prerelease ? "prerelease" :
+                        "same";
     }
     static parseVer(version) {
-        // Split the version string into major.minor.path and prerelease tag
-        const split = version.split(/[:-]/);
-        // Split the major.minor.path into seperate components
-        const prefix = split[0].split(".");
-        if (split.length === 1) {
-            return { major: Number(prefix[0]), minor: Number(prefix[1]), patch: Number(prefix[2]) };
-        }
-        else {
-            return { major: Number(prefix[0]), minor: Number(prefix[1]), patch: Number(prefix[2]), prerelease: split[1] };
-        }
+        // separate the version from the prerelease tag
+        const parts = version.split(/[:-]/);
+        // Split the major.minor.path into separate components
+        const prefix = parts[0].split(".");
+        const ver = { major: Number(prefix[0]), minor: Number(prefix[1]), patch: Number(prefix[2]) };
+        if (parts.length > 1)
+            ver.prerelease = parts[1];
+        return ver;
     }
     /** Determines whether the backend version of an RPC interface is compatible (according to semantic versioning) with the frontend version of the interface. */
     static isVersionCompatible(backend, frontend) {
+        if (backend === frontend)
+            return true; // most common case, versions are identical
         const backendSemver = this.parseVer(backend);
         const frontendSemver = this.parseVer(frontend);
+        // if either has a prerelease tag, they are not compatible unless version strings are identical
+        if (backendSemver.prerelease || frontendSemver.prerelease)
+            return false;
         const difference = this.findDiff(backendSemver, frontendSemver);
         // If the major versions are different, the versions are not compatible
-        // In the case of prerelease tags, they are compatible if the whole version string matches, otherwise it fails
-        if ((backendSemver.prerelease !== undefined || frontendSemver.prerelease !== undefined) || difference === "major") {
-            return difference === "same";
-        }
-        else if (backendSemver.major === 0 || frontendSemver.major === 0) {
-            // If the major and minor versions match and major versions are 0, compatible as long as backend patch version is greater
-            return difference === "same" || (difference === "patch" && frontendSemver.patch < backendSemver.patch);
-        }
-        else {
-            // If the strings match exactly, major and minor match but patch differs, versions are compatible
-            // If minor versions differ, compatible as long as backend patch versionn is greater
-            return difference === "same" || difference === "patch" || (difference === "minor" && frontendSemver.minor < backendSemver.minor);
-        }
+        if (difference === "major")
+            return false;
+        // special case for major version 0. If patch difference, backend patch must be greater than frontend patch
+        if (backendSemver.major === 0)
+            return (difference === "patch" && frontendSemver.patch < backendSemver.patch);
+        // patch difference is fine. If minor versions differ, compatible as long as backend minor version is greater
+        return difference === "patch" || (difference === "minor" && frontendSemver.minor < backendSemver.minor);
     }
-    /** @internal */
+    /** @beta */
     constructor(routing = RpcRoutingToken_1.RpcRoutingToken.default) {
         this.routing = routing;
         this.configuration = RpcConfiguration_1.RpcConfiguration.supply(this);

package/lib/cjs/RpcInterface.js.map

@@ -1 +1 @@
-{"version":3,"file":"RpcInterface.js","sourceRoot":"","sources":["../../src/RpcInterface.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,kEAAyF;AACzF,wDAAyD;AACzD,sDAAkE;AAClE,gEAA6D;AAC7D,iDAAqE;AAGrE,+CAA2E;AAC3E,0DAA4E;AAC5E,sDAAiD;AAyBjD;;;GAGG;AACH,MAAsB,YAAY;IAExB,MAAM,CAAC,QAAQ,CAAC,OAAmB,EAAE,QAAoB;QAC/D,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,KAAK,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC;IACnN,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,OAAe;QACrC,oEAAoE;QACpE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACpC,sDAAsD;QACtD,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YACtB,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;SACzF;aAAM;YACL,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;SAC/G;IACH,CAAC;IAED,8JAA8J;IACvJ,MAAM,CAAC,mBAAmB,CAAC,OAAe,EAAE,QAAgB;QACjE,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC7C,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;QAEhE,uEAAuE;QACvE,8GAA8G;QAC9G,IAAI,CAAC,aAAa,CAAC,UAAU,KAAK,SAAS,IAAI,cAAc,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,UAAU,KAAK,OAAO,EAAE;YACjH,OAAO,UAAU,KAAK,MAAM,CAAC;SAC9B;aAAM,IAAI,aAAa,CAAC,KAAK,KAAK,CAAC,IAAI,cAAc,CAAC,KAAK,KAAK,CAAC,EAAE;YAClE,yHAAyH;YACzH,OAAO,UAAU,KAAK,MAAM,IAAI,CAAC,UAAU,KAAK,OAAO,IAAI,cAAc,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;SACxG;aAAM;YACL,iGAAiG;YACjG,oFAAoF;YACpF,OAAO,UAAU,KAAK,MAAM,IAAI,UAAU,KAAK,OAAO,IAAI,CAAC,UAAU,KAAK,OAAO,IAAI,cAAc,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;SAClI;IACH,CAAC;IAUD,gBAAgB;IAChB,YAAmB,UAA2B,iCAAe,CAAC,OAAO;QACnE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,mCAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;IAED,8DAA8D;IACvD,KAAK,CAAC,OAAO,CAAU,UAAsB;QAClD,MAAM,gBAAgB,GAAG,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/G,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC1H,MAAM,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;QAE5C,MAAM,OAAO,GAAG,uBAAU,CAAC,MAAM,CAAC;QAClC,IAAI,OAAO,EAAE;YACX,OAAO,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC;SACjE;aAAM;YACL,MAAM,OAAO,GAAG,IAAK,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,WAAmB,CAAC,IAAI,EAAE,aAAa,EAAE,eAAe,CAAe,CAAC;YACzH,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,8DAA8D;YAC/E,IAAY,CAAC,6BAAe,CAAC,GAAG,OAAO,CAAC;YACzC,OAAO,OAAO,CAAC,QAAQ,CAAC;SACzB;IACH,CAAC;CAIF;AAvED,oCAuEC;AAED,YAAY,CAAC,SAAS,CAAC,qBAAqB,GAAG,SAAS,CAAC;AAEzD,MAAM,kBAAmB,SAAQ,uBAAU;IACtB,KAAK,CAAC,IAAI,KAAkC,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;IAChE,KAAK,CAAC,IAAI,KAAsB,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;IACpD,SAAS,CAAC,KAAa,EAAE,MAAc,IAAU,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;CACzF;AAED,KAAK,UAAU,SAAS,CAAC,OAAmB,EAAE,MAAoB,EAAE,SAAiB,EAAE,UAAiB;IACtG,MAAM,OAAO,GAAG,IAAI,kBAAkB,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;IAC7D,MAAc,CAAC,6BAAe,CAAC,GAAG,OAAO,CAAC;IAE3C,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACvE,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;IAEhC,MAAM,IAAI,GAA0B;QAClC,UAAU,EAAE;YACV,aAAa,EAAE,OAAO,CAAC,SAAS,CAAC,mBAAmB;YACpD,gBAAgB,EAAE,OAAO,CAAC,SAAS,CAAC,gBAAgB;SACrD;QACD,SAAS;QACT,UAAU;QACV,OAAO,EAAE;YACP,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;YAC9C,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,eAAe,EAAE,CAAC,OAAO,CAAC,eAAe,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;SAC3D;KACF,CAAC;IAEF,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;QAC1B,0BAAa,CAAC,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAE/C,0BAAa,CAAC,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAElD,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,QAAQ,IAAI,QAAQ,CAAC,cAAc,CAAC,sBAAsB,CAAC,IAAI,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE;YACjI,MAAM,MAAM,GAAqB,QAAQ,CAAC;YAE1C,IAAI,MAAM,CAAC,aAAa,KAAK,SAAS,EAAE;gBACtC,OAAO,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;aACjD;iBAAM,IAAI,MAAM,CAAC,aAAa,KAAK,UAAU,EAAE;gBAC9C,OAAO,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;aAClD;iBAAM,IAAI,MAAM,CAAC,aAAa,KAAK,WAAW,EAAE;gBAC/C,OAAO,eAAe,EAAE,CAAC;aAC1B;SACF;aAAM;YACL,OAAO,QAAQ,CAAC;SACjB;IACH,CAAC,CAAC;IAEF,OAAO,QAAQ,EAAE,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,OAA2B,EAAE,MAAwB,EAAE,QAA4B;IAC9G,OAAO,CAAC,OAAO,GAAG,+BAAgB,CAAC,OAAO,CAAC;IAC3C,OAAO,CAAC,eAAe,GAAI,MAAM,CAAC,aAAqC,CAAC,OAAO,CAAC;IAChF,uBAAU,CAAC,MAAM,CAAC,UAAU,CAAC,8BAAe,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAE7E,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAEnF,MAAM,yBAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7B,OAAO,QAAQ,EAAE,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,OAA2B,EAAE,MAAwB,EAAE,QAA4B;IAC/G,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,uBAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,aAAoC,EAAE,KAAK,IAAI,EAAE;YACtG,IAAI,WAAW,EAAE;gBACf,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,yCAAyC,CAAC,CAAC;aACvF;YAED,WAAW,GAAG,IAAI,CAAC;YAEnB,IAAI;gBACF,MAAM,QAAQ,GAAG,MAAM,QAAQ,EAAE,CAAC;gBAClC,OAAO,CAAC,QAAQ,CAAC,CAAC;aACnB;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,CAAC,GAAG,CAAC,CAAC;aACb;QACH,CAAC,EAAE,MAAM,CAAC,CAAC;IACb,CAAC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,eAAe;IAC5B,MAAM,IAAI,4BAAc,EAAE,CAAC;AAC7B,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 RpcInterface\r\n */\r\nimport { RpcConfiguration, RpcConfigurationSupplier } from \"./rpc/core/RpcConfiguration\";\r\nimport { CURRENT_REQUEST } from \"./rpc/core/RpcRegistry\";\r\nimport { aggregateLoad, RpcRequest } from \"./rpc/core/RpcRequest\";\r\nimport { RpcRoutingToken } from \"./rpc/core/RpcRoutingToken\";\r\nimport { InterceptedRpcRequest, IpcSession } from \"./ipc/IpcSession\";\r\nimport { RpcSerializedValue } from \"./rpc/core/RpcMarshaling\";\r\nimport { RpcManagedStatus } from \"./rpc/core/RpcProtocol\";\r\nimport { BentleyStatus, IModelError, NoContentError } from \"./IModelError\";\r\nimport { RpcRequestEvent, RpcRequestStatus } from \"./rpc/core/RpcConstants\";\r\nimport { BeDuration } from \"@itwin/core-bentley\";\r\nimport { RpcNotFoundResponse } from \"./rpc/core/RpcControl\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/**\r\n * Specifies the required static properties of an RpcInterface class.\r\n * These properties are used to identify RPC requests and responses.\r\n * @beta\r\n */\r\nexport interface RpcInterfaceDefinition<T extends RpcInterface = RpcInterface> { prototype: T, interfaceName: string, interfaceVersion: string }\r\n\r\n/**\r\n * A class that implements the operations of an RPC interface.\r\n * @beta\r\n */\r\nexport type RpcInterfaceImplementation<T extends RpcInterface = RpcInterface> = new () => T;\r\n\r\ninterface SemverType {\r\n  major: number;\r\n  minor: number;\r\n  patch: number;\r\n  prerelease?: string;\r\n}\r\n\r\n/** An RPC interface is a set of operations exposed by a service that a client can call, using configurable protocols,\r\n * in a platform-independent way. TheRpcInterface class is the base class for RPC interface definitions and implementations.\r\n * @public\r\n */\r\nexport abstract class RpcInterface {\r\n\r\n  private static findDiff(backend: SemverType, frontend: SemverType) {\r\n    return backend.major !== frontend.major ? \"major\" : backend.minor !== frontend.minor ? \"minor\" : backend.patch !== frontend.patch ? \"patch\" : backend.prerelease !== frontend.prerelease ? \"prerelease\" : \"same\";\r\n  }\r\n\r\n  private static parseVer(version: string): SemverType {\r\n    // Split the version string into major.minor.path and prerelease tag\r\n    const split = version.split(/[:-]/);\r\n    // Split the major.minor.path into seperate components\r\n    const prefix = split[0].split(\".\");\r\n    if (split.length === 1) {\r\n      return { major: Number(prefix[0]), minor: Number(prefix[1]), patch: Number(prefix[2]) };\r\n    } else {\r\n      return { major: Number(prefix[0]), minor: Number(prefix[1]), patch: Number(prefix[2]), prerelease: split[1] };\r\n    }\r\n  }\r\n\r\n  /** Determines whether the backend version of an RPC interface is compatible (according to semantic versioning) with the frontend version of the interface. */\r\n  public static isVersionCompatible(backend: string, frontend: string): boolean {\r\n    const backendSemver = this.parseVer(backend);\r\n    const frontendSemver = this.parseVer(frontend);\r\n    const difference = this.findDiff(backendSemver, frontendSemver);\r\n\r\n    // If the major versions are different, the versions are not compatible\r\n    // In the case of prerelease tags, they are compatible if the whole version string matches, otherwise it fails\r\n    if ((backendSemver.prerelease !== undefined || frontendSemver.prerelease !== undefined) || difference === \"major\") {\r\n      return difference === \"same\";\r\n    } else if (backendSemver.major === 0 || frontendSemver.major === 0) {\r\n      // If the major and minor versions match and major versions are 0, compatible as long as backend patch version is greater\r\n      return difference === \"same\" || (difference === \"patch\" && frontendSemver.patch < backendSemver.patch);\r\n    } else {\r\n      // If the strings match exactly, major and minor match but patch differs, versions are compatible\r\n      // If minor versions differ, compatible as long as backend patch versionn is greater\r\n      return difference === \"same\" || difference === \"patch\" || (difference === \"minor\" && frontendSemver.minor < backendSemver.minor);\r\n    }\r\n  }\r\n\r\n  /** The configuration for the RPC interface.\r\n   * @internal\r\n   */\r\n  public readonly configuration: RpcConfiguration;\r\n\r\n  /** @internal */\r\n  public readonly routing: RpcRoutingToken;\r\n\r\n  /** @internal */\r\n  public constructor(routing: RpcRoutingToken = RpcRoutingToken.default) {\r\n    this.routing = routing;\r\n    this.configuration = RpcConfiguration.supply(this);\r\n  }\r\n\r\n  /** Obtains the implementation result for an RPC operation. */\r\n  public async forward<T = any>(parameters: IArguments): Promise<T> {\r\n    const parametersCompat = (arguments.length === 1 && typeof (parameters) === \"object\") ? parameters : arguments;\r\n    const parametersArray = Array.isArray(parametersCompat) ? parametersCompat : Array.prototype.slice.call(parametersCompat);\r\n    const operationName = parametersArray.pop();\r\n\r\n    const session = IpcSession.active;\r\n    if (session) {\r\n      return intercept(session, this, operationName, parametersArray);\r\n    } else {\r\n      const request = new (this.configuration.protocol.requestType as any)(this, operationName, parametersArray) as RpcRequest;\r\n      request.submit(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n      (this as any)[CURRENT_REQUEST] = request;\r\n      return request.response;\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  public configurationSupplier: RpcConfigurationSupplier | undefined;\r\n}\r\n\r\nRpcInterface.prototype.configurationSupplier = undefined;\r\n\r\nclass InterceptedRequest extends RpcRequest {\r\n  protected override async load(): Promise<RpcSerializedValue> { throw new Error(); }\r\n  protected override async send(): Promise<number> { throw new Error(); }\r\n  protected override setHeader(_name: string, _value: string): void { throw new Error(); }\r\n}\r\n\r\nasync function intercept(session: IpcSession, client: RpcInterface, operation: string, parameters: any[]) {\r\n  const request = new InterceptedRequest(client, operation, []);\r\n  (client as any)[CURRENT_REQUEST] = request;\r\n\r\n  const context = await client.configuration.protocol.serialize(request);\r\n  request.parameters = parameters;\r\n\r\n  const info: InterceptedRpcRequest = {\r\n    definition: {\r\n      interfaceName: context.operation.interfaceDefinition,\r\n      interfaceVersion: context.operation.interfaceVersion,\r\n    },\r\n    operation,\r\n    parameters,\r\n    context: {\r\n      applicationId: context.applicationId,\r\n      applicationVersion: context.applicationVersion,\r\n      id: context.id,\r\n      sessionId: context.sessionId,\r\n      protocolVersion: (context.protocolVersion || 0).toString(),\r\n    },\r\n  };\r\n\r\n  const dispatch = async () => {\r\n    aggregateLoad.lastRequest = new Date().getTime();\r\n\r\n    const response = await session.handleRpc(info);\r\n\r\n    aggregateLoad.lastResponse = new Date().getTime();\r\n\r\n    if (typeof (response) === \"object\" && response.hasOwnProperty(\"iTwinRpcCoreResponse\") && response.hasOwnProperty(\"managedStatus\")) {\r\n      const status: RpcManagedStatus = response;\r\n\r\n      if (status.managedStatus === \"pending\") {\r\n        return handlePending(request, status, dispatch);\r\n      } else if (status.managedStatus === \"notFound\") {\r\n        return handleNotFound(request, status, dispatch);\r\n      } else if (status.managedStatus === \"noContent\") {\r\n        return handleNoContent();\r\n      }\r\n    } else {\r\n      return response;\r\n    }\r\n  };\r\n\r\n  return dispatch();\r\n}\r\n\r\nasync function handlePending(request: InterceptedRequest, status: RpcManagedStatus, dispatch: () => Promise<any>) {\r\n  request._status = RpcRequestStatus.Pending;\r\n  request._extendedStatus = (status.responseValue as { message: string }).message;\r\n  RpcRequest.events.raiseEvent(RpcRequestEvent.PendingUpdateReceived, request);\r\n\r\n  const delay = request.operation.policy.retryInterval(request.client.configuration);\r\n\r\n  await BeDuration.wait(delay);\r\n  return dispatch();\r\n}\r\n\r\nasync function handleNotFound(request: InterceptedRequest, status: RpcManagedStatus, dispatch: () => Promise<any>) {\r\n  return new Promise((resolve, reject) => {\r\n    let resubmitted = false;\r\n\r\n    RpcRequest.notFoundHandlers.raiseEvent(request, status.responseValue as RpcNotFoundResponse, async () => {\r\n      if (resubmitted) {\r\n        throw new IModelError(BentleyStatus.ERROR, `Already resubmitted using this handler.`);\r\n      }\r\n\r\n      resubmitted = true;\r\n\r\n      try {\r\n        const response = await dispatch();\r\n        resolve(response);\r\n      } catch (err) {\r\n        reject(err);\r\n      }\r\n    }, reject);\r\n  });\r\n}\r\n\r\nasync function handleNoContent() {\r\n  throw new NoContentError();\r\n}\r\n"]}
+{"version":3,"file":"RpcInterface.js","sourceRoot":"","sources":["../../src/RpcInterface.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,kEAAyF;AACzF,wDAAyD;AACzD,sDAAkE;AAClE,gEAA6D;AAC7D,iDAAqE;AAGrE,+CAA2E;AAC3E,0DAA4E;AAC5E,sDAAiD;AAyBjD;;;GAGG;AACH,MAAsB,YAAY;IAExB,MAAM,CAAC,QAAQ,CAAC,OAAmB,EAAE,QAAoB;QAC/D,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YACjD,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;gBAC1C,OAAO,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;oBAC1C,OAAO,CAAC,UAAU,KAAK,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;wBACzD,MAAM,CAAC;IACjB,CAAC;IAEO,MAAM,CAAC,QAAQ,CAAC,OAAe;QACrC,+CAA+C;QAC/C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACpC,sDAAsD;QACtD,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEnC,MAAM,GAAG,GAAe,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACzG,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;YAClB,GAAG,CAAC,UAAU,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAC5B,OAAO,GAAG,CAAC;IACb,CAAC;IAED,8JAA8J;IACvJ,MAAM,CAAC,mBAAmB,CAAC,OAAe,EAAE,QAAgB;QACjE,IAAI,OAAO,KAAK,QAAQ;YACtB,OAAO,IAAI,CAAC,CAAC,2CAA2C;QAE1D,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC7C,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAE/C,+FAA+F;QAC/F,IAAI,aAAa,CAAC,UAAU,IAAI,cAAc,CAAC,UAAU;YACvD,OAAO,KAAK,CAAC;QAEf,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;QAChE,uEAAuE;QACvE,IAAI,UAAU,KAAK,OAAO;YACxB,OAAO,KAAK,CAAC;QAEf,2GAA2G;QAC3G,IAAI,aAAa,CAAC,KAAK,KAAK,CAAC;YAC3B,OAAO,CAAC,UAAU,KAAK,OAAO,IAAI,cAAc,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QAEhF,6GAA6G;QAC7G,OAAO,UAAU,KAAK,OAAO,IAAI,CAAC,UAAU,KAAK,OAAO,IAAI,cAAc,CAAC,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IAC1G,CAAC;IAUD,YAAY;IACZ,YAAmB,UAA2B,iCAAe,CAAC,OAAO;QACnE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,aAAa,GAAG,mCAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;IAED,8DAA8D;IACvD,KAAK,CAAC,OAAO,CAAU,UAAsB;QAClD,MAAM,gBAAgB,GAAG,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/G,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC1H,MAAM,aAAa,GAAG,eAAe,CAAC,GAAG,EAAE,CAAC;QAE5C,MAAM,OAAO,GAAG,uBAAU,CAAC,MAAM,CAAC;QAClC,IAAI,OAAO,EAAE;YACX,OAAO,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC;SACjE;aAAM;YACL,MAAM,OAAO,GAAG,IAAK,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,WAAmB,CAAC,IAAI,EAAE,aAAa,EAAE,eAAe,CAAe,CAAC;YACzH,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,8DAA8D;YAC/E,IAAY,CAAC,6BAAe,CAAC,GAAG,OAAO,CAAC;YACzC,OAAO,OAAO,CAAC,QAAQ,CAAC;SACzB;IACH,CAAC;CAIF;AAhFD,oCAgFC;AAED,YAAY,CAAC,SAAS,CAAC,qBAAqB,GAAG,SAAS,CAAC;AAEzD,MAAM,kBAAmB,SAAQ,uBAAU;IACtB,KAAK,CAAC,IAAI,KAAkC,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;IAChE,KAAK,CAAC,IAAI,KAAsB,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;IACpD,SAAS,CAAC,KAAa,EAAE,MAAc,IAAU,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;CACzF;AAED,KAAK,UAAU,SAAS,CAAC,OAAmB,EAAE,MAAoB,EAAE,SAAiB,EAAE,UAAiB;IACtG,MAAM,OAAO,GAAG,IAAI,kBAAkB,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;IAC7D,MAAc,CAAC,6BAAe,CAAC,GAAG,OAAO,CAAC;IAE3C,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACvE,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC;IAEhC,MAAM,IAAI,GAA0B;QAClC,UAAU,EAAE;YACV,aAAa,EAAE,OAAO,CAAC,SAAS,CAAC,mBAAmB;YACpD,gBAAgB,EAAE,OAAO,CAAC,SAAS,CAAC,gBAAgB;SACrD;QACD,SAAS;QACT,UAAU;QACV,OAAO,EAAE;YACP,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;YAC9C,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,eAAe,EAAE,CAAC,OAAO,CAAC,eAAe,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;SAC3D;KACF,CAAC;IAEF,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;QAC1B,0BAAa,CAAC,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAE/C,0BAAa,CAAC,YAAY,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAElD,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,QAAQ,IAAI,QAAQ,CAAC,cAAc,CAAC,sBAAsB,CAAC,IAAI,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE;YACjI,MAAM,MAAM,GAAqB,QAAQ,CAAC;YAE1C,IAAI,MAAM,CAAC,aAAa,KAAK,SAAS,EAAE;gBACtC,OAAO,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;aACjD;iBAAM,IAAI,MAAM,CAAC,aAAa,KAAK,UAAU,EAAE;gBAC9C,OAAO,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;aAClD;iBAAM,IAAI,MAAM,CAAC,aAAa,KAAK,WAAW,EAAE;gBAC/C,OAAO,eAAe,EAAE,CAAC;aAC1B;SACF;aAAM;YACL,OAAO,QAAQ,CAAC;SACjB;IACH,CAAC,CAAC;IAEF,OAAO,QAAQ,EAAE,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,OAA2B,EAAE,MAAwB,EAAE,QAA4B;IAC9G,OAAO,CAAC,OAAO,GAAG,+BAAgB,CAAC,OAAO,CAAC;IAC3C,OAAO,CAAC,eAAe,GAAI,MAAM,CAAC,aAAqC,CAAC,OAAO,CAAC;IAChF,uBAAU,CAAC,MAAM,CAAC,UAAU,CAAC,8BAAe,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;IAE7E,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAEnF,MAAM,yBAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7B,OAAO,QAAQ,EAAE,CAAC;AACpB,CAAC;AAED,KAAK,UAAU,cAAc,CAAC,OAA2B,EAAE,MAAwB,EAAE,QAA4B;IAC/G,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,uBAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,aAAoC,EAAE,KAAK,IAAI,EAAE;YACtG,IAAI,WAAW,EAAE;gBACf,MAAM,IAAI,yBAAW,CAAC,2BAAa,CAAC,KAAK,EAAE,yCAAyC,CAAC,CAAC;aACvF;YAED,WAAW,GAAG,IAAI,CAAC;YAEnB,IAAI;gBACF,MAAM,QAAQ,GAAG,MAAM,QAAQ,EAAE,CAAC;gBAClC,OAAO,CAAC,QAAQ,CAAC,CAAC;aACnB;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,CAAC,GAAG,CAAC,CAAC;aACb;QACH,CAAC,EAAE,MAAM,CAAC,CAAC;IACb,CAAC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,eAAe;IAC5B,MAAM,IAAI,4BAAc,EAAE,CAAC;AAC7B,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 RpcInterface\r\n */\r\nimport { RpcConfiguration, RpcConfigurationSupplier } from \"./rpc/core/RpcConfiguration\";\r\nimport { CURRENT_REQUEST } from \"./rpc/core/RpcRegistry\";\r\nimport { aggregateLoad, RpcRequest } from \"./rpc/core/RpcRequest\";\r\nimport { RpcRoutingToken } from \"./rpc/core/RpcRoutingToken\";\r\nimport { InterceptedRpcRequest, IpcSession } from \"./ipc/IpcSession\";\r\nimport { RpcSerializedValue } from \"./rpc/core/RpcMarshaling\";\r\nimport { RpcManagedStatus } from \"./rpc/core/RpcProtocol\";\r\nimport { BentleyStatus, IModelError, NoContentError } from \"./IModelError\";\r\nimport { RpcRequestEvent, RpcRequestStatus } from \"./rpc/core/RpcConstants\";\r\nimport { BeDuration } from \"@itwin/core-bentley\";\r\nimport { RpcNotFoundResponse } from \"./rpc/core/RpcControl\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/**\r\n * Specifies the required static properties of an RpcInterface class.\r\n * These properties are used to identify RPC requests and responses.\r\n * @beta\r\n */\r\nexport interface RpcInterfaceDefinition<T extends RpcInterface = RpcInterface> { prototype: T, interfaceName: string, interfaceVersion: string }\r\n\r\n/**\r\n * A class that implements the operations of an RPC interface.\r\n * @beta\r\n */\r\nexport type RpcInterfaceImplementation<T extends RpcInterface = RpcInterface> = new () => T;\r\n\r\ninterface SemverType {\r\n  major: number;\r\n  minor: number;\r\n  patch: number;\r\n  prerelease?: string;\r\n}\r\n\r\n/** An RPC interface is a set of operations exposed by a service that a client can call, using configurable protocols,\r\n * in a platform-independent way. TheRpcInterface class is the base class for RPC interface definitions and implementations.\r\n * @public\r\n */\r\nexport abstract class RpcInterface {\r\n\r\n  private static findDiff(backend: SemverType, frontend: SemverType) {\r\n    return backend.major !== frontend.major ? \"major\" :\r\n      backend.minor !== frontend.minor ? \"minor\" :\r\n        backend.patch !== frontend.patch ? \"patch\" :\r\n          backend.prerelease !== frontend.prerelease ? \"prerelease\" :\r\n            \"same\";\r\n  }\r\n\r\n  private static parseVer(version: string): SemverType {\r\n    // separate the version from the prerelease tag\r\n    const parts = version.split(/[:-]/);\r\n    // Split the major.minor.path into separate components\r\n    const prefix = parts[0].split(\".\");\r\n\r\n    const ver: SemverType = { major: Number(prefix[0]), minor: Number(prefix[1]), patch: Number(prefix[2]) };\r\n    if (parts.length > 1)\r\n      ver.prerelease = parts[1];\r\n    return ver;\r\n  }\r\n\r\n  /** Determines whether the backend version of an RPC interface is compatible (according to semantic versioning) with the frontend version of the interface. */\r\n  public static isVersionCompatible(backend: string, frontend: string): boolean {\r\n    if (backend === frontend)\r\n      return true; // most common case, versions are identical\r\n\r\n    const backendSemver = this.parseVer(backend);\r\n    const frontendSemver = this.parseVer(frontend);\r\n\r\n    // if either has a prerelease tag, they are not compatible unless version strings are identical\r\n    if (backendSemver.prerelease || frontendSemver.prerelease)\r\n      return false;\r\n\r\n    const difference = this.findDiff(backendSemver, frontendSemver);\r\n    // If the major versions are different, the versions are not compatible\r\n    if (difference === \"major\")\r\n      return false;\r\n\r\n    // special case for major version 0. If patch difference, backend patch must be greater than frontend patch\r\n    if (backendSemver.major === 0)\r\n      return (difference === \"patch\" && frontendSemver.patch < backendSemver.patch);\r\n\r\n    // patch difference is fine. If minor versions differ, compatible as long as backend minor version is greater\r\n    return difference === \"patch\" || (difference === \"minor\" && frontendSemver.minor < backendSemver.minor);\r\n  }\r\n\r\n  /** The configuration for the RPC interface.\r\n   * @internal\r\n   */\r\n  public readonly configuration: RpcConfiguration;\r\n\r\n  /** @internal */\r\n  public readonly routing: RpcRoutingToken;\r\n\r\n  /** @beta */\r\n  public constructor(routing: RpcRoutingToken = RpcRoutingToken.default) {\r\n    this.routing = routing;\r\n    this.configuration = RpcConfiguration.supply(this);\r\n  }\r\n\r\n  /** Obtains the implementation result for an RPC operation. */\r\n  public async forward<T = any>(parameters: IArguments): Promise<T> {\r\n    const parametersCompat = (arguments.length === 1 && typeof (parameters) === \"object\") ? parameters : arguments;\r\n    const parametersArray = Array.isArray(parametersCompat) ? parametersCompat : Array.prototype.slice.call(parametersCompat);\r\n    const operationName = parametersArray.pop();\r\n\r\n    const session = IpcSession.active;\r\n    if (session) {\r\n      return intercept(session, this, operationName, parametersArray);\r\n    } else {\r\n      const request = new (this.configuration.protocol.requestType as any)(this, operationName, parametersArray) as RpcRequest;\r\n      request.submit(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n      (this as any)[CURRENT_REQUEST] = request;\r\n      return request.response;\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  public configurationSupplier: RpcConfigurationSupplier | undefined;\r\n}\r\n\r\nRpcInterface.prototype.configurationSupplier = undefined;\r\n\r\nclass InterceptedRequest extends RpcRequest {\r\n  protected override async load(): Promise<RpcSerializedValue> { throw new Error(); }\r\n  protected override async send(): Promise<number> { throw new Error(); }\r\n  protected override setHeader(_name: string, _value: string): void { throw new Error(); }\r\n}\r\n\r\nasync function intercept(session: IpcSession, client: RpcInterface, operation: string, parameters: any[]) {\r\n  const request = new InterceptedRequest(client, operation, []);\r\n  (client as any)[CURRENT_REQUEST] = request;\r\n\r\n  const context = await client.configuration.protocol.serialize(request);\r\n  request.parameters = parameters;\r\n\r\n  const info: InterceptedRpcRequest = {\r\n    definition: {\r\n      interfaceName: context.operation.interfaceDefinition,\r\n      interfaceVersion: context.operation.interfaceVersion,\r\n    },\r\n    operation,\r\n    parameters,\r\n    context: {\r\n      applicationId: context.applicationId,\r\n      applicationVersion: context.applicationVersion,\r\n      id: context.id,\r\n      sessionId: context.sessionId,\r\n      protocolVersion: (context.protocolVersion || 0).toString(),\r\n    },\r\n  };\r\n\r\n  const dispatch = async () => {\r\n    aggregateLoad.lastRequest = new Date().getTime();\r\n\r\n    const response = await session.handleRpc(info);\r\n\r\n    aggregateLoad.lastResponse = new Date().getTime();\r\n\r\n    if (typeof (response) === \"object\" && response.hasOwnProperty(\"iTwinRpcCoreResponse\") && response.hasOwnProperty(\"managedStatus\")) {\r\n      const status: RpcManagedStatus = response;\r\n\r\n      if (status.managedStatus === \"pending\") {\r\n        return handlePending(request, status, dispatch);\r\n      } else if (status.managedStatus === \"notFound\") {\r\n        return handleNotFound(request, status, dispatch);\r\n      } else if (status.managedStatus === \"noContent\") {\r\n        return handleNoContent();\r\n      }\r\n    } else {\r\n      return response;\r\n    }\r\n  };\r\n\r\n  return dispatch();\r\n}\r\n\r\nasync function handlePending(request: InterceptedRequest, status: RpcManagedStatus, dispatch: () => Promise<any>) {\r\n  request._status = RpcRequestStatus.Pending;\r\n  request._extendedStatus = (status.responseValue as { message: string }).message;\r\n  RpcRequest.events.raiseEvent(RpcRequestEvent.PendingUpdateReceived, request);\r\n\r\n  const delay = request.operation.policy.retryInterval(request.client.configuration);\r\n\r\n  await BeDuration.wait(delay);\r\n  return dispatch();\r\n}\r\n\r\nasync function handleNotFound(request: InterceptedRequest, status: RpcManagedStatus, dispatch: () => Promise<any>) {\r\n  return new Promise((resolve, reject) => {\r\n    let resubmitted = false;\r\n\r\n    RpcRequest.notFoundHandlers.raiseEvent(request, status.responseValue as RpcNotFoundResponse, async () => {\r\n      if (resubmitted) {\r\n        throw new IModelError(BentleyStatus.ERROR, `Already resubmitted using this handler.`);\r\n      }\r\n\r\n      resubmitted = true;\r\n\r\n      try {\r\n        const response = await dispatch();\r\n        resolve(response);\r\n      } catch (err) {\r\n        reject(err);\r\n      }\r\n    }, reject);\r\n  });\r\n}\r\n\r\nasync function handleNoContent() {\r\n  throw new NoContentError();\r\n}\r\n"]}

package/lib/cjs/SkyBox.d.ts

@@ -193,7 +193,7 @@ export declare class SkySphere extends SkyBox {
      * @param gradient Optionally overrides the default gradient settings used if the image cannot be obtained.
      */
     constructor(image: TextureImageSpec, gradient?: SkyGradient);
-    /** @internal override */
+    /** See [[SkyBox.toJSON]]. */
     toJSON(display?: boolean): SkyBoxProps;
     /** @internal */
     get textureIds(): Iterable<Id64String>;
@@ -207,10 +207,10 @@ export declare class SkyCube extends SkyBox {
     readonly images: SkyCubeProps;
     /** Create a new sky cube using the specified images.
      * @param images The images to map to each face of the cube.
-     * @param Optionally overrides  the default gradient settings used if the images cannot be obtained.
+     * @param gradient Optionally overrides  the default gradient settings used if the images cannot be obtained.
      */
     constructor(images: SkyCubeProps, gradient?: SkyGradient);
-    /** @internal override */
+    /** See [[SkyBox.toJSON]]. */
     toJSON(display?: boolean): SkyBoxProps;
     /** @internal */
     get textureIds(): Iterable<Id64String>;

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

@@ -1 +1 @@
-{"version":3,"file":"SkyBox.d.ts","sourceRoot":"","sources":["../../src/SkyBox.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnD;;;;GAIG;AACH,oBAAY,eAAe;IACzB,kEAAkE;IAClE,IAAI,IAAI;IACR;;OAEG;IACH,SAAS,IAAI;IACb,kCAAkC;IAClC,WAAW,IAAI;IACf;;OAEG;IACH,IAAI,IAAI;CACT;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,gBAAgB,CAAC;IACxB,IAAI,EAAE,gBAAgB,CAAC;IACvB,GAAG,EAAE,gBAAgB,CAAC;IACtB,MAAM,EAAE,gBAAgB,CAAC;IACzB,KAAK,EAAE,gBAAgB,CAAC;IACxB,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC;IAChC,OAAO,EAAE,gBAAgB,CAAC;IAC1B,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC;IAC3B,QAAQ,EAAE,YAAY,CAAC;IACvB,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,GAAG,iBAAiB,GAAG;IAAE,IAAI,CAAC,EAAE,eAAe,CAAC;IAAC,OAAO,CAAC,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAEvI;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;CAC1B;AAYD;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,CAAC,WAAW,CAAC,CAAC;AAEzE;;;GAGG;AACH,qBAAa,WAAW;IACtB,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,SAAgB,WAAW,EAAE,QAAQ,CAAC;IACtC,SAAgB,WAAW,EAAE,QAAQ,CAAC;IACtC,SAAgB,UAAU,EAAE,QAAQ,CAAC;IACrC,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,SAAgB,cAAc,EAAE,MAAM,CAAC;IAEvC,OAAO;IAUP,kDAAkD;IAClD,gBAAuB,QAAQ,cAAuB;IAEtD,8GAA8G;WAChG,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,WAAW;IAIzE,uCAAuC;WACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,WAAW;IAexD;;OAEG;IACI,KAAK,CAAC,YAAY,EAAE,qBAAqB,GAAG,WAAW;IAI9D,sCAAsC;IAC/B,MAAM,IAAI,WAAW;IAoB5B,4EAA4E;IACrE,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;CAO3C;AAED;;;GAGG;AACH,qBAAa,MAAM;IACjB,+GAA+G;IAC/G,SAAgB,QAAQ,EAAE,WAAW,CAAC;IAEtC,SAAS,aAAa,QAAQ,EAAE,WAAW;IAI3C,kDAAkD;IAClD,gBAAuB,QAAQ,SAAoC;IAEnE,yGAAyG;WAC3F,cAAc,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,MAAM;IAI5D,uCAAuC;WACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,MAAM;IAuBnD;;OAEG;IACI,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW;IAQ7C,gBAAgB;IAChB,IAAW,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,CAE5C;CACF;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,MAAM;IACnC,sDAAsD;IACtD,SAAgB,KAAK,EAAE,gBAAgB,CAAC;IAExC;;;OAGG;gBACgB,KAAK,EAAE,gBAAgB,EAAE,QAAQ,CAAC,EAAE,WAAW;IAKlE,yBAAyB;IACT,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW;IAUtD,gBAAgB;IAChB,IAAoB,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,CAErD;CACF;AAED;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,MAAM;IACjC,kDAAkD;IAClD,SAAgB,MAAM,EAAE,YAAY,CAAC;IAErC;;;OAGG;gBACgB,MAAM,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,WAAW;IAK/D,yBAAyB;IACT,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW;IAUtD,gBAAgB;IAChB,IAAoB,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,CAGrD;CACF"}
+{"version":3,"file":"SkyBox.d.ts","sourceRoot":"","sources":["../../src/SkyBox.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,UAAU,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnD;;;;GAIG;AACH,oBAAY,eAAe;IACzB,kEAAkE;IAClE,IAAI,IAAI;IACR;;OAEG;IACH,SAAS,IAAI;IACb,kCAAkC;IAClC,WAAW,IAAI;IACf;;OAEG;IACH,IAAI,IAAI;CACT;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,gBAAgB,CAAC;IACxB,IAAI,EAAE,gBAAgB,CAAC;IACvB,GAAG,EAAE,gBAAgB,CAAC;IACtB,MAAM,EAAE,gBAAgB,CAAC;IACzB,KAAK,EAAE,gBAAgB,CAAC;IACxB,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,eAAe,CAAC,SAAS,CAAC;IAChC,OAAO,EAAE,gBAAgB,CAAC;IAC1B,gBAAgB;IAChB,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC;IAC3B,QAAQ,EAAE,YAAY,CAAC;IACvB,gBAAgB;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,mBAAmB,GAAG,iBAAiB,GAAG;IAAE,IAAI,CAAC,EAAE,eAAe,CAAC;IAAC,OAAO,CAAC,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAEvI;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;CAC1B;AAYD;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,CAAC,WAAW,CAAC,CAAC;AAEzE;;;GAGG;AACH,qBAAa,WAAW;IACtB,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,SAAgB,WAAW,EAAE,QAAQ,CAAC;IACtC,SAAgB,WAAW,EAAE,QAAQ,CAAC;IACtC,SAAgB,UAAU,EAAE,QAAQ,CAAC;IACrC,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,SAAgB,cAAc,EAAE,MAAM,CAAC;IAEvC,OAAO;IAUP,kDAAkD;IAClD,gBAAuB,QAAQ,cAAuB;IAEtD,8GAA8G;WAChG,MAAM,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,WAAW;IAIzE,uCAAuC;WACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,WAAW;IAexD;;OAEG;IACI,KAAK,CAAC,YAAY,EAAE,qBAAqB,GAAG,WAAW;IAI9D,sCAAsC;IAC/B,MAAM,IAAI,WAAW;IAoB5B,4EAA4E;IACrE,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;CAO3C;AAED;;;GAGG;AACH,qBAAa,MAAM;IACjB,+GAA+G;IAC/G,SAAgB,QAAQ,EAAE,WAAW,CAAC;IAEtC,SAAS,aAAa,QAAQ,EAAE,WAAW;IAI3C,kDAAkD;IAClD,gBAAuB,QAAQ,SAAoC;IAEnE,yGAAyG;WAC3F,cAAc,CAAC,QAAQ,CAAC,EAAE,WAAW,GAAG,MAAM;IAI5D,uCAAuC;WACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,GAAG,MAAM;IAuBnD;;OAEG;IACI,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW;IAQ7C,gBAAgB;IAChB,IAAW,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,CAE5C;CACF;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,MAAM;IACnC,sDAAsD;IACtD,SAAgB,KAAK,EAAE,gBAAgB,CAAC;IAExC;;;OAGG;gBACgB,KAAK,EAAE,gBAAgB,EAAE,QAAQ,CAAC,EAAE,WAAW;IAKlE,6BAA6B;IACb,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW;IAUtD,gBAAgB;IAChB,IAAoB,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,CAErD;CACF;AAED;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,MAAM;IACjC,kDAAkD;IAClD,SAAgB,MAAM,EAAE,YAAY,CAAC;IAErC;;;OAGG;gBACgB,MAAM,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,WAAW;IAK/D,6BAA6B;IACb,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,WAAW;IAUtD,gBAAgB;IAChB,IAAoB,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,CAGrD;CACF"}

package/lib/cjs/SkyBox.js

@@ -163,7 +163,7 @@ class SkySphere extends SkyBox {
         super(gradient ?? SkyGradient.defaults);
         this.image = image;
     }
-    /** @internal override */
+    /** See [[SkyBox.toJSON]]. */
     toJSON(display) {
         const props = super.toJSON(display);
         props.image = {
@@ -185,13 +185,13 @@ exports.SkySphere = SkySphere;
 class SkyCube extends SkyBox {
     /** Create a new sky cube using the specified images.
      * @param images The images to map to each face of the cube.
-     * @param Optionally overrides  the default gradient settings used if the images cannot be obtained.
+     * @param gradient Optionally overrides  the default gradient settings used if the images cannot be obtained.
      */
     constructor(images, gradient) {
         super(gradient ?? SkyGradient.defaults);
         this.images = { ...images };
     }
-    /** @internal override */
+    /** See [[SkyBox.toJSON]]. */
     toJSON(display) {
         const props = super.toJSON(display);
         props.image = {

package/lib/cjs/SkyBox.js.map

@@ -1 +1 @@
-{"version":3,"file":"SkyBox.js","sourceRoot":"","sources":["../../src/SkyBox.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAgF;AAChF,yCAAqD;AAGrD;;;;GAIG;AACH,IAAY,eAaX;AAbD,WAAY,eAAe;IACzB,kEAAkE;IAClE,qDAAQ,CAAA;IACR;;OAEG;IACH,+DAAa,CAAA;IACb,kCAAkC;IAClC,mEAAe,CAAA;IACf;;OAEG;IACH,qDAAQ,CAAA;AACV,CAAC,EAbW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAa1B;AA4GD,MAAM,kBAAkB,GAAG,mBAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACxD,MAAM,kBAAkB,GAAG,mBAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACvD,MAAM,iBAAiB,GAAG,mBAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AACpD,MAAM,eAAe,GAAG,mBAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACrD,MAAM,eAAe,GAAG,GAAG,CAAC;AAE5B,SAAS,gBAAgB,CAAC,KAAqB;IAC7C,OAAO,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACpE,CAAC;AAQD;;;GAGG;AACH,MAAa,WAAW;IAStB,YAAoB,IAAoC;QACtD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,eAAe,CAAC;QACjD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,kBAAkB,CAAC;QAC1D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,iBAAiB,CAAC;QACvD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,kBAAkB,CAAC;QAC1D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,eAAe,CAAC;QACvD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,IAAI,eAAe,CAAC;IAC/D,CAAC;IAKD,8GAA8G;IACvG,MAAM,CAAC,MAAM,CAAC,KAAsC;QACzD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjD,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAmB;QACxC,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,IAAI,CAAC;YACd,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,cAAc,EAAE,KAAK,CAAC,cAAc;YACpC,QAAQ,EAAE,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC1C,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,WAAW,CAAC;YAChD,UAAU,EAAE,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC;YAC9C,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,WAAW,CAAC;SACjD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAmC;QAC9C,OAAO,IAAI,WAAW,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAAgB;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YAChC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;YACtC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;YACpC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;SACvC,CAAC;QAEF,IAAI,IAAI,CAAC,cAAc,KAAK,eAAe;YACzC,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAE7C,IAAI,IAAI,CAAC,WAAW,KAAK,eAAe;YACtC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAEvC,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4EAA4E;IACrE,MAAM,CAAC,KAAkB;QAC9B,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;YAC3H,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC3F,CAAC;;AA3DD,kDAAkD;AAC3B,oBAAQ,GAAG,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC;AApB3C,kCAAW;AAiFxB;;;GAGG;AACH,MAAa,MAAM;IAIjB,YAAsB,QAAqB;QACzC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAKD,yGAAyG;IAClG,MAAM,CAAC,cAAc,CAAC,QAAsB;QACjD,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACvD,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAmB;QACxC,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE7C,IAAI,KAAK,EAAE,KAAK,EAAE;YAChB,QAAQ,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE;gBACxB,KAAK,eAAe,CAAC,SAAS;oBAC5B,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK,CAAC,OAAO;wBACnC,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;oBAEtD,MAAM;gBACR,KAAK,eAAe,CAAC,IAAI,CAAC,CAAC;oBACzB,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;oBAChC,IAAI,EAAE,IAAI,SAAS,KAAK,EAAE,CAAC,GAAG,IAAI,SAAS,KAAK,EAAE,CAAC,MAAM,IAAI,SAAS,KAAK,EAAE,CAAC,KAAK,IAAI,SAAS,KAAK,EAAE,CAAC,IAAI,IAAI,SAAS,KAAK,EAAE,CAAC,KAAK,IAAI,SAAS,KAAK,EAAE,CAAC,IAAI;wBAC7J,OAAO,IAAI,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;oBAEnC,MAAM;iBACP;aACF;SACF;QAED,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,OAAiB;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACrC,IAAI,SAAS,KAAK,OAAO;YACvB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAE1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAW,UAAU;QACnB,OAAO,EAAE,CAAC;IACZ,CAAC;;AA9CD,kDAAkD;AAC3B,eAAQ,GAAG,IAAI,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;AATxD,wBAAM;AAyDnB;;GAEG;AACH,MAAa,SAAU,SAAQ,MAAM;IAInC;;;OAGG;IACH,YAAmB,KAAuB,EAAE,QAAsB;QAChE,KAAK,CAAC,QAAQ,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,yBAAyB;IACT,MAAM,CAAC,OAAiB;QACtC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACpC,KAAK,CAAC,KAAK,GAAG;YACZ,IAAI,EAAE,eAAe,CAAC,SAAS;YAC/B,OAAO,EAAE,IAAI,CAAC,KAAK;SACpB,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAoB,UAAU;QAC5B,OAAO,mBAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1D,CAAC;CACF;AA5BD,8BA4BC;AAED;;;GAGG;AACH,MAAa,OAAQ,SAAQ,MAAM;IAIjC;;;OAGG;IACH,YAAmB,MAAoB,EAAE,QAAsB;QAC7D,KAAK,CAAC,QAAQ,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;IAC9B,CAAC;IAED,yBAAyB;IACT,MAAM,CAAC,OAAiB;QACtC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACpC,KAAK,CAAC,KAAK,GAAG;YACZ,IAAI,EAAE,eAAe,CAAC,IAAI;YAC1B,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE;SAC7B,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAoB,UAAU;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAClH,CAAC;CACF;AA7BD,0BA6BC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { Id64, Id64String, NonFunctionPropertiesOf } from \"@itwin/core-bentley\";\r\nimport { ColorDef, ColorDefProps } from \"./ColorDef\";\r\nimport { TextureImageSpec } from \"./RenderTexture\";\r\n\r\n/** Supported types of [[SkyBox]] images.\r\n * @see [[SkyBoxImageProps]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum SkyBoxImageType {\r\n  /** No image, indicating a [[SkyGradient]] should be displayed. */\r\n  None = 0,\r\n  /** A single image mapped to the surface of a sphere.\r\n   * @see [[SkySphere]].\r\n   */\r\n  Spherical = 1,\r\n  /** @internal not yet supported */\r\n  Cylindrical = 2,\r\n  /** Six images mapped to the faces of a cube.\r\n   * @see [[SkyCube]].\r\n   */\r\n  Cube = 3,\r\n}\r\n\r\n/** JSON representation of the six images used by a [[SkyCube]].\r\n * Each property specifies the image for a face of the cube as either an image URL, or the Id of a [Texture]($backend) element.\r\n * Each image must be square and have the same dimensions as all the other images.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SkyCubeProps {\r\n  front: TextureImageSpec;\r\n  back: TextureImageSpec;\r\n  top: TextureImageSpec;\r\n  bottom: TextureImageSpec;\r\n  right: TextureImageSpec;\r\n  left: TextureImageSpec;\r\n}\r\n\r\n/** JSON representation of the image used for a [[SkySphere]].\r\n * @see [[SkyBoxProps.image]].\r\n * @public\r\n */\r\nexport interface SkySphereImageProps {\r\n  type: SkyBoxImageType.Spherical;\r\n  texture: TextureImageSpec;\r\n  /** @internal */\r\n  textures?: never;\r\n}\r\n\r\n/** JSON representation of the images used for a [[SkyCube]].\r\n * @see [[SkyBoxProps.image]].\r\n * @public\r\n */\r\nexport interface SkyCubeImageProps {\r\n  type: SkyBoxImageType.Cube;\r\n  textures: SkyCubeProps;\r\n  /** @internal */\r\n  texture?: never;\r\n}\r\n\r\n/** JSON representation of the image(s) to be mapped to the surfaces of a [[SkyBox]].\r\n * @see [[SkyBoxProps.image]].\r\n * @public\r\n * @extensions\r\n */\r\nexport type SkyBoxImageProps = SkySphereImageProps | SkyCubeImageProps | { type?: SkyBoxImageType, texture?: never, textures?: never };\r\n\r\n/** JSON representation of a [[SkyBox]] that can be drawn as the background of a [ViewState3d]($frontend).\r\n * An object of this type can describe one of several types of sky box:\r\n *  - A cube with a texture image mapped to each face; or\r\n *  - A sphere with a single texture image mapped to its surface; or\r\n *  - A sphere with a two- or four-color vertical [[Gradient]] mapped to its surface.\r\n *\r\n * Whether cuboid or spherical, the skybox is drawn as if the viewer and the contents of the view are contained within its interior.\r\n *\r\n * For a two-color gradient, the gradient transitions smoothly from the nadir color at the bottom of the sphere to the zenith color at the top of the sphere.\r\n * The sky and ground colors are unused, as are the sky and ground exponents.\r\n *\r\n * For a four-color gradient, a \"horizon\" is produced on the equator of the sphere, where the ground color and sky color meet. The lower half of the sphere transitions\r\n * smoothly from the ground color at the equator to the nadir color at the bottom, and the upper half transitions from the sky color at the equator to the zenith color at\r\n * the top of the sphere.\r\n *\r\n * The color and exponent properties are unused if one or more texture images are supplied.\r\n *\r\n * The skybox is ignored entirely when an atmosphere is displayed.\r\n *\r\n * @see [[DisplayStyle3dSettings.environment]] to define the skybox for a display style.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SkyBoxProps {\r\n  /** Whether or not the skybox should be displayed.\r\n   * Default: false.\r\n   */\r\n  display?: boolean;\r\n  /** For a [[SkyGradient]], if true, a 2-color gradient skybox is used instead of a 4-color.\r\n   * Default: false.\r\n   */\r\n  twoColor?: boolean;\r\n  /** The color of the sky at the horizon. Unused unless this is a four-color [[SkyGradient]].\r\n   * Default: (143, 205, 255).\r\n   */\r\n  skyColor?: ColorDefProps;\r\n  /** The color of the ground at the horizon. Unused unless this is a four-color [[SkyGradient]].\r\n   * Default: (120, 143, 125).\r\n   */\r\n  groundColor?: ColorDefProps;\r\n  /** The color of the top of the sphere.\r\n   * Default: (54, 117, 255).\r\n   */\r\n  zenithColor?: ColorDefProps;\r\n  /** The color of the bottom of the sphere.\r\n   * Default: (40, 15, 0).\r\n   */\r\n  nadirColor?: ColorDefProps;\r\n  /** For a 4-color [[SkyGradient]], controls speed of change from sky color to zenith color; otherwise unused.\r\n   * Default: 4.0.\r\n   */\r\n  skyExponent?: number;\r\n  /** For a 4-color [[SkyGradient]], controls speed of change from ground color to nadir color; otherwise unused.\r\n   * Default: 4.0.\r\n   */\r\n  groundExponent?: number;\r\n  /** The image(s), if any, to be mapped to the surfaces of the sphere or cube. If undefined, the skybox will be displayed as a gradient instead.\r\n   * Default: undefined.\r\n   */\r\n  image?: SkyBoxImageProps;\r\n}\r\n\r\nconst defaultGroundColor = ColorDef.from(143, 205, 125);\r\nconst defaultZenithColor = ColorDef.from(54, 117, 255);\r\nconst defaultNadirColor = ColorDef.from(40, 125, 0);\r\nconst defaultSkyColor = ColorDef.from(142, 205, 255);\r\nconst defaultExponent = 4.0;\r\n\r\nfunction colorDefFromJson(props?: ColorDefProps): ColorDef | undefined {\r\n  return undefined !== props ? ColorDef.fromJSON(props) : undefined;\r\n}\r\n\r\n/** A type containing all of the properties and none of the methods of [[SkyGradient]] with `readonly` modifiers removed.\r\n * @see [[SkyGradient.create]] and [[SkyGradient.clone]].\r\n * @public\r\n */\r\nexport type SkyGradientProperties = NonFunctionPropertiesOf<SkyGradient>;\r\n\r\n/** Describes how to map a two- or four-color [[Gradient]] to the interior of a sphere to produce a [[SkyBox]].\r\n * @see [[SkyBox.gradient]].\r\n * @public\r\n */\r\nexport class SkyGradient {\r\n  public readonly twoColor: boolean;\r\n  public readonly skyColor: ColorDef;\r\n  public readonly groundColor: ColorDef;\r\n  public readonly zenithColor: ColorDef;\r\n  public readonly nadirColor: ColorDef;\r\n  public readonly skyExponent: number;\r\n  public readonly groundExponent: number;\r\n\r\n  private constructor(args: Partial<SkyGradientProperties>) {\r\n    this.twoColor = args.twoColor ?? false;\r\n    this.skyColor = args.skyColor ?? defaultSkyColor;\r\n    this.groundColor = args.groundColor ?? defaultGroundColor;\r\n    this.nadirColor = args.nadirColor ?? defaultNadirColor;\r\n    this.zenithColor = args.zenithColor ?? defaultZenithColor;\r\n    this.skyExponent = args.skyExponent ?? defaultExponent;\r\n    this.groundExponent = args.groundExponent ?? defaultExponent;\r\n  }\r\n\r\n  /** Default settings for a four-color gradient. */\r\n  public static readonly defaults = new SkyGradient({});\r\n\r\n  /** Create a new gradient. Any properties not specified by `props` are initialized to their default values. */\r\n  public static create(props?: Partial<SkyGradientProperties>): SkyGradient {\r\n    return props ? new this(props) : this.defaults;\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props?: SkyBoxProps): SkyGradient {\r\n    if (!props)\r\n      return this.defaults;\r\n\r\n    return new this({\r\n      twoColor: props.twoColor,\r\n      skyExponent: props.skyExponent,\r\n      groundExponent: props.groundExponent,\r\n      skyColor: colorDefFromJson(props.skyColor),\r\n      groundColor: colorDefFromJson(props.groundColor),\r\n      nadirColor: colorDefFromJson(props.nadirColor),\r\n      zenithColor: colorDefFromJson(props.zenithColor),\r\n    });\r\n  }\r\n\r\n  /** Create ea copy of this gradient, identical except for any properties explicitly specified by `changedProps`.\r\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\r\n   */\r\n  public clone(changedProps: SkyGradientProperties): SkyGradient {\r\n    return new SkyGradient({ ...this, ...changedProps });\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): SkyBoxProps {\r\n    const props: SkyBoxProps = {\r\n      skyColor: this.skyColor.toJSON(),\r\n      groundColor: this.groundColor.toJSON(),\r\n      nadirColor: this.nadirColor.toJSON(),\r\n      zenithColor: this.zenithColor.toJSON(),\r\n    };\r\n\r\n    if (this.groundExponent !== defaultExponent)\r\n      props.groundExponent = this.groundExponent;\r\n\r\n    if (this.skyExponent !== defaultExponent)\r\n      props.skyExponent = this.skyExponent;\r\n\r\n    if (this.twoColor)\r\n      props.twoColor = this.twoColor;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if this gradient is equivalent to the supplied gradient. */\r\n  public equals(other: SkyGradient): boolean {\r\n    if (this === other)\r\n      return true;\r\n\r\n    return this.twoColor === other.twoColor && this.skyColor.equals(other.skyColor) && this.groundColor.equals(other.groundColor) &&\r\n      this.zenithColor.equals(other.zenithColor) && this.nadirColor.equals(other.nadirColor);\r\n  }\r\n}\r\n\r\n/** Describes how to draw a representation of a sky, as part of an [[Environment]].\r\n * @see [[SkyBoxProps]].\r\n * @public\r\n */\r\nexport class SkyBox {\r\n  /** The gradient settings, used if no cube or sphere images are supplied, or if the images cannot be loaded. */\r\n  public readonly gradient: SkyGradient;\r\n\r\n  protected constructor(gradient: SkyGradient) {\r\n    this.gradient = gradient;\r\n  }\r\n\r\n  /** Default settings for a four-color gradient. */\r\n  public static readonly defaults = new SkyBox(SkyGradient.defaults);\r\n\r\n  /** Create a skybox that displays the specified gradient, or the default gradient if none is supplied. */\r\n  public static createGradient(gradient?: SkyGradient): SkyBox {\r\n    return gradient ? new this(gradient) : this.defaults;\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props?: SkyBoxProps): SkyBox {\r\n    const gradient = SkyGradient.fromJSON(props);\r\n\r\n    if (props?.image) {\r\n      switch (props.image.type) {\r\n        case SkyBoxImageType.Spherical:\r\n          if (undefined !== props.image.texture)\r\n            return new SkySphere(props.image.texture, gradient);\r\n\r\n          break;\r\n        case SkyBoxImageType.Cube: {\r\n          const tx = props.image.textures;\r\n          if (tx && undefined !== tx.top && undefined !== tx.bottom && undefined !== tx.right && undefined !== tx.left && undefined !== tx.front && undefined !== tx.back)\r\n            return new SkyCube(tx, gradient);\r\n\r\n          break;\r\n        }\r\n      }\r\n    }\r\n\r\n    return this.createGradient(gradient);\r\n  }\r\n\r\n  /** Convert to JSON representation.\r\n   * @param display If defined, the value to use for [[SkyBoxProps.display]]; otherwise, that property will be left undefined.\r\n   */\r\n  public toJSON(display?: boolean): SkyBoxProps {\r\n    const props = this.gradient.toJSON();\r\n    if (undefined !== display)\r\n      props.display = display;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public get textureIds(): Iterable<Id64String> {\r\n    return [];\r\n  }\r\n}\r\n\r\n/** Describes how to draw a representation of a sky by mapping a single image to the interior of a sphere.\r\n * @public\r\n */\r\nexport class SkySphere extends SkyBox {\r\n  /** The image to map to the interior of the sphere. */\r\n  public readonly image: TextureImageSpec;\r\n\r\n  /** Create a new sky sphere using the specified image.\r\n   * @param image The image to map to the interior of the sphere.\r\n   * @param gradient Optionally overrides the default gradient settings used if the image cannot be obtained.\r\n   */\r\n  public constructor(image: TextureImageSpec, gradient?: SkyGradient) {\r\n    super(gradient ?? SkyGradient.defaults);\r\n    this.image = image;\r\n  }\r\n\r\n  /** @internal override */\r\n  public override toJSON(display?: boolean): SkyBoxProps {\r\n    const props = super.toJSON(display);\r\n    props.image = {\r\n      type: SkyBoxImageType.Spherical,\r\n      texture: this.image,\r\n    };\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override get textureIds(): Iterable<Id64String> {\r\n    return Id64.isValidId64(this.image) ? [this.image] : [];\r\n  }\r\n}\r\n\r\n/** Describes how to draw a representation of a sky by mapping images to the interior faces of a cube.\r\n * The images are required to be *square*, and each image must have the same dimensions as the other images.\r\n * @public\r\n */\r\nexport class SkyCube extends SkyBox {\r\n  /** The images to map to each face of the cube. */\r\n  public readonly images: SkyCubeProps;\r\n\r\n  /** Create a new sky cube using the specified images.\r\n   * @param images The images to map to each face of the cube.\r\n   * @param Optionally overrides  the default gradient settings used if the images cannot be obtained.\r\n   */\r\n  public constructor(images: SkyCubeProps, gradient?: SkyGradient) {\r\n    super(gradient ?? SkyGradient.defaults);\r\n    this.images = { ...images };\r\n  }\r\n\r\n  /** @internal override */\r\n  public override toJSON(display?: boolean): SkyBoxProps {\r\n    const props = super.toJSON(display);\r\n    props.image = {\r\n      type: SkyBoxImageType.Cube,\r\n      textures: { ...this.images },\r\n    };\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override get textureIds(): Iterable<Id64String> {\r\n    const imgs = this.images;\r\n    return [imgs.front, imgs.back, imgs.top, imgs.bottom, imgs.left, imgs.right].filter((x) => Id64.isValidId64(x));\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SkyBox.js","sourceRoot":"","sources":["../../src/SkyBox.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAgF;AAChF,yCAAqD;AAGrD;;;;GAIG;AACH,IAAY,eAaX;AAbD,WAAY,eAAe;IACzB,kEAAkE;IAClE,qDAAQ,CAAA;IACR;;OAEG;IACH,+DAAa,CAAA;IACb,kCAAkC;IAClC,mEAAe,CAAA;IACf;;OAEG;IACH,qDAAQ,CAAA;AACV,CAAC,EAbW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAa1B;AA4GD,MAAM,kBAAkB,GAAG,mBAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACxD,MAAM,kBAAkB,GAAG,mBAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACvD,MAAM,iBAAiB,GAAG,mBAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AACpD,MAAM,eAAe,GAAG,mBAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AACrD,MAAM,eAAe,GAAG,GAAG,CAAC;AAE5B,SAAS,gBAAgB,CAAC,KAAqB;IAC7C,OAAO,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACpE,CAAC;AAQD;;;GAGG;AACH,MAAa,WAAW;IAStB,YAAoB,IAAoC;QACtD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,eAAe,CAAC;QACjD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,kBAAkB,CAAC;QAC1D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,iBAAiB,CAAC;QACvD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,kBAAkB,CAAC;QAC1D,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,eAAe,CAAC;QACvD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,IAAI,eAAe,CAAC;IAC/D,CAAC;IAKD,8GAA8G;IACvG,MAAM,CAAC,MAAM,CAAC,KAAsC;QACzD,OAAO,KAAK,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjD,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAmB;QACxC,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,IAAI,CAAC;YACd,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,cAAc,EAAE,KAAK,CAAC,cAAc;YACpC,QAAQ,EAAE,gBAAgB,CAAC,KAAK,CAAC,QAAQ,CAAC;YAC1C,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,WAAW,CAAC;YAChD,UAAU,EAAE,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC;YAC9C,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,WAAW,CAAC;SACjD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAmC;QAC9C,OAAO,IAAI,WAAW,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,MAAM,KAAK,GAAgB;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YAChC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;YACtC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;YACpC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;SACvC,CAAC;QAEF,IAAI,IAAI,CAAC,cAAc,KAAK,eAAe;YACzC,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;QAE7C,IAAI,IAAI,CAAC,WAAW,KAAK,eAAe;YACtC,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QAEvC,IAAI,IAAI,CAAC,QAAQ;YACf,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAEjC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4EAA4E;IACrE,MAAM,CAAC,KAAkB;QAC9B,IAAI,IAAI,KAAK,KAAK;YAChB,OAAO,IAAI,CAAC;QAEd,OAAO,IAAI,CAAC,QAAQ,KAAK,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;YAC3H,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC3F,CAAC;;AA3DD,kDAAkD;AAC3B,oBAAQ,GAAG,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC;AApB3C,kCAAW;AAiFxB;;;GAGG;AACH,MAAa,MAAM;IAIjB,YAAsB,QAAqB;QACzC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAKD,yGAAyG;IAClG,MAAM,CAAC,cAAc,CAAC,QAAsB;QACjD,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;IACvD,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAmB;QACxC,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAE7C,IAAI,KAAK,EAAE,KAAK,EAAE;YAChB,QAAQ,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE;gBACxB,KAAK,eAAe,CAAC,SAAS;oBAC5B,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK,CAAC,OAAO;wBACnC,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;oBAEtD,MAAM;gBACR,KAAK,eAAe,CAAC,IAAI,CAAC,CAAC;oBACzB,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;oBAChC,IAAI,EAAE,IAAI,SAAS,KAAK,EAAE,CAAC,GAAG,IAAI,SAAS,KAAK,EAAE,CAAC,MAAM,IAAI,SAAS,KAAK,EAAE,CAAC,KAAK,IAAI,SAAS,KAAK,EAAE,CAAC,IAAI,IAAI,SAAS,KAAK,EAAE,CAAC,KAAK,IAAI,SAAS,KAAK,EAAE,CAAC,IAAI;wBAC7J,OAAO,IAAI,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;oBAEnC,MAAM;iBACP;aACF;SACF;QAED,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,OAAiB;QAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACrC,IAAI,SAAS,KAAK,OAAO;YACvB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAE1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAW,UAAU;QACnB,OAAO,EAAE,CAAC;IACZ,CAAC;;AA9CD,kDAAkD;AAC3B,eAAQ,GAAG,IAAI,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;AATxD,wBAAM;AAyDnB;;GAEG;AACH,MAAa,SAAU,SAAQ,MAAM;IAInC;;;OAGG;IACH,YAAmB,KAAuB,EAAE,QAAsB;QAChE,KAAK,CAAC,QAAQ,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,6BAA6B;IACb,MAAM,CAAC,OAAiB;QACtC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACpC,KAAK,CAAC,KAAK,GAAG;YACZ,IAAI,EAAE,eAAe,CAAC,SAAS;YAC/B,OAAO,EAAE,IAAI,CAAC,KAAK;SACpB,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAoB,UAAU;QAC5B,OAAO,mBAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1D,CAAC;CACF;AA5BD,8BA4BC;AAED;;;GAGG;AACH,MAAa,OAAQ,SAAQ,MAAM;IAIjC;;;OAGG;IACH,YAAmB,MAAoB,EAAE,QAAsB;QAC7D,KAAK,CAAC,QAAQ,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC;QACxC,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;IAC9B,CAAC;IAED,6BAA6B;IACb,MAAM,CAAC,OAAiB;QACtC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACpC,KAAK,CAAC,KAAK,GAAG;YACZ,IAAI,EAAE,eAAe,CAAC,IAAI;YAC1B,QAAQ,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE;SAC7B,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IAChB,IAAoB,UAAU;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAClH,CAAC;CACF;AA7BD,0BA6BC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { Id64, Id64String, NonFunctionPropertiesOf } from \"@itwin/core-bentley\";\r\nimport { ColorDef, ColorDefProps } from \"./ColorDef\";\r\nimport { TextureImageSpec } from \"./RenderTexture\";\r\n\r\n/** Supported types of [[SkyBox]] images.\r\n * @see [[SkyBoxImageProps]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum SkyBoxImageType {\r\n  /** No image, indicating a [[SkyGradient]] should be displayed. */\r\n  None = 0,\r\n  /** A single image mapped to the surface of a sphere.\r\n   * @see [[SkySphere]].\r\n   */\r\n  Spherical = 1,\r\n  /** @internal not yet supported */\r\n  Cylindrical = 2,\r\n  /** Six images mapped to the faces of a cube.\r\n   * @see [[SkyCube]].\r\n   */\r\n  Cube = 3,\r\n}\r\n\r\n/** JSON representation of the six images used by a [[SkyCube]].\r\n * Each property specifies the image for a face of the cube as either an image URL, or the Id of a [Texture]($backend) element.\r\n * Each image must be square and have the same dimensions as all the other images.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SkyCubeProps {\r\n  front: TextureImageSpec;\r\n  back: TextureImageSpec;\r\n  top: TextureImageSpec;\r\n  bottom: TextureImageSpec;\r\n  right: TextureImageSpec;\r\n  left: TextureImageSpec;\r\n}\r\n\r\n/** JSON representation of the image used for a [[SkySphere]].\r\n * @see [[SkyBoxProps.image]].\r\n * @public\r\n */\r\nexport interface SkySphereImageProps {\r\n  type: SkyBoxImageType.Spherical;\r\n  texture: TextureImageSpec;\r\n  /** @internal */\r\n  textures?: never;\r\n}\r\n\r\n/** JSON representation of the images used for a [[SkyCube]].\r\n * @see [[SkyBoxProps.image]].\r\n * @public\r\n */\r\nexport interface SkyCubeImageProps {\r\n  type: SkyBoxImageType.Cube;\r\n  textures: SkyCubeProps;\r\n  /** @internal */\r\n  texture?: never;\r\n}\r\n\r\n/** JSON representation of the image(s) to be mapped to the surfaces of a [[SkyBox]].\r\n * @see [[SkyBoxProps.image]].\r\n * @public\r\n * @extensions\r\n */\r\nexport type SkyBoxImageProps = SkySphereImageProps | SkyCubeImageProps | { type?: SkyBoxImageType, texture?: never, textures?: never };\r\n\r\n/** JSON representation of a [[SkyBox]] that can be drawn as the background of a [ViewState3d]($frontend).\r\n * An object of this type can describe one of several types of sky box:\r\n *  - A cube with a texture image mapped to each face; or\r\n *  - A sphere with a single texture image mapped to its surface; or\r\n *  - A sphere with a two- or four-color vertical [[Gradient]] mapped to its surface.\r\n *\r\n * Whether cuboid or spherical, the skybox is drawn as if the viewer and the contents of the view are contained within its interior.\r\n *\r\n * For a two-color gradient, the gradient transitions smoothly from the nadir color at the bottom of the sphere to the zenith color at the top of the sphere.\r\n * The sky and ground colors are unused, as are the sky and ground exponents.\r\n *\r\n * For a four-color gradient, a \"horizon\" is produced on the equator of the sphere, where the ground color and sky color meet. The lower half of the sphere transitions\r\n * smoothly from the ground color at the equator to the nadir color at the bottom, and the upper half transitions from the sky color at the equator to the zenith color at\r\n * the top of the sphere.\r\n *\r\n * The color and exponent properties are unused if one or more texture images are supplied.\r\n *\r\n * The skybox is ignored entirely when an atmosphere is displayed.\r\n *\r\n * @see [[DisplayStyle3dSettings.environment]] to define the skybox for a display style.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface SkyBoxProps {\r\n  /** Whether or not the skybox should be displayed.\r\n   * Default: false.\r\n   */\r\n  display?: boolean;\r\n  /** For a [[SkyGradient]], if true, a 2-color gradient skybox is used instead of a 4-color.\r\n   * Default: false.\r\n   */\r\n  twoColor?: boolean;\r\n  /** The color of the sky at the horizon. Unused unless this is a four-color [[SkyGradient]].\r\n   * Default: (143, 205, 255).\r\n   */\r\n  skyColor?: ColorDefProps;\r\n  /** The color of the ground at the horizon. Unused unless this is a four-color [[SkyGradient]].\r\n   * Default: (120, 143, 125).\r\n   */\r\n  groundColor?: ColorDefProps;\r\n  /** The color of the top of the sphere.\r\n   * Default: (54, 117, 255).\r\n   */\r\n  zenithColor?: ColorDefProps;\r\n  /** The color of the bottom of the sphere.\r\n   * Default: (40, 15, 0).\r\n   */\r\n  nadirColor?: ColorDefProps;\r\n  /** For a 4-color [[SkyGradient]], controls speed of change from sky color to zenith color; otherwise unused.\r\n   * Default: 4.0.\r\n   */\r\n  skyExponent?: number;\r\n  /** For a 4-color [[SkyGradient]], controls speed of change from ground color to nadir color; otherwise unused.\r\n   * Default: 4.0.\r\n   */\r\n  groundExponent?: number;\r\n  /** The image(s), if any, to be mapped to the surfaces of the sphere or cube. If undefined, the skybox will be displayed as a gradient instead.\r\n   * Default: undefined.\r\n   */\r\n  image?: SkyBoxImageProps;\r\n}\r\n\r\nconst defaultGroundColor = ColorDef.from(143, 205, 125);\r\nconst defaultZenithColor = ColorDef.from(54, 117, 255);\r\nconst defaultNadirColor = ColorDef.from(40, 125, 0);\r\nconst defaultSkyColor = ColorDef.from(142, 205, 255);\r\nconst defaultExponent = 4.0;\r\n\r\nfunction colorDefFromJson(props?: ColorDefProps): ColorDef | undefined {\r\n  return undefined !== props ? ColorDef.fromJSON(props) : undefined;\r\n}\r\n\r\n/** A type containing all of the properties and none of the methods of [[SkyGradient]] with `readonly` modifiers removed.\r\n * @see [[SkyGradient.create]] and [[SkyGradient.clone]].\r\n * @public\r\n */\r\nexport type SkyGradientProperties = NonFunctionPropertiesOf<SkyGradient>;\r\n\r\n/** Describes how to map a two- or four-color [[Gradient]] to the interior of a sphere to produce a [[SkyBox]].\r\n * @see [[SkyBox.gradient]].\r\n * @public\r\n */\r\nexport class SkyGradient {\r\n  public readonly twoColor: boolean;\r\n  public readonly skyColor: ColorDef;\r\n  public readonly groundColor: ColorDef;\r\n  public readonly zenithColor: ColorDef;\r\n  public readonly nadirColor: ColorDef;\r\n  public readonly skyExponent: number;\r\n  public readonly groundExponent: number;\r\n\r\n  private constructor(args: Partial<SkyGradientProperties>) {\r\n    this.twoColor = args.twoColor ?? false;\r\n    this.skyColor = args.skyColor ?? defaultSkyColor;\r\n    this.groundColor = args.groundColor ?? defaultGroundColor;\r\n    this.nadirColor = args.nadirColor ?? defaultNadirColor;\r\n    this.zenithColor = args.zenithColor ?? defaultZenithColor;\r\n    this.skyExponent = args.skyExponent ?? defaultExponent;\r\n    this.groundExponent = args.groundExponent ?? defaultExponent;\r\n  }\r\n\r\n  /** Default settings for a four-color gradient. */\r\n  public static readonly defaults = new SkyGradient({});\r\n\r\n  /** Create a new gradient. Any properties not specified by `props` are initialized to their default values. */\r\n  public static create(props?: Partial<SkyGradientProperties>): SkyGradient {\r\n    return props ? new this(props) : this.defaults;\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props?: SkyBoxProps): SkyGradient {\r\n    if (!props)\r\n      return this.defaults;\r\n\r\n    return new this({\r\n      twoColor: props.twoColor,\r\n      skyExponent: props.skyExponent,\r\n      groundExponent: props.groundExponent,\r\n      skyColor: colorDefFromJson(props.skyColor),\r\n      groundColor: colorDefFromJson(props.groundColor),\r\n      nadirColor: colorDefFromJson(props.nadirColor),\r\n      zenithColor: colorDefFromJson(props.zenithColor),\r\n    });\r\n  }\r\n\r\n  /** Create ea copy of this gradient, identical except for any properties explicitly specified by `changedProps`.\r\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\r\n   */\r\n  public clone(changedProps: SkyGradientProperties): SkyGradient {\r\n    return new SkyGradient({ ...this, ...changedProps });\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): SkyBoxProps {\r\n    const props: SkyBoxProps = {\r\n      skyColor: this.skyColor.toJSON(),\r\n      groundColor: this.groundColor.toJSON(),\r\n      nadirColor: this.nadirColor.toJSON(),\r\n      zenithColor: this.zenithColor.toJSON(),\r\n    };\r\n\r\n    if (this.groundExponent !== defaultExponent)\r\n      props.groundExponent = this.groundExponent;\r\n\r\n    if (this.skyExponent !== defaultExponent)\r\n      props.skyExponent = this.skyExponent;\r\n\r\n    if (this.twoColor)\r\n      props.twoColor = this.twoColor;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if this gradient is equivalent to the supplied gradient. */\r\n  public equals(other: SkyGradient): boolean {\r\n    if (this === other)\r\n      return true;\r\n\r\n    return this.twoColor === other.twoColor && this.skyColor.equals(other.skyColor) && this.groundColor.equals(other.groundColor) &&\r\n      this.zenithColor.equals(other.zenithColor) && this.nadirColor.equals(other.nadirColor);\r\n  }\r\n}\r\n\r\n/** Describes how to draw a representation of a sky, as part of an [[Environment]].\r\n * @see [[SkyBoxProps]].\r\n * @public\r\n */\r\nexport class SkyBox {\r\n  /** The gradient settings, used if no cube or sphere images are supplied, or if the images cannot be loaded. */\r\n  public readonly gradient: SkyGradient;\r\n\r\n  protected constructor(gradient: SkyGradient) {\r\n    this.gradient = gradient;\r\n  }\r\n\r\n  /** Default settings for a four-color gradient. */\r\n  public static readonly defaults = new SkyBox(SkyGradient.defaults);\r\n\r\n  /** Create a skybox that displays the specified gradient, or the default gradient if none is supplied. */\r\n  public static createGradient(gradient?: SkyGradient): SkyBox {\r\n    return gradient ? new this(gradient) : this.defaults;\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props?: SkyBoxProps): SkyBox {\r\n    const gradient = SkyGradient.fromJSON(props);\r\n\r\n    if (props?.image) {\r\n      switch (props.image.type) {\r\n        case SkyBoxImageType.Spherical:\r\n          if (undefined !== props.image.texture)\r\n            return new SkySphere(props.image.texture, gradient);\r\n\r\n          break;\r\n        case SkyBoxImageType.Cube: {\r\n          const tx = props.image.textures;\r\n          if (tx && undefined !== tx.top && undefined !== tx.bottom && undefined !== tx.right && undefined !== tx.left && undefined !== tx.front && undefined !== tx.back)\r\n            return new SkyCube(tx, gradient);\r\n\r\n          break;\r\n        }\r\n      }\r\n    }\r\n\r\n    return this.createGradient(gradient);\r\n  }\r\n\r\n  /** Convert to JSON representation.\r\n   * @param display If defined, the value to use for [[SkyBoxProps.display]]; otherwise, that property will be left undefined.\r\n   */\r\n  public toJSON(display?: boolean): SkyBoxProps {\r\n    const props = this.gradient.toJSON();\r\n    if (undefined !== display)\r\n      props.display = display;\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public get textureIds(): Iterable<Id64String> {\r\n    return [];\r\n  }\r\n}\r\n\r\n/** Describes how to draw a representation of a sky by mapping a single image to the interior of a sphere.\r\n * @public\r\n */\r\nexport class SkySphere extends SkyBox {\r\n  /** The image to map to the interior of the sphere. */\r\n  public readonly image: TextureImageSpec;\r\n\r\n  /** Create a new sky sphere using the specified image.\r\n   * @param image The image to map to the interior of the sphere.\r\n   * @param gradient Optionally overrides the default gradient settings used if the image cannot be obtained.\r\n   */\r\n  public constructor(image: TextureImageSpec, gradient?: SkyGradient) {\r\n    super(gradient ?? SkyGradient.defaults);\r\n    this.image = image;\r\n  }\r\n\r\n  /** See [[SkyBox.toJSON]]. */\r\n  public override toJSON(display?: boolean): SkyBoxProps {\r\n    const props = super.toJSON(display);\r\n    props.image = {\r\n      type: SkyBoxImageType.Spherical,\r\n      texture: this.image,\r\n    };\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override get textureIds(): Iterable<Id64String> {\r\n    return Id64.isValidId64(this.image) ? [this.image] : [];\r\n  }\r\n}\r\n\r\n/** Describes how to draw a representation of a sky by mapping images to the interior faces of a cube.\r\n * The images are required to be *square*, and each image must have the same dimensions as the other images.\r\n * @public\r\n */\r\nexport class SkyCube extends SkyBox {\r\n  /** The images to map to each face of the cube. */\r\n  public readonly images: SkyCubeProps;\r\n\r\n  /** Create a new sky cube using the specified images.\r\n   * @param images The images to map to each face of the cube.\r\n   * @param gradient Optionally overrides  the default gradient settings used if the images cannot be obtained.\r\n   */\r\n  public constructor(images: SkyCubeProps, gradient?: SkyGradient) {\r\n    super(gradient ?? SkyGradient.defaults);\r\n    this.images = { ...images };\r\n  }\r\n\r\n  /** See [[SkyBox.toJSON]]. */\r\n  public override toJSON(display?: boolean): SkyBoxProps {\r\n    const props = super.toJSON(display);\r\n    props.image = {\r\n      type: SkyBoxImageType.Cube,\r\n      textures: { ...this.images },\r\n    };\r\n\r\n    return props;\r\n  }\r\n\r\n  /** @internal */\r\n  public override get textureIds(): Iterable<Id64String> {\r\n    const imgs = this.images;\r\n    return [imgs.front, imgs.back, imgs.top, imgs.bottom, imgs.left, imgs.right].filter((x) => Id64.isValidId64(x));\r\n  }\r\n}\r\n"]}

package/lib/cjs/ViewFlags.d.ts

@@ -249,11 +249,11 @@ export declare class ViewFlags {
     hiddenEdgesVisible(): boolean;
     /** Returns true if the edges of surfaces should be displayed, based on [[RenderMode]] and the [[visibleEdges]] flag. */
     edgesRequired(): boolean;
-    /** Convert to JSON representation. */
-    toJSON(): ViewFlagProps;
-    /** Like [[toJSON]], but no properties are omitted.
-     * @internal
+    /** Convert to JSON representation.
+     * Properties are omitted if they match the default values.
      */
+    toJSON(): ViewFlagProps;
+    /** Like [[toJSON]], but no properties are omitted. */
     toFullyDefinedJSON(): Required<ViewFlagProps>;
     /** A ViewFlags object with all properties initialized to their default values. */
     static readonly defaults: ViewFlags;

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

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

package/lib/cjs/ViewFlags.js

@@ -194,7 +194,9 @@ class ViewFlags {
     edgesRequired() {
         return edgesRequired(this.renderMode, this.visibleEdges);
     }
-    /** Convert to JSON representation. */
+    /** Convert to JSON representation.
+     * Properties are omitted if they match the default values.
+     */
     toJSON() {
         const out = {};
         if (!this.constructions)
@@ -246,9 +248,7 @@ class ViewFlags {
         out.renderMode = this.renderMode;
         return out;
     }
-    /** Like [[toJSON]], but no properties are omitted.
-     * @internal
-     */
+    /** Like [[toJSON]], but no properties are omitted. */
     toFullyDefinedJSON() {
         return {
             renderMode: this.renderMode,

package/lib/cjs/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,sDAAkF;AAElF;;;;GAIG;AACH,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,GAAV,kBAAU,KAAV,kBAAU,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,wBAAS,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,gBAAgB;IACT,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,sCAAsC;IAC/B,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;;OAEG;IACI,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,wBAAS,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,wBAAS,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,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1I,OAAO,IAAI,SAAS,CAAC;YACnB,UAAU;YACV,QAAQ;YACR,aAAa,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC;YAClD,UAAU,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;YACzC,QAAQ,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;YAC3C,OAAO,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YACzC,MAAM,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YACvC,YAAY,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC9C,IAAI,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;YACpC,IAAI,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;YACjC,QAAQ,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;YACpC,QAAQ,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;YAC3C,SAAS,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;YAC7C,YAAY,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC7C,WAAW,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC5C,OAAO,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YACvC,UAAU,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YAC1C,UAAU,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;YAC7C,aAAa,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;YACnD,gBAAgB,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC;YACzD,eAAe,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC;YACvD,QAAQ,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YACzC,mBAAmB,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC;YAC/D,oBAAoB,EAAE,CAAC,wBAAS,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;AAzTvC,8BAAS","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  /** @internal */\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  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   * @internal\r\n   */\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,sDAAkF;AAElF;;;;GAIG;AACH,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,GAAV,kBAAU,KAAV,kBAAU,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,wBAAS,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,gBAAgB;IACT,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,wBAAS,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,wBAAS,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,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC1I,OAAO,IAAI,SAAS,CAAC;YACnB,UAAU;YACV,QAAQ;YACR,aAAa,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC;YAClD,UAAU,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;YACzC,QAAQ,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;YAC3C,OAAO,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YACzC,MAAM,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YACvC,YAAY,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC9C,IAAI,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;YACpC,IAAI,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;YACjC,QAAQ,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;YACpC,QAAQ,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;YAC3C,SAAS,EAAE,CAAC,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;YAC7C,YAAY,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC7C,WAAW,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC5C,OAAO,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YACvC,UAAU,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YAC1C,UAAU,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;YAC7C,aAAa,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;YACnD,gBAAgB,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC;YACzD,eAAe,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC;YACvD,QAAQ,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;YACzC,mBAAmB,EAAE,wBAAS,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC;YAC/D,oBAAoB,EAAE,CAAC,wBAAS,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;AAzTvC,8BAAS","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  /** @internal */\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"]}