@combeenation/3d-viewer 7.0.0 → 7.1.0

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 (105) hide show
  1. package/README.md +111 -111
  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 +670 -670
  8. package/dist/lib-cjs/api/classes/event.d.ts +396 -396
  9. package/dist/lib-cjs/api/classes/event.js +419 -419
  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 +351 -351
  15. package/dist/lib-cjs/api/classes/parameter.js +517 -517
  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 +253 -253
  23. package/dist/lib-cjs/api/classes/variant.js +843 -843
  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 +88 -88
  28. package/dist/lib-cjs/api/classes/viewer.d.ts +199 -200
  29. package/dist/lib-cjs/api/classes/viewer.js +670 -671
  30. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  31. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  32. package/dist/lib-cjs/api/classes/viewerLight.js +348 -348
  33. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  34. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  35. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  36. package/dist/lib-cjs/api/internal/sceneSetup.js +226 -226
  37. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  38. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  39. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +78 -78
  40. package/dist/lib-cjs/api/manager/gltfExportManager.js +241 -241
  41. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  42. package/dist/lib-cjs/api/manager/sceneManager.js +130 -130
  43. package/dist/lib-cjs/api/manager/tagManager.d.ts +108 -108
  44. package/dist/lib-cjs/api/manager/tagManager.js +419 -419
  45. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  46. package/dist/lib-cjs/api/manager/textureLoadManager.js +97 -97
  47. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +102 -103
  48. package/dist/lib-cjs/api/manager/variantInstanceManager.js +284 -285
  49. package/dist/lib-cjs/api/manager/variantInstanceManager.js.map +1 -1
  50. package/dist/lib-cjs/api/store/specStorage.d.ts +32 -32
  51. package/dist/lib-cjs/api/store/specStorage.js +65 -65
  52. package/dist/lib-cjs/api/util/babylonHelper.d.ts +235 -235
  53. package/dist/lib-cjs/api/util/babylonHelper.js +753 -750
  54. package/dist/lib-cjs/api/util/babylonHelper.js.map +1 -1
  55. package/dist/lib-cjs/api/util/globalTypes.d.ts +436 -436
  56. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  57. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  58. package/dist/lib-cjs/api/util/resourceHelper.js +203 -203
  59. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +44 -44
  60. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +175 -173
  61. package/dist/lib-cjs/api/util/sceneLoaderHelper.js.map +1 -1
  62. package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
  63. package/dist/lib-cjs/api/util/stringHelper.js +32 -32
  64. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  65. package/dist/lib-cjs/api/util/structureHelper.js +48 -48
  66. package/dist/lib-cjs/buildinfo.json +3 -3
  67. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  68. package/dist/lib-cjs/index.d.ts +53 -53
  69. package/dist/lib-cjs/index.js +114 -114
  70. package/package.json +81 -81
  71. package/src/api/classes/animationInterface.ts +10 -10
  72. package/src/api/classes/dottedPath.ts +181 -181
  73. package/src/api/classes/element.ts +731 -731
  74. package/src/api/classes/event.ts +452 -452
  75. package/src/api/classes/eventBroadcaster.ts +52 -52
  76. package/src/api/classes/fuzzyMap.ts +21 -21
  77. package/src/api/classes/parameter.ts +554 -554
  78. package/src/api/classes/parameterObservable.ts +73 -73
  79. package/src/api/classes/parameterizable.ts +87 -87
  80. package/src/api/classes/placementAnimation.ts +162 -162
  81. package/src/api/classes/variant.ts +933 -933
  82. package/src/api/classes/variantInstance.ts +123 -123
  83. package/src/api/classes/variantParameterizable.ts +85 -85
  84. package/src/api/classes/viewer.ts +743 -744
  85. package/src/api/classes/viewerLight.ts +339 -339
  86. package/src/api/internal/debugViewer.ts +90 -90
  87. package/src/api/internal/lensRendering.ts +9 -9
  88. package/src/api/internal/sceneSetup.ts +205 -205
  89. package/src/api/manager/animationManager.ts +143 -143
  90. package/src/api/manager/gltfExportManager.ts +236 -236
  91. package/src/api/manager/sceneManager.ts +136 -136
  92. package/src/api/manager/tagManager.ts +451 -451
  93. package/src/api/manager/textureLoadManager.ts +95 -95
  94. package/src/api/manager/variantInstanceManager.ts +297 -298
  95. package/src/api/store/specStorage.ts +68 -68
  96. package/src/api/util/babylonHelper.ts +823 -822
  97. package/src/api/util/globalTypes.ts +503 -503
  98. package/src/api/util/resourceHelper.ts +191 -191
  99. package/src/api/util/sceneLoaderHelper.ts +170 -170
  100. package/src/api/util/stringHelper.ts +30 -30
  101. package/src/api/util/structureHelper.ts +49 -49
  102. package/src/buildinfo.json +3 -3
  103. package/src/dev.ts +62 -62
  104. package/src/index.ts +100 -100
  105. package/src/types.d.ts +38 -35
@@ -1,136 +1,136 @@
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<void | ParameterObserver>[] = [];
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 observerResult = observer(this, oldParameterValue, newParameterValue);
76
- const observerPromise = Promise.resolve(observerResult);
77
- observerPromise.then(() => {
78
- this.broadcastEvent(
79
- Event.SCENE_PARAMETER_COMMITTED,
80
- this,
81
- parameter,
82
- oldParameterValue,
83
- newParameterValue
84
- );
85
- });
86
- return observerPromise;
87
- })
88
- );
89
- }
90
- }
91
- await Promise.all(observerPromises);
92
- return this;
93
- }
94
-
95
- protected addParameterObservers(): SceneManager {
96
- const handleEnvParamChange = (
97
- manager: SceneManager,
98
- oldValue: Undefinable<ParameterValue>,
99
- newValue: ParameterValue
100
- ) => {
101
- const params = {
102
- color: manager.parameters[Parameter.ENVIRONMENT_COLOR],
103
- intensity: manager.parameters[Parameter.ENVIRONMENT_INTENSITY],
104
- env: manager.parameters[Parameter.ENVIRONMENT],
105
- background: manager.parameters[Parameter.ENVIRONMENT_BACKGROUND],
106
- rotation: manager.parameters[Parameter.ENVIRONMENT_ROTATION],
107
- useDefault: manager.parameters[Parameter.ENVIRONMENT_USEDEFAULT],
108
- };
109
- const envDef: EnvironmentDefinition = {
110
- environmentColor: params.color ? Parameter.parseColor(params.color) : undefined,
111
- environmentIntensity: params.intensity !== undefined ? Parameter.parseNumber(params.intensity) : undefined,
112
- environment: params.env ? (params.env as string) : undefined,
113
- environmentBackground: params.background ? (params.background as string) : undefined,
114
- environmentRotation: params.rotation !== undefined ? Parameter.parseNumber(params.rotation) : undefined,
115
- environmentUseDefault: params.useDefault ? Parameter.parseBoolean(params.useDefault) : undefined,
116
- };
117
- changeEnvironment(manager.scene, envDef);
118
- };
119
-
120
- this._parameterObservers.set(Parameter.ENVIRONMENT_COLOR, [handleEnvParamChange]);
121
- this._parameterObservers.set(Parameter.ENVIRONMENT_ROTATION, [handleEnvParamChange]);
122
- this._parameterObservers.set(Parameter.ENVIRONMENT_USEDEFAULT, [handleEnvParamChange]);
123
- this._parameterObservers.set(Parameter.ENVIRONMENT, [handleEnvParamChange]);
124
- this._parameterObservers.set(Parameter.ENVIRONMENT_BACKGROUND, [handleEnvParamChange]);
125
- this._parameterObservers.set(Parameter.ENVIRONMENT_INTENSITY, [handleEnvParamChange]);
126
- return this;
127
- }
128
-
129
- /**
130
- * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
131
- */
132
- protected async bootstrapParameters(parameters?: ParameterBag): Promise<SceneManager> {
133
- await this.commitParameters(merge(cloneDeep(this.parameters), parameters));
134
- return this;
135
- }
136
- }
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<void | ParameterObserver>[] = [];
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 observerResult = observer(this, oldParameterValue, newParameterValue);
76
+ const observerPromise = Promise.resolve(observerResult);
77
+ observerPromise.then(() => {
78
+ this.broadcastEvent(
79
+ Event.SCENE_PARAMETER_COMMITTED,
80
+ this,
81
+ parameter,
82
+ oldParameterValue,
83
+ newParameterValue
84
+ );
85
+ });
86
+ return observerPromise;
87
+ })
88
+ );
89
+ }
90
+ }
91
+ await Promise.all(observerPromises);
92
+ return this;
93
+ }
94
+
95
+ protected addParameterObservers(): SceneManager {
96
+ const handleEnvParamChange = (
97
+ manager: SceneManager,
98
+ oldValue: Undefinable<ParameterValue>,
99
+ newValue: ParameterValue
100
+ ) => {
101
+ const params = {
102
+ color: manager.parameters[Parameter.ENVIRONMENT_COLOR],
103
+ intensity: manager.parameters[Parameter.ENVIRONMENT_INTENSITY],
104
+ env: manager.parameters[Parameter.ENVIRONMENT],
105
+ background: manager.parameters[Parameter.ENVIRONMENT_BACKGROUND],
106
+ rotation: manager.parameters[Parameter.ENVIRONMENT_ROTATION],
107
+ useDefault: manager.parameters[Parameter.ENVIRONMENT_USEDEFAULT],
108
+ };
109
+ const envDef: EnvironmentDefinition = {
110
+ environmentColor: params.color ? Parameter.parseColor(params.color) : undefined,
111
+ environmentIntensity: params.intensity !== undefined ? Parameter.parseNumber(params.intensity) : undefined,
112
+ environment: params.env ? (params.env as string) : undefined,
113
+ environmentBackground: params.background ? (params.background as string) : undefined,
114
+ environmentRotation: params.rotation !== undefined ? Parameter.parseNumber(params.rotation) : undefined,
115
+ environmentUseDefault: params.useDefault ? Parameter.parseBoolean(params.useDefault) : undefined,
116
+ };
117
+ changeEnvironment(manager.scene, envDef);
118
+ };
119
+
120
+ this._parameterObservers.set(Parameter.ENVIRONMENT_COLOR, [handleEnvParamChange]);
121
+ this._parameterObservers.set(Parameter.ENVIRONMENT_ROTATION, [handleEnvParamChange]);
122
+ this._parameterObservers.set(Parameter.ENVIRONMENT_USEDEFAULT, [handleEnvParamChange]);
123
+ this._parameterObservers.set(Parameter.ENVIRONMENT, [handleEnvParamChange]);
124
+ this._parameterObservers.set(Parameter.ENVIRONMENT_BACKGROUND, [handleEnvParamChange]);
125
+ this._parameterObservers.set(Parameter.ENVIRONMENT_INTENSITY, [handleEnvParamChange]);
126
+ return this;
127
+ }
128
+
129
+ /**
130
+ * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
131
+ */
132
+ protected async bootstrapParameters(parameters?: ParameterBag): Promise<SceneManager> {
133
+ await this.commitParameters(merge(cloneDeep(this.parameters), parameters));
134
+ return this;
135
+ }
136
+ }