@combeenation/3d-viewer 4.0.0-beta1 → 4.0.0-beta2

package/src/api/classes/parameter.ts

@@ -1,6 +1,6 @@
 import { Color3 } from '@babylonjs/core/Maths/math.color';
 import { Vector3 } from '@babylonjs/core/Maths/math.vector';
-import { get, isEmpty, isNumber, isString } from 'lodash-es';
+import { isNumber, isString } from 'lodash-es';
 
 
 /**
@@ -16,20 +16,19 @@ export class Parameter {
 	private constructor() {}
 
 	/**
-	 * Mutates the visibility. Helper methods are {@link VariantParameterizable.show} and
-	 * {@link VariantParameterizable.hide}. Getter and setter is {@link VariantParameterizable.visible}.
+	 * Mutates the visibility. Helper methods are {@link ElementParameterizable.show} and
+	 * {@link ElementParameterizable.hide}. Getter and setter is {@link ElementParameterizable.visible}.
 	 *
 	 * Scopes:
 	 * * {@link Element}
 	 * * {@link Variant}
-	 * * {@link ViewerLight} Available for all light types
 	 *
 	 * @parser {@link parseBoolean}
 	 */
 	public static readonly VISIBLE = 'visible';
 
 	/**
-	 * Stretches or compresses some meshes. Getter and setter is {@link VariantParameterizable.scaling}.
+	 * Stretches or compresses some meshes. Getter and setter is {@link ElementParameterizable.scaling}.
 	 *
 	 * Scopes:
 	 * * {@link Element}
@@ -40,7 +39,7 @@ export class Parameter {
 	public static readonly SCALING = 'scaling';
 
 	/**
-	 * Mutates the material. Getter and setter is {@link VariantParameterizable.material}. The value of this parameter
+	 * Mutates the material. Getter and setter is {@link ElementParameterizable.material}. The value of this parameter
 	 * represents the ID of a baked-in glTF or custom created material in the {@link Variant} tree.
 	 *
 	 * Scopes:
@@ -107,7 +106,7 @@ export class Parameter {
 	public static readonly HIGHLIGHT_COLOR = 'highlight.color';
 
 	/**
-	 * Mutates the highlighted state. Getter and setter is {@link VariantParameterizable.highlighted}.
+	 * Mutates the highlighted state. Getter and setter is {@link ElementParameterizable.highlighted}.
 	 *
 	 * Scopes:
 	 * * {@link Element}
@@ -118,19 +117,18 @@ export class Parameter {
 	public static readonly HIGHLIGHTED = 'highlighted';
 
 	/**
-	 * Mutates the position relative to its origin position. Getter and setter is {@link VariantParameterizable.position}.
+	 * Mutates the position relative to its origin position. Getter and setter is {@link ElementParameterizable.position}.
 	 *
 	 * Scopes:
 	 * * {@link Element}
 	 * * {@link Variant}
-	 * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#position), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#position), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#position)
 	 *
 	 * @parser {@link parseVector}
 	 */
 	public static readonly POSITION = 'position';
 
 	/**
-	 * Mutates the rotation relative to its origin rotation. Getter and setter is {@link VariantParameterizable.rotation}.
+	 * Mutates the rotation relative to its origin rotation. Getter and setter is {@link ElementParameterizable.rotation}.
 	 *
 	 * Scopes:
 	 * * {@link Element}
@@ -140,126 +138,24 @@ export class Parameter {
 	 */
 	public static readonly ROTATION = 'rotation';
 
-	/**
-	 * Mutates whether a shadow should be casted or not.
-	 *
-	 * Scopes:
-	 * * {@link Element}
-	 * * {@link Variant}
-	 *
-	 * @parser {@link parseBoolean}
-	 */
-	public static readonly CAST_SHADOW = 'castShadow';
-
-	/**
-	 * Mutates from which lights a shadow should be casted.
-	 *
-	 * Scopes:
-	 * * {@link Element}
-	 * * {@link Variant}
-	 *
-	 * @parser {@link parseCommaSeparatedList}
-	 */
-	public static readonly CAST_SHADOW_FROM_LIGHTS = 'castShadow.fromLights';
-
-	/**
-	 * Mutates whether to receive shadows or not.
-	 *
-	 * Scopes:
-	 * * {@link Element}
-	 * * {@link Variant}
-	 *
-	 * @parser {@link parseBoolean}
-	 */
-	public static readonly RECEIVE_SHADOWS = 'receiveShadows';
-
-	/**
-	 * Mutates the intensity of Lights.
-	 *
-	 * Scopes:
-	 * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#intensity), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#intensity), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#intensity), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#intensity)
-	 *
-	 * @parser {@link parseNumber}
-	 */
-	public static readonly INTENSITY = 'intensity';
-
-	/**
-	 * Mutates the direction of Lights.
-	 *
-	 * Scopes:
-	 * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#direction), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#direction), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#direction), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#direction)
-	 *
-	 * @parser {@link parseNumber}
-	 */
-	public static readonly DIRECTION = 'direction';
-
-	/**
-	 * Mutates the angle of Lights.
-	 *
-	 * Scopes:
-	 * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#angle)
-	 *
-	 * @parser {@link parseNumber}
-	 */
-	public static readonly ANGLE = 'angle';
-
-	/**
-	 * Mutates the exponent of Lights.
-	 *
-	 * Scopes:
-	 * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#exponent)
-	 *
-	 * @parser {@link parseNumber}
-	 */
-	public static readonly EXPONENT = 'exponent';
-
-	/**
-	 * Mutates the diffuse color of Lights.
-	 *
-	 * Scopes:
-	 * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#diffuse), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#diffuse), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#diffuse), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#diffuse)
-	 *
-	 * @parser {@link parseNumber}
-	 */
-	public static readonly DIFFUSE = 'diffuse';
-
-	/**
-	 * Mutates the specular color of Lights.
-	 *
-	 * Scopes:
-	 * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#specular), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#specular), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#specular), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#specular)
-	 *
-	 * @parser {@link parseNumber}
-	 */
-	public static readonly SPECULAR = 'specular';
-
 	/**
 	 * The {@link ParameterDeclarations} for all parameters in this class.
 	 */
 	public static get declarations(): ParameterDeclarations {
-		const declarations: ParameterDeclarations = {};
-		declarations[Parameter.VISIBLE] = { type: 'boolean', parser: Parameter.parseBoolean };
-		declarations[Parameter.SCALING] = { type: 'number', parser: Parameter.parseNumber };
-		declarations[Parameter.HIGHLIGHTED] = { type: 'boolean', parser: Parameter.parseBoolean };
-		declarations[Parameter.MATERIAL] = { type: 'string' };
-		declarations[Parameter.MATERIAL_COLOR] = { type: 'color', parser: Parameter.parseColor };
-		declarations[Parameter.MATERIAL_METALLNESS] = { type: 'number', parser: Parameter.parseNumber };
-		declarations[Parameter.MATERIAL_ROUGHNESS] = { type: 'number', parser: Parameter.parseNumber };
-		declarations[Parameter.HIGHLIGHT_ENABLED] = { type: 'boolean', parser: Parameter.parseBoolean };
-		declarations[Parameter.HIGHLIGHT_COLOR] = { type: 'color', parser: Parameter.parseColor };
-		declarations[Parameter.HIGHLIGHTED] = { type: 'boolean', parser: Parameter.parseBoolean };
-		declarations[Parameter.POSITION] = { type: 'vector', parser: Parameter.parseVector };
-		declarations[Parameter.ROTATION] = { type: 'vector', parser: Parameter.parseVector };
-		declarations[Parameter.CAST_SHADOW] = { type: 'boolean', parser: Parameter.parseBoolean };
-		declarations[Parameter.CAST_SHADOW_FROM_LIGHTS] = { type: 'csl', parser: Parameter.parseCommaSeparatedList };
-		declarations[Parameter.RECEIVE_SHADOWS] = { type: 'boolean', parser: Parameter.parseBoolean };
-		declarations[Parameter.INTENSITY] = { type: 'number', parser: Parameter.parseNumber };
-		declarations[Parameter.DIRECTION] = { type: 'vector', parser: Parameter.parseVector };
-		declarations[Parameter.ANGLE] = { type: 'number', parser: Parameter.parseNumber };
-		declarations[Parameter.EXPONENT] = { type: 'number', parser: Parameter.parseNumber };
-		declarations[Parameter.DIFFUSE] = { type: 'color', parser: Parameter.parseColor };
-		declarations[Parameter.SPECULAR] = { type: 'color', parser: Parameter.parseColor };
-		return declarations;
+		const declaration: ParameterDeclarations = {};
+		declaration[Parameter.VISIBLE] = { type: 'boolean' };
+		declaration[Parameter.SCALING] = { type: 'number' };
+		declaration[Parameter.HIGHLIGHTED] = { type: 'boolean' };
+		declaration[Parameter.MATERIAL] = { type: 'string' };
+		declaration[Parameter.MATERIAL_COLOR] = { type: 'color' };
+		declaration[Parameter.MATERIAL_METALLNESS] = { type: 'number' };
+		declaration[Parameter.MATERIAL_ROUGHNESS] = { type: 'number' };
+		declaration[Parameter.HIGHLIGHT_ENABLED] = { type: 'boolean' };
+		declaration[Parameter.HIGHLIGHT_COLOR] = { type: 'color' };
+		declaration[Parameter.HIGHLIGHTED] = { type: 'boolean' };
+		declaration[Parameter.POSITION] = { type: 'vector' };
+		declaration[Parameter.ROTATION] = { type: 'vector' };
+		return declaration;
 	}
 
 	/**
@@ -283,24 +179,6 @@ export class Parameter {
 		return all;
 	}
 
-	/**
-	 * Parses given {@link ParameterBag} with given {@link ParameterDeclarations}.
-	 */
-	public static parseFromDeclarations( declarations: ParameterDeclarations, parameterBag: ParameterBag ): ParsedParameterBag {
-		const parameters: ParsedParameterBag = {};
-		for( const parameter in parameterBag ) {
-			const value = get( parameterBag, parameter );
-			parameters[parameter] = value;
-			const declaration: ParameterDeclaration = declarations[parameter];
-			if( declaration ) {
-				if( !isEmpty( value ) && declaration.parser ) {
-					parameters[parameter] = declaration.parser( value );
-				}
-			}
-		}
-		return parameters;
-	}
-
 	/**
 	 * Parses a string of format `'(x,y,z)'` to a `Vector3`.
 	 */
@@ -396,13 +274,4 @@ export class Parameter {
 		return parseFloat( value.toString() );
 	}
 
-	/**
-	 * Parses a string with comma separated values to a list of strings.
-	 */
-	public static parseCommaSeparatedList( value: ParameterValue ): string[] {
-		return value.toString()
-			.split( ',' )
-			.map( s => s.trim() );
-	}
-
 }

package/src/api/classes/parameterObservable.ts

@@ -1,5 +1,6 @@
 import { merge } from 'lodash-es';
-import { uuidv4 } from '../util/stringHelper';
+import { Parameter } from '../classes/parameter';
+import { uuidv4 } from '../util/resourceHelper';
 import { EventBroadcaster } from './eventBroadcaster';
 
 export abstract class ParameterObservable extends EventBroadcaster {
@@ -74,16 +75,37 @@ export abstract class ParameterObservable extends EventBroadcaster {
 			return;
 		}
 		const declaration = parameterDeclaration[parameter];
-		const genericError = `"${value}" is not a valid value for parameter "${parameter}" of type. ` +
+		const genericError = `"${value}" is not a valid value for parameter "${parameter}" of type ` +
 			`"${declaration.type}" for ${this.constructor.name} "${this.id}".`;
-		if( declaration.parser ) {
-			try {
-				declaration.parser( value );
-			} catch( e ) {
-				throw Error( genericError + e.message );
-			}
-		}
 		switch( declaration.type ) {
+			case 'boolean':
+				try {
+					Parameter.parseBoolean( value );
+				} catch( e ) {
+					throw Error( genericError );
+				}
+				break;
+			case 'number':
+				try {
+					Parameter.parseNumber( value );
+				} catch( e ) {
+					throw Error( genericError );
+				}
+				break;
+			case 'color':
+				try {
+					Parameter.parseColor( value );
+				} catch( e ) {
+					throw Error( genericError +	` It must be hex with leading "#" or of format "(r,g,b)".` );
+				}
+				break;
+			case 'vector':
+				try {
+					Parameter.parseVector( value );
+				} catch( e ) {
+					throw Error( genericError + ` It must be of format "(x,y,z)".` );
+				}
+				break;
 			case 'select':
 				if( !declaration.options ) {
 					throw Error( `No options defined for parameter declaration "${parameter}"` +

package/src/api/classes/placementAnimation.ts

@@ -88,11 +88,6 @@ export class PlacementAnimation implements AnimationInterface {
 			position = Parameter.parseVector( position );
 			this._placementDefinition.position = position;
 		}
-		let shortestWay = true;
-		if( this._animationDefinition.shortestWay !== undefined ) {
-			shortestWay = Parameter.parseBoolean( this._animationDefinition.shortestWay );
-			this._animationDefinition.shortestWay = shortestWay;
-		}
 		if( this.mutable instanceof ArcRotateCamera ) {
 			// parse the target
 			if( isString( this._placementDefinition.target ) ) {
@@ -110,11 +105,6 @@ export class PlacementAnimation implements AnimationInterface {
 				} );
 				delete this._placementDefinition.position;
 				ghostCam.dispose();
-			} else if( shortestWay && this._placementDefinition.alpha ) {
-				// transform the target's alpha value into the same turn as the current camera position to avoid movements > 360 degrees
-				const alphaGap = this.mutable.alpha - this._placementDefinition.alpha;
-				const cntTurns = Math.round(alphaGap / (2 * Math.PI));
-				this._placementDefinition.alpha += (2 * Math.PI * cntTurns);
 			}
 		}
 	}