@itwin/core-common 4.0.0-dev.8 → 4.0.0-dev.80

package/lib/cjs/Hilite.d.ts

@@ -1,51 +1,51 @@
-/** @packageDocumentation
- * @module Rendering
- */
-import { ColorDef } from "./ColorDef";
-/** Contains types related to display of hilited elements within a [[Viewport]].
- * @public
- */
-export declare namespace Hilite {
-    /**  Describes the width of the outline applied to hilited geometry. The outline is drawn around the union of all hilited geometry and is visible behind non-hilited geometry.
-     * @see [[Hilite.Settings]]
-     */
-    enum Silhouette {
-        /** No outline. */
-        None = 0,
-        /** 1-pixel-wide outline. */
-        Thin = 1,
-        /** 2-pixel-wide outline. */
-        Thick = 2
-    }
-    /**
-     * Describes how the hilite effect is applied to elements within a [[Viewport]].
-     * The hilite effect is applied to elements contained in the [[IModelConnection]]'s [[SelectionSet]].
-     * It is designed to draw attention to those elements. The effect is produced as follows:
-     *  1. All hilited elements are drawn as normal, except that their element color is mixed with the hilite color.
-     *  2. The union of the regions of the screen corresponding to hilited elements is computed.
-     *  3. A silhouette is drawn using the hilite color around the boundaries of the hilited region. This silhouette is visible behind other geometry.
-     *  4. The hilite color is mixed with the color of each pixel within the hilited region. This enables surfaces of hilited geometry to be visible behind other geometry.
-     *
-     * The Settings allow an application to customize how this effect is applied.
-     * @see [[Viewport.hilite]]
-     */
-    class Settings {
-        /** The color that is used to draw the outline and which is mixed with element color. */
-        readonly color: ColorDef;
-        /** The ratio of hilite color to element color used when drawing unobscured portions of hilited geometry, in the range [0, 1].
-         * A ratio of 0.0 uses only the element color. A ratio of 1.0 uses only the hilite color. A ratio of 0.5 mixes the hilite color and element color evenly.
-         */
-        readonly visibleRatio: number;
-        /** The ratio of hilite color to screen color used when drawing the hilited region overtop of the screen contents, in the range [0, 1]. */
-        readonly hiddenRatio: number;
-        /** The type of outline to be drawn around the boundaries of the hilited region. */
-        silhouette: Silhouette;
-        private static clamp;
-        constructor(color?: ColorDef, visibleRatio?: number, hiddenRatio?: number, silhouette?: Silhouette);
-    }
-    /** Compare two Settings objects for equivalence. */
-    function equalSettings(lhs: Settings, rhs: Settings): boolean;
-    /** Create a copy of a Settings object. */
-    function cloneSettings(settings: Settings): Settings;
-}
+/** @packageDocumentation
+ * @module Rendering
+ */
+import { ColorDef } from "./ColorDef";
+/** Contains types related to display of hilited elements within a [[Viewport]].
+ * @public
+ */
+export declare namespace Hilite {
+    /**  Describes the width of the outline applied to hilited geometry. The outline is drawn around the union of all hilited geometry and is visible behind non-hilited geometry.
+     * @see [[Hilite.Settings]]
+     */
+    enum Silhouette {
+        /** No outline. */
+        None = 0,
+        /** 1-pixel-wide outline. */
+        Thin = 1,
+        /** 2-pixel-wide outline. */
+        Thick = 2
+    }
+    /**
+     * Describes how the hilite effect is applied to elements within a [[Viewport]].
+     * The hilite effect is applied to elements contained in the [[IModelConnection]]'s [[SelectionSet]].
+     * It is designed to draw attention to those elements. The effect is produced as follows:
+     *  1. All hilited elements are drawn as normal, except that their element color is mixed with the hilite color.
+     *  2. The union of the regions of the screen corresponding to hilited elements is computed.
+     *  3. A silhouette is drawn using the hilite color around the boundaries of the hilited region. This silhouette is visible behind other geometry.
+     *  4. The hilite color is mixed with the color of each pixel within the hilited region. This enables surfaces of hilited geometry to be visible behind other geometry.
+     *
+     * The Settings allow an application to customize how this effect is applied.
+     * @see [[Viewport.hilite]]
+     */
+    class Settings {
+        /** The color that is used to draw the outline and which is mixed with element color. */
+        readonly color: ColorDef;
+        /** The ratio of hilite color to element color used when drawing unobscured portions of hilited geometry, in the range [0, 1].
+         * A ratio of 0.0 uses only the element color. A ratio of 1.0 uses only the hilite color. A ratio of 0.5 mixes the hilite color and element color evenly.
+         */
+        readonly visibleRatio: number;
+        /** The ratio of hilite color to screen color used when drawing the hilited region overtop of the screen contents, in the range [0, 1]. */
+        readonly hiddenRatio: number;
+        /** The type of outline to be drawn around the boundaries of the hilited region. */
+        silhouette: Silhouette;
+        private static clamp;
+        constructor(color?: ColorDef, visibleRatio?: number, hiddenRatio?: number, silhouette?: Silhouette);
+    }
+    /** Compare two Settings objects for equivalence. */
+    function equalSettings(lhs: Settings, rhs: Settings): boolean;
+    /** Create a copy of a Settings object. */
+    function cloneSettings(settings: Settings): Settings;
+}
 //# sourceMappingURL=Hilite.d.ts.map

package/lib/cjs/Hilite.js

@@ -1,65 +1,65 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Rendering
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Hilite = void 0;
-const ColorDef_1 = require("./ColorDef");
-/** Contains types related to display of hilited elements within a [[Viewport]].
- * @public
- */
-var Hilite;
-(function (Hilite) {
-    /**  Describes the width of the outline applied to hilited geometry. The outline is drawn around the union of all hilited geometry and is visible behind non-hilited geometry.
-     * @see [[Hilite.Settings]]
-     */
-    let Silhouette;
-    (function (Silhouette) {
-        /** No outline. */
-        Silhouette[Silhouette["None"] = 0] = "None";
-        /** 1-pixel-wide outline. */
-        Silhouette[Silhouette["Thin"] = 1] = "Thin";
-        /** 2-pixel-wide outline. */
-        Silhouette[Silhouette["Thick"] = 2] = "Thick";
-    })(Silhouette = Hilite.Silhouette || (Hilite.Silhouette = {}));
-    /**
-     * Describes how the hilite effect is applied to elements within a [[Viewport]].
-     * The hilite effect is applied to elements contained in the [[IModelConnection]]'s [[SelectionSet]].
-     * It is designed to draw attention to those elements. The effect is produced as follows:
-     *  1. All hilited elements are drawn as normal, except that their element color is mixed with the hilite color.
-     *  2. The union of the regions of the screen corresponding to hilited elements is computed.
-     *  3. A silhouette is drawn using the hilite color around the boundaries of the hilited region. This silhouette is visible behind other geometry.
-     *  4. The hilite color is mixed with the color of each pixel within the hilited region. This enables surfaces of hilited geometry to be visible behind other geometry.
-     *
-     * The Settings allow an application to customize how this effect is applied.
-     * @see [[Viewport.hilite]]
-     */
-    class Settings {
-        constructor(color = ColorDef_1.ColorDef.from(0x23, 0xbb, 0xfc), visibleRatio = 0.25, hiddenRatio = 0.0, silhouette = Silhouette.Thin) {
-            this.color = color;
-            this.silhouette = silhouette;
-            this.visibleRatio = Settings.clamp(visibleRatio);
-            this.hiddenRatio = Settings.clamp(hiddenRatio);
-        }
-        static clamp(value) { return Math.min(1.0, Math.max(0.0, value)); }
-    }
-    Hilite.Settings = Settings;
-    /** Compare two Settings objects for equivalence. */
-    function equalSettings(lhs, rhs) {
-        return lhs.color.equals(rhs.color)
-            && lhs.visibleRatio === rhs.visibleRatio
-            && lhs.hiddenRatio === rhs.hiddenRatio
-            && lhs.silhouette === rhs.silhouette;
-    }
-    Hilite.equalSettings = equalSettings;
-    /** Create a copy of a Settings object. */
-    function cloneSettings(settings) {
-        return new Settings(settings.color, settings.visibleRatio, settings.hiddenRatio, settings.silhouette);
-    }
-    Hilite.cloneSettings = cloneSettings;
-})(Hilite = exports.Hilite || (exports.Hilite = {}));
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Rendering
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Hilite = void 0;
+const ColorDef_1 = require("./ColorDef");
+/** Contains types related to display of hilited elements within a [[Viewport]].
+ * @public
+ */
+var Hilite;
+(function (Hilite) {
+    /**  Describes the width of the outline applied to hilited geometry. The outline is drawn around the union of all hilited geometry and is visible behind non-hilited geometry.
+     * @see [[Hilite.Settings]]
+     */
+    let Silhouette;
+    (function (Silhouette) {
+        /** No outline. */
+        Silhouette[Silhouette["None"] = 0] = "None";
+        /** 1-pixel-wide outline. */
+        Silhouette[Silhouette["Thin"] = 1] = "Thin";
+        /** 2-pixel-wide outline. */
+        Silhouette[Silhouette["Thick"] = 2] = "Thick";
+    })(Silhouette = Hilite.Silhouette || (Hilite.Silhouette = {}));
+    /**
+     * Describes how the hilite effect is applied to elements within a [[Viewport]].
+     * The hilite effect is applied to elements contained in the [[IModelConnection]]'s [[SelectionSet]].
+     * It is designed to draw attention to those elements. The effect is produced as follows:
+     *  1. All hilited elements are drawn as normal, except that their element color is mixed with the hilite color.
+     *  2. The union of the regions of the screen corresponding to hilited elements is computed.
+     *  3. A silhouette is drawn using the hilite color around the boundaries of the hilited region. This silhouette is visible behind other geometry.
+     *  4. The hilite color is mixed with the color of each pixel within the hilited region. This enables surfaces of hilited geometry to be visible behind other geometry.
+     *
+     * The Settings allow an application to customize how this effect is applied.
+     * @see [[Viewport.hilite]]
+     */
+    class Settings {
+        static clamp(value) { return Math.min(1.0, Math.max(0.0, value)); }
+        constructor(color = ColorDef_1.ColorDef.from(0x23, 0xbb, 0xfc), visibleRatio = 0.25, hiddenRatio = 0.0, silhouette = Silhouette.Thin) {
+            this.color = color;
+            this.silhouette = silhouette;
+            this.visibleRatio = Settings.clamp(visibleRatio);
+            this.hiddenRatio = Settings.clamp(hiddenRatio);
+        }
+    }
+    Hilite.Settings = Settings;
+    /** Compare two Settings objects for equivalence. */
+    function equalSettings(lhs, rhs) {
+        return lhs.color.equals(rhs.color)
+            && lhs.visibleRatio === rhs.visibleRatio
+            && lhs.hiddenRatio === rhs.hiddenRatio
+            && lhs.silhouette === rhs.silhouette;
+    }
+    Hilite.equalSettings = equalSettings;
+    /** Create a copy of a Settings object. */
+    function cloneSettings(settings) {
+        return new Settings(settings.color, settings.visibleRatio, settings.hiddenRatio, settings.silhouette);
+    }
+    Hilite.cloneSettings = cloneSettings;
+})(Hilite = exports.Hilite || (exports.Hilite = {}));
 //# sourceMappingURL=Hilite.js.map

package/lib/cjs/Hilite.js.map

@@ -1 +1 @@
-{"version":3,"file":"Hilite.js","sourceRoot":"","sources":["../../src/Hilite.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yCAAsC;AAEtC;;GAEG;AACH,IAAiB,MAAM,CA2DtB;AA3DD,WAAiB,MAAM;IACrB;;OAEG;IACH,IAAY,UAOX;IAPD,WAAY,UAAU;QACpB,kBAAkB;QAClB,2CAAI,CAAA;QACJ,4BAA4B;QAC5B,2CAAI,CAAA;QACJ,4BAA4B;QAC5B,6CAAK,CAAA;IACP,CAAC,EAPW,UAAU,GAAV,iBAAU,KAAV,iBAAU,QAOrB;IAED;;;;;;;;;;;OAWG;IACH,MAAa,QAAQ;QAcnB,YAAmB,KAAK,GAAG,mBAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,YAAY,GAAG,IAAI,EAAE,WAAW,GAAG,GAAG,EAAE,UAAU,GAAG,UAAU,CAAC,IAAI;YAC9H,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACnB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACjD,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACjD,CAAC;QAPO,MAAM,CAAC,KAAK,CAAC,KAAa,IAAI,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;KAQpF;IApBY,eAAQ,WAoBpB,CAAA;IAED,oDAAoD;IACpD,SAAgB,aAAa,CAAC,GAAa,EAAE,GAAa;QACxD,OAAO,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;eAC7B,GAAG,CAAC,YAAY,KAAK,GAAG,CAAC,YAAY;eACrC,GAAG,CAAC,WAAW,KAAK,GAAG,CAAC,WAAW;eACnC,GAAG,CAAC,UAAU,KAAK,GAAG,CAAC,UAAU,CAAC;IACzC,CAAC;IALe,oBAAa,gBAK5B,CAAA;IAED,0CAA0C;IAC1C,SAAgB,aAAa,CAAC,QAAkB;QAC9C,OAAO,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IACxG,CAAC;IAFe,oBAAa,gBAE5B,CAAA;AACH,CAAC,EA3DgB,MAAM,GAAN,cAAM,KAAN,cAAM,QA2DtB","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Rendering\r\n */\r\n\r\nimport { ColorDef } from \"./ColorDef\";\r\n\r\n/** Contains types related to display of hilited elements within a [[Viewport]].\r\n * @public\r\n */\r\nexport namespace Hilite {\r\n  /**  Describes the width of the outline applied to hilited geometry. The outline is drawn around the union of all hilited geometry and is visible behind non-hilited geometry.\r\n   * @see [[Hilite.Settings]]\r\n   */\r\n  export enum Silhouette {\r\n    /** No outline. */\r\n    None,\r\n    /** 1-pixel-wide outline. */\r\n    Thin,\r\n    /** 2-pixel-wide outline. */\r\n    Thick,\r\n  }\r\n\r\n  /**\r\n   * Describes how the hilite effect is applied to elements within a [[Viewport]].\r\n   * The hilite effect is applied to elements contained in the [[IModelConnection]]'s [[SelectionSet]].\r\n   * It is designed to draw attention to those elements. The effect is produced as follows:\r\n   *  1. All hilited elements are drawn as normal, except that their element color is mixed with the hilite color.\r\n   *  2. The union of the regions of the screen corresponding to hilited elements is computed.\r\n   *  3. A silhouette is drawn using the hilite color around the boundaries of the hilited region. This silhouette is visible behind other geometry.\r\n   *  4. The hilite color is mixed with the color of each pixel within the hilited region. This enables surfaces of hilited geometry to be visible behind other geometry.\r\n   *\r\n   * The Settings allow an application to customize how this effect is applied.\r\n   * @see [[Viewport.hilite]]\r\n   */\r\n  export class Settings {\r\n    /** The color that is used to draw the outline and which is mixed with element color. */\r\n    public readonly color: ColorDef;\r\n    /** The ratio of hilite color to element color used when drawing unobscured portions of hilited geometry, in the range [0, 1].\r\n     * A ratio of 0.0 uses only the element color. A ratio of 1.0 uses only the hilite color. A ratio of 0.5 mixes the hilite color and element color evenly.\r\n     */\r\n    public readonly visibleRatio: number;\r\n    /** The ratio of hilite color to screen color used when drawing the hilited region overtop of the screen contents, in the range [0, 1]. */\r\n    public readonly hiddenRatio: number;\r\n    /** The type of outline to be drawn around the boundaries of the hilited region. */\r\n    public silhouette: Silhouette;\r\n\r\n    private static clamp(value: number) { return Math.min(1.0, Math.max(0.0, value)); }\r\n\r\n    public constructor(color = ColorDef.from(0x23, 0xbb, 0xfc), visibleRatio = 0.25, hiddenRatio = 0.0, silhouette = Silhouette.Thin) {\r\n      this.color = color;\r\n      this.silhouette = silhouette;\r\n      this.visibleRatio = Settings.clamp(visibleRatio);\r\n      this.hiddenRatio = Settings.clamp(hiddenRatio);\r\n    }\r\n  }\r\n\r\n  /** Compare two Settings objects for equivalence. */\r\n  export function equalSettings(lhs: Settings, rhs: Settings): boolean {\r\n    return lhs.color.equals(rhs.color)\r\n      && lhs.visibleRatio === rhs.visibleRatio\r\n      && lhs.hiddenRatio === rhs.hiddenRatio\r\n      && lhs.silhouette === rhs.silhouette;\r\n  }\r\n\r\n  /** Create a copy of a Settings object. */\r\n  export function cloneSettings(settings: Settings): Settings {\r\n    return new Settings(settings.color, settings.visibleRatio, settings.hiddenRatio, settings.silhouette);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Hilite.js","sourceRoot":"","sources":["../../src/Hilite.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yCAAsC;AAEtC;;GAEG;AACH,IAAiB,MAAM,CA2DtB;AA3DD,WAAiB,MAAM;IACrB;;OAEG;IACH,IAAY,UAOX;IAPD,WAAY,UAAU;QACpB,kBAAkB;QAClB,2CAAI,CAAA;QACJ,4BAA4B;QAC5B,2CAAI,CAAA;QACJ,4BAA4B;QAC5B,6CAAK,CAAA;IACP,CAAC,EAPW,UAAU,GAAV,iBAAU,KAAV,iBAAU,QAOrB;IAED;;;;;;;;;;;OAWG;IACH,MAAa,QAAQ;QAYX,MAAM,CAAC,KAAK,CAAC,KAAa,IAAI,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAEnF,YAAmB,KAAK,GAAG,mBAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,YAAY,GAAG,IAAI,EAAE,WAAW,GAAG,GAAG,EAAE,UAAU,GAAG,UAAU,CAAC,IAAI;YAC9H,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACnB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACjD,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACjD,CAAC;KACF;IApBY,eAAQ,WAoBpB,CAAA;IAED,oDAAoD;IACpD,SAAgB,aAAa,CAAC,GAAa,EAAE,GAAa;QACxD,OAAO,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;eAC7B,GAAG,CAAC,YAAY,KAAK,GAAG,CAAC,YAAY;eACrC,GAAG,CAAC,WAAW,KAAK,GAAG,CAAC,WAAW;eACnC,GAAG,CAAC,UAAU,KAAK,GAAG,CAAC,UAAU,CAAC;IACzC,CAAC;IALe,oBAAa,gBAK5B,CAAA;IAED,0CAA0C;IAC1C,SAAgB,aAAa,CAAC,QAAkB;QAC9C,OAAO,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IACxG,CAAC;IAFe,oBAAa,gBAE5B,CAAA;AACH,CAAC,EA3DgB,MAAM,GAAN,cAAM,KAAN,cAAM,QA2DtB","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Rendering\r\n */\r\n\r\nimport { ColorDef } from \"./ColorDef\";\r\n\r\n/** Contains types related to display of hilited elements within a [[Viewport]].\r\n * @public\r\n */\r\nexport namespace Hilite {\r\n  /**  Describes the width of the outline applied to hilited geometry. The outline is drawn around the union of all hilited geometry and is visible behind non-hilited geometry.\r\n   * @see [[Hilite.Settings]]\r\n   */\r\n  export enum Silhouette {\r\n    /** No outline. */\r\n    None,\r\n    /** 1-pixel-wide outline. */\r\n    Thin,\r\n    /** 2-pixel-wide outline. */\r\n    Thick,\r\n  }\r\n\r\n  /**\r\n   * Describes how the hilite effect is applied to elements within a [[Viewport]].\r\n   * The hilite effect is applied to elements contained in the [[IModelConnection]]'s [[SelectionSet]].\r\n   * It is designed to draw attention to those elements. The effect is produced as follows:\r\n   *  1. All hilited elements are drawn as normal, except that their element color is mixed with the hilite color.\r\n   *  2. The union of the regions of the screen corresponding to hilited elements is computed.\r\n   *  3. A silhouette is drawn using the hilite color around the boundaries of the hilited region. This silhouette is visible behind other geometry.\r\n   *  4. The hilite color is mixed with the color of each pixel within the hilited region. This enables surfaces of hilited geometry to be visible behind other geometry.\r\n   *\r\n   * The Settings allow an application to customize how this effect is applied.\r\n   * @see [[Viewport.hilite]]\r\n   */\r\n  export class Settings {\r\n    /** The color that is used to draw the outline and which is mixed with element color. */\r\n    public readonly color: ColorDef;\r\n    /** The ratio of hilite color to element color used when drawing unobscured portions of hilited geometry, in the range [0, 1].\r\n     * A ratio of 0.0 uses only the element color. A ratio of 1.0 uses only the hilite color. A ratio of 0.5 mixes the hilite color and element color evenly.\r\n     */\r\n    public readonly visibleRatio: number;\r\n    /** The ratio of hilite color to screen color used when drawing the hilited region overtop of the screen contents, in the range [0, 1]. */\r\n    public readonly hiddenRatio: number;\r\n    /** The type of outline to be drawn around the boundaries of the hilited region. */\r\n    public silhouette: Silhouette;\r\n\r\n    private static clamp(value: number) { return Math.min(1.0, Math.max(0.0, value)); }\r\n\r\n    public constructor(color = ColorDef.from(0x23, 0xbb, 0xfc), visibleRatio = 0.25, hiddenRatio = 0.0, silhouette = Silhouette.Thin) {\r\n      this.color = color;\r\n      this.silhouette = silhouette;\r\n      this.visibleRatio = Settings.clamp(visibleRatio);\r\n      this.hiddenRatio = Settings.clamp(hiddenRatio);\r\n    }\r\n  }\r\n\r\n  /** Compare two Settings objects for equivalence. */\r\n  export function equalSettings(lhs: Settings, rhs: Settings): boolean {\r\n    return lhs.color.equals(rhs.color)\r\n      && lhs.visibleRatio === rhs.visibleRatio\r\n      && lhs.hiddenRatio === rhs.hiddenRatio\r\n      && lhs.silhouette === rhs.silhouette;\r\n  }\r\n\r\n  /** Create a copy of a Settings object. */\r\n  export function cloneSettings(settings: Settings): Settings {\r\n    return new Settings(settings.color, settings.visibleRatio, settings.hiddenRatio, settings.silhouette);\r\n  }\r\n}\r\n"]}