@combeenation/3d-viewer 8.1.0-alpha1 → 9.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 (113) hide show
  1. package/README.md +111 -111
  2. package/dist/lib-cjs/api/classes/animationInterface.d.ts +8 -8
  3. package/dist/lib-cjs/api/classes/animationInterface.js +2 -2
  4. package/dist/lib-cjs/api/classes/dottedPath.d.ts +79 -79
  5. package/dist/lib-cjs/api/classes/dottedPath.js +166 -166
  6. package/dist/lib-cjs/api/classes/element.d.ts +153 -153
  7. package/dist/lib-cjs/api/classes/element.js +667 -672
  8. package/dist/lib-cjs/api/classes/element.js.map +1 -1
  9. package/dist/lib-cjs/api/classes/event.d.ts +401 -401
  10. package/dist/lib-cjs/api/classes/event.js +424 -424
  11. package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +26 -26
  12. package/dist/lib-cjs/api/classes/eventBroadcaster.js +49 -49
  13. package/dist/lib-cjs/api/classes/fuzzyMap.d.ts +7 -7
  14. package/dist/lib-cjs/api/classes/fuzzyMap.js +21 -21
  15. package/dist/lib-cjs/api/classes/parameter.d.ts +410 -378
  16. package/dist/lib-cjs/api/classes/parameter.js +642 -551
  17. package/dist/lib-cjs/api/classes/parameter.js.map +1 -1
  18. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
  19. package/dist/lib-cjs/api/classes/parameterObservable.js +72 -72
  20. package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
  21. package/dist/lib-cjs/api/classes/parameterizable.js +102 -102
  22. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +45 -45
  23. package/dist/lib-cjs/api/classes/placementAnimation.js +176 -176
  24. package/dist/lib-cjs/api/classes/variant.d.ts +261 -261
  25. package/dist/lib-cjs/api/classes/variant.js +870 -870
  26. package/dist/lib-cjs/api/classes/variant.js.map +1 -1
  27. package/dist/lib-cjs/api/classes/variantInstance.d.ts +53 -53
  28. package/dist/lib-cjs/api/classes/variantInstance.js +125 -125
  29. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
  30. package/dist/lib-cjs/api/classes/variantParameterizable.js +86 -86
  31. package/dist/lib-cjs/api/classes/viewer.d.ts +213 -213
  32. package/dist/lib-cjs/api/classes/viewer.js +717 -717
  33. package/dist/lib-cjs/api/classes/viewerError.d.ts +43 -43
  34. package/dist/lib-cjs/api/classes/viewerError.js +55 -55
  35. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  36. package/dist/lib-cjs/api/classes/viewerLight.js +348 -348
  37. package/dist/lib-cjs/api/classes/viewerLight.js.map +1 -1
  38. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  39. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  40. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  41. package/dist/lib-cjs/api/internal/sceneSetup.js +226 -226
  42. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  43. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  44. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +103 -103
  45. package/dist/lib-cjs/api/manager/gltfExportManager.js +325 -325
  46. package/dist/lib-cjs/api/manager/gltfExportManager.js.map +1 -1
  47. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  48. package/dist/lib-cjs/api/manager/sceneManager.js +128 -128
  49. package/dist/lib-cjs/api/manager/tagManager.d.ts +118 -118
  50. package/dist/lib-cjs/api/manager/tagManager.js +522 -508
  51. package/dist/lib-cjs/api/manager/tagManager.js.map +1 -1
  52. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  53. package/dist/lib-cjs/api/manager/textureLoadManager.js +97 -97
  54. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +106 -106
  55. package/dist/lib-cjs/api/manager/variantInstanceManager.js +290 -290
  56. package/dist/lib-cjs/api/store/specStorage.d.ts +32 -32
  57. package/dist/lib-cjs/api/store/specStorage.js +65 -65
  58. package/dist/lib-cjs/api/util/babylonHelper.d.ts +237 -235
  59. package/dist/lib-cjs/api/util/babylonHelper.js +825 -753
  60. package/dist/lib-cjs/api/util/babylonHelper.js.map +1 -1
  61. package/dist/lib-cjs/api/util/globalTypes.d.ts +479 -469
  62. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  63. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  64. package/dist/lib-cjs/api/util/resourceHelper.js +211 -203
  65. package/dist/lib-cjs/api/util/resourceHelper.js.map +1 -1
  66. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +44 -44
  67. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +175 -175
  68. package/dist/lib-cjs/api/util/sceneLoaderHelper.js.map +1 -1
  69. package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
  70. package/dist/lib-cjs/api/util/stringHelper.js +32 -32
  71. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  72. package/dist/lib-cjs/api/util/structureHelper.js +60 -60
  73. package/dist/lib-cjs/buildinfo.json +3 -3
  74. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  75. package/dist/lib-cjs/index.d.ts +54 -54
  76. package/dist/lib-cjs/index.js +117 -117
  77. package/package.json +82 -81
  78. package/src/api/classes/animationInterface.ts +10 -10
  79. package/src/api/classes/dottedPath.ts +181 -181
  80. package/src/api/classes/element.ts +723 -733
  81. package/src/api/classes/event.ts +457 -457
  82. package/src/api/classes/eventBroadcaster.ts +52 -52
  83. package/src/api/classes/fuzzyMap.ts +21 -21
  84. package/src/api/classes/parameter.ts +686 -591
  85. package/src/api/classes/parameterObservable.ts +73 -73
  86. package/src/api/classes/parameterizable.ts +87 -87
  87. package/src/api/classes/placementAnimation.ts +162 -162
  88. package/src/api/classes/variant.ts +963 -963
  89. package/src/api/classes/variantInstance.ts +123 -123
  90. package/src/api/classes/variantParameterizable.ts +83 -83
  91. package/src/api/classes/viewer.ts +770 -770
  92. package/src/api/classes/viewerError.ts +63 -63
  93. package/src/api/classes/viewerLight.ts +339 -339
  94. package/src/api/internal/debugViewer.ts +90 -90
  95. package/src/api/internal/lensRendering.ts +9 -9
  96. package/src/api/internal/sceneSetup.ts +205 -205
  97. package/src/api/manager/animationManager.ts +143 -143
  98. package/src/api/manager/gltfExportManager.ts +302 -302
  99. package/src/api/manager/sceneManager.ts +134 -134
  100. package/src/api/manager/tagManager.ts +564 -536
  101. package/src/api/manager/textureLoadManager.ts +95 -95
  102. package/src/api/manager/variantInstanceManager.ts +306 -306
  103. package/src/api/store/specStorage.ts +68 -68
  104. package/src/api/util/babylonHelper.ts +913 -823
  105. package/src/api/util/globalTypes.ts +555 -543
  106. package/src/api/util/resourceHelper.ts +198 -191
  107. package/src/api/util/sceneLoaderHelper.ts +170 -170
  108. package/src/api/util/stringHelper.ts +30 -30
  109. package/src/api/util/structureHelper.ts +60 -60
  110. package/src/buildinfo.json +3 -3
  111. package/src/dev.ts +62 -62
  112. package/src/index.ts +103 -103
  113. package/src/types.d.ts +38 -38
@@ -1,127 +1,127 @@
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.AnimationManager = void 0;
13
- const placementAnimation_1 = require("../classes/placementAnimation");
14
- const animation_1 = require("@babylonjs/core/Animations/animation");
15
- //import { CustomEase } from 'gsap/CustomEase';
16
- //import { ExpoScaleEase, RoughEase, SlowMo } from 'gsap/EasePack';
17
- const lodash_es_1 = require("lodash-es");
18
- //gsap.registerPlugin( CustomEase, ExpoScaleEase, RoughEase, SlowMo );
19
- class AnimationManager {
20
- /**
21
- * Constructor.
22
- */
23
- constructor(scene) {
24
- this.scene = scene;
25
- this.animations = [];
26
- }
27
- /**
28
- * Creates an {@link AnimationManager} based on given Babylon.js scene.
29
- */
30
- static create(scene) {
31
- return __awaiter(this, void 0, void 0, function* () {
32
- return new AnimationManager(scene);
33
- });
34
- }
35
- /**
36
- * @deprecated Use viewer.moveCameraTo().
37
- */
38
- resetCamera(animate = false) {
39
- //TODO currently only works for arcrotate. are there any other cameras?
40
- const activeCamera = this.scene.activeCamera;
41
- if (!activeCamera) {
42
- throw new Error('There is no active camera');
43
- }
44
- const initAlpha = activeCamera.metadata.alpha;
45
- const initBeta = activeCamera.metadata.beta;
46
- const initRadius = activeCamera.metadata.radius;
47
- if (animate) {
48
- this.animateArcRotateCamera(initAlpha, initBeta, initRadius);
49
- }
50
- else {
51
- activeCamera.alpha = initAlpha;
52
- activeCamera.beta = initBeta;
53
- activeCamera.radius = initRadius;
54
- }
55
- }
56
- /**
57
- * @deprecated Use viewer.moveCameraTo().
58
- */
59
- animateArcRotateCamera(targetAlpha, targetBeta, targetRadius) {
60
- const activeCamera = this.scene.activeCamera;
61
- if (!activeCamera) {
62
- throw new Error('There is no active camera');
63
- }
64
- const alphaAnimation = new animation_1.Animation('alphaAnimation', 'alpha', 30, animation_1.Animation.ANIMATIONTYPE_FLOAT, animation_1.Animation.ANIMATIONLOOPMODE_CONSTANT);
65
- const betaAnimation = new animation_1.Animation('betaAnimation', 'beta', 30, animation_1.Animation.ANIMATIONTYPE_FLOAT, animation_1.Animation.ANIMATIONLOOPMODE_CONSTANT);
66
- const radiusAnimation = new animation_1.Animation('radiusAnimation', 'radius', 30, animation_1.Animation.ANIMATIONTYPE_FLOAT, animation_1.Animation.ANIMATIONLOOPMODE_CONSTANT);
67
- alphaAnimation.setKeys([
68
- {
69
- frame: 0,
70
- value: activeCamera.alpha,
71
- },
72
- {
73
- frame: 100,
74
- value: targetAlpha,
75
- },
76
- ]);
77
- betaAnimation.setKeys([
78
- {
79
- frame: 0,
80
- value: activeCamera.beta,
81
- },
82
- {
83
- frame: 100,
84
- value: targetBeta,
85
- },
86
- ]);
87
- radiusAnimation.setKeys([
88
- {
89
- frame: 0,
90
- value: activeCamera.radius,
91
- },
92
- {
93
- frame: 100,
94
- value: targetRadius,
95
- },
96
- ]);
97
- activeCamera.animations.push(alphaAnimation);
98
- activeCamera.animations.push(betaAnimation);
99
- activeCamera.animations.push(radiusAnimation);
100
- const animation = this.scene.beginAnimation(activeCamera, 0, 100, false, 10);
101
- animation.disposeOnEnd = true;
102
- }
103
- /**
104
- * Stops and kills all running animations.
105
- */
106
- killAllAnimations() {
107
- this.animations.forEach(animation => animation.kill());
108
- this.animations = [];
109
- }
110
- /**
111
- * @see {@link PlacementAnimation.play}
112
- */
113
- animateToPlacement(mutable, placement, animation) {
114
- return __awaiter(this, void 0, void 0, function* () {
115
- const _animation = new placementAnimation_1.PlacementAnimation(mutable, placement, animation);
116
- this.animations.push(_animation);
117
- const animationPromise = _animation.play();
118
- animationPromise.then(a => {
119
- (0, lodash_es_1.remove)(this.animations, _a => _a === a);
120
- a.kill();
121
- });
122
- return yield animationPromise;
123
- });
124
- }
125
- }
126
- exports.AnimationManager = AnimationManager;
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.AnimationManager = void 0;
13
+ const placementAnimation_1 = require("../classes/placementAnimation");
14
+ const animation_1 = require("@babylonjs/core/Animations/animation");
15
+ //import { CustomEase } from 'gsap/CustomEase';
16
+ //import { ExpoScaleEase, RoughEase, SlowMo } from 'gsap/EasePack';
17
+ const lodash_es_1 = require("lodash-es");
18
+ //gsap.registerPlugin( CustomEase, ExpoScaleEase, RoughEase, SlowMo );
19
+ class AnimationManager {
20
+ /**
21
+ * Constructor.
22
+ */
23
+ constructor(scene) {
24
+ this.scene = scene;
25
+ this.animations = [];
26
+ }
27
+ /**
28
+ * Creates an {@link AnimationManager} based on given Babylon.js scene.
29
+ */
30
+ static create(scene) {
31
+ return __awaiter(this, void 0, void 0, function* () {
32
+ return new AnimationManager(scene);
33
+ });
34
+ }
35
+ /**
36
+ * @deprecated Use viewer.moveCameraTo().
37
+ */
38
+ resetCamera(animate = false) {
39
+ //TODO currently only works for arcrotate. are there any other cameras?
40
+ const activeCamera = this.scene.activeCamera;
41
+ if (!activeCamera) {
42
+ throw new Error('There is no active camera');
43
+ }
44
+ const initAlpha = activeCamera.metadata.alpha;
45
+ const initBeta = activeCamera.metadata.beta;
46
+ const initRadius = activeCamera.metadata.radius;
47
+ if (animate) {
48
+ this.animateArcRotateCamera(initAlpha, initBeta, initRadius);
49
+ }
50
+ else {
51
+ activeCamera.alpha = initAlpha;
52
+ activeCamera.beta = initBeta;
53
+ activeCamera.radius = initRadius;
54
+ }
55
+ }
56
+ /**
57
+ * @deprecated Use viewer.moveCameraTo().
58
+ */
59
+ animateArcRotateCamera(targetAlpha, targetBeta, targetRadius) {
60
+ const activeCamera = this.scene.activeCamera;
61
+ if (!activeCamera) {
62
+ throw new Error('There is no active camera');
63
+ }
64
+ const alphaAnimation = new animation_1.Animation('alphaAnimation', 'alpha', 30, animation_1.Animation.ANIMATIONTYPE_FLOAT, animation_1.Animation.ANIMATIONLOOPMODE_CONSTANT);
65
+ const betaAnimation = new animation_1.Animation('betaAnimation', 'beta', 30, animation_1.Animation.ANIMATIONTYPE_FLOAT, animation_1.Animation.ANIMATIONLOOPMODE_CONSTANT);
66
+ const radiusAnimation = new animation_1.Animation('radiusAnimation', 'radius', 30, animation_1.Animation.ANIMATIONTYPE_FLOAT, animation_1.Animation.ANIMATIONLOOPMODE_CONSTANT);
67
+ alphaAnimation.setKeys([
68
+ {
69
+ frame: 0,
70
+ value: activeCamera.alpha,
71
+ },
72
+ {
73
+ frame: 100,
74
+ value: targetAlpha,
75
+ },
76
+ ]);
77
+ betaAnimation.setKeys([
78
+ {
79
+ frame: 0,
80
+ value: activeCamera.beta,
81
+ },
82
+ {
83
+ frame: 100,
84
+ value: targetBeta,
85
+ },
86
+ ]);
87
+ radiusAnimation.setKeys([
88
+ {
89
+ frame: 0,
90
+ value: activeCamera.radius,
91
+ },
92
+ {
93
+ frame: 100,
94
+ value: targetRadius,
95
+ },
96
+ ]);
97
+ activeCamera.animations.push(alphaAnimation);
98
+ activeCamera.animations.push(betaAnimation);
99
+ activeCamera.animations.push(radiusAnimation);
100
+ const animation = this.scene.beginAnimation(activeCamera, 0, 100, false, 10);
101
+ animation.disposeOnEnd = true;
102
+ }
103
+ /**
104
+ * Stops and kills all running animations.
105
+ */
106
+ killAllAnimations() {
107
+ this.animations.forEach(animation => animation.kill());
108
+ this.animations = [];
109
+ }
110
+ /**
111
+ * @see {@link PlacementAnimation.play}
112
+ */
113
+ animateToPlacement(mutable, placement, animation) {
114
+ return __awaiter(this, void 0, void 0, function* () {
115
+ const _animation = new placementAnimation_1.PlacementAnimation(mutable, placement, animation);
116
+ this.animations.push(_animation);
117
+ const animationPromise = _animation.play();
118
+ animationPromise.then(a => {
119
+ (0, lodash_es_1.remove)(this.animations, _a => _a === a);
120
+ a.kill();
121
+ });
122
+ return yield animationPromise;
123
+ });
124
+ }
125
+ }
126
+ exports.AnimationManager = AnimationManager;
127
127
  //# sourceMappingURL=animationManager.js.map
@@ -1,103 +1,103 @@
1
- import { Viewer } from '../classes/viewer';
2
- import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
3
- import { IExportOptions } from '@babylonjs/serializers/glTF/2.0';
4
- declare type MetadataMap = {
5
- [key: string]: any;
6
- };
7
- export declare class GltfExportManager {
8
- protected viewer: Viewer;
9
- protected static readonly _CLONED_FROM_MAT_METADATA_PROPERTY = "clonedFrom";
10
- static readonly NAME_BEFORE_EXPORT_METADATA_PROPERTY = "nameBeforeExport";
11
- /**
12
- * Constructor.
13
- */
14
- protected constructor(viewer: Viewer);
15
- /**
16
- * Creates an {@link GltfExportManager}.
17
- */
18
- static create(viewer: Viewer): Promise<GltfExportManager>;
19
- /**
20
- * Exports selected nodes to a file.
21
- * @param filename optional name of the exported .GLB file.
22
- * @param exportOptions export options to be merged with default options.\
23
- * `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
24
- * @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
25
- * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
26
- */
27
- exportGlb(filename?: string, { exchangeRefractionMaterials, ...exportOptions }?: IExportOptionsExtended, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<File | undefined>;
28
- /**
29
- * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported separately.
30
- * @param filename name of the main (text-based) .GLTF file referring to separate texture files.
31
- * @param exportOptions export options to be merged with default options.\
32
- * `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
33
- * @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
34
- * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
35
- */
36
- exportGltfToFile(filename: string, { exchangeRefractionMaterials, ...exportOptions }?: IExportOptionsExtended, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<void>;
37
- /**
38
- * Exports selected nodes to GLB. This results in one binary file.
39
- * @param filename name of the .GLB file.
40
- * @param exportOptions export options to be merged with default options.\
41
- * `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
42
- * @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
43
- * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
44
- */
45
- exportGlbToFile(filename: string, { exchangeRefractionMaterials, ...exportOptions }?: IExportOptionsExtended, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<void>;
46
- /**
47
- * Gets predefined {@link IExportOptions } merged with given ones.
48
- */
49
- protected gltfExportOptions(mergeWithOptions?: IExportOptions, excluded?: ExcludedGeometryList): IExportOptions;
50
- /**
51
- * Stuff to be done before exporting to GLTF
52
- *
53
- * @returns Either the original scene if no adjustments have been made or a copied scene (which can be disposed after
54
- * the export) if adjustments have been made
55
- */
56
- protected exportPreProcess(exchangeRefractionMaterials: boolean, optimizeForAR: boolean): Promise<{
57
- scene: Scene;
58
- sceneCopied: boolean;
59
- }>;
60
- /**
61
- * Create a copy of the viewer scene, which can be further processed and optimized for the GLB export.
62
- * There is no "scene.clone" function, therefore the scene is serialized and loaded again to achieve this result.
63
- */
64
- protected copyViewerScene(): Promise<Scene>;
65
- /**
66
- * Stuff to be done after the GLTF export
67
- */
68
- protected exportPostProcess(scene: Scene, disposeScene: boolean): void;
69
- /**
70
- * Remove all node metadata and return them in a map
71
- */
72
- protected extractMetadataOfAllNodes(): MetadataMap;
73
- /**
74
- * Restore node metadata from previously cropped metadata map
75
- */
76
- protected restoreMetadataOfAllNodes(metadataMap: MetadataMap): void;
77
- /**
78
- * Materials with refraction set are not exported properly.
79
- * Exchange all such (relevant) materials with a more export-friendly version
80
- */
81
- protected exchangeRefractionMaterials(scene: Scene): void;
82
- /**
83
- * Create an export-friendly replacement material for a material using refraction.
84
- * @param mat Material to be replaced
85
- */
86
- protected createRefractionMaterialReplacement(mat: PBRMaterial): PBRMaterial;
87
- /**
88
- * Inspect if a material was temporarily cloned for GLB export
89
- * @param mat Material to be inspected
90
- */
91
- protected isMaterialClonedForExport(mat: PBRMaterial): boolean;
92
- /**
93
- * Set unique mesh names for GLB export.
94
- * Duplicate names lead to problems in AR on iOS devices.
95
- */
96
- protected setUniqueMeshNames(scene: Scene): void;
97
- /**
98
- * Stores the effect of all mesh transformations in their geometry and reset the transformation afterwards.
99
- * In this way negative scalings which lead to problems in AR on iOS devices can be eliminated.
100
- */
101
- protected bakeTransformations(scene: Scene): void;
102
- }
103
- export {};
1
+ import { Viewer } from '../classes/viewer';
2
+ import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
3
+ import { IExportOptions } from '@babylonjs/serializers/glTF/2.0';
4
+ declare type MetadataMap = {
5
+ [key: string]: any;
6
+ };
7
+ export declare class GltfExportManager {
8
+ protected viewer: Viewer;
9
+ protected static readonly _CLONED_FROM_MAT_METADATA_PROPERTY = "clonedFrom";
10
+ static readonly NAME_BEFORE_EXPORT_METADATA_PROPERTY = "nameBeforeExport";
11
+ /**
12
+ * Constructor.
13
+ */
14
+ protected constructor(viewer: Viewer);
15
+ /**
16
+ * Creates an {@link GltfExportManager}.
17
+ */
18
+ static create(viewer: Viewer): Promise<GltfExportManager>;
19
+ /**
20
+ * Exports selected nodes to a file.
21
+ * @param filename optional name of the exported .GLB file.
22
+ * @param exportOptions export options to be merged with default options.\
23
+ * `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
24
+ * @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
25
+ * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
26
+ */
27
+ exportGlb(filename?: string, { exchangeRefractionMaterials, ...exportOptions }?: IExportOptionsExtended, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<File | undefined>;
28
+ /**
29
+ * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported separately.
30
+ * @param filename name of the main (text-based) .GLTF file referring to separate texture files.
31
+ * @param exportOptions export options to be merged with default options.\
32
+ * `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
33
+ * @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
34
+ * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
35
+ */
36
+ exportGltfToFile(filename: string, { exchangeRefractionMaterials, ...exportOptions }?: IExportOptionsExtended, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<void>;
37
+ /**
38
+ * Exports selected nodes to GLB. This results in one binary file.
39
+ * @param filename name of the .GLB file.
40
+ * @param exportOptions export options to be merged with default options.\
41
+ * `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
42
+ * @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
43
+ * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
44
+ */
45
+ exportGlbToFile(filename: string, { exchangeRefractionMaterials, ...exportOptions }?: IExportOptionsExtended, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<void>;
46
+ /**
47
+ * Gets predefined {@link IExportOptions } merged with given ones.
48
+ */
49
+ protected gltfExportOptions(mergeWithOptions?: IExportOptions, excluded?: ExcludedGeometryList): IExportOptions;
50
+ /**
51
+ * Stuff to be done before exporting to GLTF
52
+ *
53
+ * @returns Either the original scene if no adjustments have been made or a copied scene (which can be disposed after
54
+ * the export) if adjustments have been made
55
+ */
56
+ protected exportPreProcess(exchangeRefractionMaterials: boolean, optimizeForAR: boolean): Promise<{
57
+ scene: Scene;
58
+ sceneCopied: boolean;
59
+ }>;
60
+ /**
61
+ * Create a copy of the viewer scene, which can be further processed and optimized for the GLB export.
62
+ * There is no "scene.clone" function, therefore the scene is serialized and loaded again to achieve this result.
63
+ */
64
+ protected copyViewerScene(): Promise<Scene>;
65
+ /**
66
+ * Stuff to be done after the GLTF export
67
+ */
68
+ protected exportPostProcess(scene: Scene, disposeScene: boolean): void;
69
+ /**
70
+ * Remove all node metadata and return them in a map
71
+ */
72
+ protected extractMetadataOfAllNodes(): MetadataMap;
73
+ /**
74
+ * Restore node metadata from previously cropped metadata map
75
+ */
76
+ protected restoreMetadataOfAllNodes(metadataMap: MetadataMap): void;
77
+ /**
78
+ * Materials with refraction set are not exported properly.
79
+ * Exchange all such (relevant) materials with a more export-friendly version
80
+ */
81
+ protected exchangeRefractionMaterials(scene: Scene): void;
82
+ /**
83
+ * Create an export-friendly replacement material for a material using refraction.
84
+ * @param mat Material to be replaced
85
+ */
86
+ protected createRefractionMaterialReplacement(mat: PBRMaterial): PBRMaterial;
87
+ /**
88
+ * Inspect if a material was temporarily cloned for GLB export
89
+ * @param mat Material to be inspected
90
+ */
91
+ protected isMaterialClonedForExport(mat: PBRMaterial): boolean;
92
+ /**
93
+ * Set unique mesh names for GLB export.
94
+ * Duplicate names lead to problems in AR on iOS devices.
95
+ */
96
+ protected setUniqueMeshNames(scene: Scene): void;
97
+ /**
98
+ * Stores the effect of all mesh transformations in their geometry and reset the transformation afterwards.
99
+ * In this way negative scalings which lead to problems in AR on iOS devices can be eliminated.
100
+ */
101
+ protected bakeTransformations(scene: Scene): void;
102
+ }
103
+ export {};