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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@combeenation/3d-viewer",
-  "version": "7.1.2",
+  "version": "7.1.3-alpha1",
   "description": "Combeenation 3D Viewer",
   "homepage": "https://github.com/Combeenation/3d-viewer#readme",
   "bugs": {

package/src/api/classes/viewer.ts

@@ -11,6 +11,7 @@ import { debounce, loadJavascript, loadJson } from '../util/resourceHelper';
 import { getCustomCbnBabylonLoaderPlugin } from '../util/sceneLoaderHelper';
 import { replaceDots } from '../util/stringHelper';
 import { isMeshIncludedInExclusionList } from '../util/structureHelper';
+import * as Index from './../../index';
 import { AnimationInterface } from './animationInterface';
 import { Event } from './event';
 import { EventBroadcaster } from './eventBroadcaster';
@@ -132,6 +133,19 @@ export class Viewer extends EventBroadcaster {
     return spec;
   }
 
+  /**
+   * Exports all modules which are exported by our index file.
+   * Needed by the Combeenation viewer control in situations where the viewer is injected from external code.
+   * See [Combeenation docs](https://docs.combeenation.com/) for more details.
+   */
+  // TODO Now: Naming + use a link to a dedicated page once it exists.
+  public static getViewerCtrlDependencies() {
+    // TODO Now, to discuss: Are there any downsides in importing * from `index` & simply export everything here?
+    //                       Pro: We don't have to adjust this if the viewer ctrl ever needs access to "more" (as long
+    //                            the newly required dep is exported from `index`)...
+    return Index;
+  }
+
   /**
    * Constructor
    */

package/src/api/util/globalTypes.ts

@@ -159,8 +159,12 @@ type StructureJson = {
   };
 };
 
+/**
+ * Extends the `StructureJson` by removing the optional flag from some properties which surely exist in the auto
+ * generated spec
+ */
 type AutoSpecStructureJson = StructureJson & {
-  scene: SceneJson;
+  scene: AutoSpecSceneJson;
   setup: SetupJson;
   variants: { [id: string]: StructureJson };
 };
@@ -186,6 +190,17 @@ type SceneJson = {
   cloneMaterialsOnMutation?: boolean;
 };
 
+/**
+ * Extends the `SceneJson` by removing the optional flag from some properties which surely exist in the auto generated
+ * spec
+ */
+type AutoSpecSceneJson = SceneJson & {
+  engine: {
+    antialiasing: boolean;
+    options: EngineOptions;
+  };
+};
+
 type SceneDefinition = {
   globals: SceneGlobals;
   cameras?: CameraDefinitions;