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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (255) hide show
  1. package/CHANGELOG.md +55 -1
  2. package/lib/cjs/BackendHubAccess.d.ts +224 -224
  3. package/lib/cjs/BackendHubAccess.d.ts.map +1 -1
  4. package/lib/cjs/BackendHubAccess.js +41 -41
  5. package/lib/cjs/BackendHubAccess.js.map +1 -1
  6. package/lib/cjs/BackendLoggerCategory.d.ts +90 -91
  7. package/lib/cjs/BackendLoggerCategory.d.ts.map +1 -1
  8. package/lib/cjs/BackendLoggerCategory.js +98 -99
  9. package/lib/cjs/BackendLoggerCategory.js.map +1 -1
  10. package/lib/cjs/BisCoreSchema.d.ts +21 -21
  11. package/lib/cjs/BisCoreSchema.js +60 -60
  12. package/lib/cjs/BriefcaseManager.d.ts +170 -170
  13. package/lib/cjs/BriefcaseManager.d.ts.map +1 -1
  14. package/lib/cjs/BriefcaseManager.js +408 -414
  15. package/lib/cjs/BriefcaseManager.js.map +1 -1
  16. package/lib/cjs/Category.d.ts +153 -153
  17. package/lib/cjs/Category.js +243 -243
  18. package/lib/cjs/Category.js.map +1 -1
  19. package/lib/cjs/ChangeSummaryManager.d.ts +187 -187
  20. package/lib/cjs/ChangeSummaryManager.js +444 -445
  21. package/lib/cjs/ChangeSummaryManager.js.map +1 -1
  22. package/lib/cjs/ChangedElementsDb.d.ts +99 -99
  23. package/lib/cjs/ChangedElementsDb.js +165 -165
  24. package/lib/cjs/ChangedElementsManager.d.ts +39 -39
  25. package/lib/cjs/ChangedElementsManager.js +88 -88
  26. package/lib/cjs/ChannelControl.d.ts +70 -0
  27. package/lib/cjs/ChannelControl.d.ts.map +1 -0
  28. package/lib/cjs/ChannelControl.js +89 -0
  29. package/lib/cjs/ChannelControl.js.map +1 -0
  30. package/lib/cjs/CheckpointManager.d.ts +121 -121
  31. package/lib/cjs/CheckpointManager.d.ts.map +1 -1
  32. package/lib/cjs/CheckpointManager.js +351 -349
  33. package/lib/cjs/CheckpointManager.js.map +1 -1
  34. package/lib/cjs/ClassRegistry.d.ts +79 -79
  35. package/lib/cjs/ClassRegistry.js +249 -245
  36. package/lib/cjs/ClassRegistry.js.map +1 -1
  37. package/lib/cjs/CloudSqlite.d.ts +355 -350
  38. package/lib/cjs/CloudSqlite.d.ts.map +1 -1
  39. package/lib/cjs/CloudSqlite.js +154 -153
  40. package/lib/cjs/CloudSqlite.js.map +1 -1
  41. package/lib/cjs/CodeService.d.ts +396 -396
  42. package/lib/cjs/CodeService.d.ts.map +1 -1
  43. package/lib/cjs/CodeService.js +63 -63
  44. package/lib/cjs/CodeService.js.map +1 -1
  45. package/lib/cjs/CodeSpecs.d.ts +55 -55
  46. package/lib/cjs/CodeSpecs.js +124 -124
  47. package/lib/cjs/ConcurrentQuery.d.ts +13 -13
  48. package/lib/cjs/ConcurrentQuery.d.ts.map +1 -1
  49. package/lib/cjs/ConcurrentQuery.js +36 -36
  50. package/lib/cjs/CustomViewState3dCreator.d.ts +21 -21
  51. package/lib/cjs/CustomViewState3dCreator.d.ts.map +1 -1
  52. package/lib/cjs/CustomViewState3dCreator.js +80 -81
  53. package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
  54. package/lib/cjs/DevTools.d.ts +74 -71
  55. package/lib/cjs/DevTools.d.ts.map +1 -1
  56. package/lib/cjs/DevTools.js +156 -154
  57. package/lib/cjs/DevTools.js.map +1 -1
  58. package/lib/cjs/DisplayStyle.d.ts +106 -106
  59. package/lib/cjs/DisplayStyle.js +253 -256
  60. package/lib/cjs/DisplayStyle.js.map +1 -1
  61. package/lib/cjs/ECDb.d.ts +194 -191
  62. package/lib/cjs/ECDb.d.ts.map +1 -1
  63. package/lib/cjs/ECDb.js +351 -350
  64. package/lib/cjs/ECDb.js.map +1 -1
  65. package/lib/cjs/ECSchemaXmlContext.d.ts +18 -18
  66. package/lib/cjs/ECSchemaXmlContext.d.ts.map +1 -1
  67. package/lib/cjs/ECSchemaXmlContext.js +41 -41
  68. package/lib/cjs/ECSqlStatement.d.ts +473 -473
  69. package/lib/cjs/ECSqlStatement.js +791 -791
  70. package/lib/cjs/Element.d.ts +1113 -1109
  71. package/lib/cjs/Element.d.ts.map +1 -1
  72. package/lib/cjs/Element.js +1424 -1427
  73. package/lib/cjs/Element.js.map +1 -1
  74. package/lib/cjs/ElementAspect.d.ts +176 -179
  75. package/lib/cjs/ElementAspect.d.ts.map +1 -1
  76. package/lib/cjs/ElementAspect.js +203 -211
  77. package/lib/cjs/ElementAspect.js.map +1 -1
  78. package/lib/cjs/ElementGraphics.d.ts +9 -9
  79. package/lib/cjs/ElementGraphics.js +41 -41
  80. package/lib/cjs/ElementGraphics.js.map +1 -1
  81. package/lib/cjs/ElementTreeWalker.d.ts +162 -162
  82. package/lib/cjs/ElementTreeWalker.d.ts.map +1 -1
  83. package/lib/cjs/ElementTreeWalker.js +409 -409
  84. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  85. package/lib/cjs/Entity.d.ts +106 -106
  86. package/lib/cjs/Entity.d.ts.map +1 -1
  87. package/lib/cjs/Entity.js +134 -134
  88. package/lib/cjs/Entity.js.map +1 -1
  89. package/lib/cjs/EntityReferences.d.ts +49 -49
  90. package/lib/cjs/EntityReferences.d.ts.map +1 -1
  91. package/lib/cjs/EntityReferences.js +95 -95
  92. package/lib/cjs/ExportGraphics.d.ts +317 -317
  93. package/lib/cjs/ExportGraphics.d.ts.map +1 -1
  94. package/lib/cjs/ExportGraphics.js +208 -208
  95. package/lib/cjs/ExternalSource.d.ts +96 -96
  96. package/lib/cjs/ExternalSource.js +131 -131
  97. package/lib/cjs/ExternalSource.js.map +1 -1
  98. package/lib/cjs/GeoCoordConfig.d.ts +19 -19
  99. package/lib/cjs/GeoCoordConfig.js +85 -85
  100. package/lib/cjs/GeoCoordConfig.js.map +1 -1
  101. package/lib/cjs/GeometrySummary.d.ts +4 -4
  102. package/lib/cjs/GeometrySummary.js +333 -333
  103. package/lib/cjs/GeometrySummary.js.map +1 -1
  104. package/lib/cjs/HubMock.d.ts +94 -94
  105. package/lib/cjs/HubMock.js +220 -222
  106. package/lib/cjs/HubMock.js.map +1 -1
  107. package/lib/cjs/IModelCloneContext.d.ts +8 -8
  108. package/lib/cjs/IModelCloneContext.d.ts.map +1 -1
  109. package/lib/cjs/IModelCloneContext.js +15 -15
  110. package/lib/cjs/IModelDb.d.ts +1216 -1196
  111. package/lib/cjs/IModelDb.d.ts.map +1 -1
  112. package/lib/cjs/IModelDb.js +2384 -2392
  113. package/lib/cjs/IModelDb.js.map +1 -1
  114. package/lib/cjs/IModelElementCloneContext.d.ts +89 -89
  115. package/lib/cjs/IModelElementCloneContext.js +159 -159
  116. package/lib/cjs/IModelHost.d.ts +355 -369
  117. package/lib/cjs/IModelHost.d.ts.map +1 -1
  118. package/lib/cjs/IModelHost.js +472 -496
  119. package/lib/cjs/IModelHost.js.map +1 -1
  120. package/lib/cjs/IModelJsFs.d.ts +62 -62
  121. package/lib/cjs/IModelJsFs.js +139 -140
  122. package/lib/cjs/IModelJsFs.js.map +1 -1
  123. package/lib/cjs/IpcHost.d.ts +104 -104
  124. package/lib/cjs/IpcHost.js +276 -278
  125. package/lib/cjs/IpcHost.js.map +1 -1
  126. package/lib/cjs/LineStyle.d.ts +311 -311
  127. package/lib/cjs/LineStyle.js +295 -295
  128. package/lib/cjs/LocalHub.d.ts +162 -162
  129. package/lib/cjs/LocalHub.d.ts.map +1 -1
  130. package/lib/cjs/LocalHub.js +579 -584
  131. package/lib/cjs/LocalHub.js.map +1 -1
  132. package/lib/cjs/LocalhostIpcHost.d.ts +21 -20
  133. package/lib/cjs/LocalhostIpcHost.d.ts.map +1 -1
  134. package/lib/cjs/LocalhostIpcHost.js +79 -81
  135. package/lib/cjs/LocalhostIpcHost.js.map +1 -1
  136. package/lib/cjs/Material.d.ts +131 -131
  137. package/lib/cjs/Material.js +180 -181
  138. package/lib/cjs/Material.js.map +1 -1
  139. package/lib/cjs/Model.d.ts +392 -392
  140. package/lib/cjs/Model.d.ts.map +1 -1
  141. package/lib/cjs/Model.js +489 -485
  142. package/lib/cjs/Model.js.map +1 -1
  143. package/lib/cjs/NativeAppStorage.d.ts +51 -51
  144. package/lib/cjs/NativeAppStorage.js +202 -202
  145. package/lib/cjs/NativeAppStorage.js.map +1 -1
  146. package/lib/cjs/NativeHost.d.ts +52 -52
  147. package/lib/cjs/NativeHost.js +160 -163
  148. package/lib/cjs/NativeHost.js.map +1 -1
  149. package/lib/cjs/NavigationRelationship.d.ts +156 -156
  150. package/lib/cjs/NavigationRelationship.js +225 -225
  151. package/lib/cjs/NavigationRelationship.js.map +1 -1
  152. package/lib/cjs/PromiseMemoizer.d.ts +51 -51
  153. package/lib/cjs/PromiseMemoizer.d.ts.map +1 -1
  154. package/lib/cjs/PromiseMemoizer.js +101 -101
  155. package/lib/cjs/PromiseMemoizer.js.map +1 -1
  156. package/lib/cjs/PropertyStore.d.ts +132 -132
  157. package/lib/cjs/PropertyStore.js +11 -11
  158. package/lib/cjs/Relationship.d.ts +416 -416
  159. package/lib/cjs/Relationship.js +494 -494
  160. package/lib/cjs/Relationship.js.map +1 -1
  161. package/lib/cjs/RpcBackend.d.ts +5 -5
  162. package/lib/cjs/RpcBackend.js +32 -32
  163. package/lib/cjs/SQLiteDb.d.ts +219 -219
  164. package/lib/cjs/SQLiteDb.js +212 -214
  165. package/lib/cjs/SQLiteDb.js.map +1 -1
  166. package/lib/cjs/Schema.d.ts +55 -55
  167. package/lib/cjs/Schema.js +83 -83
  168. package/lib/cjs/Schema.js.map +1 -1
  169. package/lib/cjs/ServerBasedLocks.d.ts +57 -57
  170. package/lib/cjs/ServerBasedLocks.js +168 -168
  171. package/lib/cjs/ServerBasedLocks.js.map +1 -1
  172. package/lib/cjs/SqliteStatement.d.ts +360 -360
  173. package/lib/cjs/SqliteStatement.d.ts.map +1 -1
  174. package/lib/cjs/SqliteStatement.js +586 -586
  175. package/lib/cjs/Texture.d.ts +58 -58
  176. package/lib/cjs/Texture.js +82 -82
  177. package/lib/cjs/Texture.js.map +1 -1
  178. package/lib/cjs/TileStorage.d.ts +44 -18
  179. package/lib/cjs/TileStorage.d.ts.map +1 -1
  180. package/lib/cjs/TileStorage.js +109 -90
  181. package/lib/cjs/TileStorage.js.map +1 -1
  182. package/lib/cjs/TxnManager.d.ts +202 -202
  183. package/lib/cjs/TxnManager.d.ts.map +1 -1
  184. package/lib/cjs/TxnManager.js +356 -356
  185. package/lib/cjs/TxnManager.js.map +1 -1
  186. package/lib/cjs/ViewDefinition.d.ts +435 -439
  187. package/lib/cjs/ViewDefinition.d.ts.map +1 -1
  188. package/lib/cjs/ViewDefinition.js +646 -646
  189. package/lib/cjs/ViewDefinition.js.map +1 -1
  190. package/lib/cjs/ViewStateHydrator.d.ts +13 -13
  191. package/lib/cjs/ViewStateHydrator.js +103 -103
  192. package/lib/cjs/core-backend.d.ts +184 -184
  193. package/lib/cjs/core-backend.d.ts.map +1 -1
  194. package/lib/cjs/core-backend.js +208 -204
  195. package/lib/cjs/core-backend.js.map +1 -1
  196. package/lib/cjs/domains/FunctionalElements.d.ts +101 -101
  197. package/lib/cjs/domains/FunctionalElements.js +145 -145
  198. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  199. package/lib/cjs/domains/FunctionalSchema.d.ts +13 -13
  200. package/lib/cjs/domains/FunctionalSchema.d.ts.map +1 -1
  201. package/lib/cjs/domains/FunctionalSchema.js +39 -40
  202. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  203. package/lib/cjs/domains/GenericElements.d.ts +177 -177
  204. package/lib/cjs/domains/GenericElements.js +263 -263
  205. package/lib/cjs/domains/GenericSchema.d.ts +10 -10
  206. package/lib/cjs/domains/GenericSchema.js +28 -28
  207. package/lib/cjs/rpc/multipart.d.ts +11 -11
  208. package/lib/cjs/rpc/multipart.js +71 -71
  209. package/lib/cjs/rpc/tracing.d.ts +28 -28
  210. package/lib/cjs/rpc/tracing.js +73 -74
  211. package/lib/cjs/rpc/tracing.js.map +1 -1
  212. package/lib/cjs/rpc/web/logging.d.ts +9 -9
  213. package/lib/cjs/rpc/web/logging.js +43 -43
  214. package/lib/cjs/rpc/web/request.d.ts +6 -6
  215. package/lib/cjs/rpc/web/request.js +73 -74
  216. package/lib/cjs/rpc/web/request.js.map +1 -1
  217. package/lib/cjs/rpc/web/response.d.ts +6 -6
  218. package/lib/cjs/rpc/web/response.js +105 -106
  219. package/lib/cjs/rpc/web/response.js.map +1 -1
  220. package/lib/cjs/rpc-impl/DevToolsRpcImpl.d.ts +15 -15
  221. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js +32 -32
  222. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts +47 -47
  223. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js +293 -294
  224. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  225. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts +20 -22
  226. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts.map +1 -1
  227. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js +190 -205
  228. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
  229. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts +36 -36
  230. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js +166 -168
  231. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
  232. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts +16 -16
  233. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js +42 -43
  234. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
  235. package/lib/cjs/rpc-impl/WipRpcImpl.d.ts +15 -15
  236. package/lib/cjs/rpc-impl/WipRpcImpl.js +37 -37
  237. package/lib/cjs/workspace/Settings.d.ts +186 -186
  238. package/lib/cjs/workspace/Settings.d.ts.map +1 -1
  239. package/lib/cjs/workspace/Settings.js +154 -155
  240. package/lib/cjs/workspace/Settings.js.map +1 -1
  241. package/lib/cjs/workspace/SettingsSchemas.d.ts +75 -75
  242. package/lib/cjs/workspace/SettingsSchemas.js +190 -191
  243. package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
  244. package/lib/cjs/workspace/Workspace.d.ts +414 -414
  245. package/lib/cjs/workspace/Workspace.js +537 -543
  246. package/lib/cjs/workspace/Workspace.js.map +1 -1
  247. package/package.json +22 -24
  248. package/lib/cjs/AliCloudStorageService.d.ts +0 -24
  249. package/lib/cjs/AliCloudStorageService.d.ts.map +0 -1
  250. package/lib/cjs/AliCloudStorageService.js +0 -72
  251. package/lib/cjs/AliCloudStorageService.js.map +0 -1
  252. package/lib/cjs/CloudStorageBackend.d.ts +0 -59
  253. package/lib/cjs/CloudStorageBackend.d.ts.map +0 -1
  254. package/lib/cjs/CloudStorageBackend.js +0 -174
  255. package/lib/cjs/CloudStorageBackend.js.map +0 -1
@@ -1,132 +1,132 @@
1
- /** @packageDocumentation
2
- * @module Elements
3
- */
4
- import { Id64String } from "@itwin/core-bentley";
5
- import { Code, CodeScopeProps, NormalMapProps, RenderMaterialProps, RgbFactorProps, TextureMapProps } from "@itwin/core-common";
6
- import { DefinitionElement } from "./Element";
7
- import { IModelDb } from "./IModelDb";
8
- /** A PhysicalMaterial defines the matter that makes up physical elements.
9
- * @note See [[RenderMaterialElement]] for the DefinitionElement used to define rendering characteristics.
10
- * @public
11
- */
12
- export declare abstract class PhysicalMaterial extends DefinitionElement {
13
- /** @internal */
14
- static get className(): string;
15
- /** Create a Code for a PhysicalMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
16
- * @param iModel The IModelDb
17
- * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
18
- * @param name The name (codeValue) of the PhysicalMaterial
19
- */
20
- static createCode(iModel: IModelDb, definitionModelId: CodeScopeProps, name: string): Code;
21
- /** Create a PhysicalMaterial
22
- * @param iModelDb The IModelDb
23
- * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
24
- * @param name The name (codeValue) of the PhysicalMaterial
25
- * @returns The newly constructed PhysicalMaterial
26
- * @throws [[IModelError]] if there is a problem creating the PhysicalMaterial
27
- */
28
- static create<T extends PhysicalMaterial>(iModelDb: IModelDb, definitionModelId: CodeScopeProps, name: string): T;
29
- }
30
- /** Defines a rendering material.
31
- * @note See [[PhysicalMaterial]] for the DefinitionElement used to define the matter that makes up physical elements.
32
- * @public
33
- */
34
- export declare class RenderMaterialElement extends DefinitionElement {
35
- /** @internal */
36
- static get className(): string;
37
- /** The name of a palette that can be used to categorize multiple materials. */
38
- paletteName: string;
39
- /** An optional description of the material. */
40
- description?: string;
41
- /** @internal */
42
- constructor(props: RenderMaterialProps, iModel: IModelDb);
43
- /** @internal */
44
- toJSON(): RenderMaterialProps;
45
- /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
46
- * @param iModel The IModelDb
47
- * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.
48
- * @param name The RenderMaterial name
49
- */
50
- static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, name: string): Code;
51
- /**
52
- * Create a RenderMaterial with given parameters.
53
- * @param iModelDb The iModel
54
- * @param definitionModelId The [[DefinitionModel]]
55
- * @param materialName The name/CodeValue of the RenderMaterial
56
- * @param params Parameters object which describes how to construct the RenderMaterial
57
- * @returns The newly constructed RenderMaterial element.
58
- * @throws [[IModelError]] if unable to create the element.
59
- */
60
- static create(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElementParams): RenderMaterialElement;
61
- /**
62
- * Insert a new RenderMaterial into a model.
63
- * @param iModelDb Insert into this iModel
64
- * @param definitionModelId Insert the new Texture into this DefinitionModel
65
- * @param materialName The name/CodeValue of the RenderMaterial
66
- * @param params Parameters object which describes how to construct the RenderMaterial
67
- * @returns The Id of the newly inserted RenderMaterial element.
68
- * @throws [[IModelError]] if unable to insert the element.
69
- */
70
- static insert(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElementParams): Id64String;
71
- }
72
- /** @public */
73
- export declare namespace RenderMaterialElement {
74
- /** Parameters used to construct a [[RenderMaterial]].
75
- * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.
76
- * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.
77
- * @deprecated in 3.6 because it is not useful to use a `class` - just use [[RenderMaterialElementParams]] directly instead.
78
- */
79
- class Params {
80
- /** A required palette name that categorizes this RenderMaterial */
81
- paletteName: string;
82
- /** An optional description of this RenderMaterial */
83
- description?: string;
84
- /** If defined, the color to use for surface fill or diffuse illumination, overriding the surface's own color. */
85
- color?: RgbFactorProps;
86
- /** The color to use for specular illumination. Default: black. */
87
- specularColor?: RgbFactorProps;
88
- /** The specular exponent describing the surface's shininess, in the range 0 through 128.
89
- * Default: 0.
90
- */
91
- finish?: number;
92
- /** A transparency to be applied to the surface, ranging from 0 (fully opaque) to 1 (fully transparent).
93
- * The surface's own transparency will be multiplied by `(1 - transmit)`. permitting the material to increase but not decrease the surface transparency.
94
- * Default: 13.5.
95
- */
96
- transmit?: number;
97
- /** The surface's diffuse reflectivity from 0.0 to 1.0. Default: 0.6. */
98
- diffuse?: number;
99
- /** The surface's specular reflectivity from 0.0 to 1.0. Default: 0.0. */
100
- specular?: number;
101
- /** Currently unused. */
102
- reflect?: number;
103
- /** Currently unused. */
104
- reflectColor?: number[];
105
- /** Specifies a texture image to map onto the surface, replacing or mixing with the surface's own color and transparency.
106
- * @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
107
- * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.
108
- */
109
- patternMap?: TextureMapProps;
110
- /** 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
111
- * surface's geometry.
112
- * @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
113
- * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.
114
- */
115
- normalMap?: NormalMapProps & {
116
- /** A factor by which to multiply the components of the normal vectors read from the texture.
117
- * Default: 1.
118
- */
119
- scale?: number;
120
- };
121
- /** Construct a new RenderMaterial.Params object with the specified paletteName. Alter the public members on that object to specify settings. */
122
- constructor(paletteName: string);
123
- }
124
- }
125
- /** Parameters used to create a [[RenderMaterial]] element.
126
- * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.
127
- * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.
128
- * @public
129
- */
130
- export interface RenderMaterialElementParams extends RenderMaterialElement.Params {
131
- }
1
+ /** @packageDocumentation
2
+ * @module Elements
3
+ */
4
+ import { Id64String } from "@itwin/core-bentley";
5
+ import { Code, CodeScopeProps, NormalMapProps, RenderMaterialProps, RgbFactorProps, TextureMapProps } from "@itwin/core-common";
6
+ import { DefinitionElement } from "./Element";
7
+ import { IModelDb } from "./IModelDb";
8
+ /** A PhysicalMaterial defines the matter that makes up physical elements.
9
+ * @note See [[RenderMaterialElement]] for the DefinitionElement used to define rendering characteristics.
10
+ * @public
11
+ */
12
+ export declare abstract class PhysicalMaterial extends DefinitionElement {
13
+ /** @internal */
14
+ static get className(): string;
15
+ /** Create a Code for a PhysicalMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
16
+ * @param iModel The IModelDb
17
+ * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
18
+ * @param name The name (codeValue) of the PhysicalMaterial
19
+ */
20
+ static createCode(iModel: IModelDb, definitionModelId: CodeScopeProps, name: string): Code;
21
+ /** Create a PhysicalMaterial
22
+ * @param iModelDb The IModelDb
23
+ * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
24
+ * @param name The name (codeValue) of the PhysicalMaterial
25
+ * @returns The newly constructed PhysicalMaterial
26
+ * @throws [[IModelError]] if there is a problem creating the PhysicalMaterial
27
+ */
28
+ static create<T extends PhysicalMaterial>(iModelDb: IModelDb, definitionModelId: CodeScopeProps, name: string): T;
29
+ }
30
+ /** Defines a rendering material.
31
+ * @note See [[PhysicalMaterial]] for the DefinitionElement used to define the matter that makes up physical elements.
32
+ * @public
33
+ */
34
+ export declare class RenderMaterialElement extends DefinitionElement {
35
+ /** @internal */
36
+ static get className(): string;
37
+ /** The name of a palette that can be used to categorize multiple materials. */
38
+ paletteName: string;
39
+ /** An optional description of the material. */
40
+ description?: string;
41
+ /** @internal */
42
+ constructor(props: RenderMaterialProps, iModel: IModelDb);
43
+ /** @internal */
44
+ toJSON(): RenderMaterialProps;
45
+ /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
46
+ * @param iModel The IModelDb
47
+ * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.
48
+ * @param name The RenderMaterial name
49
+ */
50
+ static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, name: string): Code;
51
+ /**
52
+ * Create a RenderMaterial with given parameters.
53
+ * @param iModelDb The iModel
54
+ * @param definitionModelId The [[DefinitionModel]]
55
+ * @param materialName The name/CodeValue of the RenderMaterial
56
+ * @param params Parameters object which describes how to construct the RenderMaterial
57
+ * @returns The newly constructed RenderMaterial element.
58
+ * @throws [[IModelError]] if unable to create the element.
59
+ */
60
+ static create(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElementParams): RenderMaterialElement;
61
+ /**
62
+ * Insert a new RenderMaterial into a model.
63
+ * @param iModelDb Insert into this iModel
64
+ * @param definitionModelId Insert the new Texture into this DefinitionModel
65
+ * @param materialName The name/CodeValue of the RenderMaterial
66
+ * @param params Parameters object which describes how to construct the RenderMaterial
67
+ * @returns The Id of the newly inserted RenderMaterial element.
68
+ * @throws [[IModelError]] if unable to insert the element.
69
+ */
70
+ static insert(iModelDb: IModelDb, definitionModelId: Id64String, materialName: string, params: RenderMaterialElementParams): Id64String;
71
+ }
72
+ /** @public */
73
+ export declare namespace RenderMaterialElement {
74
+ /** Parameters used to construct a [[RenderMaterial]].
75
+ * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.
76
+ * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.
77
+ * @deprecated in 3.6 because it is not useful to use a `class` - just use [[RenderMaterialElementParams]] directly instead.
78
+ */
79
+ class Params {
80
+ /** A required palette name that categorizes this RenderMaterial */
81
+ paletteName: string;
82
+ /** An optional description of this RenderMaterial */
83
+ description?: string;
84
+ /** If defined, the color to use for surface fill or diffuse illumination, overriding the surface's own color. */
85
+ color?: RgbFactorProps;
86
+ /** The color to use for specular illumination. Default: black. */
87
+ specularColor?: RgbFactorProps;
88
+ /** The specular exponent describing the surface's shininess, in the range 0 through 128.
89
+ * Default: 0.
90
+ */
91
+ finish?: number;
92
+ /** A transparency to be applied to the surface, ranging from 0 (fully opaque) to 1 (fully transparent).
93
+ * The surface's own transparency will be multiplied by `(1 - transmit)`. permitting the material to increase but not decrease the surface transparency.
94
+ * Default: 13.5.
95
+ */
96
+ transmit?: number;
97
+ /** The surface's diffuse reflectivity from 0.0 to 1.0. Default: 0.6. */
98
+ diffuse?: number;
99
+ /** The surface's specular reflectivity from 0.0 to 1.0. Default: 0.0. */
100
+ specular?: number;
101
+ /** Currently unused. */
102
+ reflect?: number;
103
+ /** Currently unused. */
104
+ reflectColor?: number[];
105
+ /** Specifies a texture image to map onto the surface, replacing or mixing with the surface's own color and transparency.
106
+ * @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
107
+ * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.
108
+ */
109
+ patternMap?: TextureMapProps;
110
+ /** 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
111
+ * surface's geometry.
112
+ * @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
113
+ * [[patternMap]]] and [[normalMap]], the value in [[patternMap]] takes precedence.
114
+ */
115
+ normalMap?: NormalMapProps & {
116
+ /** A factor by which to multiply the components of the normal vectors read from the texture.
117
+ * Default: 1.
118
+ */
119
+ scale?: number;
120
+ };
121
+ /** Construct a new RenderMaterial.Params object with the specified paletteName. Alter the public members on that object to specify settings. */
122
+ constructor(paletteName: string);
123
+ }
124
+ }
125
+ /** Parameters used to create a [[RenderMaterial]] element.
126
+ * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.
127
+ * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.
128
+ * @public
129
+ */
130
+ export interface RenderMaterialElementParams extends RenderMaterialElement.Params {
131
+ }
132
132
  //# sourceMappingURL=Material.d.ts.map
@@ -1,182 +1,181 @@
1
- "use strict";
2
- /*---------------------------------------------------------------------------------------------
3
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
- * See LICENSE.md in the project root for license terms and full copyright notice.
5
- *--------------------------------------------------------------------------------------------*/
6
- /** @packageDocumentation
7
- * @module Elements
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.RenderMaterialElement = exports.PhysicalMaterial = void 0;
11
- const core_common_1 = require("@itwin/core-common");
12
- const Element_1 = require("./Element");
13
- /* eslint-disable @typescript-eslint/naming-convention */
14
- /** A PhysicalMaterial defines the matter that makes up physical elements.
15
- * @note See [[RenderMaterialElement]] for the DefinitionElement used to define rendering characteristics.
16
- * @public
17
- */
18
- class PhysicalMaterial extends Element_1.DefinitionElement {
19
- /** @internal */
20
- static get className() { return "PhysicalMaterial"; }
21
- /** Create a Code for a PhysicalMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
22
- * @param iModel The IModelDb
23
- * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
24
- * @param name The name (codeValue) of the PhysicalMaterial
25
- */
26
- static createCode(iModel, definitionModelId, name) {
27
- const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.physicalMaterial);
28
- return new core_common_1.Code({ spec: codeSpec.id, scope: definitionModelId, value: name });
29
- }
30
- /** Create a PhysicalMaterial
31
- * @param iModelDb The IModelDb
32
- * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
33
- * @param name The name (codeValue) of the PhysicalMaterial
34
- * @returns The newly constructed PhysicalMaterial
35
- * @throws [[IModelError]] if there is a problem creating the PhysicalMaterial
36
- */
37
- static create(iModelDb, definitionModelId, name) {
38
- const elementProps = {
39
- classFullName: this.classFullName,
40
- model: definitionModelId,
41
- code: this.createCode(iModelDb, definitionModelId, name),
42
- };
43
- return iModelDb.elements.createElement(elementProps);
44
- }
45
- }
46
- exports.PhysicalMaterial = PhysicalMaterial;
47
- /** Defines a rendering material.
48
- * @note See [[PhysicalMaterial]] for the DefinitionElement used to define the matter that makes up physical elements.
49
- * @public
50
- */
51
- class RenderMaterialElement extends Element_1.DefinitionElement {
52
- /** @internal */
53
- constructor(props, iModel) {
54
- super(props, iModel);
55
- this.paletteName = props.paletteName;
56
- this.description = props.description;
57
- }
58
- /** @internal */
59
- static get className() { return "RenderMaterial"; }
60
- /** @internal */
61
- toJSON() {
62
- const val = super.toJSON();
63
- val.paletteName = this.paletteName;
64
- val.description = this.description;
65
- return val;
66
- }
67
- /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
68
- * @param iModel The IModelDb
69
- * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.
70
- * @param name The RenderMaterial name
71
- */
72
- static createCode(iModel, scopeModelId, name) {
73
- const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.texture);
74
- return 0 === name.length ? core_common_1.Code.createEmpty() : new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: name });
75
- }
76
- /**
77
- * Create a RenderMaterial with given parameters.
78
- * @param iModelDb The iModel
79
- * @param definitionModelId The [[DefinitionModel]]
80
- * @param materialName The name/CodeValue of the RenderMaterial
81
- * @param params Parameters object which describes how to construct the RenderMaterial
82
- * @returns The newly constructed RenderMaterial element.
83
- * @throws [[IModelError]] if unable to create the element.
84
- */
85
- static create(iModelDb, definitionModelId, materialName, params) {
86
- var _a;
87
- let maps;
88
- const pbr_normal = (_a = params.normalMap) === null || _a === void 0 ? void 0 : _a.scale;
89
- if (params.patternMap || params.normalMap) {
90
- function choose(obj, key) {
91
- const pat = params.patternMap;
92
- if (pat && undefined !== pat[key])
93
- obj[key] = pat[key];
94
- else if (params.normalMap && undefined !== params.normalMap[key])
95
- obj[key] = params.normalMap[key];
96
- }
97
- const baseProps = {};
98
- choose(baseProps, "pattern_angle");
99
- choose(baseProps, "pattern_u_flip");
100
- choose(baseProps, "pattern_flip");
101
- choose(baseProps, "pattern_scale");
102
- choose(baseProps, "pattern_offset");
103
- choose(baseProps, "pattern_scalemode");
104
- choose(baseProps, "pattern_mapping");
105
- choose(baseProps, "pattern_weight");
106
- maps = {};
107
- if (params.patternMap)
108
- maps.Pattern = { ...params.patternMap, ...baseProps };
109
- if (params.normalMap) {
110
- maps.Normal = {
111
- ...params.normalMap,
112
- ...baseProps,
113
- };
114
- delete maps.Normal.scale;
115
- }
116
- }
117
- // const map = undefined !== params.patternMap ? { Pattern: params.patternMap } : undefined;
118
- const renderMaterialProps = {
119
- classFullName: this.classFullName,
120
- code: this.createCode(iModelDb, definitionModelId, materialName),
121
- paletteName: params.paletteName,
122
- description: params.description,
123
- jsonProperties: {
124
- materialAssets: {
125
- renderMaterial: {
126
- HasBaseColor: params.color !== undefined,
127
- color: params.color,
128
- HasSpecularColor: params.specularColor !== undefined,
129
- specular_color: params.specularColor,
130
- HasFinish: params.finish !== undefined,
131
- finish: params.finish,
132
- HasTransmit: params.transmit !== undefined,
133
- transmit: params.transmit,
134
- HasDiffuse: params.diffuse !== undefined,
135
- diffuse: params.diffuse,
136
- HasSpecular: params.specular !== undefined,
137
- specular: params.specular,
138
- HasReflect: params.reflect !== undefined,
139
- reflect: params.reflect,
140
- HasReflectColor: params.reflectColor !== undefined,
141
- reflect_color: params.reflectColor,
142
- Map: maps,
143
- pbr_normal,
144
- },
145
- },
146
- },
147
- model: definitionModelId,
148
- isPrivate: false,
149
- };
150
- return new RenderMaterialElement(renderMaterialProps, iModelDb);
151
- }
152
- /**
153
- * Insert a new RenderMaterial into a model.
154
- * @param iModelDb Insert into this iModel
155
- * @param definitionModelId Insert the new Texture into this DefinitionModel
156
- * @param materialName The name/CodeValue of the RenderMaterial
157
- * @param params Parameters object which describes how to construct the RenderMaterial
158
- * @returns The Id of the newly inserted RenderMaterial element.
159
- * @throws [[IModelError]] if unable to insert the element.
160
- */
161
- static insert(iModelDb, definitionModelId, materialName, params) {
162
- const renderMaterial = this.create(iModelDb, definitionModelId, materialName, params);
163
- return iModelDb.elements.insertElement(renderMaterial.toJSON());
164
- }
165
- }
166
- exports.RenderMaterialElement = RenderMaterialElement;
167
- /** @public */
168
- (function (RenderMaterialElement) {
169
- /** Parameters used to construct a [[RenderMaterial]].
170
- * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.
171
- * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.
172
- * @deprecated in 3.6 because it is not useful to use a `class` - just use [[RenderMaterialElementParams]] directly instead.
173
- */
174
- class Params {
175
- /** Construct a new RenderMaterial.Params object with the specified paletteName. Alter the public members on that object to specify settings. */
176
- constructor(paletteName) {
177
- this.paletteName = paletteName;
178
- }
179
- }
180
- RenderMaterialElement.Params = Params;
181
- })(RenderMaterialElement = exports.RenderMaterialElement || (exports.RenderMaterialElement = {}));
1
+ "use strict";
2
+ /*---------------------------------------------------------------------------------------------
3
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
4
+ * See LICENSE.md in the project root for license terms and full copyright notice.
5
+ *--------------------------------------------------------------------------------------------*/
6
+ /** @packageDocumentation
7
+ * @module Elements
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.RenderMaterialElement = exports.PhysicalMaterial = void 0;
11
+ const core_common_1 = require("@itwin/core-common");
12
+ const Element_1 = require("./Element");
13
+ /* eslint-disable @typescript-eslint/naming-convention */
14
+ /** A PhysicalMaterial defines the matter that makes up physical elements.
15
+ * @note See [[RenderMaterialElement]] for the DefinitionElement used to define rendering characteristics.
16
+ * @public
17
+ */
18
+ class PhysicalMaterial extends Element_1.DefinitionElement {
19
+ /** @internal */
20
+ static get className() { return "PhysicalMaterial"; }
21
+ /** Create a Code for a PhysicalMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
22
+ * @param iModel The IModelDb
23
+ * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
24
+ * @param name The name (codeValue) of the PhysicalMaterial
25
+ */
26
+ static createCode(iModel, definitionModelId, name) {
27
+ const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.physicalMaterial);
28
+ return new core_common_1.Code({ spec: codeSpec.id, scope: definitionModelId, value: name });
29
+ }
30
+ /** Create a PhysicalMaterial
31
+ * @param iModelDb The IModelDb
32
+ * @param definitionModelId The Id of the DefinitionModel that will contain the PhysicalMaterial and provide the scope for its name.
33
+ * @param name The name (codeValue) of the PhysicalMaterial
34
+ * @returns The newly constructed PhysicalMaterial
35
+ * @throws [[IModelError]] if there is a problem creating the PhysicalMaterial
36
+ */
37
+ static create(iModelDb, definitionModelId, name) {
38
+ const elementProps = {
39
+ classFullName: this.classFullName,
40
+ model: definitionModelId,
41
+ code: this.createCode(iModelDb, definitionModelId, name),
42
+ };
43
+ return iModelDb.elements.createElement(elementProps);
44
+ }
45
+ }
46
+ exports.PhysicalMaterial = PhysicalMaterial;
47
+ /** Defines a rendering material.
48
+ * @note See [[PhysicalMaterial]] for the DefinitionElement used to define the matter that makes up physical elements.
49
+ * @public
50
+ */
51
+ class RenderMaterialElement extends Element_1.DefinitionElement {
52
+ /** @internal */
53
+ static get className() { return "RenderMaterial"; }
54
+ /** @internal */
55
+ constructor(props, iModel) {
56
+ super(props, iModel);
57
+ this.paletteName = props.paletteName;
58
+ this.description = props.description;
59
+ }
60
+ /** @internal */
61
+ toJSON() {
62
+ const val = super.toJSON();
63
+ val.paletteName = this.paletteName;
64
+ val.description = this.description;
65
+ return val;
66
+ }
67
+ /** Create a Code for a RenderMaterial given a name that is meant to be unique within the scope of the specified DefinitionModel.
68
+ * @param iModel The IModelDb
69
+ * @param scopeModelId The Id of the DefinitionModel that contains the RenderMaterial and provides the scope for its name.
70
+ * @param name The RenderMaterial name
71
+ */
72
+ static createCode(iModel, scopeModelId, name) {
73
+ const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.texture);
74
+ return 0 === name.length ? core_common_1.Code.createEmpty() : new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: name });
75
+ }
76
+ /**
77
+ * Create a RenderMaterial with given parameters.
78
+ * @param iModelDb The iModel
79
+ * @param definitionModelId The [[DefinitionModel]]
80
+ * @param materialName The name/CodeValue of the RenderMaterial
81
+ * @param params Parameters object which describes how to construct the RenderMaterial
82
+ * @returns The newly constructed RenderMaterial element.
83
+ * @throws [[IModelError]] if unable to create the element.
84
+ */
85
+ static create(iModelDb, definitionModelId, materialName, params) {
86
+ let maps;
87
+ const pbr_normal = params.normalMap?.scale;
88
+ if (params.patternMap || params.normalMap) {
89
+ function choose(obj, key) {
90
+ const pat = params.patternMap;
91
+ if (pat && undefined !== pat[key])
92
+ obj[key] = pat[key];
93
+ else if (params.normalMap && undefined !== params.normalMap[key])
94
+ obj[key] = params.normalMap[key];
95
+ }
96
+ const baseProps = {};
97
+ choose(baseProps, "pattern_angle");
98
+ choose(baseProps, "pattern_u_flip");
99
+ choose(baseProps, "pattern_flip");
100
+ choose(baseProps, "pattern_scale");
101
+ choose(baseProps, "pattern_offset");
102
+ choose(baseProps, "pattern_scalemode");
103
+ choose(baseProps, "pattern_mapping");
104
+ choose(baseProps, "pattern_weight");
105
+ maps = {};
106
+ if (params.patternMap)
107
+ maps.Pattern = { ...params.patternMap, ...baseProps };
108
+ if (params.normalMap) {
109
+ maps.Normal = {
110
+ ...params.normalMap,
111
+ ...baseProps,
112
+ };
113
+ delete maps.Normal.scale;
114
+ }
115
+ }
116
+ // const map = undefined !== params.patternMap ? { Pattern: params.patternMap } : undefined;
117
+ const renderMaterialProps = {
118
+ classFullName: this.classFullName,
119
+ code: this.createCode(iModelDb, definitionModelId, materialName),
120
+ paletteName: params.paletteName,
121
+ description: params.description,
122
+ jsonProperties: {
123
+ materialAssets: {
124
+ renderMaterial: {
125
+ HasBaseColor: params.color !== undefined,
126
+ color: params.color,
127
+ HasSpecularColor: params.specularColor !== undefined,
128
+ specular_color: params.specularColor,
129
+ HasFinish: params.finish !== undefined,
130
+ finish: params.finish,
131
+ HasTransmit: params.transmit !== undefined,
132
+ transmit: params.transmit,
133
+ HasDiffuse: params.diffuse !== undefined,
134
+ diffuse: params.diffuse,
135
+ HasSpecular: params.specular !== undefined,
136
+ specular: params.specular,
137
+ HasReflect: params.reflect !== undefined,
138
+ reflect: params.reflect,
139
+ HasReflectColor: params.reflectColor !== undefined,
140
+ reflect_color: params.reflectColor,
141
+ Map: maps,
142
+ pbr_normal,
143
+ },
144
+ },
145
+ },
146
+ model: definitionModelId,
147
+ isPrivate: false,
148
+ };
149
+ return new RenderMaterialElement(renderMaterialProps, iModelDb);
150
+ }
151
+ /**
152
+ * Insert a new RenderMaterial into a model.
153
+ * @param iModelDb Insert into this iModel
154
+ * @param definitionModelId Insert the new Texture into this DefinitionModel
155
+ * @param materialName The name/CodeValue of the RenderMaterial
156
+ * @param params Parameters object which describes how to construct the RenderMaterial
157
+ * @returns The Id of the newly inserted RenderMaterial element.
158
+ * @throws [[IModelError]] if unable to insert the element.
159
+ */
160
+ static insert(iModelDb, definitionModelId, materialName, params) {
161
+ const renderMaterial = this.create(iModelDb, definitionModelId, materialName, params);
162
+ return iModelDb.elements.insertElement(renderMaterial.toJSON());
163
+ }
164
+ }
165
+ exports.RenderMaterialElement = RenderMaterialElement;
166
+ /** @public */
167
+ (function (RenderMaterialElement) {
168
+ /** Parameters used to construct a [[RenderMaterial]].
169
+ * The persistent JSON representation - [RenderMaterialAssetProps]($common) - is quite verbose and unwieldy. This representation simplifies it somewhat.
170
+ * @see [[RenderMaterialElement.create]] and [[RenderMaterialElement.insert]] to create a [[RenderMaterial]] from parameters of this type.
171
+ * @deprecated in 3.6 because it is not useful to use a `class` - just use [[RenderMaterialElementParams]] directly instead.
172
+ */
173
+ class Params {
174
+ /** Construct a new RenderMaterial.Params object with the specified paletteName. Alter the public members on that object to specify settings. */
175
+ constructor(paletteName) {
176
+ this.paletteName = paletteName;
177
+ }
178
+ }
179
+ RenderMaterialElement.Params = Params;
180
+ })(RenderMaterialElement = exports.RenderMaterialElement || (exports.RenderMaterialElement = {}));
182
181
  //# sourceMappingURL=Material.js.map