@realsee/dnalogel 2.0.0-alpha.35 → 2.0.0-alpha.36

package/dist/PanoMeasurePlugin/typings/data.d.ts

@@ -29,4 +29,9 @@ export interface PluginData {
 /** 开放可配置参数 */
 export interface OpenParameter {
     isMobile?: boolean;
+    crossHairParameter?: CrossHairParameter;
+}
+export interface CrossHairParameter {
+    useNormalVector?: boolean;
+    ballColor?: number;
 }

package/dist/PanoMeasurePlugin/utils/mouseGroup.d.ts

@@ -1,2 +1,7 @@
 import { Group } from 'three';
-export declare function getMouseGroup(): Group;
+export interface MouseGroupParameter {
+    isMobile?: boolean;
+    useNormalVector?: boolean;
+    ballColor?: number;
+}
+export declare function getMouseGroup(params: MouseGroupParameter): Group;

package/dist/base/BasePlugin.d.ts

@@ -0,0 +1,100 @@
+import { Five, Subscribe } from '@realsee/five';
+/**
+ * 基本属性字段
+ */
+interface State {
+    /**
+     * 插件是否启用
+     */
+    enabled: boolean;
+    /**
+     * 插件UI是否展示
+     */
+    visible?: boolean;
+    /**
+     * 插件的配置项
+     */
+    config?: unknown;
+}
+interface BaseOptions {
+    /** 是否是用户行为 */
+    userAction?: boolean;
+}
+/**
+ * 插件基本事件
+ */
+declare type EventMap<PluginState> = {
+    /**
+     * 插件被销毁
+     */
+    dispose: () => void;
+    /**
+     * 插件状态变化
+     * @param params.state      最新的State
+     * @param params.prevState  上一个State
+     * @param params.userAction 是否是用户触发
+     */
+    stateChange: (params: {
+        state: PluginState;
+        prevState?: PluginState;
+        userAction: boolean;
+    }) => void;
+};
+/**
+ * plugin 的基本控制器
+ */
+declare abstract class Controller<PluginState extends State, PluginEventMap extends EventMap<PluginState>> {
+    five: Five;
+    /**
+     * 插件事件钩子
+     */
+    hooks: Subscribe<PluginEventMap>;
+    /**
+     * 当前状态
+     * @description
+     * ```text
+     * 可以通过 plugin.state 和 plugin.setState 来获取和设置。
+     * 通过 state 设置后，plugin 会通过合适的动画运动来达到设置的效果。
+     * 来迎合一些通过数据驱动的场景。
+     * ```
+     */
+    abstract state: PluginState;
+    constructor(five: Five);
+    /**
+     * 获取当前的插件状态，如果当初插件内存在需要通过动画变更的 state 值，则通过此方法可以得到中间状态
+     */
+    getCurrentState(): PluginState;
+    /**
+     * 插件自身DOM添加到父容器
+     * @param wrapper
+     */
+    appendTo?(wrapper: Element): void;
+    /**
+     * 展示UI
+     */
+    show?(options?: BaseOptions): Promise<void>;
+    /**
+     * 隐藏UI
+     */
+    hide?(options?: BaseOptions): Promise<void>;
+    /**
+     * 启用插件，让插件能够响应交互
+     */
+    abstract enable(options?: BaseOptions): void;
+    /**
+     * 禁用插件，让插件停止响应交互
+     */
+    abstract disable(options?: BaseOptions): void;
+    /**
+     * 插件进行销毁
+     */
+    abstract dispose(): void;
+    /**
+     * 设置state
+     * @param state 插件的目标状态
+     * @param options 配置项
+     */
+    abstract setState(state: Partial<PluginState>, options?: BaseOptions): void;
+}
+export type { State, EventMap, BaseOptions };
+export { Controller };

package/dist/base/BasePluginWithData.d.ts

@@ -0,0 +1,34 @@
+import * as BasePlugin from './BasePlugin';
+declare type State = BasePlugin.State;
+interface EventMap<PluginState, PluginData> extends BasePlugin.EventMap<PluginState> {
+    /** 数据变更 */
+    dataChange: (data: PluginData, prevData?: PluginData) => void;
+    /** 数据加载完成 */
+    dataLoaded: (data: PluginData) => void;
+}
+/**
+ * 插件的基础数据
+ */
+interface ServerData {
+    /**
+     * 数据版本
+     */
+    version: number;
+    /**
+     * 数据
+     */
+    data?: unknown;
+}
+declare abstract class Controller<PluginState extends State, PluginEventMap extends EventMap<PluginState, PluginData>, PluginServerData extends ServerData, PluginData> extends BasePlugin.Controller<PluginState, PluginEventMap> {
+    protected abstract data?: PluginData;
+    /**
+     * 加载插件依赖数据
+     * @param serverData 插件数据
+     * @param state 插件 State
+     */
+    abstract load(serverData: PluginServerData, state?: PluginState, userAction?: boolean): Promise<void>;
+    /** 把原始数据转化为插件数据 */
+    protected abstract formatData?(serverData: PluginServerData): Promise<PluginData>;
+}
+export type { State, EventMap, ServerData };
+export { Controller };

package/dist/floorplan/ModelFloorplanPlugin/Controller.d.ts

@@ -1,66 +1,45 @@
-import type { FLOOR_PLAN_ATTACHED_TO } from '../constant';
-import type { FloorplanEventHandlers } from './typings/events.type';
+import type { BaseOptions } from '../../base/BasePlugin';
+import type { Five } from '@realsee/five';
+import type { ShowState } from '../utils/correctFiveState';
 import type { FloorplanServerData } from '../typings/floorplanServerData';
-import type { FloorplanRoomItem } from '../typings/floorplanData';
-import { Five, Subscribe } from '@realsee/five';
-export interface ModelFloorplanParameterType {
-    northDesc?: string;
-    selector?: string | Element;
-    scale?: number;
-    modelOpacity?: number;
-    autoShowEnable?: boolean;
-    hoverEnable?: boolean;
-    compassEnable?: boolean;
-    ruleLabelsEnable?: boolean;
-    roomLabelsEnable?: boolean;
-    cameraImageUrl?: string;
-    attachedTo?: FLOOR_PLAN_ATTACHED_TO;
-    getLabelElement?: (room: FloorplanRoomItem) => Element | null;
-}
-export declare type ModelFloorplanPluginsConfigs = Omit<ModelFloorplanParameterType, 'selector' | 'scale'>;
-export interface ModelFloorplanPluginsShowOpts {
-    floorIndex?: number;
-    isAutoShow?: boolean;
-    modelOpacity?: number;
-    immediately?: boolean;
-    userAction?: boolean;
-}
-export declare const MODEL_FLOORPLAN_PLUGIN_NAME = "modelFloorplanPlugin";
-export default class ModelFloorplanPluginController {
+import type { State, EventMap, ShowOptions, HideOptions, Parameters, PluginData, PluginServerData } from './typing';
+import * as BasePlugin from '../../base/BasePluginWithData';
+export declare class Controller extends BasePlugin.Controller<State, EventMap, PluginServerData, PluginData> {
     name: string;
-    /** 用于绑定事件钩子 */
-    hooks: Subscribe<FloorplanEventHandlers>;
-    /** 展示状态 */
-    visible: boolean;
-    /** 户型图大小 */
-    size: {
-        width: number;
-        height: number;
-    };
+    state: State;
+    protected data?: PluginData;
+    /** 展示户型图时，需要正确的状态 */
+    protected showState: ShowState;
+    /** show 动画的公共 Promise */
+    protected showPromise?: Promise<void>;
     private app?;
-    private pxmm;
-    private five;
     private panoIndex;
     private floorIndex;
-    private configs;
-    private lastPanoramaLongitude;
     private selector?;
-    private floorplanData?;
+    /** 公共 Promise 的 reject 方法 */
+    private showRejection?;
+    /** 户型图父容器 */
     private wrapper?;
+    /** 户型图主容器 */
     private container;
-    private showState;
-    /** 记录上次 show 的参数，如果不一致，需要 reject 掉正在进行的 showPromise */
-    private ModelFloorplanPluginsShowOpts?;
-    private showPromise?;
-    private showRejection?;
-    constructor(five: Five, params: ModelFloorplanParameterType);
-    dispose: () => void;
-    /** 加载户型图数据 */
-    load(data: FloorplanServerData): Promise<void>;
+    /** 展示户型图图前，Five 的 Panorama Longitude */
+    private lastPanoramaLongitude;
+    /** 户型图大小 */
+    private size;
+    /** 是否已经执行过事件监听 */
+    private hasAddedEventListener;
+    /** 上一次隐藏是否是用户调用了 hide 导致的 */
+    private isHiddenByHideFunc;
+    constructor(five: Five, params?: Parameters);
+    load(serverData: PluginServerData | FloorplanServerData, state?: Partial<State>, userAction?: boolean): Promise<void>;
     /** 把插件的渲染DOM插入到对应的容器中去 */
     appendTo(wrapper: Element): this;
-    /** 更新户型图大小 */
-    updateSize: () => void;
+    /** 启用插件 */
+    enable(options?: BaseOptions): void;
+    /** 禁用插件 */
+    disable(options?: BaseOptions): void;
+    /** 销毁插件 */
+    dispose: () => void;
     /** 展示户型图
      * 1. show 函数大部分情况下需要耗时
      * 2. 如果当前已经在展示中，将不会触发任何事件
@@ -71,35 +50,48 @@ export default class ModelFloorplanPluginController {
      * @param opts.modelOpacity 模型透明度
      * @param opts.immediately 是否立即展示
      * @param opts.isAutoShow 是否是自动展示
+     * @param opts.userAction 是否是用户行为
      */
-    show: (opts?: ModelFloorplanPluginsShowOpts) => Promise<boolean>;
+    show: (options?: Omit<Partial<ShowOptions>, 'isAutoShow'>) => Promise<void>;
     /** 隐藏户型图 */
-    hide: (options?: {
-        isAutoHide?: boolean;
-        userAction?: boolean;
-    }) => boolean;
-    /** 更改户型图楼层 */
-    changeFloor(floorIndex: number): void;
-    changeConfigs(params: ModelFloorplanPluginsConfigs): void;
-    /** 模型楼层高亮改变时，自动进行楼层切换 */
-    private onModelShownFloorChange;
-    private handleModelLoaded;
+    hide: (options?: Partial<HideOptions>) => Promise<void>;
+    /** 更改插件 State */
+    setState(state: Partial<State>, options?: BaseOptions): void;
+    /** 更新户型图大小 */
+    updateSize: () => void;
+    protected formatData(serverData: PluginServerData): Promise<PluginData>;
+    private _disable;
+    private _enable;
+    private _show;
+    private _hide;
+    private updateState;
+    /** 如果用户是通过 selector 设置父容器，需要在 modelLoaded 之后把 container 自动放到父容器里
+     *
+     * - TODO: 等 selector 功能下掉之后删除这个逻辑
+     */
+    private initContainer;
     private handleClick;
-    private handleWantsTapGesture;
-    /** 从 Panorama 切换到其他模态时，记录当前的相机水平视角 */
-    private handleWantsChangeMode;
-    /** 监听模型态变化，只有在模型态才进行手势动作监听 */
-    private handleModeChange;
+    private addEventListener;
+    private removeEventListener;
+    /** modelLoaded 之后自动执行 append container 操作  */
+    private onFiveModelLoaded;
+    /** 更改模型时，自动隐藏户型图 */
+    private onFiveModeChange;
+    /** 惯性结束后，判断能否自动展示户型图 */
+    private onFiveInteriaPan;
     /** panoIndex 改变时，更新 floorIndex */
-    private handlePanoArrived;
-    /** 当户型图正在展示中的时候禁用惯性 */
-    private handleWantsInteriaPan;
+    private onFivePanoArrived;
+    /** cameraUpdate 时判断户型图是否应该自动隐藏 */
+    private onFiveCameraUpdate;
     /** 在户型图展示时阻止多指操作, 阻止鼠标放大 */
-    private handleWantsGesture;
-    /** 监听三维模型滑动
-     * 1. 在三维模型转动结束时，如果达到设置的阈值，会自动切换到户型图
-     * 2. 如何户型图已经展示，滑动时关闭户型图
-     */
-    private handlePanGesture;
+    private onFiveWantsGesture;
+    /** 户型图展示中，转动三维模型，结束时应该自动修复模型状态 */
+    private onFiveWantsPanGesture;
+    /** 阻止点击分间走点 */
+    private onFiveWantsTapGesture;
+    /** 从 Panorama 切换到其他模态时，记录当前的相机水平视角 */
+    private onFiveWantsChangeMode;
+    /** 模型楼层高亮改变时，自动进行楼层切换 */
+    private onModelShownFloorChange;
     private render;
 }

package/dist/floorplan/ModelFloorplanPlugin/index.d.ts

@@ -1,9 +1,7 @@
+import type { Parameters } from './typing';
 import type { FivePlugin } from '@realsee/five';
-import FloorplanPluginController, { ModelFloorplanParameterType } from './Controller';
-export declare const ModelFloorplanPlugin: FivePlugin<ModelFloorplanParameterType, ModelFloorplanPluginReturnType>;
+import { Controller } from './Controller';
+export declare const ModelFloorplanPlugin: FivePlugin<undefined | Parameters, Controller>;
+export declare type ModelFloorplanPluginParameterType = Parameters | undefined;
+export declare type ModelFloorplanPluginReturnType = InstanceType<typeof Controller>;
 export default ModelFloorplanPlugin;
-export declare type ModelFloorplanPluginReturnType = FloorplanPluginController;
-export type { ModelFloorplanViewEvent } from './typings/events.type';
-export type { FloorplanErrorType as ModelFloorplanErrorType } from './utils/constant';
-export type { ModelFloorplanPluginsConfigs, ModelFloorplanParameterType } from './Controller';
-export type { FloorplanEventHandlers as ModelFloorplanEventHandlers } from './typings/events.type';