@itwin/core-backend 4.0.0-dev.48 → 4.0.0-dev.51

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 (246) hide show
  1. package/lib/cjs/AliCloudStorageService.d.ts +23 -23
  2. package/lib/cjs/AliCloudStorageService.js +71 -71
  3. package/lib/cjs/AliCloudStorageService.js.map +1 -1
  4. package/lib/cjs/BackendHubAccess.d.ts +224 -224
  5. package/lib/cjs/BackendHubAccess.js +41 -41
  6. package/lib/cjs/BackendHubAccess.js.map +1 -1
  7. package/lib/cjs/BackendLoggerCategory.d.ts +91 -91
  8. package/lib/cjs/BackendLoggerCategory.js +99 -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/BisCoreSchema.js.map +1 -1
  13. package/lib/cjs/BriefcaseManager.d.ts +170 -170
  14. package/lib/cjs/BriefcaseManager.js +408 -408
  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 +446 -446
  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/ChangedElementsDb.js.map +1 -1
  25. package/lib/cjs/ChangedElementsManager.d.ts +39 -39
  26. package/lib/cjs/ChangedElementsManager.js +88 -88
  27. package/lib/cjs/ChangedElementsManager.js.map +1 -1
  28. package/lib/cjs/ChannelControl.d.ts +69 -69
  29. package/lib/cjs/ChannelControl.js +88 -88
  30. package/lib/cjs/ChannelControl.js.map +1 -1
  31. package/lib/cjs/CheckpointManager.d.ts +121 -121
  32. package/lib/cjs/CheckpointManager.js +351 -351
  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 -249
  36. package/lib/cjs/ClassRegistry.js.map +1 -1
  37. package/lib/cjs/CloudSqlite.d.ts +355 -355
  38. package/lib/cjs/CloudSqlite.js +154 -154
  39. package/lib/cjs/CloudSqlite.js.map +1 -1
  40. package/lib/cjs/CloudStorageBackend.d.ts +58 -58
  41. package/lib/cjs/CloudStorageBackend.js +170 -170
  42. package/lib/cjs/CloudStorageBackend.js.map +1 -1
  43. package/lib/cjs/CodeService.d.ts +396 -396
  44. package/lib/cjs/CodeService.js +63 -63
  45. package/lib/cjs/CodeService.js.map +1 -1
  46. package/lib/cjs/CodeSpecs.d.ts +55 -55
  47. package/lib/cjs/CodeSpecs.js +124 -124
  48. package/lib/cjs/CodeSpecs.js.map +1 -1
  49. package/lib/cjs/ConcurrentQuery.d.ts +13 -13
  50. package/lib/cjs/ConcurrentQuery.js +36 -36
  51. package/lib/cjs/ConcurrentQuery.js.map +1 -1
  52. package/lib/cjs/CustomViewState3dCreator.d.ts +21 -21
  53. package/lib/cjs/CustomViewState3dCreator.js +81 -81
  54. package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
  55. package/lib/cjs/DevTools.d.ts +73 -73
  56. package/lib/cjs/DevTools.js +156 -156
  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 -253
  60. package/lib/cjs/DisplayStyle.js.map +1 -1
  61. package/lib/cjs/ECDb.d.ts +191 -191
  62. package/lib/cjs/ECDb.js +348 -348
  63. package/lib/cjs/ECDb.js.map +1 -1
  64. package/lib/cjs/ECSchemaXmlContext.d.ts +18 -18
  65. package/lib/cjs/ECSchemaXmlContext.js +41 -41
  66. package/lib/cjs/ECSchemaXmlContext.js.map +1 -1
  67. package/lib/cjs/ECSqlStatement.d.ts +473 -473
  68. package/lib/cjs/ECSqlStatement.js +791 -791
  69. package/lib/cjs/ECSqlStatement.js.map +1 -1
  70. package/lib/cjs/Element.d.ts +1113 -1113
  71. package/lib/cjs/Element.js +1424 -1424
  72. package/lib/cjs/Element.js.map +1 -1
  73. package/lib/cjs/ElementAspect.d.ts +176 -176
  74. package/lib/cjs/ElementAspect.js +203 -203
  75. package/lib/cjs/ElementAspect.js.map +1 -1
  76. package/lib/cjs/ElementGraphics.d.ts +9 -9
  77. package/lib/cjs/ElementGraphics.js +41 -41
  78. package/lib/cjs/ElementGraphics.js.map +1 -1
  79. package/lib/cjs/ElementTreeWalker.d.ts +162 -162
  80. package/lib/cjs/ElementTreeWalker.js +409 -409
  81. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  82. package/lib/cjs/Entity.d.ts +106 -106
  83. package/lib/cjs/Entity.js +134 -134
  84. package/lib/cjs/Entity.js.map +1 -1
  85. package/lib/cjs/EntityReferences.d.ts +49 -49
  86. package/lib/cjs/EntityReferences.js +95 -95
  87. package/lib/cjs/EntityReferences.js.map +1 -1
  88. package/lib/cjs/ExportGraphics.d.ts +317 -317
  89. package/lib/cjs/ExportGraphics.js +208 -208
  90. package/lib/cjs/ExportGraphics.js.map +1 -1
  91. package/lib/cjs/ExternalSource.d.ts +96 -96
  92. package/lib/cjs/ExternalSource.js +131 -131
  93. package/lib/cjs/ExternalSource.js.map +1 -1
  94. package/lib/cjs/GeoCoordConfig.d.ts +19 -19
  95. package/lib/cjs/GeoCoordConfig.js +85 -85
  96. package/lib/cjs/GeoCoordConfig.js.map +1 -1
  97. package/lib/cjs/GeometrySummary.d.ts +4 -4
  98. package/lib/cjs/GeometrySummary.js +380 -380
  99. package/lib/cjs/GeometrySummary.js.map +1 -1
  100. package/lib/cjs/HubMock.d.ts +94 -94
  101. package/lib/cjs/HubMock.js +220 -220
  102. package/lib/cjs/HubMock.js.map +1 -1
  103. package/lib/cjs/IModelCloneContext.d.ts +8 -8
  104. package/lib/cjs/IModelCloneContext.js +15 -15
  105. package/lib/cjs/IModelCloneContext.js.map +1 -1
  106. package/lib/cjs/IModelDb.d.ts +1213 -1213
  107. package/lib/cjs/IModelDb.js +2380 -2380
  108. package/lib/cjs/IModelDb.js.map +1 -1
  109. package/lib/cjs/IModelElementCloneContext.d.ts +89 -89
  110. package/lib/cjs/IModelElementCloneContext.js +159 -159
  111. package/lib/cjs/IModelElementCloneContext.js.map +1 -1
  112. package/lib/cjs/IModelHost.d.ts +369 -369
  113. package/lib/cjs/IModelHost.js +488 -488
  114. package/lib/cjs/IModelHost.js.map +1 -1
  115. package/lib/cjs/IModelJsFs.d.ts +62 -62
  116. package/lib/cjs/IModelJsFs.js +139 -139
  117. package/lib/cjs/IModelJsFs.js.map +1 -1
  118. package/lib/cjs/IpcHost.d.ts +104 -104
  119. package/lib/cjs/IpcHost.js +276 -276
  120. package/lib/cjs/IpcHost.js.map +1 -1
  121. package/lib/cjs/LineStyle.d.ts +311 -311
  122. package/lib/cjs/LineStyle.js +295 -295
  123. package/lib/cjs/LineStyle.js.map +1 -1
  124. package/lib/cjs/LocalHub.d.ts +162 -162
  125. package/lib/cjs/LocalHub.js +580 -580
  126. package/lib/cjs/LocalHub.js.map +1 -1
  127. package/lib/cjs/LocalhostIpcHost.d.ts +20 -20
  128. package/lib/cjs/LocalhostIpcHost.js +79 -79
  129. package/lib/cjs/LocalhostIpcHost.js.map +1 -1
  130. package/lib/cjs/Material.d.ts +131 -131
  131. package/lib/cjs/Material.js +180 -180
  132. package/lib/cjs/Material.js.map +1 -1
  133. package/lib/cjs/Model.d.ts +392 -392
  134. package/lib/cjs/Model.js +489 -489
  135. package/lib/cjs/Model.js.map +1 -1
  136. package/lib/cjs/NativeAppStorage.d.ts +51 -51
  137. package/lib/cjs/NativeAppStorage.js +202 -202
  138. package/lib/cjs/NativeAppStorage.js.map +1 -1
  139. package/lib/cjs/NativeHost.d.ts +52 -52
  140. package/lib/cjs/NativeHost.js +160 -160
  141. package/lib/cjs/NativeHost.js.map +1 -1
  142. package/lib/cjs/NavigationRelationship.d.ts +156 -156
  143. package/lib/cjs/NavigationRelationship.js +225 -225
  144. package/lib/cjs/NavigationRelationship.js.map +1 -1
  145. package/lib/cjs/PromiseMemoizer.d.ts +51 -51
  146. package/lib/cjs/PromiseMemoizer.js +101 -101
  147. package/lib/cjs/PromiseMemoizer.js.map +1 -1
  148. package/lib/cjs/PropertyStore.d.ts +132 -132
  149. package/lib/cjs/PropertyStore.js +11 -11
  150. package/lib/cjs/PropertyStore.js.map +1 -1
  151. package/lib/cjs/Relationship.d.ts +416 -416
  152. package/lib/cjs/Relationship.js +494 -494
  153. package/lib/cjs/Relationship.js.map +1 -1
  154. package/lib/cjs/RpcBackend.d.ts +5 -5
  155. package/lib/cjs/RpcBackend.js +32 -32
  156. package/lib/cjs/RpcBackend.js.map +1 -1
  157. package/lib/cjs/SQLiteDb.d.ts +219 -219
  158. package/lib/cjs/SQLiteDb.js +212 -212
  159. package/lib/cjs/SQLiteDb.js.map +1 -1
  160. package/lib/cjs/Schema.d.ts +55 -55
  161. package/lib/cjs/Schema.js +83 -83
  162. package/lib/cjs/Schema.js.map +1 -1
  163. package/lib/cjs/ServerBasedLocks.d.ts +57 -57
  164. package/lib/cjs/ServerBasedLocks.js +168 -168
  165. package/lib/cjs/ServerBasedLocks.js.map +1 -1
  166. package/lib/cjs/SqliteStatement.d.ts +360 -360
  167. package/lib/cjs/SqliteStatement.js +586 -586
  168. package/lib/cjs/SqliteStatement.js.map +1 -1
  169. package/lib/cjs/Texture.d.ts +58 -58
  170. package/lib/cjs/Texture.js +82 -82
  171. package/lib/cjs/Texture.js.map +1 -1
  172. package/lib/cjs/TileStorage.d.ts +18 -18
  173. package/lib/cjs/TileStorage.js +87 -87
  174. package/lib/cjs/TileStorage.js.map +1 -1
  175. package/lib/cjs/TxnManager.d.ts +202 -202
  176. package/lib/cjs/TxnManager.js +356 -356
  177. package/lib/cjs/TxnManager.js.map +1 -1
  178. package/lib/cjs/ViewDefinition.d.ts +435 -435
  179. package/lib/cjs/ViewDefinition.js +646 -646
  180. package/lib/cjs/ViewDefinition.js.map +1 -1
  181. package/lib/cjs/ViewStateHydrator.d.ts +13 -13
  182. package/lib/cjs/ViewStateHydrator.js +103 -103
  183. package/lib/cjs/ViewStateHydrator.js.map +1 -1
  184. package/lib/cjs/assets/IModelChange.02.00.00.ecschema.xml +90 -90
  185. package/lib/cjs/assets/Settings/Schemas/Cloud.Schema.json +67 -67
  186. package/lib/cjs/assets/Settings/Schemas/Gcs.schema.json +31 -31
  187. package/lib/cjs/assets/Settings/Schemas/Workspace.Schema.json +52 -52
  188. package/lib/cjs/assets/Settings/backend.setting.json5 +138 -138
  189. package/lib/cjs/core-backend.d.ts +185 -185
  190. package/lib/cjs/core-backend.js +205 -205
  191. package/lib/cjs/core-backend.js.map +1 -1
  192. package/lib/cjs/domains/FunctionalElements.d.ts +101 -101
  193. package/lib/cjs/domains/FunctionalElements.js +145 -145
  194. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  195. package/lib/cjs/domains/FunctionalSchema.d.ts +13 -13
  196. package/lib/cjs/domains/FunctionalSchema.js +39 -39
  197. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  198. package/lib/cjs/domains/GenericElements.d.ts +177 -177
  199. package/lib/cjs/domains/GenericElements.js +263 -263
  200. package/lib/cjs/domains/GenericElements.js.map +1 -1
  201. package/lib/cjs/domains/GenericSchema.d.ts +10 -10
  202. package/lib/cjs/domains/GenericSchema.js +28 -28
  203. package/lib/cjs/domains/GenericSchema.js.map +1 -1
  204. package/lib/cjs/rpc/multipart.d.ts +11 -11
  205. package/lib/cjs/rpc/multipart.js +71 -71
  206. package/lib/cjs/rpc/multipart.js.map +1 -1
  207. package/lib/cjs/rpc/tracing.d.ts +28 -28
  208. package/lib/cjs/rpc/tracing.js +73 -73
  209. package/lib/cjs/rpc/tracing.js.map +1 -1
  210. package/lib/cjs/rpc/web/logging.d.ts +9 -9
  211. package/lib/cjs/rpc/web/logging.js +43 -43
  212. package/lib/cjs/rpc/web/logging.js.map +1 -1
  213. package/lib/cjs/rpc/web/request.d.ts +6 -6
  214. package/lib/cjs/rpc/web/request.js +73 -73
  215. package/lib/cjs/rpc/web/request.js.map +1 -1
  216. package/lib/cjs/rpc/web/response.d.ts +6 -6
  217. package/lib/cjs/rpc/web/response.js +105 -105
  218. package/lib/cjs/rpc/web/response.js.map +1 -1
  219. package/lib/cjs/rpc-impl/DevToolsRpcImpl.d.ts +15 -15
  220. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js +32 -32
  221. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js.map +1 -1
  222. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts +47 -47
  223. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js +293 -293
  224. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  225. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts +22 -22
  226. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js +202 -202
  227. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
  228. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts +36 -36
  229. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js +166 -166
  230. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
  231. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts +16 -16
  232. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js +42 -42
  233. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
  234. package/lib/cjs/rpc-impl/WipRpcImpl.d.ts +15 -15
  235. package/lib/cjs/rpc-impl/WipRpcImpl.js +37 -37
  236. package/lib/cjs/rpc-impl/WipRpcImpl.js.map +1 -1
  237. package/lib/cjs/workspace/Settings.d.ts +186 -186
  238. package/lib/cjs/workspace/Settings.js +154 -154
  239. package/lib/cjs/workspace/Settings.js.map +1 -1
  240. package/lib/cjs/workspace/SettingsSchemas.d.ts +75 -75
  241. package/lib/cjs/workspace/SettingsSchemas.js +190 -190
  242. package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
  243. package/lib/cjs/workspace/Workspace.d.ts +414 -414
  244. package/lib/cjs/workspace/Workspace.js +537 -537
  245. package/lib/cjs/workspace/Workspace.js.map +1 -1
  246. package/package.json +10 -10
@@ -1,647 +1,647 @@
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 ViewDefinitions
8
- */
9
- var _a, _b, _c, _d;
10
- Object.defineProperty(exports, "__esModule", { value: true });
11
- exports.LightLocation = exports.ViewAttachment = exports.AuxCoordSystemSpatial = exports.AuxCoordSystem3d = exports.AuxCoordSystem2d = exports.AuxCoordSystem = exports.TemplateViewDefinition3d = exports.TemplateViewDefinition2d = exports.SheetViewDefinition = exports.DrawingViewDefinition = exports.ViewDefinition2d = exports.OrthographicViewDefinition = exports.SpatialViewDefinition = exports.ViewDefinition3d = exports.ViewDefinition = exports.CategorySelector = exports.ModelSelector = void 0;
12
- const core_bentley_1 = require("@itwin/core-bentley");
13
- const core_geometry_1 = require("@itwin/core-geometry");
14
- const core_common_1 = require("@itwin/core-common");
15
- const Element_1 = require("./Element");
16
- /** Holds the list of Ids of GeometricModels displayed by a [[SpatialViewDefinition]]. Multiple SpatialViewDefinitions may point to the same ModelSelector.
17
- * @see [ModelSelectorState]($frontend)
18
- * See [how to create a ModelSelector]$(docs/learning/backend/CreateElements.md#ModelSelector).
19
- * @public
20
- */
21
- class ModelSelector extends Element_1.DefinitionElement {
22
- /** @internal */
23
- constructor(props, iModel) {
24
- super(props, iModel);
25
- this.models = props.models;
26
- }
27
- /** @internal */
28
- static get className() { return "ModelSelector"; }
29
- /** @internal */
30
- toJSON() {
31
- const val = super.toJSON();
32
- val.models = this.models;
33
- return val;
34
- }
35
- /** @internal */
36
- collectReferenceConcreteIds(referenceIds) {
37
- super.collectReferenceConcreteIds(referenceIds);
38
- this.models.forEach((modelId) => referenceIds.addModel(modelId));
39
- }
40
- /** Create a Code for a ModelSelector given a name that is meant to be unique within the scope of the specified DefinitionModel.
41
- * @param iModel The IModelDb
42
- * @param scopeModelId The Id of the DefinitionModel that contains the ModelSelector and provides the scope for its name.
43
- * @param codeValue The ModelSelector name
44
- */
45
- static createCode(iModel, scopeModelId, codeValue) {
46
- const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.modelSelector);
47
- return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
48
- }
49
- /**
50
- * Create a ModelSelector to select which Models are displayed by a ViewDefinition.
51
- * @param iModelDb The iModel
52
- * @param definitionModelId The [[DefinitionModel]]
53
- * @param name The name/CodeValue of the ModelSelector
54
- * @param models Array of models to select for display
55
- * @returns The newly constructed ModelSelector element.
56
- * @throws [[IModelError]] if unable to create the element.
57
- */
58
- static create(iModelDb, definitionModelId, name, models) {
59
- const modelSelectorProps = {
60
- classFullName: this.classFullName,
61
- code: this.createCode(iModelDb, definitionModelId, name),
62
- model: definitionModelId,
63
- models,
64
- isPrivate: false,
65
- };
66
- return new ModelSelector(modelSelectorProps, iModelDb);
67
- }
68
- /**
69
- * Insert a ModelSelector to select which Models are displayed by a ViewDefinition.
70
- * @param iModelDb Insert into this iModel
71
- * @param definitionModelId Insert the new ModelSelector into this DefinitionModel
72
- * @param name The name/CodeValue of the ModelSelector
73
- * @param models Array of models to select for display
74
- * @returns The Id of the newly inserted ModelSelector element.
75
- * @throws [[IModelError]] if unable to insert the element.
76
- */
77
- static insert(iModelDb, definitionModelId, name, models) {
78
- const modelSelector = this.create(iModelDb, definitionModelId, name, models);
79
- return iModelDb.elements.insertElement(modelSelector.toJSON());
80
- }
81
- }
82
- exports.ModelSelector = ModelSelector;
83
- /** Holds a list of Ids of Categories to be displayed in a view.
84
- * @see [CategorySelectorState]($frontend)
85
- * See [how to create a CategorySelector]$(docs/learning/backend/CreateElements.md#CategorySelector).
86
- * @public
87
- */
88
- class CategorySelector extends Element_1.DefinitionElement {
89
- /** @internal */
90
- constructor(props, iModel) {
91
- super(props, iModel);
92
- this.categories = props.categories;
93
- }
94
- /** @internal */
95
- static get className() { return "CategorySelector"; }
96
- /** @internal */
97
- toJSON() {
98
- const val = super.toJSON();
99
- val.categories = this.categories;
100
- return val;
101
- }
102
- /** @internal */
103
- collectReferenceConcreteIds(referenceIds) {
104
- super.collectReferenceConcreteIds(referenceIds);
105
- this.categories.forEach((categoryId) => referenceIds.addElement(categoryId));
106
- }
107
- /** Create a Code for a CategorySelector given a name that is meant to be unique within the scope of the specified DefinitionModel.
108
- * @param iModel The IModelDb
109
- * @param scopeModelId The Id of the DefinitionModel that contains the CategorySelector and provides the scope for its name.
110
- * @param codeValue The CategorySelector name
111
- */
112
- static createCode(iModel, scopeModelId, codeValue) {
113
- const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.categorySelector);
114
- return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
115
- }
116
- /**
117
- * Create a CategorySelector to select which categories are displayed by a ViewDefinition.
118
- * @param iModelDb The iModel
119
- * @param definitionModelId The [[DefinitionModel]]
120
- * @param name The name of the CategorySelector
121
- * @param categories Array of categories to select for display
122
- * @returns The newly constructed CategorySelector element.
123
- * @throws [[IModelError]] if unable to create the element.
124
- */
125
- static create(iModelDb, definitionModelId, name, categories) {
126
- const categorySelectorProps = {
127
- classFullName: this.classFullName,
128
- code: this.createCode(iModelDb, definitionModelId, name),
129
- model: definitionModelId,
130
- categories,
131
- isPrivate: false,
132
- };
133
- return new CategorySelector(categorySelectorProps, iModelDb);
134
- }
135
- /**
136
- * Insert a CategorySelector to select which categories are displayed by a ViewDefinition.
137
- * @param iModelDb Insert into this iModel
138
- * @param definitionModelId Insert the new CategorySelector into this DefinitionModel
139
- * @param name The name of the CategorySelector
140
- * @param categories Array of categories to select for display
141
- * @returns The Id of the newly inserted CategorySelector element.
142
- * @throws [[IModelError]] if unable to insert the element.
143
- */
144
- static insert(iModelDb, definitionModelId, name, categories) {
145
- const categorySelector = this.create(iModelDb, definitionModelId, name, categories);
146
- return iModelDb.elements.insertElement(categorySelector.toJSON());
147
- }
148
- }
149
- exports.CategorySelector = CategorySelector;
150
- /**
151
- * The definition element for a view. ViewDefinitions specify the area/volume that is viewed, the Ids of a DisplayStyle and a CategorySelector,
152
- * plus additional view-specific parameters in their [[Element.jsonProperties]].
153
- *
154
- * Subclasses of ViewDefinition determine which model(s) are viewed.
155
- *
156
- * **Example: Obtaining the background color for a view**
157
- * ``` ts
158
- * [[include:ViewDefinition.getBackgroundColor]]
159
- * ```
160
- *
161
- * @note ViewDefinition is only available in the backend. See [ViewState]($frontend) for usage in the frontend.
162
- * @public
163
- */
164
- class ViewDefinition extends (_b = Element_1.DefinitionElement) {
165
- /** @internal */
166
- constructor(props, iModel) {
167
- super(props, iModel);
168
- this.categorySelectorId = core_bentley_1.Id64.fromJSON(props.categorySelectorId);
169
- if (!core_bentley_1.Id64.isValid(this.categorySelectorId))
170
- throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `categorySelectorId is invalid`);
171
- this.displayStyleId = core_bentley_1.Id64.fromJSON(props.displayStyleId);
172
- if (!core_bentley_1.Id64.isValid(this.displayStyleId))
173
- throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `displayStyleId is invalid`);
174
- }
175
- /** @internal */
176
- static get className() { return "ViewDefinition"; }
177
- /** @internal */
178
- toJSON() {
179
- const json = super.toJSON();
180
- json.categorySelectorId = this.categorySelectorId;
181
- json.displayStyleId = this.displayStyleId;
182
- return json;
183
- }
184
- /** @internal */
185
- collectReferenceConcreteIds(referenceIds) {
186
- super.collectReferenceConcreteIds(referenceIds);
187
- referenceIds.addElement(this.categorySelectorId);
188
- referenceIds.addElement(this.displayStyleId);
189
- const acsId = this.getAuxiliaryCoordinateSystemId();
190
- if (core_bentley_1.Id64.isValidId64(acsId)) {
191
- referenceIds.addElement(acsId);
192
- }
193
- }
194
- /** @internal */
195
- static onCloned(context, sourceElementProps, targetElementProps) {
196
- super.onCloned(context, sourceElementProps, targetElementProps);
197
- if (context.isBetweenIModels && targetElementProps.jsonProperties && targetElementProps.jsonProperties.viewDetails) {
198
- const acsId = core_bentley_1.Id64.fromJSON(targetElementProps.jsonProperties.viewDetails.acs);
199
- if (core_bentley_1.Id64.isValidId64(acsId)) {
200
- targetElementProps.jsonProperties.viewDetails.acs = context.findTargetElementId(acsId);
201
- }
202
- }
203
- }
204
- /** Type guard for `instanceof ViewDefinition3d` */
205
- isView3d() { return this instanceof ViewDefinition3d; }
206
- /** Type guard for 'instanceof ViewDefinition2d` */
207
- isView2d() { return this instanceof ViewDefinition2d; }
208
- /** Type guard for `instanceof SpatialViewDefinition` */
209
- isSpatialView() { return this instanceof SpatialViewDefinition; }
210
- /** Type guard for 'instanceof DrawingViewDefinition' */
211
- isDrawingView() { return this instanceof DrawingViewDefinition; }
212
- /** Load this view's DisplayStyle from the IModelDb. */
213
- loadDisplayStyle() { return this.iModel.elements.getElement(this.displayStyleId); }
214
- /** Load this view's CategorySelector from the IModelDb. */
215
- loadCategorySelector() { return this.iModel.elements.getElement(this.categorySelectorId); }
216
- /** The Id of the AuxiliaryCoordinateSystem for this ViewDefinition, or an invalid Id if no ACS is defined. */
217
- getAuxiliaryCoordinateSystemId() {
218
- return this.details.auxiliaryCoordinateSystemId;
219
- }
220
- /** Set or clear the AuxiliaryCoordinateSystem for this ViewDefinition.
221
- * @param acsId The Id of the new AuxiliaryCoordinateSystem. If `Id64.invalid` is passed, then no AuxiliaryCoordinateSystem will be used.
222
- */
223
- setAuxiliaryCoordinateSystemId(acsId) {
224
- this.details.auxiliaryCoordinateSystemId = acsId;
225
- }
226
- /** Create a Code for a ViewDefinition given a name that is meant to be unique within the scope of the specified DefinitionModel.
227
- * @param iModel The IModelDb
228
- * @param scopeModelId The Id of the DefinitionModel to contain the ViewDefinition and provides the scope for its name.
229
- * @param codeValue The ViewDefinition name
230
- */
231
- static createCode(iModel, scopeModelId, codeValue) {
232
- const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.viewDefinition);
233
- return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
234
- }
235
- }
236
- exports.ViewDefinition = ViewDefinition;
237
- _a = ViewDefinition;
238
- /** @beta */
239
- ViewDefinition.requiredReferenceKeys = [...Reflect.get(_b, "requiredReferenceKeys", _a), "categorySelectorId", "displayStyleId"];
240
- /** @alpha */
241
- ViewDefinition.requiredReferenceKeyTypeMap = {
242
- ...Reflect.get(_b, "requiredReferenceKeyTypeMap", _a),
243
- categorySelectorId: core_common_1.ConcreteEntityTypes.Element,
244
- displayStyleId: core_common_1.ConcreteEntityTypes.Element,
245
- };
246
- /** Defines a view of one or more 3d models.
247
- * @public
248
- */
249
- class ViewDefinition3d extends ViewDefinition {
250
- /** @internal */
251
- constructor(props, iModel) {
252
- super(props, iModel);
253
- this.cameraOn = core_bentley_1.JsonUtils.asBool(props.cameraOn);
254
- this.origin = core_geometry_1.Point3d.fromJSON(props.origin);
255
- this.extents = core_geometry_1.Vector3d.fromJSON(props.extents);
256
- this.angles = core_geometry_1.YawPitchRollAngles.fromJSON(props.angles);
257
- this.camera = new core_common_1.Camera(props.camera);
258
- this._details = new core_common_1.ViewDetails3d(this.jsonProperties);
259
- }
260
- /** @internal */
261
- static get className() { return "ViewDefinition3d"; }
262
- /** @internal */
263
- toJSON() {
264
- const val = super.toJSON();
265
- val.cameraOn = this.cameraOn;
266
- val.origin = this.origin;
267
- val.extents = this.extents;
268
- val.angles = this.angles;
269
- val.camera = this.camera;
270
- return val;
271
- }
272
- /** Provides access to optional detail settings for this view. */
273
- get details() { return this._details; }
274
- /** Load this view's DisplayStyle3d from the IModelDb. */
275
- loadDisplayStyle3d() { return this.iModel.elements.getElement(this.displayStyleId); }
276
- }
277
- exports.ViewDefinition3d = ViewDefinition3d;
278
- /** Defines a view of one or more SpatialModels.
279
- * The list of viewed models is stored by the ModelSelector.
280
- *
281
- * This is how a SpatialViewDefinition selects the elements to display:
282
- *
283
- * SpatialViewDefinition
284
- * * ModelSelector
285
- * * ModelIds -------> SpatialModels <----------GeometricElement3d.Model
286
- * * CategorySelector
287
- * * CategoryIds -----> SpatialCategories <----------GeometricElement3d.Category
288
- * @public
289
- */
290
- class SpatialViewDefinition extends (_d = ViewDefinition3d) {
291
- /** @internal */
292
- constructor(props, iModel) {
293
- super(props, iModel);
294
- this.modelSelectorId = core_bentley_1.Id64.fromJSON(props.modelSelectorId);
295
- if (!core_bentley_1.Id64.isValid(this.modelSelectorId))
296
- throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `modelSelectorId is invalid`);
297
- }
298
- /** @internal */
299
- static get className() { return "SpatialViewDefinition"; }
300
- /** Construct a SpatialViewDefinition from its JSON representation. */
301
- static fromJSON(props, iModel) {
302
- return new SpatialViewDefinition({ ...props, classFullName: this.classFullName }, iModel);
303
- }
304
- /** Convert this view to its JSON representation. */
305
- toJSON() {
306
- const json = super.toJSON();
307
- json.modelSelectorId = this.modelSelectorId;
308
- return json;
309
- }
310
- /** @internal */
311
- collectReferenceConcreteIds(referenceIds) {
312
- super.collectReferenceConcreteIds(referenceIds);
313
- referenceIds.addElement(this.modelSelectorId);
314
- }
315
- /** Load this view's ModelSelector from the IModelDb. */
316
- loadModelSelector() { return this.iModel.elements.getElement(this.modelSelectorId); }
317
- /**
318
- * Create a SpatialViewDefinition with the camera turned on.
319
- * @param iModelDb The iModel
320
- * @param definitionModelId The [[DefinitionModel]]
321
- * @param name The name/CodeValue of the view
322
- * @param modelSelectorId The [[ModelSelector]] that this view should use
323
- * @param categorySelectorId The [[CategorySelector]] that this view should use
324
- * @param displayStyleId The [[DisplayStyle3d]] that this view should use
325
- * @param range Defines the view origin and extents
326
- * @param standardView Optionally defines the view's rotation
327
- * @param cameraAngle Camera angle in radians.
328
- * @returns The newly constructed SpatialViewDefinition element
329
- * @throws [[IModelError]] if there is a problem creating the view
330
- */
331
- static createWithCamera(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso, cameraAngle = core_geometry_1.Angle.piOver2Radians) {
332
- const rotation = core_geometry_1.Matrix3d.createStandardWorldToView(standardView);
333
- const angles = core_geometry_1.YawPitchRollAngles.createFromMatrix3d(rotation);
334
- const rotationTransform = core_geometry_1.Transform.createOriginAndMatrix(undefined, rotation);
335
- const rotatedRange = rotationTransform.multiplyRange(range);
336
- const cameraDistance = 2 * (rotatedRange.diagonal().magnitudeXY() / 2.0) / Math.tan(cameraAngle / 2.0);
337
- const cameraLocation = rotatedRange.diagonalFractionToPoint(.5); // Start at center.
338
- cameraLocation.z += cameraDistance; // Back up by camera distance.
339
- rotation.multiplyTransposeVectorInPlace(cameraLocation);
340
- const viewDefinitionProps = {
341
- classFullName: this.classFullName,
342
- model: definitionModelId,
343
- code: this.createCode(iModelDb, definitionModelId, name),
344
- modelSelectorId,
345
- categorySelectorId,
346
- displayStyleId,
347
- origin: rotation.multiplyTransposeXYZ(rotatedRange.low.x, rotatedRange.low.y, rotatedRange.low.z),
348
- extents: rotatedRange.diagonal(),
349
- angles,
350
- cameraOn: true,
351
- camera: { lens: { radians: cameraAngle }, focusDist: cameraDistance, eye: cameraLocation },
352
- };
353
- return new SpatialViewDefinition(viewDefinitionProps, iModelDb);
354
- }
355
- /**
356
- * Insert an SpatialViewDefinition with the camera turned on.
357
- * @see [[createWithCamera]] for details.
358
- * @returns The Id of the newly inserted SpatialViewDefinition element
359
- * @throws [[IModelError]] if there is an insert problem.
360
- */
361
- static insertWithCamera(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso, cameraAngle = core_geometry_1.Angle.piOver2Radians) {
362
- const viewDefinition = this.createWithCamera(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView, cameraAngle);
363
- return iModelDb.elements.insertElement(viewDefinition.toJSON());
364
- }
365
- }
366
- exports.SpatialViewDefinition = SpatialViewDefinition;
367
- _c = SpatialViewDefinition;
368
- /** @beta */
369
- SpatialViewDefinition.requiredReferenceKeys = [...Reflect.get(_d, "requiredReferenceKeys", _c), "modelSelectorId"];
370
- /** @alpha */
371
- SpatialViewDefinition.requiredReferenceKeyTypeMap = {
372
- ...Reflect.get(_d, "requiredReferenceKeyTypeMap", _c),
373
- modelSelectorId: core_common_1.ConcreteEntityTypes.Element,
374
- };
375
- /** Defines a spatial view that displays geometry on the image plane using a parallel orthographic projection.
376
- * See [how to create a OrthographicViewDefinition]$(docs/learning/backend/CreateElements.md#OrthographicViewDefinition).
377
- * @public
378
- */
379
- class OrthographicViewDefinition extends SpatialViewDefinition {
380
- /** @internal */
381
- static get className() { return "OrthographicViewDefinition"; }
382
- constructor(props, iModel) { super(props, iModel); }
383
- /**
384
- * Create an OrthographicViewDefinition
385
- * @param iModelDb The iModel
386
- * @param definitionModelId The [[DefinitionModel]]
387
- * @param name The name/CodeValue of the view
388
- * @param modelSelectorId The [[ModelSelector]] that this view should use
389
- * @param categorySelectorId The [[CategorySelector]] that this view should use
390
- * @param displayStyleId The [[DisplayStyle3d]] that this view should use
391
- * @param range Defines the view origin and extents
392
- * @param standardView Optionally defines the view's rotation
393
- * @returns The newly constructed OrthographicViewDefinition element
394
- * @throws [[IModelError]] if there is a problem creating the view
395
- */
396
- static create(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso) {
397
- const rotation = core_geometry_1.Matrix3d.createStandardWorldToView(standardView);
398
- const angles = core_geometry_1.YawPitchRollAngles.createFromMatrix3d(rotation);
399
- const rotationTransform = core_geometry_1.Transform.createOriginAndMatrix(undefined, rotation);
400
- const rotatedRange = rotationTransform.multiplyRange(range);
401
- const viewDefinitionProps = {
402
- classFullName: this.classFullName,
403
- model: definitionModelId,
404
- code: this.createCode(iModelDb, definitionModelId, name),
405
- modelSelectorId,
406
- categorySelectorId,
407
- displayStyleId,
408
- origin: rotation.multiplyTransposeXYZ(rotatedRange.low.x, rotatedRange.low.y, rotatedRange.low.z),
409
- extents: rotatedRange.diagonal(),
410
- angles,
411
- cameraOn: false,
412
- camera: new core_common_1.Camera(), // not used when cameraOn === false
413
- };
414
- return new OrthographicViewDefinition(viewDefinitionProps, iModelDb);
415
- }
416
- /**
417
- * Insert an OrthographicViewDefinition
418
- * @param iModelDb Insert into this iModel
419
- * @param definitionModelId Insert the new OrthographicViewDefinition into this DefinitionModel
420
- * @param name The name/CodeValue of the view
421
- * @param modelSelectorId The [[ModelSelector]] that this view should use
422
- * @param categorySelectorId The [[CategorySelector]] that this view should use
423
- * @param displayStyleId The [[DisplayStyle3d]] that this view should use
424
- * @param range Defines the view origin and extents
425
- * @param standardView Optionally defines the view's rotation
426
- * @returns The Id of the newly inserted OrthographicViewDefinition element
427
- * @throws [[IModelError]] if there is an insert problem.
428
- */
429
- static insert(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso) {
430
- const viewDefinition = this.create(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView);
431
- return iModelDb.elements.insertElement(viewDefinition.toJSON());
432
- }
433
- /** Set a new viewed range without changing the rotation or any other properties. */
434
- setRange(range) {
435
- const rotation = this.angles.toMatrix3d();
436
- const rotationTransform = core_geometry_1.Transform.createOriginAndMatrix(undefined, rotation);
437
- const rotatedRange = rotationTransform.multiplyRange(range);
438
- this.origin = core_geometry_1.Point3d.createFrom(rotation.multiplyTransposeXYZ(rotatedRange.low.x, rotatedRange.low.y, rotatedRange.low.z));
439
- this.extents = rotatedRange.diagonal();
440
- }
441
- }
442
- exports.OrthographicViewDefinition = OrthographicViewDefinition;
443
- /** Defines a view of a single 2d model. Each 2d model has its own coordinate system, so only one may appear per view.
444
- * @public
445
- */
446
- class ViewDefinition2d extends ViewDefinition {
447
- /** @internal */
448
- constructor(props, iModel) {
449
- super(props, iModel);
450
- this.baseModelId = core_bentley_1.Id64.fromJSON(props.baseModelId);
451
- this.origin = core_geometry_1.Point2d.fromJSON(props.origin);
452
- this.delta = core_geometry_1.Point2d.fromJSON(props.delta);
453
- this.angle = core_geometry_1.Angle.fromJSON(props.angle);
454
- this._details = new core_common_1.ViewDetails(this.jsonProperties);
455
- }
456
- /** @internal */
457
- static get className() { return "ViewDefinition2d"; }
458
- /** @internal */
459
- toJSON() {
460
- const val = super.toJSON();
461
- val.baseModelId = this.baseModelId;
462
- val.origin = this.origin;
463
- val.delta = this.delta;
464
- val.angle = this.angle;
465
- return val;
466
- }
467
- /** @internal */
468
- collectReferenceConcreteIds(referenceIds) {
469
- super.collectReferenceConcreteIds(referenceIds);
470
- referenceIds.addElement(this.baseModelId);
471
- }
472
- /** Provides access to optional detail settings for this view. */
473
- get details() { return this._details; }
474
- /** Load this view's DisplayStyle2d from the IModelDb. */
475
- loadDisplayStyle2d() { return this.iModel.elements.getElement(this.displayStyleId); }
476
- }
477
- exports.ViewDefinition2d = ViewDefinition2d;
478
- /** Defines a view of a [[DrawingModel]].
479
- * @public
480
- */
481
- class DrawingViewDefinition extends ViewDefinition2d {
482
- /** @internal */
483
- static get className() { return "DrawingViewDefinition"; }
484
- /** @internal */
485
- constructor(props, iModel) {
486
- super(props, iModel);
487
- }
488
- /** Create a DrawingViewDefinition
489
- * @param iModelDb The iModel
490
- * @param definitionModelId The [[DefinitionModel]]
491
- * @param name The name/CodeValue of the view
492
- * @param baseModelId The base [[DrawingModel]]
493
- * @param categorySelectorId The [[CategorySelector]] that this view should use
494
- * @param displayStyleId The [[DisplayStyle2d]] that this view should use
495
- * @param range Defines the view origin and extents
496
- * @throws [[IModelError]] if there is a problem creating the element.
497
- */
498
- static create(iModelDb, definitionModelId, name, baseModelId, categorySelectorId, displayStyleId, range) {
499
- const viewDefinitionProps = {
500
- classFullName: this.classFullName,
501
- model: definitionModelId,
502
- code: this.createCode(iModelDb, definitionModelId, name),
503
- baseModelId,
504
- categorySelectorId,
505
- displayStyleId,
506
- origin: { x: range.low.x, y: range.low.y },
507
- delta: range.diagonal(),
508
- angle: 0,
509
- };
510
- return new DrawingViewDefinition(viewDefinitionProps, iModelDb);
511
- }
512
- /** Construct a DrawingViewDefinition from its JSON representation. */
513
- static fromJSON(props, iModel) {
514
- return new DrawingViewDefinition({ ...props, classFullName: this.classFullName }, iModel);
515
- }
516
- /** Insert a DrawingViewDefinition
517
- * @param iModelDb Insert into this iModel
518
- * @param definitionModelId Insert the new DrawingViewDefinition into this [[DefinitionModel]]
519
- * @param name The name/CodeValue of the view
520
- * @param baseModelId The base [[DrawingModel]]
521
- * @param categorySelectorId The [[CategorySelector]] that this view should use
522
- * @param displayStyleId The [[DisplayStyle2d]] that this view should use
523
- * @param range Defines the view origin and extents
524
- * @throws [[IModelError]] if there is an insert problem.
525
- */
526
- static insert(iModelDb, definitionModelId, name, baseModelId, categorySelectorId, displayStyleId, range) {
527
- const viewDefinition = this.create(iModelDb, definitionModelId, name, baseModelId, categorySelectorId, displayStyleId, range);
528
- return iModelDb.elements.insertElement(viewDefinition.toJSON());
529
- }
530
- }
531
- exports.DrawingViewDefinition = DrawingViewDefinition;
532
- /** Defines a view of a [[SheetModel]].
533
- * @public
534
- */
535
- class SheetViewDefinition extends ViewDefinition2d {
536
- /** @internal */
537
- static get className() { return "SheetViewDefinition"; }
538
- }
539
- exports.SheetViewDefinition = SheetViewDefinition;
540
- /** A ViewDefinition used to display a 2d template model.
541
- * @internal
542
- */
543
- class TemplateViewDefinition2d extends ViewDefinition2d {
544
- /** @internal */
545
- static get className() { return "TemplateViewDefinition2d"; }
546
- }
547
- exports.TemplateViewDefinition2d = TemplateViewDefinition2d;
548
- /** A ViewDefinition used to display a 3d template model.
549
- * @internal
550
- */
551
- class TemplateViewDefinition3d extends ViewDefinition3d {
552
- /** @internal */
553
- static get className() { return "TemplateViewDefinition3d"; }
554
- }
555
- exports.TemplateViewDefinition3d = TemplateViewDefinition3d;
556
- /** An auxiliary coordinate system element. Auxiliary coordinate systems can be used by views to show
557
- * coordinate information in different units and/or orientations.
558
- * @public
559
- */
560
- class AuxCoordSystem extends Element_1.DefinitionElement {
561
- constructor(props, iModel) { super(props, iModel); }
562
- /** @internal */
563
- static get className() { return "AuxCoordSystem"; }
564
- }
565
- exports.AuxCoordSystem = AuxCoordSystem;
566
- /** A 2d auxiliary coordinate system.
567
- * @public
568
- */
569
- class AuxCoordSystem2d extends AuxCoordSystem {
570
- constructor(props, iModel) { super(props, iModel); }
571
- /** @internal */
572
- static get className() { return "AuxCoordSystem2d"; }
573
- /** Create a Code for a AuxCoordSystem2d element given a name that is meant to be unique within the scope of the specified DefinitionModel.
574
- * @param iModel The IModelDb
575
- * @param scopeModelId The Id of the DefinitionModel that contains the AuxCoordSystem2d element and provides the scope for its name.
576
- * @param codeValue The AuxCoordSystem2d name
577
- */
578
- static createCode(iModel, scopeModelId, codeValue) {
579
- const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.auxCoordSystem2d);
580
- return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
581
- }
582
- }
583
- exports.AuxCoordSystem2d = AuxCoordSystem2d;
584
- /** A 3d auxiliary coordinate system.
585
- * @public
586
- */
587
- class AuxCoordSystem3d extends AuxCoordSystem {
588
- constructor(props, iModel) { super(props, iModel); }
589
- /** @internal */
590
- static get className() { return "AuxCoordSystem3d"; }
591
- /** Create a Code for a AuxCoordSystem3d element given a name that is meant to be unique within the scope of the specified DefinitionModel.
592
- * @param iModel The IModelDb
593
- * @param scopeModelId The Id of the DefinitionModel that contains the AuxCoordSystem3d element and provides the scope for its name.
594
- * @param codeValue The AuxCoordSystem3d name
595
- */
596
- static createCode(iModel, scopeModelId, codeValue) {
597
- const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.auxCoordSystem3d);
598
- return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
599
- }
600
- }
601
- exports.AuxCoordSystem3d = AuxCoordSystem3d;
602
- /** A spatial auxiliary coordinate system.
603
- * @public
604
- */
605
- class AuxCoordSystemSpatial extends AuxCoordSystem3d {
606
- /** @internal */
607
- static get className() { return "AuxCoordSystemSpatial"; }
608
- /** Create a Code for a AuxCoordSystemSpatial element given a name that is meant to be unique within the scope of the specified DefinitionModel.
609
- * @param iModel The IModelDb
610
- * @param scopeModelId The Id of the DefinitionModel that contains the AuxCoordSystemSpatial element and provides the scope for its name.
611
- * @param codeValue The AuxCoordSystemSpatial name
612
- */
613
- static createCode(iModel, scopeModelId, codeValue) {
614
- const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.auxCoordSystemSpatial);
615
- return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
616
- }
617
- }
618
- exports.AuxCoordSystemSpatial = AuxCoordSystemSpatial;
619
- /** Represents an *attachment* of a [[ViewDefinition]] to a [[Sheet]].
620
- * @public
621
- */
622
- class ViewAttachment extends Element_1.GraphicalElement2d {
623
- constructor(props, iModel) {
624
- super(props, iModel);
625
- this.view = new core_common_1.RelatedElement(props.view);
626
- // ###NOTE: scale, displayPriority, and clipping vectors are stored in ViewAttachmentProps.jsonProperties.
627
- }
628
- /** @internal */
629
- static get className() { return "ViewAttachment"; }
630
- /** @internal */
631
- collectReferenceConcreteIds(referenceIds) {
632
- super.collectReferenceConcreteIds(referenceIds);
633
- referenceIds.addElement(this.view.id);
634
- }
635
- }
636
- exports.ViewAttachment = ViewAttachment;
637
- /** The position in space of a Light.
638
- * @internal
639
- */
640
- class LightLocation extends Element_1.SpatialLocationElement {
641
- /** @internal */
642
- constructor(props, iModel) { super(props, iModel); }
643
- /** @internal */
644
- static get className() { return "LightLocation"; }
645
- }
646
- exports.LightLocation = LightLocation;
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 ViewDefinitions
8
+ */
9
+ var _a, _b, _c, _d;
10
+ Object.defineProperty(exports, "__esModule", { value: true });
11
+ exports.LightLocation = exports.ViewAttachment = exports.AuxCoordSystemSpatial = exports.AuxCoordSystem3d = exports.AuxCoordSystem2d = exports.AuxCoordSystem = exports.TemplateViewDefinition3d = exports.TemplateViewDefinition2d = exports.SheetViewDefinition = exports.DrawingViewDefinition = exports.ViewDefinition2d = exports.OrthographicViewDefinition = exports.SpatialViewDefinition = exports.ViewDefinition3d = exports.ViewDefinition = exports.CategorySelector = exports.ModelSelector = void 0;
12
+ const core_bentley_1 = require("@itwin/core-bentley");
13
+ const core_geometry_1 = require("@itwin/core-geometry");
14
+ const core_common_1 = require("@itwin/core-common");
15
+ const Element_1 = require("./Element");
16
+ /** Holds the list of Ids of GeometricModels displayed by a [[SpatialViewDefinition]]. Multiple SpatialViewDefinitions may point to the same ModelSelector.
17
+ * @see [ModelSelectorState]($frontend)
18
+ * See [how to create a ModelSelector]$(docs/learning/backend/CreateElements.md#ModelSelector).
19
+ * @public
20
+ */
21
+ class ModelSelector extends Element_1.DefinitionElement {
22
+ /** @internal */
23
+ constructor(props, iModel) {
24
+ super(props, iModel);
25
+ this.models = props.models;
26
+ }
27
+ /** @internal */
28
+ static get className() { return "ModelSelector"; }
29
+ /** @internal */
30
+ toJSON() {
31
+ const val = super.toJSON();
32
+ val.models = this.models;
33
+ return val;
34
+ }
35
+ /** @internal */
36
+ collectReferenceConcreteIds(referenceIds) {
37
+ super.collectReferenceConcreteIds(referenceIds);
38
+ this.models.forEach((modelId) => referenceIds.addModel(modelId));
39
+ }
40
+ /** Create a Code for a ModelSelector given a name that is meant to be unique within the scope of the specified DefinitionModel.
41
+ * @param iModel The IModelDb
42
+ * @param scopeModelId The Id of the DefinitionModel that contains the ModelSelector and provides the scope for its name.
43
+ * @param codeValue The ModelSelector name
44
+ */
45
+ static createCode(iModel, scopeModelId, codeValue) {
46
+ const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.modelSelector);
47
+ return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
48
+ }
49
+ /**
50
+ * Create a ModelSelector to select which Models are displayed by a ViewDefinition.
51
+ * @param iModelDb The iModel
52
+ * @param definitionModelId The [[DefinitionModel]]
53
+ * @param name The name/CodeValue of the ModelSelector
54
+ * @param models Array of models to select for display
55
+ * @returns The newly constructed ModelSelector element.
56
+ * @throws [[IModelError]] if unable to create the element.
57
+ */
58
+ static create(iModelDb, definitionModelId, name, models) {
59
+ const modelSelectorProps = {
60
+ classFullName: this.classFullName,
61
+ code: this.createCode(iModelDb, definitionModelId, name),
62
+ model: definitionModelId,
63
+ models,
64
+ isPrivate: false,
65
+ };
66
+ return new ModelSelector(modelSelectorProps, iModelDb);
67
+ }
68
+ /**
69
+ * Insert a ModelSelector to select which Models are displayed by a ViewDefinition.
70
+ * @param iModelDb Insert into this iModel
71
+ * @param definitionModelId Insert the new ModelSelector into this DefinitionModel
72
+ * @param name The name/CodeValue of the ModelSelector
73
+ * @param models Array of models to select for display
74
+ * @returns The Id of the newly inserted ModelSelector element.
75
+ * @throws [[IModelError]] if unable to insert the element.
76
+ */
77
+ static insert(iModelDb, definitionModelId, name, models) {
78
+ const modelSelector = this.create(iModelDb, definitionModelId, name, models);
79
+ return iModelDb.elements.insertElement(modelSelector.toJSON());
80
+ }
81
+ }
82
+ exports.ModelSelector = ModelSelector;
83
+ /** Holds a list of Ids of Categories to be displayed in a view.
84
+ * @see [CategorySelectorState]($frontend)
85
+ * See [how to create a CategorySelector]$(docs/learning/backend/CreateElements.md#CategorySelector).
86
+ * @public
87
+ */
88
+ class CategorySelector extends Element_1.DefinitionElement {
89
+ /** @internal */
90
+ constructor(props, iModel) {
91
+ super(props, iModel);
92
+ this.categories = props.categories;
93
+ }
94
+ /** @internal */
95
+ static get className() { return "CategorySelector"; }
96
+ /** @internal */
97
+ toJSON() {
98
+ const val = super.toJSON();
99
+ val.categories = this.categories;
100
+ return val;
101
+ }
102
+ /** @internal */
103
+ collectReferenceConcreteIds(referenceIds) {
104
+ super.collectReferenceConcreteIds(referenceIds);
105
+ this.categories.forEach((categoryId) => referenceIds.addElement(categoryId));
106
+ }
107
+ /** Create a Code for a CategorySelector given a name that is meant to be unique within the scope of the specified DefinitionModel.
108
+ * @param iModel The IModelDb
109
+ * @param scopeModelId The Id of the DefinitionModel that contains the CategorySelector and provides the scope for its name.
110
+ * @param codeValue The CategorySelector name
111
+ */
112
+ static createCode(iModel, scopeModelId, codeValue) {
113
+ const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.categorySelector);
114
+ return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
115
+ }
116
+ /**
117
+ * Create a CategorySelector to select which categories are displayed by a ViewDefinition.
118
+ * @param iModelDb The iModel
119
+ * @param definitionModelId The [[DefinitionModel]]
120
+ * @param name The name of the CategorySelector
121
+ * @param categories Array of categories to select for display
122
+ * @returns The newly constructed CategorySelector element.
123
+ * @throws [[IModelError]] if unable to create the element.
124
+ */
125
+ static create(iModelDb, definitionModelId, name, categories) {
126
+ const categorySelectorProps = {
127
+ classFullName: this.classFullName,
128
+ code: this.createCode(iModelDb, definitionModelId, name),
129
+ model: definitionModelId,
130
+ categories,
131
+ isPrivate: false,
132
+ };
133
+ return new CategorySelector(categorySelectorProps, iModelDb);
134
+ }
135
+ /**
136
+ * Insert a CategorySelector to select which categories are displayed by a ViewDefinition.
137
+ * @param iModelDb Insert into this iModel
138
+ * @param definitionModelId Insert the new CategorySelector into this DefinitionModel
139
+ * @param name The name of the CategorySelector
140
+ * @param categories Array of categories to select for display
141
+ * @returns The Id of the newly inserted CategorySelector element.
142
+ * @throws [[IModelError]] if unable to insert the element.
143
+ */
144
+ static insert(iModelDb, definitionModelId, name, categories) {
145
+ const categorySelector = this.create(iModelDb, definitionModelId, name, categories);
146
+ return iModelDb.elements.insertElement(categorySelector.toJSON());
147
+ }
148
+ }
149
+ exports.CategorySelector = CategorySelector;
150
+ /**
151
+ * The definition element for a view. ViewDefinitions specify the area/volume that is viewed, the Ids of a DisplayStyle and a CategorySelector,
152
+ * plus additional view-specific parameters in their [[Element.jsonProperties]].
153
+ *
154
+ * Subclasses of ViewDefinition determine which model(s) are viewed.
155
+ *
156
+ * **Example: Obtaining the background color for a view**
157
+ * ``` ts
158
+ * [[include:ViewDefinition.getBackgroundColor]]
159
+ * ```
160
+ *
161
+ * @note ViewDefinition is only available in the backend. See [ViewState]($frontend) for usage in the frontend.
162
+ * @public
163
+ */
164
+ class ViewDefinition extends (_b = Element_1.DefinitionElement) {
165
+ /** @internal */
166
+ constructor(props, iModel) {
167
+ super(props, iModel);
168
+ this.categorySelectorId = core_bentley_1.Id64.fromJSON(props.categorySelectorId);
169
+ if (!core_bentley_1.Id64.isValid(this.categorySelectorId))
170
+ throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `categorySelectorId is invalid`);
171
+ this.displayStyleId = core_bentley_1.Id64.fromJSON(props.displayStyleId);
172
+ if (!core_bentley_1.Id64.isValid(this.displayStyleId))
173
+ throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `displayStyleId is invalid`);
174
+ }
175
+ /** @internal */
176
+ static get className() { return "ViewDefinition"; }
177
+ /** @internal */
178
+ toJSON() {
179
+ const json = super.toJSON();
180
+ json.categorySelectorId = this.categorySelectorId;
181
+ json.displayStyleId = this.displayStyleId;
182
+ return json;
183
+ }
184
+ /** @internal */
185
+ collectReferenceConcreteIds(referenceIds) {
186
+ super.collectReferenceConcreteIds(referenceIds);
187
+ referenceIds.addElement(this.categorySelectorId);
188
+ referenceIds.addElement(this.displayStyleId);
189
+ const acsId = this.getAuxiliaryCoordinateSystemId();
190
+ if (core_bentley_1.Id64.isValidId64(acsId)) {
191
+ referenceIds.addElement(acsId);
192
+ }
193
+ }
194
+ /** @internal */
195
+ static onCloned(context, sourceElementProps, targetElementProps) {
196
+ super.onCloned(context, sourceElementProps, targetElementProps);
197
+ if (context.isBetweenIModels && targetElementProps.jsonProperties && targetElementProps.jsonProperties.viewDetails) {
198
+ const acsId = core_bentley_1.Id64.fromJSON(targetElementProps.jsonProperties.viewDetails.acs);
199
+ if (core_bentley_1.Id64.isValidId64(acsId)) {
200
+ targetElementProps.jsonProperties.viewDetails.acs = context.findTargetElementId(acsId);
201
+ }
202
+ }
203
+ }
204
+ /** Type guard for `instanceof ViewDefinition3d` */
205
+ isView3d() { return this instanceof ViewDefinition3d; }
206
+ /** Type guard for 'instanceof ViewDefinition2d` */
207
+ isView2d() { return this instanceof ViewDefinition2d; }
208
+ /** Type guard for `instanceof SpatialViewDefinition` */
209
+ isSpatialView() { return this instanceof SpatialViewDefinition; }
210
+ /** Type guard for 'instanceof DrawingViewDefinition' */
211
+ isDrawingView() { return this instanceof DrawingViewDefinition; }
212
+ /** Load this view's DisplayStyle from the IModelDb. */
213
+ loadDisplayStyle() { return this.iModel.elements.getElement(this.displayStyleId); }
214
+ /** Load this view's CategorySelector from the IModelDb. */
215
+ loadCategorySelector() { return this.iModel.elements.getElement(this.categorySelectorId); }
216
+ /** The Id of the AuxiliaryCoordinateSystem for this ViewDefinition, or an invalid Id if no ACS is defined. */
217
+ getAuxiliaryCoordinateSystemId() {
218
+ return this.details.auxiliaryCoordinateSystemId;
219
+ }
220
+ /** Set or clear the AuxiliaryCoordinateSystem for this ViewDefinition.
221
+ * @param acsId The Id of the new AuxiliaryCoordinateSystem. If `Id64.invalid` is passed, then no AuxiliaryCoordinateSystem will be used.
222
+ */
223
+ setAuxiliaryCoordinateSystemId(acsId) {
224
+ this.details.auxiliaryCoordinateSystemId = acsId;
225
+ }
226
+ /** Create a Code for a ViewDefinition given a name that is meant to be unique within the scope of the specified DefinitionModel.
227
+ * @param iModel The IModelDb
228
+ * @param scopeModelId The Id of the DefinitionModel to contain the ViewDefinition and provides the scope for its name.
229
+ * @param codeValue The ViewDefinition name
230
+ */
231
+ static createCode(iModel, scopeModelId, codeValue) {
232
+ const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.viewDefinition);
233
+ return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
234
+ }
235
+ }
236
+ exports.ViewDefinition = ViewDefinition;
237
+ _a = ViewDefinition;
238
+ /** @beta */
239
+ ViewDefinition.requiredReferenceKeys = [...Reflect.get(_b, "requiredReferenceKeys", _a), "categorySelectorId", "displayStyleId"];
240
+ /** @alpha */
241
+ ViewDefinition.requiredReferenceKeyTypeMap = {
242
+ ...Reflect.get(_b, "requiredReferenceKeyTypeMap", _a),
243
+ categorySelectorId: core_common_1.ConcreteEntityTypes.Element,
244
+ displayStyleId: core_common_1.ConcreteEntityTypes.Element,
245
+ };
246
+ /** Defines a view of one or more 3d models.
247
+ * @public
248
+ */
249
+ class ViewDefinition3d extends ViewDefinition {
250
+ /** @internal */
251
+ constructor(props, iModel) {
252
+ super(props, iModel);
253
+ this.cameraOn = core_bentley_1.JsonUtils.asBool(props.cameraOn);
254
+ this.origin = core_geometry_1.Point3d.fromJSON(props.origin);
255
+ this.extents = core_geometry_1.Vector3d.fromJSON(props.extents);
256
+ this.angles = core_geometry_1.YawPitchRollAngles.fromJSON(props.angles);
257
+ this.camera = new core_common_1.Camera(props.camera);
258
+ this._details = new core_common_1.ViewDetails3d(this.jsonProperties);
259
+ }
260
+ /** @internal */
261
+ static get className() { return "ViewDefinition3d"; }
262
+ /** @internal */
263
+ toJSON() {
264
+ const val = super.toJSON();
265
+ val.cameraOn = this.cameraOn;
266
+ val.origin = this.origin;
267
+ val.extents = this.extents;
268
+ val.angles = this.angles;
269
+ val.camera = this.camera;
270
+ return val;
271
+ }
272
+ /** Provides access to optional detail settings for this view. */
273
+ get details() { return this._details; }
274
+ /** Load this view's DisplayStyle3d from the IModelDb. */
275
+ loadDisplayStyle3d() { return this.iModel.elements.getElement(this.displayStyleId); }
276
+ }
277
+ exports.ViewDefinition3d = ViewDefinition3d;
278
+ /** Defines a view of one or more SpatialModels.
279
+ * The list of viewed models is stored by the ModelSelector.
280
+ *
281
+ * This is how a SpatialViewDefinition selects the elements to display:
282
+ *
283
+ * SpatialViewDefinition
284
+ * * ModelSelector
285
+ * * ModelIds -------> SpatialModels <----------GeometricElement3d.Model
286
+ * * CategorySelector
287
+ * * CategoryIds -----> SpatialCategories <----------GeometricElement3d.Category
288
+ * @public
289
+ */
290
+ class SpatialViewDefinition extends (_d = ViewDefinition3d) {
291
+ /** @internal */
292
+ constructor(props, iModel) {
293
+ super(props, iModel);
294
+ this.modelSelectorId = core_bentley_1.Id64.fromJSON(props.modelSelectorId);
295
+ if (!core_bentley_1.Id64.isValid(this.modelSelectorId))
296
+ throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, `modelSelectorId is invalid`);
297
+ }
298
+ /** @internal */
299
+ static get className() { return "SpatialViewDefinition"; }
300
+ /** Construct a SpatialViewDefinition from its JSON representation. */
301
+ static fromJSON(props, iModel) {
302
+ return new SpatialViewDefinition({ ...props, classFullName: this.classFullName }, iModel);
303
+ }
304
+ /** Convert this view to its JSON representation. */
305
+ toJSON() {
306
+ const json = super.toJSON();
307
+ json.modelSelectorId = this.modelSelectorId;
308
+ return json;
309
+ }
310
+ /** @internal */
311
+ collectReferenceConcreteIds(referenceIds) {
312
+ super.collectReferenceConcreteIds(referenceIds);
313
+ referenceIds.addElement(this.modelSelectorId);
314
+ }
315
+ /** Load this view's ModelSelector from the IModelDb. */
316
+ loadModelSelector() { return this.iModel.elements.getElement(this.modelSelectorId); }
317
+ /**
318
+ * Create a SpatialViewDefinition with the camera turned on.
319
+ * @param iModelDb The iModel
320
+ * @param definitionModelId The [[DefinitionModel]]
321
+ * @param name The name/CodeValue of the view
322
+ * @param modelSelectorId The [[ModelSelector]] that this view should use
323
+ * @param categorySelectorId The [[CategorySelector]] that this view should use
324
+ * @param displayStyleId The [[DisplayStyle3d]] that this view should use
325
+ * @param range Defines the view origin and extents
326
+ * @param standardView Optionally defines the view's rotation
327
+ * @param cameraAngle Camera angle in radians.
328
+ * @returns The newly constructed SpatialViewDefinition element
329
+ * @throws [[IModelError]] if there is a problem creating the view
330
+ */
331
+ static createWithCamera(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso, cameraAngle = core_geometry_1.Angle.piOver2Radians) {
332
+ const rotation = core_geometry_1.Matrix3d.createStandardWorldToView(standardView);
333
+ const angles = core_geometry_1.YawPitchRollAngles.createFromMatrix3d(rotation);
334
+ const rotationTransform = core_geometry_1.Transform.createOriginAndMatrix(undefined, rotation);
335
+ const rotatedRange = rotationTransform.multiplyRange(range);
336
+ const cameraDistance = 2 * (rotatedRange.diagonal().magnitudeXY() / 2.0) / Math.tan(cameraAngle / 2.0);
337
+ const cameraLocation = rotatedRange.diagonalFractionToPoint(.5); // Start at center.
338
+ cameraLocation.z += cameraDistance; // Back up by camera distance.
339
+ rotation.multiplyTransposeVectorInPlace(cameraLocation);
340
+ const viewDefinitionProps = {
341
+ classFullName: this.classFullName,
342
+ model: definitionModelId,
343
+ code: this.createCode(iModelDb, definitionModelId, name),
344
+ modelSelectorId,
345
+ categorySelectorId,
346
+ displayStyleId,
347
+ origin: rotation.multiplyTransposeXYZ(rotatedRange.low.x, rotatedRange.low.y, rotatedRange.low.z),
348
+ extents: rotatedRange.diagonal(),
349
+ angles,
350
+ cameraOn: true,
351
+ camera: { lens: { radians: cameraAngle }, focusDist: cameraDistance, eye: cameraLocation },
352
+ };
353
+ return new SpatialViewDefinition(viewDefinitionProps, iModelDb);
354
+ }
355
+ /**
356
+ * Insert an SpatialViewDefinition with the camera turned on.
357
+ * @see [[createWithCamera]] for details.
358
+ * @returns The Id of the newly inserted SpatialViewDefinition element
359
+ * @throws [[IModelError]] if there is an insert problem.
360
+ */
361
+ static insertWithCamera(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso, cameraAngle = core_geometry_1.Angle.piOver2Radians) {
362
+ const viewDefinition = this.createWithCamera(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView, cameraAngle);
363
+ return iModelDb.elements.insertElement(viewDefinition.toJSON());
364
+ }
365
+ }
366
+ exports.SpatialViewDefinition = SpatialViewDefinition;
367
+ _c = SpatialViewDefinition;
368
+ /** @beta */
369
+ SpatialViewDefinition.requiredReferenceKeys = [...Reflect.get(_d, "requiredReferenceKeys", _c), "modelSelectorId"];
370
+ /** @alpha */
371
+ SpatialViewDefinition.requiredReferenceKeyTypeMap = {
372
+ ...Reflect.get(_d, "requiredReferenceKeyTypeMap", _c),
373
+ modelSelectorId: core_common_1.ConcreteEntityTypes.Element,
374
+ };
375
+ /** Defines a spatial view that displays geometry on the image plane using a parallel orthographic projection.
376
+ * See [how to create a OrthographicViewDefinition]$(docs/learning/backend/CreateElements.md#OrthographicViewDefinition).
377
+ * @public
378
+ */
379
+ class OrthographicViewDefinition extends SpatialViewDefinition {
380
+ /** @internal */
381
+ static get className() { return "OrthographicViewDefinition"; }
382
+ constructor(props, iModel) { super(props, iModel); }
383
+ /**
384
+ * Create an OrthographicViewDefinition
385
+ * @param iModelDb The iModel
386
+ * @param definitionModelId The [[DefinitionModel]]
387
+ * @param name The name/CodeValue of the view
388
+ * @param modelSelectorId The [[ModelSelector]] that this view should use
389
+ * @param categorySelectorId The [[CategorySelector]] that this view should use
390
+ * @param displayStyleId The [[DisplayStyle3d]] that this view should use
391
+ * @param range Defines the view origin and extents
392
+ * @param standardView Optionally defines the view's rotation
393
+ * @returns The newly constructed OrthographicViewDefinition element
394
+ * @throws [[IModelError]] if there is a problem creating the view
395
+ */
396
+ static create(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso) {
397
+ const rotation = core_geometry_1.Matrix3d.createStandardWorldToView(standardView);
398
+ const angles = core_geometry_1.YawPitchRollAngles.createFromMatrix3d(rotation);
399
+ const rotationTransform = core_geometry_1.Transform.createOriginAndMatrix(undefined, rotation);
400
+ const rotatedRange = rotationTransform.multiplyRange(range);
401
+ const viewDefinitionProps = {
402
+ classFullName: this.classFullName,
403
+ model: definitionModelId,
404
+ code: this.createCode(iModelDb, definitionModelId, name),
405
+ modelSelectorId,
406
+ categorySelectorId,
407
+ displayStyleId,
408
+ origin: rotation.multiplyTransposeXYZ(rotatedRange.low.x, rotatedRange.low.y, rotatedRange.low.z),
409
+ extents: rotatedRange.diagonal(),
410
+ angles,
411
+ cameraOn: false,
412
+ camera: new core_common_1.Camera(), // not used when cameraOn === false
413
+ };
414
+ return new OrthographicViewDefinition(viewDefinitionProps, iModelDb);
415
+ }
416
+ /**
417
+ * Insert an OrthographicViewDefinition
418
+ * @param iModelDb Insert into this iModel
419
+ * @param definitionModelId Insert the new OrthographicViewDefinition into this DefinitionModel
420
+ * @param name The name/CodeValue of the view
421
+ * @param modelSelectorId The [[ModelSelector]] that this view should use
422
+ * @param categorySelectorId The [[CategorySelector]] that this view should use
423
+ * @param displayStyleId The [[DisplayStyle3d]] that this view should use
424
+ * @param range Defines the view origin and extents
425
+ * @param standardView Optionally defines the view's rotation
426
+ * @returns The Id of the newly inserted OrthographicViewDefinition element
427
+ * @throws [[IModelError]] if there is an insert problem.
428
+ */
429
+ static insert(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView = core_geometry_1.StandardViewIndex.Iso) {
430
+ const viewDefinition = this.create(iModelDb, definitionModelId, name, modelSelectorId, categorySelectorId, displayStyleId, range, standardView);
431
+ return iModelDb.elements.insertElement(viewDefinition.toJSON());
432
+ }
433
+ /** Set a new viewed range without changing the rotation or any other properties. */
434
+ setRange(range) {
435
+ const rotation = this.angles.toMatrix3d();
436
+ const rotationTransform = core_geometry_1.Transform.createOriginAndMatrix(undefined, rotation);
437
+ const rotatedRange = rotationTransform.multiplyRange(range);
438
+ this.origin = core_geometry_1.Point3d.createFrom(rotation.multiplyTransposeXYZ(rotatedRange.low.x, rotatedRange.low.y, rotatedRange.low.z));
439
+ this.extents = rotatedRange.diagonal();
440
+ }
441
+ }
442
+ exports.OrthographicViewDefinition = OrthographicViewDefinition;
443
+ /** Defines a view of a single 2d model. Each 2d model has its own coordinate system, so only one may appear per view.
444
+ * @public
445
+ */
446
+ class ViewDefinition2d extends ViewDefinition {
447
+ /** @internal */
448
+ constructor(props, iModel) {
449
+ super(props, iModel);
450
+ this.baseModelId = core_bentley_1.Id64.fromJSON(props.baseModelId);
451
+ this.origin = core_geometry_1.Point2d.fromJSON(props.origin);
452
+ this.delta = core_geometry_1.Point2d.fromJSON(props.delta);
453
+ this.angle = core_geometry_1.Angle.fromJSON(props.angle);
454
+ this._details = new core_common_1.ViewDetails(this.jsonProperties);
455
+ }
456
+ /** @internal */
457
+ static get className() { return "ViewDefinition2d"; }
458
+ /** @internal */
459
+ toJSON() {
460
+ const val = super.toJSON();
461
+ val.baseModelId = this.baseModelId;
462
+ val.origin = this.origin;
463
+ val.delta = this.delta;
464
+ val.angle = this.angle;
465
+ return val;
466
+ }
467
+ /** @internal */
468
+ collectReferenceConcreteIds(referenceIds) {
469
+ super.collectReferenceConcreteIds(referenceIds);
470
+ referenceIds.addElement(this.baseModelId);
471
+ }
472
+ /** Provides access to optional detail settings for this view. */
473
+ get details() { return this._details; }
474
+ /** Load this view's DisplayStyle2d from the IModelDb. */
475
+ loadDisplayStyle2d() { return this.iModel.elements.getElement(this.displayStyleId); }
476
+ }
477
+ exports.ViewDefinition2d = ViewDefinition2d;
478
+ /** Defines a view of a [[DrawingModel]].
479
+ * @public
480
+ */
481
+ class DrawingViewDefinition extends ViewDefinition2d {
482
+ /** @internal */
483
+ static get className() { return "DrawingViewDefinition"; }
484
+ /** @internal */
485
+ constructor(props, iModel) {
486
+ super(props, iModel);
487
+ }
488
+ /** Create a DrawingViewDefinition
489
+ * @param iModelDb The iModel
490
+ * @param definitionModelId The [[DefinitionModel]]
491
+ * @param name The name/CodeValue of the view
492
+ * @param baseModelId The base [[DrawingModel]]
493
+ * @param categorySelectorId The [[CategorySelector]] that this view should use
494
+ * @param displayStyleId The [[DisplayStyle2d]] that this view should use
495
+ * @param range Defines the view origin and extents
496
+ * @throws [[IModelError]] if there is a problem creating the element.
497
+ */
498
+ static create(iModelDb, definitionModelId, name, baseModelId, categorySelectorId, displayStyleId, range) {
499
+ const viewDefinitionProps = {
500
+ classFullName: this.classFullName,
501
+ model: definitionModelId,
502
+ code: this.createCode(iModelDb, definitionModelId, name),
503
+ baseModelId,
504
+ categorySelectorId,
505
+ displayStyleId,
506
+ origin: { x: range.low.x, y: range.low.y },
507
+ delta: range.diagonal(),
508
+ angle: 0,
509
+ };
510
+ return new DrawingViewDefinition(viewDefinitionProps, iModelDb);
511
+ }
512
+ /** Construct a DrawingViewDefinition from its JSON representation. */
513
+ static fromJSON(props, iModel) {
514
+ return new DrawingViewDefinition({ ...props, classFullName: this.classFullName }, iModel);
515
+ }
516
+ /** Insert a DrawingViewDefinition
517
+ * @param iModelDb Insert into this iModel
518
+ * @param definitionModelId Insert the new DrawingViewDefinition into this [[DefinitionModel]]
519
+ * @param name The name/CodeValue of the view
520
+ * @param baseModelId The base [[DrawingModel]]
521
+ * @param categorySelectorId The [[CategorySelector]] that this view should use
522
+ * @param displayStyleId The [[DisplayStyle2d]] that this view should use
523
+ * @param range Defines the view origin and extents
524
+ * @throws [[IModelError]] if there is an insert problem.
525
+ */
526
+ static insert(iModelDb, definitionModelId, name, baseModelId, categorySelectorId, displayStyleId, range) {
527
+ const viewDefinition = this.create(iModelDb, definitionModelId, name, baseModelId, categorySelectorId, displayStyleId, range);
528
+ return iModelDb.elements.insertElement(viewDefinition.toJSON());
529
+ }
530
+ }
531
+ exports.DrawingViewDefinition = DrawingViewDefinition;
532
+ /** Defines a view of a [[SheetModel]].
533
+ * @public
534
+ */
535
+ class SheetViewDefinition extends ViewDefinition2d {
536
+ /** @internal */
537
+ static get className() { return "SheetViewDefinition"; }
538
+ }
539
+ exports.SheetViewDefinition = SheetViewDefinition;
540
+ /** A ViewDefinition used to display a 2d template model.
541
+ * @internal
542
+ */
543
+ class TemplateViewDefinition2d extends ViewDefinition2d {
544
+ /** @internal */
545
+ static get className() { return "TemplateViewDefinition2d"; }
546
+ }
547
+ exports.TemplateViewDefinition2d = TemplateViewDefinition2d;
548
+ /** A ViewDefinition used to display a 3d template model.
549
+ * @internal
550
+ */
551
+ class TemplateViewDefinition3d extends ViewDefinition3d {
552
+ /** @internal */
553
+ static get className() { return "TemplateViewDefinition3d"; }
554
+ }
555
+ exports.TemplateViewDefinition3d = TemplateViewDefinition3d;
556
+ /** An auxiliary coordinate system element. Auxiliary coordinate systems can be used by views to show
557
+ * coordinate information in different units and/or orientations.
558
+ * @public
559
+ */
560
+ class AuxCoordSystem extends Element_1.DefinitionElement {
561
+ constructor(props, iModel) { super(props, iModel); }
562
+ /** @internal */
563
+ static get className() { return "AuxCoordSystem"; }
564
+ }
565
+ exports.AuxCoordSystem = AuxCoordSystem;
566
+ /** A 2d auxiliary coordinate system.
567
+ * @public
568
+ */
569
+ class AuxCoordSystem2d extends AuxCoordSystem {
570
+ constructor(props, iModel) { super(props, iModel); }
571
+ /** @internal */
572
+ static get className() { return "AuxCoordSystem2d"; }
573
+ /** Create a Code for a AuxCoordSystem2d element given a name that is meant to be unique within the scope of the specified DefinitionModel.
574
+ * @param iModel The IModelDb
575
+ * @param scopeModelId The Id of the DefinitionModel that contains the AuxCoordSystem2d element and provides the scope for its name.
576
+ * @param codeValue The AuxCoordSystem2d name
577
+ */
578
+ static createCode(iModel, scopeModelId, codeValue) {
579
+ const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.auxCoordSystem2d);
580
+ return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
581
+ }
582
+ }
583
+ exports.AuxCoordSystem2d = AuxCoordSystem2d;
584
+ /** A 3d auxiliary coordinate system.
585
+ * @public
586
+ */
587
+ class AuxCoordSystem3d extends AuxCoordSystem {
588
+ constructor(props, iModel) { super(props, iModel); }
589
+ /** @internal */
590
+ static get className() { return "AuxCoordSystem3d"; }
591
+ /** Create a Code for a AuxCoordSystem3d element given a name that is meant to be unique within the scope of the specified DefinitionModel.
592
+ * @param iModel The IModelDb
593
+ * @param scopeModelId The Id of the DefinitionModel that contains the AuxCoordSystem3d element and provides the scope for its name.
594
+ * @param codeValue The AuxCoordSystem3d name
595
+ */
596
+ static createCode(iModel, scopeModelId, codeValue) {
597
+ const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.auxCoordSystem3d);
598
+ return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
599
+ }
600
+ }
601
+ exports.AuxCoordSystem3d = AuxCoordSystem3d;
602
+ /** A spatial auxiliary coordinate system.
603
+ * @public
604
+ */
605
+ class AuxCoordSystemSpatial extends AuxCoordSystem3d {
606
+ /** @internal */
607
+ static get className() { return "AuxCoordSystemSpatial"; }
608
+ /** Create a Code for a AuxCoordSystemSpatial element given a name that is meant to be unique within the scope of the specified DefinitionModel.
609
+ * @param iModel The IModelDb
610
+ * @param scopeModelId The Id of the DefinitionModel that contains the AuxCoordSystemSpatial element and provides the scope for its name.
611
+ * @param codeValue The AuxCoordSystemSpatial name
612
+ */
613
+ static createCode(iModel, scopeModelId, codeValue) {
614
+ const codeSpec = iModel.codeSpecs.getByName(core_common_1.BisCodeSpec.auxCoordSystemSpatial);
615
+ return new core_common_1.Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });
616
+ }
617
+ }
618
+ exports.AuxCoordSystemSpatial = AuxCoordSystemSpatial;
619
+ /** Represents an *attachment* of a [[ViewDefinition]] to a [[Sheet]].
620
+ * @public
621
+ */
622
+ class ViewAttachment extends Element_1.GraphicalElement2d {
623
+ constructor(props, iModel) {
624
+ super(props, iModel);
625
+ this.view = new core_common_1.RelatedElement(props.view);
626
+ // ###NOTE: scale, displayPriority, and clipping vectors are stored in ViewAttachmentProps.jsonProperties.
627
+ }
628
+ /** @internal */
629
+ static get className() { return "ViewAttachment"; }
630
+ /** @internal */
631
+ collectReferenceConcreteIds(referenceIds) {
632
+ super.collectReferenceConcreteIds(referenceIds);
633
+ referenceIds.addElement(this.view.id);
634
+ }
635
+ }
636
+ exports.ViewAttachment = ViewAttachment;
637
+ /** The position in space of a Light.
638
+ * @internal
639
+ */
640
+ class LightLocation extends Element_1.SpatialLocationElement {
641
+ /** @internal */
642
+ constructor(props, iModel) { super(props, iModel); }
643
+ /** @internal */
644
+ static get className() { return "LightLocation"; }
645
+ }
646
+ exports.LightLocation = LightLocation;
647
647
  //# sourceMappingURL=ViewDefinition.js.map