@inweb/client 25.2.2 → 25.2.8

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 (224) hide show
  1. package/LICENSE +20 -20
  2. package/README.md +70 -70
  3. package/dist/client.js +12369 -11952
  4. package/dist/client.js.map +1 -1
  5. package/dist/client.min.js +1 -1
  6. package/dist/client.module.js +714 -235
  7. package/dist/client.module.js.map +1 -1
  8. package/lib/Api/Assembly.d.ts +338 -338
  9. package/lib/Api/ClashTest.d.ts +175 -175
  10. package/lib/Api/Client.d.ts +451 -451
  11. package/lib/Api/ClientEvents.d.ts +28 -28
  12. package/lib/Api/File.d.ts +567 -567
  13. package/lib/Api/HttpClient.d.ts +12 -12
  14. package/lib/Api/IAssembly.d.ts +13 -13
  15. package/lib/Api/IFile.d.ts +45 -45
  16. package/lib/Api/IHttpClient.d.ts +10 -10
  17. package/lib/Api/IUser.d.ts +10 -10
  18. package/lib/Api/Job.d.ts +141 -141
  19. package/lib/Api/Member.d.ts +84 -84
  20. package/lib/Api/Model.d.ts +146 -146
  21. package/lib/Api/Permission.d.ts +92 -92
  22. package/lib/Api/Project.d.ts +246 -246
  23. package/lib/Api/Role.d.ts +81 -81
  24. package/lib/Api/User.d.ts +196 -196
  25. package/lib/Api/impl/FetchError.d.ts +17 -17
  26. package/lib/Api/impl/Utils.d.ts +32 -32
  27. package/lib/Api/impl/http.d.ts +66 -66
  28. package/lib/ConvetMath.d.ts +28 -28
  29. package/lib/Viewer/CanvasEvents.d.ts +1 -1
  30. package/lib/Viewer/Commands/ApplyModelTransform.d.ts +1 -1
  31. package/lib/Viewer/Commands/ClearMarkup.d.ts +1 -1
  32. package/lib/Viewer/Commands/ClearSlices.d.ts +1 -1
  33. package/lib/Viewer/Commands/CreatePreview.d.ts +1 -1
  34. package/lib/Viewer/Commands/Explode.d.ts +1 -1
  35. package/lib/Viewer/Commands/GetDefaultViewPositions.d.ts +1 -1
  36. package/lib/Viewer/Commands/GetModels.d.ts +1 -1
  37. package/lib/Viewer/Commands/GetSelected.d.ts +1 -1
  38. package/lib/Viewer/Commands/HideSelected.d.ts +1 -1
  39. package/lib/Viewer/Commands/IsolateSelected.d.ts +1 -1
  40. package/lib/Viewer/Commands/RegenerateAll.d.ts +1 -1
  41. package/lib/Viewer/Commands/ResetView.d.ts +1 -1
  42. package/lib/Viewer/Commands/SelectModel.d.ts +1 -1
  43. package/lib/Viewer/Commands/SetActiveDragger.d.ts +1 -1
  44. package/lib/Viewer/Commands/SetDefaultViewPosition.d.ts +1 -1
  45. package/lib/Viewer/Commands/SetMarkupColor.d.ts +1 -1
  46. package/lib/Viewer/Commands/SetSelected.d.ts +1 -1
  47. package/lib/Viewer/Commands/ShowAll.d.ts +1 -1
  48. package/lib/Viewer/Commands/Unselect.d.ts +1 -1
  49. package/lib/Viewer/Commands/ZoomToExtents.d.ts +1 -1
  50. package/lib/Viewer/Commands/ZoomToObjects.d.ts +1 -1
  51. package/lib/Viewer/Commands/ZoomToSelected.d.ts +1 -1
  52. package/lib/Viewer/Commands.d.ts +2 -2
  53. package/lib/Viewer/Draggers/Actions/OrbitAction.d.ts +21 -21
  54. package/lib/Viewer/Draggers/Actions/PanAction.d.ts +17 -17
  55. package/lib/Viewer/Draggers/Actions/ZoomAction.d.ts +7 -7
  56. package/lib/Viewer/Draggers/Common/Geometry.d.ts +114 -114
  57. package/lib/Viewer/Draggers/Common/GestureManager.d.ts +40 -40
  58. package/lib/Viewer/Draggers/Common/OdBaseDragger.d.ts +53 -53
  59. package/lib/Viewer/Draggers/Common/OdaGeAction.d.ts +29 -29
  60. package/lib/Viewer/Draggers/MeasureLineDragger/MeasureLineItem.d.ts +30 -30
  61. package/lib/Viewer/Draggers/MeasureLineDragger/MeasureUtils.d.ts +19 -19
  62. package/lib/Viewer/Draggers/MeasureLineDragger/index.d.ts +23 -23
  63. package/lib/Viewer/Draggers/OdBaseCuttingPlaneDragger.d.ts +26 -26
  64. package/lib/Viewer/Draggers/OdCuttingPlaneXAxisDragger.d.ts +7 -7
  65. package/lib/Viewer/Draggers/OdCuttingPlaneYAxisDragger.d.ts +7 -7
  66. package/lib/Viewer/Draggers/OdCuttingPlaneZAxisDragger.d.ts +7 -7
  67. package/lib/Viewer/Draggers/OdOrbitDragger.d.ts +14 -14
  68. package/lib/Viewer/Draggers/OdPanDragger.d.ts +11 -11
  69. package/lib/Viewer/Draggers/OdZoomDragger.d.ts +11 -11
  70. package/lib/Viewer/Draggers/OdZoomWheelDragger.d.ts +10 -10
  71. package/lib/Viewer/Draggers/OdZoomWindowDragger/OdSelectionFrame.d.ts +18 -18
  72. package/lib/Viewer/Draggers/OdZoomWindowDragger/index.d.ts +13 -13
  73. package/lib/Viewer/Draggers/OdaLineDragger.d.ts +14 -14
  74. package/lib/Viewer/Draggers/OdaTextDragger.d.ts +15 -15
  75. package/lib/Viewer/Draggers/OdaWalkDragger.d.ts +29 -29
  76. package/lib/Viewer/Draggers/OrbitAroundBuildingDragger.d.ts +18 -18
  77. package/lib/Viewer/EventEmitter2.d.ts +53 -53
  78. package/lib/Viewer/ICommands.d.ts +24 -24
  79. package/lib/Viewer/IEventEmitter2.d.ts +12 -12
  80. package/lib/Viewer/IViewer.d.ts +28 -26
  81. package/lib/Viewer/Loaders/BaseLoader.d.ts +10 -10
  82. package/lib/Viewer/Loaders/LoaderFactory.d.ts +10 -9
  83. package/lib/Viewer/Loaders/TCSLoader.d.ts +4 -4
  84. package/lib/Viewer/Loaders/UpdaterController.d.ts +14 -14
  85. package/lib/Viewer/Loaders/VsfXLoader.d.ts +4 -4
  86. package/lib/Viewer/Loaders/VsfXPartialLoader.d.ts +4 -4
  87. package/lib/Viewer/Loaders/VsfXStreamingLoader.d.ts +5 -0
  88. package/lib/Viewer/Markup/Api/IMarkupArrow.d.ts +21 -11
  89. package/lib/Viewer/Markup/Api/IMarkupCloud.d.ts +15 -0
  90. package/lib/Viewer/Markup/Api/IMarkupColorable.d.ts +4 -4
  91. package/lib/Viewer/Markup/Api/IMarkupEllipse.d.ts +14 -14
  92. package/lib/Viewer/Markup/Api/IMarkupImage.d.ts +14 -14
  93. package/lib/Viewer/Markup/Api/IMarkupLine.d.ts +18 -10
  94. package/lib/Viewer/Markup/Api/IMarkupObject.d.ts +11 -11
  95. package/lib/Viewer/Markup/Api/IMarkupRectangle.d.ts +14 -14
  96. package/lib/Viewer/Markup/Api/IMarkupText.d.ts +12 -12
  97. package/lib/Viewer/Markup/Api/Impl/Konva/KonvaArrow.d.ts +46 -31
  98. package/lib/Viewer/Markup/Api/Impl/Konva/KonvaCloud.d.ts +36 -0
  99. package/lib/Viewer/Markup/Api/Impl/Konva/KonvaEllipse.d.ts +40 -39
  100. package/lib/Viewer/Markup/Api/Impl/Konva/KonvaImage.d.ts +36 -35
  101. package/lib/Viewer/Markup/Api/Impl/Konva/KonvaLine.d.ts +35 -31
  102. package/lib/Viewer/Markup/Api/Impl/Konva/KonvaRectangle.d.ts +38 -37
  103. package/lib/Viewer/Markup/Api/Impl/Konva/KonvaText.d.ts +37 -36
  104. package/lib/Viewer/Markup/IMarkup.d.ts +38 -37
  105. package/lib/Viewer/Markup/Impl/Konva/KonvaMarkup.d.ts +71 -62
  106. package/lib/Viewer/Markup/Impl/Konva/MarkupColor.d.ts +18 -18
  107. package/lib/Viewer/Markup/Impl/Visualize/VisualizeMarkup.d.ts +33 -32
  108. package/lib/Viewer/Markup/MarkupFactory.d.ts +6 -6
  109. package/lib/Viewer/Options.d.ts +238 -227
  110. package/lib/Viewer/OptionsEvents.d.ts +25 -25
  111. package/lib/Viewer/Viewer.d.ts +358 -352
  112. package/lib/Viewer/ViewerCommands.d.ts +22 -22
  113. package/lib/Viewer/ViewerEvents.d.ts +600 -600
  114. package/lib/Viewer/utils.d.ts +3 -3
  115. package/lib/index.d.ts +23 -23
  116. package/package.json +38 -32
  117. package/src/Api/Assembly.ts +678 -678
  118. package/src/Api/ClashTest.ts +290 -290
  119. package/src/Api/Client.ts +816 -816
  120. package/src/Api/ClientEvents.ts +31 -31
  121. package/src/Api/File.ts +962 -962
  122. package/src/Api/HttpClient.ts +73 -73
  123. package/src/Api/IAssembly.ts +37 -37
  124. package/src/Api/IFile.ts +74 -74
  125. package/src/Api/IHttpClient.ts +50 -50
  126. package/src/Api/IUser.ts +33 -33
  127. package/src/Api/Job.ts +253 -253
  128. package/src/Api/Member.ts +161 -161
  129. package/src/Api/Model.ts +259 -259
  130. package/src/Api/Permission.ts +173 -173
  131. package/src/Api/Project.ts +479 -479
  132. package/src/Api/Role.ts +158 -158
  133. package/src/Api/User.ts +357 -357
  134. package/src/Api/impl/FetchError.ts +48 -48
  135. package/src/Api/impl/Utils.ts +367 -367
  136. package/src/Api/impl/http.ts +92 -92
  137. package/src/ConvetMath.ts +372 -372
  138. package/src/Viewer/CanvasEvents.ts +41 -41
  139. package/src/Viewer/Commands/ApplyModelTransform.ts +70 -70
  140. package/src/Viewer/Commands/ClearMarkup.ts +28 -28
  141. package/src/Viewer/Commands/ClearSlices.ts +27 -27
  142. package/src/Viewer/Commands/CreatePreview.ts +33 -33
  143. package/src/Viewer/Commands/Explode.ts +38 -38
  144. package/src/Viewer/Commands/GetDefaultViewPositions.ts +36 -36
  145. package/src/Viewer/Commands/GetModels.ts +43 -43
  146. package/src/Viewer/Commands/GetSelected.ts +58 -58
  147. package/src/Viewer/Commands/HideSelected.ts +37 -37
  148. package/src/Viewer/Commands/IsolateSelected.ts +37 -37
  149. package/src/Viewer/Commands/RegenerateAll.ts +37 -37
  150. package/src/Viewer/Commands/ResetView.ts +43 -43
  151. package/src/Viewer/Commands/SelectModel.ts +52 -52
  152. package/src/Viewer/Commands/SetActiveDragger.ts +29 -29
  153. package/src/Viewer/Commands/SetDefaultViewPosition.ts +50 -50
  154. package/src/Viewer/Commands/SetMarkupColor.ts +29 -29
  155. package/src/Viewer/Commands/SetSelected.ts +47 -47
  156. package/src/Viewer/Commands/ShowAll.ts +37 -37
  157. package/src/Viewer/Commands/Unselect.ts +37 -37
  158. package/src/Viewer/Commands/ZoomToExtents.ts +43 -43
  159. package/src/Viewer/Commands/ZoomToObjects.ts +47 -47
  160. package/src/Viewer/Commands/ZoomToSelected.ts +39 -39
  161. package/src/Viewer/Commands.ts +81 -81
  162. package/src/Viewer/Draggers/Actions/OrbitAction.ts +250 -250
  163. package/src/Viewer/Draggers/Actions/PanAction.ts +102 -102
  164. package/src/Viewer/Draggers/Actions/ZoomAction.ts +45 -45
  165. package/src/Viewer/Draggers/Common/Geometry.ts +152 -152
  166. package/src/Viewer/Draggers/Common/GestureManager.ts +263 -263
  167. package/src/Viewer/Draggers/Common/OdBaseDragger.ts +270 -270
  168. package/src/Viewer/Draggers/Common/OdaGeAction.ts +146 -146
  169. package/src/Viewer/Draggers/MeasureLineDragger/MeasureLineItem.ts +248 -248
  170. package/src/Viewer/Draggers/MeasureLineDragger/MeasureUtils.ts +182 -182
  171. package/src/Viewer/Draggers/MeasureLineDragger/index.ts +166 -166
  172. package/src/Viewer/Draggers/OdBaseCuttingPlaneDragger.ts +182 -182
  173. package/src/Viewer/Draggers/OdCuttingPlaneXAxisDragger.ts +53 -53
  174. package/src/Viewer/Draggers/OdCuttingPlaneYAxisDragger.ts +53 -53
  175. package/src/Viewer/Draggers/OdCuttingPlaneZAxisDragger.ts +53 -53
  176. package/src/Viewer/Draggers/OdOrbitDragger.ts +70 -70
  177. package/src/Viewer/Draggers/OdPanDragger.ts +62 -62
  178. package/src/Viewer/Draggers/OdZoomDragger.ts +59 -59
  179. package/src/Viewer/Draggers/OdZoomWheelDragger.ts +103 -103
  180. package/src/Viewer/Draggers/OdZoomWindowDragger/OdSelectionFrame.ts +123 -123
  181. package/src/Viewer/Draggers/OdZoomWindowDragger/index.ts +75 -75
  182. package/src/Viewer/Draggers/OdaLineDragger.ts +80 -80
  183. package/src/Viewer/Draggers/OdaTextDragger.ts +118 -118
  184. package/src/Viewer/Draggers/OdaWalkDragger.ts +278 -278
  185. package/src/Viewer/Draggers/OrbitAroundBuildingDragger.ts +184 -184
  186. package/src/Viewer/EventEmitter2.ts +116 -116
  187. package/src/Viewer/ICommands.ts +53 -53
  188. package/src/Viewer/IEventEmitter2.ts +36 -36
  189. package/src/Viewer/IViewer.ts +58 -55
  190. package/src/Viewer/Loaders/BaseLoader.ts +40 -40
  191. package/src/Viewer/Loaders/LoaderFactory.ts +47 -44
  192. package/src/Viewer/Loaders/TCSLoader.ts +82 -82
  193. package/src/Viewer/Loaders/UpdaterController.ts +36 -36
  194. package/src/Viewer/Loaders/VsfXLoader.ts +65 -87
  195. package/src/Viewer/Loaders/VsfXPartialLoader.ts +208 -208
  196. package/src/Viewer/Loaders/VsfXStreamingLoader.ts +87 -0
  197. package/src/Viewer/Markup/Api/IMarkupArrow.ts +12 -15
  198. package/src/Viewer/Markup/Api/IMarkupCloud.ts +15 -0
  199. package/src/Viewer/Markup/Api/IMarkupColorable.ts +4 -4
  200. package/src/Viewer/Markup/Api/IMarkupEllipse.ts +15 -15
  201. package/src/Viewer/Markup/Api/IMarkupImage.ts +15 -15
  202. package/src/Viewer/Markup/Api/IMarkupLine.ts +20 -10
  203. package/src/Viewer/Markup/Api/IMarkupObject.ts +15 -15
  204. package/src/Viewer/Markup/Api/IMarkupRectangle.ts +15 -15
  205. package/src/Viewer/Markup/Api/IMarkupText.ts +12 -12
  206. package/src/Viewer/Markup/Api/Impl/Konva/KonvaArrow.ts +117 -119
  207. package/src/Viewer/Markup/Api/Impl/Konva/KonvaCloud.ts +208 -0
  208. package/src/Viewer/Markup/Api/Impl/Konva/KonvaEllipse.ts +118 -113
  209. package/src/Viewer/Markup/Api/Impl/Konva/KonvaImage.ts +123 -121
  210. package/src/Viewer/Markup/Api/Impl/Konva/KonvaLine.ts +130 -99
  211. package/src/Viewer/Markup/Api/Impl/Konva/KonvaRectangle.ts +119 -113
  212. package/src/Viewer/Markup/Api/Impl/Konva/KonvaText.ts +110 -104
  213. package/src/Viewer/Markup/IMarkup.ts +40 -39
  214. package/src/Viewer/Markup/Impl/Konva/KonvaMarkup.ts +1144 -872
  215. package/src/Viewer/Markup/Impl/Konva/MarkupColor.ts +39 -39
  216. package/src/Viewer/Markup/Impl/Visualize/VisualizeMarkup.ts +231 -273
  217. package/src/Viewer/Markup/MarkupFactory.ts +32 -32
  218. package/src/Viewer/Options.ts +522 -502
  219. package/src/Viewer/OptionsEvents.ts +28 -28
  220. package/src/Viewer/Viewer.ts +1191 -1109
  221. package/src/Viewer/ViewerCommands.ts +45 -45
  222. package/src/Viewer/ViewerEvents.ts +700 -700
  223. package/src/Viewer/utils.ts +74 -74
  224. package/src/index.ts +48 -48
@@ -1,502 +1,522 @@
1
- ///////////////////////////////////////////////////////////////////////////////
2
- // Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
3
- // All rights reserved.
4
- //
5
- // This software and its documentation and related materials are owned by
6
- // the Alliance. The software may only be incorporated into application
7
- // programs owned by members of the Alliance, subject to a signed
8
- // Membership Agreement and Supplemental Software License Agreement with the
9
- // Alliance. The structure and organization of this software are the valuable
10
- // trade secrets of the Alliance and its suppliers. The software is also
11
- // protected by copyright law and international treaty provisions. Application
12
- // programs incorporating this software must include the following statement
13
- // with their copyright notices:
14
- //
15
- // This application incorporates Open Design Alliance software pursuant to a
16
- // license agreement with Open Design Alliance.
17
- // Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
18
- // All rights reserved.
19
- //
20
- // By use of this software, its documentation or related materials, you
21
- // acknowledge and accept the above terms.
22
- ///////////////////////////////////////////////////////////////////////////////
23
-
24
- import { EventEmitter2 } from "./EventEmitter2";
25
-
26
- export interface RGB {
27
- red: number;
28
- green: number;
29
- blue: number;
30
- }
31
-
32
- /**
33
- * `VisualizeJS` parameters.
34
- */
35
- export interface OptionsData {
36
- /**
37
- * Show WCS
38
- *
39
- * @defaultValue true
40
- */
41
- showWCS?: boolean;
42
-
43
- /**
44
- * Enable camera animation
45
- *
46
- * @defaultValue true
47
- */
48
- cameraAnimation?: boolean;
49
-
50
- /**
51
- * Enable antialiasing use FXAA
52
- *
53
- * @defaultValue true
54
- */
55
- antialiasing?: boolean;
56
-
57
- /**
58
- * Enable ground shadows
59
- *
60
- * @defaultValue false
61
- */
62
- groundShadow?: boolean;
63
-
64
- /**
65
- * Enable shadows
66
- *
67
- * @defaultValue false
68
- */
69
- shadows?: boolean;
70
-
71
- /**
72
- * Camera speed on X axis
73
- *
74
- * @defaultValue 4
75
- */
76
- cameraAxisXSpeed?: number;
77
-
78
- /**
79
- * Camera speed on Y axis
80
- *
81
- * @defaultValue 1
82
- */
83
- cameraAxisYSpeed?: number;
84
-
85
- /**
86
- * Ambient occlusion
87
- *
88
- * @defaultValue false
89
- */
90
- ambientOcclusion?: boolean;
91
-
92
- /**
93
- * Enable partial load mode to be able open large drawing If enablePartialMode enabled, then
94
- * sceneGraph will be switched off
95
- *
96
- * @defaultValue false
97
- */
98
- enablePartialMode?: boolean;
99
-
100
- /**
101
- * The size of the memory buffer that the Viewer can use for graphics data
102
- *
103
- * @defaultValue 3294967296
104
- */
105
- memoryLimit?: number;
106
-
107
- /**
108
- * Cutting plane fill color
109
- *
110
- * @defaultValue { red: 0xff, green: 0x98, blue: 0x00 }
111
- */
112
- cuttingPlaneFillColor?: RGB;
113
-
114
- /**
115
- * Outline edges color in RGB format.
116
- */
117
- edgesColor?: { r: number; g: number; b: number };
118
-
119
- /**
120
- * Faces color in the RGB format.
121
- */
122
- facesColor?: { r: number; g: number; b: number };
123
-
124
- /**
125
- * Show or hide edges.
126
- */
127
- edgesVisibility?: boolean;
128
-
129
- /**
130
- * Show edges over drawing.
131
- */
132
- edgesOverlap?: boolean;
133
-
134
- /**
135
- * Show faces over drawing.
136
- */
137
- facesOverlap?: boolean;
138
-
139
- /**
140
- * Faces transparency value from 0 to 255.
141
- */
142
- facesTransparancy?: number;
143
-
144
- /**
145
- * Enable custom highlight settings.
146
- */
147
- enableCustomHighlight?: boolean;
148
-
149
- /**
150
- * Enable or disable scene graph, it increases perfomance improvement, but consumes memory
151
- * Large drawings can take up a lot of memory. If sceneGraph enabled, then enablePartialMode
152
- * will be switched off
153
- */
154
- sceneGraph: boolean;
155
-
156
- /**
157
- * Edge display models. No edges is usefull for less memory consumption: `false` - no edges
158
- * are displayed, `true` - display isolines.
159
- */
160
- edgeModel: boolean;
161
-
162
- /**
163
- * Reverse the mouse wheel direction for zooming: false - moving the wheel up zooms in,
164
- * moving down zooms out, `true` - moving the wheel up zooms out, moving down zooms in.
165
- */
166
- reverseZoomWheel: boolean;
167
-
168
- /**
169
- * Enable mouse wheel zooming.
170
- */
171
- enableZoomWheel: boolean;
172
-
173
- /**
174
- * Enable touch gestures. This option will be ignored when enableZoomWheel is disabled, since
175
- * gestures contains touch zoom.
176
- */
177
- enableGestures: boolean;
178
-
179
- /**
180
- * Default file geometry data type. Can be one of:
181
- *
182
- * - `vsfx` - `VSFX` (default), for opening a file in `VisualizeJS` viewer.
183
- * - `gltf` - `glTF`, for opening a file in `Three.js` viewer.
184
- */
185
- geometryType?: string;
186
- }
187
-
188
- export class Options {
189
- protected _emitter?: EventEmitter2;
190
- protected _data: OptionsData;
191
-
192
- constructor(emitter?: EventEmitter2) {
193
- this._emitter = emitter;
194
- this._data = Options.defaults();
195
- this.loadFromStorage();
196
- }
197
-
198
- static defaults(): OptionsData {
199
- return {
200
- showWCS: true,
201
- cameraAnimation: true,
202
- antialiasing: true,
203
- groundShadow: false,
204
- shadows: false,
205
- cameraAxisXSpeed: 4,
206
- cameraAxisYSpeed: 1,
207
- ambientOcclusion: false,
208
- enablePartialMode: false,
209
- memoryLimit: 3294967296,
210
- cuttingPlaneFillColor: { red: 0xff, green: 0x98, blue: 0x00 },
211
- edgesColor: { r: 0xff, g: 0x98, b: 0x00 },
212
- facesColor: { r: 0xff, g: 0x98, b: 0x00 },
213
- edgesVisibility: true,
214
- edgesOverlap: true,
215
- facesOverlap: false,
216
- facesTransparancy: 200,
217
- enableCustomHighlight: true,
218
- sceneGraph: false,
219
- edgeModel: true,
220
- reverseZoomWheel: false,
221
- enableZoomWheel: true,
222
- enableGestures: true,
223
- geometryType: "vsfx",
224
- };
225
- }
226
-
227
- notifierChangeEvent(): void {
228
- if (this._emitter !== undefined) {
229
- this.saveToStorage();
230
- this._emitter.emit({ type: "optionschange", data: this });
231
- }
232
- }
233
-
234
- saveToStorage(): void {
235
- if (typeof window !== "undefined")
236
- try {
237
- localStorage.setItem("od-client-settings", JSON.stringify(this.data));
238
- } catch (error) {
239
- console.error("Cannot save client settings.", error);
240
- }
241
- }
242
-
243
- loadFromStorage(): void {
244
- if (typeof window !== "undefined")
245
- try {
246
- const item = localStorage.getItem("od-client-settings");
247
- if (item) {
248
- const data = JSON.parse(item);
249
- this.data = { ...data };
250
- }
251
- } catch (error) {
252
- console.error("Cannot load client settings.", error);
253
- }
254
- }
255
-
256
- /**
257
- * Reset options to default
258
- *
259
- * @param fields - Name of fields to be reset
260
- */
261
- resetToDefaults(fields?: string[]): void {
262
- if (fields !== undefined) {
263
- const defaults = Options.defaults();
264
- const resetData = fields.reduce((acc, field) => {
265
- acc[field] = defaults[field];
266
- return acc;
267
- }, {});
268
-
269
- this.data = { ...this.data, ...resetData };
270
- } else {
271
- this.data = { ...this.data, ...Options.defaults() };
272
- }
273
- }
274
-
275
- get data(): OptionsData {
276
- return this._data;
277
- }
278
-
279
- set data(value: OptionsData) {
280
- const sceneGraph = value.enablePartialMode ? false : value.sceneGraph;
281
- this._data = { ...Options.defaults(), ...this._data, ...value, sceneGraph };
282
- this.notifierChangeEvent();
283
- }
284
-
285
- get showWCS(): boolean {
286
- return this._data.showWCS;
287
- }
288
-
289
- set showWCS(value: boolean) {
290
- this._data.showWCS = value;
291
- this.notifierChangeEvent();
292
- }
293
-
294
- get cameraAnimation(): boolean {
295
- return this._data.cameraAnimation;
296
- }
297
-
298
- set cameraAnimation(value: boolean) {
299
- this._data.cameraAnimation = value;
300
- this.notifierChangeEvent();
301
- }
302
-
303
- get antialiasing(): boolean {
304
- return this._data.antialiasing;
305
- }
306
-
307
- set antialiasing(value: boolean) {
308
- this._data.antialiasing = value;
309
- this.notifierChangeEvent();
310
- }
311
-
312
- get groundShadow(): boolean {
313
- return this._data.groundShadow;
314
- }
315
-
316
- set groundShadow(value: boolean) {
317
- this._data.groundShadow = value;
318
- this.notifierChangeEvent();
319
- }
320
-
321
- get shadows(): boolean {
322
- return this._data.shadows;
323
- }
324
-
325
- set shadows(value: boolean) {
326
- this._data.shadows = value;
327
- this.notifierChangeEvent();
328
- }
329
-
330
- get cameraAxisXSpeed(): number {
331
- return this._data.cameraAxisXSpeed;
332
- }
333
-
334
- set cameraAxisXSpeed(value: number) {
335
- this._data.cameraAxisXSpeed = value;
336
- this.notifierChangeEvent();
337
- }
338
-
339
- get cameraAxisYSpeed(): number {
340
- return this._data.cameraAxisYSpeed;
341
- }
342
-
343
- set cameraAxisYSpeed(value: number) {
344
- this.cameraAxisYSpeed = value;
345
- this.notifierChangeEvent();
346
- }
347
-
348
- get ambientOcclusion(): boolean {
349
- return this._data.ambientOcclusion;
350
- }
351
-
352
- set ambientOcclusion(value: boolean) {
353
- this._data.ambientOcclusion = value;
354
- this.notifierChangeEvent();
355
- }
356
-
357
- get enablePartialMode(): boolean {
358
- return this._data.enablePartialMode;
359
- }
360
-
361
- set enablePartialMode(value: boolean) {
362
- this._data.enablePartialMode = value;
363
- if (value) this._data.sceneGraph = false;
364
- this.notifierChangeEvent();
365
- }
366
-
367
- get memoryLimit(): number {
368
- return this._data.memoryLimit;
369
- }
370
-
371
- set memoryLimit(value: number) {
372
- this._data.memoryLimit = value;
373
- this.notifierChangeEvent();
374
- }
375
-
376
- get cuttingPlaneFillColor(): RGB {
377
- return this._data.cuttingPlaneFillColor;
378
- }
379
-
380
- set cuttingPlaneFillColor(value: RGB) {
381
- this._data.cuttingPlaneFillColor = value;
382
- this.notifierChangeEvent();
383
- }
384
-
385
- get edgesColor() {
386
- return this._data.edgesColor;
387
- }
388
-
389
- set edgesColor(value) {
390
- this._data.edgesColor = value;
391
- this.notifierChangeEvent();
392
- }
393
-
394
- get facesColor() {
395
- return this._data.facesColor;
396
- }
397
-
398
- set facesColor(value) {
399
- this._data.facesColor = value;
400
- this.notifierChangeEvent();
401
- }
402
-
403
- get edgesVisibility() {
404
- return this._data.edgesVisibility;
405
- }
406
-
407
- set edgesVisibility(value) {
408
- this._data.edgesVisibility = value;
409
- this.notifierChangeEvent();
410
- }
411
-
412
- get edgesOverlap() {
413
- return this._data.edgesOverlap;
414
- }
415
-
416
- set edgesOverlap(value) {
417
- this._data.edgesOverlap = value;
418
- this.notifierChangeEvent();
419
- }
420
-
421
- get facesOverlap() {
422
- return this._data.facesOverlap;
423
- }
424
-
425
- set facesOverlap(value) {
426
- this._data.facesOverlap = value;
427
- this.notifierChangeEvent();
428
- }
429
-
430
- get facesTransparancy() {
431
- return this._data.facesTransparancy;
432
- }
433
-
434
- set facesTransparancy(value) {
435
- this._data.facesTransparancy = value;
436
- this.notifierChangeEvent();
437
- }
438
-
439
- get enableCustomHighlight() {
440
- return this._data.enableCustomHighlight;
441
- }
442
-
443
- set enableCustomHighlight(value) {
444
- this._data.enableCustomHighlight = value;
445
- this.notifierChangeEvent();
446
- }
447
-
448
- get sceneGraph() {
449
- return this._data.sceneGraph;
450
- }
451
-
452
- set sceneGraph(value) {
453
- this._data.sceneGraph = value;
454
- if (value) this._data.enablePartialMode = false;
455
- this.notifierChangeEvent();
456
- }
457
-
458
- get edgeModel() {
459
- return Boolean(this._data.edgeModel);
460
- }
461
-
462
- set edgeModel(value) {
463
- this._data.edgeModel = Boolean(value);
464
- this.notifierChangeEvent();
465
- }
466
-
467
- get reverseZoomWheel() {
468
- return this._data.reverseZoomWheel;
469
- }
470
-
471
- set reverseZoomWheel(value: boolean) {
472
- this._data.reverseZoomWheel = !!value;
473
- this.notifierChangeEvent();
474
- }
475
-
476
- get enableZoomWheel() {
477
- return this._data.enableZoomWheel;
478
- }
479
-
480
- set enableZoomWheel(value: boolean) {
481
- this._data.enableZoomWheel = !!value;
482
- this.notifierChangeEvent();
483
- }
484
-
485
- get enableGestures() {
486
- return this._data.enableGestures;
487
- }
488
-
489
- set enableGestures(value: boolean) {
490
- this._data.enableGestures = !!value;
491
- this.notifierChangeEvent();
492
- }
493
-
494
- get geometryType() {
495
- return this._data.geometryType;
496
- }
497
-
498
- set geometryType(value: string) {
499
- this._data.geometryType = value;
500
- this.notifierChangeEvent();
501
- }
502
- }
1
+ ///////////////////////////////////////////////////////////////////////////////
2
+ // Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
3
+ // All rights reserved.
4
+ //
5
+ // This software and its documentation and related materials are owned by
6
+ // the Alliance. The software may only be incorporated into application
7
+ // programs owned by members of the Alliance, subject to a signed
8
+ // Membership Agreement and Supplemental Software License Agreement with the
9
+ // Alliance. The structure and organization of this software are the valuable
10
+ // trade secrets of the Alliance and its suppliers. The software is also
11
+ // protected by copyright law and international treaty provisions. Application
12
+ // programs incorporating this software must include the following statement
13
+ // with their copyright notices:
14
+ //
15
+ // This application incorporates Open Design Alliance software pursuant to a
16
+ // license agreement with Open Design Alliance.
17
+ // Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
18
+ // All rights reserved.
19
+ //
20
+ // By use of this software, its documentation or related materials, you
21
+ // acknowledge and accept the above terms.
22
+ ///////////////////////////////////////////////////////////////////////////////
23
+
24
+ import { EventEmitter2 } from "./EventEmitter2";
25
+
26
+ export interface RGB {
27
+ red: number;
28
+ green: number;
29
+ blue: number;
30
+ }
31
+
32
+ /**
33
+ * `VisualizeJS` parameters.
34
+ */
35
+ export interface OptionsData {
36
+ /**
37
+ * Show WCS
38
+ *
39
+ * @defaultValue true
40
+ */
41
+ showWCS?: boolean;
42
+
43
+ /**
44
+ * Enable camera animation
45
+ *
46
+ * @defaultValue true
47
+ */
48
+ cameraAnimation?: boolean;
49
+
50
+ /**
51
+ * Enable antialiasing use FXAA
52
+ *
53
+ * @defaultValue true
54
+ */
55
+ antialiasing?: boolean;
56
+
57
+ /**
58
+ * Enable ground shadows
59
+ *
60
+ * @defaultValue false
61
+ */
62
+ groundShadow?: boolean;
63
+
64
+ /**
65
+ * Enable shadows
66
+ *
67
+ * @defaultValue false
68
+ */
69
+ shadows?: boolean;
70
+
71
+ /**
72
+ * Camera speed on X axis
73
+ *
74
+ * @defaultValue 4
75
+ */
76
+ cameraAxisXSpeed?: number;
77
+
78
+ /**
79
+ * Camera speed on Y axis
80
+ *
81
+ * @defaultValue 1
82
+ */
83
+ cameraAxisYSpeed?: number;
84
+
85
+ /**
86
+ * Ambient occlusion
87
+ *
88
+ * @defaultValue false
89
+ */
90
+ ambientOcclusion?: boolean;
91
+
92
+ /**
93
+ * Enable streaming mode
94
+ *
95
+ * If enableStreamingMode is true then enablePartialMode will be used, otherwise -
96
+ * enablePartialMode will be ignored and file / assembly will be loaded in one go
97
+ *
98
+ * @defaultValue true
99
+ */
100
+ enableStreamingMode?: boolean;
101
+
102
+ /**
103
+ * Enable partial load mode to be able open large drawing If enablePartialMode enabled, then
104
+ * sceneGraph will be switched off
105
+ *
106
+ * @defaultValue false
107
+ */
108
+ enablePartialMode?: boolean;
109
+
110
+ /**
111
+ * The size of the memory buffer that the Viewer can use for graphics data
112
+ *
113
+ * @defaultValue 3294967296
114
+ */
115
+ memoryLimit?: number;
116
+
117
+ /**
118
+ * Cutting plane fill color
119
+ *
120
+ * @defaultValue { red: 0xff, green: 0x98, blue: 0x00 }
121
+ */
122
+ cuttingPlaneFillColor?: RGB;
123
+
124
+ /**
125
+ * Outline edges color in RGB format.
126
+ */
127
+ edgesColor?: { r: number; g: number; b: number };
128
+
129
+ /**
130
+ * Faces color in the RGB format.
131
+ */
132
+ facesColor?: { r: number; g: number; b: number };
133
+
134
+ /**
135
+ * Show or hide edges.
136
+ */
137
+ edgesVisibility?: boolean;
138
+
139
+ /**
140
+ * Show edges over drawing.
141
+ */
142
+ edgesOverlap?: boolean;
143
+
144
+ /**
145
+ * Show faces over drawing.
146
+ */
147
+ facesOverlap?: boolean;
148
+
149
+ /**
150
+ * Faces transparency value from 0 to 255.
151
+ */
152
+ facesTransparancy?: number;
153
+
154
+ /**
155
+ * Enable custom highlight settings.
156
+ */
157
+ enableCustomHighlight?: boolean;
158
+
159
+ /**
160
+ * Enable or disable scene graph, it increases perfomance improvement, but consumes memory
161
+ * Large drawings can take up a lot of memory. If sceneGraph enabled, then enablePartialMode
162
+ * will be switched off
163
+ */
164
+ sceneGraph: boolean;
165
+
166
+ /**
167
+ * Edge display models. No edges is usefull for less memory consumption: `false` - no edges
168
+ * are displayed, `true` - display isolines.
169
+ */
170
+ edgeModel: boolean;
171
+
172
+ /**
173
+ * Reverse the mouse wheel direction for zooming: false - moving the wheel up zooms in,
174
+ * moving down zooms out, `true` - moving the wheel up zooms out, moving down zooms in.
175
+ */
176
+ reverseZoomWheel: boolean;
177
+
178
+ /**
179
+ * Enable mouse wheel zooming.
180
+ */
181
+ enableZoomWheel: boolean;
182
+
183
+ /**
184
+ * Enable touch gestures. This option will be ignored when enableZoomWheel is disabled, since
185
+ * gestures contains touch zoom.
186
+ */
187
+ enableGestures: boolean;
188
+
189
+ /**
190
+ * Default file geometry data type. Can be one of:
191
+ *
192
+ * - `vsfx` - `VSFX` (default), for opening a file in `VisualizeJS` viewer.
193
+ * - `gltf` - `glTF`, for opening a file in `Three.js` viewer.
194
+ */
195
+ geometryType?: string;
196
+ }
197
+
198
+ export class Options {
199
+ protected _emitter?: EventEmitter2;
200
+ protected _data: OptionsData;
201
+
202
+ constructor(emitter?: EventEmitter2) {
203
+ this._emitter = emitter;
204
+ this._data = Options.defaults();
205
+ this.loadFromStorage();
206
+ }
207
+
208
+ static defaults(): OptionsData {
209
+ return {
210
+ showWCS: true,
211
+ cameraAnimation: true,
212
+ antialiasing: true,
213
+ groundShadow: false,
214
+ shadows: false,
215
+ cameraAxisXSpeed: 4,
216
+ cameraAxisYSpeed: 1,
217
+ ambientOcclusion: false,
218
+ enableStreamingMode: true,
219
+ enablePartialMode: false,
220
+ memoryLimit: 3294967296,
221
+ cuttingPlaneFillColor: { red: 0xff, green: 0x98, blue: 0x00 },
222
+ edgesColor: { r: 0xff, g: 0x98, b: 0x00 },
223
+ facesColor: { r: 0xff, g: 0x98, b: 0x00 },
224
+ edgesVisibility: true,
225
+ edgesOverlap: true,
226
+ facesOverlap: false,
227
+ facesTransparancy: 200,
228
+ enableCustomHighlight: true,
229
+ sceneGraph: false,
230
+ edgeModel: true,
231
+ reverseZoomWheel: false,
232
+ enableZoomWheel: true,
233
+ enableGestures: true,
234
+ geometryType: "vsfx",
235
+ };
236
+ }
237
+
238
+ notifierChangeEvent(): void {
239
+ if (this._emitter !== undefined) {
240
+ this.saveToStorage();
241
+ this._emitter.emit({ type: "optionschange", data: this });
242
+ }
243
+ }
244
+
245
+ saveToStorage(): void {
246
+ if (typeof window !== "undefined")
247
+ try {
248
+ localStorage.setItem("od-client-settings", JSON.stringify(this.data));
249
+ } catch (error) {
250
+ console.error("Cannot save client settings.", error);
251
+ }
252
+ }
253
+
254
+ loadFromStorage(): void {
255
+ if (typeof window !== "undefined")
256
+ try {
257
+ const item = localStorage.getItem("od-client-settings");
258
+ if (item) {
259
+ const data = JSON.parse(item);
260
+ this.data = { ...data };
261
+ }
262
+ } catch (error) {
263
+ console.error("Cannot load client settings.", error);
264
+ }
265
+ }
266
+
267
+ /**
268
+ * Reset options to default
269
+ *
270
+ * @param fields - Name of fields to be reset
271
+ */
272
+ resetToDefaults(fields?: string[]): void {
273
+ if (fields !== undefined) {
274
+ const defaults = Options.defaults();
275
+ const resetData = fields.reduce((acc, field) => {
276
+ acc[field] = defaults[field];
277
+ return acc;
278
+ }, {});
279
+
280
+ this.data = { ...this.data, ...resetData };
281
+ } else {
282
+ this.data = { ...this.data, ...Options.defaults() };
283
+ }
284
+ }
285
+
286
+ get data(): OptionsData {
287
+ return this._data;
288
+ }
289
+
290
+ set data(value: OptionsData) {
291
+ const sceneGraph = value.enablePartialMode ? false : value.sceneGraph;
292
+ this._data = { ...Options.defaults(), ...this._data, ...value, sceneGraph };
293
+ this.notifierChangeEvent();
294
+ }
295
+
296
+ get showWCS(): boolean {
297
+ return this._data.showWCS;
298
+ }
299
+
300
+ set showWCS(value: boolean) {
301
+ this._data.showWCS = value;
302
+ this.notifierChangeEvent();
303
+ }
304
+
305
+ get cameraAnimation(): boolean {
306
+ return this._data.cameraAnimation;
307
+ }
308
+
309
+ set cameraAnimation(value: boolean) {
310
+ this._data.cameraAnimation = value;
311
+ this.notifierChangeEvent();
312
+ }
313
+
314
+ get antialiasing(): boolean {
315
+ return this._data.antialiasing;
316
+ }
317
+
318
+ set antialiasing(value: boolean) {
319
+ this._data.antialiasing = value;
320
+ this.notifierChangeEvent();
321
+ }
322
+
323
+ get groundShadow(): boolean {
324
+ return this._data.groundShadow;
325
+ }
326
+
327
+ set groundShadow(value: boolean) {
328
+ this._data.groundShadow = value;
329
+ this.notifierChangeEvent();
330
+ }
331
+
332
+ get shadows(): boolean {
333
+ return this._data.shadows;
334
+ }
335
+
336
+ set shadows(value: boolean) {
337
+ this._data.shadows = value;
338
+ this.notifierChangeEvent();
339
+ }
340
+
341
+ get cameraAxisXSpeed(): number {
342
+ return this._data.cameraAxisXSpeed;
343
+ }
344
+
345
+ set cameraAxisXSpeed(value: number) {
346
+ this._data.cameraAxisXSpeed = value;
347
+ this.notifierChangeEvent();
348
+ }
349
+
350
+ get cameraAxisYSpeed(): number {
351
+ return this._data.cameraAxisYSpeed;
352
+ }
353
+
354
+ set cameraAxisYSpeed(value: number) {
355
+ this.cameraAxisYSpeed = value;
356
+ this.notifierChangeEvent();
357
+ }
358
+
359
+ get ambientOcclusion(): boolean {
360
+ return this._data.ambientOcclusion;
361
+ }
362
+
363
+ set ambientOcclusion(value: boolean) {
364
+ this._data.ambientOcclusion = value;
365
+ this.notifierChangeEvent();
366
+ }
367
+
368
+ get enableStreamingMode(): boolean {
369
+ return this._data.enableStreamingMode;
370
+ }
371
+
372
+ set enableStreamingMode(value: boolean) {
373
+ this._data.enableStreamingMode = value;
374
+ this.notifierChangeEvent();
375
+ }
376
+
377
+ get enablePartialMode(): boolean {
378
+ return this._data.enablePartialMode;
379
+ }
380
+
381
+ set enablePartialMode(value: boolean) {
382
+ this._data.enablePartialMode = value;
383
+ if (value) this._data.sceneGraph = false;
384
+ this.notifierChangeEvent();
385
+ }
386
+
387
+ get memoryLimit(): number {
388
+ return this._data.memoryLimit;
389
+ }
390
+
391
+ set memoryLimit(value: number) {
392
+ this._data.memoryLimit = value;
393
+ this.notifierChangeEvent();
394
+ }
395
+
396
+ get cuttingPlaneFillColor(): RGB {
397
+ return this._data.cuttingPlaneFillColor;
398
+ }
399
+
400
+ set cuttingPlaneFillColor(value: RGB) {
401
+ this._data.cuttingPlaneFillColor = value;
402
+ this.notifierChangeEvent();
403
+ }
404
+
405
+ get edgesColor() {
406
+ return this._data.edgesColor;
407
+ }
408
+
409
+ set edgesColor(value) {
410
+ this._data.edgesColor = value;
411
+ this.notifierChangeEvent();
412
+ }
413
+
414
+ get facesColor() {
415
+ return this._data.facesColor;
416
+ }
417
+
418
+ set facesColor(value) {
419
+ this._data.facesColor = value;
420
+ this.notifierChangeEvent();
421
+ }
422
+
423
+ get edgesVisibility() {
424
+ return this._data.edgesVisibility;
425
+ }
426
+
427
+ set edgesVisibility(value) {
428
+ this._data.edgesVisibility = value;
429
+ this.notifierChangeEvent();
430
+ }
431
+
432
+ get edgesOverlap() {
433
+ return this._data.edgesOverlap;
434
+ }
435
+
436
+ set edgesOverlap(value) {
437
+ this._data.edgesOverlap = value;
438
+ this.notifierChangeEvent();
439
+ }
440
+
441
+ get facesOverlap() {
442
+ return this._data.facesOverlap;
443
+ }
444
+
445
+ set facesOverlap(value) {
446
+ this._data.facesOverlap = value;
447
+ this.notifierChangeEvent();
448
+ }
449
+
450
+ get facesTransparancy() {
451
+ return this._data.facesTransparancy;
452
+ }
453
+
454
+ set facesTransparancy(value) {
455
+ this._data.facesTransparancy = value;
456
+ this.notifierChangeEvent();
457
+ }
458
+
459
+ get enableCustomHighlight() {
460
+ return this._data.enableCustomHighlight;
461
+ }
462
+
463
+ set enableCustomHighlight(value) {
464
+ this._data.enableCustomHighlight = value;
465
+ this.notifierChangeEvent();
466
+ }
467
+
468
+ get sceneGraph() {
469
+ return this._data.sceneGraph;
470
+ }
471
+
472
+ set sceneGraph(value) {
473
+ this._data.sceneGraph = value;
474
+ if (value) this._data.enablePartialMode = false;
475
+ this.notifierChangeEvent();
476
+ }
477
+
478
+ get edgeModel() {
479
+ return Boolean(this._data.edgeModel);
480
+ }
481
+
482
+ set edgeModel(value) {
483
+ this._data.edgeModel = Boolean(value);
484
+ this.notifierChangeEvent();
485
+ }
486
+
487
+ get reverseZoomWheel() {
488
+ return this._data.reverseZoomWheel;
489
+ }
490
+
491
+ set reverseZoomWheel(value: boolean) {
492
+ this._data.reverseZoomWheel = !!value;
493
+ this.notifierChangeEvent();
494
+ }
495
+
496
+ get enableZoomWheel() {
497
+ return this._data.enableZoomWheel;
498
+ }
499
+
500
+ set enableZoomWheel(value: boolean) {
501
+ this._data.enableZoomWheel = !!value;
502
+ this.notifierChangeEvent();
503
+ }
504
+
505
+ get enableGestures() {
506
+ return this._data.enableGestures;
507
+ }
508
+
509
+ set enableGestures(value: boolean) {
510
+ this._data.enableGestures = !!value;
511
+ this.notifierChangeEvent();
512
+ }
513
+
514
+ get geometryType() {
515
+ return this._data.geometryType;
516
+ }
517
+
518
+ set geometryType(value: string) {
519
+ this._data.geometryType = value;
520
+ this.notifierChangeEvent();
521
+ }
522
+ }