@configura/babylon-view 2.0.0-alpha.9 → 2.1.0-alpha.0

package/.eslintrc.json

@@ -1,18 +1,5 @@
 {
 	"parser": "@typescript-eslint/parser",
 	"plugins": ["@typescript-eslint"],
-	"extends": [
-		"eslint:recommended",
-		"plugin:@typescript-eslint/recommended",
-		"prettier"
-
-		// TODO: Type-checking rules require a proper tsconfig-file to work,
-		//       pointed at by the parserOption.project setting.
-		//
-		//"plugin:@typescript-eslint/recommended-requiring-type-checking"
-	]
-	//"rules": { "@typescript-eslint/no-floating-promises": "error" }
-	//"parserOptions": {
-	//	"project": "./tsconfig.json"
-	//}
+	"extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"]
 }

package/dist/camera/CfgOrbitalCamera.d.ts

@@ -46,6 +46,7 @@ export declare class CfgOrbitalCamera extends WorkaroundCfgOrbitalCamera {
     _lowestAllowedCameraHeight: number | undefined;
     set lowestAllowedCameraHeight(v: number | undefined);
     get lowestAllowedCameraHeight(): number | undefined;
+    private _pointerDown;
     disableAutomaticSizing: boolean;
     disableZoom: boolean;
     private _externalControlHasHappened;
@@ -54,8 +55,10 @@ export declare class CfgOrbitalCamera extends WorkaroundCfgOrbitalCamera {
     set radius(r: number);
     get radius(): number;
     private get _orbitalCameraControlProps();
-    private _boundNotifyCameraControlListeners;
+    private _boundCameraListener;
+    private _pointerUpDownCallback;
     frameRenderNeeded(): boolean;
+    private get _isMoving();
     private _notifyCameraControlListeners;
     get cameraControlObservable(): Observable<CfgOrbitalCameraControlProps>;
     /**

package/dist/camera/CfgOrbitalCamera.js

@@ -1,3 +1,4 @@
+import { PointerEventTypes } from "@babylonjs/core";
 import { ArcRotateCamera } from "@babylonjs/core/Cameras/arcRotateCamera.js";
 import { Vector3 } from "@babylonjs/core/Maths/math.vector.js";
 import { degToRad, normalizeAngle, Observable } from "@configura/web-utilities";
@@ -33,11 +34,26 @@ export class CfgOrbitalCamera extends WorkaroundCfgOrbitalCamera {
         this._latestSignificantChangeBoundingBox = new CfgBoundingBox();
         this._disableSubFloorCam = false;
         this._lowestAllowedCameraHeight = undefined;
+        this._pointerDown = false;
         this.disableAutomaticSizing = false;
         this.disableZoom = false;
         this._externalControlHasHappened = false;
         this._radius = 0;
-        this._boundNotifyCameraControlListeners = () => this._notifyCameraControlListeners();
+        this._boundCameraListener = () => {
+            // This is a cheap operation, so it's acceptable to do it
+            // for every update (even if no radius-change has happened)
+            this._applyNoSneakPeeking();
+            this._notifyCameraControlListeners();
+        };
+        this._pointerUpDownCallback = (p, s) => {
+            if (p.type === PointerEventTypes.POINTERUP) {
+                this._pointerDown = false;
+                this._notifyCameraControlListeners();
+            }
+            if (p.type === PointerEventTypes.POINTERDOWN) {
+                this._pointerDown = true;
+            }
+        };
         this.attachControl(_canvas, // This parameters is not actually used for anything. But still required.
         false, // No panning with keyboard
         false // No panning with mouse
@@ -58,11 +74,13 @@ export class CfgOrbitalCamera extends WorkaroundCfgOrbitalCamera {
         this.fov = this._config.fov;
         this.inertia = this._config.inertia;
         this.angularSensibilityX = this.angularSensibilityY = this._config.pointerSpeedFactor;
-        this.onViewMatrixChangedObservable.add(this._boundNotifyCameraControlListeners);
+        scene.onPointerObservable.add(this._pointerUpDownCallback, PointerEventTypes.POINTERUP | PointerEventTypes.POINTERDOWN);
+        this.onViewMatrixChangedObservable.add(this._boundCameraListener);
     }
     dispose() {
         this.detachControl(this._canvas);
-        this.onViewMatrixChangedObservable.removeCallback(this._boundNotifyCameraControlListeners);
+        this.onViewMatrixChangedObservable.removeCallback(this._boundCameraListener);
+        this._scene.onPointerObservable.removeCallback(this._pointerUpDownCallback);
         super.dispose();
     }
     set disableSubFloorCam(v) {
@@ -103,6 +121,7 @@ export class CfgOrbitalCamera extends WorkaroundCfgOrbitalCamera {
             yaw: normalizeAngle(this.alpha),
             pitch: this.beta,
             distanceWasAutoSet: this.radius === this._currentMinDistanceToFitModelInView,
+            committed: !(this._isMoving || this._pointerDown),
         };
     }
     frameRenderNeeded() {
@@ -110,8 +129,10 @@ export class CfgOrbitalCamera extends WorkaroundCfgOrbitalCamera {
         if (externalControlHasHappened) {
             this._externalControlHasHappened = false;
         }
+        return this._isMoving || externalControlHasHappened;
+    }
+    get _isMoving() {
         return (this.useAutoRotationBehavior ||
-            externalControlHasHappened ||
             this.inertialAlphaOffset !== 0 ||
             this.inertialBetaOffset !== 0 ||
             this.inertialPanningX !== 0 ||

package/dist/camera/CfgOrbitalCameraControlProps.d.ts

@@ -1,12 +1,15 @@
+export interface CfgOrbitalCameraBasicProps {
+    distance?: number;
+    yaw?: number;
+    pitch?: number;
+}
 /**
  * @param distanceWasAutoSet Indicates that the camera distance was auto set. If true when setting
  * camera settings @param distance will be ignored.
  */
-export interface CfgOrbitalCameraControlProps {
-    distance?: number;
-    yaw?: number;
-    pitch?: number;
+export interface CfgOrbitalCameraControlProps extends CfgOrbitalCameraBasicProps {
     distanceWasAutoSet?: boolean;
+    committed?: boolean;
 }
-export declare function orbitalCameraControlPropsEquals(left: CfgOrbitalCameraControlProps, right: CfgOrbitalCameraControlProps): boolean;
+export declare function orbitalCameraControlPropsEquals(left: CfgOrbitalCameraControlProps, right: CfgOrbitalCameraControlProps, ignoreCommitted?: boolean): boolean;
 //# sourceMappingURL=CfgOrbitalCameraControlProps.d.ts.map

package/dist/camera/CfgOrbitalCameraControlProps.js

@@ -1,6 +1,7 @@
-export function orbitalCameraControlPropsEquals(left, right) {
+export function orbitalCameraControlPropsEquals(left, right, ignoreCommitted = false) {
     return (((left.distanceWasAutoSet && right.distanceWasAutoSet) ||
         left.distance === right.distance) &&
         left.yaw === right.yaw &&
-        left.pitch === right.pitch);
+        left.pitch === right.pitch &&
+        (ignoreCommitted || left.committed === right.committed));
 }

package/dist/io/CfgHistoryToCameraConfConnector.d.ts

@@ -1,4 +1,4 @@
-import { CfgHistoryManager, CfgHistoryManagerSendData } from "@configura/web-api";
+import { CfgHistoryManager, CfgHistoryManagerSendData, HistoryMode } from "@configura/web-api";
 import { Observable } from "@configura/web-utilities";
 import { CfgOrbitalCameraControlProps } from "../camera/CfgOrbitalCameraControlProps.js";
 import { CfgCameraConfMessage, CfgIOCameraConfConnector } from "./CfgIOCameraConfConnector.js";
@@ -9,18 +9,20 @@ import { CfgCameraConfMessage, CfgIOCameraConfConnector } from "./CfgIOCameraCon
  */
 export declare class CfgHistoryToCameraConfConnector extends CfgIOCameraConfConnector<CfgHistoryManagerSendData<CfgCameraConfMessage>> {
     private readonly defaults;
+    private readonly _mode;
     private readonly _qsKeyYaw;
     private readonly _qsKeyPitch;
     private readonly _qsKeyDistance;
     /**
      * @param defaults The default camera settings.
      * @param cameraControl Connects with the Camera.
+     * @param mode
      * @param qsKeyYaw The Query String key for Yaw.
      * @param qsKeyPitch The Query String key for Pitch.
      * @param qsKeyDistance The Query String key for Distance.
      * @returns The instance and the initial camera orientation.
      */
-    static make(manager: CfgHistoryManager, defaults: CfgOrbitalCameraControlProps, cameraControl: Observable<CfgOrbitalCameraControlProps>, qsKeyYaw?: string, qsKeyPitch?: string, qsKeyDistance?: string): {
+    static make(manager: CfgHistoryManager, defaults: CfgOrbitalCameraControlProps, cameraControl: Observable<CfgOrbitalCameraControlProps>, mode: HistoryMode, qsKeyYaw?: string, qsKeyPitch?: string, qsKeyDistance?: string): {
         instance: CfgHistoryToCameraConfConnector;
         initial: CfgOrbitalCameraControlProps;
     };

package/dist/io/CfgHistoryToCameraConfConnector.js

@@ -1,6 +1,6 @@
 import { CfgHistoryManager } from "@configura/web-api";
 import { degToRad, radToDeg } from "@configura/web-utilities";
-import { CfgIOCameraConfConnector } from "./CfgIOCameraConfConnector.js";
+import { CfgIOCameraConfConnector, STAGE_CAMERA_CONF_MESSAGE_KEY, } from "./CfgIOCameraConfConnector.js";
 const YAW_QS_KEY = "stageyaw";
 const PITCH_QS_KEY = "stagepitch";
 const DISTANCE_QS_KEY = "stagedistance";
@@ -38,9 +38,10 @@ const radToDegOrUndefined = (v) => v && radToDeg(v);
  * to the history stack.
  */
 export class CfgHistoryToCameraConfConnector extends CfgIOCameraConfConnector {
-    constructor(manager, defaults, initial, cameraControl, _qsKeyYaw, _qsKeyPitch, _qsKeyDistance) {
+    constructor(manager, defaults, initial, cameraControl, _mode, _qsKeyYaw, _qsKeyPitch, _qsKeyDistance) {
         super(manager, initial, cameraControl);
         this.defaults = defaults;
+        this._mode = _mode;
         this._qsKeyYaw = _qsKeyYaw;
         this._qsKeyPitch = _qsKeyPitch;
         this._qsKeyDistance = _qsKeyDistance;
@@ -48,20 +49,29 @@ export class CfgHistoryToCameraConfConnector extends CfgIOCameraConfConnector {
     /**
      * @param defaults The default camera settings.
      * @param cameraControl Connects with the Camera.
+     * @param mode
      * @param qsKeyYaw The Query String key for Yaw.
      * @param qsKeyPitch The Query String key for Pitch.
      * @param qsKeyDistance The Query String key for Distance.
      * @returns The instance and the initial camera orientation.
      */
-    static make(manager, defaults, cameraControl, qsKeyYaw = YAW_QS_KEY, qsKeyPitch = PITCH_QS_KEY, qsKeyDistance = DISTANCE_QS_KEY) {
+    static make(manager, defaults, cameraControl, mode, qsKeyYaw = YAW_QS_KEY, qsKeyPitch = PITCH_QS_KEY, qsKeyDistance = DISTANCE_QS_KEY) {
         var _a, _b;
         const qsKeyValues = CfgHistoryManager.currentQsKeyValues();
-        const initial = {
-            yaw: (_a = degToRadOrUndefined(qsAsNumber(qsKeyValues, qsKeyYaw))) !== null && _a !== void 0 ? _a : defaults.yaw,
-            pitch: (_b = degToRadOrUndefined(qsAsNumber(qsKeyValues, qsKeyPitch))) !== null && _b !== void 0 ? _b : defaults.pitch,
-            distance: qsAsNumber(qsKeyValues, qsKeyDistance !== null && qsKeyDistance !== void 0 ? qsKeyDistance : defaults.distance),
-        };
-        const instance = new CfgHistoryToCameraConfConnector(manager, defaults, initial, cameraControl, qsKeyYaw, qsKeyPitch, qsKeyDistance);
+        // First try to use the state, if that doesn't work use the query string
+        let initial;
+        const initialMessage = CfgHistoryManager.getMessageFromCurrentHistoryState(STAGE_CAMERA_CONF_MESSAGE_KEY);
+        if (initialMessage !== undefined) {
+            initial = initialMessage.cameraConf;
+        }
+        else {
+            initial = {
+                yaw: (_a = degToRadOrUndefined(qsAsNumber(qsKeyValues, qsKeyYaw))) !== null && _a !== void 0 ? _a : defaults.yaw,
+                pitch: (_b = degToRadOrUndefined(qsAsNumber(qsKeyValues, qsKeyPitch))) !== null && _b !== void 0 ? _b : defaults.pitch,
+                distance: qsAsNumber(qsKeyValues, qsKeyDistance !== null && qsKeyDistance !== void 0 ? qsKeyDistance : defaults.distance),
+            };
+        }
+        const instance = new CfgHistoryToCameraConfConnector(manager, defaults, initial, cameraControl, mode, qsKeyYaw, qsKeyPitch, qsKeyDistance);
         return { instance, initial };
     }
     makeSendData(cameraConf, initial) {
@@ -74,7 +84,7 @@ export class CfgHistoryToCameraConfConnector extends CfgIOCameraConfConnector {
         return {
             message: CfgIOCameraConfConnector.makeMessage(cameraConf, initial),
             qsKeyValues,
-            useHistoryPush: false,
+            mode: this._mode,
         };
     }
 }

package/dist/io/CfgIOCameraConfConnector.d.ts

@@ -15,12 +15,12 @@ declare type CameraConfCallback = (conf: CfgOrbitalCameraControlProps) => Promis
  */
 export declare abstract class CfgIOCameraConfConnector<S> {
     private readonly _ioManager;
-    private readonly _cameraControl;
-    private _stopListenToMessage;
-    private _stopListenToProdConf;
-    constructor(_ioManager: CfgIOManager<S>, initial: CfgOrbitalCameraControlProps, _cameraControl: Observable<CfgOrbitalCameraControlProps>);
+    private readonly _stopListenToMessage;
+    private readonly _stopListenToCameraConf;
+    constructor(_ioManager: CfgIOManager<S>, initial: CfgOrbitalCameraControlProps, cameraControl: Observable<CfgOrbitalCameraControlProps>);
     destroy: () => void;
-    private _delayId;
+    private _latestSentData;
+    private _sendWithoutDuplicates;
     private _send;
     protected abstract makeSendData(cameraConf: CfgOrbitalCameraControlProps, initial: boolean): S;
     static makeMessage(cameraConf: CfgOrbitalCameraControlProps, initial: boolean): CfgCameraConfMessage;

package/dist/io/CfgIOCameraConfConnector.js

@@ -7,40 +7,41 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-// Chrome is not happy if history updates are sent to rapidly.
-// And message receivers probably don't want to get flooded either.
-const THROTTLING_DELAY = 100;
+import { orbitalCameraControlPropsEquals, } from "../camera/CfgOrbitalCameraControlProps.js";
 export const STAGE_CAMERA_CONF_MESSAGE_KEY = "stagecameraconf";
 export const STAGE_CAMERA_MESSAGE_VERSION = "1.0";
 /**
  * Base class for connecting the camera configuration to an IO channel
  */
 export class CfgIOCameraConfConnector {
-    constructor(_ioManager, initial, _cameraControl) {
+    constructor(_ioManager, initial, cameraControl) {
         this._ioManager = _ioManager;
-        this._cameraControl = _cameraControl;
-        this._stopListenToMessage = undefined;
-        this._stopListenToProdConf = undefined;
         this.destroy = () => {
-            var _a, _b;
-            (_a = this._stopListenToMessage) === null || _a === void 0 ? void 0 : _a.call(this);
-            (_b = this._stopListenToProdConf) === null || _b === void 0 ? void 0 : _b.call(this);
+            this._stopListenToMessage();
+            this._stopListenToCameraConf();
+        };
+        this._sendWithoutDuplicates = (cameraConf, initial) => {
+            const latestSentData = this._latestSentData;
+            if (latestSentData !== undefined) {
+                if (orbitalCameraControlPropsEquals(latestSentData.cameraConf, cameraConf) &&
+                    latestSentData.initial === initial) {
+                    return;
+                }
+            }
+            this._latestSentData = { cameraConf, initial };
+            this._send(this.makeSendData(cameraConf, initial));
         };
         this._send = (data) => this._ioManager.send(STAGE_CAMERA_CONF_MESSAGE_KEY, data);
-        this._send(this.makeSendData(initial, true));
+        this._sendWithoutDuplicates(initial, true);
         this._stopListenToMessage = CfgIOCameraConfConnector.listenForMessage((message) => __awaiter(this, void 0, void 0, function* () {
-            if (this._delayId !== undefined) {
+            cameraControl.notifyAll(message.cameraConf, this);
+        }), _ioManager);
+        this._stopListenToCameraConf = CfgIOCameraConfConnector.listenForCamera((cameraConf) => __awaiter(this, void 0, void 0, function* () {
+            if (!cameraConf.committed) {
                 return;
             }
-            _cameraControl.notifyAll(message.cameraConf, this);
-        }), _ioManager);
-        this._stopListenToProdConf = CfgIOCameraConfConnector.listenForCamera((cameraConf) => __awaiter(this, void 0, void 0, function* () {
-            window.clearTimeout(this._delayId);
-            this._delayId = window.setTimeout(() => {
-                this._send(this.makeSendData(cameraConf, false));
-                this._delayId = undefined;
-            }, THROTTLING_DELAY);
-        }), _cameraControl);
+            this._sendWithoutDuplicates(cameraConf, false);
+        }), cameraControl);
     }
     static makeMessage(cameraConf, initial) {
         return {

package/dist/view/SingleProductDefaultCameraView.d.ts

@@ -19,7 +19,8 @@ export declare class SingleProductDefaultCameraView<T extends SingleProductDefau
     private _orbitalCameraConfigurationObservable;
     private _previousOrbitalCameraConf;
     constructor(options: SingleProductDefaultCameraViewConstructorOptions);
-    private _cameraConf;
+    private _cameraDefaults;
+    private initOrResetCamera;
     resetCamera(): void;
     setConfiguration(configuration: SingleProductDefaultCameraViewConfiguration): void;
     addEventListener<K extends keyof T>(event: K, listener: EventListener<T, K>): void;

package/dist/view/SingleProductDefaultCameraView.js

@@ -10,11 +10,11 @@ const CONTENT_TO_LIGHT_RIG_SCALE_FACTOR = 1;
 export class SingleProductDefaultCameraView extends SingleProductView {
     constructor(options) {
         super(Object.assign(Object.assign({}, options), { cameraCreator: getDefaultCamera }));
-        this._cameraConf = {};
+        this._cameraDefaults = {};
     }
-    resetCamera() {
+    initOrResetCamera(props) {
         this.handleSizing(true);
-        const { distance, pitch, yaw } = this._cameraConf;
+        const { distance, pitch, yaw } = props;
         let change = false;
         if (distance !== undefined) {
             this._camera.forceRadius(distance);
@@ -34,15 +34,19 @@ export class SingleProductDefaultCameraView extends SingleProductView {
             this._camera.getViewMatrix();
         }
     }
+    resetCamera() {
+        this.initOrResetCamera(this._cameraDefaults);
+    }
     setConfiguration(configuration) {
+        var _a;
         super.setConfiguration(configuration);
         const cameraConf = configuration.camera || {};
         this._camera.disableAutomaticSizing = cameraConf.disableAutomaticSizing === true;
         this._camera.disableZoom = cameraConf.disableZoom === true;
         this._camera.disableSubFloorCam = cameraConf.disableSubFloorCam === true;
         this._camera.lowestAllowedCameraHeight = cameraConf.lowestAllowedCameraHeight;
-        this._cameraConf = cameraConf;
-        this.resetCamera();
+        this._cameraDefaults = cameraConf;
+        this.initOrResetCamera((_a = cameraConf.initial) !== null && _a !== void 0 ? _a : cameraConf);
         const { autoRotate } = cameraConf;
         if (autoRotate !== undefined) {
             this._camera.useAutoRotationBehavior = true;
@@ -127,7 +131,7 @@ export class SingleProductDefaultCameraView extends SingleProductView {
             ? new CfgBoundingBox()
             : currentProductNode.boundingBox;
         boundingBox.applyMatrix(CET_TO_BABYLON_MATRIX);
-        const initialCameraDistanceSetPreventsInitialAutoSizingSet = this.isFirstLoad && this._cameraConf.distance !== undefined;
+        const initialCameraDistanceSetPreventsInitialAutoSizingSet = this.isFirstLoad && this._cameraDefaults.distance !== undefined;
         this._camera.setContentBoundingBox(boundingBox, initialCameraDistanceSetPreventsInitialAutoSizingSet ? false : force ? true : undefined);
         if (!boundingBox.isEmpty) {
             this._lightRig.scale =

package/dist/view/SingleProductDefaultCameraViewConfiguration.d.ts

@@ -1,19 +1,21 @@
 import { EventListener } from "@configura/web-utilities";
-import { CfgOrbitalCameraControlProps } from "../camera/CfgOrbitalCameraControlProps.js";
+import { CfgOrbitalCameraBasicProps } from "../camera/CfgOrbitalCameraControlProps.js";
 import { CameraConfigurationProps } from "./BaseViewConfiguration.js";
 import { SingleProductViewConfiguration, SingleProductViewEventMap } from "./SingleProductViewConfiguration.js";
 /**
- * @param disableZoom Don't let the camera dolly in and out. Zoom is stricly speaking not correct, we only dolly the camera.
+ * @param yaw Horizontal angle for the camera. Range -π to π radians. The camera will reset to this angle.
+ * @param pitch Vertical angle for the camera. Range 0 to π radians, measured from the north pole. The camera will reset to this angle.
+ * @param distance Only works if disableAutomaticSizing is set
+ * @param initial If set these values are used for the initial configuration of the camera. If not set yaw, pitch and distance are used.
+ * @param disableZoom Don't let the camera dolly in and out. Zoom is strictly speaking not correct, we only dolly the camera.
  * @param disableAutomaticSizing Turn off automatic adaption of camera distance and light rig size.
  * @param disableSubFloorCam It is common that catalogue models are designed to never be shown from below. This limits camera polar angle.
  * @param lowestAllowedCameraHeight Relative to the size of the viewed model, the lowest height the camera can reach. Setting this to 0 is the same as disableSubFloorCam. 1 means the camera can not move lower than the height of the model. Any numeric value is allowed.
- * @param distance Only works if disableAutomaticSizing is set
- * @param yaw Horisontal angle for the camera. Range -π to π radians.
- * @param pitch Vertical angle for the camera. Range 0 to π radians, measured from the north pole.
  * @param autoRotate See babylon-documentation for parameter-documentation
  */
 export interface SingleProductDefaultCameraViewConfiguration extends SingleProductViewConfiguration {
-    camera?: CfgOrbitalCameraControlProps & {
+    camera?: CfgOrbitalCameraBasicProps & {
+        initial?: CfgOrbitalCameraBasicProps;
         disableZoom?: boolean;
         disableAutomaticSizing?: boolean;
         disableSubFloorCam?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@configura/babylon-view",
-	"version": "2.0.0-alpha.9",
+	"version": "2.1.0-alpha.0",
 	"license": "Apache-2.0",
 	"type": "module",
 	"main": "dist/index.js",
@@ -16,16 +16,16 @@
 	},
 	"dependencies": {
 		"@babylonjs/core": "4.2.0",
-		"@configura/web-core": "2.0.0-alpha.9",
-		"@configura/web-utilities": "2.0.0-alpha.9"
+		"@configura/web-core": "2.1.0-alpha.0",
+		"@configura/web-utilities": "2.1.0-alpha.0"
 	},
 	"devDependencies": {
-		"@configura/web-api": "2.0.0-alpha.9",
+		"@configura/web-api": "2.1.0-alpha.0",
 		"del-cli": "^3.0.0",
 		"typescript": "4.2"
 	},
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "734f4e65f7d3dc9836c5c0321dbe6c36bbfa2531"
+	"gitHead": "883ad6e31a55f05124dd0a6b2047c36ef6e6cea1"
 }