@itwin/core-common 4.0.0-dev.44 → 4.0.0-dev.48

package/lib/cjs/MaterialProps.d.ts

@@ -1,154 +1,154 @@
-/** @packageDocumentation
- * @module Rendering
- */
-import { Id64String } from "@itwin/core-bentley";
-import { DefinitionElementProps } from "./ElementProps";
-import { TextureMapping } from "./TextureMapping";
-/** Describes a color as an array of three numbers ranging from 0 to 1 where the first entry corresponds to the color's red component,
- * the second to green, and the third to blue.
- * @see usage in [[RenderMaterialAssetProps]].
- * @public
- * @extensions
- */
-export declare type RgbFactorProps = number[];
-/** A 2d point specified as an array of 2 numbers [x, y].
- * @see usage in [[TextureMapProps]].
- * @public
- * @extensions
- */
-export declare type Point2dProps = number[];
-/** Describes the units in which a [[TextureMapProps]]' scale is expressed.
- * @public
- * @extensions
- */
-export declare enum TextureMapUnits {
-    /** Indicates the scale has no units. */
-    Relative = 0,
-    Meters = 3,
-    Millimeters = 4,
-    Feet = 5,
-    Inches = 6
-}
-/** As part of a [[RenderMaterialAssetProps]], describes how to map a [[RenderTexture]]'s image to the triangles of a mesh to which the material is applied.
- * @see [[RenderMaterialAssetMapsProps]] for the supported types of texture mappings.
- * @public
- * @extensions
- */
-export interface TextureMapProps {
-    /** Angle in degrees to rotate texture when applying; defaults to 0.0 if undefined */
-    pattern_angle?: number;
-    /** If true, flip the pattern map in U; if undefined, defaults to false */
-    pattern_u_flip?: boolean;
-    /** If true, flip the pattern map in V; if undefined, defaults to false */
-    pattern_flip?: boolean;
-    /** X, Y scale to apply to the pattern map; if undefined, defaults to {0,0}, which is almost never useful. */
-    pattern_scale?: Point2dProps;
-    /** X, Y offset to apply to the pattern map; if undefined, defaults to {0,0} */
-    pattern_offset?: Point2dProps;
-    /** Units to use when applying the scaling; if undefined, defaults to [[TextureMapUnits.Relative]] */
-    pattern_scalemode?: TextureMapUnits;
-    /** Mapping mode to use for the texture application; if undefined, defaults to [[TextureMapping.Mode.Parametric]] */
-    pattern_mapping?: TextureMapping.Mode;
-    /** Weight at which to combine diffuse image and color; if undefined, defaults to 1.0 */
-    pattern_weight?: number;
-    /** The Id of the persistent [Texture]($backend) element defining the texture image. */
-    TextureId: Id64String;
-}
-/** Flags applied to a [[NormalMapProps]]. The enum values can be combined using bitwise operators.
- * @public
- */
-export declare enum NormalMapFlags {
-    /** No special flags. */
-    None = 0,
-    /** Indicates that the Y component of each vector - stored in the texture's green channel - points upward along the positive Y axis and should
-     * be negated. By default it points downward.
-     */
-    GreenUp = 1
-}
-/** Describes how to apply [normal mapping](https://en.wikipedia.org/wiki/Normal_mapping) to a surface material.
- * @see [[RenderMaterialAssetMapsProps.Normal]] to define a normal map for a [[RenderMaterialAssetProps]].
- * @public
- */
-export interface NormalMapProps extends TextureMapProps {
-    /** Flags controlling how the normal map is applied. Default: [[NormalMapFlags.None]]. */
-    NormalFlags?: NormalMapFlags;
-}
-/** Describes different types of textures to be applied to a surface material to alter its appearance.
- * @note While technically both [[Pattern]] and [[Normal]] can define their own mapping parameters (`pattern_angle`, `pattern_mapping`, etc), in practice
- * if both maps are present they are expected to have identical mapping parameters, with the exception of `TextureId`.
- * @see [[RenderMaterialAssetProps.Map]] to define the texture maps for a material asset.
- * @public
- */
-export interface RenderMaterialAssetMapsProps {
-    /** Maps an image describing the diffuse color of the surface, replacing or mixing with the surface's own color. */
-    Pattern?: TextureMapProps;
-    /** Maps a [normal map](https://en.wikipedia.org/wiki/Normal_mapping) to the surface, simulating more complex surface details than are
-     * present in the surface's geometry.
-     */
-    Normal?: NormalMapProps;
-}
-/** Describes the graphical properties of a [RenderMaterialElement]($backend) as part of a [[RenderMaterialProps]].
- * This representation is used to persist the material properties into the [IModelDb]($backend), but is unwieldy and verbose.
- * @see [RenderMaterialElementParams]($backend) for a somewhat more ergonomic representation.
- * @public
- * @extensions
- */
-export interface RenderMaterialAssetProps {
-    /** If true, this material has a fill/diffuse color; if undefined, defaults to false */
-    HasBaseColor?: boolean;
-    /** Surface color used for fill or diffuse illumination; if undefined, defaults to black */
-    color?: RgbFactorProps;
-    /** If true, this material has a specular color; if undefined, defaults to false */
-    HasSpecularColor?: boolean;
-    /** Surface color used for specular illumination; if undefined, defaults to black */
-    specular_color?: RgbFactorProps;
-    /** If true, this material has a specular exponent; if undefined, defaults to false */
-    HasFinish?: boolean;
-    /** Specular exponent (surface shininess); range is 0 to 128; if undefined, defaults to 13.5 */
-    finish?: number;
-    /** If true, this material has surface transparency; if undefined, defaults to false */
-    HasTransmit?: boolean;
-    /** Surface transparency; if undefined, defaults to 0.0 */
-    transmit?: number;
-    /** If true, this material has a value for diffuse reflectivity; if undefined, defaults to false */
-    HasDiffuse?: boolean;
-    /** Surface diffuse reflectivity; if undefined, defaults to 0.6 */
-    diffuse?: number;
-    /** If true, this material has a value for specular reflectivity; if undefined, defaults to false.  If false, specular value is actually set to 0.0 */
-    HasSpecular?: boolean;
-    /** Surface specular reflectivity; if undefined, defaults to 0.4 */
-    specular?: number;
-    /** If true, this material has a value for environmental reflectivity; if undefined, defaults to false */
-    HasReflect?: boolean;
-    /** Surface environmental reflectivity; stored as fraction of specular in V8 material settings; if undefined defaults to 0.0 */
-    reflect?: number;
-    /** If true, this material has a surface reflectance color; if undefined, defaults to false.  If false, reflectance color is actually set to specular color */
-    HasReflectColor?: boolean;
-    /** Surface reflectance color; if undefined, defaults to black */
-    reflect_color?: RgbFactorProps;
-    /** A scale by which to multiply the components of the normals read from [[Map.Normal]], if a normal map is defined.
-     * Default: 1.0
-     */
-    pbr_normal?: number;
-    /** An optional set of texture maps associated with this material. */
-    Map?: RenderMaterialAssetMapsProps;
-}
-/** Properties that define a [RenderMaterialElement]($backend).
- * @see [[RenderMaterial]] for the representation used by the display system.
- * @public
- * @extensions
- */
-export interface RenderMaterialProps extends DefinitionElementProps {
-    /** The name of a palette that can be used to categorize multiple materials. */
-    paletteName: string;
-    /** An optional description of the material. */
-    description?: string;
-    jsonProperties?: {
-        /** A container for various "assets" describing aspects of the material. */
-        materialAssets?: {
-            /** Properties of the material describing how it is displayed. */
-            renderMaterial?: RenderMaterialAssetProps;
-        };
-    };
-}
+/** @packageDocumentation
+ * @module Rendering
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { DefinitionElementProps } from "./ElementProps";
+import { TextureMapping } from "./TextureMapping";
+/** Describes a color as an array of three numbers ranging from 0 to 1 where the first entry corresponds to the color's red component,
+ * the second to green, and the third to blue.
+ * @see usage in [[RenderMaterialAssetProps]].
+ * @public
+ * @extensions
+ */
+export declare type RgbFactorProps = number[];
+/** A 2d point specified as an array of 2 numbers [x, y].
+ * @see usage in [[TextureMapProps]].
+ * @public
+ * @extensions
+ */
+export declare type Point2dProps = number[];
+/** Describes the units in which a [[TextureMapProps]]' scale is expressed.
+ * @public
+ * @extensions
+ */
+export declare enum TextureMapUnits {
+    /** Indicates the scale has no units. */
+    Relative = 0,
+    Meters = 3,
+    Millimeters = 4,
+    Feet = 5,
+    Inches = 6
+}
+/** As part of a [[RenderMaterialAssetProps]], describes how to map a [[RenderTexture]]'s image to the triangles of a mesh to which the material is applied.
+ * @see [[RenderMaterialAssetMapsProps]] for the supported types of texture mappings.
+ * @public
+ * @extensions
+ */
+export interface TextureMapProps {
+    /** Angle in degrees to rotate texture when applying; defaults to 0.0 if undefined */
+    pattern_angle?: number;
+    /** If true, flip the pattern map in U; if undefined, defaults to false */
+    pattern_u_flip?: boolean;
+    /** If true, flip the pattern map in V; if undefined, defaults to false */
+    pattern_flip?: boolean;
+    /** X, Y scale to apply to the pattern map; if undefined, defaults to {0,0}, which is almost never useful. */
+    pattern_scale?: Point2dProps;
+    /** X, Y offset to apply to the pattern map; if undefined, defaults to {0,0} */
+    pattern_offset?: Point2dProps;
+    /** Units to use when applying the scaling; if undefined, defaults to [[TextureMapUnits.Relative]] */
+    pattern_scalemode?: TextureMapUnits;
+    /** Mapping mode to use for the texture application; if undefined, defaults to [[TextureMapping.Mode.Parametric]] */
+    pattern_mapping?: TextureMapping.Mode;
+    /** Weight at which to combine diffuse image and color; if undefined, defaults to 1.0 */
+    pattern_weight?: number;
+    /** The Id of the persistent [Texture]($backend) element defining the texture image. */
+    TextureId: Id64String;
+}
+/** Flags applied to a [[NormalMapProps]]. The enum values can be combined using bitwise operators.
+ * @public
+ */
+export declare enum NormalMapFlags {
+    /** No special flags. */
+    None = 0,
+    /** Indicates that the Y component of each vector - stored in the texture's green channel - points upward along the positive Y axis and should
+     * be negated. By default it points downward.
+     */
+    GreenUp = 1
+}
+/** Describes how to apply [normal mapping](https://en.wikipedia.org/wiki/Normal_mapping) to a surface material.
+ * @see [[RenderMaterialAssetMapsProps.Normal]] to define a normal map for a [[RenderMaterialAssetProps]].
+ * @public
+ */
+export interface NormalMapProps extends TextureMapProps {
+    /** Flags controlling how the normal map is applied. Default: [[NormalMapFlags.None]]. */
+    NormalFlags?: NormalMapFlags;
+}
+/** Describes different types of textures to be applied to a surface material to alter its appearance.
+ * @note While technically both [[Pattern]] and [[Normal]] can define their own mapping parameters (`pattern_angle`, `pattern_mapping`, etc), in practice
+ * if both maps are present they are expected to have identical mapping parameters, with the exception of `TextureId`.
+ * @see [[RenderMaterialAssetProps.Map]] to define the texture maps for a material asset.
+ * @public
+ */
+export interface RenderMaterialAssetMapsProps {
+    /** Maps an image describing the diffuse color of the surface, replacing or mixing with the surface's own color. */
+    Pattern?: TextureMapProps;
+    /** Maps a [normal map](https://en.wikipedia.org/wiki/Normal_mapping) to the surface, simulating more complex surface details than are
+     * present in the surface's geometry.
+     */
+    Normal?: NormalMapProps;
+}
+/** Describes the graphical properties of a [RenderMaterialElement]($backend) as part of a [[RenderMaterialProps]].
+ * This representation is used to persist the material properties into the [IModelDb]($backend), but is unwieldy and verbose.
+ * @see [RenderMaterialElementParams]($backend) for a somewhat more ergonomic representation.
+ * @public
+ * @extensions
+ */
+export interface RenderMaterialAssetProps {
+    /** If true, this material has a fill/diffuse color; if undefined, defaults to false */
+    HasBaseColor?: boolean;
+    /** Surface color used for fill or diffuse illumination; if undefined, defaults to black */
+    color?: RgbFactorProps;
+    /** If true, this material has a specular color; if undefined, defaults to false */
+    HasSpecularColor?: boolean;
+    /** Surface color used for specular illumination; if undefined, defaults to black */
+    specular_color?: RgbFactorProps;
+    /** If true, this material has a specular exponent; if undefined, defaults to false */
+    HasFinish?: boolean;
+    /** Specular exponent (surface shininess); range is 0 to 128; if undefined, defaults to 13.5 */
+    finish?: number;
+    /** If true, this material has surface transparency; if undefined, defaults to false */
+    HasTransmit?: boolean;
+    /** Surface transparency; if undefined, defaults to 0.0 */
+    transmit?: number;
+    /** If true, this material has a value for diffuse reflectivity; if undefined, defaults to false */
+    HasDiffuse?: boolean;
+    /** Surface diffuse reflectivity; if undefined, defaults to 0.6 */
+    diffuse?: number;
+    /** If true, this material has a value for specular reflectivity; if undefined, defaults to false.  If false, specular value is actually set to 0.0 */
+    HasSpecular?: boolean;
+    /** Surface specular reflectivity; if undefined, defaults to 0.4 */
+    specular?: number;
+    /** If true, this material has a value for environmental reflectivity; if undefined, defaults to false */
+    HasReflect?: boolean;
+    /** Surface environmental reflectivity; stored as fraction of specular in V8 material settings; if undefined defaults to 0.0 */
+    reflect?: number;
+    /** If true, this material has a surface reflectance color; if undefined, defaults to false.  If false, reflectance color is actually set to specular color */
+    HasReflectColor?: boolean;
+    /** Surface reflectance color; if undefined, defaults to black */
+    reflect_color?: RgbFactorProps;
+    /** A scale by which to multiply the components of the normals read from [[Map.Normal]], if a normal map is defined.
+     * Default: 1.0
+     */
+    pbr_normal?: number;
+    /** An optional set of texture maps associated with this material. */
+    Map?: RenderMaterialAssetMapsProps;
+}
+/** Properties that define a [RenderMaterialElement]($backend).
+ * @see [[RenderMaterial]] for the representation used by the display system.
+ * @public
+ * @extensions
+ */
+export interface RenderMaterialProps extends DefinitionElementProps {
+    /** The name of a palette that can be used to categorize multiple materials. */
+    paletteName: string;
+    /** An optional description of the material. */
+    description?: string;
+    jsonProperties?: {
+        /** A container for various "assets" describing aspects of the material. */
+        materialAssets?: {
+            /** Properties of the material describing how it is displayed. */
+            renderMaterial?: RenderMaterialAssetProps;
+        };
+    };
+}
 //# sourceMappingURL=MaterialProps.d.ts.map

package/lib/cjs/MaterialProps.js

@@ -1,36 +1,36 @@
-"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.NormalMapFlags = exports.TextureMapUnits = void 0;
-/** Describes the units in which a [[TextureMapProps]]' scale is expressed.
- * @public
- * @extensions
- */
-var TextureMapUnits;
-(function (TextureMapUnits) {
-    /** Indicates the scale has no units. */
-    TextureMapUnits[TextureMapUnits["Relative"] = 0] = "Relative";
-    TextureMapUnits[TextureMapUnits["Meters"] = 3] = "Meters";
-    TextureMapUnits[TextureMapUnits["Millimeters"] = 4] = "Millimeters";
-    TextureMapUnits[TextureMapUnits["Feet"] = 5] = "Feet";
-    TextureMapUnits[TextureMapUnits["Inches"] = 6] = "Inches";
-})(TextureMapUnits = exports.TextureMapUnits || (exports.TextureMapUnits = {}));
-/** Flags applied to a [[NormalMapProps]]. The enum values can be combined using bitwise operators.
- * @public
- */
-var NormalMapFlags;
-(function (NormalMapFlags) {
-    /** No special flags. */
-    NormalMapFlags[NormalMapFlags["None"] = 0] = "None";
-    /** Indicates that the Y component of each vector - stored in the texture's green channel - points upward along the positive Y axis and should
-     * be negated. By default it points downward.
-     */
-    NormalMapFlags[NormalMapFlags["GreenUp"] = 1] = "GreenUp";
-})(NormalMapFlags = exports.NormalMapFlags || (exports.NormalMapFlags = {}));
+"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.NormalMapFlags = exports.TextureMapUnits = void 0;
+/** Describes the units in which a [[TextureMapProps]]' scale is expressed.
+ * @public
+ * @extensions
+ */
+var TextureMapUnits;
+(function (TextureMapUnits) {
+    /** Indicates the scale has no units. */
+    TextureMapUnits[TextureMapUnits["Relative"] = 0] = "Relative";
+    TextureMapUnits[TextureMapUnits["Meters"] = 3] = "Meters";
+    TextureMapUnits[TextureMapUnits["Millimeters"] = 4] = "Millimeters";
+    TextureMapUnits[TextureMapUnits["Feet"] = 5] = "Feet";
+    TextureMapUnits[TextureMapUnits["Inches"] = 6] = "Inches";
+})(TextureMapUnits = exports.TextureMapUnits || (exports.TextureMapUnits = {}));
+/** Flags applied to a [[NormalMapProps]]. The enum values can be combined using bitwise operators.
+ * @public
+ */
+var NormalMapFlags;
+(function (NormalMapFlags) {
+    /** No special flags. */
+    NormalMapFlags[NormalMapFlags["None"] = 0] = "None";
+    /** Indicates that the Y component of each vector - stored in the texture's green channel - points upward along the positive Y axis and should
+     * be negated. By default it points downward.
+     */
+    NormalMapFlags[NormalMapFlags["GreenUp"] = 1] = "GreenUp";
+})(NormalMapFlags = exports.NormalMapFlags || (exports.NormalMapFlags = {}));
 //# sourceMappingURL=MaterialProps.js.map

package/lib/cjs/MaterialProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"MaterialProps.js","sourceRoot":"","sources":["../../src/MaterialProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAqBH;;;GAGG;AACH,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,wCAAwC;IACxC,6DAAY,CAAA;IACZ,yDAAU,CAAA;IACV,mEAAe,CAAA;IACf,qDAAQ,CAAA;IACR,yDAAU,CAAA;AACZ,CAAC,EAPW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAO1B;AA8BD;;GAEG;AACH,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,wBAAwB;IACxB,mDAAQ,CAAA;IACR;;OAEG;IACH,yDAAgB,CAAA;AAClB,CAAC,EAPW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAOzB","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 { Id64String } from \"@itwin/core-bentley\";\r\nimport { DefinitionElementProps } from \"./ElementProps\";\r\nimport { TextureMapping } from \"./TextureMapping\";\r\n\r\n/** Describes a color as an array of three numbers ranging from 0 to 1 where the first entry corresponds to the color's red component,\r\n * the second to green, and the third to blue.\r\n * @see usage in [[RenderMaterialAssetProps]].\r\n * @public\r\n * @extensions\r\n */\r\nexport type RgbFactorProps = number[];\r\n\r\n/** A 2d point specified as an array of 2 numbers [x, y].\r\n * @see usage in [[TextureMapProps]].\r\n * @public\r\n * @extensions\r\n */\r\nexport type Point2dProps = number[];\r\n\r\n/** Describes the units in which a [[TextureMapProps]]' scale is expressed.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum TextureMapUnits {\r\n  /** Indicates the scale has no units. */\r\n  Relative = 0,\r\n  Meters = 3,\r\n  Millimeters = 4,\r\n  Feet = 5,\r\n  Inches = 6,\r\n}\r\n\r\n/* eslint-disable @typescript-eslint/naming-convention */\r\n\r\n/** As part of a [[RenderMaterialAssetProps]], describes how to map a [[RenderTexture]]'s image to the triangles of a mesh to which the material is applied.\r\n * @see [[RenderMaterialAssetMapsProps]] for the supported types of texture mappings.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface TextureMapProps {\r\n  /** Angle in degrees to rotate texture when applying; defaults to 0.0 if undefined */\r\n  pattern_angle?: number;\r\n  /** If true, flip the pattern map in U; if undefined, defaults to false */\r\n  pattern_u_flip?: boolean;\r\n  /** If true, flip the pattern map in V; if undefined, defaults to false */\r\n  pattern_flip?: boolean;\r\n  /** X, Y scale to apply to the pattern map; if undefined, defaults to {0,0}, which is almost never useful. */\r\n  pattern_scale?: Point2dProps;\r\n  /** X, Y offset to apply to the pattern map; if undefined, defaults to {0,0} */\r\n  pattern_offset?: Point2dProps;\r\n  /** Units to use when applying the scaling; if undefined, defaults to [[TextureMapUnits.Relative]] */\r\n  pattern_scalemode?: TextureMapUnits;\r\n  /** Mapping mode to use for the texture application; if undefined, defaults to [[TextureMapping.Mode.Parametric]] */\r\n  pattern_mapping?: TextureMapping.Mode;\r\n  /** Weight at which to combine diffuse image and color; if undefined, defaults to 1.0 */\r\n  pattern_weight?: number;\r\n  /** The Id of the persistent [Texture]($backend) element defining the texture image. */\r\n  TextureId: Id64String;\r\n}\r\n\r\n/** Flags applied to a [[NormalMapProps]]. The enum values can be combined using bitwise operators.\r\n * @public\r\n */\r\nexport enum NormalMapFlags {\r\n  /** No special flags. */\r\n  None = 0,\r\n  /** Indicates that the Y component of each vector - stored in the texture's green channel - points upward along the positive Y axis and should\r\n   * be negated. By default it points downward.\r\n   */\r\n  GreenUp = 1 << 0,\r\n}\r\n\r\n/** Describes how to apply [normal mapping](https://en.wikipedia.org/wiki/Normal_mapping) to a surface material.\r\n * @see [[RenderMaterialAssetMapsProps.Normal]] to define a normal map for a [[RenderMaterialAssetProps]].\r\n * @public\r\n */\r\nexport interface NormalMapProps extends TextureMapProps {\r\n  /** Flags controlling how the normal map is applied. Default: [[NormalMapFlags.None]]. */\r\n  NormalFlags?: NormalMapFlags;\r\n}\r\n\r\n/** Describes different types of textures to be applied to a surface material to alter its appearance.\r\n * @note While technically both [[Pattern]] and [[Normal]] can define their own mapping parameters (`pattern_angle`, `pattern_mapping`, etc), in practice\r\n * if both maps are present they are expected to have identical mapping parameters, with the exception of `TextureId`.\r\n * @see [[RenderMaterialAssetProps.Map]] to define the texture maps for a material asset.\r\n * @public\r\n */\r\nexport interface RenderMaterialAssetMapsProps {\r\n  /** Maps an image describing the diffuse color of the surface, replacing or mixing with the surface's own color. */\r\n  Pattern?: TextureMapProps;\r\n  /** Maps a [normal map](https://en.wikipedia.org/wiki/Normal_mapping) to the surface, simulating more complex surface details than are\r\n   * present in the surface's geometry.\r\n   */\r\n  Normal?: NormalMapProps;\r\n}\r\n\r\n/** Describes the graphical properties of a [RenderMaterialElement]($backend) as part of a [[RenderMaterialProps]].\r\n * This representation is used to persist the material properties into the [IModelDb]($backend), but is unwieldy and verbose.\r\n * @see [RenderMaterialElementParams]($backend) for a somewhat more ergonomic representation.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface RenderMaterialAssetProps {\r\n  /** If true, this material has a fill/diffuse color; if undefined, defaults to false */\r\n  HasBaseColor?: boolean;\r\n  /** Surface color used for fill or diffuse illumination; if undefined, defaults to black */\r\n  color?: RgbFactorProps;\r\n  /** If true, this material has a specular color; if undefined, defaults to false */\r\n  HasSpecularColor?: boolean;\r\n  /** Surface color used for specular illumination; if undefined, defaults to black */\r\n  specular_color?: RgbFactorProps;\r\n  /** If true, this material has a specular exponent; if undefined, defaults to false */\r\n  HasFinish?: boolean;\r\n  /** Specular exponent (surface shininess); range is 0 to 128; if undefined, defaults to 13.5 */\r\n  finish?: number;\r\n  /** If true, this material has surface transparency; if undefined, defaults to false */\r\n  HasTransmit?: boolean;\r\n  /** Surface transparency; if undefined, defaults to 0.0 */\r\n  transmit?: number;\r\n  /** If true, this material has a value for diffuse reflectivity; if undefined, defaults to false */\r\n  HasDiffuse?: boolean;\r\n  /** Surface diffuse reflectivity; if undefined, defaults to 0.6 */\r\n  diffuse?: number;\r\n  /** If true, this material has a value for specular reflectivity; if undefined, defaults to false.  If false, specular value is actually set to 0.0 */\r\n  HasSpecular?: boolean;\r\n  /** Surface specular reflectivity; if undefined, defaults to 0.4 */\r\n  specular?: number;\r\n  /** If true, this material has a value for environmental reflectivity; if undefined, defaults to false */\r\n  HasReflect?: boolean;\r\n  /** Surface environmental reflectivity; stored as fraction of specular in V8 material settings; if undefined defaults to 0.0 */\r\n  reflect?: number;\r\n  /** If true, this material has a surface reflectance color; if undefined, defaults to false.  If false, reflectance color is actually set to specular color */\r\n  HasReflectColor?: boolean;\r\n  /** Surface reflectance color; if undefined, defaults to black */\r\n  reflect_color?: RgbFactorProps;\r\n  /** A scale by which to multiply the components of the normals read from [[Map.Normal]], if a normal map is defined.\r\n   * Default: 1.0\r\n   */\r\n  pbr_normal?: number;\r\n  /** An optional set of texture maps associated with this material. */\r\n  Map?: RenderMaterialAssetMapsProps;\r\n}\r\n\r\n/** Properties that define a [RenderMaterialElement]($backend).\r\n * @see [[RenderMaterial]] for the representation used by the display system.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface RenderMaterialProps extends DefinitionElementProps {\r\n  /** The name of a palette that can be used to categorize multiple materials. */\r\n  paletteName: string;\r\n  /** An optional description of the material. */\r\n  description?: string;\r\n  jsonProperties?: {\r\n    /** A container for various \"assets\" describing aspects of the material. */\r\n    materialAssets?: {\r\n      /** Properties of the material describing how it is displayed. */\r\n      renderMaterial?: RenderMaterialAssetProps;\r\n    };\r\n  };\r\n}\r\n"]}
+{"version":3,"file":"MaterialProps.js","sourceRoot":"","sources":["../../src/MaterialProps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAqBH;;;GAGG;AACH,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,wCAAwC;IACxC,6DAAY,CAAA;IACZ,yDAAU,CAAA;IACV,mEAAe,CAAA;IACf,qDAAQ,CAAA;IACR,yDAAU,CAAA;AACZ,CAAC,EAPW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAO1B;AA8BD;;GAEG;AACH,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,wBAAwB;IACxB,mDAAQ,CAAA;IACR;;OAEG;IACH,yDAAgB,CAAA;AAClB,CAAC,EAPW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAOzB","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 Rendering\n */\n\nimport { Id64String } from \"@itwin/core-bentley\";\nimport { DefinitionElementProps } from \"./ElementProps\";\nimport { TextureMapping } from \"./TextureMapping\";\n\n/** Describes a color as an array of three numbers ranging from 0 to 1 where the first entry corresponds to the color's red component,\n * the second to green, and the third to blue.\n * @see usage in [[RenderMaterialAssetProps]].\n * @public\n * @extensions\n */\nexport type RgbFactorProps = number[];\n\n/** A 2d point specified as an array of 2 numbers [x, y].\n * @see usage in [[TextureMapProps]].\n * @public\n * @extensions\n */\nexport type Point2dProps = number[];\n\n/** Describes the units in which a [[TextureMapProps]]' scale is expressed.\n * @public\n * @extensions\n */\nexport enum TextureMapUnits {\n  /** Indicates the scale has no units. */\n  Relative = 0,\n  Meters = 3,\n  Millimeters = 4,\n  Feet = 5,\n  Inches = 6,\n}\n\n/* eslint-disable @typescript-eslint/naming-convention */\n\n/** As part of a [[RenderMaterialAssetProps]], describes how to map a [[RenderTexture]]'s image to the triangles of a mesh to which the material is applied.\n * @see [[RenderMaterialAssetMapsProps]] for the supported types of texture mappings.\n * @public\n * @extensions\n */\nexport interface TextureMapProps {\n  /** Angle in degrees to rotate texture when applying; defaults to 0.0 if undefined */\n  pattern_angle?: number;\n  /** If true, flip the pattern map in U; if undefined, defaults to false */\n  pattern_u_flip?: boolean;\n  /** If true, flip the pattern map in V; if undefined, defaults to false */\n  pattern_flip?: boolean;\n  /** X, Y scale to apply to the pattern map; if undefined, defaults to {0,0}, which is almost never useful. */\n  pattern_scale?: Point2dProps;\n  /** X, Y offset to apply to the pattern map; if undefined, defaults to {0,0} */\n  pattern_offset?: Point2dProps;\n  /** Units to use when applying the scaling; if undefined, defaults to [[TextureMapUnits.Relative]] */\n  pattern_scalemode?: TextureMapUnits;\n  /** Mapping mode to use for the texture application; if undefined, defaults to [[TextureMapping.Mode.Parametric]] */\n  pattern_mapping?: TextureMapping.Mode;\n  /** Weight at which to combine diffuse image and color; if undefined, defaults to 1.0 */\n  pattern_weight?: number;\n  /** The Id of the persistent [Texture]($backend) element defining the texture image. */\n  TextureId: Id64String;\n}\n\n/** Flags applied to a [[NormalMapProps]]. The enum values can be combined using bitwise operators.\n * @public\n */\nexport enum NormalMapFlags {\n  /** No special flags. */\n  None = 0,\n  /** Indicates that the Y component of each vector - stored in the texture's green channel - points upward along the positive Y axis and should\n   * be negated. By default it points downward.\n   */\n  GreenUp = 1 << 0,\n}\n\n/** Describes how to apply [normal mapping](https://en.wikipedia.org/wiki/Normal_mapping) to a surface material.\n * @see [[RenderMaterialAssetMapsProps.Normal]] to define a normal map for a [[RenderMaterialAssetProps]].\n * @public\n */\nexport interface NormalMapProps extends TextureMapProps {\n  /** Flags controlling how the normal map is applied. Default: [[NormalMapFlags.None]]. */\n  NormalFlags?: NormalMapFlags;\n}\n\n/** Describes different types of textures to be applied to a surface material to alter its appearance.\n * @note While technically both [[Pattern]] and [[Normal]] can define their own mapping parameters (`pattern_angle`, `pattern_mapping`, etc), in practice\n * if both maps are present they are expected to have identical mapping parameters, with the exception of `TextureId`.\n * @see [[RenderMaterialAssetProps.Map]] to define the texture maps for a material asset.\n * @public\n */\nexport interface RenderMaterialAssetMapsProps {\n  /** Maps an image describing the diffuse color of the surface, replacing or mixing with the surface's own color. */\n  Pattern?: TextureMapProps;\n  /** Maps a [normal map](https://en.wikipedia.org/wiki/Normal_mapping) to the surface, simulating more complex surface details than are\n   * present in the surface's geometry.\n   */\n  Normal?: NormalMapProps;\n}\n\n/** Describes the graphical properties of a [RenderMaterialElement]($backend) as part of a [[RenderMaterialProps]].\n * This representation is used to persist the material properties into the [IModelDb]($backend), but is unwieldy and verbose.\n * @see [RenderMaterialElementParams]($backend) for a somewhat more ergonomic representation.\n * @public\n * @extensions\n */\nexport interface RenderMaterialAssetProps {\n  /** If true, this material has a fill/diffuse color; if undefined, defaults to false */\n  HasBaseColor?: boolean;\n  /** Surface color used for fill or diffuse illumination; if undefined, defaults to black */\n  color?: RgbFactorProps;\n  /** If true, this material has a specular color; if undefined, defaults to false */\n  HasSpecularColor?: boolean;\n  /** Surface color used for specular illumination; if undefined, defaults to black */\n  specular_color?: RgbFactorProps;\n  /** If true, this material has a specular exponent; if undefined, defaults to false */\n  HasFinish?: boolean;\n  /** Specular exponent (surface shininess); range is 0 to 128; if undefined, defaults to 13.5 */\n  finish?: number;\n  /** If true, this material has surface transparency; if undefined, defaults to false */\n  HasTransmit?: boolean;\n  /** Surface transparency; if undefined, defaults to 0.0 */\n  transmit?: number;\n  /** If true, this material has a value for diffuse reflectivity; if undefined, defaults to false */\n  HasDiffuse?: boolean;\n  /** Surface diffuse reflectivity; if undefined, defaults to 0.6 */\n  diffuse?: number;\n  /** If true, this material has a value for specular reflectivity; if undefined, defaults to false.  If false, specular value is actually set to 0.0 */\n  HasSpecular?: boolean;\n  /** Surface specular reflectivity; if undefined, defaults to 0.4 */\n  specular?: number;\n  /** If true, this material has a value for environmental reflectivity; if undefined, defaults to false */\n  HasReflect?: boolean;\n  /** Surface environmental reflectivity; stored as fraction of specular in V8 material settings; if undefined defaults to 0.0 */\n  reflect?: number;\n  /** If true, this material has a surface reflectance color; if undefined, defaults to false.  If false, reflectance color is actually set to specular color */\n  HasReflectColor?: boolean;\n  /** Surface reflectance color; if undefined, defaults to black */\n  reflect_color?: RgbFactorProps;\n  /** A scale by which to multiply the components of the normals read from [[Map.Normal]], if a normal map is defined.\n   * Default: 1.0\n   */\n  pbr_normal?: number;\n  /** An optional set of texture maps associated with this material. */\n  Map?: RenderMaterialAssetMapsProps;\n}\n\n/** Properties that define a [RenderMaterialElement]($backend).\n * @see [[RenderMaterial]] for the representation used by the display system.\n * @public\n * @extensions\n */\nexport interface RenderMaterialProps extends DefinitionElementProps {\n  /** The name of a palette that can be used to categorize multiple materials. */\n  paletteName: string;\n  /** An optional description of the material. */\n  description?: string;\n  jsonProperties?: {\n    /** A container for various \"assets\" describing aspects of the material. */\n    materialAssets?: {\n      /** Properties of the material describing how it is displayed. */\n      renderMaterial?: RenderMaterialAssetProps;\n    };\n  };\n}\n"]}

package/lib/cjs/ModelClipGroup.d.ts

@@ -1,68 +1,68 @@
-/** @packageDocumentation
- * @module Views
- */
-import { Id64Array, Id64String } from "@itwin/core-bentley";
-import { ClipVector, ClipVectorProps } from "@itwin/core-geometry";
-/** JSON representation of a [[ModelClipGroup]].
- * @public
- * @extensions
- */
-export interface ModelClipGroupProps {
-    /** The Ids of the models in the group. */
-    models?: Id64Array;
-    /** JSON representation of the [ClipVector]($core-geometry) applied to the group. */
-    clip?: ClipVectorProps;
-}
-/** Describes how to clip a group of models in the context of a [ViewDefinition3d]($backend) by applying a single [ClipVector]($core-geometry] to each model in the group.
- * @see [[ModelClipGroups]] to define multiple groups of models with different clip vectors.
- * @public
- */
-export declare class ModelClipGroup {
-    /** The Ids of the models to be clipped, or undefined if the group includes all models. */
-    readonly models?: Id64Array;
-    /** The clip to apply to the group of models. `undefined` indicates the models are exempt from clipping. */
-    readonly clip?: ClipVector;
-    private constructor();
-    /** Create a new ModelClipGroup. The input arguments are captured as references and should not be subsequently modified. */
-    static create(clip: ClipVector | undefined, models?: Id64Array): ModelClipGroup;
-    /** Create a deep copy of this group. */
-    clone(): ModelClipGroup;
-    /** Returns whether the specified model Id belongs to this group. */
-    includesModel(modelId: Id64String): boolean;
-    /** Create from JSON representation. */
-    static fromJSON(props: ModelClipGroupProps): ModelClipGroup;
-    /** Convert to JSON representation. */
-    toJSON(): ModelClipGroupProps;
-}
-/** Describes how to clip groups of models in the context of a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).
- * Each group will be clipped by the [ClipVector]($core-geometry) associated with the group to which it belongs.
- * A model belongs to the first group in the list for which `ModelClipGroup.includesModel()` returns `true`.
- * A catch-all group can be defined by a ModelClipGroup with an `undefined` array of model Ids; any model whose Id does not appear in any group's list would belong to this group. If a catch-all group exists, it should appear last in the list.
- * A group of models can be exempted from clipping by a ModelClipGroup with an `undefined` ClipVector.
- * @note A ModelClipGroups obtained from a [[ViewDetails3d]] should **not** be modified directly. Clone it instead and modify the clone.
- * @see [[ViewDetails3d.modelClipGroups]] to define the clip groups for a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).
- * @public
- */
-export declare class ModelClipGroups {
-    /** The groups of models and their associated clips. */
-    readonly groups: ModelClipGroup[];
-    /** Create a new ModelClipGroups.
-     * @note The ModelClipGroup takes ownership of the input array, which should not be subsequently modified.
-     */
-    constructor(groups?: ModelClipGroup[]);
-    /** Create a deep copy of this ModelClipGroups. */
-    clone(): ModelClipGroups;
-    /** Find the first group to which the specified model Id belongs, if any. */
-    findGroup(modelId: Id64String): ModelClipGroup | undefined;
-    /** Returns the array index of the group to which the specified model belongs, or -1 if the model belongs to no group. */
-    findGroupIndex(modelId: Id64String): number;
-    /** Find the clip that should be applied to the specified model.
-     * @note This may return `undefined` if the model belongs to no group, **or** it belongs to a group that should not be clipped.
-     */
-    getClipForModel(modelId: Id64String): ClipVector | undefined;
-    /** Create from JSON representation. */
-    static fromJSON(props: ModelClipGroupProps[] | undefined): ModelClipGroups;
-    /** Convert to JSON representation. */
-    toJSON(): ModelClipGroupProps[];
-}
+/** @packageDocumentation
+ * @module Views
+ */
+import { Id64Array, Id64String } from "@itwin/core-bentley";
+import { ClipVector, ClipVectorProps } from "@itwin/core-geometry";
+/** JSON representation of a [[ModelClipGroup]].
+ * @public
+ * @extensions
+ */
+export interface ModelClipGroupProps {
+    /** The Ids of the models in the group. */
+    models?: Id64Array;
+    /** JSON representation of the [ClipVector]($core-geometry) applied to the group. */
+    clip?: ClipVectorProps;
+}
+/** Describes how to clip a group of models in the context of a [ViewDefinition3d]($backend) by applying a single [ClipVector]($core-geometry] to each model in the group.
+ * @see [[ModelClipGroups]] to define multiple groups of models with different clip vectors.
+ * @public
+ */
+export declare class ModelClipGroup {
+    /** The Ids of the models to be clipped, or undefined if the group includes all models. */
+    readonly models?: Id64Array;
+    /** The clip to apply to the group of models. `undefined` indicates the models are exempt from clipping. */
+    readonly clip?: ClipVector;
+    private constructor();
+    /** Create a new ModelClipGroup. The input arguments are captured as references and should not be subsequently modified. */
+    static create(clip: ClipVector | undefined, models?: Id64Array): ModelClipGroup;
+    /** Create a deep copy of this group. */
+    clone(): ModelClipGroup;
+    /** Returns whether the specified model Id belongs to this group. */
+    includesModel(modelId: Id64String): boolean;
+    /** Create from JSON representation. */
+    static fromJSON(props: ModelClipGroupProps): ModelClipGroup;
+    /** Convert to JSON representation. */
+    toJSON(): ModelClipGroupProps;
+}
+/** Describes how to clip groups of models in the context of a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).
+ * Each group will be clipped by the [ClipVector]($core-geometry) associated with the group to which it belongs.
+ * A model belongs to the first group in the list for which `ModelClipGroup.includesModel()` returns `true`.
+ * A catch-all group can be defined by a ModelClipGroup with an `undefined` array of model Ids; any model whose Id does not appear in any group's list would belong to this group. If a catch-all group exists, it should appear last in the list.
+ * A group of models can be exempted from clipping by a ModelClipGroup with an `undefined` ClipVector.
+ * @note A ModelClipGroups obtained from a [[ViewDetails3d]] should **not** be modified directly. Clone it instead and modify the clone.
+ * @see [[ViewDetails3d.modelClipGroups]] to define the clip groups for a [ViewDefinition3d]($backend) or [ViewState3d]($frontend).
+ * @public
+ */
+export declare class ModelClipGroups {
+    /** The groups of models and their associated clips. */
+    readonly groups: ModelClipGroup[];
+    /** Create a new ModelClipGroups.
+     * @note The ModelClipGroup takes ownership of the input array, which should not be subsequently modified.
+     */
+    constructor(groups?: ModelClipGroup[]);
+    /** Create a deep copy of this ModelClipGroups. */
+    clone(): ModelClipGroups;
+    /** Find the first group to which the specified model Id belongs, if any. */
+    findGroup(modelId: Id64String): ModelClipGroup | undefined;
+    /** Returns the array index of the group to which the specified model belongs, or -1 if the model belongs to no group. */
+    findGroupIndex(modelId: Id64String): number;
+    /** Find the clip that should be applied to the specified model.
+     * @note This may return `undefined` if the model belongs to no group, **or** it belongs to a group that should not be clipped.
+     */
+    getClipForModel(modelId: Id64String): ClipVector | undefined;
+    /** Create from JSON representation. */
+    static fromJSON(props: ModelClipGroupProps[] | undefined): ModelClipGroups;
+    /** Convert to JSON representation. */
+    toJSON(): ModelClipGroupProps[];
+}
 //# sourceMappingURL=ModelClipGroup.d.ts.map