@realsee/dnalogel 2.1.0-alpha.2 → 2.1.0-alpha.3

package/dist/PanoTagPlugin/floorplan/MapviewFloorplanPlugin/Controller.d.ts

@@ -0,0 +1,95 @@
+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 { 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;
+    state: State;
+    protected data?: PluginData;
+    /** 展示户型图时，需要正确的状态 */
+    protected showState: ShowState;
+    /** show 动画的公共 Promise */
+    protected showPromise?: Promise<void>;
+    private app?;
+    private panoIndex;
+    private floorIndex;
+    private selector?;
+    /** 公共 Promise 的 reject 方法 */
+    private showRejection?;
+    /** 户型图父容器 */
+    private wrapper?;
+    /** 户型图主容器 */
+    private container;
+    /** 展示户型图图前，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;
+    /** 启用插件 */
+    enable(options?: BaseOptions): void;
+    /** 禁用插件 */
+    disable(options?: BaseOptions): void;
+    /** 销毁插件 */
+    dispose: () => void;
+    /** 展示户型图
+     * 1. show 函数大部分情况下需要耗时
+     * 2. 如果当前已经在展示中，将不会触发任何事件
+     * 3. 如果展示过程被中断，将抛出错误
+     * 4. 多次调用 show 方法，只会触发一次 showAnimationEnded 事件，但是展示结果会取决于最后一次调用参数
+     * 5. 如果多次调用 show 方法，参数与上次参数不一致时，上次 show Promise 会被 reject
+     * @param opts.floorIndex 楼层
+     * @param opts.modelOpacity 模型透明度
+     * @param opts.immediately 是否立即展示
+     * @param opts.isAutoShow 是否是自动展示
+     * @param opts.userAction 是否是用户行为
+     */
+    show: (options?: Omit<Partial<ShowOptions>, 'isAutoShow'>) => Promise<void>;
+    /** 隐藏户型图 */
+    hide: (options?: Partial<HideOptions>) => Promise<void>;
+    /** 更改插件 State */
+    setState(state: Partial<State>, options?: BaseOptions): void;
+    /** 更新户型图大小 */
+    updateSize: () => void;
+    /** 更新户型图位置 */
+    updatePosition(): 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 addEventListener;
+    private removeEventListener;
+    /** modelLoaded 之后自动执行 append container 操作  */
+    private onFiveModelLoaded;
+    /** 更改模型时，自动隐藏户型图 */
+    private onFiveModeChange;
+    /** panoIndex 改变时，更新 floorIndex */
+    private onFivePanoArrived;
+    /** cameraUpdate 时判断户型图是否应该自动隐藏 */
+    private onFiveCameraUpdate;
+    /** 户型图展示中，转动三维模型，结束时应该自动修复模型状态 */
+    private onFiveWantsPanGesture;
+    /** 阻止点击分间走点 */
+    private onFiveWantsTapGesture;
+    /** 从 Panorama 切换到其他模态时，记录当前的相机水平视角 */
+    private onFiveWantsChangeMode;
+    /** 模型楼层高亮改变时，自动进行楼层切换 */
+    private onModelShownFloorChange;
+    private render;
+}

package/dist/PanoTagPlugin/floorplan/MapviewFloorplanPlugin/index.d.ts

@@ -0,0 +1,7 @@
+import type { Parameters } from './typing';
+import type { FivePlugin } from '@realsee/five';
+import { Controller } from './Controller';
+export declare const MapviewFloorplanPlugin: FivePlugin<undefined | Parameters, Controller>;
+export declare type MapviewFloorplanPluginParameterType = Parameters | undefined;
+export declare type MapviewFloorplanPluginReturnType = InstanceType<typeof Controller>;
+export default MapviewFloorplanPlugin;

package/dist/PanoTagPlugin/floorplan/MapviewFloorplanPlugin/typing.d.ts

@@ -0,0 +1,107 @@
+import type { FLOOR_PLAN_ATTACHED_TO } from '../constant';
+import type * as BasePlugin from '../../base/BasePluginWithData';
+import type { FloorplanServerData } from '../typings/floorplanServerData';
+import type { FloorplanData, FloorplanRoomItem } from '../typings/floorplanData';
+export interface State extends BasePlugin.State {
+    visible: boolean;
+    config: Config;
+}
+export interface Config {
+    /** 指北针的显示文案，默认为 '北' */
+    northDesc: string;
+    /** 户型图展示时，模型的透明度，默认为 1 */
+    modelOpacity: number;
+    /** 鼠标放置在分间上时，是否要自动高亮分间，默认为 true */
+    hoverEnable: boolean;
+    /** 是否要启用指北针功能，默认为 true */
+    compassEnable: boolean;
+    /** Five 切换到 Topview Mode 时，是否自动展示户型图，默认为 true */
+    autoShowEnable: boolean;
+    /** 是否要启用户型图分间标尺功能，默认为 true */
+    ruleLabelsEnable: boolean;
+    /** 是否要启用户型图分间标签功能，默认为 true */
+    roomLabelsEnable: boolean;
+    /** 自定义「雷达」图标 */
+    cameraImageUrl: string;
+    /** 计算户型图大小时，以模型的哪个高度为依据，默认为 BOUNDING_CENTER
+     * - FLOOR_PLAN_ATTACHED_TO.FLOOR: 户型图大小与模型的地板进行贴合
+     * - FLOOR_PLAN_ATTACHED_TO.CEILING: 户型图大小与模型的天花板进行贴合
+     * - FLOOR_PLAN_ATTACHED_TO.BOUNDING_CENTER: 户型图大小与模型的中心进行贴合
+     */
+    attachedTo: FLOOR_PLAN_ATTACHED_TO;
+    /** 分间标签的自定义函数，通过返回自定义 DOM 替换对应分间的标签 */
+    getLabelElement: undefined | ((room: FloorplanRoomItem) => Element | null);
+    /** 是否支持房屋标签自适应展示，默认为 true
+     * @description
+     * * 标签边框超过房间边框时，自动隐藏；不超过时自动展示。
+     * * 鼠标 hover 时，自动展示。
+     * */
+    adaptiveRoomLabelVisibleEnable: boolean;
+}
+export interface Parameters extends Partial<Config> {
+    selector?: string | Element;
+    scale?: number;
+}
+export interface ViewEvent {
+    /** 是否是用户滑动模型导致的户型图自动展示/消失 */
+    auto: boolean;
+    /** 是否是用户操作 */
+    userAction: boolean;
+}
+export interface EventMap extends BasePlugin.EventMap<State, FloorplanData> {
+    /**
+     * 展示结束的回调
+     * @param event.auto 是否是自动操作
+     * @param event.userAction 是否是用户操作
+     */
+    showAnimationEnded: (event: ViewEvent) => void;
+    /** visible 从 false 到 true 的回调
+     * @param event.userAction 是否是用户操作
+     */
+    show: (event: ViewEvent) => void;
+    /** visible 从 true 到 false 的回调
+     * @param event.auto 是否是自动操作
+     * @param event.userAction 是否是用户操作
+     */
+    hide: (event: ViewEvent) => void;
+    /** enabled 从 false 到 true 的回调
+     * @param event.userAction 是否是用户操作
+     */
+    enable: (event: {
+        userAction: boolean;
+    }) => void;
+    /** enabled 从 true 到 false 的回调
+     * @param event.userAction 是否是用户操作
+     */
+    disable: (event: {
+        userAction: boolean;
+    }) => void;
+    /**
+     * 点击户型图的回调
+     * @return 当返回 false 时，会阻止默认行为
+     */
+    click: () => boolean | void;
+}
+export interface PluginServerData extends BasePlugin.ServerData {
+    version: number;
+    data: FloorplanServerData;
+}
+export interface ShowOptions {
+    /** 展示户型图时，希望到达的楼层数 */
+    floorIndex: number;
+    /** 是否自动展示 */
+    isAutoShow: boolean;
+    /** 展示户型图时，模型透明度 */
+    modelOpacity: number;
+    /** 是否需要 opacity 动画 */
+    immediately: boolean;
+    /** 是否是用户操作 */
+    userAction: boolean;
+}
+export interface HideOptions {
+    /** 是否自动隐藏 */
+    isAutoHide: boolean;
+    /** 是否是用户操作 */
+    userAction: boolean;
+}
+export { FloorplanData as PluginData };

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

@@ -1,6 +1,7 @@
 export * from './constant';
+export * from './ModelFloorplanPlugin';
+export * from './MapviewFloorplanPlugin';
 export * from './TopviewFloorplanPlugin';
 export * from './PanoFloorplanRadarPlugin';
-export * from './ModelFloorplanPlugin';
 export * from './typings/floorplanServerData';
 export * from './typings/floorplanData';

package/dist/PanoTagPlugin/index.d.ts

@@ -1,6 +1,5 @@
 import type { FivePlugin } from '@realsee/five';
 import PanoTagPluginController from './controller';
-export * from './typings';
 export * from './controller';
 export declare type PanoTagPluginExportInterface = InstanceType<typeof PanoTagPluginController>;
 export declare type PanoTagPluginParamsInterface = ConstructorParameters<typeof PanoTagPluginController>[1];