@combeenation/3d-viewer 12.4.1 → 13.0.1

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 (213) hide show
  1. package/dist/lib-cjs/buildinfo.json +1 -1
  2. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  3. package/dist/lib-cjs/index.d.ts +63 -63
  4. package/dist/lib-cjs/index.js +81 -114
  5. package/dist/lib-cjs/index.js.map +1 -1
  6. package/dist/lib-cjs/internal/cbn-custom-babylon-loader-plugin.d.ts +10 -0
  7. package/dist/lib-cjs/internal/cbn-custom-babylon-loader-plugin.js +132 -0
  8. package/dist/lib-cjs/internal/cbn-custom-babylon-loader-plugin.js.map +1 -0
  9. package/dist/lib-cjs/internal/cloning-helper.d.ts +19 -0
  10. package/dist/lib-cjs/internal/cloning-helper.js +164 -0
  11. package/dist/lib-cjs/internal/cloning-helper.js.map +1 -0
  12. package/dist/lib-cjs/internal/device-helper.d.ts +9 -0
  13. package/dist/lib-cjs/{api/util/deviceHelper.js → internal/device-helper.js} +7 -11
  14. package/dist/lib-cjs/internal/device-helper.js.map +1 -0
  15. package/dist/lib-cjs/internal/geometry-helper.d.ts +21 -0
  16. package/dist/lib-cjs/{api/util/geometryHelper.js → internal/geometry-helper.js} +58 -25
  17. package/dist/lib-cjs/internal/geometry-helper.js.map +1 -0
  18. package/dist/lib-cjs/internal/metadata-helper.d.ts +26 -0
  19. package/dist/lib-cjs/internal/metadata-helper.js +51 -0
  20. package/dist/lib-cjs/internal/metadata-helper.js.map +1 -0
  21. package/dist/lib-cjs/internal/paintable-helper.d.ts +40 -0
  22. package/dist/lib-cjs/internal/paintable-helper.js +287 -0
  23. package/dist/lib-cjs/internal/paintable-helper.js.map +1 -0
  24. package/dist/lib-cjs/internal/tags-helper.d.ts +12 -0
  25. package/dist/lib-cjs/internal/tags-helper.js +38 -0
  26. package/dist/lib-cjs/internal/tags-helper.js.map +1 -0
  27. package/dist/lib-cjs/manager/camera-manager.d.ts +51 -0
  28. package/dist/lib-cjs/manager/camera-manager.js +154 -0
  29. package/dist/lib-cjs/manager/camera-manager.js.map +1 -0
  30. package/dist/lib-cjs/manager/debug-manager.d.ts +60 -0
  31. package/dist/lib-cjs/manager/debug-manager.js +218 -0
  32. package/dist/lib-cjs/manager/debug-manager.js.map +1 -0
  33. package/dist/lib-cjs/manager/event-manager.d.ts +52 -0
  34. package/dist/lib-cjs/manager/event-manager.js +72 -0
  35. package/dist/lib-cjs/manager/event-manager.js.map +1 -0
  36. package/dist/lib-cjs/{api/manager/gltfExportManager.d.ts → manager/gltf-export-manager.d.ts} +29 -34
  37. package/dist/lib-cjs/{api/manager/gltfExportManager.js → manager/gltf-export-manager.js} +103 -124
  38. package/dist/lib-cjs/manager/gltf-export-manager.js.map +1 -0
  39. package/dist/lib-cjs/manager/material-manager.d.ts +35 -0
  40. package/dist/lib-cjs/manager/material-manager.js +126 -0
  41. package/dist/lib-cjs/manager/material-manager.js.map +1 -0
  42. package/dist/lib-cjs/manager/model-manager.d.ts +145 -0
  43. package/dist/lib-cjs/manager/model-manager.js +383 -0
  44. package/dist/lib-cjs/manager/model-manager.js.map +1 -0
  45. package/dist/lib-cjs/manager/parameter-manager.d.ts +210 -0
  46. package/dist/lib-cjs/manager/parameter-manager.js +515 -0
  47. package/dist/lib-cjs/manager/parameter-manager.js.map +1 -0
  48. package/dist/lib-cjs/manager/scene-manager.d.ts +45 -0
  49. package/dist/lib-cjs/manager/scene-manager.js +65 -0
  50. package/dist/lib-cjs/manager/scene-manager.js.map +1 -0
  51. package/dist/lib-cjs/manager/screenshot-manager.d.ts +36 -0
  52. package/dist/lib-cjs/manager/screenshot-manager.js +40 -0
  53. package/dist/lib-cjs/manager/screenshot-manager.js.map +1 -0
  54. package/dist/lib-cjs/manager/texture-manager.d.ts +12 -0
  55. package/dist/lib-cjs/manager/texture-manager.js +44 -0
  56. package/dist/lib-cjs/manager/texture-manager.js.map +1 -0
  57. package/dist/lib-cjs/{api/classes/viewerError.d.ts → viewer-error.d.ts} +6 -1
  58. package/dist/lib-cjs/{api/classes/viewerError.js → viewer-error.js} +7 -2
  59. package/dist/lib-cjs/viewer-error.js.map +1 -0
  60. package/dist/lib-cjs/viewer.d.ts +117 -0
  61. package/dist/lib-cjs/viewer.js +222 -0
  62. package/dist/lib-cjs/viewer.js.map +1 -0
  63. package/package.json +10 -11
  64. package/src/dev.ts +14 -37
  65. package/src/{types.d.ts → global-types.d.ts} +8 -18
  66. package/src/index.ts +79 -113
  67. package/src/internal/cbn-custom-babylon-loader-plugin.ts +159 -0
  68. package/src/internal/cloning-helper.ts +225 -0
  69. package/src/internal/device-helper.ts +25 -0
  70. package/src/{api/util/geometryHelper.ts → internal/geometry-helper.ts} +63 -24
  71. package/src/internal/metadata-helper.ts +63 -0
  72. package/src/internal/paintable-helper.ts +310 -0
  73. package/src/internal/tags-helper.ts +41 -0
  74. package/src/manager/camera-manager.ts +236 -0
  75. package/src/manager/debug-manager.ts +245 -0
  76. package/src/manager/event-manager.ts +72 -0
  77. package/src/{api/manager/gltfExportManager.ts → manager/gltf-export-manager.ts} +132 -125
  78. package/src/manager/material-manager.ts +135 -0
  79. package/src/manager/model-manager.ts +458 -0
  80. package/src/manager/parameter-manager.ts +652 -0
  81. package/src/manager/scene-manager.ts +101 -0
  82. package/src/manager/screenshot-manager.ts +59 -0
  83. package/src/manager/texture-manager.ts +32 -0
  84. package/src/{api/classes/viewerError.ts → viewer-error.ts} +6 -1
  85. package/src/viewer.ts +296 -0
  86. package/dist/lib-cjs/api/classes/animationInterface.d.ts +0 -8
  87. package/dist/lib-cjs/api/classes/animationInterface.js +0 -3
  88. package/dist/lib-cjs/api/classes/animationInterface.js.map +0 -1
  89. package/dist/lib-cjs/api/classes/dottedPath.d.ts +0 -79
  90. package/dist/lib-cjs/api/classes/dottedPath.js +0 -167
  91. package/dist/lib-cjs/api/classes/dottedPath.js.map +0 -1
  92. package/dist/lib-cjs/api/classes/element.d.ts +0 -153
  93. package/dist/lib-cjs/api/classes/element.js +0 -703
  94. package/dist/lib-cjs/api/classes/element.js.map +0 -1
  95. package/dist/lib-cjs/api/classes/event.d.ts +0 -401
  96. package/dist/lib-cjs/api/classes/event.js +0 -425
  97. package/dist/lib-cjs/api/classes/event.js.map +0 -1
  98. package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +0 -26
  99. package/dist/lib-cjs/api/classes/eventBroadcaster.js +0 -50
  100. package/dist/lib-cjs/api/classes/eventBroadcaster.js.map +0 -1
  101. package/dist/lib-cjs/api/classes/fuzzyMap.d.ts +0 -7
  102. package/dist/lib-cjs/api/classes/fuzzyMap.js +0 -22
  103. package/dist/lib-cjs/api/classes/fuzzyMap.js.map +0 -1
  104. package/dist/lib-cjs/api/classes/parameter.d.ts +0 -410
  105. package/dist/lib-cjs/api/classes/parameter.js +0 -643
  106. package/dist/lib-cjs/api/classes/parameter.js.map +0 -1
  107. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +0 -36
  108. package/dist/lib-cjs/api/classes/parameterObservable.js +0 -73
  109. package/dist/lib-cjs/api/classes/parameterObservable.js.map +0 -1
  110. package/dist/lib-cjs/api/classes/parameterizable.d.ts +0 -15
  111. package/dist/lib-cjs/api/classes/parameterizable.js +0 -103
  112. package/dist/lib-cjs/api/classes/parameterizable.js.map +0 -1
  113. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +0 -45
  114. package/dist/lib-cjs/api/classes/placementAnimation.js +0 -177
  115. package/dist/lib-cjs/api/classes/placementAnimation.js.map +0 -1
  116. package/dist/lib-cjs/api/classes/variant.d.ts +0 -261
  117. package/dist/lib-cjs/api/classes/variant.js +0 -873
  118. package/dist/lib-cjs/api/classes/variant.js.map +0 -1
  119. package/dist/lib-cjs/api/classes/variantInstance.d.ts +0 -53
  120. package/dist/lib-cjs/api/classes/variantInstance.js +0 -126
  121. package/dist/lib-cjs/api/classes/variantInstance.js.map +0 -1
  122. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +0 -17
  123. package/dist/lib-cjs/api/classes/variantParameterizable.js +0 -87
  124. package/dist/lib-cjs/api/classes/variantParameterizable.js.map +0 -1
  125. package/dist/lib-cjs/api/classes/viewer.d.ts +0 -215
  126. package/dist/lib-cjs/api/classes/viewer.js +0 -709
  127. package/dist/lib-cjs/api/classes/viewer.js.map +0 -1
  128. package/dist/lib-cjs/api/classes/viewerError.js.map +0 -1
  129. package/dist/lib-cjs/api/classes/viewerLight.d.ts +0 -66
  130. package/dist/lib-cjs/api/classes/viewerLight.js +0 -345
  131. package/dist/lib-cjs/api/classes/viewerLight.js.map +0 -1
  132. package/dist/lib-cjs/api/internal/lensRendering.d.ts +0 -8
  133. package/dist/lib-cjs/api/internal/lensRendering.js +0 -12
  134. package/dist/lib-cjs/api/internal/lensRendering.js.map +0 -1
  135. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +0 -13
  136. package/dist/lib-cjs/api/internal/sceneSetup.js +0 -228
  137. package/dist/lib-cjs/api/internal/sceneSetup.js.map +0 -1
  138. package/dist/lib-cjs/api/manager/animationManager.d.ts +0 -30
  139. package/dist/lib-cjs/api/manager/animationManager.js +0 -127
  140. package/dist/lib-cjs/api/manager/animationManager.js.map +0 -1
  141. package/dist/lib-cjs/api/manager/gltfExportManager.js.map +0 -1
  142. package/dist/lib-cjs/api/manager/sceneManager.d.ts +0 -33
  143. package/dist/lib-cjs/api/manager/sceneManager.js +0 -129
  144. package/dist/lib-cjs/api/manager/sceneManager.js.map +0 -1
  145. package/dist/lib-cjs/api/manager/tagManager.d.ts +0 -118
  146. package/dist/lib-cjs/api/manager/tagManager.js +0 -531
  147. package/dist/lib-cjs/api/manager/tagManager.js.map +0 -1
  148. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +0 -22
  149. package/dist/lib-cjs/api/manager/textureLoadManager.js +0 -108
  150. package/dist/lib-cjs/api/manager/textureLoadManager.js.map +0 -1
  151. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +0 -106
  152. package/dist/lib-cjs/api/manager/variantInstanceManager.js +0 -291
  153. package/dist/lib-cjs/api/manager/variantInstanceManager.js.map +0 -1
  154. package/dist/lib-cjs/api/store/specStorage.d.ts +0 -32
  155. package/dist/lib-cjs/api/store/specStorage.js +0 -66
  156. package/dist/lib-cjs/api/store/specStorage.js.map +0 -1
  157. package/dist/lib-cjs/api/util/babylonHelper.d.ts +0 -238
  158. package/dist/lib-cjs/api/util/babylonHelper.js +0 -826
  159. package/dist/lib-cjs/api/util/babylonHelper.js.map +0 -1
  160. package/dist/lib-cjs/api/util/debugHelper.d.ts +0 -9
  161. package/dist/lib-cjs/api/util/debugHelper.js +0 -94
  162. package/dist/lib-cjs/api/util/debugHelper.js.map +0 -1
  163. package/dist/lib-cjs/api/util/deviceHelper.d.ts +0 -9
  164. package/dist/lib-cjs/api/util/deviceHelper.js.map +0 -1
  165. package/dist/lib-cjs/api/util/geometryHelper.d.ts +0 -17
  166. package/dist/lib-cjs/api/util/geometryHelper.js.map +0 -1
  167. package/dist/lib-cjs/api/util/globalTypes.d.ts +0 -490
  168. package/dist/lib-cjs/api/util/globalTypes.js +0 -2
  169. package/dist/lib-cjs/api/util/globalTypes.js.map +0 -1
  170. package/dist/lib-cjs/api/util/resourceHelper.d.ts +0 -58
  171. package/dist/lib-cjs/api/util/resourceHelper.js +0 -215
  172. package/dist/lib-cjs/api/util/resourceHelper.js.map +0 -1
  173. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +0 -58
  174. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +0 -229
  175. package/dist/lib-cjs/api/util/sceneLoaderHelper.js.map +0 -1
  176. package/dist/lib-cjs/api/util/stringHelper.d.ts +0 -13
  177. package/dist/lib-cjs/api/util/stringHelper.js +0 -33
  178. package/dist/lib-cjs/api/util/stringHelper.js.map +0 -1
  179. package/dist/lib-cjs/api/util/structureHelper.d.ts +0 -9
  180. package/dist/lib-cjs/api/util/structureHelper.js +0 -58
  181. package/dist/lib-cjs/api/util/structureHelper.js.map +0 -1
  182. package/src/api/classes/animationInterface.ts +0 -10
  183. package/src/api/classes/dottedPath.ts +0 -181
  184. package/src/api/classes/element.ts +0 -766
  185. package/src/api/classes/event.ts +0 -457
  186. package/src/api/classes/eventBroadcaster.ts +0 -52
  187. package/src/api/classes/fuzzyMap.ts +0 -21
  188. package/src/api/classes/parameter.ts +0 -686
  189. package/src/api/classes/parameterObservable.ts +0 -73
  190. package/src/api/classes/parameterizable.ts +0 -87
  191. package/src/api/classes/placementAnimation.ts +0 -162
  192. package/src/api/classes/variant.ts +0 -965
  193. package/src/api/classes/variantInstance.ts +0 -123
  194. package/src/api/classes/variantParameterizable.ts +0 -83
  195. package/src/api/classes/viewer.ts +0 -751
  196. package/src/api/classes/viewerLight.ts +0 -335
  197. package/src/api/internal/debugViewer.ts +0 -90
  198. package/src/api/internal/lensRendering.ts +0 -9
  199. package/src/api/internal/sceneSetup.ts +0 -208
  200. package/src/api/manager/animationManager.ts +0 -143
  201. package/src/api/manager/sceneManager.ts +0 -134
  202. package/src/api/manager/tagManager.ts +0 -572
  203. package/src/api/manager/textureLoadManager.ts +0 -107
  204. package/src/api/manager/variantInstanceManager.ts +0 -306
  205. package/src/api/store/specStorage.ts +0 -68
  206. package/src/api/util/babylonHelper.ts +0 -915
  207. package/src/api/util/debugHelper.ts +0 -121
  208. package/src/api/util/deviceHelper.ts +0 -31
  209. package/src/api/util/globalTypes.ts +0 -566
  210. package/src/api/util/resourceHelper.ts +0 -201
  211. package/src/api/util/sceneLoaderHelper.ts +0 -247
  212. package/src/api/util/stringHelper.ts +0 -30
  213. package/src/api/util/structureHelper.ts +0 -62
@@ -1,121 +0,0 @@
1
- import { AxesViewer } from '@babylonjs/core/Debug/axesViewer';
2
- import { DynamicTexture } from '@babylonjs/core/Materials/Textures/dynamicTexture';
3
- import { StandardMaterial } from '@babylonjs/core/Materials/standardMaterial';
4
- import { Color3 } from '@babylonjs/core/Maths/math.color';
5
- import { Vector3 } from '@babylonjs/core/Maths/math.vector';
6
- import { MeshBuilder } from '@babylonjs/core/Meshes/meshBuilder';
7
- import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
8
- import { UtilityLayerRenderer } from '@babylonjs/core/Rendering/utilityLayerRenderer';
9
-
10
- type DebugAxisKeys = 'X' | 'Y' | 'Z';
11
- type DebugAxisConfig = { color: Color3; position: Vector3 };
12
-
13
- const _DEBUG_AXIS_MAP: Record<DebugAxisKeys, DebugAxisConfig> = {
14
- X: { color: Color3.Red().scale(0.5), position: new Vector3(1, 0, 0) },
15
- Y: { color: Color3.Green().scale(0.5), position: new Vector3(0, 1, 0) },
16
- Z: { color: Color3.Blue().scale(0.5), position: new Vector3(0, 0, 1) },
17
- };
18
-
19
- const _WORLD_COORD_ROOT_KEY = '__world_coordinates__';
20
- let _AXES_VIEWER: AxesViewer;
21
-
22
- /**
23
- * Create debug coordinate system located in world origin.
24
- * This function is based on Babylon.js `AxesViewer`, axis texts are added manually.
25
- */
26
- export function showWorldCoordinates(dimension: number) {
27
- // make sure to remove already existing debug coordinate systems
28
- hideWorldCoordinates();
29
-
30
- // draw in utility layer, so that there is no interaction with the actually scene content (eg: glb export, autofocus)
31
- const utilityLayerScene = UtilityLayerRenderer.DefaultUtilityLayer.utilityLayerScene;
32
-
33
- const worldCoordRoot = new TransformNode('__world_coordinates__', utilityLayerScene);
34
- // axes viewer coordinate system is a bit too large
35
- // multiply with unify factor to create arrows which exactly match the length of the input dimension
36
- const factor = _getWorldCoordinatesAxesUnifyFactor();
37
- _AXES_VIEWER = new AxesViewer(utilityLayerScene, dimension * factor);
38
-
39
- _prepareWorldCoordinateAxis('X', _AXES_VIEWER.xAxis, worldCoordRoot, dimension, utilityLayerScene);
40
- _prepareWorldCoordinateAxis('Y', _AXES_VIEWER.yAxis, worldCoordRoot, dimension, utilityLayerScene);
41
- _prepareWorldCoordinateAxis('Z', _AXES_VIEWER.zAxis, worldCoordRoot, dimension, utilityLayerScene);
42
- }
43
-
44
- /**
45
- * Remove meshes and materials that are associated with the debug world coordinates system
46
- */
47
- export function hideWorldCoordinates() {
48
- const utilityLayerScene = UtilityLayerRenderer.DefaultUtilityLayer.utilityLayerScene;
49
-
50
- _AXES_VIEWER?.dispose();
51
-
52
- const worldCoordRoot = utilityLayerScene.getTransformNodeByName(_WORLD_COORD_ROOT_KEY);
53
- if (worldCoordRoot) {
54
- worldCoordRoot.dispose(false, true);
55
- }
56
- }
57
-
58
- /**
59
- * Adjust and enhance coordinate axes to fulfill our needs.
60
- * - moves nodes into common root
61
- * - adds text node
62
- */
63
- function _prepareWorldCoordinateAxis(
64
- text: 'X' | 'Y' | 'Z',
65
- axis: TransformNode,
66
- root: TransformNode,
67
- dimension: number,
68
- utilityLayerScene: Scene
69
- ) {
70
- // create unique names
71
- axis.name = `${_WORLD_COORD_ROOT_KEY}.${text}`;
72
- axis.parent = root;
73
-
74
- // create text mesh via dynamic texture
75
- const dynamicTexture = new DynamicTexture(`${_WORLD_COORD_ROOT_KEY}.${text}`, 50, utilityLayerScene, true);
76
- dynamicTexture.hasAlpha = true;
77
- // 42.5 is a magic offset, so that the text is vertically centered for font size 50px
78
- // horizontal centering works well with the standard behaviour of Babylon.js (setting "null" as "width")
79
- dynamicTexture.drawText(text, null, 42.5, 'bold 50px Arial', 'white', 'transparent', true);
80
-
81
- const material = new StandardMaterial(`${_WORLD_COORD_ROOT_KEY}.${text}`, utilityLayerScene);
82
- material.disableLighting = true;
83
- material.emissiveColor = _DEBUG_AXIS_MAP[text].color;
84
- material.diffuseTexture = dynamicTexture;
85
-
86
- const plane = MeshBuilder.CreatePlane(
87
- `${_WORLD_COORD_ROOT_KEY}.${text}.TextPlane`,
88
- { size: dimension / 10 },
89
- utilityLayerScene
90
- );
91
- // make sure that text is located outside of arrow
92
- plane.position = _DEBUG_AXIS_MAP[text].position.multiplyByFloats(
93
- dimension * 1.05,
94
- dimension * 1.05,
95
- dimension * 1.05
96
- );
97
- plane.parent = root;
98
- plane.material = material;
99
- // will be rendered on top of "default" meshes => taken from Babylon.js repo "AxesViewer" implementation
100
- plane.renderingGroupId = 2;
101
- // setting billboard mode ensures, that the text is always readable
102
- plane.billboardMode = TransformNode.BILLBOARDMODE_ALL;
103
- }
104
-
105
- /**
106
- * Calculate factor for creating world coordinate axes with exactly one unit in length
107
- */
108
- function _getWorldCoordinatesAxesUnifyFactor() {
109
- // These constants are taken from the Babylon.js repository
110
- const coneZPosOffset = 0.3;
111
- const coneHeight = 0.075;
112
- const baseScaling = 4;
113
-
114
- // cone is moved 0.3 units away from the center
115
- // the origin of the cone will be located on 1.2, if combined with the base scaling of 4
116
- // invert that offset to get the origin to 1
117
- // also consider the cone height to move the tip of the cone to 1 instead the center
118
- const factor = 1 / ((coneZPosOffset + coneHeight / 2) * baseScaling);
119
-
120
- return factor;
121
- }
@@ -1,31 +0,0 @@
1
- import { SpecStorage } from '../store/specStorage';
2
-
3
- /**
4
- * Checks if the current device is an iPhone
5
- */
6
- const getIsIPhone = () => {
7
- const isIPhone = /iPhone/.test(navigator.userAgent);
8
-
9
- return isIPhone;
10
- };
11
-
12
- /**
13
- * Checks if the current device is "scaled down", as defined in the Spec
14
- */
15
- const getIsScaledDownDevice = () => {
16
- const sceneJson = SpecStorage.get<SceneJson>('scene');
17
-
18
- if (!sceneJson.engine?.limitTextureSize) {
19
- // no down scaling defined
20
- return false;
21
- }
22
-
23
- // check device
24
- const deviceFits =
25
- sceneJson.engine.limitTextureSize.devices === 'all' ||
26
- (sceneJson.engine.limitTextureSize.devices === 'iPhone' && getIsIPhone());
27
-
28
- return deviceFits;
29
- };
30
-
31
- export { getIsIPhone, getIsScaledDownDevice };