@combeenation/3d-viewer 4.0.0-alpha9 → 4.0.0-beta4

package/src/index.ts

@@ -1,91 +1,87 @@
-/// <reference path="api/util/globalTypes.ts" />
-
-import { Animation as BabylonAnimation } from '@babylonjs/core/Animations/animation';
-import { ArcRotateCamera } from '@babylonjs/core/Cameras/arcRotateCamera';
-import { Engine } from '@babylonjs/core/Engines/engine';
-import { DirectionalLight } from '@babylonjs/core/Lights/directionalLight';
-import { HemisphericLight } from '@babylonjs/core/Lights/hemisphericLight';
-import { Material } from '@babylonjs/core/Materials/material';
-import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
-import { StandardMaterial } from '@babylonjs/core/Materials/standardMaterial';
-import { CubeTexture } from '@babylonjs/core/Materials/Textures/cubeTexture';
-import { DynamicTexture } from '@babylonjs/core/Materials/Textures/dynamicTexture';
-import { Texture } from '@babylonjs/core/Materials/Textures/texture';
-import { Color3, Color4 } from '@babylonjs/core/Maths/math.color';
-import { Vector3 } from '@babylonjs/core/Maths/math.vector';
-import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
-import { InstancedMesh } from '@babylonjs/core/Meshes/instancedMesh';
-import { Mesh } from '@babylonjs/core/Meshes/mesh';
-import { MeshBuilder } from '@babylonjs/core/Meshes/meshBuilder';
-import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
-import { Node } from '@babylonjs/core/node';
-
-/**
- * Without explicitly importing the "BoundingBoxRenderer", we're getting "scene.getBoundingBoxRenderer is undefined"
- * errors when creating HighlightLayer instances. Not sure why but those errors only happen when using the built
- * version of the viewer (e.g. when pulling it from NPM etc.)...
- */
-import '@babylonjs/core/Rendering/boundingBoxRenderer';
-import { Scene } from '@babylonjs/core/scene';
-import { Parameterizable } from './api/classes/parameterizable';
-import { VariantParameterizable } from './api/classes/variantParameterizable';
-import { EventEmitter } from 'eventemitter3';
-import { Element } from './api/classes/element';
-import { emitter, Event } from './api/classes/event';
-import { EventBroadcaster } from './api/classes/eventBroadcaster';
-import { Parameter } from './api/classes/parameter';
-import { ParameterObservable } from './api/classes/parameterObservable';
-import { PlacementAnimation } from './api/classes/placementAnimation';
-import { Variant } from './api/classes/variant';
-import { VariantInstance } from './api/classes/variantInstance';
-import { Viewer } from './api/classes/viewer';
-import { ViewerLight } from './api/classes/viewerLight';
-import { AnimationManager } from './api/manager/animationManager';
-import { SceneManager } from './api/manager/sceneManager';
-import { VariantInstanceManager } from './api/manager/variantInstanceManager';
-import * as BabylonHelper from './api/util/babylonHelper';
-
-/**
- * Expose some frequently used babylon modules by our consumers.
- */
-export {
-	AnimationManager,
-	Variant,
-	VariantInstanceManager,
-	Viewer,
-	ParameterObservable,
-	Parameterizable,
-	VariantParameterizable,
-	ViewerLight,
-	emitter as Emitter,
-	EventEmitter,
-	Event,
-	Parameter,
-	VariantInstance,
-	Color3,
-	Color4,
-	Vector3,
-	AbstractMesh,
-	InstancedMesh,
-	Mesh,
-	TransformNode,
-	Node,
-	Material,
-	PBRMaterial,
-	StandardMaterial,
-	Scene,
-	Engine,
-	ArcRotateCamera,
-	DynamicTexture,
-	CubeTexture,
-	MeshBuilder,
-	Texture,
-	BabylonAnimation,
-	HemisphericLight,
-	DirectionalLight,
-	Element,
-	EventBroadcaster,
-	SceneManager,
-	PlacementAnimation,
-	BabylonHelper,
-};
+/// <reference path="api/util/globalTypes.ts" />
+
+import { ArcRotateCamera } from '@babylonjs/core/Cameras/arcRotateCamera';
+import { Engine } from '@babylonjs/core/Engines/engine';
+import { Material } from '@babylonjs/core/Materials/material';
+import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
+import { StandardMaterial } from '@babylonjs/core/Materials/standardMaterial';
+import { DynamicTexture } from '@babylonjs/core/Materials/Textures/dynamicTexture';
+import { Color3, Color4 } from '@babylonjs/core/Maths/math.color';
+import { Vector3 } from '@babylonjs/core/Maths/math.vector';
+import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
+import { InstancedMesh } from '@babylonjs/core/Meshes/instancedMesh';
+import { Mesh } from '@babylonjs/core/Meshes/mesh';
+import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
+import { Node } from '@babylonjs/core/node';
+import { Scene } from '@babylonjs/core/scene';
+import { VariantInstance } from './api/classes/variantInstance';
+import { Viewer } from './api/classes/viewer';
+import { Event, emitter } from './api/classes/event';
+import { EventEmitter } from 'eventemitter3';
+import { Parameter } from './api/classes/parameter';
+import { CubeTexture } from '@babylonjs/core/Materials/Textures/cubeTexture';
+import { Animation as BabylonAnimation } from '@babylonjs/core/Animations/animation';
+import { MeshBuilder } from '@babylonjs/core/Meshes/meshBuilder';
+import { Texture } from '@babylonjs/core/Materials/Textures/texture';
+import { DirectionalLight } from '@babylonjs/core/Lights/directionalLight';
+import { HemisphericLight } from '@babylonjs/core/Lights/hemisphericLight';
+import { Variant } from './api/classes/variant';
+import { ParameterObservable } from './api/classes/parameterObservable';
+import { ElementParameterizable } from './api/classes/elementParameterizable';
+import { Element } from './api/classes/element';
+import { VariantInstanceManager } from './api/manager/variantInstanceManager';
+import { AnimationManager } from './api/manager/animationManager';
+import { EventBroadcaster } from './api/classes/eventBroadcaster';
+import { SceneManager } from './api/manager/sceneManager';
+import { PlacementAnimation } from './api/classes/placementAnimation';
+import * as BabylonHelper from './api/util/babylonHelper';
+
+/**
+ * Without explicitly importing the "BoundingBoxRenderer", we're getting "scene.getBoundingBoxRenderer is undefined"
+ * errors when creating HighlightLayer instances. Not sure why but those errors only happen when using the built
+ * version of the viewer (e.g. when pulling it from NPM etc.)...
+ */
+import '@babylonjs/core/Rendering/boundingBoxRenderer';
+
+/**
+ * Expose some frequently used babylon modules by our consumers.
+ */
+export {
+	AnimationManager,
+	Variant,
+	VariantInstanceManager,
+	Viewer,
+	ParameterObservable,
+	ElementParameterizable,
+	emitter as Emitter,
+	EventEmitter,
+	Event,
+	Parameter,
+	VariantInstance,
+	Color3,
+	Color4,
+	Vector3,
+	AbstractMesh,
+	InstancedMesh,
+	Mesh,
+	TransformNode,
+	Node,
+	Material,
+	PBRMaterial,
+	StandardMaterial,
+	Scene,
+	Engine,
+	ArcRotateCamera,
+	DynamicTexture,
+	CubeTexture,
+	MeshBuilder,
+	Texture,
+	BabylonAnimation,
+	HemisphericLight,
+	DirectionalLight,
+	Element,
+	EventBroadcaster,
+	SceneManager,
+	PlacementAnimation,
+	BabylonHelper,
+};

package/src/pagesconfig.json

@@ -1,52 +1,57 @@
-{
-  "groups": [
-    {
-      "title": "Release Notes",
-      "pages": [
-        {
-          "title": "Releases",
-          "source": "./doc/release-notes/releases.md",
-          "children": [
-            {
-              "title": "Version 1.1.2",
-              "source": "./doc/release-notes/version-details/1-1-2.md"
-            },
-            {
-              "title": "Version 1.2.0",
-              "source": "./doc/release-notes/version-details/1-2-0.md"
-            },
-            {
-              "title": "Version 2.0.0",
-              "source": "./doc/release-notes/version-details/2-0-0.md"
-            },
-            {
-              "title": "Version 2.1.0",
-              "source": "./doc/release-notes/version-details/2-1-0.md"
-            }
-          ]
-        }
-      ]
-    },
-    {
-      "title": "Documentation",
-      "pages": [
-        {
-          "title": "Specification",
-          "source": "./doc/Specification.md"
-        },
-        {
-          "title": "Parameters",
-          "source": "./doc/Parameters.md"
-        },
-        {
-          "title": "ViewerLights",
-          "source": "./doc/ViewerLights.md"
-        },
-        {
-          "title": "Paintables",
-          "source": "./doc/Paintables.md"
-        }
-      ]
-    }
-  ]
-}
+{
+  "groups": [
+    {
+      "title": "Release Notes",
+      "pages": [
+        {
+          "title": "Releases",
+          "source": "./doc/release-notes/releases.md",
+          "children": [
+            {
+              "title": "Version 1.1.2",
+              "source": "./doc/release-notes/version-details/1-1-2.md"
+            },
+            {
+              "title": "Version 1.2.0",
+              "source": "./doc/release-notes/version-details/1-2-0.md"
+            },
+            {
+              "title": "Version 2.0.0",
+              "source": "./doc/release-notes/version-details/2-0-0.md"
+            },
+            {
+              "title": "Version 2.1.0",
+              "source": "./doc/release-notes/version-details/2-1-0.md"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "title": "Documentation",
+      "pages": [
+        {
+          "title": "Specification",
+          "source": "./doc/documentation/Specification.md"
+        },
+        {
+          "title": "Parameters",
+          "source": "./doc/documentation/Parameters.md"
+        },
+        {
+          "title": "Paintables",
+          "source": "./doc/documentation/Paintables.md"
+        }
+      ]
+    },
+    {
+      "title": "Best Practice",
+      "pages": [
+        {
+          "title": "How to change custom material properties",
+          "source": "./doc/best-practice/Custom-material-properties.md"
+        }
+      ]
+    }
+  ]
+}

package/src/tsconfig.json

@@ -1,43 +1,43 @@
-{
-	"buildOnSave": false,
-	"compileOnSave": false,
-	"exclude": [
-		"dist"
-	],
-	"compilerOptions": {
-		"module": "es2015",
-		"moduleResolution": "node",
-		"target": "es5",
-		"removeComments": false,
-		"preserveConstEnums": true,
-		"sourceMap": true,
-		"skipLibCheck": true,
-		"strict": true,
-		"noFallthroughCasesInSwitch": true,
-		"baseUrl": ".",
-		"importHelpers": true,
-		"resolveJsonModule": true,
-		"lib": [
-			"es6",
-			"dom"
-		]
-	},
-	"typedocOptions": {
-		"name": "Combeenation 3D viewer",
-		"entryPoints": [
-			"src/index.ts",
-			"src/api/util/globalTypes.ts",
-		],
-		"exclude": [
-			"src/dev.ts",
-			"assets/"
-		],
-		"excludeInternal": true,
-		"excludePrivate": true,
-		"excludeProtected": true,
-		"listInvalidSymbolLinks": true,
-		"out": "docs",
-		"pages": "src/pagesconfig.json",
-		"theme": "doc/cbn-docs-theme"
-	}
-}
+{
+	"buildOnSave": false,
+	"compileOnSave": false,
+	"exclude": [
+		"dist"
+	],
+	"compilerOptions": {
+		"module": "es2015",
+		"moduleResolution": "node",
+		"target": "es5",
+		"removeComments": false,
+		"preserveConstEnums": true,
+		"sourceMap": true,
+		"skipLibCheck": true,
+		"strict": true,
+		"noFallthroughCasesInSwitch": true,
+		"baseUrl": ".",
+		"importHelpers": true,
+		"resolveJsonModule": true,
+		"lib": [
+			"es6",
+			"dom"
+		]
+	},
+	"typedocOptions": {
+		"name": "Combeenation 3D viewer",
+		"entryPoints": [
+			"src/index.ts",
+			"src/api/util/globalTypes.ts",
+		],
+		"exclude": [
+			"src/dev.ts",
+			"assets/"
+		],
+		"excludeInternal": true,
+		"excludePrivate": true,
+		"excludeProtected": true,
+		"listInvalidSymbolLinks": true,
+		"out": "docs",
+		"pages": "src/pagesconfig.json",
+		"theme": "doc/cbn-docs-theme"
+	}
+}

package/src/tsconfig.types.json

@@ -1,10 +1,10 @@
-{
-	"extends": "./tsconfig",
-	"exclude": [
-	],
-	"compilerOptions": {
-		"declaration": true,
-		"noEmit": false,
-		"emitDeclarationOnly": true
-	}
+{
+	"extends": "./tsconfig",
+	"exclude": [
+	],
+	"compilerOptions": {
+		"declaration": true,
+		"noEmit": false,
+		"emitDeclarationOnly": true
+	}
 }

package/src/types.d.ts

@@ -1,4 +1,4 @@
-/** @ignore **/
-declare let IS_PRODUCTION: boolean;
-declare let VERSION_INFORMATION: string;
-
+/** @ignore **/
+declare let IS_PRODUCTION: boolean;
+declare let VERSION_INFORMATION: string;
+

package/src/api/classes/variantParameterizable.ts

@@ -1,73 +0,0 @@
-import { DottedPath } from './../classes/dottedPath';
-import { Event } from './../classes/event';
-import { Parameterizable } from './../classes/parameterizable';
-import { Variant } from './../classes/variant';
-import { mergeMaps } from './../util/resourceHelper';
-import { camelToSnakeCase } from './../util/stringHelper';
-import { cloneDeep, concat, get, merge } from 'lodash-es';
-
-export abstract class VariantParameterizable extends Parameterizable {
-
-	protected readonly _parameterObservers: Map<string, ParameterObserver[]> = new Map();
-
-	protected constructor( public readonly variant: Variant,
-	                       public readonly name: string ) {
-		super();
-	}
-
-	/**
-	 * Gets the inherited parameters from the {@link Variant} with cleaned {@link Parameterizable} prefix.
-	 */
-	get inheritedParameters(): ParameterBag {
-		const parameterBag: ParameterBag = {};
-		for( const parameter in this.variant.inheritedParameters ) {
-			const dpp = DottedPath.create( parameter );
-			if( dpp.firstPart !== this.name ) {
-				continue;
-			}
-			dpp.shiftPart();
-			parameterBag[dpp.path] = this.variant.inheritedParameters[parameter];
-		}
-		return parameterBag;
-	}
-
-	/**
-	 * Places the given {@link ParameterBag} in the {@link VariantParameterizable}'s parameters, replaces all patterns in the
-	 * {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
-	 */
-	public async commitParameters( parameters?: ParameterBag ): Promise<VariantParameterizable> {
-		if( !parameters ) {
-			parameters = {};
-		}
-		const oldParameters = cloneDeep( this.parameters );
-		merge( this.parameters, parameters );
-		// handle parameter observers
-		let observerPromises: Promise<void | ParameterObserver>[] = [];
-		for( const parameter in this.parameters ) {
-			const oldParameterValue = oldParameters[parameter];
-			const newParameterValue = this.parameters[parameter];
-			this.variant.assertParameter( this.variant.inheritedParameterDeclaration, parameter, newParameterValue );
-			if( oldParameterValue === newParameterValue ) {
-				continue;
-			}
-			// parameter changed
-			const parameterObservers = mergeMaps( this._parameterObservers, this.parameterObservers );
-			if( parameterObservers.has( parameter ) ) {
-				const observers = parameterObservers.get( parameter )!;
-				observerPromises = concat( observerPromises, observers.map( observer => {
-					const observerResult = observer( this, oldParameterValue, newParameterValue );
-					const observerPromise = Promise.resolve( observerResult );
-					observerPromise.then( () => {
-						const clsName = camelToSnakeCase( this.constructor.name ).toUpperCase();
-						this.broadcastEvent( get( Event, clsName + '_PARAMETER_COMMITTED' ),
-							this, parameter, oldParameterValue, newParameterValue );
-					} );
-					return observerPromise;
-				} ) );
-			}
-		}
-		await Promise.all( observerPromises );
-		return this;
-	}
-
-}