@itwin/core-common 3.6.0-dev.54 → 3.6.0-dev.59

package/lib/cjs/EntityReference.d.ts

@@ -1,52 +1,52 @@
-/** @packageDocumentation
- * @module Schema
- */
-import { Id64String } from "@itwin/core-bentley";
-/**
- * Types of concrete entities. Used for storing strings in JavaScript reference-equality containers which encode
- * low-level entity information.
- * @note the values of this enum are unstable, do not depend upon their values between versions of iTwin.js
- *       (e.g. do not serialize them and load them in another version of iTwin.js and expect them to work)
- * CodeSpecs are excepted since their JavaScript representation does not derive from [Entity]($backend)
- * @note the string value of each variant is required/guaranteed to be 1 character
- * @see EntityReference
- * @alpha
- */
-export declare enum ConcreteEntityTypes {
-    Model = "m",
-    Element = "e",
-    ElementAspect = "a",
-    Relationship = "r"
-}
-/**
- * Adds some utilities to the [[ConcreteEntityTypes]] enum
- * @alpha
- */
-export declare namespace ConcreteEntityTypes {
-    /** used by the transformer to figure out where to check for the existence in a db of a concrete element id
-     * @internal
-     */
-    function toBisCoreRootClassFullName(type: ConcreteEntityTypes): string;
-}
-/**
- * This id format can be used for storing a unique key for an entity in containers like `Map`.
- * Elements and non-element entities have different id sequences, they can collide with each other, but not within themselves.
- * @note for utilities that require runtime backend classes, see [EntityReferences]($backend)
- * @alpha
- */
-export declare type EntityReference = `${ConcreteEntityTypes}${Id64String}`;
-/** A set of concrete entity ids, with additional functions to more literately add ids where you have the raw id and know what type it is
- * @alpha
- */
-export declare class EntityReferenceSet extends Set<EntityReference> {
-    addElement(id: Id64String): void;
-    addModel(id: Id64String): void;
-    addAspect(id: Id64String): void;
-    addRelationship(id: Id64String): void;
-}
-/** @internal entity reference type information of a relationship */
-export interface RelTypeInfo {
-    source: ConcreteEntityTypes;
-    target: ConcreteEntityTypes;
-}
+/** @packageDocumentation
+ * @module Schema
+ */
+import { Id64String } from "@itwin/core-bentley";
+/**
+ * Types of concrete entities. Used for storing strings in JavaScript reference-equality containers which encode
+ * low-level entity information.
+ * @note the values of this enum are unstable, do not depend upon their values between versions of iTwin.js
+ *       (e.g. do not serialize them and load them in another version of iTwin.js and expect them to work)
+ * CodeSpecs are excepted since their JavaScript representation does not derive from [Entity]($backend)
+ * @note the string value of each variant is required/guaranteed to be 1 character
+ * @see EntityReference
+ * @alpha
+ */
+export declare enum ConcreteEntityTypes {
+    Model = "m",
+    Element = "e",
+    ElementAspect = "a",
+    Relationship = "r"
+}
+/**
+ * Adds some utilities to the [[ConcreteEntityTypes]] enum
+ * @alpha
+ */
+export declare namespace ConcreteEntityTypes {
+    /** used by the transformer to figure out where to check for the existence in a db of a concrete element id
+     * @internal
+     */
+    function toBisCoreRootClassFullName(type: ConcreteEntityTypes): string;
+}
+/**
+ * This id format can be used for storing a unique key for an entity in containers like `Map`.
+ * Elements and non-element entities have different id sequences, they can collide with each other, but not within themselves.
+ * @note for utilities that require runtime backend classes, see [EntityReferences]($backend)
+ * @alpha
+ */
+export declare type EntityReference = `${ConcreteEntityTypes}${Id64String}`;
+/** A set of concrete entity ids, with additional functions to more literately add ids where you have the raw id and know what type it is
+ * @alpha
+ */
+export declare class EntityReferenceSet extends Set<EntityReference> {
+    addElement(id: Id64String): void;
+    addModel(id: Id64String): void;
+    addAspect(id: Id64String): void;
+    addRelationship(id: Id64String): void;
+}
+/** @internal entity reference type information of a relationship */
+export interface RelTypeInfo {
+    source: ConcreteEntityTypes;
+    target: ConcreteEntityTypes;
+}
 //# sourceMappingURL=EntityReference.d.ts.map

package/lib/cjs/EntityReference.js

@@ -1,57 +1,57 @@
-"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 Schema
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EntityReferenceSet = exports.ConcreteEntityTypes = void 0;
-/**
- * Types of concrete entities. Used for storing strings in JavaScript reference-equality containers which encode
- * low-level entity information.
- * @note the values of this enum are unstable, do not depend upon their values between versions of iTwin.js
- *       (e.g. do not serialize them and load them in another version of iTwin.js and expect them to work)
- * CodeSpecs are excepted since their JavaScript representation does not derive from [Entity]($backend)
- * @note the string value of each variant is required/guaranteed to be 1 character
- * @see EntityReference
- * @alpha
- */
-var ConcreteEntityTypes;
-(function (ConcreteEntityTypes) {
-    ConcreteEntityTypes["Model"] = "m";
-    ConcreteEntityTypes["Element"] = "e";
-    ConcreteEntityTypes["ElementAspect"] = "a";
-    ConcreteEntityTypes["Relationship"] = "r";
-})(ConcreteEntityTypes = exports.ConcreteEntityTypes || (exports.ConcreteEntityTypes = {}));
-/**
- * Adds some utilities to the [[ConcreteEntityTypes]] enum
- * @alpha
- */
-(function (ConcreteEntityTypes) {
-    const toBisCoreRootClassFullNameMap = {
-        [ConcreteEntityTypes.Model]: "BisCore:Model",
-        [ConcreteEntityTypes.Element]: "BisCore:Element",
-        [ConcreteEntityTypes.ElementAspect]: "BisCore:ElementAspect",
-        [ConcreteEntityTypes.Relationship]: "BisCore:Relationship",
-    };
-    /** used by the transformer to figure out where to check for the existence in a db of a concrete element id
-     * @internal
-     */
-    function toBisCoreRootClassFullName(type) {
-        return toBisCoreRootClassFullNameMap[type];
-    }
-    ConcreteEntityTypes.toBisCoreRootClassFullName = toBisCoreRootClassFullName;
-})(ConcreteEntityTypes = exports.ConcreteEntityTypes || (exports.ConcreteEntityTypes = {}));
-/** A set of concrete entity ids, with additional functions to more literately add ids where you have the raw id and know what type it is
- * @alpha
- */
-class EntityReferenceSet extends Set {
-    addElement(id) { this.add(`e${id}`); }
-    addModel(id) { this.add(`m${id}`); }
-    addAspect(id) { this.add(`a${id}`); }
-    addRelationship(id) { this.add(`r${id}`); }
-}
-exports.EntityReferenceSet = EntityReferenceSet;
+"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 Schema
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityReferenceSet = exports.ConcreteEntityTypes = void 0;
+/**
+ * Types of concrete entities. Used for storing strings in JavaScript reference-equality containers which encode
+ * low-level entity information.
+ * @note the values of this enum are unstable, do not depend upon their values between versions of iTwin.js
+ *       (e.g. do not serialize them and load them in another version of iTwin.js and expect them to work)
+ * CodeSpecs are excepted since their JavaScript representation does not derive from [Entity]($backend)
+ * @note the string value of each variant is required/guaranteed to be 1 character
+ * @see EntityReference
+ * @alpha
+ */
+var ConcreteEntityTypes;
+(function (ConcreteEntityTypes) {
+    ConcreteEntityTypes["Model"] = "m";
+    ConcreteEntityTypes["Element"] = "e";
+    ConcreteEntityTypes["ElementAspect"] = "a";
+    ConcreteEntityTypes["Relationship"] = "r";
+})(ConcreteEntityTypes = exports.ConcreteEntityTypes || (exports.ConcreteEntityTypes = {}));
+/**
+ * Adds some utilities to the [[ConcreteEntityTypes]] enum
+ * @alpha
+ */
+(function (ConcreteEntityTypes) {
+    const toBisCoreRootClassFullNameMap = {
+        [ConcreteEntityTypes.Model]: "BisCore:Model",
+        [ConcreteEntityTypes.Element]: "BisCore:Element",
+        [ConcreteEntityTypes.ElementAspect]: "BisCore:ElementAspect",
+        [ConcreteEntityTypes.Relationship]: "BisCore:Relationship",
+    };
+    /** used by the transformer to figure out where to check for the existence in a db of a concrete element id
+     * @internal
+     */
+    function toBisCoreRootClassFullName(type) {
+        return toBisCoreRootClassFullNameMap[type];
+    }
+    ConcreteEntityTypes.toBisCoreRootClassFullName = toBisCoreRootClassFullName;
+})(ConcreteEntityTypes = exports.ConcreteEntityTypes || (exports.ConcreteEntityTypes = {}));
+/** A set of concrete entity ids, with additional functions to more literately add ids where you have the raw id and know what type it is
+ * @alpha
+ */
+class EntityReferenceSet extends Set {
+    addElement(id) { this.add(`e${id}`); }
+    addModel(id) { this.add(`m${id}`); }
+    addAspect(id) { this.add(`a${id}`); }
+    addRelationship(id) { this.add(`r${id}`); }
+}
+exports.EntityReferenceSet = EntityReferenceSet;
 //# sourceMappingURL=EntityReference.js.map

package/lib/cjs/EntityReference.js.map

@@ -1 +1 @@
-{"version":3,"file":"EntityReference.js","sourceRoot":"","sources":["../../src/EntityReference.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;;;;;;;;GASG;AACH,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,kCAAW,CAAA;IACX,oCAAa,CAAA;IACb,0CAAmB,CAAA;IACnB,yCAAkB,CAAA;AACpB,CAAC,EALW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAK9B;AAED;;;GAGG;AACH,WAAiB,mBAAmB;IAClC,MAAM,6BAA6B,GAAG;QACpC,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,eAAe;QAC5C,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,iBAAiB;QAChD,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,uBAAuB;QAC5D,CAAC,mBAAmB,CAAC,YAAY,CAAC,EAAE,sBAAsB;KAClD,CAAC;IAEX;;OAEG;IACH,SAAgB,0BAA0B,CAAC,IAAyB;QAClE,OAAO,6BAA6B,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAFe,8CAA0B,6BAEzC,CAAA;AACH,CAAC,EAdgB,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAcnC;AAUD;;GAEG;AACH,MAAa,kBAAmB,SAAQ,GAAoB;IACnD,UAAU,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAClD,QAAQ,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAChD,SAAS,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IACjD,eAAe,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;CAC/D;AALD,gDAKC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Schema\n */\n\nimport { Id64String } from \"@itwin/core-bentley\";\n\n/**\n * Types of concrete entities. Used for storing strings in JavaScript reference-equality containers which encode\n * low-level entity information.\n * @note the values of this enum are unstable, do not depend upon their values between versions of iTwin.js\n *       (e.g. do not serialize them and load them in another version of iTwin.js and expect them to work)\n * CodeSpecs are excepted since their JavaScript representation does not derive from [Entity]($backend)\n * @note the string value of each variant is required/guaranteed to be 1 character\n * @see EntityReference\n * @alpha\n */\nexport enum ConcreteEntityTypes {\n  Model = \"m\",\n  Element = \"e\",\n  ElementAspect = \"a\",\n  Relationship = \"r\",\n}\n\n/**\n * Adds some utilities to the [[ConcreteEntityTypes]] enum\n * @alpha\n */\nexport namespace ConcreteEntityTypes {\n  const toBisCoreRootClassFullNameMap = {\n    [ConcreteEntityTypes.Model]: \"BisCore:Model\",\n    [ConcreteEntityTypes.Element]: \"BisCore:Element\",\n    [ConcreteEntityTypes.ElementAspect]: \"BisCore:ElementAspect\",\n    [ConcreteEntityTypes.Relationship]: \"BisCore:Relationship\",\n  } as const;\n\n  /** used by the transformer to figure out where to check for the existence in a db of a concrete element id\n   * @internal\n   */\n  export function toBisCoreRootClassFullName(type: ConcreteEntityTypes): string {\n    return toBisCoreRootClassFullNameMap[type];\n  }\n}\n\n/**\n * This id format can be used for storing a unique key for an entity in containers like `Map`.\n * Elements and non-element entities have different id sequences, they can collide with each other, but not within themselves.\n * @note for utilities that require runtime backend classes, see [EntityReferences]($backend)\n * @alpha\n */\nexport type EntityReference = `${ConcreteEntityTypes}${Id64String}`;\n\n/** A set of concrete entity ids, with additional functions to more literately add ids where you have the raw id and know what type it is\n * @alpha\n */\nexport class EntityReferenceSet extends Set<EntityReference> {\n  public addElement(id: Id64String) { this.add(`e${id}`); }\n  public addModel(id: Id64String) { this.add(`m${id}`); }\n  public addAspect(id: Id64String) { this.add(`a${id}`); }\n  public addRelationship(id: Id64String) { this.add(`r${id}`); }\n}\n\n/** @internal entity reference type information of a relationship */\nexport interface RelTypeInfo {\n  source: ConcreteEntityTypes;\n  target: ConcreteEntityTypes;\n}\n"]}
+{"version":3,"file":"EntityReference.js","sourceRoot":"","sources":["../../src/EntityReference.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;;;;;;;;GASG;AACH,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,kCAAW,CAAA;IACX,oCAAa,CAAA;IACb,0CAAmB,CAAA;IACnB,yCAAkB,CAAA;AACpB,CAAC,EALW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAK9B;AAED;;;GAGG;AACH,WAAiB,mBAAmB;IAClC,MAAM,6BAA6B,GAAG;QACpC,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,eAAe;QAC5C,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,iBAAiB;QAChD,CAAC,mBAAmB,CAAC,aAAa,CAAC,EAAE,uBAAuB;QAC5D,CAAC,mBAAmB,CAAC,YAAY,CAAC,EAAE,sBAAsB;KAClD,CAAC;IAEX;;OAEG;IACH,SAAgB,0BAA0B,CAAC,IAAyB;QAClE,OAAO,6BAA6B,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAFe,8CAA0B,6BAEzC,CAAA;AACH,CAAC,EAdgB,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAcnC;AAUD;;GAEG;AACH,MAAa,kBAAmB,SAAQ,GAAoB;IACnD,UAAU,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAClD,QAAQ,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAChD,SAAS,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IACjD,eAAe,CAAC,EAAc,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;CAC/D;AALD,gDAKC","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 Schema\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\n\r\n/**\r\n * Types of concrete entities. Used for storing strings in JavaScript reference-equality containers which encode\r\n * low-level entity information.\r\n * @note the values of this enum are unstable, do not depend upon their values between versions of iTwin.js\r\n *       (e.g. do not serialize them and load them in another version of iTwin.js and expect them to work)\r\n * CodeSpecs are excepted since their JavaScript representation does not derive from [Entity]($backend)\r\n * @note the string value of each variant is required/guaranteed to be 1 character\r\n * @see EntityReference\r\n * @alpha\r\n */\r\nexport enum ConcreteEntityTypes {\r\n  Model = \"m\",\r\n  Element = \"e\",\r\n  ElementAspect = \"a\",\r\n  Relationship = \"r\",\r\n}\r\n\r\n/**\r\n * Adds some utilities to the [[ConcreteEntityTypes]] enum\r\n * @alpha\r\n */\r\nexport namespace ConcreteEntityTypes {\r\n  const toBisCoreRootClassFullNameMap = {\r\n    [ConcreteEntityTypes.Model]: \"BisCore:Model\",\r\n    [ConcreteEntityTypes.Element]: \"BisCore:Element\",\r\n    [ConcreteEntityTypes.ElementAspect]: \"BisCore:ElementAspect\",\r\n    [ConcreteEntityTypes.Relationship]: \"BisCore:Relationship\",\r\n  } as const;\r\n\r\n  /** used by the transformer to figure out where to check for the existence in a db of a concrete element id\r\n   * @internal\r\n   */\r\n  export function toBisCoreRootClassFullName(type: ConcreteEntityTypes): string {\r\n    return toBisCoreRootClassFullNameMap[type];\r\n  }\r\n}\r\n\r\n/**\r\n * This id format can be used for storing a unique key for an entity in containers like `Map`.\r\n * Elements and non-element entities have different id sequences, they can collide with each other, but not within themselves.\r\n * @note for utilities that require runtime backend classes, see [EntityReferences]($backend)\r\n * @alpha\r\n */\r\nexport type EntityReference = `${ConcreteEntityTypes}${Id64String}`;\r\n\r\n/** A set of concrete entity ids, with additional functions to more literately add ids where you have the raw id and know what type it is\r\n * @alpha\r\n */\r\nexport class EntityReferenceSet extends Set<EntityReference> {\r\n  public addElement(id: Id64String) { this.add(`e${id}`); }\r\n  public addModel(id: Id64String) { this.add(`m${id}`); }\r\n  public addAspect(id: Id64String) { this.add(`a${id}`); }\r\n  public addRelationship(id: Id64String) { this.add(`r${id}`); }\r\n}\r\n\r\n/** @internal entity reference type information of a relationship */\r\nexport interface RelTypeInfo {\r\n  source: ConcreteEntityTypes;\r\n  target: ConcreteEntityTypes;\r\n}\r\n"]}

package/lib/cjs/Environment.d.ts

@@ -1,62 +1,62 @@
-/** @packageDocumentation
- * @module DisplayStyles
- */
-import { NonFunctionPropertiesOf } from "@itwin/core-bentley";
-import { GroundPlane, GroundPlaneProps } from "./GroundPlane";
-import { SkyBox, SkyBoxProps } from "./SkyBox";
-/** JSON representation of an [[Environment]].
- * @see [[DisplayStyle3dSettingsProps.environment]].
- * @public
- * @extensions
- */
-export interface EnvironmentProps {
-    /** See [[Environment.ground]] and [[Environment.displayGround]]. */
-    ground?: GroundPlaneProps;
-    /** See [[Environment.sky]] and [[Environment.displaySky]]. */
-    sky?: SkyBoxProps;
-}
-/** A type containing all of the properties of [[Environment]] with none of the methods and with the `readonly` modifiers removed.
- * @see [[Environment.create]] and [[Environment.clone]].
- * @public
- */
-export declare type EnvironmentProperties = NonFunctionPropertiesOf<Environment>;
-/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the
- * outdoor environment.
- * @see [[DisplayStyle3dSettings.environment]].
- * @public
- */
-export declare class Environment {
-    /** If true, the sky box will be displayed.
-     * Default: false.
-     * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleSkyBox]] to change this.
-     */
-    readonly displaySky: boolean;
-    /** If true, the ground plane will be displayed.
-     * Default: false.
-     * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleGroundPlane]] to change this.
-     */
-    readonly displayGround: boolean;
-    /** Describes how the sky box should be drawn. */
-    readonly sky: SkyBox;
-    /** Describes how the ground plane should be drawn. */
-    readonly ground: GroundPlane;
-    protected constructor(props?: Partial<EnvironmentProperties>);
-    /** Default settings with neither ground plane nor sky box displayed. */
-    static readonly defaults: Environment;
-    /** Create a new Environment. Any properties not specified by `props` will be initialized to their default values. */
-    static create(props?: Partial<EnvironmentProperties>): Environment;
-    /** Create a copy of this environment, changing the `displayGround` and/or `displaySky` flags. */
-    withDisplay(display: {
-        sky?: boolean;
-        ground?: boolean;
-    }): Environment;
-    /** Convert to JSON representation. */
-    toJSON(): EnvironmentProps;
-    /** Create from JSON representation. */
-    static fromJSON(props?: EnvironmentProps): Environment;
-    /** Create a copy of this environment, identical except for any properties specified by `changedProps`.
-     * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.
-     */
-    clone(changedProps?: Partial<EnvironmentProperties>): Environment;
-}
+/** @packageDocumentation
+ * @module DisplayStyles
+ */
+import { NonFunctionPropertiesOf } from "@itwin/core-bentley";
+import { GroundPlane, GroundPlaneProps } from "./GroundPlane";
+import { SkyBox, SkyBoxProps } from "./SkyBox";
+/** JSON representation of an [[Environment]].
+ * @see [[DisplayStyle3dSettingsProps.environment]].
+ * @public
+ * @extensions
+ */
+export interface EnvironmentProps {
+    /** See [[Environment.ground]] and [[Environment.displayGround]]. */
+    ground?: GroundPlaneProps;
+    /** See [[Environment.sky]] and [[Environment.displaySky]]. */
+    sky?: SkyBoxProps;
+}
+/** A type containing all of the properties of [[Environment]] with none of the methods and with the `readonly` modifiers removed.
+ * @see [[Environment.create]] and [[Environment.clone]].
+ * @public
+ */
+export declare type EnvironmentProperties = NonFunctionPropertiesOf<Environment>;
+/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the
+ * outdoor environment.
+ * @see [[DisplayStyle3dSettings.environment]].
+ * @public
+ */
+export declare class Environment {
+    /** If true, the sky box will be displayed.
+     * Default: false.
+     * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleSkyBox]] to change this.
+     */
+    readonly displaySky: boolean;
+    /** If true, the ground plane will be displayed.
+     * Default: false.
+     * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleGroundPlane]] to change this.
+     */
+    readonly displayGround: boolean;
+    /** Describes how the sky box should be drawn. */
+    readonly sky: SkyBox;
+    /** Describes how the ground plane should be drawn. */
+    readonly ground: GroundPlane;
+    protected constructor(props?: Partial<EnvironmentProperties>);
+    /** Default settings with neither ground plane nor sky box displayed. */
+    static readonly defaults: Environment;
+    /** Create a new Environment. Any properties not specified by `props` will be initialized to their default values. */
+    static create(props?: Partial<EnvironmentProperties>): Environment;
+    /** Create a copy of this environment, changing the `displayGround` and/or `displaySky` flags. */
+    withDisplay(display: {
+        sky?: boolean;
+        ground?: boolean;
+    }): Environment;
+    /** Convert to JSON representation. */
+    toJSON(): EnvironmentProps;
+    /** Create from JSON representation. */
+    static fromJSON(props?: EnvironmentProps): Environment;
+    /** Create a copy of this environment, identical except for any properties specified by `changedProps`.
+     * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.
+     */
+    clone(changedProps?: Partial<EnvironmentProperties>): Environment;
+}
 //# sourceMappingURL=Environment.d.ts.map

package/lib/cjs/Environment.js

@@ -1,74 +1,74 @@
-"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 DisplayStyles
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Environment = void 0;
-const GroundPlane_1 = require("./GroundPlane");
-const SkyBox_1 = require("./SkyBox");
-/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the
- * outdoor environment.
- * @see [[DisplayStyle3dSettings.environment]].
- * @public
- */
-class Environment {
-    constructor(props) {
-        var _a, _b, _c, _d;
-        this.displaySky = (_a = props === null || props === void 0 ? void 0 : props.displaySky) !== null && _a !== void 0 ? _a : false;
-        this.displayGround = (_b = props === null || props === void 0 ? void 0 : props.displayGround) !== null && _b !== void 0 ? _b : false;
-        this.sky = (_c = props === null || props === void 0 ? void 0 : props.sky) !== null && _c !== void 0 ? _c : SkyBox_1.SkyBox.defaults;
-        this.ground = (_d = props === null || props === void 0 ? void 0 : props.ground) !== null && _d !== void 0 ? _d : GroundPlane_1.GroundPlane.defaults;
-    }
-    /** Create a new Environment. Any properties not specified by `props` will be initialized to their default values. */
-    static create(props) {
-        return props ? new this(props) : this.defaults;
-    }
-    /** Create a copy of this environment, changing the `displayGround` and/or `displaySky` flags. */
-    withDisplay(display) {
-        var _a, _b;
-        const displaySky = (_a = display.sky) !== null && _a !== void 0 ? _a : this.displaySky;
-        const displayGround = (_b = display.ground) !== null && _b !== void 0 ? _b : this.displayGround;
-        if (displaySky === this.displaySky && displayGround === this.displayGround)
-            return this;
-        return Environment.create({
-            ...this,
-            displaySky: displaySky !== null && displaySky !== void 0 ? displaySky : this.displaySky,
-            displayGround: displayGround !== null && displayGround !== void 0 ? displayGround : this.displayGround,
-        });
-    }
-    /** Convert to JSON representation. */
-    toJSON() {
-        return {
-            sky: this.sky.toJSON(this.displaySky),
-            ground: this.ground.toJSON(this.displayGround),
-        };
-    }
-    /** Create from JSON representation. */
-    static fromJSON(props) {
-        var _a, _b;
-        if (!props)
-            return this.defaults;
-        return new this({
-            displaySky: (_a = props === null || props === void 0 ? void 0 : props.sky) === null || _a === void 0 ? void 0 : _a.display,
-            displayGround: (_b = props === null || props === void 0 ? void 0 : props.ground) === null || _b === void 0 ? void 0 : _b.display,
-            sky: (props === null || props === void 0 ? void 0 : props.sky) ? SkyBox_1.SkyBox.fromJSON(props.sky) : undefined,
-            ground: (props === null || props === void 0 ? void 0 : props.ground) ? GroundPlane_1.GroundPlane.fromJSON(props.ground) : undefined,
-        });
-    }
-    /** Create a copy of this environment, identical except for any properties specified by `changedProps`.
-     * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.
-     */
-    clone(changedProps) {
-        if (!changedProps)
-            return this;
-        return Environment.create({ ...this, ...changedProps });
-    }
-}
-exports.Environment = Environment;
-/** Default settings with neither ground plane nor sky box displayed. */
-Environment.defaults = new Environment();
+"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 DisplayStyles
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Environment = void 0;
+const GroundPlane_1 = require("./GroundPlane");
+const SkyBox_1 = require("./SkyBox");
+/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the
+ * outdoor environment.
+ * @see [[DisplayStyle3dSettings.environment]].
+ * @public
+ */
+class Environment {
+    constructor(props) {
+        var _a, _b, _c, _d;
+        this.displaySky = (_a = props === null || props === void 0 ? void 0 : props.displaySky) !== null && _a !== void 0 ? _a : false;
+        this.displayGround = (_b = props === null || props === void 0 ? void 0 : props.displayGround) !== null && _b !== void 0 ? _b : false;
+        this.sky = (_c = props === null || props === void 0 ? void 0 : props.sky) !== null && _c !== void 0 ? _c : SkyBox_1.SkyBox.defaults;
+        this.ground = (_d = props === null || props === void 0 ? void 0 : props.ground) !== null && _d !== void 0 ? _d : GroundPlane_1.GroundPlane.defaults;
+    }
+    /** Create a new Environment. Any properties not specified by `props` will be initialized to their default values. */
+    static create(props) {
+        return props ? new this(props) : this.defaults;
+    }
+    /** Create a copy of this environment, changing the `displayGround` and/or `displaySky` flags. */
+    withDisplay(display) {
+        var _a, _b;
+        const displaySky = (_a = display.sky) !== null && _a !== void 0 ? _a : this.displaySky;
+        const displayGround = (_b = display.ground) !== null && _b !== void 0 ? _b : this.displayGround;
+        if (displaySky === this.displaySky && displayGround === this.displayGround)
+            return this;
+        return Environment.create({
+            ...this,
+            displaySky: displaySky !== null && displaySky !== void 0 ? displaySky : this.displaySky,
+            displayGround: displayGround !== null && displayGround !== void 0 ? displayGround : this.displayGround,
+        });
+    }
+    /** Convert to JSON representation. */
+    toJSON() {
+        return {
+            sky: this.sky.toJSON(this.displaySky),
+            ground: this.ground.toJSON(this.displayGround),
+        };
+    }
+    /** Create from JSON representation. */
+    static fromJSON(props) {
+        var _a, _b;
+        if (!props)
+            return this.defaults;
+        return new this({
+            displaySky: (_a = props === null || props === void 0 ? void 0 : props.sky) === null || _a === void 0 ? void 0 : _a.display,
+            displayGround: (_b = props === null || props === void 0 ? void 0 : props.ground) === null || _b === void 0 ? void 0 : _b.display,
+            sky: (props === null || props === void 0 ? void 0 : props.sky) ? SkyBox_1.SkyBox.fromJSON(props.sky) : undefined,
+            ground: (props === null || props === void 0 ? void 0 : props.ground) ? GroundPlane_1.GroundPlane.fromJSON(props.ground) : undefined,
+        });
+    }
+    /** Create a copy of this environment, identical except for any properties specified by `changedProps`.
+     * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.
+     */
+    clone(changedProps) {
+        if (!changedProps)
+            return this;
+        return Environment.create({ ...this, ...changedProps });
+    }
+}
+exports.Environment = Environment;
+/** Default settings with neither ground plane nor sky box displayed. */
+Environment.defaults = new Environment();
 //# sourceMappingURL=Environment.js.map

package/lib/cjs/Environment.js.map

@@ -1 +1 @@
-{"version":3,"file":"Environment.js","sourceRoot":"","sources":["../../src/Environment.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,+CAA8D;AAC9D,qCAA+C;AAoB/C;;;;GAIG;AACH,MAAa,WAAW;IAgBtB,YAAsB,KAAsC;;QAC1D,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,mCAAI,KAAK,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,aAAa,mCAAI,KAAK,CAAC;QACnD,IAAI,CAAC,GAAG,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,mCAAI,eAAM,CAAC,QAAQ,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,mCAAI,yBAAW,CAAC,QAAQ,CAAC;IACtD,CAAC;IAKD,qHAAqH;IAC9G,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,iGAAiG;IAC1F,WAAW,CAAC,OAA4C;;QAC7D,MAAM,UAAU,GAAG,MAAA,OAAO,CAAC,GAAG,mCAAI,IAAI,CAAC,UAAU,CAAC;QAClD,MAAM,aAAa,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,IAAI,CAAC,aAAa,CAAC;QAC3D,IAAI,UAAU,KAAK,IAAI,CAAC,UAAU,IAAI,aAAa,KAAK,IAAI,CAAC,aAAa;YACxE,OAAO,IAAI,CAAC;QAEd,OAAO,WAAW,CAAC,MAAM,CAAC;YACxB,GAAG,IAAI;YACP,UAAU,EAAE,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,IAAI,CAAC,UAAU;YACzC,aAAa,EAAE,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,IAAI,CAAC,aAAa;SACnD,CAAC,CAAC;IACL,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;YACrC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;SAC/C,CAAC;IACJ,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAwB;;QAC7C,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,IAAI,CAAC;YACd,UAAU,EAAE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,0CAAE,OAAO;YAC/B,aAAa,EAAE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,0CAAE,OAAO;YACrC,GAAG,EAAE,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,EAAC,CAAC,CAAC,eAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;YACxD,MAAM,EAAE,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,EAAC,CAAC,CAAC,yBAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;SACvE,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAA6C;QACxD,IAAI,CAAC,YAAY;YACf,OAAO,IAAI,CAAC;QAEd,OAAO,WAAW,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IAC1D,CAAC;;AA1EH,kCA2EC;AApDC,wEAAwE;AACjD,oBAAQ,GAAG,IAAI,WAAW,EAAE,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { NonFunctionPropertiesOf } from \"@itwin/core-bentley\";\nimport { GroundPlane, GroundPlaneProps } from \"./GroundPlane\";\nimport { SkyBox, SkyBoxProps } from \"./SkyBox\";\n\n/** JSON representation of an [[Environment]].\n * @see [[DisplayStyle3dSettingsProps.environment]].\n * @public\n * @extensions\n */\nexport interface EnvironmentProps {\n  /** See [[Environment.ground]] and [[Environment.displayGround]]. */\n  ground?: GroundPlaneProps;\n  /** See [[Environment.sky]] and [[Environment.displaySky]]. */\n  sky?: SkyBoxProps;\n}\n\n/** A type containing all of the properties of [[Environment]] with none of the methods and with the `readonly` modifiers removed.\n * @see [[Environment.create]] and [[Environment.clone]].\n * @public\n */\nexport type EnvironmentProperties = NonFunctionPropertiesOf<Environment>;\n\n/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the\n * outdoor environment.\n * @see [[DisplayStyle3dSettings.environment]].\n * @public\n */\nexport class Environment {\n  /** If true, the sky box will be displayed.\n   * Default: false.\n   * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleSkyBox]] to change this.\n   */\n  public readonly displaySky: boolean;\n  /** If true, the ground plane will be displayed.\n   * Default: false.\n   * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleGroundPlane]] to change this.\n   */\n  public readonly displayGround: boolean;\n  /** Describes how the sky box should be drawn. */\n  public readonly sky: SkyBox;\n  /** Describes how the ground plane should be drawn. */\n  public readonly ground: GroundPlane;\n\n  protected constructor(props?: Partial<EnvironmentProperties>) {\n    this.displaySky = props?.displaySky ?? false;\n    this.displayGround = props?.displayGround ?? false;\n    this.sky = props?.sky ?? SkyBox.defaults;\n    this.ground = props?.ground ?? GroundPlane.defaults;\n  }\n\n  /** Default settings with neither ground plane nor sky box displayed. */\n  public static readonly defaults = new Environment();\n\n  /** Create a new Environment. Any properties not specified by `props` will be initialized to their default values. */\n  public static create(props?: Partial<EnvironmentProperties>): Environment {\n    return props ? new this(props) : this.defaults;\n  }\n\n  /** Create a copy of this environment, changing the `displayGround` and/or `displaySky` flags. */\n  public withDisplay(display: { sky?: boolean, ground?: boolean }): Environment {\n    const displaySky = display.sky ?? this.displaySky;\n    const displayGround = display.ground ?? this.displayGround;\n    if (displaySky === this.displaySky && displayGround === this.displayGround)\n      return this;\n\n    return Environment.create({\n      ...this,\n      displaySky: displaySky ?? this.displaySky,\n      displayGround: displayGround ?? this.displayGround,\n    });\n  }\n\n  /** Convert to JSON representation. */\n  public toJSON(): EnvironmentProps {\n    return {\n      sky: this.sky.toJSON(this.displaySky),\n      ground: this.ground.toJSON(this.displayGround),\n    };\n  }\n\n  /** Create from JSON representation. */\n  public static fromJSON(props?: EnvironmentProps): Environment {\n    if (!props)\n      return this.defaults;\n\n    return new this({\n      displaySky: props?.sky?.display,\n      displayGround: props?.ground?.display,\n      sky: props?.sky ? SkyBox.fromJSON(props.sky) : undefined,\n      ground: props?.ground ? GroundPlane.fromJSON(props.ground) : undefined,\n    });\n  }\n\n  /** Create a copy of this environment, identical except for any properties specified by `changedProps`.\n   * Any properties of `changedProps` explicitly set to `undefined` will be reset to their default values.\n   */\n  public clone(changedProps?: Partial<EnvironmentProperties>): Environment {\n    if (!changedProps)\n      return this;\n\n    return Environment.create({ ...this, ...changedProps });\n  }\n}\n"]}
+{"version":3,"file":"Environment.js","sourceRoot":"","sources":["../../src/Environment.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,+CAA8D;AAC9D,qCAA+C;AAoB/C;;;;GAIG;AACH,MAAa,WAAW;IAgBtB,YAAsB,KAAsC;;QAC1D,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,mCAAI,KAAK,CAAC;QAC7C,IAAI,CAAC,aAAa,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,aAAa,mCAAI,KAAK,CAAC;QACnD,IAAI,CAAC,GAAG,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,mCAAI,eAAM,CAAC,QAAQ,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,mCAAI,yBAAW,CAAC,QAAQ,CAAC;IACtD,CAAC;IAKD,qHAAqH;IAC9G,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,iGAAiG;IAC1F,WAAW,CAAC,OAA4C;;QAC7D,MAAM,UAAU,GAAG,MAAA,OAAO,CAAC,GAAG,mCAAI,IAAI,CAAC,UAAU,CAAC;QAClD,MAAM,aAAa,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,IAAI,CAAC,aAAa,CAAC;QAC3D,IAAI,UAAU,KAAK,IAAI,CAAC,UAAU,IAAI,aAAa,KAAK,IAAI,CAAC,aAAa;YACxE,OAAO,IAAI,CAAC;QAEd,OAAO,WAAW,CAAC,MAAM,CAAC;YACxB,GAAG,IAAI;YACP,UAAU,EAAE,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,IAAI,CAAC,UAAU;YACzC,aAAa,EAAE,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,IAAI,CAAC,aAAa;SACnD,CAAC,CAAC;IACL,CAAC;IAED,sCAAsC;IAC/B,MAAM;QACX,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;YACrC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC;SAC/C,CAAC;IACJ,CAAC;IAED,uCAAuC;IAChC,MAAM,CAAC,QAAQ,CAAC,KAAwB;;QAC7C,IAAI,CAAC,KAAK;YACR,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,IAAI,CAAC;YACd,UAAU,EAAE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,0CAAE,OAAO;YAC/B,aAAa,EAAE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,0CAAE,OAAO;YACrC,GAAG,EAAE,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,EAAC,CAAC,CAAC,eAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;YACxD,MAAM,EAAE,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,EAAC,CAAC,CAAC,yBAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;SACvE,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAA6C;QACxD,IAAI,CAAC,YAAY;YACf,OAAO,IAAI,CAAC;QAEd,OAAO,WAAW,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IAC1D,CAAC;;AA1EH,kCA2EC;AApDC,wEAAwE;AACjD,oBAAQ,GAAG,IAAI,WAAW,EAAE,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { NonFunctionPropertiesOf } from \"@itwin/core-bentley\";\r\nimport { GroundPlane, GroundPlaneProps } from \"./GroundPlane\";\r\nimport { SkyBox, SkyBoxProps } from \"./SkyBox\";\r\n\r\n/** JSON representation of an [[Environment]].\r\n * @see [[DisplayStyle3dSettingsProps.environment]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface EnvironmentProps {\r\n  /** See [[Environment.ground]] and [[Environment.displayGround]]. */\r\n  ground?: GroundPlaneProps;\r\n  /** See [[Environment.sky]] and [[Environment.displaySky]]. */\r\n  sky?: SkyBoxProps;\r\n}\r\n\r\n/** A type containing all of the properties of [[Environment]] with none of the methods and with the `readonly` modifiers removed.\r\n * @see [[Environment.create]] and [[Environment.clone]].\r\n * @public\r\n */\r\nexport type EnvironmentProperties = NonFunctionPropertiesOf<Environment>;\r\n\r\n/** As part of a [[DisplayStyle3dSettings]], controls the display of a [[SkyBox]] and [[GroundPlane]] to simulate the\r\n * outdoor environment.\r\n * @see [[DisplayStyle3dSettings.environment]].\r\n * @public\r\n */\r\nexport class Environment {\r\n  /** If true, the sky box will be displayed.\r\n   * Default: false.\r\n   * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleSkyBox]] to change this.\r\n   */\r\n  public readonly displaySky: boolean;\r\n  /** If true, the ground plane will be displayed.\r\n   * Default: false.\r\n   * @see [[withDisplay]] or [[DisplayStyle3dSettings.toggleGroundPlane]] to change this.\r\n   */\r\n  public readonly displayGround: boolean;\r\n  /** Describes how the sky box should be drawn. */\r\n  public readonly sky: SkyBox;\r\n  /** Describes how the ground plane should be drawn. */\r\n  public readonly ground: GroundPlane;\r\n\r\n  protected constructor(props?: Partial<EnvironmentProperties>) {\r\n    this.displaySky = props?.displaySky ?? false;\r\n    this.displayGround = props?.displayGround ?? false;\r\n    this.sky = props?.sky ?? SkyBox.defaults;\r\n    this.ground = props?.ground ?? GroundPlane.defaults;\r\n  }\r\n\r\n  /** Default settings with neither ground plane nor sky box displayed. */\r\n  public static readonly defaults = new Environment();\r\n\r\n  /** Create a new Environment. Any properties not specified by `props` will be initialized to their default values. */\r\n  public static create(props?: Partial<EnvironmentProperties>): Environment {\r\n    return props ? new this(props) : this.defaults;\r\n  }\r\n\r\n  /** Create a copy of this environment, changing the `displayGround` and/or `displaySky` flags. */\r\n  public withDisplay(display: { sky?: boolean, ground?: boolean }): Environment {\r\n    const displaySky = display.sky ?? this.displaySky;\r\n    const displayGround = display.ground ?? this.displayGround;\r\n    if (displaySky === this.displaySky && displayGround === this.displayGround)\r\n      return this;\r\n\r\n    return Environment.create({\r\n      ...this,\r\n      displaySky: displaySky ?? this.displaySky,\r\n      displayGround: displayGround ?? this.displayGround,\r\n    });\r\n  }\r\n\r\n  /** Convert to JSON representation. */\r\n  public toJSON(): EnvironmentProps {\r\n    return {\r\n      sky: this.sky.toJSON(this.displaySky),\r\n      ground: this.ground.toJSON(this.displayGround),\r\n    };\r\n  }\r\n\r\n  /** Create from JSON representation. */\r\n  public static fromJSON(props?: EnvironmentProps): Environment {\r\n    if (!props)\r\n      return this.defaults;\r\n\r\n    return new this({\r\n      displaySky: props?.sky?.display,\r\n      displayGround: props?.ground?.display,\r\n      sky: props?.sky ? SkyBox.fromJSON(props.sky) : undefined,\r\n      ground: props?.ground ? GroundPlane.fromJSON(props.ground) : undefined,\r\n    });\r\n  }\r\n\r\n  /** Create a copy of this environment, identical except for any properties 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?: Partial<EnvironmentProperties>): Environment {\r\n    if (!changedProps)\r\n      return this;\r\n\r\n    return Environment.create({ ...this, ...changedProps });\r\n  }\r\n}\r\n"]}

package/lib/cjs/FeatureIndex.d.ts

@@ -1,40 +1,40 @@
-/** @packageDocumentation
- * @module Rendering
- */
-import { ColorDef } from "./ColorDef";
-/** @internal */
-export declare class NonUniformColor {
-    readonly colors: Uint32Array;
-    readonly indices: Uint16Array;
-    readonly isOpaque: boolean;
-    constructor(colors: Uint32Array, indices: number[], hasAlpha: boolean);
-}
-/** @internal */
-export declare class ColorIndex {
-    private _color;
-    get hasAlpha(): boolean;
-    get isUniform(): boolean;
-    get numColors(): number;
-    constructor();
-    reset(): void;
-    get uniform(): ColorDef | undefined;
-    initUniform(color: ColorDef | number): void;
-    get nonUniform(): NonUniformColor | undefined;
-    initNonUniform(colors: Uint32Array, indices: number[], hasAlpha: boolean): void;
-}
-/** @internal */
-export declare enum FeatureIndexType {
-    Empty = 0,
-    Uniform = 1,
-    NonUniform = 2
-}
-/** @internal */
-export declare class FeatureIndex {
-    type: FeatureIndexType;
-    featureID: number;
-    featureIDs?: Uint32Array;
-    get isUniform(): boolean;
-    get isEmpty(): boolean;
-    reset(): void;
-}
+/** @packageDocumentation
+ * @module Rendering
+ */
+import { ColorDef } from "./ColorDef";
+/** @internal */
+export declare class NonUniformColor {
+    readonly colors: Uint32Array;
+    readonly indices: Uint16Array;
+    readonly isOpaque: boolean;
+    constructor(colors: Uint32Array, indices: number[], hasAlpha: boolean);
+}
+/** @internal */
+export declare class ColorIndex {
+    private _color;
+    get hasAlpha(): boolean;
+    get isUniform(): boolean;
+    get numColors(): number;
+    constructor();
+    reset(): void;
+    get uniform(): ColorDef | undefined;
+    initUniform(color: ColorDef | number): void;
+    get nonUniform(): NonUniformColor | undefined;
+    initNonUniform(colors: Uint32Array, indices: number[], hasAlpha: boolean): void;
+}
+/** @internal */
+export declare enum FeatureIndexType {
+    Empty = 0,
+    Uniform = 1,
+    NonUniform = 2
+}
+/** @internal */
+export declare class FeatureIndex {
+    type: FeatureIndexType;
+    featureID: number;
+    featureIDs?: Uint32Array;
+    get isUniform(): boolean;
+    get isEmpty(): boolean;
+    reset(): void;
+}
 //# sourceMappingURL=FeatureIndex.d.ts.map