@itwin/core-backend 4.0.0-dev.10 → 4.0.0-dev.101

package/lib/cjs/Material.d.ts

@@ -1,132 +1,132 @@
-/** @packageDocumentation
- * @module Elements
- */
-import { Id64String } from "@itwin/core-bentley";
-import { Code, CodeScopeProps, NormalMapProps, RenderMaterialProps, RgbFactorProps, TextureMapProps } from "@itwin/core-common";
-import { DefinitionElement } from "./Element";
-import { IModelDb } from "./IModelDb";
-/** A PhysicalMaterial defines the matter that makes up physical elements.
- * @note See [[RenderMaterialElement]] for the DefinitionElement used to define rendering characteristics.
- * @public
- */
-export declare abstract class PhysicalMaterial extends DefinitionElement {
-    /** @internal */
-    static get className(): string;
-    /** Create a Code for a PhysicalMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
-     * @param iModel  The IModelDb
-     * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
-     * @param name The name (codeValue) of the PhysicalMaterial
-     */
-    static createCode(iModel: IModelDb, definitionModelId: CodeScopeProps, name: string): Code;
-    /** Create a PhysicalMaterial
-     * @param iModelDb The IModelDb
-     * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
-     * @param name The name (codeValue) of the PhysicalMaterial
-     * @returns The newly constructed PhysicalMaterial
-     * @throws [[IModelError]] if there is a problem creating the PhysicalMaterial
-     */
-    static create<T extends PhysicalMaterial>(iModelDb: IModelDb, definitionModelId: CodeScopeProps, name: string): T;
-}
-/** Defines a rendering material.
- * @note See [[PhysicalMaterial]] for the DefinitionElement used to define the matter that makes up physical elements.
- * @public
- */
-export declare class RenderMaterialElement extends DefinitionElement {
-    /** @internal */
-    static get className(): string;
-    /** The name of a palette that can be used to categorize multiple materials. */
-    paletteName: string;
-    /** An optional description of the material. */
-    description?: string;
-    /** @internal */
-    constructor(props: RenderMaterialProps, iModel: IModelDb);
-    /** @internal */
-    toJSON(): RenderMaterialProps;
-    /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
-     * @param iModel  The IModelDb
-     * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.
-     * @param name The RenderMaterial name
-     */
-    static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, name: string): Code;
-    /**
-     * Create a RenderMaterial with given parameters.
-     * @param iModelDb The iModel
-     * @param definitionModelId The [[DefinitionModel]]
-     * @param materialName The name/CodeValue of the RenderMaterial
-     * @param params Parameters object which describes how to construct the RenderMaterial
-     * @returns The newly constructed RenderMaterial element.
-     * @throws [[IModelError]] if unable to create the element.
-     */
-    static create(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElementParams): RenderMaterialElement;
-    /**
-     * Insert a new RenderMaterial into a model.
-     * @param iModelDb Insert into this iModel
-     * @param definitionModelId Insert the new Texture into this DefinitionModel
-     * @param materialName The name/CodeValue of the RenderMaterial
-     * @param params Parameters object which describes how to construct the RenderMaterial
-     * @returns The Id of the newly inserted RenderMaterial element.
-     * @throws [[IModelError]] if unable to insert the element.
-     */
-    static insert(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElementParams): Id64String;
-}
-/** @public */
-export declare namespace RenderMaterialElement {
-    /** Parameters used to construct a [[RenderMaterial]].
-     * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.
-     * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.
-     * @deprecated in 3.6 because it is not useful to use a `class` - just use [[RenderMaterialElementParams]] directly instead.
-     */
-    class Params {
-        /** A required palette name that categorizes this RenderMaterial */
-        paletteName: string;
-        /** An optional description of this RenderMaterial */
-        description?: string;
-        /** If defined, the color to use for surface fill or diffuse illumination, overriding the surface's own color. */
-        color?: RgbFactorProps;
-        /** The color to use for specular illumination. Default: black. */
-        specularColor?: RgbFactorProps;
-        /** The specular exponent describing the surface's shininess, in the range 0 through 128.
-         * Default: 0.
-         */
-        finish?: number;
-        /** A transparency to be applied to the surface, ranging from 0 (fully opaque) to 1 (fully transparent).
-         * The surface's own transparency will be multiplied by `(1 - transmit)`. permitting the material to increase but not decrease the surface transparency.
-         * Default: 13.5.
-         */
-        transmit?: number;
-        /** The surface's diffuse reflectivity from 0.0 to 1.0. Default: 0.6. */
-        diffuse?: number;
-        /** The surface's specular reflectivity from 0.0 to 1.0. Default: 0.0. */
-        specular?: number;
-        /** Currently unused. */
-        reflect?: number;
-        /** Currently unused. */
-        reflectColor?: number[];
-        /** Specifies a texture image to map onto the surface, replacing or mixing with the surface's own color and transparency.
-         * @note With the exception of `TextureId`, the [TextureMapProps]($common) of [[patternMap]] and [[normalMap]] are expected to be identical. If a property is defined in both
-         * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.
-         */
-        patternMap?: TextureMapProps;
-        /** Specifies a [normal map](https://en.wikipedia.org/wiki/Normal_mapping) to apply to the surface to simulate more surface detail than is present in the
-         * surface's geometry.
-         * @note With the exception of `TextureId`, the [TextureMapProps]($common) of [[patternMap]] and [[normalMap]] are expected to be identical. If a property is defined in both
-         * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.
-         */
-        normalMap?: NormalMapProps & {
-            /** A factor by which to multiply the components of the normal vectors read from the texture.
-             * Default: 1.
-             */
-            scale?: number;
-        };
-        /** Construct a new RenderMaterial.Params object with the specified paletteName. Alter the public members on that object to specify settings. */
-        constructor(paletteName: string);
-    }
-}
-/** Parameters used to create a [[RenderMaterial]] element.
- * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.
- * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.
- * @public
- */
-export interface RenderMaterialElementParams extends RenderMaterialElement.Params {
-}
+/** @packageDocumentation
+ * @module Elements
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { Code, CodeScopeProps, NormalMapProps, RenderMaterialProps, RgbFactorProps, TextureMapProps } from "@itwin/core-common";
+import { DefinitionElement } from "./Element";
+import { IModelDb } from "./IModelDb";
+/** A PhysicalMaterial defines the matter that makes up physical elements.
+ * @note See [[RenderMaterialElement]] for the DefinitionElement used to define rendering characteristics.
+ * @public
+ */
+export declare abstract class PhysicalMaterial extends DefinitionElement {
+    /** @internal */
+    static get className(): string;
+    /** Create a Code for a PhysicalMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModelDb
+     * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
+     * @param name The name (codeValue) of the PhysicalMaterial
+     */
+    static createCode(iModel: IModelDb, definitionModelId: CodeScopeProps, name: string): Code;
+    /** Create a PhysicalMaterial
+     * @param iModelDb The IModelDb
+     * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
+     * @param name The name (codeValue) of the PhysicalMaterial
+     * @returns The newly constructed PhysicalMaterial
+     * @throws [[IModelError]] if there is a problem creating the PhysicalMaterial
+     */
+    static create<T extends PhysicalMaterial>(iModelDb: IModelDb, definitionModelId: CodeScopeProps, name: string): T;
+}
+/** Defines a rendering material.
+ * @note See [[PhysicalMaterial]] for the DefinitionElement used to define the matter that makes up physical elements.
+ * @public
+ */
+export declare class RenderMaterialElement extends DefinitionElement {
+    /** @internal */
+    static get className(): string;
+    /** The name of a palette that can be used to categorize multiple materials. */
+    paletteName: string;
+    /** An optional description of the material. */
+    description?: string;
+    /** @internal */
+    constructor(props: RenderMaterialProps, iModel: IModelDb);
+    /** @internal */
+    toJSON(): RenderMaterialProps;
+    /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
+     * @param iModel  The IModelDb
+     * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.
+     * @param name The RenderMaterial name
+     */
+    static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, name: string): Code;
+    /**
+     * Create a RenderMaterial with given parameters.
+     * @param iModelDb The iModel
+     * @param definitionModelId The [[DefinitionModel]]
+     * @param materialName The name/CodeValue of the RenderMaterial
+     * @param params Parameters object which describes how to construct the RenderMaterial
+     * @returns The newly constructed RenderMaterial element.
+     * @throws [[IModelError]] if unable to create the element.
+     */
+    static create(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElementParams): RenderMaterialElement;
+    /**
+     * Insert a new RenderMaterial into a model.
+     * @param iModelDb Insert into this iModel
+     * @param definitionModelId Insert the new Texture into this DefinitionModel
+     * @param materialName The name/CodeValue of the RenderMaterial
+     * @param params Parameters object which describes how to construct the RenderMaterial
+     * @returns The Id of the newly inserted RenderMaterial element.
+     * @throws [[IModelError]] if unable to insert the element.
+     */
+    static insert(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElementParams): Id64String;
+}
+/** @public */
+export declare namespace RenderMaterialElement {
+    /** Parameters used to construct a [[RenderMaterial]].
+     * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.
+     * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.
+     * @deprecated in 3.6 because it is not useful to use a `class` - just use [[RenderMaterialElementParams]] directly instead.
+     */
+    class Params {
+        /** A required palette name that categorizes this RenderMaterial */
+        paletteName: string;
+        /** An optional description of this RenderMaterial */
+        description?: string;
+        /** If defined, the color to use for surface fill or diffuse illumination, overriding the surface's own color. */
+        color?: RgbFactorProps;
+        /** The color to use for specular illumination. Default: black. */
+        specularColor?: RgbFactorProps;
+        /** The specular exponent describing the surface's shininess, in the range 0 through 128.
+         * Default: 0.
+         */
+        finish?: number;
+        /** A transparency to be applied to the surface, ranging from 0 (fully opaque) to 1 (fully transparent).
+         * The surface's own transparency will be multiplied by `(1 - transmit)`. permitting the material to increase but not decrease the surface transparency.
+         * Default: 13.5.
+         */
+        transmit?: number;
+        /** The surface's diffuse reflectivity from 0.0 to 1.0. Default: 0.6. */
+        diffuse?: number;
+        /** The surface's specular reflectivity from 0.0 to 1.0. Default: 0.0. */
+        specular?: number;
+        /** Currently unused. */
+        reflect?: number;
+        /** Currently unused. */
+        reflectColor?: number[];
+        /** Specifies a texture image to map onto the surface, replacing or mixing with the surface's own color and transparency.
+         * @note With the exception of `TextureId`, the [TextureMapProps]($common) of [[patternMap]] and [[normalMap]] are expected to be identical. If a property is defined in both
+         * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.
+         */
+        patternMap?: TextureMapProps;
+        /** Specifies a [normal map](https://en.wikipedia.org/wiki/Normal_mapping) to apply to the surface to simulate more surface detail than is present in the
+         * surface's geometry.
+         * @note With the exception of `TextureId`, the [TextureMapProps]($common) of [[patternMap]] and [[normalMap]] are expected to be identical. If a property is defined in both
+         * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.
+         */
+        normalMap?: NormalMapProps & {
+            /** A factor by which to multiply the components of the normal vectors read from the texture.
+             * Default: 1.
+             */
+            scale?: number;
+        };
+        /** Construct a new RenderMaterial.Params object with the specified paletteName. Alter the public members on that object to specify settings. */
+        constructor(paletteName: string);
+    }
+}
+/** Parameters used to create a [[RenderMaterial]] element.
+ * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.
+ * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.
+ * @public
+ */
+export interface RenderMaterialElementParams extends RenderMaterialElement.Params {
+}
 //# sourceMappingURL=Material.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Material.d.ts","sourceRoot":"","sources":["../../src/Material.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EACQ,IAAI,EAAE,cAAc,EAAoC,cAAc,EAAgC,mBAAmB,EAAE,cAAc,EAAE,eAAe,EACxK,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;;GAGG;AACH,8BAAsB,gBAAiB,SAAQ,iBAAiB;IAC9D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAIjG;;;;;;OAMG;WACW,MAAM,CAAC,CAAC,SAAS,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;CAQzH;AAED;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,iBAAiB;IAC1D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAE3E,+EAA+E;IACxE,WAAW,EAAE,MAAM,CAAC;IAC3B,+CAA+C;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB;gBACJ,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAKxD,gBAAgB;IACA,MAAM,IAAI,mBAAmB;IAM7C;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAI5F;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,2BAA2B,GAAG,qBAAqB;IA2EzJ;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,2BAA2B,GAAG,UAAU;CAI/I;AAED,cAAc;AACd,yBAAiB,qBAAqB,CAAC;IACrC;;;;OAIG;IACH,MAAa,MAAM;QACjB,mEAAmE;QAC5D,WAAW,EAAE,MAAM,CAAC;QAC3B,qDAAqD;QAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;QAC5B,iHAAiH;QAC1G,KAAK,CAAC,EAAE,cAAc,CAAC;QAC9B,kEAAkE;QAC3D,aAAa,CAAC,EAAE,cAAc,CAAC;QACtC;;WAEG;QACI,MAAM,CAAC,EAAE,MAAM,CAAC;QACvB;;;WAGG;QACI,QAAQ,CAAC,EAAE,MAAM,CAAC;QACzB,wEAAwE;QACjE,OAAO,CAAC,EAAE,MAAM,CAAC;QACxB,yEAAyE;QAClE,QAAQ,CAAC,EAAE,MAAM,CAAC;QACzB,wBAAwB;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACxB,wBAAwB;QACjB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;QAC/B;;;WAGG;QACI,UAAU,CAAC,EAAE,eAAe,CAAC;QACpC;;;;WAIG;QACI,SAAS,CAAC,EAAE,cAAc,GAAG;YAClC;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QAEF,gJAAgJ;oBAC7H,WAAW,EAAE,MAAM;KAGvC;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB,CAAC,MAAM;CAChF"}
+{"version":3,"file":"Material.d.ts","sourceRoot":"","sources":["../../src/Material.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EACQ,IAAI,EAAE,cAAc,EAAoC,cAAc,EAAgC,mBAAmB,EAAE,cAAc,EAAE,eAAe,EACxK,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;;GAGG;AACH,8BAAsB,gBAAiB,SAAQ,iBAAiB;IAC9D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA+B;IAC7E;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAIjG;;;;;;OAMG;WACW,MAAM,CAAC,CAAC,SAAS,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;CAQzH;AAED;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,iBAAiB;IAC1D,gBAAgB;IAChB,WAA2B,SAAS,IAAI,MAAM,CAA6B;IAE3E,+EAA+E;IACxE,WAAW,EAAE,MAAM,CAAC;IAC3B,+CAA+C;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB;gBACJ,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,QAAQ;IAKxD,gBAAgB;IACA,MAAM,IAAI,mBAAmB;IAM7C;;;;OAIG;WACW,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAI5F;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,2BAA2B,GAAG,qBAAqB;IAgFzJ;;;;;;;;OAQG;WACW,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,iBAAiB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,2BAA2B,GAAG,UAAU;CAI/I;AAED,cAAc;AACd,yBAAiB,qBAAqB,CAAC;IACrC;;;;OAIG;IACH,MAAa,MAAM;QACjB,mEAAmE;QAC5D,WAAW,EAAE,MAAM,CAAC;QAC3B,qDAAqD;QAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;QAC5B,iHAAiH;QAC1G,KAAK,CAAC,EAAE,cAAc,CAAC;QAC9B,kEAAkE;QAC3D,aAAa,CAAC,EAAE,cAAc,CAAC;QACtC;;WAEG;QACI,MAAM,CAAC,EAAE,MAAM,CAAC;QACvB;;;WAGG;QACI,QAAQ,CAAC,EAAE,MAAM,CAAC;QACzB,wEAAwE;QACjE,OAAO,CAAC,EAAE,MAAM,CAAC;QACxB,yEAAyE;QAClE,QAAQ,CAAC,EAAE,MAAM,CAAC;QACzB,wBAAwB;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACxB,wBAAwB;QACjB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;QAC/B;;;WAGG;QACI,UAAU,CAAC,EAAE,eAAe,CAAC;QACpC;;;;WAIG;QACI,SAAS,CAAC,EAAE,cAAc,GAAG;YAClC;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QAEF,gJAAgJ;oBAC7H,WAAW,EAAE,MAAM;KAGvC;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB,CAAC,MAAM;CAChF"}