@combeenation/3d-viewer 3.1.1-alpha7 → 3.1.2

package/src/api/classes/eventBroadcaster.ts

@@ -1,54 +1,54 @@
-import * as EventEmitter from 'eventemitter3';
-import { emitter } from './event';
-
-export abstract class EventBroadcaster {
-
-	public readonly eventEmitter: EventEmitter;
-
-	protected readonly _eventEmitter: EventEmitter;
-
-	protected constructor() {
-		this.eventEmitter = emitter;
-		this._eventEmitter = new EventEmitter();
-	}
-
-	/**
-	 * Adds a listener function for the given event.
-	 */
-	public addEventListener( event: string, fn: EventEmitter.ListenerFn ): EventBroadcaster {
-		this._eventEmitter.addListener( event, fn );
-		return this;
-	}
-
-	/**
-	 * Removes all `eventListeners` for given event.
-	 */
-	public removeEventListener( event: string ): EventBroadcaster {
-		this._eventEmitter.removeListener( event );
-		return this;
-	}
-
-	/**
-	 * Broadcasts the given event with given arguments to all listeners and emitters.
-	 */
-	public broadcastEvent( event: string, ...args: any[] ): EventBroadcaster {
-		this._eventEmitter.emit( event, ...args );
-		this.eventEmitter.emit( event, ...args );
-		return this;
-	}
-
-	/**
-	 * Alias for {@link addEventListener}.
-	 */
-	public on( event: string, fn: EventEmitter.ListenerFn): EventBroadcaster {
-		return this.addEventListener( event, fn );
-	}
-
-	/**
-	 * Alias for {@link removeEventListener}.
-	 */
-	public off( event: string ): EventBroadcaster {
-		return this.removeEventListener( event );
-	}
-
-}
+import * as EventEmitter from 'eventemitter3';
+import { emitter } from './event';
+
+export abstract class EventBroadcaster {
+
+	public readonly eventEmitter: EventEmitter;
+
+	protected readonly _eventEmitter: EventEmitter;
+
+	protected constructor() {
+		this.eventEmitter = emitter;
+		this._eventEmitter = new EventEmitter();
+	}
+
+	/**
+	 * Adds a listener function for the given event.
+	 */
+	public addEventListener( event: string, fn: EventEmitter.ListenerFn ): EventBroadcaster {
+		this._eventEmitter.addListener( event, fn );
+		return this;
+	}
+
+	/**
+	 * Removes all `eventListeners` for given event.
+	 */
+	public removeEventListener( event: string ): EventBroadcaster {
+		this._eventEmitter.removeListener( event );
+		return this;
+	}
+
+	/**
+	 * Broadcasts the given event with given arguments to all listeners and emitters.
+	 */
+	public broadcastEvent( event: string, ...args: any[] ): EventBroadcaster {
+		this._eventEmitter.emit( event, ...args );
+		this.eventEmitter.emit( event, ...args );
+		return this;
+	}
+
+	/**
+	 * Alias for {@link addEventListener}.
+	 */
+	public on( event: string, fn: EventEmitter.ListenerFn): EventBroadcaster {
+		return this.addEventListener( event, fn );
+	}
+
+	/**
+	 * Alias for {@link removeEventListener}.
+	 */
+	public off( event: string ): EventBroadcaster {
+		return this.removeEventListener( event );
+	}
+
+}

package/src/api/classes/parameter.ts

@@ -1,277 +1,277 @@
-import { Color3 } from '@babylonjs/core/Maths/math.color';
-import { Vector3 } from '@babylonjs/core/Maths/math.vector';
-import { isNumber, isString } from 'lodash-es';
-
-
-/**
- * This `Parameter` class defines all parameters that can be consumed and committed by a {@link ParameterObservable}.
- * Use {@link ParameterObservable.addParameterObserver} or {@link ParameterObservable.commitParameters} to either add or
- * commit parameters on your observable objects.
- */
-export class Parameter {
-
-	/**
-	 * Constructor.
-	 */
-	private constructor() {}
-
-	/**
-	 * 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}
-	 *
-	 * @parser {@link parseBoolean}
-	 */
-	public static readonly VISIBLE = 'visible';
-
-	/**
-	 * Stretches or compresses some meshes. Getter and setter is {@link ElementParameterizable.scaling}.
-	 *
-	 * Scopes:
-	 * * {@link Element}
-	 * * {@link Variant}
-	 *
-	 * @parser {@link parseScaling}
-	 */
-	public static readonly SCALING = 'scaling';
-
-	/**
-	 * 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:
-	 * * {@link Element}
-	 * * {@link Variant}
-	 *
-	 * @parser string
-	 */
-	public static readonly MATERIAL = 'material';
-
-	/**
-	 * Mutates the material color.
-	 *
-	 * Scopes:
-	 * * {@link Element}
-	 * * {@link Variant}
-	 *
-	 * @parser {@link parseColor}
-	 */
-	public static readonly MATERIAL_COLOR = 'material.color';
-
-	/**
-	 * Mutates the material metallness.
-	 *
-	 * Scopes:
-	 * * {@link Element}
-	 * * {@link Variant}
-	 *
-	 * @parser {@link parseNumber}
-	 */
-	public static readonly MATERIAL_METALLNESS = 'material.metallness';
-
-	/**
-	 * Mutates the material roughness.
-	 *
-	 * Scopes:
-	 * * {@link Element}
-	 * * {@link Variant}
-	 *
-	 * @parser {@link parseNumber}
-	 */
-	public static readonly MATERIAL_ROUGHNESS = 'material.roughness';
-
-	/**
-	 * Mutates whether a highlight layer should be enabled.
-	 *
-	 * Scopes:
-	 * * {@link Element}
-	 * * {@link Variant}
-	 *
-	 * @parser {@link parseBoolean}
-	 */
-	public static readonly HIGHLIGHT_ENABLED = 'highlight.enabled';
-
-	/**
-	 * Changes the highlight color.
-	 *
-	 * Scopes:
-	 * * {@link Element}
-	 * * {@link Variant}
-	 *
-	 * @parser {@link parseColor}
-	 */
-	public static readonly HIGHLIGHT_COLOR = 'highlight.color';
-
-	/**
-	 * Mutates the highlighted state. Getter and setter is {@link ElementParameterizable.highlighted}.
-	 *
-	 * Scopes:
-	 * * {@link Element}
-	 * * {@link Variant}
-	 *
-	 * @parser {@link parseBoolean}
-	 */
-	public static readonly HIGHLIGHTED = 'highlighted';
-
-	/**
-	 * Mutates the position relative to its origin position. Getter and setter is {@link ElementParameterizable.position}.
-	 *
-	 * Scopes:
-	 * * {@link Element}
-	 * * {@link Variant}
-	 *
-	 * @parser {@link parseVector}
-	 */
-	public static readonly POSITION = 'position';
-
-	/**
-	 * Mutates the rotation relative to its origin rotation. Getter and setter is {@link ElementParameterizable.rotation}.
-	 *
-	 * Scopes:
-	 * * {@link Element}
-	 * * {@link Variant}
-	 *
-	 * @parser {@link parseRotation}
-	 */
-	public static readonly ROTATION = 'rotation';
-
-	/**
-	 * The {@link ParameterDeclarations} for all parameters in this class.
-	 */
-	public static get declarations(): ParameterDeclarations {
-		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;
-	}
-
-	/**
-	 * Gets the {@link ParameterDeclaration} for a given {@link Parameter} declared in this class.
-	 */
-	public static getDeclaration(parameter: string): ParameterDeclaration {
-		return Parameter.declarations[parameter];
-	}
-
-	/**
-	 * All parameters defined in this class.
-	 */
-	public static get all() {
-		const all: string[] = [];
-		for( const parameter in Parameter ) {
-			const property = Object.getOwnPropertyDescriptor(Parameter, parameter);
-			if( parameter.toUpperCase() === parameter && property && isString( property.value ) ) {
-				all.push( property.value );
-			}
-		}
-		return all;
-	}
-
-	/**
-	 * Parses a string of format `'(x,y,z)'` to a `Vector3`.
-	 */
-	public static parseVector( value: ParameterValue ): Vector3 {
-		if( !isString( value ) ) {
-			throw new Error( `Unable to convert "${value}" into a Vector: not a string.` );
-		}
-		let cleanedValue = value.split( ' ' ).join( '' );
-		if( cleanedValue.startsWith( '(' ) && cleanedValue.endsWith( ')' ) ) {
-			cleanedValue = cleanedValue.substring( 1, cleanedValue.length - 1 );
-			let [x, y, z] = cleanedValue.split( ',' ).map( value => parseFloat( value ) );
-			return new Vector3( x, y, z );
-		} else {
-			throw new Error( `Unable to parse "${value}" to a Vector: expected "(x,y,z)".` );
-		}
-	}
-
-	/**
-	 * Stringifies a Vector3 to format `(x,y,z)`.
-	 */
-	public static stringifyVector( value: Vector3 ): string {
-		return `(${value.x},${value.y},${value.z})`;
-	}
-
-	/**
-	 * Parses a string of format `'(x,y,z)'` with angular degrees to a `Vector3` with rotation information in radians.
-	 */
-	public static parseRotation( value: ParameterValue ): Vector3 {
-		const rotation = Parameter.parseVector( value );
-		const deg2rad = function( deg: number ) {
-			return deg * Math.PI / 180;
-		};
-		return rotation.set(
-			deg2rad( rotation.x ),
-			deg2rad( rotation.y ),
-			deg2rad( rotation.z )
-		);
-	}
-
-	/**
-	 * Parses a string of format `'(x,y,z)'` or a simple `number` to a `Vector3` for scaling.
-	 */
-	public static parseScaling( value: ParameterValue ): Vector3 {
-		let scaling = new Vector3();
-		if( isString( value ) ) {
-			const cleanedFactor = value.split( ' ' ).join( '' );
-			if( cleanedFactor.startsWith( '(' ) && cleanedFactor.endsWith( ')' ) ) {
-				scaling = Parameter.parseVector( cleanedFactor );
-			} else {
-				const _factor = parseFloat( value );
-				scaling = new Vector3( _factor, _factor, _factor );
-			}
-		} else if( isNumber( value ) ) {
-			scaling = new Vector3( value, value, value );
-		} else {
-			throw new Error( `Unable to convert "${value}" to a Vector: expected "(x,y,z)".` );
-		}
-		return scaling;
-	}
-
-	/**
-	 * Parses a string of format `'#rrggbb'` or `'(r,g,b)'` to a `Color3`.
-	 */
-	public static parseColor( value: ParameterValue ): Color3 {
-		let cleanedValue = value.toString().split( ' ' ).join( '' );
-		if( cleanedValue.startsWith( '#' ) ) {
-			return Color3.FromHexString( value.toString() );
-		}
-		if( cleanedValue.startsWith( '(' ) && cleanedValue.endsWith( ')' ) ) {
-			cleanedValue = cleanedValue.substring( 1, cleanedValue.length - 1 );
-			let [r, g, b] = cleanedValue.split( ',' ).map( value => parseFloat( value ) );
-			return Color3.FromInts( r, g, b );
-		}
-		throw new Error( `Unable to parse "${value}" to a Color: expected "#rrggbb" or "(r,g,b)".` );
-	}
-
-	/**
-	 * Parses a `boolean` string (`'true'`/`'1'` or `'false'`/`'0'`) or `number` (`1` or `0`) to a `boolean` or `undefined`.
-	 */
-	public static parseBoolean( value: ParameterValue ): boolean {
-		if( value.toString() === 'true' || value.toString() === '1' ) {
-			return true;
-		} else if( value.toString() === 'false' || value.toString() === '0' ) {
-			return false;
-		}
-		throw new Error( `Unable to parse "${value}" to a boolean.` );
-	}
-
-	/**
-	 * Parses a number `string` to a `number`.
-	 */
-	public static parseNumber( value: ParameterValue ): number {
-		return parseFloat( value.toString() );
-	}
-
-}
+import { Color3 } from '@babylonjs/core/Maths/math.color';
+import { Vector3 } from '@babylonjs/core/Maths/math.vector';
+import { isNumber, isString } from 'lodash-es';
+
+
+/**
+ * This `Parameter` class defines all parameters that can be consumed and committed by a {@link ParameterObservable}.
+ * Use {@link ParameterObservable.addParameterObserver} or {@link ParameterObservable.commitParameters} to either add or
+ * commit parameters on your observable objects.
+ */
+export class Parameter {
+
+	/**
+	 * Constructor.
+	 */
+	private constructor() {}
+
+	/**
+	 * 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}
+	 *
+	 * @parser {@link parseBoolean}
+	 */
+	public static readonly VISIBLE = 'visible';
+
+	/**
+	 * Stretches or compresses some meshes. Getter and setter is {@link ElementParameterizable.scaling}.
+	 *
+	 * Scopes:
+	 * * {@link Element}
+	 * * {@link Variant}
+	 *
+	 * @parser {@link parseScaling}
+	 */
+	public static readonly SCALING = 'scaling';
+
+	/**
+	 * 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:
+	 * * {@link Element}
+	 * * {@link Variant}
+	 *
+	 * @parser string
+	 */
+	public static readonly MATERIAL = 'material';
+
+	/**
+	 * Mutates the material color.
+	 *
+	 * Scopes:
+	 * * {@link Element}
+	 * * {@link Variant}
+	 *
+	 * @parser {@link parseColor}
+	 */
+	public static readonly MATERIAL_COLOR = 'material.color';
+
+	/**
+	 * Mutates the material metallness.
+	 *
+	 * Scopes:
+	 * * {@link Element}
+	 * * {@link Variant}
+	 *
+	 * @parser {@link parseNumber}
+	 */
+	public static readonly MATERIAL_METALLNESS = 'material.metallness';
+
+	/**
+	 * Mutates the material roughness.
+	 *
+	 * Scopes:
+	 * * {@link Element}
+	 * * {@link Variant}
+	 *
+	 * @parser {@link parseNumber}
+	 */
+	public static readonly MATERIAL_ROUGHNESS = 'material.roughness';
+
+	/**
+	 * Mutates whether a highlight layer should be enabled.
+	 *
+	 * Scopes:
+	 * * {@link Element}
+	 * * {@link Variant}
+	 *
+	 * @parser {@link parseBoolean}
+	 */
+	public static readonly HIGHLIGHT_ENABLED = 'highlight.enabled';
+
+	/**
+	 * Changes the highlight color.
+	 *
+	 * Scopes:
+	 * * {@link Element}
+	 * * {@link Variant}
+	 *
+	 * @parser {@link parseColor}
+	 */
+	public static readonly HIGHLIGHT_COLOR = 'highlight.color';
+
+	/**
+	 * Mutates the highlighted state. Getter and setter is {@link ElementParameterizable.highlighted}.
+	 *
+	 * Scopes:
+	 * * {@link Element}
+	 * * {@link Variant}
+	 *
+	 * @parser {@link parseBoolean}
+	 */
+	public static readonly HIGHLIGHTED = 'highlighted';
+
+	/**
+	 * Mutates the position relative to its origin position. Getter and setter is {@link ElementParameterizable.position}.
+	 *
+	 * Scopes:
+	 * * {@link Element}
+	 * * {@link Variant}
+	 *
+	 * @parser {@link parseVector}
+	 */
+	public static readonly POSITION = 'position';
+
+	/**
+	 * Mutates the rotation relative to its origin rotation. Getter and setter is {@link ElementParameterizable.rotation}.
+	 *
+	 * Scopes:
+	 * * {@link Element}
+	 * * {@link Variant}
+	 *
+	 * @parser {@link parseRotation}
+	 */
+	public static readonly ROTATION = 'rotation';
+
+	/**
+	 * The {@link ParameterDeclarations} for all parameters in this class.
+	 */
+	public static get declarations(): ParameterDeclarations {
+		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;
+	}
+
+	/**
+	 * Gets the {@link ParameterDeclaration} for a given {@link Parameter} declared in this class.
+	 */
+	public static getDeclaration(parameter: string): ParameterDeclaration {
+		return Parameter.declarations[parameter];
+	}
+
+	/**
+	 * All parameters defined in this class.
+	 */
+	public static get all() {
+		const all: string[] = [];
+		for( const parameter in Parameter ) {
+			const property = Object.getOwnPropertyDescriptor(Parameter, parameter);
+			if( parameter.toUpperCase() === parameter && property && isString( property.value ) ) {
+				all.push( property.value );
+			}
+		}
+		return all;
+	}
+
+	/**
+	 * Parses a string of format `'(x,y,z)'` to a `Vector3`.
+	 */
+	public static parseVector( value: ParameterValue ): Vector3 {
+		if( !isString( value ) ) {
+			throw new Error( `Unable to convert "${value}" into a Vector: not a string.` );
+		}
+		let cleanedValue = value.split( ' ' ).join( '' );
+		if( cleanedValue.startsWith( '(' ) && cleanedValue.endsWith( ')' ) ) {
+			cleanedValue = cleanedValue.substring( 1, cleanedValue.length - 1 );
+			let [x, y, z] = cleanedValue.split( ',' ).map( value => parseFloat( value ) );
+			return new Vector3( x, y, z );
+		} else {
+			throw new Error( `Unable to parse "${value}" to a Vector: expected "(x,y,z)".` );
+		}
+	}
+
+	/**
+	 * Stringifies a Vector3 to format `(x,y,z)`.
+	 */
+	public static stringifyVector( value: Vector3 ): string {
+		return `(${value.x},${value.y},${value.z})`;
+	}
+
+	/**
+	 * Parses a string of format `'(x,y,z)'` with angular degrees to a `Vector3` with rotation information in radians.
+	 */
+	public static parseRotation( value: ParameterValue ): Vector3 {
+		const rotation = Parameter.parseVector( value );
+		const deg2rad = function( deg: number ) {
+			return deg * Math.PI / 180;
+		};
+		return rotation.set(
+			deg2rad( rotation.x ),
+			deg2rad( rotation.y ),
+			deg2rad( rotation.z )
+		);
+	}
+
+	/**
+	 * Parses a string of format `'(x,y,z)'` or a simple `number` to a `Vector3` for scaling.
+	 */
+	public static parseScaling( value: ParameterValue ): Vector3 {
+		let scaling = new Vector3();
+		if( isString( value ) ) {
+			const cleanedFactor = value.split( ' ' ).join( '' );
+			if( cleanedFactor.startsWith( '(' ) && cleanedFactor.endsWith( ')' ) ) {
+				scaling = Parameter.parseVector( cleanedFactor );
+			} else {
+				const _factor = parseFloat( value );
+				scaling = new Vector3( _factor, _factor, _factor );
+			}
+		} else if( isNumber( value ) ) {
+			scaling = new Vector3( value, value, value );
+		} else {
+			throw new Error( `Unable to convert "${value}" to a Vector: expected "(x,y,z)".` );
+		}
+		return scaling;
+	}
+
+	/**
+	 * Parses a string of format `'#rrggbb'` or `'(r,g,b)'` to a `Color3`.
+	 */
+	public static parseColor( value: ParameterValue ): Color3 {
+		let cleanedValue = value.toString().split( ' ' ).join( '' );
+		if( cleanedValue.startsWith( '#' ) ) {
+			return Color3.FromHexString( value.toString() );
+		}
+		if( cleanedValue.startsWith( '(' ) && cleanedValue.endsWith( ')' ) ) {
+			cleanedValue = cleanedValue.substring( 1, cleanedValue.length - 1 );
+			let [r, g, b] = cleanedValue.split( ',' ).map( value => parseFloat( value ) );
+			return Color3.FromInts( r, g, b );
+		}
+		throw new Error( `Unable to parse "${value}" to a Color: expected "#rrggbb" or "(r,g,b)".` );
+	}
+
+	/**
+	 * Parses a `boolean` string (`'true'`/`'1'` or `'false'`/`'0'`) or `number` (`1` or `0`) to a `boolean` or `undefined`.
+	 */
+	public static parseBoolean( value: ParameterValue ): boolean {
+		if( value.toString() === 'true' || value.toString() === '1' ) {
+			return true;
+		} else if( value.toString() === 'false' || value.toString() === '0' ) {
+			return false;
+		}
+		throw new Error( `Unable to parse "${value}" to a boolean.` );
+	}
+
+	/**
+	 * Parses a number `string` to a `number`.
+	 */
+	public static parseNumber( value: ParameterValue ): number {
+		return parseFloat( value.toString() );
+	}
+
+}