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

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 (270) hide show
  1. package/CHANGELOG.md +68 -1
  2. package/lib/cjs/BackendHubAccess.d.ts +226 -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/BlobContainerService.d.ts +120 -0
  13. package/lib/cjs/BlobContainerService.d.ts.map +1 -0
  14. package/lib/cjs/BlobContainerService.js +18 -0
  15. package/lib/cjs/BlobContainerService.js.map +1 -0
  16. package/lib/cjs/BriefcaseManager.d.ts +184 -170
  17. package/lib/cjs/BriefcaseManager.d.ts.map +1 -1
  18. package/lib/cjs/BriefcaseManager.js +421 -414
  19. package/lib/cjs/BriefcaseManager.js.map +1 -1
  20. package/lib/cjs/Category.d.ts +153 -153
  21. package/lib/cjs/Category.js +243 -243
  22. package/lib/cjs/Category.js.map +1 -1
  23. package/lib/cjs/ChangeSummaryManager.d.ts +187 -187
  24. package/lib/cjs/ChangeSummaryManager.js +444 -445
  25. package/lib/cjs/ChangeSummaryManager.js.map +1 -1
  26. package/lib/cjs/ChangedElementsDb.d.ts +99 -99
  27. package/lib/cjs/ChangedElementsDb.js +165 -165
  28. package/lib/cjs/ChangedElementsManager.d.ts +39 -39
  29. package/lib/cjs/ChangedElementsManager.js +88 -88
  30. package/lib/cjs/ChannelControl.d.ts +70 -0
  31. package/lib/cjs/ChannelControl.d.ts.map +1 -0
  32. package/lib/cjs/ChannelControl.js +89 -0
  33. package/lib/cjs/ChannelControl.js.map +1 -0
  34. package/lib/cjs/CheckpointManager.d.ts +121 -121
  35. package/lib/cjs/CheckpointManager.d.ts.map +1 -1
  36. package/lib/cjs/CheckpointManager.js +351 -349
  37. package/lib/cjs/CheckpointManager.js.map +1 -1
  38. package/lib/cjs/ClassRegistry.d.ts +79 -79
  39. package/lib/cjs/ClassRegistry.js +249 -245
  40. package/lib/cjs/ClassRegistry.js.map +1 -1
  41. package/lib/cjs/CloudSqlite.d.ts +572 -350
  42. package/lib/cjs/CloudSqlite.d.ts.map +1 -1
  43. package/lib/cjs/CloudSqlite.js +374 -153
  44. package/lib/cjs/CloudSqlite.js.map +1 -1
  45. package/lib/cjs/CodeService.d.ts +399 -396
  46. package/lib/cjs/CodeService.d.ts.map +1 -1
  47. package/lib/cjs/CodeService.js +63 -63
  48. package/lib/cjs/CodeService.js.map +1 -1
  49. package/lib/cjs/CodeSpecs.d.ts +58 -55
  50. package/lib/cjs/CodeSpecs.d.ts.map +1 -1
  51. package/lib/cjs/CodeSpecs.js +154 -124
  52. package/lib/cjs/CodeSpecs.js.map +1 -1
  53. package/lib/cjs/ConcurrentQuery.d.ts +13 -13
  54. package/lib/cjs/ConcurrentQuery.d.ts.map +1 -1
  55. package/lib/cjs/ConcurrentQuery.js +36 -36
  56. package/lib/cjs/CustomViewState3dCreator.d.ts +21 -21
  57. package/lib/cjs/CustomViewState3dCreator.d.ts.map +1 -1
  58. package/lib/cjs/CustomViewState3dCreator.js +80 -81
  59. package/lib/cjs/CustomViewState3dCreator.js.map +1 -1
  60. package/lib/cjs/DevTools.d.ts +74 -71
  61. package/lib/cjs/DevTools.d.ts.map +1 -1
  62. package/lib/cjs/DevTools.js +156 -154
  63. package/lib/cjs/DevTools.js.map +1 -1
  64. package/lib/cjs/DisplayStyle.d.ts +104 -106
  65. package/lib/cjs/DisplayStyle.d.ts.map +1 -1
  66. package/lib/cjs/DisplayStyle.js +251 -256
  67. package/lib/cjs/DisplayStyle.js.map +1 -1
  68. package/lib/cjs/ECDb.d.ts +194 -191
  69. package/lib/cjs/ECDb.d.ts.map +1 -1
  70. package/lib/cjs/ECDb.js +351 -350
  71. package/lib/cjs/ECDb.js.map +1 -1
  72. package/lib/cjs/ECSchemaXmlContext.d.ts +18 -18
  73. package/lib/cjs/ECSchemaXmlContext.d.ts.map +1 -1
  74. package/lib/cjs/ECSchemaXmlContext.js +41 -41
  75. package/lib/cjs/ECSqlStatement.d.ts +473 -473
  76. package/lib/cjs/ECSqlStatement.js +791 -791
  77. package/lib/cjs/Element.d.ts +1105 -1109
  78. package/lib/cjs/Element.d.ts.map +1 -1
  79. package/lib/cjs/Element.js +1416 -1427
  80. package/lib/cjs/Element.js.map +1 -1
  81. package/lib/cjs/ElementAspect.d.ts +175 -179
  82. package/lib/cjs/ElementAspect.d.ts.map +1 -1
  83. package/lib/cjs/ElementAspect.js +202 -211
  84. package/lib/cjs/ElementAspect.js.map +1 -1
  85. package/lib/cjs/ElementGraphics.d.ts +9 -9
  86. package/lib/cjs/ElementGraphics.js +41 -41
  87. package/lib/cjs/ElementGraphics.js.map +1 -1
  88. package/lib/cjs/ElementTreeWalker.d.ts +162 -162
  89. package/lib/cjs/ElementTreeWalker.d.ts.map +1 -1
  90. package/lib/cjs/ElementTreeWalker.js +409 -409
  91. package/lib/cjs/ElementTreeWalker.js.map +1 -1
  92. package/lib/cjs/Entity.d.ts +102 -106
  93. package/lib/cjs/Entity.d.ts.map +1 -1
  94. package/lib/cjs/Entity.js +118 -134
  95. package/lib/cjs/Entity.js.map +1 -1
  96. package/lib/cjs/EntityReferences.d.ts +49 -49
  97. package/lib/cjs/EntityReferences.d.ts.map +1 -1
  98. package/lib/cjs/EntityReferences.js +95 -95
  99. package/lib/cjs/ExportGraphics.d.ts +317 -317
  100. package/lib/cjs/ExportGraphics.d.ts.map +1 -1
  101. package/lib/cjs/ExportGraphics.js +208 -208
  102. package/lib/cjs/ExternalSource.d.ts +95 -96
  103. package/lib/cjs/ExternalSource.d.ts.map +1 -1
  104. package/lib/cjs/ExternalSource.js +130 -131
  105. package/lib/cjs/ExternalSource.js.map +1 -1
  106. package/lib/cjs/GeoCoordConfig.d.ts +19 -19
  107. package/lib/cjs/GeoCoordConfig.js +85 -85
  108. package/lib/cjs/GeoCoordConfig.js.map +1 -1
  109. package/lib/cjs/GeometrySummary.d.ts +4 -4
  110. package/lib/cjs/GeometrySummary.js +333 -333
  111. package/lib/cjs/GeometrySummary.js.map +1 -1
  112. package/lib/cjs/HubMock.d.ts +94 -94
  113. package/lib/cjs/HubMock.js +220 -222
  114. package/lib/cjs/HubMock.js.map +1 -1
  115. package/lib/cjs/IModelCloneContext.d.ts +8 -8
  116. package/lib/cjs/IModelCloneContext.d.ts.map +1 -1
  117. package/lib/cjs/IModelCloneContext.js +15 -15
  118. package/lib/cjs/IModelDb.d.ts +1222 -1196
  119. package/lib/cjs/IModelDb.d.ts.map +1 -1
  120. package/lib/cjs/IModelDb.js +2389 -2392
  121. package/lib/cjs/IModelDb.js.map +1 -1
  122. package/lib/cjs/IModelElementCloneContext.d.ts +89 -89
  123. package/lib/cjs/IModelElementCloneContext.js +159 -159
  124. package/lib/cjs/IModelHost.d.ts +370 -369
  125. package/lib/cjs/IModelHost.d.ts.map +1 -1
  126. package/lib/cjs/IModelHost.js +476 -496
  127. package/lib/cjs/IModelHost.js.map +1 -1
  128. package/lib/cjs/IModelJsFs.d.ts +62 -62
  129. package/lib/cjs/IModelJsFs.js +139 -140
  130. package/lib/cjs/IModelJsFs.js.map +1 -1
  131. package/lib/cjs/IpcHost.d.ts +104 -104
  132. package/lib/cjs/IpcHost.js +276 -278
  133. package/lib/cjs/IpcHost.js.map +1 -1
  134. package/lib/cjs/LineStyle.d.ts +311 -311
  135. package/lib/cjs/LineStyle.js +295 -295
  136. package/lib/cjs/LocalHub.d.ts +162 -162
  137. package/lib/cjs/LocalHub.d.ts.map +1 -1
  138. package/lib/cjs/LocalHub.js +579 -584
  139. package/lib/cjs/LocalHub.js.map +1 -1
  140. package/lib/cjs/LocalhostIpcHost.d.ts +21 -20
  141. package/lib/cjs/LocalhostIpcHost.d.ts.map +1 -1
  142. package/lib/cjs/LocalhostIpcHost.js +79 -81
  143. package/lib/cjs/LocalhostIpcHost.js.map +1 -1
  144. package/lib/cjs/Material.d.ts +131 -131
  145. package/lib/cjs/Material.d.ts.map +1 -1
  146. package/lib/cjs/Material.js +185 -181
  147. package/lib/cjs/Material.js.map +1 -1
  148. package/lib/cjs/Model.d.ts +391 -392
  149. package/lib/cjs/Model.d.ts.map +1 -1
  150. package/lib/cjs/Model.js +487 -485
  151. package/lib/cjs/Model.js.map +1 -1
  152. package/lib/cjs/NativeAppStorage.d.ts +51 -51
  153. package/lib/cjs/NativeAppStorage.js +202 -202
  154. package/lib/cjs/NativeAppStorage.js.map +1 -1
  155. package/lib/cjs/NativeHost.d.ts +52 -52
  156. package/lib/cjs/NativeHost.d.ts.map +1 -1
  157. package/lib/cjs/NativeHost.js +158 -163
  158. package/lib/cjs/NativeHost.js.map +1 -1
  159. package/lib/cjs/NavigationRelationship.d.ts +156 -156
  160. package/lib/cjs/NavigationRelationship.js +225 -225
  161. package/lib/cjs/NavigationRelationship.js.map +1 -1
  162. package/lib/cjs/PromiseMemoizer.d.ts +51 -51
  163. package/lib/cjs/PromiseMemoizer.d.ts.map +1 -1
  164. package/lib/cjs/PromiseMemoizer.js +101 -101
  165. package/lib/cjs/PromiseMemoizer.js.map +1 -1
  166. package/lib/cjs/PropertyStore.d.ts +123 -132
  167. package/lib/cjs/PropertyStore.d.ts.map +1 -1
  168. package/lib/cjs/PropertyStore.js +179 -11
  169. package/lib/cjs/PropertyStore.js.map +1 -1
  170. package/lib/cjs/Relationship.d.ts +413 -416
  171. package/lib/cjs/Relationship.d.ts.map +1 -1
  172. package/lib/cjs/Relationship.js +491 -494
  173. package/lib/cjs/Relationship.js.map +1 -1
  174. package/lib/cjs/RpcBackend.d.ts +5 -5
  175. package/lib/cjs/RpcBackend.js +32 -32
  176. package/lib/cjs/SQLiteDb.d.ts +317 -219
  177. package/lib/cjs/SQLiteDb.d.ts.map +1 -1
  178. package/lib/cjs/SQLiteDb.js +318 -214
  179. package/lib/cjs/SQLiteDb.js.map +1 -1
  180. package/lib/cjs/Schema.d.ts +55 -55
  181. package/lib/cjs/Schema.js +83 -83
  182. package/lib/cjs/Schema.js.map +1 -1
  183. package/lib/cjs/ServerBasedLocks.d.ts +57 -57
  184. package/lib/cjs/ServerBasedLocks.js +168 -168
  185. package/lib/cjs/ServerBasedLocks.js.map +1 -1
  186. package/lib/cjs/SqliteStatement.d.ts +360 -360
  187. package/lib/cjs/SqliteStatement.d.ts.map +1 -1
  188. package/lib/cjs/SqliteStatement.js +586 -586
  189. package/lib/cjs/Texture.d.ts +58 -58
  190. package/lib/cjs/Texture.js +82 -82
  191. package/lib/cjs/Texture.js.map +1 -1
  192. package/lib/cjs/TileStorage.d.ts +44 -18
  193. package/lib/cjs/TileStorage.d.ts.map +1 -1
  194. package/lib/cjs/TileStorage.js +109 -90
  195. package/lib/cjs/TileStorage.js.map +1 -1
  196. package/lib/cjs/TxnManager.d.ts +202 -202
  197. package/lib/cjs/TxnManager.d.ts.map +1 -1
  198. package/lib/cjs/TxnManager.js +356 -356
  199. package/lib/cjs/TxnManager.js.map +1 -1
  200. package/lib/cjs/ViewDefinition.d.ts +429 -439
  201. package/lib/cjs/ViewDefinition.d.ts.map +1 -1
  202. package/lib/cjs/ViewDefinition.js +640 -646
  203. package/lib/cjs/ViewDefinition.js.map +1 -1
  204. package/lib/cjs/ViewStateHydrator.d.ts +13 -13
  205. package/lib/cjs/ViewStateHydrator.js +103 -103
  206. package/lib/cjs/core-backend.d.ts +181 -184
  207. package/lib/cjs/core-backend.d.ts.map +1 -1
  208. package/lib/cjs/core-backend.js +205 -204
  209. package/lib/cjs/core-backend.js.map +1 -1
  210. package/lib/cjs/domains/FunctionalElements.d.ts +101 -101
  211. package/lib/cjs/domains/FunctionalElements.js +145 -145
  212. package/lib/cjs/domains/FunctionalElements.js.map +1 -1
  213. package/lib/cjs/domains/FunctionalSchema.d.ts +13 -13
  214. package/lib/cjs/domains/FunctionalSchema.d.ts.map +1 -1
  215. package/lib/cjs/domains/FunctionalSchema.js +39 -40
  216. package/lib/cjs/domains/FunctionalSchema.js.map +1 -1
  217. package/lib/cjs/domains/GenericElements.d.ts +177 -177
  218. package/lib/cjs/domains/GenericElements.js +263 -263
  219. package/lib/cjs/domains/GenericSchema.d.ts +10 -10
  220. package/lib/cjs/domains/GenericSchema.js +28 -28
  221. package/lib/cjs/rpc/multipart.d.ts +11 -11
  222. package/lib/cjs/rpc/multipart.js +71 -71
  223. package/lib/cjs/rpc/tracing.d.ts +28 -28
  224. package/lib/cjs/rpc/tracing.js +73 -74
  225. package/lib/cjs/rpc/tracing.js.map +1 -1
  226. package/lib/cjs/rpc/web/logging.d.ts +9 -9
  227. package/lib/cjs/rpc/web/logging.js +43 -43
  228. package/lib/cjs/rpc/web/request.d.ts +6 -6
  229. package/lib/cjs/rpc/web/request.js +73 -74
  230. package/lib/cjs/rpc/web/request.js.map +1 -1
  231. package/lib/cjs/rpc/web/response.d.ts +6 -6
  232. package/lib/cjs/rpc/web/response.js +105 -106
  233. package/lib/cjs/rpc/web/response.js.map +1 -1
  234. package/lib/cjs/rpc-impl/DevToolsRpcImpl.d.ts +15 -15
  235. package/lib/cjs/rpc-impl/DevToolsRpcImpl.js +32 -32
  236. package/lib/cjs/rpc-impl/IModelReadRpcImpl.d.ts +47 -47
  237. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js +293 -294
  238. package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map +1 -1
  239. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts +20 -22
  240. package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts.map +1 -1
  241. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js +193 -205
  242. package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map +1 -1
  243. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts +36 -36
  244. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js +166 -168
  245. package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map +1 -1
  246. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts +16 -16
  247. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js +42 -43
  248. package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map +1 -1
  249. package/lib/cjs/rpc-impl/WipRpcImpl.d.ts +15 -15
  250. package/lib/cjs/rpc-impl/WipRpcImpl.js +37 -37
  251. package/lib/cjs/workspace/Settings.d.ts +186 -186
  252. package/lib/cjs/workspace/Settings.d.ts.map +1 -1
  253. package/lib/cjs/workspace/Settings.js +155 -155
  254. package/lib/cjs/workspace/Settings.js.map +1 -1
  255. package/lib/cjs/workspace/SettingsSchemas.d.ts +75 -75
  256. package/lib/cjs/workspace/SettingsSchemas.js +190 -191
  257. package/lib/cjs/workspace/SettingsSchemas.js.map +1 -1
  258. package/lib/cjs/workspace/Workspace.d.ts +411 -414
  259. package/lib/cjs/workspace/Workspace.d.ts.map +1 -1
  260. package/lib/cjs/workspace/Workspace.js +521 -543
  261. package/lib/cjs/workspace/Workspace.js.map +1 -1
  262. package/package.json +25 -28
  263. package/lib/cjs/AliCloudStorageService.d.ts +0 -24
  264. package/lib/cjs/AliCloudStorageService.d.ts.map +0 -1
  265. package/lib/cjs/AliCloudStorageService.js +0 -72
  266. package/lib/cjs/AliCloudStorageService.js.map +0 -1
  267. package/lib/cjs/CloudStorageBackend.d.ts +0 -59
  268. package/lib/cjs/CloudStorageBackend.d.ts.map +0 -1
  269. package/lib/cjs/CloudStorageBackend.js +0 -174
  270. package/lib/cjs/CloudStorageBackend.js.map +0 -1
@@ -1,296 +1,296 @@
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 Symbology
8
- */
9
- Object.defineProperty(exports, "__esModule", { value: true });
10
- exports.LineStyleDefinition = void 0;
11
- const core_bentley_1 = require("@itwin/core-bentley");
12
- const core_common_1 = require("@itwin/core-common");
13
- const Element_1 = require("./Element");
14
- /** A line style definition is a uniquely named pattern that repeats as it is displayed along a curve path. In the absence of a line style, curve display is limited to solid lines with a width in pixels.
15
- * There are three varieties of line styles:
16
- * - A style described by a stroke pattern (series of dashes and gaps) that may also include symbol graphics.
17
- * - A style using pre-defined pixel bit patterns [[LinePixels]] for dashed display (Code1-Code7).
18
- * - A style that uses a texture.
19
- *
20
- * A definition is defined by one or more components. A component is saved as a "file property" and can be referenced by other components. The line style definition references a component
21
- * by file property id and type and is saved as a dictionary element.
22
- * @public
23
- */
24
- var LineStyleDefinition;
25
- (function (LineStyleDefinition) {
26
- /** Line style component type identifiers */
27
- let ComponentType;
28
- (function (ComponentType) {
29
- /** Component type for [[LineStyleDefinition.PointSymbolProps]] */
30
- ComponentType[ComponentType["PointSymbol"] = 1] = "PointSymbol";
31
- /** Component type for [[LineStyleDefinition.CompoundProps]] */
32
- ComponentType[ComponentType["Compound"] = 2] = "Compound";
33
- /** Component type for [[LineStyleDefinition.StrokePatternProps]] */
34
- ComponentType[ComponentType["StrokePattern"] = 3] = "StrokePattern";
35
- /** Component type for [[LineStyleDefinition.StrokePointProps]] */
36
- ComponentType[ComponentType["StrokePoint"] = 4] = "StrokePoint";
37
- /** Component type for [[LinePixels]], never saved as a file property */
38
- ComponentType[ComponentType["Internal"] = 6] = "Internal";
39
- /** Component type for [[LineStyleDefinition.RasterImageProps]] */
40
- ComponentType[ComponentType["RasterImage"] = 7] = "RasterImage";
41
- })(ComponentType = LineStyleDefinition.ComponentType || (LineStyleDefinition.ComponentType = {}));
42
- /** Mask of values for StrokeMode */
43
- let StrokeMode;
44
- (function (StrokeMode) {
45
- /** Stroke represents a blank space */
46
- StrokeMode[StrokeMode["Gap"] = 0] = "Gap";
47
- /** Stroke represents a solid dash */
48
- StrokeMode[StrokeMode["Dash"] = 1] = "Dash";
49
- /** Treat stroke as rigid and continue past a corner to complete the stroke as opposed to breaking at the corner */
50
- StrokeMode[StrokeMode["Ray"] = 2] = "Ray";
51
- /** Stroke length can be stretched when [[LineStyleDefinition.StrokePatternOptions.Iteration]] and [[LineStyleDefinition.StrokePatternOptions.AutoPhase]] options are set, applicable to both Gap and Dash strokes */
52
- StrokeMode[StrokeMode["Scale"] = 4] = "Scale";
53
- /** Invert stroke in first stroke pattern */
54
- StrokeMode[StrokeMode["FirstInvert"] = 8] = "FirstInvert";
55
- /** Invert stroke in last stroke pattern */
56
- StrokeMode[StrokeMode["LastInvert"] = 16] = "LastInvert";
57
- })(StrokeMode = LineStyleDefinition.StrokeMode || (LineStyleDefinition.StrokeMode = {}));
58
- /** Define constant width or tapered strokes with distance specified in meters */
59
- let StrokeWidth;
60
- (function (StrokeWidth) {
61
- /** Stroke draws as one pixel wide line */
62
- StrokeWidth[StrokeWidth["None"] = 0] = "None";
63
- /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to left side of stroke */
64
- StrokeWidth[StrokeWidth["Left"] = 1] = "Left";
65
- /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to right side of stroke */
66
- StrokeWidth[StrokeWidth["Right"] = 2] = "Right";
67
- /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to both sides of stroke */
68
- StrokeWidth[StrokeWidth["Full"] = 3] = "Full";
69
- })(StrokeWidth = LineStyleDefinition.StrokeWidth || (LineStyleDefinition.StrokeWidth = {}));
70
- /** Controls appearance of stroke end caps. If StrokeCap is >= Hexagon, the end cap is stroked as an arc and the value of
71
- * StrokeCap indicates the number of vectors in the arc.
72
- */
73
- let StrokeCap;
74
- (function (StrokeCap) {
75
- /** Stroke displays as a closed polygon */
76
- StrokeCap[StrokeCap["Closed"] = 0] = "Closed";
77
- /** Stroke displays lines at specified width instead of a polygon */
78
- StrokeCap[StrokeCap["Open"] = 1] = "Open";
79
- /** Stroke length extended by half the stroke width */
80
- StrokeCap[StrokeCap["Extended"] = 2] = "Extended";
81
- /** Stroke end cap is a hexagon */
82
- StrokeCap[StrokeCap["Hexagon"] = 3] = "Hexagon";
83
- /** Stroke end cap is an octagon */
84
- StrokeCap[StrokeCap["Octagon"] = 4] = "Octagon";
85
- /** Stroke end cap is a decagon */
86
- StrokeCap[StrokeCap["Decagon"] = 5] = "Decagon";
87
- /** Stroke end cap is an arc */
88
- StrokeCap[StrokeCap["Arc"] = 30] = "Arc";
89
- })(StrokeCap = LineStyleDefinition.StrokeCap || (LineStyleDefinition.StrokeCap = {}));
90
- /** Options to control how stroke pattern is applied to underlying curve */
91
- let StrokePatternOptions;
92
- (function (StrokePatternOptions) {
93
- /** Use default stroke behavior */
94
- StrokePatternOptions[StrokePatternOptions["None"] = 0] = "None";
95
- /** [[LineStyleDefinition.StrokePatternProps.phase]] represents fractional distance into first stroke of pattern */
96
- StrokePatternOptions[StrokePatternOptions["AutoPhase"] = 1] = "AutoPhase";
97
- /** Use [[LineStyleDefinition.StrokePatternProps.maxIter]] to limit the number of iterations of the stroke pattern */
98
- StrokePatternOptions[StrokePatternOptions["Iteration"] = 8] = "Iteration";
99
- /** Single segment mode restarts the stroke pattern at corners instead of continuing around corners */
100
- StrokePatternOptions[StrokePatternOptions["Segment"] = 16] = "Segment";
101
- /** Center the line style and stretch the ends */
102
- StrokePatternOptions[StrokePatternOptions["CenterStretch"] = 32] = "CenterStretch";
103
- })(StrokePatternOptions = LineStyleDefinition.StrokePatternOptions || (LineStyleDefinition.StrokePatternOptions = {}));
104
- /** Flags to identify point symbol behavior */
105
- let PointSymbolFlags;
106
- (function (PointSymbolFlags) {
107
- /** Default symbol behavior */
108
- PointSymbolFlags[PointSymbolFlags["None"] = 0] = "None";
109
- /** Symbol includes 3d geometry */
110
- PointSymbolFlags[PointSymbolFlags["Is3d"] = 1] = "Is3d";
111
- /** Symbol does not allow scaling */
112
- PointSymbolFlags[PointSymbolFlags["NoScale"] = 2] = "NoScale";
113
- })(PointSymbolFlags = LineStyleDefinition.PointSymbolFlags || (LineStyleDefinition.PointSymbolFlags = {}));
114
- /** Symbol options for location, orientation, and behavior */
115
- let SymbolOptions;
116
- (function (SymbolOptions) {
117
- /** No point symbol */
118
- SymbolOptions[SymbolOptions["None"] = 0] = "None";
119
- /** Symbol at origin of stroke */
120
- SymbolOptions[SymbolOptions["Origin"] = 1] = "Origin";
121
- /** Symbol at end of stroke */
122
- SymbolOptions[SymbolOptions["End"] = 2] = "End";
123
- /** symbol at center of stroke */
124
- SymbolOptions[SymbolOptions["Center"] = 3] = "Center";
125
- /** Symbol at curve start point */
126
- SymbolOptions[SymbolOptions["CurveOrigin"] = 4] = "CurveOrigin";
127
- /** Symbol at curve end point */
128
- SymbolOptions[SymbolOptions["CurveEnd"] = 8] = "CurveEnd";
129
- /** Symbol at each vertex */
130
- SymbolOptions[SymbolOptions["CurveVertex"] = 16] = "CurveVertex";
131
- /** Adjust symbol rotation left->right */
132
- SymbolOptions[SymbolOptions["AdjustRotation"] = 32] = "AdjustRotation";
133
- /** Angle of symbol not relative to stroke direction */
134
- SymbolOptions[SymbolOptions["AbsoluteRotation"] = 64] = "AbsoluteRotation";
135
- /** No scale on variable strokes */
136
- SymbolOptions[SymbolOptions["NoScale"] = 256] = "NoScale";
137
- /** No clip on partial strokes */
138
- SymbolOptions[SymbolOptions["NoClip"] = 512] = "NoClip";
139
- /** No partial strokes */
140
- SymbolOptions[SymbolOptions["NoPartial"] = 1024] = "NoPartial";
141
- /** Project partial origin */
142
- SymbolOptions[SymbolOptions["ProjectOrigin"] = 2048] = "ProjectOrigin";
143
- /** Use color from symbol instead of inheriting curve color */
144
- SymbolOptions[SymbolOptions["UseColor"] = 16384] = "UseColor";
145
- /** Use weight from symbol instead of inheriting curve weight */
146
- SymbolOptions[SymbolOptions["UseWeight"] = 32768] = "UseWeight";
147
- })(SymbolOptions = LineStyleDefinition.SymbolOptions || (LineStyleDefinition.SymbolOptions = {}));
148
- /** Flags to describe a style or control style behavior */
149
- let StyleFlags;
150
- (function (StyleFlags) {
151
- /** Use defaults */
152
- StyleFlags[StyleFlags["None"] = 0] = "None";
153
- /** Only snap to center line and not individual strokes and symbols of line style */
154
- StyleFlags[StyleFlags["NoSnap"] = 4] = "NoSnap";
155
- /** Style represents a continuous line with width (determined by looking at components if not set) */
156
- StyleFlags[StyleFlags["Continuous"] = 8] = "Continuous";
157
- /** Style represents physical geometry and should be scaled as such */
158
- StyleFlags[StyleFlags["Physical"] = 128] = "Physical";
159
- })(StyleFlags = LineStyleDefinition.StyleFlags || (LineStyleDefinition.StyleFlags = {}));
160
- /** Helper methods for creating and querying line styles */
161
- class Utils {
162
- /** Create a file property for a new stroke pattern component. */
163
- static createStrokePatternComponent(iModel, props) {
164
- const fileProps = { name: "LineCodeV1", namespace: "dgn_LStyle" };
165
- fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);
166
- iModel.saveFileProperty(fileProps, JSON.stringify(props));
167
- return { compId: fileProps.id, compType: ComponentType.StrokePattern };
168
- }
169
- /** Create a file property for a new point symbol component.
170
- * If base and size parameters are not supplied, queries GeometryPart by id to set them.
171
- */
172
- static createPointSymbolComponent(iModel, props) {
173
- // if part extents weren't supplied, set them up now.
174
- if (!props.baseX && !props.baseY && !props.baseZ && !props.sizeX && !props.sizeY && !props.sizeZ) {
175
- const geomPart = iModel.elements.getElement(props.geomPartId);
176
- if (!geomPart)
177
- return undefined;
178
- props.baseX = geomPart.bbox.low.x;
179
- props.baseY = geomPart.bbox.low.y;
180
- props.baseZ = geomPart.bbox.low.z;
181
- props.sizeX = geomPart.bbox.high.x;
182
- props.sizeY = geomPart.bbox.high.y;
183
- props.sizeZ = geomPart.bbox.high.z;
184
- }
185
- const fileProps = { name: "PointSymV1", namespace: "dgn_LStyle" };
186
- fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);
187
- iModel.saveFileProperty(fileProps, JSON.stringify(props));
188
- return { compId: fileProps.id, compType: ComponentType.PointSymbol };
189
- }
190
- /** Create a file property for a new stroke point component. */
191
- static createStrokePointComponent(iModel, props) {
192
- const fileProps = { name: "LinePointV1", namespace: "dgn_LStyle" };
193
- fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);
194
- iModel.saveFileProperty(fileProps, JSON.stringify(props));
195
- return { compId: fileProps.id, compType: ComponentType.StrokePoint };
196
- }
197
- /** Create a file property for a new compound component. */
198
- static createCompoundComponent(iModel, props) {
199
- const fileProps = { name: "CompoundV1", namespace: "dgn_LStyle" };
200
- fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);
201
- iModel.saveFileProperty(fileProps, JSON.stringify(props));
202
- return { compId: fileProps.id, compType: ComponentType.Compound };
203
- }
204
- /** Create a file property for a new raster image component. */
205
- static createRasterComponent(iModel, props, image) {
206
- const rasterFileProps = { name: "RasterImageV1", namespace: "dgn_LStyle" };
207
- rasterFileProps.id = iModel.queryNextAvailableFileProperty(rasterFileProps);
208
- iModel.saveFileProperty(rasterFileProps, undefined, image);
209
- props.imageId = rasterFileProps.id;
210
- const fileProps = { name: "RasterComponentV1", namespace: "dgn_LStyle" };
211
- fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);
212
- iModel.saveFileProperty(fileProps, JSON.stringify(props));
213
- return { compId: fileProps.id, compType: ComponentType.RasterImage };
214
- }
215
- /** Query for an existing line style with the supplied name. */
216
- static queryStyle(imodel, scopeModelId, name) {
217
- return imodel.elements.queryElementIdByCode(Element_1.LineStyle.createCode(imodel, scopeModelId, name));
218
- }
219
- /** Insert a new line style with the supplied name.
220
- * @throws [[IModelError]] if unable to insert the line style definition element.
221
- */
222
- static createStyle(imodel, scopeModelId, name, props) {
223
- if (undefined === props.flags)
224
- props.flags = StyleFlags.NoSnap; // If flags weren't supplied, default to not snapping to stroke geometry.
225
- const lsProps = {
226
- classFullName: "BisCore:LineStyle",
227
- model: scopeModelId,
228
- code: Element_1.LineStyle.createCode(imodel, scopeModelId, name),
229
- data: JSON.stringify(props),
230
- };
231
- return imodel.elements.insertElement(lsProps);
232
- }
233
- /** Query for a continuous line style that can be used to create curves with physical width instead of weight in pixels and create one if it does not already exist.
234
- * There are 2 ways to define a continuous line style:
235
- * - Width is not specified in the style itself and instead will be supplied as an override for each curve that is drawn.
236
- * - Defined using [[LineStyleDefinition.ComponentType.Internal]] with component id 0 [[LinePixels.Solid]] which has special behavior of being affected by width overrides.
237
- * - Width is specified in the style.
238
- * - Defined using a single stroke component that is a long dash.
239
- *
240
- * @throws [[IModelError]] if unable to insert the line style definition element.
241
- */
242
- static getOrCreateContinuousStyle(imodel, scopeModelId, width) {
243
- if (width === undefined) {
244
- const name0 = "Continuous";
245
- const lsId0 = this.queryStyle(imodel, scopeModelId, name0);
246
- return (undefined === lsId0 ? this.createStyle(imodel, scopeModelId, name0, { compId: 0, compType: ComponentType.Internal, flags: StyleFlags.Continuous | StyleFlags.NoSnap }) : lsId0);
247
- }
248
- const name = `Continuous-${width}`;
249
- const lsId = this.queryStyle(imodel, scopeModelId, name);
250
- if (undefined !== lsId)
251
- return lsId;
252
- const strokePatternData = this.createStrokePatternComponent(imodel, { descr: name, strokes: [{ length: 1e37, orgWidth: width, strokeMode: StrokeMode.Dash, widthMode: StrokeWidth.Full }] });
253
- if (undefined === strokePatternData)
254
- throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, "Unable to insert stroke component");
255
- return this.createStyle(imodel, scopeModelId, name, { compId: strokePatternData.compId, compType: strokePatternData.compType, flags: StyleFlags.Continuous | StyleFlags.NoSnap });
256
- }
257
- /** Query for a line style using the supplied [[LinePixels]] value (Code1-Code7) and create one if it does not already exist.
258
- * Most applications should instead use [[createStrokePatternComponent]] to define a style with physical dash and gap lengths.
259
- * Unlike other components, [[LineStyleDefinition.ComponentType.Internal]] uses the line code as the compId instead of a file property id.
260
- * @throws [[IModelError]] if supplied an invalid [[LinePixels]] value or if unable to insert the line style definition element.
261
- */
262
- static getOrCreateLinePixelsStyle(imodel, scopeModelId, linePixels) {
263
- let lineCode;
264
- switch (linePixels) {
265
- case core_common_1.LinePixels.Code1:
266
- lineCode = 1;
267
- break;
268
- case core_common_1.LinePixels.Code2:
269
- lineCode = 2;
270
- break;
271
- case core_common_1.LinePixels.Code3:
272
- lineCode = 3;
273
- break;
274
- case core_common_1.LinePixels.Code4:
275
- lineCode = 4;
276
- break;
277
- case core_common_1.LinePixels.Code5:
278
- lineCode = 5;
279
- break;
280
- case core_common_1.LinePixels.Code6:
281
- lineCode = 6;
282
- break;
283
- case core_common_1.LinePixels.Code7:
284
- lineCode = 7;
285
- break;
286
- default:
287
- throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, "Invalid LinePixels");
288
- }
289
- const name = `LinePixelsCodeNumber-${lineCode}`;
290
- const lsId = this.queryStyle(imodel, scopeModelId, name);
291
- return (undefined === lsId ? this.createStyle(imodel, scopeModelId, name, { compId: lineCode, compType: ComponentType.Internal }) : lsId);
292
- }
293
- }
294
- LineStyleDefinition.Utils = Utils;
295
- })(LineStyleDefinition = exports.LineStyleDefinition || (exports.LineStyleDefinition = {}));
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 Symbology
8
+ */
9
+ Object.defineProperty(exports, "__esModule", { value: true });
10
+ exports.LineStyleDefinition = void 0;
11
+ const core_bentley_1 = require("@itwin/core-bentley");
12
+ const core_common_1 = require("@itwin/core-common");
13
+ const Element_1 = require("./Element");
14
+ /** A line style definition is a uniquely named pattern that repeats as it is displayed along a curve path. In the absence of a line style, curve display is limited to solid lines with a width in pixels.
15
+ * There are three varieties of line styles:
16
+ * - A style described by a stroke pattern (series of dashes and gaps) that may also include symbol graphics.
17
+ * - A style using pre-defined pixel bit patterns [[LinePixels]] for dashed display (Code1-Code7).
18
+ * - A style that uses a texture.
19
+ *
20
+ * A definition is defined by one or more components. A component is saved as a "file property" and can be referenced by other components. The line style definition references a component
21
+ * by file property id and type and is saved as a dictionary element.
22
+ * @public
23
+ */
24
+ var LineStyleDefinition;
25
+ (function (LineStyleDefinition) {
26
+ /** Line style component type identifiers */
27
+ let ComponentType;
28
+ (function (ComponentType) {
29
+ /** Component type for [[LineStyleDefinition.PointSymbolProps]] */
30
+ ComponentType[ComponentType["PointSymbol"] = 1] = "PointSymbol";
31
+ /** Component type for [[LineStyleDefinition.CompoundProps]] */
32
+ ComponentType[ComponentType["Compound"] = 2] = "Compound";
33
+ /** Component type for [[LineStyleDefinition.StrokePatternProps]] */
34
+ ComponentType[ComponentType["StrokePattern"] = 3] = "StrokePattern";
35
+ /** Component type for [[LineStyleDefinition.StrokePointProps]] */
36
+ ComponentType[ComponentType["StrokePoint"] = 4] = "StrokePoint";
37
+ /** Component type for [[LinePixels]], never saved as a file property */
38
+ ComponentType[ComponentType["Internal"] = 6] = "Internal";
39
+ /** Component type for [[LineStyleDefinition.RasterImageProps]] */
40
+ ComponentType[ComponentType["RasterImage"] = 7] = "RasterImage";
41
+ })(ComponentType = LineStyleDefinition.ComponentType || (LineStyleDefinition.ComponentType = {}));
42
+ /** Mask of values for StrokeMode */
43
+ let StrokeMode;
44
+ (function (StrokeMode) {
45
+ /** Stroke represents a blank space */
46
+ StrokeMode[StrokeMode["Gap"] = 0] = "Gap";
47
+ /** Stroke represents a solid dash */
48
+ StrokeMode[StrokeMode["Dash"] = 1] = "Dash";
49
+ /** Treat stroke as rigid and continue past a corner to complete the stroke as opposed to breaking at the corner */
50
+ StrokeMode[StrokeMode["Ray"] = 2] = "Ray";
51
+ /** Stroke length can be stretched when [[LineStyleDefinition.StrokePatternOptions.Iteration]] and [[LineStyleDefinition.StrokePatternOptions.AutoPhase]] options are set, applicable to both Gap and Dash strokes */
52
+ StrokeMode[StrokeMode["Scale"] = 4] = "Scale";
53
+ /** Invert stroke in first stroke pattern */
54
+ StrokeMode[StrokeMode["FirstInvert"] = 8] = "FirstInvert";
55
+ /** Invert stroke in last stroke pattern */
56
+ StrokeMode[StrokeMode["LastInvert"] = 16] = "LastInvert";
57
+ })(StrokeMode = LineStyleDefinition.StrokeMode || (LineStyleDefinition.StrokeMode = {}));
58
+ /** Define constant width or tapered strokes with distance specified in meters */
59
+ let StrokeWidth;
60
+ (function (StrokeWidth) {
61
+ /** Stroke draws as one pixel wide line */
62
+ StrokeWidth[StrokeWidth["None"] = 0] = "None";
63
+ /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to left side of stroke */
64
+ StrokeWidth[StrokeWidth["Left"] = 1] = "Left";
65
+ /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to right side of stroke */
66
+ StrokeWidth[StrokeWidth["Right"] = 2] = "Right";
67
+ /** Half [[LineStyleDefinition.StrokeProps.orgWidth]] and [[LineStyleDefinition.StrokeProps.endWidth]] applied to both sides of stroke */
68
+ StrokeWidth[StrokeWidth["Full"] = 3] = "Full";
69
+ })(StrokeWidth = LineStyleDefinition.StrokeWidth || (LineStyleDefinition.StrokeWidth = {}));
70
+ /** Controls appearance of stroke end caps. If StrokeCap is >= Hexagon, the end cap is stroked as an arc and the value of
71
+ * StrokeCap indicates the number of vectors in the arc.
72
+ */
73
+ let StrokeCap;
74
+ (function (StrokeCap) {
75
+ /** Stroke displays as a closed polygon */
76
+ StrokeCap[StrokeCap["Closed"] = 0] = "Closed";
77
+ /** Stroke displays lines at specified width instead of a polygon */
78
+ StrokeCap[StrokeCap["Open"] = 1] = "Open";
79
+ /** Stroke length extended by half the stroke width */
80
+ StrokeCap[StrokeCap["Extended"] = 2] = "Extended";
81
+ /** Stroke end cap is a hexagon */
82
+ StrokeCap[StrokeCap["Hexagon"] = 3] = "Hexagon";
83
+ /** Stroke end cap is an octagon */
84
+ StrokeCap[StrokeCap["Octagon"] = 4] = "Octagon";
85
+ /** Stroke end cap is a decagon */
86
+ StrokeCap[StrokeCap["Decagon"] = 5] = "Decagon";
87
+ /** Stroke end cap is an arc */
88
+ StrokeCap[StrokeCap["Arc"] = 30] = "Arc";
89
+ })(StrokeCap = LineStyleDefinition.StrokeCap || (LineStyleDefinition.StrokeCap = {}));
90
+ /** Options to control how stroke pattern is applied to underlying curve */
91
+ let StrokePatternOptions;
92
+ (function (StrokePatternOptions) {
93
+ /** Use default stroke behavior */
94
+ StrokePatternOptions[StrokePatternOptions["None"] = 0] = "None";
95
+ /** [[LineStyleDefinition.StrokePatternProps.phase]] represents fractional distance into first stroke of pattern */
96
+ StrokePatternOptions[StrokePatternOptions["AutoPhase"] = 1] = "AutoPhase";
97
+ /** Use [[LineStyleDefinition.StrokePatternProps.maxIter]] to limit the number of iterations of the stroke pattern */
98
+ StrokePatternOptions[StrokePatternOptions["Iteration"] = 8] = "Iteration";
99
+ /** Single segment mode restarts the stroke pattern at corners instead of continuing around corners */
100
+ StrokePatternOptions[StrokePatternOptions["Segment"] = 16] = "Segment";
101
+ /** Center the line style and stretch the ends */
102
+ StrokePatternOptions[StrokePatternOptions["CenterStretch"] = 32] = "CenterStretch";
103
+ })(StrokePatternOptions = LineStyleDefinition.StrokePatternOptions || (LineStyleDefinition.StrokePatternOptions = {}));
104
+ /** Flags to identify point symbol behavior */
105
+ let PointSymbolFlags;
106
+ (function (PointSymbolFlags) {
107
+ /** Default symbol behavior */
108
+ PointSymbolFlags[PointSymbolFlags["None"] = 0] = "None";
109
+ /** Symbol includes 3d geometry */
110
+ PointSymbolFlags[PointSymbolFlags["Is3d"] = 1] = "Is3d";
111
+ /** Symbol does not allow scaling */
112
+ PointSymbolFlags[PointSymbolFlags["NoScale"] = 2] = "NoScale";
113
+ })(PointSymbolFlags = LineStyleDefinition.PointSymbolFlags || (LineStyleDefinition.PointSymbolFlags = {}));
114
+ /** Symbol options for location, orientation, and behavior */
115
+ let SymbolOptions;
116
+ (function (SymbolOptions) {
117
+ /** No point symbol */
118
+ SymbolOptions[SymbolOptions["None"] = 0] = "None";
119
+ /** Symbol at origin of stroke */
120
+ SymbolOptions[SymbolOptions["Origin"] = 1] = "Origin";
121
+ /** Symbol at end of stroke */
122
+ SymbolOptions[SymbolOptions["End"] = 2] = "End";
123
+ /** symbol at center of stroke */
124
+ SymbolOptions[SymbolOptions["Center"] = 3] = "Center";
125
+ /** Symbol at curve start point */
126
+ SymbolOptions[SymbolOptions["CurveOrigin"] = 4] = "CurveOrigin";
127
+ /** Symbol at curve end point */
128
+ SymbolOptions[SymbolOptions["CurveEnd"] = 8] = "CurveEnd";
129
+ /** Symbol at each vertex */
130
+ SymbolOptions[SymbolOptions["CurveVertex"] = 16] = "CurveVertex";
131
+ /** Adjust symbol rotation left->right */
132
+ SymbolOptions[SymbolOptions["AdjustRotation"] = 32] = "AdjustRotation";
133
+ /** Angle of symbol not relative to stroke direction */
134
+ SymbolOptions[SymbolOptions["AbsoluteRotation"] = 64] = "AbsoluteRotation";
135
+ /** No scale on variable strokes */
136
+ SymbolOptions[SymbolOptions["NoScale"] = 256] = "NoScale";
137
+ /** No clip on partial strokes */
138
+ SymbolOptions[SymbolOptions["NoClip"] = 512] = "NoClip";
139
+ /** No partial strokes */
140
+ SymbolOptions[SymbolOptions["NoPartial"] = 1024] = "NoPartial";
141
+ /** Project partial origin */
142
+ SymbolOptions[SymbolOptions["ProjectOrigin"] = 2048] = "ProjectOrigin";
143
+ /** Use color from symbol instead of inheriting curve color */
144
+ SymbolOptions[SymbolOptions["UseColor"] = 16384] = "UseColor";
145
+ /** Use weight from symbol instead of inheriting curve weight */
146
+ SymbolOptions[SymbolOptions["UseWeight"] = 32768] = "UseWeight";
147
+ })(SymbolOptions = LineStyleDefinition.SymbolOptions || (LineStyleDefinition.SymbolOptions = {}));
148
+ /** Flags to describe a style or control style behavior */
149
+ let StyleFlags;
150
+ (function (StyleFlags) {
151
+ /** Use defaults */
152
+ StyleFlags[StyleFlags["None"] = 0] = "None";
153
+ /** Only snap to center line and not individual strokes and symbols of line style */
154
+ StyleFlags[StyleFlags["NoSnap"] = 4] = "NoSnap";
155
+ /** Style represents a continuous line with width (determined by looking at components if not set) */
156
+ StyleFlags[StyleFlags["Continuous"] = 8] = "Continuous";
157
+ /** Style represents physical geometry and should be scaled as such */
158
+ StyleFlags[StyleFlags["Physical"] = 128] = "Physical";
159
+ })(StyleFlags = LineStyleDefinition.StyleFlags || (LineStyleDefinition.StyleFlags = {}));
160
+ /** Helper methods for creating and querying line styles */
161
+ class Utils {
162
+ /** Create a file property for a new stroke pattern component. */
163
+ static createStrokePatternComponent(iModel, props) {
164
+ const fileProps = { name: "LineCodeV1", namespace: "dgn_LStyle" };
165
+ fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);
166
+ iModel.saveFileProperty(fileProps, JSON.stringify(props));
167
+ return { compId: fileProps.id, compType: ComponentType.StrokePattern };
168
+ }
169
+ /** Create a file property for a new point symbol component.
170
+ * If base and size parameters are not supplied, queries GeometryPart by id to set them.
171
+ */
172
+ static createPointSymbolComponent(iModel, props) {
173
+ // if part extents weren't supplied, set them up now.
174
+ if (!props.baseX && !props.baseY && !props.baseZ && !props.sizeX && !props.sizeY && !props.sizeZ) {
175
+ const geomPart = iModel.elements.getElement(props.geomPartId);
176
+ if (!geomPart)
177
+ return undefined;
178
+ props.baseX = geomPart.bbox.low.x;
179
+ props.baseY = geomPart.bbox.low.y;
180
+ props.baseZ = geomPart.bbox.low.z;
181
+ props.sizeX = geomPart.bbox.high.x;
182
+ props.sizeY = geomPart.bbox.high.y;
183
+ props.sizeZ = geomPart.bbox.high.z;
184
+ }
185
+ const fileProps = { name: "PointSymV1", namespace: "dgn_LStyle" };
186
+ fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);
187
+ iModel.saveFileProperty(fileProps, JSON.stringify(props));
188
+ return { compId: fileProps.id, compType: ComponentType.PointSymbol };
189
+ }
190
+ /** Create a file property for a new stroke point component. */
191
+ static createStrokePointComponent(iModel, props) {
192
+ const fileProps = { name: "LinePointV1", namespace: "dgn_LStyle" };
193
+ fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);
194
+ iModel.saveFileProperty(fileProps, JSON.stringify(props));
195
+ return { compId: fileProps.id, compType: ComponentType.StrokePoint };
196
+ }
197
+ /** Create a file property for a new compound component. */
198
+ static createCompoundComponent(iModel, props) {
199
+ const fileProps = { name: "CompoundV1", namespace: "dgn_LStyle" };
200
+ fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);
201
+ iModel.saveFileProperty(fileProps, JSON.stringify(props));
202
+ return { compId: fileProps.id, compType: ComponentType.Compound };
203
+ }
204
+ /** Create a file property for a new raster image component. */
205
+ static createRasterComponent(iModel, props, image) {
206
+ const rasterFileProps = { name: "RasterImageV1", namespace: "dgn_LStyle" };
207
+ rasterFileProps.id = iModel.queryNextAvailableFileProperty(rasterFileProps);
208
+ iModel.saveFileProperty(rasterFileProps, undefined, image);
209
+ props.imageId = rasterFileProps.id;
210
+ const fileProps = { name: "RasterComponentV1", namespace: "dgn_LStyle" };
211
+ fileProps.id = iModel.queryNextAvailableFileProperty(fileProps);
212
+ iModel.saveFileProperty(fileProps, JSON.stringify(props));
213
+ return { compId: fileProps.id, compType: ComponentType.RasterImage };
214
+ }
215
+ /** Query for an existing line style with the supplied name. */
216
+ static queryStyle(imodel, scopeModelId, name) {
217
+ return imodel.elements.queryElementIdByCode(Element_1.LineStyle.createCode(imodel, scopeModelId, name));
218
+ }
219
+ /** Insert a new line style with the supplied name.
220
+ * @throws [[IModelError]] if unable to insert the line style definition element.
221
+ */
222
+ static createStyle(imodel, scopeModelId, name, props) {
223
+ if (undefined === props.flags)
224
+ props.flags = StyleFlags.NoSnap; // If flags weren't supplied, default to not snapping to stroke geometry.
225
+ const lsProps = {
226
+ classFullName: "BisCore:LineStyle",
227
+ model: scopeModelId,
228
+ code: Element_1.LineStyle.createCode(imodel, scopeModelId, name),
229
+ data: JSON.stringify(props),
230
+ };
231
+ return imodel.elements.insertElement(lsProps);
232
+ }
233
+ /** Query for a continuous line style that can be used to create curves with physical width instead of weight in pixels and create one if it does not already exist.
234
+ * There are 2 ways to define a continuous line style:
235
+ * - Width is not specified in the style itself and instead will be supplied as an override for each curve that is drawn.
236
+ * - Defined using [[LineStyleDefinition.ComponentType.Internal]] with component id 0 [[LinePixels.Solid]] which has special behavior of being affected by width overrides.
237
+ * - Width is specified in the style.
238
+ * - Defined using a single stroke component that is a long dash.
239
+ *
240
+ * @throws [[IModelError]] if unable to insert the line style definition element.
241
+ */
242
+ static getOrCreateContinuousStyle(imodel, scopeModelId, width) {
243
+ if (width === undefined) {
244
+ const name0 = "Continuous";
245
+ const lsId0 = this.queryStyle(imodel, scopeModelId, name0);
246
+ return (undefined === lsId0 ? this.createStyle(imodel, scopeModelId, name0, { compId: 0, compType: ComponentType.Internal, flags: StyleFlags.Continuous | StyleFlags.NoSnap }) : lsId0);
247
+ }
248
+ const name = `Continuous-${width}`;
249
+ const lsId = this.queryStyle(imodel, scopeModelId, name);
250
+ if (undefined !== lsId)
251
+ return lsId;
252
+ const strokePatternData = this.createStrokePatternComponent(imodel, { descr: name, strokes: [{ length: 1e37, orgWidth: width, strokeMode: StrokeMode.Dash, widthMode: StrokeWidth.Full }] });
253
+ if (undefined === strokePatternData)
254
+ throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, "Unable to insert stroke component");
255
+ return this.createStyle(imodel, scopeModelId, name, { compId: strokePatternData.compId, compType: strokePatternData.compType, flags: StyleFlags.Continuous | StyleFlags.NoSnap });
256
+ }
257
+ /** Query for a line style using the supplied [[LinePixels]] value (Code1-Code7) and create one if it does not already exist.
258
+ * Most applications should instead use [[createStrokePatternComponent]] to define a style with physical dash and gap lengths.
259
+ * Unlike other components, [[LineStyleDefinition.ComponentType.Internal]] uses the line code as the compId instead of a file property id.
260
+ * @throws [[IModelError]] if supplied an invalid [[LinePixels]] value or if unable to insert the line style definition element.
261
+ */
262
+ static getOrCreateLinePixelsStyle(imodel, scopeModelId, linePixels) {
263
+ let lineCode;
264
+ switch (linePixels) {
265
+ case core_common_1.LinePixels.Code1:
266
+ lineCode = 1;
267
+ break;
268
+ case core_common_1.LinePixels.Code2:
269
+ lineCode = 2;
270
+ break;
271
+ case core_common_1.LinePixels.Code3:
272
+ lineCode = 3;
273
+ break;
274
+ case core_common_1.LinePixels.Code4:
275
+ lineCode = 4;
276
+ break;
277
+ case core_common_1.LinePixels.Code5:
278
+ lineCode = 5;
279
+ break;
280
+ case core_common_1.LinePixels.Code6:
281
+ lineCode = 6;
282
+ break;
283
+ case core_common_1.LinePixels.Code7:
284
+ lineCode = 7;
285
+ break;
286
+ default:
287
+ throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadArg, "Invalid LinePixels");
288
+ }
289
+ const name = `LinePixelsCodeNumber-${lineCode}`;
290
+ const lsId = this.queryStyle(imodel, scopeModelId, name);
291
+ return (undefined === lsId ? this.createStyle(imodel, scopeModelId, name, { compId: lineCode, compType: ComponentType.Internal }) : lsId);
292
+ }
293
+ }
294
+ LineStyleDefinition.Utils = Utils;
295
+ })(LineStyleDefinition = exports.LineStyleDefinition || (exports.LineStyleDefinition = {}));
296
296
  //# sourceMappingURL=LineStyle.js.map