@combeenation/3d-viewer 6.1.0 → 6.2.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 (97) 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 +149 -149
  7. package/dist/lib-cjs/api/classes/element.js +669 -669
  8. package/dist/lib-cjs/api/classes/event.d.ts +342 -342
  9. package/dist/lib-cjs/api/classes/event.js +365 -365
  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/parameter.d.ts +339 -339
  13. package/dist/lib-cjs/api/classes/parameter.js +464 -464
  14. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
  15. package/dist/lib-cjs/api/classes/parameterObservable.js +97 -97
  16. package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
  17. package/dist/lib-cjs/api/classes/parameterizable.js +102 -102
  18. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +45 -45
  19. package/dist/lib-cjs/api/classes/placementAnimation.js +176 -176
  20. package/dist/lib-cjs/api/classes/variant.d.ts +238 -234
  21. package/dist/lib-cjs/api/classes/variant.js +841 -828
  22. package/dist/lib-cjs/api/classes/variant.js.map +1 -1
  23. package/dist/lib-cjs/api/classes/variantInstance.d.ts +44 -44
  24. package/dist/lib-cjs/api/classes/variantInstance.js +105 -105
  25. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
  26. package/dist/lib-cjs/api/classes/variantParameterizable.js +88 -88
  27. package/dist/lib-cjs/api/classes/viewer.d.ts +192 -187
  28. package/dist/lib-cjs/api/classes/viewer.js +639 -594
  29. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  30. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  31. package/dist/lib-cjs/api/classes/viewerLight.js +348 -348
  32. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  33. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  34. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  35. package/dist/lib-cjs/api/internal/sceneSetup.js +226 -226
  36. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  37. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  38. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +78 -78
  39. package/dist/lib-cjs/api/manager/gltfExportManager.js +241 -241
  40. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  41. package/dist/lib-cjs/api/manager/sceneManager.js +130 -130
  42. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  43. package/dist/lib-cjs/api/manager/textureLoadManager.js +97 -97
  44. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +92 -92
  45. package/dist/lib-cjs/api/manager/variantInstanceManager.js +260 -260
  46. package/dist/lib-cjs/api/store/specStorage.d.ts +24 -24
  47. package/dist/lib-cjs/api/store/specStorage.js +50 -50
  48. package/dist/lib-cjs/api/util/babylonHelper.d.ts +187 -187
  49. package/dist/lib-cjs/api/util/babylonHelper.js +596 -596
  50. package/dist/lib-cjs/api/util/globalTypes.d.ts +387 -383
  51. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  52. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  53. package/dist/lib-cjs/api/util/resourceHelper.js +203 -203
  54. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +42 -42
  55. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +139 -139
  56. package/dist/lib-cjs/api/util/stringHelper.d.ts +9 -9
  57. package/dist/lib-cjs/api/util/stringHelper.js +25 -25
  58. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  59. package/dist/lib-cjs/api/util/structureHelper.js +48 -48
  60. package/dist/lib-cjs/buildinfo.json +3 -3
  61. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  62. package/dist/lib-cjs/index.d.ts +51 -51
  63. package/dist/lib-cjs/index.js +110 -110
  64. package/package.json +81 -81
  65. package/src/api/classes/animationInterface.ts +10 -10
  66. package/src/api/classes/dottedPath.ts +181 -181
  67. package/src/api/classes/element.ts +717 -717
  68. package/src/api/classes/event.ts +385 -385
  69. package/src/api/classes/eventBroadcaster.ts +52 -52
  70. package/src/api/classes/parameter.ts +497 -497
  71. package/src/api/classes/parameterObservable.ts +100 -100
  72. package/src/api/classes/parameterizable.ts +87 -87
  73. package/src/api/classes/placementAnimation.ts +162 -162
  74. package/src/api/classes/variant.ts +910 -896
  75. package/src/api/classes/variantInstance.ts +97 -97
  76. package/src/api/classes/variantParameterizable.ts +85 -85
  77. package/src/api/classes/viewer.ts +720 -672
  78. package/src/api/classes/viewerLight.ts +339 -339
  79. package/src/api/internal/debugViewer.ts +90 -90
  80. package/src/api/internal/lensRendering.ts +9 -9
  81. package/src/api/internal/sceneSetup.ts +205 -205
  82. package/src/api/manager/animationManager.ts +143 -143
  83. package/src/api/manager/gltfExportManager.ts +236 -236
  84. package/src/api/manager/sceneManager.ts +132 -132
  85. package/src/api/manager/textureLoadManager.ts +95 -95
  86. package/src/api/manager/variantInstanceManager.ts +265 -265
  87. package/src/api/store/specStorage.ts +51 -51
  88. package/src/api/util/babylonHelper.ts +663 -663
  89. package/src/api/util/globalTypes.ts +437 -432
  90. package/src/api/util/resourceHelper.ts +191 -191
  91. package/src/api/util/sceneLoaderHelper.ts +137 -137
  92. package/src/api/util/stringHelper.ts +23 -23
  93. package/src/api/util/structureHelper.ts +49 -49
  94. package/src/buildinfo.json +3 -3
  95. package/src/dev.ts +61 -61
  96. package/src/index.ts +96 -96
  97. package/src/types.d.ts +28 -28
@@ -1,131 +1,131 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.SceneManager = void 0;
13
- const event_1 = require("../classes/event");
14
- const parameter_1 = require("../classes/parameter");
15
- const parameterObservable_1 = require("../classes/parameterObservable");
16
- const specStorage_1 = require("../store/specStorage");
17
- const babylonHelper_1 = require("../util/babylonHelper");
18
- const resourceHelper_1 = require("../util/resourceHelper");
19
- const textureLoadManager_1 = require("./textureLoadManager");
20
- const lodash_es_1 = require("lodash-es");
21
- class SceneManager extends parameterObservable_1.ParameterObservable {
22
- /**
23
- * Constructor.
24
- */
25
- constructor(scene) {
26
- super();
27
- this.scene = scene;
28
- this._parameterObservers = new Map();
29
- this._textureLoadManager = null;
30
- this._textureLoadManager = textureLoadManager_1.TextureLoadManager.create(scene);
31
- this.addParameterObservers();
32
- }
33
- /**
34
- * Creates a {@link SceneManager} based on given BabylonJS scene.
35
- */
36
- static create(scene) {
37
- return __awaiter(this, void 0, void 0, function* () {
38
- const sceneManager = new SceneManager(scene);
39
- yield sceneManager.bootstrapParameters(specStorage_1.SpecStorage.get('scene.parameters'));
40
- return sceneManager;
41
- });
42
- }
43
- /**
44
- * The active `Camera`.
45
- */
46
- get activeCamera() {
47
- if (!this.scene.activeCamera) {
48
- throw new Error('Scene has no active camera.');
49
- }
50
- return this.scene.activeCamera;
51
- }
52
- /**
53
- * Places the given {@link ParameterBag} in the {@link SceneManager}'s parameters, replaces all patterns in the
54
- * {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
55
- *
56
- * @emit {@link Event.SCENE_PARAMETER_COMMITTED}
57
- */
58
- commitParameters(parameters) {
59
- return __awaiter(this, void 0, void 0, function* () {
60
- if (!parameters) {
61
- parameters = {};
62
- }
63
- const oldParameters = (0, lodash_es_1.cloneDeep)(this.parameters);
64
- (0, lodash_es_1.merge)(this.parameters, parameters);
65
- // handle parameter observers
66
- let observerPromises = [];
67
- for (const parameter in this.parameters) {
68
- const oldParameterValue = oldParameters[parameter];
69
- const newParameterValue = this.parameters[parameter];
70
- this.assertParameter(parameter_1.Parameter.declarations, parameter, newParameterValue);
71
- if (oldParameterValue === newParameterValue) {
72
- continue;
73
- }
74
- // parameter changed
75
- const parameterObservers = (0, resourceHelper_1.mergeMaps)(this._parameterObservers, this.parameterObservers);
76
- if (parameterObservers.has(parameter)) {
77
- const observers = parameterObservers.get(parameter);
78
- observerPromises = (0, lodash_es_1.concat)(observerPromises, observers.map(observer => {
79
- const observerResult = observer(this, oldParameterValue, newParameterValue);
80
- const observerPromise = Promise.resolve(observerResult);
81
- observerPromise.then(() => {
82
- this.broadcastEvent(event_1.Event.SCENE_PARAMETER_COMMITTED, this, parameter, oldParameterValue, newParameterValue);
83
- });
84
- return observerPromise;
85
- }));
86
- }
87
- }
88
- yield Promise.all(observerPromises);
89
- return this;
90
- });
91
- }
92
- addParameterObservers() {
93
- const handleEnvParamChange = (manager, oldValue, newValue) => {
94
- const params = {
95
- color: manager.parameters[parameter_1.Parameter.ENVIRONMENT_COLOR],
96
- intensity: manager.parameters[parameter_1.Parameter.ENVIRONMENT_INTENSITY],
97
- env: manager.parameters[parameter_1.Parameter.ENVIRONMENT],
98
- background: manager.parameters[parameter_1.Parameter.ENVIRONMENT_BACKGROUND],
99
- rotation: manager.parameters[parameter_1.Parameter.ENVIRONMENT_ROTATION],
100
- useDefault: manager.parameters[parameter_1.Parameter.ENVIRONMENT_USEDEFAULT],
101
- };
102
- const envDef = {
103
- environmentColor: params.color ? parameter_1.Parameter.parseColor(params.color) : undefined,
104
- environmentIntensity: params.intensity !== undefined ? parameter_1.Parameter.parseNumber(params.intensity) : undefined,
105
- environment: params.env ? params.env : undefined,
106
- environmentBackground: params.background ? params.background : undefined,
107
- environmentRotation: params.rotation !== undefined ? parameter_1.Parameter.parseNumber(params.rotation) : undefined,
108
- environmentUseDefault: params.useDefault ? parameter_1.Parameter.parseBoolean(params.useDefault) : undefined,
109
- };
110
- (0, babylonHelper_1.changeEnvironment)(manager.scene, envDef);
111
- };
112
- this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_COLOR, [handleEnvParamChange]);
113
- this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_ROTATION, [handleEnvParamChange]);
114
- this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_USEDEFAULT, [handleEnvParamChange]);
115
- this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT, [handleEnvParamChange]);
116
- this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_BACKGROUND, [handleEnvParamChange]);
117
- this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_INTENSITY, [handleEnvParamChange]);
118
- return this;
119
- }
120
- /**
121
- * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
122
- */
123
- bootstrapParameters(parameters) {
124
- return __awaiter(this, void 0, void 0, function* () {
125
- yield this.commitParameters((0, lodash_es_1.merge)((0, lodash_es_1.cloneDeep)(this.parameters), parameters));
126
- return this;
127
- });
128
- }
129
- }
130
- exports.SceneManager = SceneManager;
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.SceneManager = void 0;
13
+ const event_1 = require("../classes/event");
14
+ const parameter_1 = require("../classes/parameter");
15
+ const parameterObservable_1 = require("../classes/parameterObservable");
16
+ const specStorage_1 = require("../store/specStorage");
17
+ const babylonHelper_1 = require("../util/babylonHelper");
18
+ const resourceHelper_1 = require("../util/resourceHelper");
19
+ const textureLoadManager_1 = require("./textureLoadManager");
20
+ const lodash_es_1 = require("lodash-es");
21
+ class SceneManager extends parameterObservable_1.ParameterObservable {
22
+ /**
23
+ * Constructor.
24
+ */
25
+ constructor(scene) {
26
+ super();
27
+ this.scene = scene;
28
+ this._parameterObservers = new Map();
29
+ this._textureLoadManager = null;
30
+ this._textureLoadManager = textureLoadManager_1.TextureLoadManager.create(scene);
31
+ this.addParameterObservers();
32
+ }
33
+ /**
34
+ * Creates a {@link SceneManager} based on given BabylonJS scene.
35
+ */
36
+ static create(scene) {
37
+ return __awaiter(this, void 0, void 0, function* () {
38
+ const sceneManager = new SceneManager(scene);
39
+ yield sceneManager.bootstrapParameters(specStorage_1.SpecStorage.get('scene.parameters'));
40
+ return sceneManager;
41
+ });
42
+ }
43
+ /**
44
+ * The active `Camera`.
45
+ */
46
+ get activeCamera() {
47
+ if (!this.scene.activeCamera) {
48
+ throw new Error('Scene has no active camera.');
49
+ }
50
+ return this.scene.activeCamera;
51
+ }
52
+ /**
53
+ * Places the given {@link ParameterBag} in the {@link SceneManager}'s parameters, replaces all patterns in the
54
+ * {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
55
+ *
56
+ * @emit {@link Event.SCENE_PARAMETER_COMMITTED}
57
+ */
58
+ commitParameters(parameters) {
59
+ return __awaiter(this, void 0, void 0, function* () {
60
+ if (!parameters) {
61
+ parameters = {};
62
+ }
63
+ const oldParameters = (0, lodash_es_1.cloneDeep)(this.parameters);
64
+ (0, lodash_es_1.merge)(this.parameters, parameters);
65
+ // handle parameter observers
66
+ let observerPromises = [];
67
+ for (const parameter in this.parameters) {
68
+ const oldParameterValue = oldParameters[parameter];
69
+ const newParameterValue = this.parameters[parameter];
70
+ this.assertParameter(parameter_1.Parameter.declarations, parameter, newParameterValue);
71
+ if (oldParameterValue === newParameterValue) {
72
+ continue;
73
+ }
74
+ // parameter changed
75
+ const parameterObservers = (0, resourceHelper_1.mergeMaps)(this._parameterObservers, this.parameterObservers);
76
+ if (parameterObservers.has(parameter)) {
77
+ const observers = parameterObservers.get(parameter);
78
+ observerPromises = (0, lodash_es_1.concat)(observerPromises, observers.map(observer => {
79
+ const observerResult = observer(this, oldParameterValue, newParameterValue);
80
+ const observerPromise = Promise.resolve(observerResult);
81
+ observerPromise.then(() => {
82
+ this.broadcastEvent(event_1.Event.SCENE_PARAMETER_COMMITTED, this, parameter, oldParameterValue, newParameterValue);
83
+ });
84
+ return observerPromise;
85
+ }));
86
+ }
87
+ }
88
+ yield Promise.all(observerPromises);
89
+ return this;
90
+ });
91
+ }
92
+ addParameterObservers() {
93
+ const handleEnvParamChange = (manager, oldValue, newValue) => {
94
+ const params = {
95
+ color: manager.parameters[parameter_1.Parameter.ENVIRONMENT_COLOR],
96
+ intensity: manager.parameters[parameter_1.Parameter.ENVIRONMENT_INTENSITY],
97
+ env: manager.parameters[parameter_1.Parameter.ENVIRONMENT],
98
+ background: manager.parameters[parameter_1.Parameter.ENVIRONMENT_BACKGROUND],
99
+ rotation: manager.parameters[parameter_1.Parameter.ENVIRONMENT_ROTATION],
100
+ useDefault: manager.parameters[parameter_1.Parameter.ENVIRONMENT_USEDEFAULT],
101
+ };
102
+ const envDef = {
103
+ environmentColor: params.color ? parameter_1.Parameter.parseColor(params.color) : undefined,
104
+ environmentIntensity: params.intensity !== undefined ? parameter_1.Parameter.parseNumber(params.intensity) : undefined,
105
+ environment: params.env ? params.env : undefined,
106
+ environmentBackground: params.background ? params.background : undefined,
107
+ environmentRotation: params.rotation !== undefined ? parameter_1.Parameter.parseNumber(params.rotation) : undefined,
108
+ environmentUseDefault: params.useDefault ? parameter_1.Parameter.parseBoolean(params.useDefault) : undefined,
109
+ };
110
+ (0, babylonHelper_1.changeEnvironment)(manager.scene, envDef);
111
+ };
112
+ this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_COLOR, [handleEnvParamChange]);
113
+ this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_ROTATION, [handleEnvParamChange]);
114
+ this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_USEDEFAULT, [handleEnvParamChange]);
115
+ this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT, [handleEnvParamChange]);
116
+ this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_BACKGROUND, [handleEnvParamChange]);
117
+ this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_INTENSITY, [handleEnvParamChange]);
118
+ return this;
119
+ }
120
+ /**
121
+ * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
122
+ */
123
+ bootstrapParameters(parameters) {
124
+ return __awaiter(this, void 0, void 0, function* () {
125
+ yield this.commitParameters((0, lodash_es_1.merge)((0, lodash_es_1.cloneDeep)(this.parameters), parameters));
126
+ return this;
127
+ });
128
+ }
129
+ }
130
+ exports.SceneManager = SceneManager;
131
131
  //# sourceMappingURL=sceneManager.js.map
@@ -1,22 +1,22 @@
1
- import { EventBroadcaster } from '../classes/eventBroadcaster';
2
- import { Scene as BabylonScene } from '@babylonjs/core/scene';
3
- /**
4
- * Keeps track of all texture loading/ready states and fires {@link Event.TEXTURE_LOADING_START} and
5
- * {@link Event.TEXTURE_LOADING_END} events.
6
- */
7
- export declare class TextureLoadManager extends EventBroadcaster {
8
- scene: BabylonScene;
9
- private readonly _loadingTextures;
10
- private _readyStatePollingIntervalMs;
11
- private _readyStatePollingId;
12
- private constructor();
13
- static create(scene: BabylonScene): TextureLoadManager;
14
- private startReadyStatePollingIfNeeded;
15
- private endReadyStatePollingIfNeeded;
16
- /**
17
- * Checks the "ready state" of all textures inside the `this._loadingTextures` map, removes the ready ones and fires
18
- * the {@link Event.TEXTURE_LOADING_END} event if no more textures are loading (i.e. "all ready").
19
- */
20
- private checkLoadingTexturesState;
21
- private onTextureAdded;
22
- }
1
+ import { EventBroadcaster } from '../classes/eventBroadcaster';
2
+ import { Scene as BabylonScene } from '@babylonjs/core/scene';
3
+ /**
4
+ * Keeps track of all texture loading/ready states and fires {@link Event.TEXTURE_LOADING_START} and
5
+ * {@link Event.TEXTURE_LOADING_END} events.
6
+ */
7
+ export declare class TextureLoadManager extends EventBroadcaster {
8
+ scene: BabylonScene;
9
+ private readonly _loadingTextures;
10
+ private _readyStatePollingIntervalMs;
11
+ private _readyStatePollingId;
12
+ private constructor();
13
+ static create(scene: BabylonScene): TextureLoadManager;
14
+ private startReadyStatePollingIfNeeded;
15
+ private endReadyStatePollingIfNeeded;
16
+ /**
17
+ * Checks the "ready state" of all textures inside the `this._loadingTextures` map, removes the ready ones and fires
18
+ * the {@link Event.TEXTURE_LOADING_END} event if no more textures are loading (i.e. "all ready").
19
+ */
20
+ private checkLoadingTexturesState;
21
+ private onTextureAdded;
22
+ }
@@ -1,98 +1,98 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.TextureLoadManager = void 0;
13
- const event_1 = require("../classes/event");
14
- const eventBroadcaster_1 = require("../classes/eventBroadcaster");
15
- const babylonHelper_1 = require("../util/babylonHelper");
16
- const resourceHelper_1 = require("../util/resourceHelper");
17
- /**
18
- * Keeps track of all texture loading/ready states and fires {@link Event.TEXTURE_LOADING_START} and
19
- * {@link Event.TEXTURE_LOADING_END} events.
20
- */
21
- class TextureLoadManager extends eventBroadcaster_1.EventBroadcaster {
22
- constructor(scene) {
23
- super();
24
- this.scene = scene;
25
- // We're keeping track of all "loading textures" in this map ourselves instead of relying on information from
26
- // `scene.textures` as that proved to be rather unreliable for our use cases.
27
- // E.g. see this forums post for some more information:
28
- // https://forum.babylonjs.com/t/using-scene-createdefaultenvironment-removes-textures-from-scene/35267
29
- this._loadingTextures = new Map();
30
- // Whenever we fire the {@link Event.TEXTURE_LOADING_START} event, we're starting a polling service which checks all
31
- // x ms if all awaited textures are in "ready state" or not.
32
- // This is basically just an additional safety net in addition to our `onLoadObservable`s and was added to prevent
33
- // situations where a {@link Event.TEXTURE_LOADING_START} event is fired without an accompanying
34
- // {@link Event.TEXTURE_LOADING_END} as that is a situation which can lead to load masks being endlessly shown in a
35
- // cfgr.
36
- // In theory this shouldn't be necessary, but we've already discovered some quirks and inconsistent behavior around
37
- // the texture load observables etc. and I felt more save with this safety net in place.
38
- this._readyStatePollingIntervalMs = 200;
39
- this._readyStatePollingId = 0;
40
- this.scene.onNewTextureAddedObservable.add(texture => this.onTextureAdded(texture));
41
- }
42
- static create(scene) {
43
- const loadMgr = new TextureLoadManager(scene);
44
- return loadMgr;
45
- }
46
- startReadyStatePollingIfNeeded() {
47
- if (!this._readyStatePollingId) {
48
- this._readyStatePollingId = window.setInterval(() => this.checkLoadingTexturesState(), this._readyStatePollingIntervalMs);
49
- }
50
- }
51
- endReadyStatePollingIfNeeded() {
52
- if (this._readyStatePollingId) {
53
- window.clearInterval(this._readyStatePollingId);
54
- this._readyStatePollingId = 0;
55
- }
56
- }
57
- /**
58
- * Checks the "ready state" of all textures inside the `this._loadingTextures` map, removes the ready ones and fires
59
- * the {@link Event.TEXTURE_LOADING_END} event if no more textures are loading (i.e. "all ready").
60
- */
61
- checkLoadingTexturesState() {
62
- const allTexturesReadyBefore = !this._loadingTextures.size;
63
- if (allTexturesReadyBefore)
64
- return;
65
- // Remove textures which are in "ready state" from the map
66
- for (const [id, texture] of this._loadingTextures) {
67
- if (texture.isReady())
68
- this._loadingTextures.delete(id);
69
- }
70
- const allTexturesReadyAfter = !this._loadingTextures.size;
71
- if (allTexturesReadyAfter) {
72
- this.broadcastEvent(event_1.Event.TEXTURE_LOADING_END);
73
- this.endReadyStatePollingIfNeeded();
74
- }
75
- }
76
- onTextureAdded(texture) {
77
- return __awaiter(this, void 0, void 0, function* () {
78
- // Workaround:
79
- // The texture object is not fully created when the "added observable" is called. E.g. the function
80
- // `onLoadObservable` is not there at that point.
81
- // More details: https://forum.babylonjs.com/t/basetexture-whenallready-returns-too-early/34501/4
82
- yield (0, resourceHelper_1.sleep)(0);
83
- // Some textures are already in "ready state" after the sleep -> We don't care for them anymore as well as for
84
- // textures which don't come with an `onLoadObservable` (i.e. not of class {@link Texture}).
85
- if (texture.isReady() || !(0, babylonHelper_1.isTextureWithOnLoadObservable)(texture))
86
- return;
87
- const noCurrentLoadingTextures = !this._loadingTextures.size;
88
- if (noCurrentLoadingTextures) {
89
- this.broadcastEvent(event_1.Event.TEXTURE_LOADING_START);
90
- this.startReadyStatePollingIfNeeded();
91
- }
92
- this._loadingTextures.set(texture.uniqueId, texture);
93
- texture.onLoadObservable.addOnce(texture => this.checkLoadingTexturesState());
94
- });
95
- }
96
- }
97
- exports.TextureLoadManager = TextureLoadManager;
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.TextureLoadManager = void 0;
13
+ const event_1 = require("../classes/event");
14
+ const eventBroadcaster_1 = require("../classes/eventBroadcaster");
15
+ const babylonHelper_1 = require("../util/babylonHelper");
16
+ const resourceHelper_1 = require("../util/resourceHelper");
17
+ /**
18
+ * Keeps track of all texture loading/ready states and fires {@link Event.TEXTURE_LOADING_START} and
19
+ * {@link Event.TEXTURE_LOADING_END} events.
20
+ */
21
+ class TextureLoadManager extends eventBroadcaster_1.EventBroadcaster {
22
+ constructor(scene) {
23
+ super();
24
+ this.scene = scene;
25
+ // We're keeping track of all "loading textures" in this map ourselves instead of relying on information from
26
+ // `scene.textures` as that proved to be rather unreliable for our use cases.
27
+ // E.g. see this forums post for some more information:
28
+ // https://forum.babylonjs.com/t/using-scene-createdefaultenvironment-removes-textures-from-scene/35267
29
+ this._loadingTextures = new Map();
30
+ // Whenever we fire the {@link Event.TEXTURE_LOADING_START} event, we're starting a polling service which checks all
31
+ // x ms if all awaited textures are in "ready state" or not.
32
+ // This is basically just an additional safety net in addition to our `onLoadObservable`s and was added to prevent
33
+ // situations where a {@link Event.TEXTURE_LOADING_START} event is fired without an accompanying
34
+ // {@link Event.TEXTURE_LOADING_END} as that is a situation which can lead to load masks being endlessly shown in a
35
+ // cfgr.
36
+ // In theory this shouldn't be necessary, but we've already discovered some quirks and inconsistent behavior around
37
+ // the texture load observables etc. and I felt more save with this safety net in place.
38
+ this._readyStatePollingIntervalMs = 200;
39
+ this._readyStatePollingId = 0;
40
+ this.scene.onNewTextureAddedObservable.add(texture => this.onTextureAdded(texture));
41
+ }
42
+ static create(scene) {
43
+ const loadMgr = new TextureLoadManager(scene);
44
+ return loadMgr;
45
+ }
46
+ startReadyStatePollingIfNeeded() {
47
+ if (!this._readyStatePollingId) {
48
+ this._readyStatePollingId = window.setInterval(() => this.checkLoadingTexturesState(), this._readyStatePollingIntervalMs);
49
+ }
50
+ }
51
+ endReadyStatePollingIfNeeded() {
52
+ if (this._readyStatePollingId) {
53
+ window.clearInterval(this._readyStatePollingId);
54
+ this._readyStatePollingId = 0;
55
+ }
56
+ }
57
+ /**
58
+ * Checks the "ready state" of all textures inside the `this._loadingTextures` map, removes the ready ones and fires
59
+ * the {@link Event.TEXTURE_LOADING_END} event if no more textures are loading (i.e. "all ready").
60
+ */
61
+ checkLoadingTexturesState() {
62
+ const allTexturesReadyBefore = !this._loadingTextures.size;
63
+ if (allTexturesReadyBefore)
64
+ return;
65
+ // Remove textures which are in "ready state" from the map
66
+ for (const [id, texture] of this._loadingTextures) {
67
+ if (texture.isReady())
68
+ this._loadingTextures.delete(id);
69
+ }
70
+ const allTexturesReadyAfter = !this._loadingTextures.size;
71
+ if (allTexturesReadyAfter) {
72
+ this.broadcastEvent(event_1.Event.TEXTURE_LOADING_END);
73
+ this.endReadyStatePollingIfNeeded();
74
+ }
75
+ }
76
+ onTextureAdded(texture) {
77
+ return __awaiter(this, void 0, void 0, function* () {
78
+ // Workaround:
79
+ // The texture object is not fully created when the "added observable" is called. E.g. the function
80
+ // `onLoadObservable` is not there at that point.
81
+ // More details: https://forum.babylonjs.com/t/basetexture-whenallready-returns-too-early/34501/4
82
+ yield (0, resourceHelper_1.sleep)(0);
83
+ // Some textures are already in "ready state" after the sleep -> We don't care for them anymore as well as for
84
+ // textures which don't come with an `onLoadObservable` (i.e. not of class {@link Texture}).
85
+ if (texture.isReady() || !(0, babylonHelper_1.isTextureWithOnLoadObservable)(texture))
86
+ return;
87
+ const noCurrentLoadingTextures = !this._loadingTextures.size;
88
+ if (noCurrentLoadingTextures) {
89
+ this.broadcastEvent(event_1.Event.TEXTURE_LOADING_START);
90
+ this.startReadyStatePollingIfNeeded();
91
+ }
92
+ this._loadingTextures.set(texture.uniqueId, texture);
93
+ texture.onLoadObservable.addOnce(texture => this.checkLoadingTexturesState());
94
+ });
95
+ }
96
+ }
97
+ exports.TextureLoadManager = TextureLoadManager;
98
98
  //# sourceMappingURL=textureLoadManager.js.map