@combeenation/3d-viewer 10.0.0-alpha3 → 11.0.0-beta1

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 (108) hide show
  1. package/README.md +9 -9
  2. package/dist/lib-cjs/api/classes/animationInterface.d.ts +8 -8
  3. package/dist/lib-cjs/api/classes/animationInterface.js +2 -2
  4. package/dist/lib-cjs/api/classes/dottedPath.d.ts +79 -79
  5. package/dist/lib-cjs/api/classes/dottedPath.js +166 -166
  6. package/dist/lib-cjs/api/classes/element.d.ts +153 -153
  7. package/dist/lib-cjs/api/classes/element.js +666 -666
  8. package/dist/lib-cjs/api/classes/event.d.ts +401 -401
  9. package/dist/lib-cjs/api/classes/event.js +424 -424
  10. package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +26 -26
  11. package/dist/lib-cjs/api/classes/eventBroadcaster.js +49 -49
  12. package/dist/lib-cjs/api/classes/fuzzyMap.d.ts +7 -7
  13. package/dist/lib-cjs/api/classes/fuzzyMap.js +21 -21
  14. package/dist/lib-cjs/api/classes/parameter.d.ts +410 -410
  15. package/dist/lib-cjs/api/classes/parameter.js +642 -642
  16. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
  17. package/dist/lib-cjs/api/classes/parameterObservable.js +72 -72
  18. package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
  19. package/dist/lib-cjs/api/classes/parameterizable.js +102 -102
  20. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +45 -45
  21. package/dist/lib-cjs/api/classes/placementAnimation.js +176 -176
  22. package/dist/lib-cjs/api/classes/variant.d.ts +261 -261
  23. package/dist/lib-cjs/api/classes/variant.js +871 -871
  24. package/dist/lib-cjs/api/classes/variantInstance.d.ts +53 -53
  25. package/dist/lib-cjs/api/classes/variantInstance.js +125 -125
  26. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
  27. package/dist/lib-cjs/api/classes/variantParameterizable.js +86 -86
  28. package/dist/lib-cjs/api/classes/viewer.d.ts +211 -211
  29. package/dist/lib-cjs/api/classes/viewer.js +736 -736
  30. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  31. package/dist/lib-cjs/api/classes/viewerError.d.ts +43 -43
  32. package/dist/lib-cjs/api/classes/viewerError.js +55 -55
  33. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  34. package/dist/lib-cjs/api/classes/viewerLight.js +344 -344
  35. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  36. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  37. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  38. package/dist/lib-cjs/api/internal/sceneSetup.js +224 -224
  39. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  40. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  41. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +102 -102
  42. package/dist/lib-cjs/api/manager/gltfExportManager.js +322 -322
  43. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  44. package/dist/lib-cjs/api/manager/sceneManager.js +128 -128
  45. package/dist/lib-cjs/api/manager/tagManager.d.ts +118 -118
  46. package/dist/lib-cjs/api/manager/tagManager.js +535 -535
  47. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  48. package/dist/lib-cjs/api/manager/textureLoadManager.js +98 -98
  49. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +106 -106
  50. package/dist/lib-cjs/api/manager/variantInstanceManager.js +290 -290
  51. package/dist/lib-cjs/api/store/specStorage.d.ts +32 -32
  52. package/dist/lib-cjs/api/store/specStorage.js +65 -65
  53. package/dist/lib-cjs/api/util/babylonHelper.d.ts +238 -238
  54. package/dist/lib-cjs/api/util/babylonHelper.js +826 -826
  55. package/dist/lib-cjs/api/util/geometryHelper.d.ts +7 -7
  56. package/dist/lib-cjs/api/util/geometryHelper.js +115 -115
  57. package/dist/lib-cjs/api/util/globalTypes.d.ts +485 -484
  58. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  59. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  60. package/dist/lib-cjs/api/util/resourceHelper.js +214 -214
  61. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +44 -44
  62. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +175 -175
  63. package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
  64. package/dist/lib-cjs/api/util/stringHelper.js +32 -32
  65. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  66. package/dist/lib-cjs/api/util/structureHelper.js +64 -64
  67. package/dist/lib-cjs/buildinfo.json +3 -3
  68. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  69. package/dist/lib-cjs/index.d.ts +54 -54
  70. package/dist/lib-cjs/index.js +117 -117
  71. package/package.json +84 -84
  72. package/src/api/classes/animationInterface.ts +10 -10
  73. package/src/api/classes/dottedPath.ts +181 -181
  74. package/src/api/classes/element.ts +723 -723
  75. package/src/api/classes/event.ts +457 -457
  76. package/src/api/classes/eventBroadcaster.ts +52 -52
  77. package/src/api/classes/fuzzyMap.ts +21 -21
  78. package/src/api/classes/parameter.ts +686 -686
  79. package/src/api/classes/parameterObservable.ts +73 -73
  80. package/src/api/classes/parameterizable.ts +87 -87
  81. package/src/api/classes/placementAnimation.ts +162 -162
  82. package/src/api/classes/variant.ts +964 -964
  83. package/src/api/classes/variantInstance.ts +123 -123
  84. package/src/api/classes/variantParameterizable.ts +83 -83
  85. package/src/api/classes/viewer.ts +786 -786
  86. package/src/api/classes/viewerError.ts +63 -63
  87. package/src/api/classes/viewerLight.ts +335 -335
  88. package/src/api/internal/debugViewer.ts +90 -90
  89. package/src/api/internal/lensRendering.ts +9 -9
  90. package/src/api/internal/sceneSetup.ts +203 -203
  91. package/src/api/manager/animationManager.ts +143 -143
  92. package/src/api/manager/gltfExportManager.ts +312 -312
  93. package/src/api/manager/sceneManager.ts +134 -134
  94. package/src/api/manager/tagManager.ts +576 -576
  95. package/src/api/manager/textureLoadManager.ts +96 -96
  96. package/src/api/manager/variantInstanceManager.ts +306 -306
  97. package/src/api/store/specStorage.ts +68 -68
  98. package/src/api/util/babylonHelper.ts +915 -915
  99. package/src/api/util/geometryHelper.ts +140 -140
  100. package/src/api/util/globalTypes.ts +561 -560
  101. package/src/api/util/resourceHelper.ts +201 -201
  102. package/src/api/util/sceneLoaderHelper.ts +170 -170
  103. package/src/api/util/stringHelper.ts +30 -30
  104. package/src/api/util/structureHelper.ts +63 -63
  105. package/src/buildinfo.json +3 -3
  106. package/src/dev.ts +70 -70
  107. package/src/index.ts +103 -103
  108. package/src/types.d.ts +49 -49
@@ -1,134 +1,134 @@
1
- import { Event } from '../classes/event';
2
- import { Parameter } from '../classes/parameter';
3
- import { ParameterObservable } from '../classes/parameterObservable';
4
- import { SpecStorage } from '../store/specStorage';
5
- import { changeEnvironment } from '../util/babylonHelper';
6
- import { mergeMaps } from '../util/resourceHelper';
7
- import { TextureLoadManager } from './textureLoadManager';
8
- import { Camera } from '@babylonjs/core/Cameras/camera';
9
- import { Scene as BabylonScene } from '@babylonjs/core/scene';
10
- import { cloneDeep, concat, merge } from 'lodash-es';
11
-
12
- export class SceneManager extends ParameterObservable {
13
- protected readonly _parameterObservers: Map<string, ParameterObserver[]> = new Map();
14
-
15
- protected _textureLoadManager: TextureLoadManager | null = null;
16
-
17
- /**
18
- * Constructor.
19
- */
20
- protected constructor(public scene: BabylonScene) {
21
- super();
22
- this._textureLoadManager = TextureLoadManager.create(scene);
23
- this.addParameterObservers();
24
- }
25
-
26
- /**
27
- * Creates a {@link SceneManager} based on given Babylon.js scene.
28
- */
29
- public static async create(scene: BabylonScene): Promise<SceneManager> {
30
- const sceneManager = new SceneManager(scene);
31
-
32
- await sceneManager.bootstrapParameters(SpecStorage.get<ParameterBag>('scene.parameters'));
33
- return sceneManager;
34
- }
35
-
36
- /**
37
- * The active `Camera`.
38
- */
39
- get activeCamera(): Camera {
40
- if (!this.scene.activeCamera) {
41
- throw new Error('Scene has no active camera.');
42
- }
43
- return this.scene.activeCamera;
44
- }
45
-
46
- /**
47
- * Places the given {@link ParameterBag} in the {@link SceneManager}'s parameters, replaces all patterns in the
48
- * {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
49
- *
50
- * @emit {@link Event.SCENE_PARAMETER_COMMITTED}
51
- */
52
- public async commitParameters(parameters?: ParameterBag): Promise<SceneManager> {
53
- if (!parameters) {
54
- parameters = {};
55
- }
56
- const oldParameters = cloneDeep(this.parameters);
57
- merge(this.parameters, parameters);
58
-
59
- // handle parameter observers
60
- let observerPromises: Promise<ParameterObserverResult>[] = [];
61
- for (const parameter in this.parameters) {
62
- const oldParameterValue = oldParameters[parameter];
63
- const newParameterValue = this.parameters[parameter];
64
- this.assertParameter(Parameter.declarations, parameter, newParameterValue);
65
- if (oldParameterValue === newParameterValue) {
66
- continue;
67
- }
68
- // parameter changed
69
- const parameterObservers = mergeMaps(this._parameterObservers, this.parameterObservers);
70
- if (parameterObservers.has(parameter)) {
71
- const observers = parameterObservers.get(parameter)!;
72
- observerPromises = concat(
73
- observerPromises,
74
- observers.map(observer => {
75
- const observerPromise = observer(this, oldParameterValue, newParameterValue);
76
- return Promise.resolve(observerPromise).then(() => {
77
- this.broadcastEvent(
78
- Event.SCENE_PARAMETER_COMMITTED,
79
- this,
80
- parameter,
81
- oldParameterValue,
82
- newParameterValue
83
- );
84
- });
85
- })
86
- );
87
- }
88
- }
89
- await Promise.all(observerPromises);
90
- return this;
91
- }
92
-
93
- protected addParameterObservers(): SceneManager {
94
- const handleEnvParamChange = async (
95
- manager: SceneManager,
96
- oldValue: Undefinable<ParameterValue>,
97
- newValue: ParameterValue
98
- ) => {
99
- const params = {
100
- color: manager.parameters[Parameter.ENVIRONMENT_COLOR],
101
- intensity: manager.parameters[Parameter.ENVIRONMENT_INTENSITY],
102
- env: manager.parameters[Parameter.ENVIRONMENT],
103
- background: manager.parameters[Parameter.ENVIRONMENT_BACKGROUND],
104
- rotation: manager.parameters[Parameter.ENVIRONMENT_ROTATION],
105
- useDefault: manager.parameters[Parameter.ENVIRONMENT_USEDEFAULT],
106
- };
107
- const envDef: EnvironmentDefinition = {
108
- environmentColor: params.color ? Parameter.parseColor(params.color) : undefined,
109
- environmentIntensity: params.intensity !== undefined ? Parameter.parseNumber(params.intensity) : undefined,
110
- environment: params.env ? (params.env as string) : undefined,
111
- environmentBackground: params.background ? (params.background as string) : undefined,
112
- environmentRotation: params.rotation !== undefined ? Parameter.parseNumber(params.rotation) : undefined,
113
- environmentUseDefault: params.useDefault ? Parameter.parseBoolean(params.useDefault) : undefined,
114
- };
115
- changeEnvironment(manager.scene, envDef);
116
- };
117
-
118
- this._parameterObservers.set(Parameter.ENVIRONMENT_COLOR, [handleEnvParamChange]);
119
- this._parameterObservers.set(Parameter.ENVIRONMENT_ROTATION, [handleEnvParamChange]);
120
- this._parameterObservers.set(Parameter.ENVIRONMENT_USEDEFAULT, [handleEnvParamChange]);
121
- this._parameterObservers.set(Parameter.ENVIRONMENT, [handleEnvParamChange]);
122
- this._parameterObservers.set(Parameter.ENVIRONMENT_BACKGROUND, [handleEnvParamChange]);
123
- this._parameterObservers.set(Parameter.ENVIRONMENT_INTENSITY, [handleEnvParamChange]);
124
- return this;
125
- }
126
-
127
- /**
128
- * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
129
- */
130
- protected async bootstrapParameters(parameters?: ParameterBag): Promise<SceneManager> {
131
- await this.commitParameters(merge(cloneDeep(this.parameters), parameters));
132
- return this;
133
- }
134
- }
1
+ import { Event } from '../classes/event';
2
+ import { Parameter } from '../classes/parameter';
3
+ import { ParameterObservable } from '../classes/parameterObservable';
4
+ import { SpecStorage } from '../store/specStorage';
5
+ import { changeEnvironment } from '../util/babylonHelper';
6
+ import { mergeMaps } from '../util/resourceHelper';
7
+ import { TextureLoadManager } from './textureLoadManager';
8
+ import { Camera } from '@babylonjs/core/Cameras/camera';
9
+ import { Scene as BabylonScene } from '@babylonjs/core/scene';
10
+ import { cloneDeep, concat, merge } from 'lodash-es';
11
+
12
+ export class SceneManager extends ParameterObservable {
13
+ protected readonly _parameterObservers: Map<string, ParameterObserver[]> = new Map();
14
+
15
+ protected _textureLoadManager: TextureLoadManager | null = null;
16
+
17
+ /**
18
+ * Constructor.
19
+ */
20
+ protected constructor(public scene: BabylonScene) {
21
+ super();
22
+ this._textureLoadManager = TextureLoadManager.create(scene);
23
+ this.addParameterObservers();
24
+ }
25
+
26
+ /**
27
+ * Creates a {@link SceneManager} based on given Babylon.js scene.
28
+ */
29
+ public static async create(scene: BabylonScene): Promise<SceneManager> {
30
+ const sceneManager = new SceneManager(scene);
31
+
32
+ await sceneManager.bootstrapParameters(SpecStorage.get<ParameterBag>('scene.parameters'));
33
+ return sceneManager;
34
+ }
35
+
36
+ /**
37
+ * The active `Camera`.
38
+ */
39
+ get activeCamera(): Camera {
40
+ if (!this.scene.activeCamera) {
41
+ throw new Error('Scene has no active camera.');
42
+ }
43
+ return this.scene.activeCamera;
44
+ }
45
+
46
+ /**
47
+ * Places the given {@link ParameterBag} in the {@link SceneManager}'s parameters, replaces all patterns in the
48
+ * {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
49
+ *
50
+ * @emit {@link Event.SCENE_PARAMETER_COMMITTED}
51
+ */
52
+ public async commitParameters(parameters?: ParameterBag): Promise<SceneManager> {
53
+ if (!parameters) {
54
+ parameters = {};
55
+ }
56
+ const oldParameters = cloneDeep(this.parameters);
57
+ merge(this.parameters, parameters);
58
+
59
+ // handle parameter observers
60
+ let observerPromises: Promise<ParameterObserverResult>[] = [];
61
+ for (const parameter in this.parameters) {
62
+ const oldParameterValue = oldParameters[parameter];
63
+ const newParameterValue = this.parameters[parameter];
64
+ this.assertParameter(Parameter.declarations, parameter, newParameterValue);
65
+ if (oldParameterValue === newParameterValue) {
66
+ continue;
67
+ }
68
+ // parameter changed
69
+ const parameterObservers = mergeMaps(this._parameterObservers, this.parameterObservers);
70
+ if (parameterObservers.has(parameter)) {
71
+ const observers = parameterObservers.get(parameter)!;
72
+ observerPromises = concat(
73
+ observerPromises,
74
+ observers.map(observer => {
75
+ const observerPromise = observer(this, oldParameterValue, newParameterValue);
76
+ return Promise.resolve(observerPromise).then(() => {
77
+ this.broadcastEvent(
78
+ Event.SCENE_PARAMETER_COMMITTED,
79
+ this,
80
+ parameter,
81
+ oldParameterValue,
82
+ newParameterValue
83
+ );
84
+ });
85
+ })
86
+ );
87
+ }
88
+ }
89
+ await Promise.all(observerPromises);
90
+ return this;
91
+ }
92
+
93
+ protected addParameterObservers(): SceneManager {
94
+ const handleEnvParamChange = async (
95
+ manager: SceneManager,
96
+ oldValue: Undefinable<ParameterValue>,
97
+ newValue: ParameterValue
98
+ ) => {
99
+ const params = {
100
+ color: manager.parameters[Parameter.ENVIRONMENT_COLOR],
101
+ intensity: manager.parameters[Parameter.ENVIRONMENT_INTENSITY],
102
+ env: manager.parameters[Parameter.ENVIRONMENT],
103
+ background: manager.parameters[Parameter.ENVIRONMENT_BACKGROUND],
104
+ rotation: manager.parameters[Parameter.ENVIRONMENT_ROTATION],
105
+ useDefault: manager.parameters[Parameter.ENVIRONMENT_USEDEFAULT],
106
+ };
107
+ const envDef: EnvironmentDefinition = {
108
+ environmentColor: params.color ? Parameter.parseColor(params.color) : undefined,
109
+ environmentIntensity: params.intensity !== undefined ? Parameter.parseNumber(params.intensity) : undefined,
110
+ environment: params.env ? (params.env as string) : undefined,
111
+ environmentBackground: params.background ? (params.background as string) : undefined,
112
+ environmentRotation: params.rotation !== undefined ? Parameter.parseNumber(params.rotation) : undefined,
113
+ environmentUseDefault: params.useDefault ? Parameter.parseBoolean(params.useDefault) : undefined,
114
+ };
115
+ changeEnvironment(manager.scene, envDef);
116
+ };
117
+
118
+ this._parameterObservers.set(Parameter.ENVIRONMENT_COLOR, [handleEnvParamChange]);
119
+ this._parameterObservers.set(Parameter.ENVIRONMENT_ROTATION, [handleEnvParamChange]);
120
+ this._parameterObservers.set(Parameter.ENVIRONMENT_USEDEFAULT, [handleEnvParamChange]);
121
+ this._parameterObservers.set(Parameter.ENVIRONMENT, [handleEnvParamChange]);
122
+ this._parameterObservers.set(Parameter.ENVIRONMENT_BACKGROUND, [handleEnvParamChange]);
123
+ this._parameterObservers.set(Parameter.ENVIRONMENT_INTENSITY, [handleEnvParamChange]);
124
+ return this;
125
+ }
126
+
127
+ /**
128
+ * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
129
+ */
130
+ protected async bootstrapParameters(parameters?: ParameterBag): Promise<SceneManager> {
131
+ await this.commitParameters(merge(cloneDeep(this.parameters), parameters));
132
+ return this;
133
+ }
134
+ }