@combeenation/3d-viewer 12.4.1 → 12.4.3

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 (114) hide show
  1. package/README.md +9 -9
  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 +702 -702
  8. package/dist/lib-cjs/api/classes/event.d.ts +401 -401
  9. package/dist/lib-cjs/api/classes/event.js +424 -424
  10. package/dist/lib-cjs/api/classes/eventBroadcaster.d.ts +26 -26
  11. package/dist/lib-cjs/api/classes/eventBroadcaster.js +49 -49
  12. package/dist/lib-cjs/api/classes/fuzzyMap.d.ts +7 -7
  13. package/dist/lib-cjs/api/classes/fuzzyMap.js +21 -21
  14. package/dist/lib-cjs/api/classes/parameter.d.ts +410 -410
  15. package/dist/lib-cjs/api/classes/parameter.js +642 -642
  16. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
  17. package/dist/lib-cjs/api/classes/parameterObservable.js +72 -72
  18. package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
  19. package/dist/lib-cjs/api/classes/parameterizable.js +102 -102
  20. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +45 -45
  21. package/dist/lib-cjs/api/classes/placementAnimation.js +176 -176
  22. package/dist/lib-cjs/api/classes/variant.d.ts +261 -261
  23. package/dist/lib-cjs/api/classes/variant.js +872 -872
  24. package/dist/lib-cjs/api/classes/variantInstance.d.ts +53 -53
  25. package/dist/lib-cjs/api/classes/variantInstance.js +125 -125
  26. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
  27. package/dist/lib-cjs/api/classes/variantParameterizable.js +86 -86
  28. package/dist/lib-cjs/api/classes/viewer.d.ts +215 -215
  29. package/dist/lib-cjs/api/classes/viewer.js +708 -708
  30. package/dist/lib-cjs/api/classes/viewerError.d.ts +43 -43
  31. package/dist/lib-cjs/api/classes/viewerError.js +55 -55
  32. package/dist/lib-cjs/api/classes/viewerLight.d.ts +66 -66
  33. package/dist/lib-cjs/api/classes/viewerLight.js +344 -344
  34. package/dist/lib-cjs/api/internal/lensRendering.d.ts +8 -8
  35. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  36. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  37. package/dist/lib-cjs/api/internal/sceneSetup.js +227 -227
  38. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  39. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  40. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +80 -80
  41. package/dist/lib-cjs/api/manager/gltfExportManager.js +300 -299
  42. package/dist/lib-cjs/api/manager/gltfExportManager.js.map +1 -1
  43. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  44. package/dist/lib-cjs/api/manager/sceneManager.js +128 -128
  45. package/dist/lib-cjs/api/manager/tagManager.d.ts +118 -118
  46. package/dist/lib-cjs/api/manager/tagManager.js +530 -530
  47. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  48. package/dist/lib-cjs/api/manager/textureLoadManager.js +107 -107
  49. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +106 -106
  50. package/dist/lib-cjs/api/manager/variantInstanceManager.js +290 -290
  51. package/dist/lib-cjs/api/store/specStorage.d.ts +32 -32
  52. package/dist/lib-cjs/api/store/specStorage.js +65 -65
  53. package/dist/lib-cjs/api/util/babylonHelper.d.ts +238 -238
  54. package/dist/lib-cjs/api/util/babylonHelper.js +825 -825
  55. package/dist/lib-cjs/api/util/debugHelper.d.ts +9 -9
  56. package/dist/lib-cjs/api/util/debugHelper.js +93 -93
  57. package/dist/lib-cjs/api/util/deviceHelper.d.ts +9 -9
  58. package/dist/lib-cjs/api/util/deviceHelper.js +28 -28
  59. package/dist/lib-cjs/api/util/geometryHelper.d.ts +17 -17
  60. package/dist/lib-cjs/api/util/geometryHelper.js +112 -112
  61. package/dist/lib-cjs/api/util/globalTypes.d.ts +490 -490
  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 +214 -214
  65. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +58 -58
  66. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +228 -228
  67. package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
  68. package/dist/lib-cjs/api/util/stringHelper.js +32 -32
  69. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  70. package/dist/lib-cjs/api/util/structureHelper.js +57 -57
  71. package/dist/lib-cjs/buildinfo.json +3 -3
  72. package/dist/lib-cjs/commonjs.tsconfig.tsbuildinfo +1 -1
  73. package/dist/lib-cjs/index.d.ts +63 -63
  74. package/dist/lib-cjs/index.js +128 -128
  75. package/package.json +93 -92
  76. package/src/api/classes/animationInterface.ts +10 -10
  77. package/src/api/classes/dottedPath.ts +181 -181
  78. package/src/api/classes/element.ts +766 -766
  79. package/src/api/classes/event.ts +457 -457
  80. package/src/api/classes/eventBroadcaster.ts +52 -52
  81. package/src/api/classes/fuzzyMap.ts +21 -21
  82. package/src/api/classes/parameter.ts +686 -686
  83. package/src/api/classes/parameterObservable.ts +73 -73
  84. package/src/api/classes/parameterizable.ts +87 -87
  85. package/src/api/classes/placementAnimation.ts +162 -162
  86. package/src/api/classes/variant.ts +965 -965
  87. package/src/api/classes/variantInstance.ts +123 -123
  88. package/src/api/classes/variantParameterizable.ts +83 -83
  89. package/src/api/classes/viewer.ts +751 -751
  90. package/src/api/classes/viewerError.ts +63 -63
  91. package/src/api/classes/viewerLight.ts +335 -335
  92. package/src/api/internal/debugViewer.ts +90 -90
  93. package/src/api/internal/lensRendering.ts +9 -9
  94. package/src/api/internal/sceneSetup.ts +208 -208
  95. package/src/api/manager/animationManager.ts +143 -143
  96. package/src/api/manager/gltfExportManager.ts +337 -334
  97. package/src/api/manager/sceneManager.ts +134 -134
  98. package/src/api/manager/tagManager.ts +572 -572
  99. package/src/api/manager/textureLoadManager.ts +107 -107
  100. package/src/api/manager/variantInstanceManager.ts +306 -306
  101. package/src/api/store/specStorage.ts +68 -68
  102. package/src/api/util/babylonHelper.ts +915 -915
  103. package/src/api/util/debugHelper.ts +121 -121
  104. package/src/api/util/deviceHelper.ts +31 -31
  105. package/src/api/util/geometryHelper.ts +142 -142
  106. package/src/api/util/globalTypes.ts +566 -566
  107. package/src/api/util/resourceHelper.ts +201 -201
  108. package/src/api/util/sceneLoaderHelper.ts +247 -247
  109. package/src/api/util/stringHelper.ts +30 -30
  110. package/src/api/util/structureHelper.ts +62 -62
  111. package/src/buildinfo.json +3 -3
  112. package/src/dev.ts +70 -70
  113. package/src/index.ts +116 -116
  114. package/src/types.d.ts +49 -49
@@ -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,80 +1,80 @@
1
- import { Viewer } from '../classes/viewer';
2
- import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
3
- import { Node as BjsNode } from '@babylonjs/core/node';
4
- import '@babylonjs/serializers/glTF/2.0/Extensions/KHR_texture_transform';
5
- export declare class GltfExportManager {
6
- protected viewer: Viewer;
7
- protected static readonly _METADATA_PROPS: {
8
- exportNode: string;
9
- deleteAfterExport: string;
10
- exchangeMaterialWith: string;
11
- };
12
- protected static readonly _EXPORT_ROOT_NAME = "__export_root__";
13
- protected _maxTextureSize: number;
14
- protected constructor(viewer: Viewer);
15
- static create(viewer: Viewer): Promise<GltfExportManager>;
16
- /**
17
- * Exports selected nodes to a file.
18
- * @param filename Optional name of the exported .GLB file.
19
- * @param optimizeForAR Adjusts the exported GLB so that known issues get automatically fixed, this
20
- * is mostly targeting Apples .usdz format.
21
- * @param excluded Optional list of geometry (meshes, elements, variants,...) to be excluded from the export.
22
- */
23
- exportGlb(filename?: string, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<File | undefined>;
24
- /**
25
- * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported seperately.
26
- * @param filename Name of the main (text-based) .GLTF file referring to separate texture files.
27
- * @param optimizeForAR Adjusts the exported GLB so that known issues get automatically fixed, this
28
- * is mostly targeting Apples .usdz format.
29
- * @param excluded Optional list of geometry (meshes, elements, variants,...) to be excluded from the export.
30
- */
31
- exportGltfToFile(filename: string, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<void>;
32
- /**
33
- * Exports selected nodes to GLB. This results in one binary file.
34
- * @param filename Name of the main (text-based) .GLTF file referring to seperate texture files.
35
- * @param optimizeForAR Adjusts the exported GLB so that known issues get automatically fixed, this
36
- * is mostly targeting Apples .usdz format.
37
- * @param excluded Optional list of geometry (meshes, elements, variants,...) to be excluded from the export.
38
- */
39
- exportGlbToFile(filename: string, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<void>;
40
- /**
41
- * Prepares scene for GLB export.
42
- * This is very important for AR exports, since we have to do a lot of conversions to satisfy Apples .usdz format.
43
- */
44
- protected _exportPreProcess(optimizeForAR: boolean, excluded?: ExcludedGeometryList): Promise<void>;
45
- /**
46
- * Cleans up scene after export
47
- */
48
- protected _exportPostProcess(optimizeForAR: boolean): Promise<void>;
49
- /**
50
- * Creates a clone of the node which should be used for the export.
51
- * Also switches to the cloned material if required.
52
- */
53
- protected _prepareNodeForExport(node: BjsNode, clonedParent: TransformNode, excluded?: ExcludedGeometryList): void;
54
- /**
55
- * Help function for receiving all nodes that are marked for the export
56
- */
57
- protected _getNodesMarkedForExport(meshesOnly?: boolean): TransformNode[];
58
- /**
59
- * Defines options for the export.
60
- * We don't allow the user to overwrite certain settings, since we rely on properties like `removeNoopRootNodes` to
61
- * stay `true` in order to make the AR export work.
62
- * We could theoretically allow it if AR optimization is not desired, but this may confuse the user.
63
- */
64
- protected static _gltfExportOptions(optimizeForAR: boolean, excluded?: ExcludedGeometryList): IExportOptions;
65
- /**
66
- * Checks if a node should be available in the export
67
- */
68
- protected static _shouldExportNode(node: BjsNode, excluded?: ExcludedGeometryList): boolean;
69
- /**
70
- * Creates a clone of the material which should be used for the export.
71
- * This is mostly required for recreating textures with lower sizes.
72
- * CAUTION: Material exchanging is not supported for materials that contain certain texture types:
73
- * - Dynamic textures (Paintables): Cloning dynamic textures doesn't clone the canvas context
74
- * => so the clone is just empty
75
- * - Render target textures: Disposing the clone will leave the scene in a "not ready" state
76
- * => this scenario is not fully analyzed yet, but it's not really worth the effort right now, since this kind of
77
- * of texture is not really used ATM
78
- */
79
- protected static _exchangeMaterial(material: Material): void;
80
- }
1
+ import { Viewer } from '../classes/viewer';
2
+ import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
3
+ import { Node as BjsNode } from '@babylonjs/core/node';
4
+ import '@babylonjs/serializers/glTF/2.0/Extensions/KHR_texture_transform';
5
+ export declare class GltfExportManager {
6
+ protected viewer: Viewer;
7
+ protected static readonly _METADATA_PROPS: {
8
+ exportNode: string;
9
+ deleteAfterExport: string;
10
+ exchangeMaterialWith: string;
11
+ };
12
+ protected static readonly _EXPORT_ROOT_NAME = "__export_root__";
13
+ protected _maxTextureSize: number;
14
+ protected constructor(viewer: Viewer);
15
+ static create(viewer: Viewer): Promise<GltfExportManager>;
16
+ /**
17
+ * Exports selected nodes to a file.
18
+ * @param filename Optional name of the exported .GLB file.
19
+ * @param optimizeForAR Adjusts the exported GLB so that known issues get automatically fixed, this
20
+ * is mostly targeting Apples .usdz format.
21
+ * @param excluded Optional list of geometry (meshes, elements, variants,...) to be excluded from the export.
22
+ */
23
+ exportGlb(filename?: string, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<File | undefined>;
24
+ /**
25
+ * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported seperately.
26
+ * @param filename Name of the main (text-based) .GLTF file referring to separate texture files.
27
+ * @param optimizeForAR Adjusts the exported GLB so that known issues get automatically fixed, this
28
+ * is mostly targeting Apples .usdz format.
29
+ * @param excluded Optional list of geometry (meshes, elements, variants,...) to be excluded from the export.
30
+ */
31
+ exportGltfToFile(filename: string, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<void>;
32
+ /**
33
+ * Exports selected nodes to GLB. This results in one binary file.
34
+ * @param filename Name of the main (text-based) .GLTF file referring to seperate texture files.
35
+ * @param optimizeForAR Adjusts the exported GLB so that known issues get automatically fixed, this
36
+ * is mostly targeting Apples .usdz format.
37
+ * @param excluded Optional list of geometry (meshes, elements, variants,...) to be excluded from the export.
38
+ */
39
+ exportGlbToFile(filename: string, optimizeForAR?: boolean, excluded?: ExcludedGeometryList): Promise<void>;
40
+ /**
41
+ * Prepares scene for GLB export.
42
+ * This is very important for AR exports, since we have to do a lot of conversions to satisfy Apples .usdz format.
43
+ */
44
+ protected _exportPreProcess(optimizeForAR: boolean, excluded?: ExcludedGeometryList): Promise<void>;
45
+ /**
46
+ * Cleans up scene after export
47
+ */
48
+ protected _exportPostProcess(optimizeForAR: boolean): Promise<void>;
49
+ /**
50
+ * Creates a clone of the node which should be used for the export.
51
+ * Also switches to the cloned material if required.
52
+ */
53
+ protected _prepareNodeForExport(node: BjsNode, clonedParent: TransformNode, excluded?: ExcludedGeometryList): void;
54
+ /**
55
+ * Help function for receiving all nodes that are marked for the export
56
+ */
57
+ protected _getNodesMarkedForExport(meshesOnly?: boolean): TransformNode[];
58
+ /**
59
+ * Defines options for the export.
60
+ * We don't allow the user to overwrite certain settings, since we rely on properties like `removeNoopRootNodes` to
61
+ * stay `true` in order to make the AR export work.
62
+ * We could theoretically allow it if AR optimization is not desired, but this may confuse the user.
63
+ */
64
+ protected static _gltfExportOptions(optimizeForAR: boolean, excluded?: ExcludedGeometryList): IExportOptions;
65
+ /**
66
+ * Checks if a node should be available in the export
67
+ */
68
+ protected static _shouldExportNode(node: BjsNode, excluded?: ExcludedGeometryList): boolean;
69
+ /**
70
+ * Creates a clone of the material which should be used for the export.
71
+ * This is mostly required for recreating textures with lower sizes.
72
+ * CAUTION: Material exchanging is not supported for materials that contain certain texture types:
73
+ * - Dynamic textures (Paintables): Cloning dynamic textures doesn't clone the canvas context
74
+ * => so the clone is just empty
75
+ * - Render target textures: Disposing the clone will leave the scene in a "not ready" state
76
+ * => this scenario is not fully analyzed yet, but it's not really worth the effort right now, since this kind of
77
+ * of texture is not really used ATM
78
+ */
79
+ protected static _exchangeMaterial(material: Material): void;
80
+ }