@combeenation/3d-viewer 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/LICENSE +13 -0
  2. package/README.md +111 -0
  3. package/dist/types/api/classes/animationInterface.d.ts +8 -0
  4. package/dist/types/api/classes/dottedPath.d.ts +79 -0
  5. package/dist/types/api/classes/element.d.ts +153 -0
  6. package/dist/types/api/classes/event.d.ts +396 -0
  7. package/dist/types/api/classes/eventBroadcaster.d.ts +26 -0
  8. package/dist/types/api/classes/fuzzyMap.d.ts +7 -0
  9. package/dist/types/api/classes/parameter.d.ts +351 -0
  10. package/dist/types/api/classes/parameterObservable.d.ts +36 -0
  11. package/dist/types/api/classes/parameterizable.d.ts +15 -0
  12. package/dist/types/api/classes/placementAnimation.d.ts +45 -0
  13. package/dist/types/api/classes/variant.d.ts +253 -0
  14. package/dist/types/api/classes/variantInstance.d.ts +53 -0
  15. package/dist/types/api/classes/variantParameterizable.d.ts +17 -0
  16. package/dist/types/api/classes/viewer.d.ts +200 -0
  17. package/dist/types/api/classes/viewerLight.d.ts +66 -0
  18. package/dist/types/api/internal/lensRendering.d.ts +8 -0
  19. package/dist/types/api/internal/sceneSetup.d.ts +13 -0
  20. package/dist/types/api/manager/animationManager.d.ts +30 -0
  21. package/dist/types/api/manager/gltfExportManager.d.ts +78 -0
  22. package/dist/types/api/manager/sceneManager.d.ts +33 -0
  23. package/dist/types/api/manager/tagManager.d.ts +108 -0
  24. package/dist/types/api/manager/textureLoadManager.d.ts +22 -0
  25. package/dist/types/api/manager/variantInstanceManager.d.ts +103 -0
  26. package/dist/types/api/store/specStorage.d.ts +32 -0
  27. package/dist/types/api/util/babylonHelper.d.ts +235 -0
  28. package/dist/types/api/util/globalTypes.d.ts +436 -0
  29. package/dist/types/api/util/resourceHelper.d.ts +58 -0
  30. package/dist/types/api/util/sceneLoaderHelper.d.ts +44 -0
  31. package/dist/types/api/util/stringHelper.d.ts +13 -0
  32. package/dist/types/api/util/structureHelper.d.ts +9 -0
  33. package/dist/types/declaration.tsconfig.tsbuildinfo +1 -0
  34. package/dist/types/index.d.ts +27 -0
  35. package/package.json +87 -0
  36. package/src/api/classes/animationInterface.ts +10 -0
  37. package/src/api/classes/dottedPath.ts +181 -0
  38. package/src/api/classes/element.ts +731 -0
  39. package/src/api/classes/event.ts +452 -0
  40. package/src/api/classes/eventBroadcaster.ts +52 -0
  41. package/src/api/classes/fuzzyMap.ts +21 -0
  42. package/src/api/classes/parameter.ts +554 -0
  43. package/src/api/classes/parameterObservable.ts +73 -0
  44. package/src/api/classes/parameterizable.ts +87 -0
  45. package/src/api/classes/placementAnimation.ts +162 -0
  46. package/src/api/classes/variant.ts +933 -0
  47. package/src/api/classes/variantInstance.ts +123 -0
  48. package/src/api/classes/variantParameterizable.ts +85 -0
  49. package/src/api/classes/viewer.ts +742 -0
  50. package/src/api/classes/viewerLight.ts +339 -0
  51. package/src/api/internal/debugViewer.ts +90 -0
  52. package/src/api/internal/lensRendering.ts +9 -0
  53. package/src/api/internal/sceneSetup.ts +205 -0
  54. package/src/api/manager/animationManager.ts +143 -0
  55. package/src/api/manager/gltfExportManager.ts +236 -0
  56. package/src/api/manager/sceneManager.ts +136 -0
  57. package/src/api/manager/tagManager.ts +451 -0
  58. package/src/api/manager/textureLoadManager.ts +95 -0
  59. package/src/api/manager/variantInstanceManager.ts +298 -0
  60. package/src/api/store/specStorage.ts +68 -0
  61. package/src/api/util/babylonHelper.ts +822 -0
  62. package/src/api/util/globalTypes.ts +503 -0
  63. package/src/api/util/resourceHelper.ts +191 -0
  64. package/src/api/util/sceneLoaderHelper.ts +170 -0
  65. package/src/api/util/stringHelper.ts +30 -0
  66. package/src/api/util/structureHelper.ts +49 -0
  67. package/src/buildinfo.json +3 -0
  68. package/src/dev.ts +62 -0
  69. package/src/index.ts +79 -0
  70. package/src/types.d.ts +36 -0
@@ -0,0 +1,339 @@
1
+ import {
2
+ cloneNodeWithParents,
3
+ disableNodeWithParents,
4
+ enableNodeWithParents,
5
+ getRootNode,
6
+ injectNodeMetadata,
7
+ transformTransformNode,
8
+ } from './../util/babylonHelper';
9
+ import { DottedPath } from './dottedPath';
10
+ import { Parameter } from './parameter';
11
+ import { Variant } from './variant';
12
+ import { VariantParameterizable } from './variantParameterizable';
13
+ import { ShadowGenerator } from '@babylonjs/core/Lights/Shadows/shadowGenerator';
14
+ import '@babylonjs/core/Lights/Shadows/shadowGeneratorSceneComponent';
15
+ import { HemisphericLight } from '@babylonjs/core/Lights/hemisphericLight';
16
+ import { Light } from '@babylonjs/core/Lights/light';
17
+ import { PointLight } from '@babylonjs/core/Lights/pointLight';
18
+ import { ShadowLight } from '@babylonjs/core/Lights/shadowLight';
19
+ import { Vector3 } from '@babylonjs/core/Maths/math.vector';
20
+ import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
21
+ import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_lights_punctual';
22
+ import { get, isEmpty, isString, set } from 'lodash-es';
23
+
24
+ /**
25
+ * A {@link ViewerLight} of a {@link Variant}. Acts as a container for Babylon.js lights. Lives only in the context of a
26
+ * {@link Variant}.
27
+ */
28
+ export class ViewerLight extends VariantParameterizable {
29
+ protected _light: Light | undefined;
30
+
31
+ /**
32
+ * Constructor.
33
+ */
34
+ protected constructor(public readonly variant: Variant, public readonly name: string) {
35
+ super(variant, name);
36
+ this.addParameterObservers();
37
+ }
38
+
39
+ /**
40
+ * Creates a {@link ViewerLight} with given name.
41
+ */
42
+ public static async create(variant: Variant, name: string): Promise<ViewerLight> {
43
+ const viewerLight = new ViewerLight(variant, name);
44
+ viewerLight._light = await viewerLight.createBabylonLightFromDefinition(viewerLight.definition);
45
+ return viewerLight;
46
+ }
47
+
48
+ /**
49
+ * The wrapped Light.
50
+ */
51
+ get light(): Light {
52
+ if (!this._light) {
53
+ throw new Error(`Light for ViewerLight "${this.name}" has not been properly initialized.`);
54
+ }
55
+ return this._light!;
56
+ }
57
+
58
+ /**
59
+ * The {@link DottedPath} in the built tree of {@link ViewerLight}s.
60
+ * E.g. "_.top-1.sub-2.sub-sub-3.el-1"
61
+ */
62
+ get dottedPath(): DottedPath {
63
+ return DottedPath.create(this.variant.dottedPath).addPart(this.name);
64
+ }
65
+
66
+ /**
67
+ * The id representing a {@link DottedPath}.
68
+ */
69
+ get id(): string {
70
+ const dottedPath = DottedPath.create(this.dottedPath);
71
+ dottedPath.shiftPart(); // remove root
72
+ return dottedPath.path;
73
+ }
74
+
75
+ /**
76
+ * The {@link LightDefinition} of the {@link ViewerLight}.
77
+ */
78
+ get definition(): LightDefinition {
79
+ const definition = this.variant.structureJson.lights![this.name];
80
+ if (isString(definition)) {
81
+ return {
82
+ type: 'baked',
83
+ path: definition,
84
+ } as LightDefinition;
85
+ }
86
+ return definition as LightDefinition;
87
+ }
88
+
89
+ /**
90
+ * The type of the {@link ViewerLight}'s light.
91
+ */
92
+ get type(): string {
93
+ return this.light.constructor.name.replace(/light/i, '').toLowerCase();
94
+ }
95
+
96
+ /**
97
+ * @see {@link VariantParameterizable.commitParameters}
98
+ * @emit {@link Event.VIEWER_LIGHT_PARAMETER_COMMITTED}
99
+ */
100
+ public async commitParameters(parameters?: ParameterBag): Promise<VariantParameterizable> {
101
+ return super.commitParameters(parameters);
102
+ }
103
+
104
+ /**
105
+ * Adds the default {@link ParameterObserver}s which are called every time {@link commitParameters} is called.
106
+ */
107
+ protected addParameterObservers(): ViewerLight {
108
+ this._parameterObservers.set(Parameter.VISIBLE, [
109
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
110
+ let visible;
111
+ try {
112
+ visible = Parameter.parseBoolean(newValue);
113
+ } catch (e) {
114
+ return;
115
+ }
116
+ if (visible === true) {
117
+ enableNodeWithParents(light.light);
118
+ } else if (visible === false) {
119
+ disableNodeWithParents(light.light);
120
+ }
121
+ },
122
+ ]);
123
+ this._parameterObservers.set(Parameter.INTENSITY, [
124
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
125
+ set(light.light, 'intensity', Parameter.parseNumber(newValue));
126
+ },
127
+ ]);
128
+ this._parameterObservers.set(Parameter.SCALING, [
129
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
130
+ // we have to deal just with root nodes here due to relative impacts in a node tree
131
+ const rootNode = getRootNode(light.light);
132
+ if (rootNode instanceof TransformNode) {
133
+ transformTransformNode(rootNode, {
134
+ scaling: Parameter.parseScaling(newValue),
135
+ position: Parameter.parseVector(light.inheritedParameters[Parameter.POSITION] || '(0, 0, 0)'),
136
+ rotation: Parameter.parseRotation(light.inheritedParameters[Parameter.ROTATION] || '(0, 0, 0)'),
137
+ });
138
+ }
139
+ },
140
+ ]);
141
+ this._parameterObservers.set(Parameter.POSITION, [
142
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
143
+ // we have to deal just with root nodes here due to relative impacts in a node tree
144
+ const rootNode = getRootNode(light.light);
145
+ if (rootNode instanceof TransformNode) {
146
+ transformTransformNode(rootNode, {
147
+ scaling: Parameter.parseVector(light.inheritedParameters[Parameter.SCALING] || '(1, 1, 1)'),
148
+ position: Parameter.parseVector(newValue),
149
+ rotation: Parameter.parseRotation(light.inheritedParameters[Parameter.ROTATION] || '(0, 0, 0)'),
150
+ });
151
+ }
152
+ },
153
+ ]);
154
+ this._parameterObservers.set(Parameter.ROTATION, [
155
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
156
+ // we have to deal just with root nodes here due to relative impacts in a node tree
157
+ const rootNode = getRootNode(light.light);
158
+ if (rootNode instanceof TransformNode) {
159
+ transformTransformNode(rootNode, {
160
+ scaling: Parameter.parseVector(light.inheritedParameters[Parameter.SCALING] || '(1, 1, 1)'),
161
+ position: Parameter.parseVector(light.inheritedParameters[Parameter.POSITION] || '(0, 0, 0)'),
162
+ rotation: Parameter.parseRotation(newValue),
163
+ });
164
+ }
165
+ },
166
+ ]);
167
+ this._parameterObservers.set(Parameter.DIRECTION, [
168
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
169
+ if (
170
+ (light.light instanceof ShadowLight && !(light.light instanceof PointLight)) ||
171
+ light.light instanceof HemisphericLight
172
+ ) {
173
+ set(light.light, 'direction', Parameter.parseVector(newValue));
174
+ }
175
+ },
176
+ ]);
177
+ this._parameterObservers.set(Parameter.ANGLE, [
178
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
179
+ if (light.light.getClassName() === 'SpotLight') {
180
+ set(light.light, 'angle', Parameter.parseNumber(newValue));
181
+ }
182
+ },
183
+ ]);
184
+ this._parameterObservers.set(Parameter.EXPONENT, [
185
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
186
+ if (light.light.getClassName() === 'SpotLight') {
187
+ set(light.light, 'exponent', Parameter.parseNumber(newValue));
188
+ }
189
+ },
190
+ ]);
191
+ this._parameterObservers.set(Parameter.DIFFUSE, [
192
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
193
+ set(light.light, 'diffuse', Parameter.parseColor(newValue));
194
+ },
195
+ ]);
196
+ this._parameterObservers.set(Parameter.SPECULAR, [
197
+ async (light: ViewerLight, oldValue: Undefinable<ParameterValue>, newValue: ParameterValue) => {
198
+ set(light.light, 'specular', Parameter.parseColor(newValue));
199
+ },
200
+ ]);
201
+ return this;
202
+ }
203
+
204
+ /**
205
+ * @param definition
206
+ * @protected
207
+ */
208
+ protected async createBabylonLightFromDefinition(definition: LightDefinition): Promise<Light> {
209
+ const parameters = Parameter.parseFromDeclarations(Parameter.declarations, this.inheritedParameters);
210
+ const scene = this.variant.viewer.scene;
211
+ let lightId = this.id;
212
+ let babylonLight;
213
+ switch (definition.type) {
214
+ case 'baked': {
215
+ if (!definition['path']) {
216
+ throw new Error(`The light "${lightId}" of type "${definition.type}" needs a "path".`);
217
+ }
218
+ const bakedLight = this.variant.inheritedLights.find(l => l.metadata.dottedPath.path === definition['path']);
219
+ if (bakedLight) {
220
+ lightId = bakedLight.metadata.dottedPath.clone().unshiftPart(this.id).path;
221
+ babylonLight = cloneNodeWithParents(bakedLight) as Light;
222
+ babylonLight!.name = lightId;
223
+ babylonLight!.id = lightId;
224
+ } else {
225
+ throw new Error(`No light found for path "${definition['path']}" in ViewerLight "${lightId}".`);
226
+ }
227
+ break;
228
+ }
229
+ case 'hemispheric': {
230
+ if (!parameters['direction']) {
231
+ throw new Error(`The ViewerLight "${lightId}" of type "${definition.type}" needs a "direction".`);
232
+ }
233
+ // @ts-ignore es6 build doesn't allow dynamic imports
234
+ const hemisphericLightModule = await import(
235
+ /* webpackChunkName: "hemispheric-light" */ '@babylonjs/core/Lights/hemisphericLight'
236
+ );
237
+ babylonLight = new hemisphericLightModule.HemisphericLight(lightId, parameters['direction'], scene);
238
+ break;
239
+ }
240
+ case 'point': {
241
+ // @ts-ignore es6 build doesn't allow dynamic imports
242
+ const pointLightModule = await import(
243
+ /* webpackChunkName: "point-light" */ '@babylonjs/core/Lights/pointLight'
244
+ );
245
+ babylonLight = new pointLightModule.PointLight(
246
+ lightId,
247
+ Vector3.Zero(), // position is set via parent TransformNode
248
+ scene
249
+ );
250
+ break;
251
+ }
252
+ case 'directional': {
253
+ if (!parameters['direction']) {
254
+ throw new Error(`The ViewerLight "${lightId}" of type "${definition.type}" needs a "direction".`);
255
+ }
256
+ // @ts-ignore es6 build doesn't allow dynamic imports
257
+ const directionalLightModule = await import(
258
+ /* webpackChunkName: "directional-light" */ '@babylonjs/core/Lights/directionalLight'
259
+ );
260
+ babylonLight = new directionalLightModule.DirectionalLight(lightId, parameters['direction'], scene);
261
+ break;
262
+ }
263
+ case 'spot': {
264
+ if (!parameters['direction']) {
265
+ throw new Error(`The ViewerLight "${lightId}" of type "${definition.type}" needs a "direction".`);
266
+ }
267
+ if (!parameters['angle']) {
268
+ throw new Error(`A ViewerLight of type "${definition.type}" needs an "angle".`);
269
+ }
270
+ if (!parameters['exponent']) {
271
+ throw new Error(`The ViewerLight "${lightId}" of type "${definition.type}" needs an "exponent".`);
272
+ }
273
+ // @ts-ignore es6 build doesn't allow dynamic imports
274
+ const spotLightModule = await import(/* webpackChunkName: "spot-light" */ '@babylonjs/core/Lights/spotLight');
275
+ babylonLight = new spotLightModule.SpotLight(
276
+ lightId,
277
+ Vector3.Zero(), // position is set via parent TransformNode
278
+ parameters['direction'],
279
+ parameters['angle'],
280
+ parameters['exponent'],
281
+ scene
282
+ );
283
+ break;
284
+ }
285
+ default:
286
+ throw new Error(`The type "${definition.type}" for ViewerLight "${lightId}" is not implemented (yet).`);
287
+ }
288
+ if (!babylonLight) {
289
+ throw new Error(
290
+ `The Light for ViewerLight "${lightId}" of type "${definition.type}" could no be created ` + `or found.`
291
+ );
292
+ }
293
+ if (!babylonLight.parent) {
294
+ // Create pseudo parent since lights do not implement mutations like "rotation" by itself.
295
+ babylonLight.parent = new TransformNode('__light__', this.variant.viewer.scene, true);
296
+ }
297
+ injectNodeMetadata(babylonLight.parent, {
298
+ variant: this.variant,
299
+ variantParameterizable: this,
300
+ });
301
+ // disable/hide by default
302
+ disableNodeWithParents(babylonLight);
303
+ // process shadow generator
304
+ const shadowGeneratorDefinition = get(definition, 'shadowGenerator') as ShadowGeneratorDefinition;
305
+ if (!isEmpty(shadowGeneratorDefinition)) {
306
+ if (!(babylonLight instanceof ShadowLight)) {
307
+ throw new Error(
308
+ `Using a ShadowGenerator with light type "${definition.type}" is not supported for ` +
309
+ `"${lightId}". Use lights deriving from ShadowLight.`
310
+ );
311
+ }
312
+ await this.processShadowGenerator(babylonLight, shadowGeneratorDefinition);
313
+ }
314
+ return babylonLight;
315
+ }
316
+
317
+ /**
318
+ * @param babylonLight
319
+ * @param definition
320
+ * @protected
321
+ */
322
+ protected async processShadowGenerator(
323
+ babylonLight: ShadowLight,
324
+ definition: ShadowGeneratorDefinition
325
+ ): Promise<ShadowGenerator> {
326
+ const parameterDeclarations: ParameterDeclarations = {};
327
+ // define declarations here if needed in future
328
+ const parameterBag = definition as {} as ParameterBag;
329
+ const parameters = Parameter.parseFromDeclarations(parameterDeclarations, parameterBag);
330
+ const shadowGenerator = new ShadowGenerator(parameters['mapSize'], babylonLight);
331
+ for (const parameter in parameters) {
332
+ if (parameter === 'mapSize') {
333
+ continue;
334
+ }
335
+ set(shadowGenerator, parameter, get(parameters, parameter));
336
+ }
337
+ return shadowGenerator;
338
+ }
339
+ }
@@ -0,0 +1,90 @@
1
+ /**
2
+ * @internal
3
+ */
4
+ /// <reference path="../util/globalTypes.ts" />
5
+ import { Event } from '../classes/event';
6
+ import { Viewer } from '../classes/viewer';
7
+ import { Scene } from '@babylonjs/core/scene';
8
+
9
+ export class DebugViewer extends Viewer {
10
+ constructor(canvas: HTMLCanvasElement, data: string | StructureJson) {
11
+ super(canvas, data);
12
+ }
13
+
14
+ public async bootstrap(): Promise<Viewer> {
15
+ for (const event of Event.all) {
16
+ this.eventEmitter.addListener(event, (...args) => console.debug(`Emitting ${event}`, ...args));
17
+ }
18
+ for (const event of [
19
+ Event.VARIANT_INSTANCE_DESTROYED,
20
+ Event.VARIANT_INSTANCE_CREATED,
21
+ Event.VARIANT_INSTANCE_CLONED,
22
+ Event.VARIANT_PARAMETER_COMMITTED,
23
+ ]) {
24
+ this.eventEmitter.addListener(event, this.instanceDebugger.bind(this));
25
+ }
26
+ return super.bootstrap();
27
+ }
28
+
29
+ protected async initScene(): Promise<Scene> {
30
+ const scene = await super.initScene();
31
+
32
+ scene.getEngine().runRenderLoop(() => {
33
+ this.fpsDebugger();
34
+ });
35
+
36
+ return scene;
37
+ }
38
+
39
+ protected instanceDebugger(instance: VariantInstance) {
40
+ const instances: string[] = [];
41
+ this.variantInstances.all.forEach(variantInstance => {
42
+ instances.push(
43
+ `${variantInstance.name}${variantInstance.variant.visible ? '' : ' [hidden]'}${
44
+ variantInstance.variant.highlighted ? ' [highlighted]' : ''
45
+ }`
46
+ );
47
+ });
48
+ let debugContainer = document.getElementById('cyledge-combeenation-3d-viewer-instance-debugger');
49
+ if (!debugContainer) {
50
+ debugContainer = document.createElement('pre');
51
+ debugContainer.setAttribute('id', 'cyledge-combeenation-3d-viewer-instance-debugger');
52
+ debugContainer.setAttribute(
53
+ 'style',
54
+ `
55
+ background: #454545;
56
+ color: #fff;
57
+ position: absolute;
58
+ bottom: 0;
59
+ right: 0;
60
+ padding: 10px;
61
+ margin: 0;
62
+ `
63
+ );
64
+ document.body.appendChild(debugContainer);
65
+ }
66
+ debugContainer.innerHTML = JSON.stringify(instances, null, 2);
67
+ }
68
+
69
+ protected fpsDebugger() {
70
+ let debugContainer = document.getElementById('cyledge-combeenation-3d-viewer-fps-debugger');
71
+ if (!debugContainer) {
72
+ debugContainer = document.createElement('pre');
73
+ debugContainer.setAttribute('id', 'cyledge-combeenation-3d-viewer-fps-debugger');
74
+ debugContainer.setAttribute(
75
+ 'style',
76
+ `
77
+ background: #454545;
78
+ color: #fff;
79
+ position: absolute;
80
+ bottom: 0;
81
+ left: 0;
82
+ padding: 10px;
83
+ margin: 0;
84
+ `
85
+ );
86
+ document.body.appendChild(debugContainer);
87
+ }
88
+ debugContainer.innerHTML = `${this.engine.getFps().toFixed(2)} fps`;
89
+ }
90
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Group the required LensRendering dependencies into a single file to allow a single "import"
3
+ *
4
+ * @internal
5
+ */
6
+ import { LensRenderingPipeline } from '@babylonjs/core/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline';
7
+ import '@babylonjs/core/Rendering/depthRendererSceneComponent';
8
+
9
+ export { LensRenderingPipeline };
@@ -0,0 +1,205 @@
1
+ import { Parameter } from '../classes/parameter';
2
+ import { Camera } from '@babylonjs/core/Cameras/camera';
3
+ import { Engine } from '@babylonjs/core/Engines/engine';
4
+ import '@babylonjs/core/Helpers/sceneHelpers';
5
+ import '@babylonjs/core/Materials/Textures/Loaders/ddsTextureLoader';
6
+ import { Color4 } from '@babylonjs/core/Maths/math.color';
7
+ import { Vector3 } from '@babylonjs/core/Maths/math.vector';
8
+ import { GroundMesh } from '@babylonjs/core/Meshes/groundMesh';
9
+ import { MeshBuilder } from '@babylonjs/core/Meshes/meshBuilder';
10
+ import { DefaultRenderingPipeline } from '@babylonjs/core/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline';
11
+ import { Scene } from '@babylonjs/core/scene';
12
+ import { get, isEmpty } from 'lodash-es';
13
+
14
+ const defaultSceneClearColor = new Color4(0, 0, 0, 0);
15
+ const defaultEnvHelperColor = new Color4(1, 1, 1, 0);
16
+
17
+ /**
18
+ * @param scene
19
+ * @param name
20
+ * @param definition
21
+ */
22
+ const processGround = async function (
23
+ scene: Scene,
24
+ name: string,
25
+ definition: GroundDefinition
26
+ ): Promise<Mesh | GroundMesh> {
27
+ return new Promise(resolve => {
28
+ const _resolve = (ground: Mesh) => {
29
+ if (definition.receiveShadows !== undefined) {
30
+ ground.receiveShadows = definition.receiveShadows;
31
+ }
32
+ resolve(ground);
33
+ };
34
+ switch (definition.type) {
35
+ case 'baked':
36
+ if (!definition.meshId) {
37
+ throw new Error(`A baked ground must define a "meshId".`);
38
+ }
39
+ _resolve(scene.getMeshByID(definition.meshId) as Mesh);
40
+ break;
41
+ case 'ground':
42
+ _resolve(MeshBuilder.CreateGround(name, definition, scene));
43
+ break;
44
+ case 'heightmap':
45
+ if (!definition.url) {
46
+ throw new Error(`A heightmap ground must define an "url".`);
47
+ }
48
+ definition.onReady = (_ground: GroundMesh) => {
49
+ _resolve(_ground);
50
+ };
51
+ MeshBuilder.CreateGroundFromHeightMap(name, definition.url, definition, scene);
52
+ break;
53
+ default:
54
+ throw new Error(`Ground of type "${definition.type}" not implemented (yet).`);
55
+ }
56
+ });
57
+ };
58
+
59
+ /**
60
+ * @param scene
61
+ */
62
+ const defaultCamera = async function (scene: Scene): Promise<Camera> {
63
+ return await processCamera(scene, 'default_camera', {
64
+ type: 'arc',
65
+ active: true,
66
+ });
67
+ };
68
+
69
+ /**
70
+ * @param scene
71
+ * @param name
72
+ * @param cameraSetup
73
+ */
74
+ const processCamera = async function (scene: Scene, name: string, cameraSetup: CameraDefinition): Promise<Camera> {
75
+ let camera: Camera;
76
+ let target = Vector3.Zero();
77
+ if (cameraSetup.target) {
78
+ target = Parameter.parseVector(cameraSetup.target);
79
+ }
80
+ switch (cameraSetup.type) {
81
+ case 'arc': {
82
+ // @ts-ignore es6 build doesn't allow dynamic imports
83
+ const arcCameraModule = await import(
84
+ /* webpackChunkName: "arc-rotate-camera" */ '@babylonjs/core/Cameras/arcRotateCamera'
85
+ );
86
+ camera = new arcCameraModule.ArcRotateCamera(name, Math.PI / 4, Math.PI / 4, 2, target, scene);
87
+ camera.metadata = {
88
+ alpha: Math.PI / 4,
89
+ beta: Math.PI / 4,
90
+ radius: 2,
91
+ };
92
+ break;
93
+ }
94
+ }
95
+ if (cameraSetup.active) {
96
+ camera.attachControl(scene.getEngine().getRenderingCanvas()!, true);
97
+ }
98
+ if (cameraSetup.fov) {
99
+ camera.fov = cameraSetup.fov;
100
+ }
101
+ camera.storeState();
102
+ return camera;
103
+ };
104
+
105
+ /**
106
+ * @param engine
107
+ * @param sceneJson
108
+ */
109
+ const sceneSetup = async function (engine: Engine, sceneJson: SceneJson): Promise<Scene> {
110
+ const scene = new Scene(engine);
111
+ scene.clearColor = defaultSceneClearColor;
112
+ // cameras
113
+ const cameras: Camera[] = [];
114
+ const cameraDefinitions = get(sceneJson.scene, 'cameras') as CameraDefinitions;
115
+ if (!isEmpty(cameraDefinitions)) {
116
+ for (const cameraName in cameraDefinitions) {
117
+ cameras.push(await processCamera(scene, cameraName, cameraDefinitions[cameraName]));
118
+ }
119
+ } else {
120
+ const camera = await defaultCamera(scene);
121
+ cameras.push(camera);
122
+ }
123
+ // grounds
124
+ const groundDefinitions = get(sceneJson.scene, 'grounds', {}) as GroundDefinitions;
125
+ if (!isEmpty(groundDefinitions)) {
126
+ for (const groundName in groundDefinitions) {
127
+ await processGround(scene, groundName, groundDefinitions[groundName]);
128
+ }
129
+ }
130
+ // TODO: try to split this away from the default rendering pipeline to save module imports
131
+ // The "hdr" setting had negative effect on rendering in Safari. Everything looked a little "edgy". I'm not completely
132
+ // sure if disabling it comes with other negative side effects I don't see right now, so we should probably
133
+ // investigate this a little more in detail at some point.
134
+ const defaultPipeline = new DefaultRenderingPipeline('default-rendering-pipeline', false, scene);
135
+ /* DISABLED: causes problems with Internet Explorer
136
+ defaultPipeline.imageProcessingEnabled = true;
137
+ */
138
+ if (sceneJson.scene.globals.aa) {
139
+ defaultPipeline.fxaaEnabled = true; //implicitly does FxaaPostProcess()
140
+ }
141
+ // Set samples regardless of fxaa setting since we don't want to use fxaa but still increase the sample count
142
+ defaultPipeline.samples = 8;
143
+ if (sceneJson.scene.globals['camera-settings']) {
144
+ if (
145
+ sceneJson.scene.globals['camera-settings']!.sharpen &&
146
+ sceneJson.scene.globals['camera-settings']!.sharpen.enabled
147
+ ) {
148
+ defaultPipeline.sharpenEnabled = true; //implicitly does SharpenPostProcess()
149
+ //defaultPipeline.sharpen.colorAmount = 1;
150
+ //defaultPipeline.sharpen.edgeAmount = 0;
151
+ }
152
+ if (
153
+ sceneJson.scene.globals['camera-settings']!.bloom &&
154
+ sceneJson.scene.globals['camera-settings']!.bloom.enabled
155
+ ) {
156
+ defaultPipeline.bloomEnabled = true;
157
+ if (sceneJson.scene.globals['camera-settings']!.bloom.size) {
158
+ defaultPipeline.bloomScale = sceneJson.scene.globals['camera-settings']!.bloom.size;
159
+ }
160
+ if (sceneJson.scene.globals['camera-settings']!.bloom.threshold) {
161
+ defaultPipeline.bloomThreshold = sceneJson.scene.globals['camera-settings']!.bloom.threshold;
162
+ }
163
+ }
164
+ if (sceneJson.scene.globals['camera-settings']!.contrast) {
165
+ scene.imageProcessingConfiguration.contrast = sceneJson.scene.globals['camera-settings']!.contrast;
166
+ }
167
+ if (sceneJson.scene.globals['camera-settings']!.exposure) {
168
+ scene.imageProcessingConfiguration.exposure = sceneJson.scene.globals['camera-settings']!.exposure;
169
+ }
170
+ if (sceneJson.scene.globals['camera-settings']!.dof && sceneJson.scene.globals['camera-settings']!.dof.enabled) {
171
+ // @ts-ignore es6 build doesn't allow dynamic imports
172
+ const module = await import(/* webpackChunkName: "lens-rendering" */ './lensRendering');
173
+ new module.LensRenderingPipeline(
174
+ 'lens-rendering',
175
+ sceneJson.scene.globals['camera-settings']!.dof.settings,
176
+ scene,
177
+ 1.0,
178
+ cameras
179
+ );
180
+ }
181
+ }
182
+ // TODO: make this dynamic
183
+ /*
184
+ const texture = new HDRCubeTexture("/assets/small_cave_1k.hdr", scene, 256);
185
+ texture.gammaSpace = false;
186
+ scene.environmentTexture = texture;
187
+ // scene.environmentTexture.
188
+
189
+ const skyboxMaterial = new StandardMaterial("skyBox", scene);
190
+ skyboxMaterial.backFaceCulling = false;
191
+ skyboxMaterial.reflectionTexture = texture;
192
+ skyboxMaterial.reflectionTexture.coordinatesMode = Texture.SKYBOX_MODE;
193
+ skyboxMaterial.disableLighting = false;
194
+ // TODO: replace with BoxBuilder
195
+ const skybox = MeshBuilder.CreateBox("skyBox", {size: 1000.0}, scene);
196
+ skybox.isPickable = false; //never pick a skybox
197
+ skybox.infiniteDistance = true;
198
+ skybox.material = skyboxMaterial;
199
+ */
200
+
201
+ // TODO: shadows don't work with HemishpericLight
202
+ return scene;
203
+ };
204
+
205
+ export { sceneSetup, defaultSceneClearColor, defaultEnvHelperColor };