@combeenation/3d-viewer 7.1.3 → 8.1.0-alpha1

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 (111) 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 +672 -672
  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 +378 -351
  15. package/dist/lib-cjs/api/classes/parameter.js +551 -524
  16. package/dist/lib-cjs/api/classes/parameter.js.map +1 -1
  17. package/dist/lib-cjs/api/classes/parameterObservable.d.ts +36 -36
  18. package/dist/lib-cjs/api/classes/parameterObservable.js +72 -72
  19. package/dist/lib-cjs/api/classes/parameterizable.d.ts +15 -15
  20. package/dist/lib-cjs/api/classes/parameterizable.js +102 -102
  21. package/dist/lib-cjs/api/classes/placementAnimation.d.ts +45 -45
  22. package/dist/lib-cjs/api/classes/placementAnimation.js +176 -176
  23. package/dist/lib-cjs/api/classes/variant.d.ts +261 -253
  24. package/dist/lib-cjs/api/classes/variant.js +870 -858
  25. package/dist/lib-cjs/api/classes/variant.js.map +1 -1
  26. package/dist/lib-cjs/api/classes/variantInstance.d.ts +53 -53
  27. package/dist/lib-cjs/api/classes/variantInstance.js +125 -125
  28. package/dist/lib-cjs/api/classes/variantParameterizable.d.ts +17 -17
  29. package/dist/lib-cjs/api/classes/variantParameterizable.js +86 -86
  30. package/dist/lib-cjs/api/classes/viewer.d.ts +213 -213
  31. package/dist/lib-cjs/api/classes/viewer.js +717 -716
  32. package/dist/lib-cjs/api/classes/viewer.js.map +1 -1
  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/internal/lensRendering.d.ts +8 -8
  38. package/dist/lib-cjs/api/internal/lensRendering.js +11 -11
  39. package/dist/lib-cjs/api/internal/sceneSetup.d.ts +13 -13
  40. package/dist/lib-cjs/api/internal/sceneSetup.js +226 -226
  41. package/dist/lib-cjs/api/manager/animationManager.d.ts +30 -30
  42. package/dist/lib-cjs/api/manager/animationManager.js +126 -126
  43. package/dist/lib-cjs/api/manager/gltfExportManager.d.ts +103 -79
  44. package/dist/lib-cjs/api/manager/gltfExportManager.js +325 -242
  45. package/dist/lib-cjs/api/manager/gltfExportManager.js.map +1 -1
  46. package/dist/lib-cjs/api/manager/sceneManager.d.ts +33 -33
  47. package/dist/lib-cjs/api/manager/sceneManager.js +128 -128
  48. package/dist/lib-cjs/api/manager/tagManager.d.ts +118 -116
  49. package/dist/lib-cjs/api/manager/tagManager.js +508 -444
  50. package/dist/lib-cjs/api/manager/tagManager.js.map +1 -1
  51. package/dist/lib-cjs/api/manager/textureLoadManager.d.ts +22 -22
  52. package/dist/lib-cjs/api/manager/textureLoadManager.js +97 -97
  53. package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts +106 -106
  54. package/dist/lib-cjs/api/manager/variantInstanceManager.js +290 -292
  55. package/dist/lib-cjs/api/manager/variantInstanceManager.js.map +1 -1
  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 +235 -235
  59. package/dist/lib-cjs/api/util/babylonHelper.js +753 -753
  60. package/dist/lib-cjs/api/util/globalTypes.d.ts +469 -455
  61. package/dist/lib-cjs/api/util/globalTypes.js +1 -1
  62. package/dist/lib-cjs/api/util/resourceHelper.d.ts +58 -58
  63. package/dist/lib-cjs/api/util/resourceHelper.js +203 -203
  64. package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts +44 -44
  65. package/dist/lib-cjs/api/util/sceneLoaderHelper.js +175 -175
  66. package/dist/lib-cjs/api/util/stringHelper.d.ts +13 -13
  67. package/dist/lib-cjs/api/util/stringHelper.js +32 -32
  68. package/dist/lib-cjs/api/util/structureHelper.d.ts +9 -9
  69. package/dist/lib-cjs/api/util/structureHelper.js +60 -57
  70. package/dist/lib-cjs/api/util/structureHelper.js.map +1 -1
  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 +54 -54
  74. package/dist/lib-cjs/index.js +117 -117
  75. package/package.json +81 -81
  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 +733 -733
  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 +591 -561
  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 +963 -949
  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 +770 -772
  90. package/src/api/classes/viewerError.ts +63 -63
  91. package/src/api/classes/viewerLight.ts +339 -339
  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 +205 -205
  95. package/src/api/manager/animationManager.ts +143 -143
  96. package/src/api/manager/gltfExportManager.ts +302 -237
  97. package/src/api/manager/sceneManager.ts +134 -134
  98. package/src/api/manager/tagManager.ts +536 -477
  99. package/src/api/manager/textureLoadManager.ts +95 -95
  100. package/src/api/manager/variantInstanceManager.ts +306 -309
  101. package/src/api/store/specStorage.ts +68 -68
  102. package/src/api/util/babylonHelper.ts +823 -823
  103. package/src/api/util/globalTypes.ts +543 -525
  104. package/src/api/util/resourceHelper.ts +191 -191
  105. package/src/api/util/sceneLoaderHelper.ts +170 -170
  106. package/src/api/util/stringHelper.ts +30 -30
  107. package/src/api/util/structureHelper.ts +60 -58
  108. package/src/buildinfo.json +3 -3
  109. package/src/dev.ts +62 -62
  110. package/src/index.ts +103 -103
  111. package/src/types.d.ts +38 -38
@@ -1,87 +1,87 @@
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.VariantParameterizable = void 0;
13
- const dottedPath_1 = require("./../classes/dottedPath");
14
- const event_1 = require("./../classes/event");
15
- const parameterizable_1 = require("./../classes/parameterizable");
16
- const resourceHelper_1 = require("./../util/resourceHelper");
17
- const stringHelper_1 = require("./../util/stringHelper");
18
- const lodash_es_1 = require("lodash-es");
19
- class VariantParameterizable extends parameterizable_1.Parameterizable {
20
- constructor(variant, name) {
21
- super();
22
- this.variant = variant;
23
- this.name = name;
24
- this._parameterObservers = new Map();
25
- }
26
- /**
27
- * Gets the inherited parameters from the {@link Variant} with cleaned {@link Parameterizable} prefix.
28
- */
29
- get inheritedParameters() {
30
- const parameterBag = {};
31
- for (const parameter in this.variant.inheritedParameters) {
32
- const dpp = dottedPath_1.DottedPath.create(parameter);
33
- if (dpp.parts.length !== 1) {
34
- continue;
35
- }
36
- parameterBag[parameter] = this.variant.inheritedParameters[parameter];
37
- }
38
- for (const parameter in this.variant.inheritedParameters) {
39
- const dpp = dottedPath_1.DottedPath.create(parameter);
40
- if (dpp.firstPart !== this.name) {
41
- continue;
42
- }
43
- dpp.shiftPart();
44
- parameterBag[dpp.path] = this.variant.inheritedParameters[parameter];
45
- }
46
- return parameterBag;
47
- }
48
- /**
49
- * Places the given {@link ParameterBag} in the {@link VariantParameterizable}'s parameters, replaces all patterns in
50
- * the {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
51
- */
52
- commitParameters(parameters) {
53
- return __awaiter(this, void 0, void 0, function* () {
54
- if (!parameters) {
55
- parameters = {};
56
- }
57
- const oldParameters = (0, lodash_es_1.cloneDeep)(this.parameters);
58
- (0, lodash_es_1.merge)(this.parameters, parameters);
59
- // handle parameter observers
60
- let observerPromises = [];
61
- for (const parameter in this.parameters) {
62
- const oldParameterValue = oldParameters[parameter];
63
- const newParameterValue = this.parameters[parameter];
64
- this.variant.assertParameter(this.variant.inheritedParameterDeclaration, parameter, newParameterValue);
65
- if (oldParameterValue === newParameterValue) {
66
- continue;
67
- }
68
- // parameter changed
69
- const parameterObservers = (0, resourceHelper_1.mergeMaps)(this._parameterObservers, this.parameterObservers);
70
- if (parameterObservers.has(parameter)) {
71
- const observers = parameterObservers.get(parameter);
72
- observerPromises = (0, lodash_es_1.concat)(observerPromises, observers.map(observer => {
73
- const observerPromise = observer(this, oldParameterValue, newParameterValue);
74
- return Promise.resolve(observerPromise).then(() => {
75
- const clsName = (0, stringHelper_1.camelToSnakeCase)(this.constructor.name).toUpperCase();
76
- this.broadcastEvent((0, lodash_es_1.get)(event_1.Event, clsName + '_PARAMETER_COMMITTED'), this, parameter, oldParameterValue, newParameterValue);
77
- });
78
- }));
79
- }
80
- }
81
- yield Promise.all(observerPromises);
82
- return this;
83
- });
84
- }
85
- }
86
- exports.VariantParameterizable = VariantParameterizable;
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.VariantParameterizable = void 0;
13
+ const dottedPath_1 = require("./../classes/dottedPath");
14
+ const event_1 = require("./../classes/event");
15
+ const parameterizable_1 = require("./../classes/parameterizable");
16
+ const resourceHelper_1 = require("./../util/resourceHelper");
17
+ const stringHelper_1 = require("./../util/stringHelper");
18
+ const lodash_es_1 = require("lodash-es");
19
+ class VariantParameterizable extends parameterizable_1.Parameterizable {
20
+ constructor(variant, name) {
21
+ super();
22
+ this.variant = variant;
23
+ this.name = name;
24
+ this._parameterObservers = new Map();
25
+ }
26
+ /**
27
+ * Gets the inherited parameters from the {@link Variant} with cleaned {@link Parameterizable} prefix.
28
+ */
29
+ get inheritedParameters() {
30
+ const parameterBag = {};
31
+ for (const parameter in this.variant.inheritedParameters) {
32
+ const dpp = dottedPath_1.DottedPath.create(parameter);
33
+ if (dpp.parts.length !== 1) {
34
+ continue;
35
+ }
36
+ parameterBag[parameter] = this.variant.inheritedParameters[parameter];
37
+ }
38
+ for (const parameter in this.variant.inheritedParameters) {
39
+ const dpp = dottedPath_1.DottedPath.create(parameter);
40
+ if (dpp.firstPart !== this.name) {
41
+ continue;
42
+ }
43
+ dpp.shiftPart();
44
+ parameterBag[dpp.path] = this.variant.inheritedParameters[parameter];
45
+ }
46
+ return parameterBag;
47
+ }
48
+ /**
49
+ * Places the given {@link ParameterBag} in the {@link VariantParameterizable}'s parameters, replaces all patterns in
50
+ * the {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
51
+ */
52
+ commitParameters(parameters) {
53
+ return __awaiter(this, void 0, void 0, function* () {
54
+ if (!parameters) {
55
+ parameters = {};
56
+ }
57
+ const oldParameters = (0, lodash_es_1.cloneDeep)(this.parameters);
58
+ (0, lodash_es_1.merge)(this.parameters, parameters);
59
+ // handle parameter observers
60
+ let observerPromises = [];
61
+ for (const parameter in this.parameters) {
62
+ const oldParameterValue = oldParameters[parameter];
63
+ const newParameterValue = this.parameters[parameter];
64
+ this.variant.assertParameter(this.variant.inheritedParameterDeclaration, parameter, newParameterValue);
65
+ if (oldParameterValue === newParameterValue) {
66
+ continue;
67
+ }
68
+ // parameter changed
69
+ const parameterObservers = (0, resourceHelper_1.mergeMaps)(this._parameterObservers, this.parameterObservers);
70
+ if (parameterObservers.has(parameter)) {
71
+ const observers = parameterObservers.get(parameter);
72
+ observerPromises = (0, lodash_es_1.concat)(observerPromises, observers.map(observer => {
73
+ const observerPromise = observer(this, oldParameterValue, newParameterValue);
74
+ return Promise.resolve(observerPromise).then(() => {
75
+ const clsName = (0, stringHelper_1.camelToSnakeCase)(this.constructor.name).toUpperCase();
76
+ this.broadcastEvent((0, lodash_es_1.get)(event_1.Event, clsName + '_PARAMETER_COMMITTED'), this, parameter, oldParameterValue, newParameterValue);
77
+ });
78
+ }));
79
+ }
80
+ }
81
+ yield Promise.all(observerPromises);
82
+ return this;
83
+ });
84
+ }
85
+ }
86
+ exports.VariantParameterizable = VariantParameterizable;
87
87
  //# sourceMappingURL=variantParameterizable.js.map
@@ -1,213 +1,213 @@
1
- import { AnimationManager } from '../manager/animationManager';
2
- import { GltfExportManager } from '../manager/gltfExportManager';
3
- import { SceneManager } from '../manager/sceneManager';
4
- import { TagManager } from '../manager/tagManager';
5
- import { VariantInstanceManager } from '../manager/variantInstanceManager';
6
- import * as Index from './../../index';
7
- import { AnimationInterface } from './animationInterface';
8
- import { EventBroadcaster } from './eventBroadcaster';
9
- import { VariantInstance } from './variantInstance';
10
- import { Engine } from '@babylonjs/core/Engines/engine';
11
- import { Mesh } from '@babylonjs/core/Meshes/mesh';
12
- import { Scene } from '@babylonjs/core/scene';
13
- /**
14
- * The main exposed object. This is the entry point into the application
15
- *
16
- * ```js
17
- * const canvas = document.getElementById( 'babylon-canvas' );
18
- * const viewer = Viewer( canvas, '/path/to/index.json' );
19
- * ```
20
- * The class does nothing on its own and needs to {@link bootstrap}
21
- */
22
- export declare class Viewer extends EventBroadcaster {
23
- readonly canvas: HTMLCanvasElement;
24
- protected structureJson: string | StructureJson;
25
- static readonly BOUNDING_BOX_NAME = "__bounding_box__";
26
- protected _scene: Scene | null;
27
- protected _animationManager: AnimationManager | null;
28
- protected _sceneManager: SceneManager | null;
29
- protected _tagManager: TagManager | null;
30
- protected _gltfExportManager: GltfExportManager | null;
31
- protected _variantInstances: VariantInstanceManager | null;
32
- protected _cloneMaterialsOnMutation: boolean;
33
- protected _isRenderLoopPaused: boolean;
34
- protected _inspectorLoaded: boolean;
35
- protected _nodeNamingStrategyHandler: NodeNamingStrategyHandler | null;
36
- static version: string;
37
- private static readonly _autofocusConstants;
38
- /**
39
- * Help function for automatically creating a valid Spec from a list of variant names and dedicated GLB/babylon URLs.
40
- * This data is most likely coming from babylon assets from the Combeenation system but other sources are also valid.
41
- */
42
- static generateSpec(genData: SpecGenerationData[]): AutoSpecStructureJson;
43
- /**
44
- * Returns all modules which are exported by the viewers index file.
45
- *
46
- * Needed by the [Combeenation viewer control](https://docs.combeenation.com/docs/3d-viewer-control) in situations where the viewer is injected from external code.
47
- *
48
- * See [Combeenation docs](https://docs.combeenation.com/docs/3d-viewer-control-with-custom-js) for more details.
49
- */
50
- static getAllViewerModules(): typeof Index;
51
- /**
52
- * Constructor
53
- */
54
- constructor(canvas: HTMLCanvasElement, structureJson: string | StructureJson);
55
- /**
56
- * Gets the Babylon.js Scene that is attached to the instance.
57
- *
58
- * @throws Error if the `scene` has not been initialized.
59
- */
60
- get scene(): Scene;
61
- /**
62
- * Gets the {@link SceneManager} attached to the viewer.
63
- *
64
- * @throws Error if the {@link SceneManager} has not been initialized.
65
- */
66
- get sceneManager(): SceneManager;
67
- /**
68
- * Gets the {@link GltfExportManager} attached to the viewer.
69
- *
70
- * @throws Error if the {@link GltfExportManager} has not been initialized.
71
- */
72
- get gltfExportManager(): GltfExportManager;
73
- /**
74
- * Gets the Babylon.js Engine that is attached to the viewer.
75
- */
76
- get engine(): Engine;
77
- /**
78
- * Gets the {@link VariantInstanceManager} attached to the viewer.
79
- *
80
- * @throws Error if the {@link VariantInstanceManager} has not been initialized.
81
- */
82
- get variantInstances(): VariantInstanceManager;
83
- /**
84
- * Gets the {@link AnimationManager} attached to the viewer.
85
- *
86
- * @throws Error if the {@link AnimationManager} has not been initialized.
87
- */
88
- get animationManager(): AnimationManager;
89
- get tagManager(): TagManager;
90
- /**
91
- * Gets the `cloneMaterialsOnMutation` flag, as defined in the spec
92
- */
93
- get cloneMaterialsOnMutation(): boolean;
94
- /**
95
- * Gets the strategy handler for naming cloned nodes.
96
- */
97
- get nodeNamingStrategyHandler(): NodeNamingStrategyHandler;
98
- /**
99
- * Sets the strategy handler for naming cloned nodes.\
100
- * Check the docs of the tag managers [renaming](https://3dviewer.docs.combeenation.com/pages/documentation/Tag-Manager.html#uniqueness-of-node-and-tag-names)
101
- * chapter for further details.
102
- */
103
- set nodeNamingStrategyHandler(value: NodeNamingStrategyHandler);
104
- /**
105
- * Starts the application. This will
106
- * * load the given "index" JSON file
107
- * * setup the scene with the "scene" JSON file
108
- * * create an (optional) default setup with different variant settings
109
- * * sets up resizing by attaching a debounced version of {@link resize}
110
- *
111
- * @throws Error if any of the files is not found/valid
112
- *
113
- * @emits {@link Event.BOOTSTRAP_START}
114
- * @emits {@link Event.BOOTSTRAP_END}
115
- */
116
- bootstrap(tagManagerParameterValues?: TagManagerParameterValue[]): Promise<Viewer>;
117
- /**
118
- * Enables the Babylon.js [Inspector](https://doc.babylonjs.com/toolsAndResources/tools/inspector).\
119
- * Due to the additional size of the inspector, the CDN version is used instead of shipping the required code with
120
- * the viewer.\
121
- * This means that the code will be downloaded only when needed and calling `enableDebugLayer` can take a little while
122
- * depending on your internet connection etc.
123
- */
124
- enableDebugLayer(options?: IInspectorOptions): Promise<void>;
125
- /**
126
- * Destroys all registered {@link VariantInstance}s that are registered
127
- */
128
- destroyVariantInstances(): Viewer;
129
- /**
130
- * Trigger a resize event for the `Engine`
131
- */
132
- resize(): Viewer;
133
- /**
134
- * A convenience method for directly getting a Node from a {@link VariantInstance} and an {@link Element} by its
135
- * {@link DottedPath}s.
136
- */
137
- getNode(variantInstanceName: string, elementDottedPath: DottedPathArgument, nodeDottedPath: DottedPathArgument): Promise<TransformNode>;
138
- /**
139
- * A convenience method for directly getting a Node from a {@link VariantInstance} and an {@link Element} by its
140
- * {@link DottedPath}s.
141
- */
142
- getMesh(variantInstanceName: string, elementDottedPath: DottedPathArgument, meshDottedPath: DottedPathArgument): Promise<Mesh | null>;
143
- /**
144
- * Switches the camera
145
- *
146
- * @emits {@link Event.CAMERA_SWITCHED}
147
- */
148
- switchCamera(newCamera: string, reset?: boolean): Viewer;
149
- /**
150
- * Moves or animates the active camera to given `placement`.
151
- */
152
- moveActiveCameraTo(placement: string | PlacementDefinition, animation?: string | AnimationDefinition): Promise<AnimationInterface>;
153
- /**
154
- * Takes a sceenshot the the current scene. The result is a string containing a base64 encoded image
155
- */
156
- screenshot(settings?: ScreenshotSettings): Promise<string>;
157
- /**
158
- * Checks whether the browser is capable of handling XR.
159
- */
160
- isBrowserARCapable(): Promise<boolean>;
161
- /**
162
- * Calculates the bounding box from all visible meshes on the scene.
163
- */
164
- calculateBoundingBox(excludeGeometry?: ExcludedGeometryList): Promise<Mesh>;
165
- /**
166
- * Focuses the camera to see every visible mesh in scene and tries to optimize wheel precision and panning
167
- */
168
- autofocusActiveCamera(settings?: AutofocusSettings): Promise<void>;
169
- /**
170
- * Resets everything by calling {@link destroy} to clear all references and {@link bootstrap} to setup a clean
171
- * environment
172
- */
173
- reset(tagManagerParameterValues: TagManagerParameterValue[]): Promise<Viewer>;
174
- /**
175
- * Destroys
176
- *
177
- * * all {@link VariantInstance}s using {@link destroyVariantInstances}
178
- * * calling `dispose` on the `Engine` and `Scene`
179
- */
180
- destroy(): Viewer;
181
- /**
182
- * Show coordinate system with given dimension (for debugging purpose).
183
- */
184
- showWorldCoordinates(dimension: number): void;
185
- /**
186
- * Pause render loop.
187
- */
188
- pauseRendering(): void;
189
- /**
190
- * Resume render loop when paused.
191
- */
192
- resumeRendering(): void;
193
- /**
194
- * Prints defined instances from SetupJson to the console.
195
- */
196
- protected printInstanceDefinitions(setupJson: SetupJson): void;
197
- /**
198
- * @emits {@link Event.SCENE_PROCESSING_START}
199
- * @emits {@link Event.SCENE_PROCESSING_END}
200
- */
201
- protected initScene(): Promise<Scene>;
202
- /**
203
- * Register custom file loader for babylon files which adds "missing-material" metadata to meshes which reference
204
- * materials that are not present in the `materials` section of the given babylon file.
205
- *
206
- * Required for babylon files & materials loaded from "Combeenation configurator assets".
207
- */
208
- protected initCbnBabylonLoaderPlugin(): void;
209
- /**
210
- * Batch creation of multiple {@link VariantInstance} objects with a {@link SetupJson} object passed
211
- */
212
- protected createVariantInstances(tagManagerParameterValues?: TagManagerParameterValue[]): Promise<VariantInstance[]>;
213
- }
1
+ import { AnimationManager } from '../manager/animationManager';
2
+ import { GltfExportManager } from '../manager/gltfExportManager';
3
+ import { SceneManager } from '../manager/sceneManager';
4
+ import { TagManager } from '../manager/tagManager';
5
+ import { VariantInstanceManager } from '../manager/variantInstanceManager';
6
+ import * as Index from './../../index';
7
+ import { AnimationInterface } from './animationInterface';
8
+ import { EventBroadcaster } from './eventBroadcaster';
9
+ import { VariantInstance } from './variantInstance';
10
+ import { Engine } from '@babylonjs/core/Engines/engine';
11
+ import { Mesh } from '@babylonjs/core/Meshes/mesh';
12
+ import { Scene } from '@babylonjs/core/scene';
13
+ /**
14
+ * The main exposed object. This is the entry point into the application
15
+ *
16
+ * ```js
17
+ * const canvas = document.getElementById( 'babylon-canvas' );
18
+ * const viewer = Viewer( canvas, '/path/to/index.json' );
19
+ * ```
20
+ * The class does nothing on its own and needs to {@link bootstrap}
21
+ */
22
+ export declare class Viewer extends EventBroadcaster {
23
+ readonly canvas: HTMLCanvasElement;
24
+ protected structureJson: string | StructureJson;
25
+ static readonly BOUNDING_BOX_NAME = "__bounding_box__";
26
+ protected _scene: Scene | null;
27
+ protected _animationManager: AnimationManager | null;
28
+ protected _sceneManager: SceneManager | null;
29
+ protected _tagManager: TagManager | null;
30
+ protected _gltfExportManager: GltfExportManager | null;
31
+ protected _variantInstances: VariantInstanceManager | null;
32
+ protected _cloneMaterialsOnMutation: boolean;
33
+ protected _isRenderLoopPaused: boolean;
34
+ protected _inspectorLoaded: boolean;
35
+ protected _nodeNamingStrategyHandler: NodeNamingStrategyHandler | null;
36
+ static version: string;
37
+ private static readonly _autofocusConstants;
38
+ /**
39
+ * Help function for automatically creating a valid Spec from a list of variant names and dedicated GLB/babylon URLs.
40
+ * This data is most likely coming from babylon assets from the Combeenation system but other sources are also valid.
41
+ */
42
+ static generateSpec(genData: SpecGenerationData[]): AutoSpecStructureJson;
43
+ /**
44
+ * Returns all modules which are exported by the viewers index file.
45
+ *
46
+ * Needed by the [Combeenation viewer control](https://docs.combeenation.com/docs/3d-viewer-control) in situations where the viewer is injected from external code.
47
+ *
48
+ * See [Combeenation docs](https://docs.combeenation.com/docs/3d-viewer-control-with-custom-js) for more details.
49
+ */
50
+ static getAllViewerModules(): typeof Index;
51
+ /**
52
+ * Constructor
53
+ */
54
+ constructor(canvas: HTMLCanvasElement, structureJson: string | StructureJson);
55
+ /**
56
+ * Gets the Babylon.js Scene that is attached to the instance.
57
+ *
58
+ * @throws Error if the `scene` has not been initialized.
59
+ */
60
+ get scene(): Scene;
61
+ /**
62
+ * Gets the {@link SceneManager} attached to the viewer.
63
+ *
64
+ * @throws Error if the {@link SceneManager} has not been initialized.
65
+ */
66
+ get sceneManager(): SceneManager;
67
+ /**
68
+ * Gets the {@link GltfExportManager} attached to the viewer.
69
+ *
70
+ * @throws Error if the {@link GltfExportManager} has not been initialized.
71
+ */
72
+ get gltfExportManager(): GltfExportManager;
73
+ /**
74
+ * Gets the Babylon.js Engine that is attached to the viewer.
75
+ */
76
+ get engine(): Engine;
77
+ /**
78
+ * Gets the {@link VariantInstanceManager} attached to the viewer.
79
+ *
80
+ * @throws Error if the {@link VariantInstanceManager} has not been initialized.
81
+ */
82
+ get variantInstances(): VariantInstanceManager;
83
+ /**
84
+ * Gets the {@link AnimationManager} attached to the viewer.
85
+ *
86
+ * @throws Error if the {@link AnimationManager} has not been initialized.
87
+ */
88
+ get animationManager(): AnimationManager;
89
+ get tagManager(): TagManager;
90
+ /**
91
+ * Gets the `cloneMaterialsOnMutation` flag, as defined in the spec
92
+ */
93
+ get cloneMaterialsOnMutation(): boolean;
94
+ /**
95
+ * Gets the strategy handler for naming cloned nodes.
96
+ */
97
+ get nodeNamingStrategyHandler(): NodeNamingStrategyHandler;
98
+ /**
99
+ * Sets the strategy handler for naming cloned nodes.\
100
+ * Check the docs of the tag managers [renaming](https://3dviewer.docs.combeenation.com/pages/documentation/Tag-Manager.html#uniqueness-of-node-and-tag-names)
101
+ * chapter for further details.
102
+ */
103
+ set nodeNamingStrategyHandler(value: NodeNamingStrategyHandler);
104
+ /**
105
+ * Starts the application. This will
106
+ * * load the given "index" JSON file
107
+ * * setup the scene with the "scene" JSON file
108
+ * * create an (optional) default setup with different variant settings
109
+ * * sets up resizing by attaching a debounced version of {@link resize}
110
+ *
111
+ * @throws Error if any of the files is not found/valid
112
+ *
113
+ * @emits {@link Event.BOOTSTRAP_START}
114
+ * @emits {@link Event.BOOTSTRAP_END}
115
+ */
116
+ bootstrap(tagManagerParameterValues?: TagManagerParameterValue[]): Promise<Viewer>;
117
+ /**
118
+ * Enables the Babylon.js [Inspector](https://doc.babylonjs.com/toolsAndResources/tools/inspector).\
119
+ * Due to the additional size of the inspector, the CDN version is used instead of shipping the required code with
120
+ * the viewer.\
121
+ * This means that the code will be downloaded only when needed and calling `enableDebugLayer` can take a little while
122
+ * depending on your internet connection etc.
123
+ */
124
+ enableDebugLayer(options?: IInspectorOptions): Promise<void>;
125
+ /**
126
+ * Destroys all registered {@link VariantInstance}s that are registered
127
+ */
128
+ destroyVariantInstances(): Viewer;
129
+ /**
130
+ * Trigger a resize event for the `Engine`
131
+ */
132
+ resize(): Viewer;
133
+ /**
134
+ * A convenience method for directly getting a Node from a {@link VariantInstance} and an {@link Element} by its
135
+ * {@link DottedPath}s.
136
+ */
137
+ getNode(variantInstanceName: string, elementDottedPath: DottedPathArgument, nodeDottedPath: DottedPathArgument): Promise<TransformNode>;
138
+ /**
139
+ * A convenience method for directly getting a Node from a {@link VariantInstance} and an {@link Element} by its
140
+ * {@link DottedPath}s.
141
+ */
142
+ getMesh(variantInstanceName: string, elementDottedPath: DottedPathArgument, meshDottedPath: DottedPathArgument): Promise<Mesh | null>;
143
+ /**
144
+ * Switches the camera
145
+ *
146
+ * @emits {@link Event.CAMERA_SWITCHED}
147
+ */
148
+ switchCamera(newCamera: string, reset?: boolean): Viewer;
149
+ /**
150
+ * Moves or animates the active camera to given `placement`.
151
+ */
152
+ moveActiveCameraTo(placement: string | PlacementDefinition, animation?: string | AnimationDefinition): Promise<AnimationInterface>;
153
+ /**
154
+ * Takes a sceenshot the the current scene. The result is a string containing a base64 encoded image
155
+ */
156
+ screenshot(settings?: ScreenshotSettings): Promise<string>;
157
+ /**
158
+ * Checks whether the browser is capable of handling XR.
159
+ */
160
+ isBrowserARCapable(): Promise<boolean>;
161
+ /**
162
+ * Calculates the bounding box from all visible meshes on the scene.
163
+ */
164
+ calculateBoundingBox(excludeGeometry?: ExcludedGeometryList): Promise<Mesh>;
165
+ /**
166
+ * Focuses the camera to see every visible mesh in scene and tries to optimize wheel precision and panning
167
+ */
168
+ autofocusActiveCamera(settings?: AutofocusSettings): Promise<void>;
169
+ /**
170
+ * Resets everything by calling {@link destroy} to clear all references and {@link bootstrap} to setup a clean
171
+ * environment
172
+ */
173
+ reset(tagManagerParameterValues?: TagManagerParameterValue[]): Promise<Viewer>;
174
+ /**
175
+ * Destroys
176
+ *
177
+ * * all {@link VariantInstance}s using {@link destroyVariantInstances}
178
+ * * calling `dispose` on the `Engine` and `Scene`
179
+ */
180
+ destroy(): Viewer;
181
+ /**
182
+ * Show coordinate system with given dimension (for debugging purpose).
183
+ */
184
+ showWorldCoordinates(dimension: number): void;
185
+ /**
186
+ * Pause render loop.
187
+ */
188
+ pauseRendering(): void;
189
+ /**
190
+ * Resume render loop when paused.
191
+ */
192
+ resumeRendering(): void;
193
+ /**
194
+ * Prints defined instances from SetupJson to the console.
195
+ */
196
+ protected printInstanceDefinitions(setupJson: SetupJson): void;
197
+ /**
198
+ * @emits {@link Event.SCENE_PROCESSING_START}
199
+ * @emits {@link Event.SCENE_PROCESSING_END}
200
+ */
201
+ protected initScene(): Promise<Scene>;
202
+ /**
203
+ * Register custom file loader for babylon files which adds "missing-material" metadata to meshes which reference
204
+ * materials that are not present in the `materials` section of the given babylon file.
205
+ *
206
+ * Required for babylon files & materials loaded from "Combeenation configurator assets".
207
+ */
208
+ protected initCbnBabylonLoaderPlugin(): void;
209
+ /**
210
+ * Batch creation of multiple {@link VariantInstance} objects with a {@link SetupJson} object passed
211
+ */
212
+ protected createVariantInstances(): Promise<VariantInstance[]>;
213
+ }