@combeenation/3d-viewer 12.4.1 → 13.0.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.
- package/dist/lib-cjs/buildinfo.json +1 -1
- package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
- package/dist/lib-cjs/index.d.ts +63 -63
- package/dist/lib-cjs/index.js +81 -114
- package/dist/lib-cjs/index.js.map +1 -1
- package/dist/lib-cjs/internal/cbnCustomBabylonLoaderPlugin.d.ts +10 -0
- package/dist/lib-cjs/internal/cbnCustomBabylonLoaderPlugin.js +124 -0
- package/dist/lib-cjs/internal/cbnCustomBabylonLoaderPlugin.js.map +1 -0
- package/dist/lib-cjs/internal/cloningHelper.d.ts +19 -0
- package/dist/lib-cjs/internal/cloningHelper.js +165 -0
- package/dist/lib-cjs/internal/cloningHelper.js.map +1 -0
- package/dist/lib-cjs/internal/deviceHelper.d.ts +9 -0
- package/dist/lib-cjs/{api/util → internal}/deviceHelper.js +6 -10
- package/dist/lib-cjs/internal/deviceHelper.js.map +1 -0
- package/dist/lib-cjs/internal/geometryHelper.d.ts +21 -0
- package/dist/lib-cjs/{api/util → internal}/geometryHelper.js +57 -24
- package/dist/lib-cjs/internal/geometryHelper.js.map +1 -0
- package/dist/lib-cjs/internal/metadataHelper.d.ts +26 -0
- package/dist/lib-cjs/internal/metadataHelper.js +51 -0
- package/dist/lib-cjs/internal/metadataHelper.js.map +1 -0
- package/dist/lib-cjs/internal/paintableHelper.d.ts +40 -0
- package/dist/lib-cjs/internal/paintableHelper.js +287 -0
- package/dist/lib-cjs/internal/paintableHelper.js.map +1 -0
- package/dist/lib-cjs/internal/tagsHelper.d.ts +12 -0
- package/dist/lib-cjs/internal/tagsHelper.js +38 -0
- package/dist/lib-cjs/internal/tagsHelper.js.map +1 -0
- package/dist/lib-cjs/manager/cameraManager.d.ts +51 -0
- package/dist/lib-cjs/manager/cameraManager.js +154 -0
- package/dist/lib-cjs/manager/cameraManager.js.map +1 -0
- package/dist/lib-cjs/manager/debugManager.d.ts +60 -0
- package/dist/lib-cjs/manager/debugManager.js +218 -0
- package/dist/lib-cjs/manager/debugManager.js.map +1 -0
- package/dist/lib-cjs/manager/eventManager.d.ts +52 -0
- package/dist/lib-cjs/manager/eventManager.js +72 -0
- package/dist/lib-cjs/manager/eventManager.js.map +1 -0
- package/dist/lib-cjs/{api/manager → manager}/gltfExportManager.d.ts +29 -34
- package/dist/lib-cjs/{api/manager → manager}/gltfExportManager.js +99 -120
- package/dist/lib-cjs/manager/gltfExportManager.js.map +1 -0
- package/dist/lib-cjs/manager/materialManager.d.ts +35 -0
- package/dist/lib-cjs/manager/materialManager.js +126 -0
- package/dist/lib-cjs/manager/materialManager.js.map +1 -0
- package/dist/lib-cjs/manager/modelManager.d.ts +145 -0
- package/dist/lib-cjs/manager/modelManager.js +381 -0
- package/dist/lib-cjs/manager/modelManager.js.map +1 -0
- package/dist/lib-cjs/manager/parameterManager.d.ts +210 -0
- package/dist/lib-cjs/manager/parameterManager.js +515 -0
- package/dist/lib-cjs/manager/parameterManager.js.map +1 -0
- package/dist/lib-cjs/manager/sceneManager.d.ts +45 -0
- package/dist/lib-cjs/manager/sceneManager.js +65 -0
- package/dist/lib-cjs/manager/sceneManager.js.map +1 -0
- package/dist/lib-cjs/manager/screenshotManager.d.ts +36 -0
- package/dist/lib-cjs/manager/screenshotManager.js +40 -0
- package/dist/lib-cjs/manager/screenshotManager.js.map +1 -0
- package/dist/lib-cjs/manager/textureManager.d.ts +12 -0
- package/dist/lib-cjs/manager/textureManager.js +44 -0
- package/dist/lib-cjs/manager/textureManager.js.map +1 -0
- package/dist/lib-cjs/viewer.d.ts +117 -0
- package/dist/lib-cjs/viewer.js +222 -0
- package/dist/lib-cjs/viewer.js.map +1 -0
- package/dist/lib-cjs/{api/classes/viewerError.d.ts → viewerError.d.ts} +6 -1
- package/dist/lib-cjs/{api/classes/viewerError.js → viewerError.js} +6 -1
- package/dist/lib-cjs/viewerError.js.map +1 -0
- package/package.json +10 -11
- package/src/dev.ts +14 -37
- package/src/{types.d.ts → globalTypes.d.ts} +8 -18
- package/src/index.ts +79 -113
- package/src/internal/cbnCustomBabylonLoaderPlugin.ts +149 -0
- package/src/internal/cloningHelper.ts +225 -0
- package/src/internal/deviceHelper.ts +25 -0
- package/src/{api/util → internal}/geometryHelper.ts +63 -24
- package/src/internal/metadataHelper.ts +63 -0
- package/src/internal/paintableHelper.ts +310 -0
- package/src/internal/tagsHelper.ts +41 -0
- package/src/manager/cameraManager.ts +236 -0
- package/src/manager/debugManager.ts +245 -0
- package/src/manager/eventManager.ts +72 -0
- package/src/{api/manager → manager}/gltfExportManager.ts +132 -125
- package/src/manager/materialManager.ts +135 -0
- package/src/manager/modelManager.ts +456 -0
- package/src/manager/parameterManager.ts +652 -0
- package/src/manager/sceneManager.ts +101 -0
- package/src/manager/screenshotManager.ts +59 -0
- package/src/manager/textureManager.ts +32 -0
- package/src/viewer.ts +296 -0
- package/src/{api/classes/viewerError.ts → viewerError.ts} +6 -1
- package/dist/lib-cjs/api/classes/animationInterface.d.ts +0 -8
- package/dist/lib-cjs/api/classes/animationInterface.js +0 -3
- package/dist/lib-cjs/api/classes/animationInterface.js.map +0 -1
- package/dist/lib-cjs/api/classes/dottedPath.d.ts +0 -79
- package/dist/lib-cjs/api/classes/dottedPath.js +0 -167
- package/dist/lib-cjs/api/classes/dottedPath.js.map +0 -1
- package/dist/lib-cjs/api/classes/element.d.ts +0 -153
- package/dist/lib-cjs/api/classes/element.js +0 -703
- package/dist/lib-cjs/api/classes/element.js.map +0 -1
- package/dist/lib-cjs/api/classes/event.d.ts +0 -401
- package/dist/lib-cjs/api/classes/event.js +0 -425
- package/dist/lib-cjs/api/classes/event.js.map +0 -1
- package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +0 -26
- package/dist/lib-cjs/api/classes/eventBroadcaster.js +0 -50
- package/dist/lib-cjs/api/classes/eventBroadcaster.js.map +0 -1
- package/dist/lib-cjs/api/classes/fuzzyMap.d.ts +0 -7
- package/dist/lib-cjs/api/classes/fuzzyMap.js +0 -22
- package/dist/lib-cjs/api/classes/fuzzyMap.js.map +0 -1
- package/dist/lib-cjs/api/classes/parameter.d.ts +0 -410
- package/dist/lib-cjs/api/classes/parameter.js +0 -643
- package/dist/lib-cjs/api/classes/parameter.js.map +0 -1
- package/dist/lib-cjs/api/classes/parameterObservable.d.ts +0 -36
- package/dist/lib-cjs/api/classes/parameterObservable.js +0 -73
- package/dist/lib-cjs/api/classes/parameterObservable.js.map +0 -1
- package/dist/lib-cjs/api/classes/parameterizable.d.ts +0 -15
- package/dist/lib-cjs/api/classes/parameterizable.js +0 -103
- package/dist/lib-cjs/api/classes/parameterizable.js.map +0 -1
- package/dist/lib-cjs/api/classes/placementAnimation.d.ts +0 -45
- package/dist/lib-cjs/api/classes/placementAnimation.js +0 -177
- package/dist/lib-cjs/api/classes/placementAnimation.js.map +0 -1
- package/dist/lib-cjs/api/classes/variant.d.ts +0 -261
- package/dist/lib-cjs/api/classes/variant.js +0 -873
- package/dist/lib-cjs/api/classes/variant.js.map +0 -1
- package/dist/lib-cjs/api/classes/variantInstance.d.ts +0 -53
- package/dist/lib-cjs/api/classes/variantInstance.js +0 -126
- package/dist/lib-cjs/api/classes/variantInstance.js.map +0 -1
- package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +0 -17
- package/dist/lib-cjs/api/classes/variantParameterizable.js +0 -87
- package/dist/lib-cjs/api/classes/variantParameterizable.js.map +0 -1
- package/dist/lib-cjs/api/classes/viewer.d.ts +0 -215
- package/dist/lib-cjs/api/classes/viewer.js +0 -709
- package/dist/lib-cjs/api/classes/viewer.js.map +0 -1
- package/dist/lib-cjs/api/classes/viewerError.js.map +0 -1
- package/dist/lib-cjs/api/classes/viewerLight.d.ts +0 -66
- package/dist/lib-cjs/api/classes/viewerLight.js +0 -345
- package/dist/lib-cjs/api/classes/viewerLight.js.map +0 -1
- package/dist/lib-cjs/api/internal/lensRendering.d.ts +0 -8
- package/dist/lib-cjs/api/internal/lensRendering.js +0 -12
- package/dist/lib-cjs/api/internal/lensRendering.js.map +0 -1
- package/dist/lib-cjs/api/internal/sceneSetup.d.ts +0 -13
- package/dist/lib-cjs/api/internal/sceneSetup.js +0 -228
- package/dist/lib-cjs/api/internal/sceneSetup.js.map +0 -1
- package/dist/lib-cjs/api/manager/animationManager.d.ts +0 -30
- package/dist/lib-cjs/api/manager/animationManager.js +0 -127
- package/dist/lib-cjs/api/manager/animationManager.js.map +0 -1
- package/dist/lib-cjs/api/manager/gltfExportManager.js.map +0 -1
- package/dist/lib-cjs/api/manager/sceneManager.d.ts +0 -33
- package/dist/lib-cjs/api/manager/sceneManager.js +0 -129
- package/dist/lib-cjs/api/manager/sceneManager.js.map +0 -1
- package/dist/lib-cjs/api/manager/tagManager.d.ts +0 -118
- package/dist/lib-cjs/api/manager/tagManager.js +0 -531
- package/dist/lib-cjs/api/manager/tagManager.js.map +0 -1
- package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +0 -22
- package/dist/lib-cjs/api/manager/textureLoadManager.js +0 -108
- package/dist/lib-cjs/api/manager/textureLoadManager.js.map +0 -1
- package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +0 -106
- package/dist/lib-cjs/api/manager/variantInstanceManager.js +0 -291
- package/dist/lib-cjs/api/manager/variantInstanceManager.js.map +0 -1
- package/dist/lib-cjs/api/store/specStorage.d.ts +0 -32
- package/dist/lib-cjs/api/store/specStorage.js +0 -66
- package/dist/lib-cjs/api/store/specStorage.js.map +0 -1
- package/dist/lib-cjs/api/util/babylonHelper.d.ts +0 -238
- package/dist/lib-cjs/api/util/babylonHelper.js +0 -826
- package/dist/lib-cjs/api/util/babylonHelper.js.map +0 -1
- package/dist/lib-cjs/api/util/debugHelper.d.ts +0 -9
- package/dist/lib-cjs/api/util/debugHelper.js +0 -94
- package/dist/lib-cjs/api/util/debugHelper.js.map +0 -1
- package/dist/lib-cjs/api/util/deviceHelper.d.ts +0 -9
- package/dist/lib-cjs/api/util/deviceHelper.js.map +0 -1
- package/dist/lib-cjs/api/util/geometryHelper.d.ts +0 -17
- package/dist/lib-cjs/api/util/geometryHelper.js.map +0 -1
- package/dist/lib-cjs/api/util/globalTypes.d.ts +0 -490
- package/dist/lib-cjs/api/util/globalTypes.js +0 -2
- package/dist/lib-cjs/api/util/globalTypes.js.map +0 -1
- package/dist/lib-cjs/api/util/resourceHelper.d.ts +0 -58
- package/dist/lib-cjs/api/util/resourceHelper.js +0 -215
- package/dist/lib-cjs/api/util/resourceHelper.js.map +0 -1
- package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +0 -58
- package/dist/lib-cjs/api/util/sceneLoaderHelper.js +0 -229
- package/dist/lib-cjs/api/util/sceneLoaderHelper.js.map +0 -1
- package/dist/lib-cjs/api/util/stringHelper.d.ts +0 -13
- package/dist/lib-cjs/api/util/stringHelper.js +0 -33
- package/dist/lib-cjs/api/util/stringHelper.js.map +0 -1
- package/dist/lib-cjs/api/util/structureHelper.d.ts +0 -9
- package/dist/lib-cjs/api/util/structureHelper.js +0 -58
- package/dist/lib-cjs/api/util/structureHelper.js.map +0 -1
- package/src/api/classes/animationInterface.ts +0 -10
- package/src/api/classes/dottedPath.ts +0 -181
- package/src/api/classes/element.ts +0 -766
- package/src/api/classes/event.ts +0 -457
- package/src/api/classes/eventBroadcaster.ts +0 -52
- package/src/api/classes/fuzzyMap.ts +0 -21
- package/src/api/classes/parameter.ts +0 -686
- package/src/api/classes/parameterObservable.ts +0 -73
- package/src/api/classes/parameterizable.ts +0 -87
- package/src/api/classes/placementAnimation.ts +0 -162
- package/src/api/classes/variant.ts +0 -965
- package/src/api/classes/variantInstance.ts +0 -123
- package/src/api/classes/variantParameterizable.ts +0 -83
- package/src/api/classes/viewer.ts +0 -751
- package/src/api/classes/viewerLight.ts +0 -335
- package/src/api/internal/debugViewer.ts +0 -90
- package/src/api/internal/lensRendering.ts +0 -9
- package/src/api/internal/sceneSetup.ts +0 -208
- package/src/api/manager/animationManager.ts +0 -143
- package/src/api/manager/sceneManager.ts +0 -134
- package/src/api/manager/tagManager.ts +0 -572
- package/src/api/manager/textureLoadManager.ts +0 -107
- package/src/api/manager/variantInstanceManager.ts +0 -306
- package/src/api/store/specStorage.ts +0 -68
- package/src/api/util/babylonHelper.ts +0 -915
- package/src/api/util/debugHelper.ts +0 -121
- package/src/api/util/deviceHelper.ts +0 -31
- package/src/api/util/globalTypes.ts +0 -566
- package/src/api/util/resourceHelper.ts +0 -201
- package/src/api/util/sceneLoaderHelper.ts +0 -247
- package/src/api/util/stringHelper.ts +0 -30
- package/src/api/util/structureHelper.ts +0 -62
|
@@ -1,572 +0,0 @@
|
|
|
1
|
-
import { Event, emitter } from '../classes/event';
|
|
2
|
-
import { FuzzyMap } from '../classes/fuzzyMap';
|
|
3
|
-
import { Parameter } from '../classes/parameter';
|
|
4
|
-
import { Viewer } from '../classes/viewer';
|
|
5
|
-
import { ViewerError, ViewerErrorIds } from '../classes/viewerError';
|
|
6
|
-
import {
|
|
7
|
-
assertMeshCapability,
|
|
8
|
-
drawPaintableOnMaterial,
|
|
9
|
-
injectMetadata,
|
|
10
|
-
mapTags,
|
|
11
|
-
setMaterial,
|
|
12
|
-
} from '../util/babylonHelper';
|
|
13
|
-
import { createImageFromImgSrc, createImageFromSvg } from '../util/resourceHelper';
|
|
14
|
-
import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
|
|
15
|
-
import { Tags } from '@babylonjs/core/Misc/tags';
|
|
16
|
-
import isSvg from 'is-svg';
|
|
17
|
-
import { clone, get, merge, uniq } from 'lodash-es';
|
|
18
|
-
|
|
19
|
-
export class TagManager {
|
|
20
|
-
public readonly parameters: TagManagerParameterBag = new FuzzyMap();
|
|
21
|
-
|
|
22
|
-
public readonly parameterObservers: TagManagerParameterObserverBag = new Map();
|
|
23
|
-
|
|
24
|
-
/**
|
|
25
|
-
* Constructor.
|
|
26
|
-
*/
|
|
27
|
-
public constructor(protected viewer: Viewer) {
|
|
28
|
-
this.addParameterObservers();
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
|
|
33
|
-
* nodes with given tagName.
|
|
34
|
-
*/
|
|
35
|
-
public async setTagParameterValue(
|
|
36
|
-
tagName: string,
|
|
37
|
-
parameterName: string,
|
|
38
|
-
value: ParameterValue
|
|
39
|
-
): Promise<TagManagerParameterObserverResultBag> {
|
|
40
|
-
return await this.handleParameter({ tagName: tagName }, parameterName, value);
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
* Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
|
|
45
|
-
* nodes with given nodeName.
|
|
46
|
-
*/
|
|
47
|
-
public async setNodeParameterValue(
|
|
48
|
-
nodeName: string,
|
|
49
|
-
parameterName: string,
|
|
50
|
-
value: ParameterValue
|
|
51
|
-
): Promise<TagManagerParameterObserverResultBag> {
|
|
52
|
-
return await this.handleParameter({ nodeName: nodeName }, parameterName, value);
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
/**
|
|
56
|
-
* Calls the {@link ParameterObserver} for given {@link Parameter} and applies the {@link ParameterValue} on all
|
|
57
|
-
* materials with given materialName.
|
|
58
|
-
*/
|
|
59
|
-
public async setMaterialParameterValue(
|
|
60
|
-
materialName: string,
|
|
61
|
-
parameterName: string,
|
|
62
|
-
value: ParameterValue
|
|
63
|
-
): Promise<TagManagerParameterObserverResultBag> {
|
|
64
|
-
return await this.handleParameter({ materialName: materialName }, parameterName, value);
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
/**
|
|
68
|
-
* Splits the passed {@link TagManagerParameterValue}s into individual values and calls all {@link ParameterObserver}s
|
|
69
|
-
* of all {@link Parameter}s with the respective {@link TagManagerSubject} and {@link ParameterValue}. The result is a
|
|
70
|
-
* map of passed {@link TagManagerParameterValue}s and the associated {@link TagManagerParameterObserverResult} of the
|
|
71
|
-
* {@link ParameterObserver}.
|
|
72
|
-
*/
|
|
73
|
-
public async setParameterValues(
|
|
74
|
-
values: TagManagerParameterValue[]
|
|
75
|
-
): Promise<Map<TagManagerParameterValue, TagManagerParameterObserverResultBag>> {
|
|
76
|
-
const observerResultMap: Map<TagManagerParameterValue, TagManagerParameterObserverResultBag> = new Map();
|
|
77
|
-
const tagPromises: Promise<TagManagerParameterObserverResultBag>[] = [];
|
|
78
|
-
const nodePromises: Promise<TagManagerParameterObserverResultBag>[] = [];
|
|
79
|
-
const materialPromises: Promise<TagManagerParameterObserverResultBag>[] = [];
|
|
80
|
-
for (const value of values) {
|
|
81
|
-
const subject: TagManagerSubject = {};
|
|
82
|
-
if (value.tagName) {
|
|
83
|
-
subject.tagName = value.tagName;
|
|
84
|
-
}
|
|
85
|
-
if (value.nodeName) {
|
|
86
|
-
subject.nodeName = value.nodeName;
|
|
87
|
-
}
|
|
88
|
-
if (value.materialName) {
|
|
89
|
-
subject.materialName = value.materialName;
|
|
90
|
-
}
|
|
91
|
-
const observerResultPromise = this.handleParameter(subject, value.parameterName, value.value);
|
|
92
|
-
observerResultPromise.then(result => observerResultMap.set(value, result));
|
|
93
|
-
if (value.tagName) {
|
|
94
|
-
tagPromises.push(observerResultPromise);
|
|
95
|
-
}
|
|
96
|
-
if (value.nodeName) {
|
|
97
|
-
nodePromises.push(observerResultPromise);
|
|
98
|
-
}
|
|
99
|
-
if (value.materialName) {
|
|
100
|
-
materialPromises.push(observerResultPromise);
|
|
101
|
-
}
|
|
102
|
-
}
|
|
103
|
-
await Promise.all(tagPromises);
|
|
104
|
-
await Promise.all(nodePromises);
|
|
105
|
-
await Promise.all(materialPromises);
|
|
106
|
-
return observerResultMap;
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
/**
|
|
110
|
-
* Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
|
|
111
|
-
* {@link parameters} and the given object.
|
|
112
|
-
*/
|
|
113
|
-
public getSubjectsFor(object: TransformNode | Material): TagManagerSubject[] {
|
|
114
|
-
return [...this.parameters.keys()].filter(
|
|
115
|
-
subject =>
|
|
116
|
-
(subject.tagName && Tags.MatchesQuery(object, subject.tagName)) ||
|
|
117
|
-
(subject.nodeName && object.name === subject.nodeName) ||
|
|
118
|
-
(subject.materialName && object.name === subject.materialName)
|
|
119
|
-
);
|
|
120
|
-
}
|
|
121
|
-
|
|
122
|
-
/**
|
|
123
|
-
* Gets a list of {@link TagManagerSubject}s that are present in both the state of the {@link TagManager}'s
|
|
124
|
-
* {@link parameters} and the given objects.
|
|
125
|
-
*/
|
|
126
|
-
public getApplicableSubjectsFor(objects: (TransformNode | Material)[]): TagManagerSubject[] {
|
|
127
|
-
let applicableSubjects: TagManagerSubject[] = [];
|
|
128
|
-
for (const object of objects) {
|
|
129
|
-
const subjects = this.getSubjectsFor(object);
|
|
130
|
-
applicableSubjects = [...applicableSubjects, ...subjects];
|
|
131
|
-
}
|
|
132
|
-
return uniq(applicableSubjects);
|
|
133
|
-
}
|
|
134
|
-
|
|
135
|
-
/**
|
|
136
|
-
* Applies all existing states of the {@link TagManager}'s {@link parameters} for given {@link TagManagerSubject}s.
|
|
137
|
-
*/
|
|
138
|
-
public async applyExistingParameterValuesFor(
|
|
139
|
-
subjects: TagManagerSubject[]
|
|
140
|
-
): Promise<Map<TagManagerSubject, TagManagerParameterObserverResultBag>> {
|
|
141
|
-
const observerResultMap: Map<TagManagerSubject, TagManagerParameterObserverResultBag> = new Map();
|
|
142
|
-
let tagPromises: Promise<TagManagerParameterObserverResultBag>[] = [];
|
|
143
|
-
let nodePromises: Promise<TagManagerParameterObserverResultBag>[] = [];
|
|
144
|
-
let materialPromises: Promise<TagManagerParameterObserverResultBag>[] = [];
|
|
145
|
-
for (const subject of subjects) {
|
|
146
|
-
const observerResultPromises = this.handleParameterBag(subject, this.parameters.get(subject)!);
|
|
147
|
-
for (const observerResultPromise of observerResultPromises) {
|
|
148
|
-
observerResultPromise.then(result => observerResultMap.set(subject, result));
|
|
149
|
-
}
|
|
150
|
-
if (subject.tagName) {
|
|
151
|
-
tagPromises = [...tagPromises, ...observerResultPromises];
|
|
152
|
-
}
|
|
153
|
-
if (subject.nodeName) {
|
|
154
|
-
nodePromises = [...nodePromises, ...observerResultPromises];
|
|
155
|
-
}
|
|
156
|
-
if (subject.materialName) {
|
|
157
|
-
materialPromises = [...materialPromises, ...observerResultPromises];
|
|
158
|
-
}
|
|
159
|
-
}
|
|
160
|
-
await Promise.all(tagPromises);
|
|
161
|
-
await Promise.all(nodePromises);
|
|
162
|
-
await Promise.all(materialPromises);
|
|
163
|
-
return observerResultMap;
|
|
164
|
-
}
|
|
165
|
-
|
|
166
|
-
/**
|
|
167
|
-
* Does the same as {@link setParameterValues} with the difference that all existing states of the
|
|
168
|
-
* {@link TagManager}'s {@link parameters} are applied to all given nodes.
|
|
169
|
-
*/
|
|
170
|
-
public async applyExistingParameterValuesTo(
|
|
171
|
-
objects: (TransformNode | Material)[]
|
|
172
|
-
): Promise<Map<TagManagerSubject, TagManagerParameterObserverResultBag>> {
|
|
173
|
-
return this.applyExistingParameterValuesFor(this.getApplicableSubjectsFor(objects));
|
|
174
|
-
}
|
|
175
|
-
|
|
176
|
-
/**
|
|
177
|
-
* Applies all existing states of the {@link TagManager}'s {@link parameters} for all {@link TagManagerSubject}s.
|
|
178
|
-
*/
|
|
179
|
-
public async applyExistingParameterValues(): Promise<Map<TagManagerSubject, TagManagerParameterObserverResultBag>> {
|
|
180
|
-
return this.applyExistingParameterValuesFor([...this.parameters.keys()]);
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
/**
|
|
184
|
-
* Maps all tags on given nodes with the {@link TagMapping} and updates the state of the {@link TagManager}'s
|
|
185
|
-
* {@link parameters} for all new tags.
|
|
186
|
-
* Also updates the state of all nodes in the tag managers parameter state.
|
|
187
|
-
*/
|
|
188
|
-
public mapNodesAndTags(nodes: TransformNode[], tagMapping: TagMapping): TagManager {
|
|
189
|
-
this.updateParametersWithNodeAndTagMapping(nodes, tagMapping);
|
|
190
|
-
mapTags(nodes, tagMapping);
|
|
191
|
-
return this;
|
|
192
|
-
}
|
|
193
|
-
|
|
194
|
-
/**
|
|
195
|
-
* Gets a distinct list of all tags within the current scene.
|
|
196
|
-
*/
|
|
197
|
-
public getAllTags(): string[] {
|
|
198
|
-
const tags: string[] = [];
|
|
199
|
-
const nodes = this.viewer.scene.getNodes();
|
|
200
|
-
for (const node of nodes) {
|
|
201
|
-
tags.push(...Object.keys(Tags.GetTags(node, false) ?? {}));
|
|
202
|
-
}
|
|
203
|
-
return [...new Set(tags)];
|
|
204
|
-
}
|
|
205
|
-
|
|
206
|
-
/**
|
|
207
|
-
* Prints the state of the {@link TagManager}'s {@link parameters} to the console.
|
|
208
|
-
*/
|
|
209
|
-
public printAllTags(): void {
|
|
210
|
-
const printable = [];
|
|
211
|
-
for (const subject of this.parameters.keys()) {
|
|
212
|
-
const parameterBag = this.parameters.get(subject);
|
|
213
|
-
for (const parameter in parameterBag) {
|
|
214
|
-
printable.push({
|
|
215
|
-
subject: JSON.stringify(subject),
|
|
216
|
-
parameter: parameter,
|
|
217
|
-
value: parameterBag[parameter],
|
|
218
|
-
nodes: this.getNodesBySubject(subject),
|
|
219
|
-
});
|
|
220
|
-
}
|
|
221
|
-
}
|
|
222
|
-
console.table(printable);
|
|
223
|
-
}
|
|
224
|
-
|
|
225
|
-
/**
|
|
226
|
-
* Prints the state of the {@link TagManager}'s {@link parameters} for one tagName to the console.
|
|
227
|
-
*/
|
|
228
|
-
public printTagInfo(tagName: string): void {
|
|
229
|
-
const parameterBag = this.parameters.get({ tagName: tagName });
|
|
230
|
-
const printable = [];
|
|
231
|
-
for (const parameter in parameterBag) {
|
|
232
|
-
printable.push({
|
|
233
|
-
parameter: parameter,
|
|
234
|
-
value: parameterBag[parameter],
|
|
235
|
-
nodes: this.getNodesBySubject({ tagName: tagName }),
|
|
236
|
-
});
|
|
237
|
-
}
|
|
238
|
-
console.table(printable);
|
|
239
|
-
}
|
|
240
|
-
|
|
241
|
-
/**
|
|
242
|
-
* Sets a {@link ParameterObserver} for the given {@link Parameter}.
|
|
243
|
-
*
|
|
244
|
-
* The observer should return `false` in cases where the given value was not actually applied. E.g. when wanting to
|
|
245
|
-
* apply a property on the given `node`s material which doesn't exist at the time the observer is called etc.
|
|
246
|
-
*/
|
|
247
|
-
public setParameterObserver(parameter: string, observer: TagManagerParameterObserver): TagManager {
|
|
248
|
-
this.parameterObservers.set(parameter, observer);
|
|
249
|
-
return this;
|
|
250
|
-
}
|
|
251
|
-
|
|
252
|
-
/**
|
|
253
|
-
* Gets all nodes for given {@link TagManagerSubject} on the Babylon.js scene.
|
|
254
|
-
*/
|
|
255
|
-
public getNodesBySubject(subject: TagManagerSubject, predicate?: (node: TransformNode) => boolean): TransformNode[] {
|
|
256
|
-
let nodes: TransformNode[] = [];
|
|
257
|
-
if (subject.tagName) {
|
|
258
|
-
nodes = [
|
|
259
|
-
...nodes,
|
|
260
|
-
...this.viewer.scene.getTransformNodesByTags(subject.tagName, predicate),
|
|
261
|
-
...this.viewer.scene.getMeshesByTags(subject.tagName, predicate),
|
|
262
|
-
];
|
|
263
|
-
}
|
|
264
|
-
if (subject.nodeName) {
|
|
265
|
-
nodes = [
|
|
266
|
-
...nodes,
|
|
267
|
-
this.viewer.scene.getTransformNodeByName(subject.nodeName),
|
|
268
|
-
this.viewer.scene.getMeshByName(subject.nodeName),
|
|
269
|
-
].filter(t => !!t && (!predicate || predicate(t))) as TransformNode[];
|
|
270
|
-
}
|
|
271
|
-
return nodes;
|
|
272
|
-
}
|
|
273
|
-
|
|
274
|
-
/**
|
|
275
|
-
* Gets all materials for given {@link TagManagerSubject} on the Babylon.js scene.
|
|
276
|
-
*/
|
|
277
|
-
public getMaterialsBySubject(subject: TagManagerSubject, predicate?: (material: Material) => boolean): Material[] {
|
|
278
|
-
let materials: Material[] = [];
|
|
279
|
-
if (subject.tagName) {
|
|
280
|
-
materials = [...materials, ...this.viewer.scene.getMaterialByTags(subject.tagName, predicate)];
|
|
281
|
-
}
|
|
282
|
-
if (subject.materialName) {
|
|
283
|
-
materials = [...materials, this.viewer.scene.getMaterialByName(subject.materialName)].filter(
|
|
284
|
-
t => !!t && (!predicate || predicate(t))
|
|
285
|
-
) as Material[];
|
|
286
|
-
}
|
|
287
|
-
return materials;
|
|
288
|
-
}
|
|
289
|
-
|
|
290
|
-
/**
|
|
291
|
-
* Registers observers that are called on every new object added to the Babylon.js scene.
|
|
292
|
-
* The observers ensure that each new object gets the state of the {@link TagManager}'s {@link parameters} applied.
|
|
293
|
-
*/
|
|
294
|
-
public registerNewObjectObservers(scene: Scene) {
|
|
295
|
-
// nodes and meshes
|
|
296
|
-
const onNewTransformNodeAdded = (node: TransformNode) => {
|
|
297
|
-
/* NOTE:
|
|
298
|
-
Removed the check for created instances here since it is not guaranteed that all instances
|
|
299
|
-
created means that there is no scenario where new nodes should get TagManager parameters applied.
|
|
300
|
-
Instead, we check for the state to be enabled via the `onEnabledStateChangedObservable` below.
|
|
301
|
-
*/
|
|
302
|
-
const onEnabledStateChangedObserver = node.onEnabledStateChangedObservable.add(async state => {
|
|
303
|
-
if (!state) {
|
|
304
|
-
// if the node is disabled, means ignoring also "ghost nodes"
|
|
305
|
-
return;
|
|
306
|
-
}
|
|
307
|
-
await this.applyExistingParameterValuesTo([node]);
|
|
308
|
-
node.onEnabledStateChangedObservable.remove(onEnabledStateChangedObserver);
|
|
309
|
-
});
|
|
310
|
-
node.onEnabledStateChangedObservable.makeObserverBottomPriority(onEnabledStateChangedObserver!);
|
|
311
|
-
};
|
|
312
|
-
scene.onNewTransformNodeAddedObservable.makeObserverBottomPriority(
|
|
313
|
-
scene.onNewTransformNodeAddedObservable.add(onNewTransformNodeAdded)!
|
|
314
|
-
);
|
|
315
|
-
scene.onNewMeshAddedObservable.makeObserverBottomPriority(
|
|
316
|
-
scene.onNewMeshAddedObservable.add(onNewTransformNodeAdded)!
|
|
317
|
-
);
|
|
318
|
-
// materials
|
|
319
|
-
const onNewMaterialAdded = (material: Material) => {
|
|
320
|
-
/* NOTE:
|
|
321
|
-
We have to wait until a material is bound to a Mesh. In all other scenarios, the material
|
|
322
|
-
is not "fully ready" or even empty (without working attributes/properties).
|
|
323
|
-
*/
|
|
324
|
-
const onMaterialBindObserver = material.onBindObservable.add(async abstractMesh => {
|
|
325
|
-
await this.applyExistingParameterValuesTo([material]);
|
|
326
|
-
material.onBindObservable.remove(onMaterialBindObserver);
|
|
327
|
-
});
|
|
328
|
-
material.onBindObservable.makeObserverBottomPriority(onMaterialBindObserver!);
|
|
329
|
-
};
|
|
330
|
-
scene.onNewMaterialAddedObservable.makeObserverBottomPriority(
|
|
331
|
-
scene.onNewMaterialAddedObservable.add(onNewMaterialAdded)!
|
|
332
|
-
);
|
|
333
|
-
}
|
|
334
|
-
|
|
335
|
-
/**
|
|
336
|
-
* Adds the default {@link ParameterObserver}s.
|
|
337
|
-
* @protected
|
|
338
|
-
*/
|
|
339
|
-
protected addParameterObservers(): TagManager {
|
|
340
|
-
this.parameterObservers.set(Parameter.VISIBLE, async payload => {
|
|
341
|
-
const visible = Parameter.parseBoolean(payload.newValue);
|
|
342
|
-
if (visible === true) {
|
|
343
|
-
for (const node of payload.nodes) {
|
|
344
|
-
node.setEnabled(true);
|
|
345
|
-
}
|
|
346
|
-
} else if (visible === false) {
|
|
347
|
-
for (const node of payload.nodes) {
|
|
348
|
-
node.setEnabled(false);
|
|
349
|
-
}
|
|
350
|
-
}
|
|
351
|
-
return true;
|
|
352
|
-
});
|
|
353
|
-
this.parameterObservers.set(Parameter.SCALING, async payload => {
|
|
354
|
-
for (const node of payload.nodes) {
|
|
355
|
-
node.scaling = Parameter.parseVector(payload.newValue);
|
|
356
|
-
}
|
|
357
|
-
return true;
|
|
358
|
-
});
|
|
359
|
-
this.parameterObservers.set(Parameter.POSITION, async payload => {
|
|
360
|
-
for (const node of payload.nodes) {
|
|
361
|
-
node.position = Parameter.parseVector(payload.newValue);
|
|
362
|
-
}
|
|
363
|
-
return true;
|
|
364
|
-
});
|
|
365
|
-
this.parameterObservers.set(Parameter.ROTATION, async payload => {
|
|
366
|
-
for (const node of payload.nodes) {
|
|
367
|
-
node.rotation = Parameter.parseRotation(payload.newValue);
|
|
368
|
-
}
|
|
369
|
-
return true;
|
|
370
|
-
});
|
|
371
|
-
this.parameterObservers.set(Parameter.MATERIAL, async payload => {
|
|
372
|
-
for (const node of payload.nodes) {
|
|
373
|
-
assertMeshCapability(node, Parameter.MATERIAL);
|
|
374
|
-
setMaterial(node, payload.newValue.toString(), false);
|
|
375
|
-
}
|
|
376
|
-
return true;
|
|
377
|
-
});
|
|
378
|
-
this.parameterObservers.set(Parameter.COLOR, async payload => {
|
|
379
|
-
const color = Parameter.parseColor(payload.newValue);
|
|
380
|
-
for (const material of payload.materials) {
|
|
381
|
-
const materialCls = material.getClassName();
|
|
382
|
-
switch (materialCls) {
|
|
383
|
-
case 'PBRMaterial':
|
|
384
|
-
(material as PBRMaterial).albedoColor = color.toLinearSpace();
|
|
385
|
-
break;
|
|
386
|
-
case 'StandardMaterial':
|
|
387
|
-
(material as StandardMaterial).diffuseColor = color;
|
|
388
|
-
break;
|
|
389
|
-
default:
|
|
390
|
-
throw new Error(`Setting color for material of instance "${materialCls}" not implemented (yet).`);
|
|
391
|
-
}
|
|
392
|
-
}
|
|
393
|
-
return true;
|
|
394
|
-
});
|
|
395
|
-
this.parameterObservers.set(Parameter.ROUGHNESS, async payload => {
|
|
396
|
-
const roughness = Parameter.parseNumber(payload.newValue);
|
|
397
|
-
for (const material of payload.materials) {
|
|
398
|
-
const materialCls = material.getClassName();
|
|
399
|
-
switch (materialCls) {
|
|
400
|
-
case 'PBRMaterial':
|
|
401
|
-
(material as PBRMaterial).roughness = roughness;
|
|
402
|
-
break;
|
|
403
|
-
case 'StandardMaterial':
|
|
404
|
-
(material as StandardMaterial).roughness = roughness;
|
|
405
|
-
break;
|
|
406
|
-
default:
|
|
407
|
-
throw new Error(`Setting roughness for material of instance "${materialCls}" not implemented (yet).`);
|
|
408
|
-
}
|
|
409
|
-
}
|
|
410
|
-
return true;
|
|
411
|
-
});
|
|
412
|
-
this.parameterObservers.set(Parameter.METALLIC, async payload => {
|
|
413
|
-
const metallic = Parameter.parseNumber(payload.newValue);
|
|
414
|
-
for (const material of payload.materials) {
|
|
415
|
-
const materialCls = material.getClassName();
|
|
416
|
-
switch (materialCls) {
|
|
417
|
-
case 'PBRMaterial':
|
|
418
|
-
(material as PBRMaterial).metallic = metallic;
|
|
419
|
-
break;
|
|
420
|
-
default:
|
|
421
|
-
throw new Error(`Setting metallic for material of instance "${materialCls}" not implemented (yet).`);
|
|
422
|
-
}
|
|
423
|
-
}
|
|
424
|
-
return true;
|
|
425
|
-
});
|
|
426
|
-
this.parameterObservers.set(Parameter.PAINTABLE, async payload => {
|
|
427
|
-
const paintableValue: PaintableValue = Parameter.parsePaintable(payload.newValue);
|
|
428
|
-
|
|
429
|
-
// check if value is svg or image source, do the conversion accordingly
|
|
430
|
-
const srcIsSvg = isSvg(paintableValue.src);
|
|
431
|
-
if (!srcIsSvg && paintableValue.src.includes('<svg') && paintableValue.src.includes('</svg>')) {
|
|
432
|
-
// seems like the user tried to use a SVG string, as <svg> tags are used
|
|
433
|
-
// inform the user that this is not a valid SVG string
|
|
434
|
-
throw new Error(`Setting paintable value failed: "${paintableValue.src}" is no valid SVG string.`);
|
|
435
|
-
}
|
|
436
|
-
|
|
437
|
-
let imageSource: CanvasImageSource;
|
|
438
|
-
try {
|
|
439
|
-
imageSource = srcIsSvg
|
|
440
|
-
? await createImageFromSvg(paintableValue.src)
|
|
441
|
-
: await createImageFromImgSrc(paintableValue.src);
|
|
442
|
-
} catch {
|
|
443
|
-
// SVG might be invalid, even if it passes `isSvg` check
|
|
444
|
-
// in this case the image can't be created and will throw an error, which should be handled by the viewer and
|
|
445
|
-
// Combeenation viewer control
|
|
446
|
-
throw new ViewerError({
|
|
447
|
-
id: ViewerErrorIds.InvalidParameterValue,
|
|
448
|
-
message: `Invalid value for parameter "paintable" given:\nImage can't be created from source string.\nGiven value: ${paintableValue.src}`,
|
|
449
|
-
});
|
|
450
|
-
}
|
|
451
|
-
|
|
452
|
-
// apply image source on desired material(s)
|
|
453
|
-
for (const material of payload.materials) {
|
|
454
|
-
drawPaintableOnMaterial(material, imageSource, this.viewer.scene, paintableValue.options);
|
|
455
|
-
}
|
|
456
|
-
|
|
457
|
-
return true;
|
|
458
|
-
});
|
|
459
|
-
return this;
|
|
460
|
-
}
|
|
461
|
-
|
|
462
|
-
/**
|
|
463
|
-
* Passes all {@link ParameterValue}s of the given {@link ParameterBag} for given {@link TagManagerSubject} to
|
|
464
|
-
* {@link handleParameter}.
|
|
465
|
-
* @protected
|
|
466
|
-
*/
|
|
467
|
-
protected handleParameterBag(
|
|
468
|
-
subject: TagManagerSubject,
|
|
469
|
-
parameters: ParameterBag
|
|
470
|
-
): Promise<TagManagerParameterObserverResultBag>[] {
|
|
471
|
-
const observerPromises: Promise<TagManagerParameterObserverResultBag>[] = [];
|
|
472
|
-
for (const parameter in parameters) {
|
|
473
|
-
observerPromises.push(this.handleParameter(subject, parameter, parameters[parameter]));
|
|
474
|
-
}
|
|
475
|
-
return observerPromises;
|
|
476
|
-
}
|
|
477
|
-
|
|
478
|
-
/**
|
|
479
|
-
* Asserts the given {@link Parameter} and its {@link ParameterValue}, stores the state in the {@link TagManager}'s
|
|
480
|
-
* {@link parameters}, calculates the applicable nodes, injects the {@link ParameterValue} in the node's metadata,
|
|
481
|
-
* calls the responsible {@link ParameterObserver}s and emits the event {@link Event.TAG_MANAGER_PARAMETER_COMMITTED}.
|
|
482
|
-
* @protected
|
|
483
|
-
*/
|
|
484
|
-
protected async handleParameter(
|
|
485
|
-
subject: TagManagerSubject,
|
|
486
|
-
parameter: string,
|
|
487
|
-
parameterValue: ParameterValue
|
|
488
|
-
): Promise<TagManagerParameterObserverResultBag> {
|
|
489
|
-
Parameter.assertParameter(Parameter.declarations, parameter, parameterValue);
|
|
490
|
-
const parameterBag = this.parameters.get(subject) || {};
|
|
491
|
-
const oldValue = parameterBag[parameter];
|
|
492
|
-
const parameterObserverResultBag: TagManagerParameterObserverResultBag = {
|
|
493
|
-
subject: subject,
|
|
494
|
-
parameter: parameter,
|
|
495
|
-
nodes: [],
|
|
496
|
-
materials: [],
|
|
497
|
-
oldValue: oldValue,
|
|
498
|
-
newValue: parameterValue,
|
|
499
|
-
parameterObserverResult: false,
|
|
500
|
-
};
|
|
501
|
-
if (!this.parameterObservers.has(parameter)) {
|
|
502
|
-
return Promise.resolve(parameterObserverResultBag);
|
|
503
|
-
}
|
|
504
|
-
this.parameters.set(subject, parameterBag);
|
|
505
|
-
this.parameters.get(subject)![parameter] = parameterValue;
|
|
506
|
-
// get objects by subject and filter nodes by state
|
|
507
|
-
const nodes = this.getNodesBySubject(subject).filter(
|
|
508
|
-
o => o.metadata?.tagManager?.parameters?.[parameter] !== parameterValue
|
|
509
|
-
);
|
|
510
|
-
const materials = this.getMaterialsBySubject(subject).filter(
|
|
511
|
-
o => o.metadata?.tagManager?.parameters?.[parameter] !== parameterValue
|
|
512
|
-
);
|
|
513
|
-
if (nodes.length === 0 && materials.length === 0) {
|
|
514
|
-
return Promise.resolve(parameterObserverResultBag);
|
|
515
|
-
}
|
|
516
|
-
// store state in objects
|
|
517
|
-
for (const object of [...nodes, ...materials]) {
|
|
518
|
-
injectMetadata(object, { tagManager: { parameters: { [parameter]: parameterValue } } }, false);
|
|
519
|
-
}
|
|
520
|
-
|
|
521
|
-
const observer = this.parameterObservers.get(parameter)!;
|
|
522
|
-
const result = await observer({
|
|
523
|
-
subject: subject,
|
|
524
|
-
nodes: nodes,
|
|
525
|
-
materials: materials,
|
|
526
|
-
newValue: parameterValue,
|
|
527
|
-
oldValue: oldValue,
|
|
528
|
-
});
|
|
529
|
-
|
|
530
|
-
if (result === false) {
|
|
531
|
-
// reset to old value if observer was not successful
|
|
532
|
-
this.parameters.get(subject)![parameter] = oldValue;
|
|
533
|
-
// store old state in objects
|
|
534
|
-
for (const object of [...nodes, ...materials]) {
|
|
535
|
-
injectMetadata(object, { tagManager: { parameters: { [parameter]: oldValue } } }, false);
|
|
536
|
-
}
|
|
537
|
-
}
|
|
538
|
-
parameterObserverResultBag.nodes = nodes;
|
|
539
|
-
parameterObserverResultBag.materials = materials;
|
|
540
|
-
parameterObserverResultBag.parameterObserverResult = result;
|
|
541
|
-
emitter.emit(Event.TAG_MANAGER_PARAMETER_COMMITTED, parameterObserverResultBag);
|
|
542
|
-
return parameterObserverResultBag;
|
|
543
|
-
}
|
|
544
|
-
|
|
545
|
-
/**
|
|
546
|
-
* Updates the state of the {@link TagManager}'s {@link parameters} for all new nodes and tags given in
|
|
547
|
-
* {@link TagMapping}.
|
|
548
|
-
* @protected
|
|
549
|
-
*/
|
|
550
|
-
protected updateParametersWithNodeAndTagMapping(nodes: TransformNode[], tagMapping: TagMapping): void {
|
|
551
|
-
// create node mapping by linking the clone source name to the new node name
|
|
552
|
-
const nodeMapping = nodes.reduce((accNodeMapping, curNode) => {
|
|
553
|
-
const oldNode = get(curNode.metadata, 'cloneSource') as TransformNode;
|
|
554
|
-
if (oldNode) {
|
|
555
|
-
accNodeMapping[oldNode.name] = curNode.name;
|
|
556
|
-
}
|
|
557
|
-
return accNodeMapping;
|
|
558
|
-
}, {} as TagMapping);
|
|
559
|
-
for (const subject of this.parameters.keys()) {
|
|
560
|
-
const isNode = subject.nodeName;
|
|
561
|
-
const newName = isNode ? nodeMapping[subject.nodeName] : tagMapping[subject.tagName];
|
|
562
|
-
if (!newName) {
|
|
563
|
-
continue;
|
|
564
|
-
}
|
|
565
|
-
const newSubject = clone(subject);
|
|
566
|
-
newSubject[isNode ? 'nodeName' : 'tagName'] = newName;
|
|
567
|
-
const parameterBag = clone(this.parameters.get(subject)!);
|
|
568
|
-
merge(parameterBag, this.parameters.get(newSubject));
|
|
569
|
-
this.parameters.set(newSubject, parameterBag);
|
|
570
|
-
}
|
|
571
|
-
}
|
|
572
|
-
}
|
|
@@ -1,107 +0,0 @@
|
|
|
1
|
-
import { Event } from '../classes/event';
|
|
2
|
-
import { EventBroadcaster } from '../classes/eventBroadcaster';
|
|
3
|
-
import { isLoadableTexture } from '../util/babylonHelper';
|
|
4
|
-
import { sleep } from '../util/resourceHelper';
|
|
5
|
-
import { BaseTexture } from '@babylonjs/core/Materials/Textures/baseTexture';
|
|
6
|
-
import { Scene as BabylonScene } from '@babylonjs/core/scene';
|
|
7
|
-
|
|
8
|
-
/**
|
|
9
|
-
* Keeps track of all texture loading/ready states and fires {@link Event.TEXTURE_LOADING_START} and
|
|
10
|
-
* {@link Event.TEXTURE_LOADING_END} events.
|
|
11
|
-
*/
|
|
12
|
-
export class TextureLoadManager extends EventBroadcaster {
|
|
13
|
-
// We're keeping track of all "loading textures" in this map ourselves instead of relying on information from
|
|
14
|
-
// `scene.textures` as that proved to be rather unreliable for our use cases.
|
|
15
|
-
// E.g. see this forums post for some more information:
|
|
16
|
-
// https://forum.babylonjs.com/t/using-scene-createdefaultenvironment-removes-textures-from-scene/35267
|
|
17
|
-
private readonly _loadingTextures: Map<number, BaseTexture> = new Map();
|
|
18
|
-
|
|
19
|
-
// Whenever we fire the {@link Event.TEXTURE_LOADING_START} event, we're starting a polling service which checks all
|
|
20
|
-
// x ms if all awaited textures are in "ready state" or not.
|
|
21
|
-
// This is basically just an additional safety net in addition to our `onLoadObservable`s and was added to prevent
|
|
22
|
-
// situations where a {@link Event.TEXTURE_LOADING_START} event is fired without an accompanying
|
|
23
|
-
// {@link Event.TEXTURE_LOADING_END} as that is a situation which can lead to load masks being endlessly shown in a
|
|
24
|
-
// cfgr.
|
|
25
|
-
// In theory this shouldn't be necessary, but we've already discovered some quirks and inconsistent behavior around
|
|
26
|
-
// the texture load observables etc. and I felt more save with this safety net in place.
|
|
27
|
-
private _readyStatePollingIntervalMs = 200;
|
|
28
|
-
private _readyStatePollingId = 0;
|
|
29
|
-
|
|
30
|
-
private constructor(public scene: BabylonScene) {
|
|
31
|
-
super();
|
|
32
|
-
this.scene.onNewTextureAddedObservable.add(texture => this.onTextureAdded(texture));
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
public static create(scene: BabylonScene): TextureLoadManager {
|
|
36
|
-
const loadMgr = new TextureLoadManager(scene);
|
|
37
|
-
return loadMgr;
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
private startReadyStatePollingIfNeeded() {
|
|
41
|
-
if (!this._readyStatePollingId) {
|
|
42
|
-
this._readyStatePollingId = window.setInterval(
|
|
43
|
-
() => this.checkLoadingTexturesState(),
|
|
44
|
-
this._readyStatePollingIntervalMs
|
|
45
|
-
);
|
|
46
|
-
}
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
private endReadyStatePollingIfNeeded() {
|
|
50
|
-
if (this._readyStatePollingId) {
|
|
51
|
-
window.clearInterval(this._readyStatePollingId);
|
|
52
|
-
this._readyStatePollingId = 0;
|
|
53
|
-
}
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
/**
|
|
57
|
-
* Checks the "ready state" of all textures inside the `this._loadingTextures` map, removes the ready ones and fires
|
|
58
|
-
* the {@link Event.TEXTURE_LOADING_END} event if no more textures are loading (i.e. "all ready").
|
|
59
|
-
*/
|
|
60
|
-
private checkLoadingTexturesState() {
|
|
61
|
-
const allTexturesReadyBefore = !this._loadingTextures.size;
|
|
62
|
-
if (allTexturesReadyBefore) return;
|
|
63
|
-
|
|
64
|
-
// Remove textures which are in "ready state" from the map
|
|
65
|
-
for (const [id, texture] of this._loadingTextures) {
|
|
66
|
-
if (texture.isReady()) this._loadingTextures.delete(id);
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
const allTexturesReadyAfter = !this._loadingTextures.size;
|
|
70
|
-
if (allTexturesReadyAfter) {
|
|
71
|
-
this.broadcastEvent(Event.TEXTURE_LOADING_END);
|
|
72
|
-
this.endReadyStatePollingIfNeeded();
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
private async onTextureAdded(texture: BaseTexture) {
|
|
77
|
-
// Workaround:
|
|
78
|
-
// The texture object is not fully created when the "added observable" is called. E.g. the function
|
|
79
|
-
// `onLoadObservable` is not there at that point.
|
|
80
|
-
// More details: https://forum.babylonjs.com/t/basetexture-whenallready-returns-too-early/34501/4
|
|
81
|
-
await sleep(0);
|
|
82
|
-
|
|
83
|
-
// textures based CBN image assets are hard to analyse in the inspector, since the asset url is set as name
|
|
84
|
-
// with this functionality we try to find these CBN image assets and crop the name accordingly
|
|
85
|
-
// => see CB-9558
|
|
86
|
-
const isUrl = texture.name.startsWith('https://');
|
|
87
|
-
const textureQueryString = '?name=';
|
|
88
|
-
const indexOfTextureQueryParam = texture.name.lastIndexOf(textureQueryString);
|
|
89
|
-
|
|
90
|
-
if (isUrl && indexOfTextureQueryParam > -1) {
|
|
91
|
-
texture.name = texture.name.substring(indexOfTextureQueryParam + textureQueryString.length);
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
// Some textures are already in "ready state" after the sleep -> We don't care for them anymore as well as for
|
|
95
|
-
// textures which don't come with an `onLoadObservable` (i.e. not of class {@link Texture}) or do not have an URL to
|
|
96
|
-
// load (i.e. RawTexture2DArray texture type for morph target data storage).
|
|
97
|
-
if (!isLoadableTexture(texture) || texture.isReady()) return;
|
|
98
|
-
|
|
99
|
-
const noCurrentLoadingTextures = !this._loadingTextures.size;
|
|
100
|
-
if (noCurrentLoadingTextures) {
|
|
101
|
-
this.broadcastEvent(Event.TEXTURE_LOADING_START);
|
|
102
|
-
this.startReadyStatePollingIfNeeded();
|
|
103
|
-
}
|
|
104
|
-
this._loadingTextures.set(texture.uniqueId, texture);
|
|
105
|
-
texture.onLoadObservable.addOnce(texture => this.checkLoadingTexturesState());
|
|
106
|
-
}
|
|
107
|
-
}
|