@realsee/dnalogel 3.5.0 → 3.6.0-dev.0

package/dist/CruisePlugin/BaseController.d.ts

@@ -0,0 +1,159 @@
+import type { Five, State } from '@realsee/five';
+import type { BaseOptions } from '../base/BasePlugin';
+import type { GuideLinePluginExportType } from '../GuideLinePlugin';
+import * as BasePlugin from '../base/BasePlugin';
+import type { PluginState, EventMap, MoveEffect } from './typing';
+import type { PartialDeep } from 'type-fest';
+export declare const pluginFlag: (name: string) => string;
+export default abstract class CruiseController<PluginData, Config = unknown> extends BasePlugin.Controller<PluginState, EventMap> {
+    state: PluginState;
+    protected data?: PluginData & {
+        id: string | number;
+    };
+    protected config?: Config;
+    protected privateState: {
+        /**
+         * privateState.playing 和 state.playing 的区别：
+         * state.playing 先为true，然后才 handleplay，handleplay方法内会检查privateState.playing，如果已经开始（privateState.playing === true），就不执行操作，如果为false，就执行操作
+         * 其实就是加了一个不允许重复执行handleplay的逻辑
+         */
+        playing: boolean;
+        broke: boolean;
+        playId?: string;
+        moveToFirstPanoEffect?: MoveEffect;
+        moveToFirstPanoDuration?: number;
+        modeChanging?: boolean;
+    };
+    protected GuideLine?: GuideLinePluginExportType;
+    constructor(five: Five, config?: Config);
+    /**
+     * @description Play | Continue play. if have been paused, continue play from the pause position; if playing, do nothing
+     */
+    play(options?: {
+        userAction?: boolean;
+    }): void;
+    /**
+     * @description Pause
+     */
+    pause(options?: {
+        userAction?: boolean;
+    }): void;
+    /**
+     * @description Show guide line
+     */
+    show(options?: {
+        userAction?: boolean;
+    }): Promise<void>;
+    /**
+     * @description Hide guide line
+     */
+    hide(options?: {
+        userAction?: boolean;
+    }): Promise<void>;
+    /**
+     * @description Enable
+     */
+    enable(options?: {
+        userAction?: boolean;
+    }): void;
+    /**
+     * @description Disable
+     */
+    disable(options?: {
+        userAction?: boolean;
+    }): void;
+    /**
+     * @description Dispose
+     */
+    dispose(): void;
+    /**
+     * @description Set state
+     */
+    setState(state: PartialDeep<PluginState>, options?: BaseOptions & Record<string, any>): void;
+    /**
+     * @description Clear pause data
+     */
+    protected clearPauseData(): boolean;
+    protected changePlayState(play: boolean, options?: {
+        userAction?: boolean;
+        playFromIndex?: number;
+        playFromId?: string;
+    }): void;
+    protected handleEnable(enabled: boolean, userAction?: boolean): void;
+    protected handleVisible(visible: boolean, userAction?: boolean): void;
+    /**
+     * @description: listen interupted by five gesture
+     */
+    protected addInterruptListener(interrupt: () => void): () => void;
+    /**
+     * @description Get duration by speed
+     */
+    protected getSpeededDuration(duration: number): number;
+    /**
+     * @description Force interupt five updateCamera
+     */
+    protected forceInteruptUpdateCamera(): void;
+    protected getPauseData(): {
+        fiveState: Partial<State>;
+        id?: string | number;
+        playedProgress: number;
+        duration?: number;
+    };
+    /**
+     * @description Set pause data
+     */
+    protected setPauseData(): Map<string | number, {
+        fiveState: Partial<State>;
+        id?: string | number;
+        playedProgress: number;
+        duration?: number;
+    }>;
+    /**
+     * @description: Restore state that before loaded
+     */
+    protected clear(): void;
+    protected handleDispose(): void;
+    /**
+     * @description Action function if plugin is enable
+     */
+    protected actionIfStateIsEnabled<T = any>(func: () => T, options?: {
+        warnLog?: true;
+    }): T;
+    protected disposedErrorLog: () => void;
+    protected disableWarnLog: () => void;
+    protected disableErrorLog: () => void;
+    /**
+     * @description Load Data and State
+     */
+    abstract load(serverData: unknown, state?: PluginState, userAction?: boolean): Promise<void>;
+    /**
+     * @description Play from first keyframe
+     */
+    abstract playFromStart(): void;
+    /**
+     * @description Play | Continue play. if have been paused, continue play from the pause position; if playing, do nothing
+     * @param {number} options.playFromIndex play from keyframes index
+     * @param {string} options.playFromId play from keyframes id
+     */
+    protected abstract handlePlay(options?: {
+        userAction?: boolean;
+        playFromIndex?: number;
+        playFromId?: string;
+        notEmitEvent?: true;
+    }): Promise<string>;
+    /**
+     * @description: Change play speed
+     */
+    protected abstract changeSpeed(speed: number): void;
+    /**
+     * @description Get ratate progress
+     */
+    protected abstract getProgress(): number;
+    /**
+     * @description: Pause and record pause state
+     */
+    protected abstract handlePause(options?: {
+        userAction?: boolean;
+        notEmitEvent?: true;
+    }): void;
+}

package/dist/CruisePlugin/Move.d.ts

@@ -0,0 +1,40 @@
+import type { Five } from '@realsee/five';
+import CruiseController from './BaseController';
+import type { PluginState } from './typing';
+import type { PartialDeep } from 'type-fest';
+import type * as THREE from 'three';
+type Data = {
+    path: THREE.CurvePath<THREE.Vector3>;
+    offset?: Partial<{
+        x: number;
+        y: number;
+        z: number;
+    }>;
+};
+type Config = {
+    offset?: Partial<{
+        x: number;
+        y: number;
+        z: number;
+    }>;
+    allowBroke?: boolean;
+};
+export default class MoveController extends CruiseController<Data, Config> {
+    private curve;
+    private baseCurveOffset;
+    private curveOffset;
+    private playStartedTime;
+    private duration;
+    constructor(five: Five, config?: Config);
+    load(data: Data, state?: PartialDeep<PluginState>): Promise<void>;
+    changeSpeed: (speed: number, userAction?: boolean) => void;
+    moveToStart: () => void;
+    playFromStart: () => void;
+    protected getDuration: () => number;
+    protected getProgress: () => number;
+    protected handlePlay(): Promise<string>;
+    protected handlePause(options?: {
+        userAction?: boolean;
+    }): void;
+}
+export {};

package/dist/CruisePlugin/Work.d.ts

@@ -0,0 +1,120 @@
+import type { Five, State } from '@realsee/five';
+import type { PluginState, PluginServerData, PluginData, CruiseKeyframe, MoveEffect, Config } from './typing';
+import CruiseController from './BaseController';
+export default class WalkController extends CruiseController<PluginData, Config> {
+    state: PluginState;
+    protected privateState: {
+        /**
+         * privateState.playing 和 state.playing 的区别：
+         * state.playing 先为true，然后才 handleplay，handleplay方法内会检查privateState.playing，如果已经开始（privateState.playing === true），就不执行操作，如果为false，就执行操作
+         * 其实就是加了一个不允许重复执行handleplay的逻辑
+         */
+        playing: boolean;
+        currentPlayKeyframe: {
+            keyframe: CruiseKeyframe;
+            originDuration?: number;
+        } | null;
+        currentPlayQueue: Promise<any>[];
+        broke: boolean;
+        playId?: string;
+        moveToFirstPanoEffect?: MoveEffect;
+        moveToFirstPanoDuration?: number;
+        modeChanging?: boolean;
+    };
+    constructor(five: Five, config?: Config);
+    /**
+     * @description Load Data and State
+     */
+    load(serverData: PluginServerData | PluginServerData['data'], state?: PluginState, userAction?: boolean): Promise<void>;
+    /**
+     * @description If playing, first pause, then play from keyframes index/id
+     * @param {number} options.index play from keyframes index
+     * @param {string} options.id play from keyframes id
+     */
+    playFrom(options: {
+        userAction?: boolean;
+        index?: number;
+        id?: string;
+    }): void;
+    /**
+     * @description Play from first keyframe
+     */
+    playFromStart(options?: {
+        userAction?: boolean;
+    }): void;
+    /**
+     * @description Format data
+     */
+    protected formatData(serverData: PluginServerData | PluginServerData['data']): Promise<PluginData>;
+    /**
+     * @description Play | Continue play. if have been paused, continue play from the pause position; if playing, do nothing
+     * @param {number} options.playFromIndex play from keyframes index
+     * @param {string} options.playFromId play from keyframes id
+     */
+    protected handlePlay(options?: {
+        userAction?: boolean;
+        playFromIndex?: number;
+        playFromId?: string;
+        notEmitEvent?: true;
+    }): Promise<string>;
+    /**
+     * @description: Pause and record pause state
+     */
+    protected handlePause(options?: {
+        userAction?: boolean;
+        notEmitEvent?: true;
+    }): void;
+    /**
+     * @description: Change play speed
+     */
+    protected changeSpeed(speed: number, userAction?: boolean): void;
+    /**
+     * @description Get ratate progress
+     */
+    protected getProgress(): any;
+    /**
+     * @description Set pause data
+     */
+    protected setPauseData(): Map<string, {
+        fiveState: Partial<State>;
+        id?: string | number;
+        playedProgress: number;
+        duration?: number;
+    }>;
+    /**
+     * @description: Restore state that before loaded
+     */
+    protected clear(): void;
+    /**
+     * @description Play single keyframe
+     */
+    private playKeyframe;
+    /**
+     * @description: getPlayPromise
+     */
+    private getPlayPromise;
+    /**
+     * @description Action promise queue in sequence
+     */
+    private actionPromiseQueue;
+    /**
+     * @description Action move keyframe
+     */
+    private move;
+    /**
+     * @description Action rotate keyframe
+     */
+    private rotate;
+    /**
+     * @description Update five camera
+     */
+    private updateCamera;
+    /**
+     * @description: Change five pano
+     */
+    private changePano;
+    /**
+     * @description Change five mode
+     */
+    private changeMode;
+}

package/dist/CruisePlugin/index.d.ts

@@ -1,9 +1,10 @@
 import type { FivePlugin } from '@realsee/five';
-import CruisePluginController from './Controller';
 import * as CruisePluginTypes from './typing';
 import type { Config } from './typing';
-export { CruisePluginController };
-export declare const CruisePlugin: FivePlugin<Config | undefined, InstanceType<typeof CruisePluginController>>;
+import WalkController from './Work';
+import MoveController from './Move';
+export declare const CruisePlugin: FivePlugin<Config | undefined, InstanceType<typeof WalkController>>;
+export { WalkController, MoveController, MoveController as CruisePluginController };
 export type { CruisePluginExportType } from './typing';
 export default CruisePlugin;
 export { CruisePluginTypes };

package/dist/CruisePlugin/typing.d.ts

@@ -82,7 +82,7 @@ export interface PluginState extends BasePluginWithData.State {
     speed: number;
     config?: {
         /** 速度配置 */
-        speedConfig?: {
+        speedConfig?: Partial<{
             /** 旋转速度 */
             rotateSpeed: number;
             /** 旋转速度单位 */
@@ -91,7 +91,7 @@ export interface PluginState extends BasePluginWithData.State {
             moveSpeed: number;
             /** 移动速度单位 */
             moveSpeedUnit: 'm/s' | 'm/ms';
-        };
+        }>;
         /** five 走点动画 */
         moveEffect?: MoveEffect;
     };

package/dist/CruisePlugin/utils/getFiveStateOnCurve.d.ts

@@ -0,0 +1,11 @@
+import * as THREE from 'three';
+export declare function getFiveStateOnCurve(curve: THREE.Curve<THREE.Vector3>, progress: number, curveOffset: Partial<{
+    x: number;
+    y: number;
+    z: number;
+}>): {
+    offset: THREE.Vector3;
+    longitude: number;
+    latitude: number;
+    distance: number;
+};

package/dist/GuideLinePlugin/Controller.d.ts

@@ -4,10 +4,9 @@ import type { EventMap, PluginData, PluginServerData, PluginState } from './typi
 import type * as PluginType from './typing';
 import type { Config } from '../base/BasePlugin';
 import { GuideLineItem } from './GuideLineItem';
-import CruisePluginController from '../CruisePlugin/Controller';
+import CruisePluginController from '../CruisePlugin/Move';
 export declare const pluginFlag: (name: string) => string;
 export default class Controller extends BasePluginWithData.Controller<PluginState, EventMap, PluginServerData, PluginData> {
-    readonly version = "v1.1.0";
     readonly name = "GuideLinePlugin";
     readonly cruisePlugin: CruisePluginController;
     /** GuideLineItem 索引 */
@@ -60,9 +59,5 @@ export default class Controller extends BasePluginWithData.Controller<PluginStat
     private handleEnable;
     private handleVisible;
     private disposedErrorLog;
-    /**
-     * @description: Wait for five model ready
-     */
-    private waitFiveLoaded;
     private getDataWithoutVersion;
 }