@realsee/dnalogel 2.1.2-alpha.9 → 2.2.0

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

@@ -0,0 +1,99 @@
+import type { PartialDeep } from 'type-fest';
+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, Config, 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: PartialDeep<State>, options?: BaseOptions): void;
+    changeConfigs(config: Partial<Config>, userAction?: boolean): 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 addEventListener;
+    private removeEventListener;
+    /** modelLoaded 之后自动执行 append container 操作  */
+    private onFiveModelLoaded;
+    /** 更改模型时，自动隐藏户型图 */
+    private onFiveModeChange;
+    /** 惯性结束后，判断能否自动展示户型图 */
+    private onFiveInteriaPan;
+    /** panoIndex 改变时，更新 floorIndex */
+    private onFivePanoArrived;
+    /** cameraUpdate 时判断户型图是否应该自动隐藏 */
+    private onFiveCameraUpdate;
+    /** 在户型图展示时阻止多指操作, 阻止鼠标放大 */
+    private onFiveWantsGesture;
+    /** 户型图展示中，转动三维模型，结束时应该自动修复模型状态 */
+    private onFiveWantsPanGesture;
+    /** 阻止点击分间走点 */
+    private onFiveWantsTapGesture;
+    /** 从 Panorama 切换到其他模态时，记录当前的相机水平视角 */
+    private onFiveWantsChangeMode;
+    /** 模型楼层高亮改变时，自动进行楼层切换 */
+    private onModelShownFloorChange;
+    private render;
+}

package/dist/floorplan/ModelFloorplanPlugin/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 ModelFloorplanPlugin: FivePlugin<undefined | Parameters, Controller>;
+export declare type ModelFloorplanPluginParameterType = Parameters | undefined;
+export declare type ModelFloorplanPluginReturnType = InstanceType<typeof Controller>;
+export default ModelFloorplanPlugin;

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

@@ -0,0 +1 @@
+export * from '../typings';

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

@@ -0,0 +1,36 @@
+import type { Five } from '@realsee/five';
+import type { BaseOptions } from '../../base/BasePlugin';
+import type { FloorplanServerData } from '../typings/floorplanServerData';
+import type { FloorplanExtraObject3D } from '../typings/floorplanData';
+import type { State, Config, EventMap, 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;
+    private app?;
+    private wrapperSelector;
+    private wrapper;
+    private disposed;
+    private extraObjects;
+    constructor(five: Five, params?: Parameters);
+    dispose: () => void;
+    load(serverData: PluginServerData | FloorplanServerData, state?: Partial<State>, userAction?: boolean): Promise<void>;
+    show(options?: BaseOptions): Promise<void>;
+    hide(options?: BaseOptions): Promise<void>;
+    enable(options?: BaseOptions): void;
+    disable(options?: BaseOptions): void;
+    /** 更改插件 State */
+    setState(state: Partial<State>, options?: BaseOptions): void;
+    /** 把插件的渲染DOM插入到对应的容器中去 */
+    appendTo(wrapper: Element): void;
+    changeConfigs(config: Config, userAction?: boolean): void;
+    setExtraObjectsWith3DPositions(data: FloorplanExtraObject3D[]): void;
+    protected formatData(serverData: PluginServerData): Promise<PluginData>;
+    private _enable;
+    private _disable;
+    private _show;
+    private _hide;
+    private updateState;
+    private render;
+}

package/dist/floorplan/PanoFloorplanRadarPlugin/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 PanoFloorplanRadarPlugin: FivePlugin<Parameters | undefined, Controller>;
+export declare type PanoFloorplanRadarPluginParameterType = Parameters | undefined;
+export declare type PanoFloorplanRadarPluginReturnType = InstanceType<typeof Controller>;
+export default PanoFloorplanRadarPlugin;

package/dist/floorplan/PanoFloorplanRadarPlugin/typing.d.ts

@@ -0,0 +1,52 @@
+import type * as BasePlugin from '../../base/BasePluginWithData';
+import type { FloorplanData } from '../typings/floorplanData';
+import type { FloorplanServerData } from '../typings/floorplanServerData';
+export interface Config {
+    /** 鼠标放置在分间上时，是否要自动高亮分间 */
+    hoverEnable: boolean;
+    /** 自定义「雷达」图标 */
+    cameraImageUrl: string;
+}
+export interface State extends BasePlugin.State {
+    visible: boolean;
+    config: Config;
+}
+export interface EventMap extends BasePlugin.EventMap<State, FloorplanData> {
+    /** visible 从 false 到 true 的回调
+     * @param event.userAction 是否是用户操作
+     */
+    show: (event: {
+        userAction: boolean;
+    }) => void;
+    /** visible 从 true 到 false 的回调
+     * @param event.userAction 是否是用户操作
+     */
+    hide: (event: {
+        userAction: boolean;
+    }) => void;
+    /** enabled 从 false 到 true 的回调
+     * @param event.userAction 是否是用户操作
+     */
+    enable: (event: {
+        userAction: boolean;
+    }) => void;
+    /** enabled 从 true 到 false 的回调
+     * @param event.userAction 是否是用户操作
+     */
+    disable: (event: {
+        userAction: boolean;
+    }) => void;
+}
+/** 插件初始化参数 */
+export interface Parameters extends Partial<Config> {
+    wrapper?: string | Element;
+    configs?: {
+        hoverEnable?: boolean;
+        cameraImageUrl?: string;
+    };
+}
+export interface PluginServerData extends BasePlugin.ServerData {
+    version: number;
+    data: FloorplanServerData;
+}
+export { FloorplanData as PluginData };

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

@@ -0,0 +1,69 @@
+import type { PartialDeep } from 'type-fest';
+import type { BaseOptions } from '../../base/BasePlugin';
+import type { Five } from '@realsee/five';
+import type { FloorplanServerData } from '../typings/floorplanServerData';
+import type { State, Config, EventMap, 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;
+    private app?;
+    private selector?;
+    private panoIndex;
+    private floorIndex;
+    /** 户型图父容器 */
+    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>;
+    /** 更新户型图大小 */
+    updateSize: () => void;
+    /** 更新户型图位置 */
+    updatePosition(): void;
+    /** 把插件的渲染DOM插入到对应的容器中去 */
+    appendTo(wrapper: Element): this;
+    show(options?: BaseOptions): Promise<void>;
+    hide(options?: BaseOptions): Promise<void>;
+    enable(options?: BaseOptions): void;
+    disable(options?: BaseOptions): void;
+    /** 销毁插件 */
+    dispose: () => void;
+    /** 更改插件 State */
+    setState(state: PartialDeep<State>, options?: BaseOptions): void;
+    changeConfigs(config: Partial<Config>, userAction?: boolean): void;
+    protected formatData(serverData: PluginServerData): Promise<PluginData>;
+    private _show;
+    private _hide;
+    private _enable;
+    private _disable;
+    private updateState;
+    private addEventListener;
+    private removeEventListener;
+    /** modelLoaded 之后自动执行 append container 操作  */
+    private onFiveModelLoaded;
+    /** 非 Topview 态隐藏户型图 */
+    private onFiveModeChange;
+    private onFivePanoArrived;
+    private onFiveCameraUpdate;
+    private onFiveWantsGesture;
+    private onFiveWantsMoveToPano;
+    /** 动画结束后是 Topview 态就展示户型图 */
+    private onFiveInitAnimationEnded;
+    private onModelShownFloorChange;
+    /** 如果用户是通过 selector 设置父容器，需要在 modelLoaded 之后把 container 自动放到父容器里
+     *
+     * - TODO: 等 selector 功能下掉之后删除这个逻辑
+     */
+    private initContainer;
+    private render;
+}

package/dist/floorplan/TopviewFloorplanPlugin/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 TopviewFloorplanPlugin: FivePlugin<undefined | Parameters, Controller>;
+export declare type TopviewFloorplanPluginParameterType = Parameters | undefined;
+export declare type TopviewFloorplanPluginReturnType = InstanceType<typeof Controller>;
+export default TopviewFloorplanPlugin;

package/dist/floorplan/TopviewFloorplanPlugin/typing.d.ts

@@ -0,0 +1,11 @@
+import type * as FloorplanPlugin from '../typings';
+export * from '../typings';
+export interface Config extends FloorplanPlugin.Config {
+    /** 是否开启放大缩小和拖动功能，默认为 false */
+    gestureEnable: boolean;
+    /** 点击房间时，是否阻止跳转到被点房间的全景态点位上，默认为 false */
+    preventRoomClick?: boolean;
+}
+export interface State extends FloorplanPlugin.State {
+    config: Config;
+}

package/dist/floorplan/constant.d.ts

@@ -0,0 +1,5 @@
+export declare enum FLOOR_PLAN_ATTACHED_TO {
+    FLOOR = 1,
+    CEILING = 2,
+    BOUNDING_CENTER = 3
+}

package/dist/floorplan/index.d.ts

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

package/dist/floorplan/typings/floorplanData.d.ts

@@ -0,0 +1,137 @@
+/**
+ * @file 对输入到户型图相关插件内的数据做 format 之后的数据
+ * 1. 数据的下划线到驼峰的转换
+ * 2. svg url 到 svg content 的处理
+ */
+import type { RecordKeys, RecordValue } from './utility';
+/** 户型图坐标，坐标原点时户型图中心点，单位是户型图单位 */
+export interface FloorplanPosition {
+    x: number;
+    y: number;
+}
+/** 户型图图片坐标，坐标原点是图片左上角，取值范围是 [0, 1]，表示距离左上角的相对距离 */
+export interface FloorplanImagePosition {
+    x: number;
+    y: number;
+}
+/** 户型图线框图 */
+export interface FloorplanOutlineItem {
+    url: string;
+    index: number;
+    svgUrl?: string;
+    svgContent?: string;
+}
+/** 户型图入户门 */
+export interface FloorplanEntrance {
+    /** 入户门角度 */
+    rad: number;
+    /** 入户门所在的位置「户型图坐标系」 */
+    position: FloorplanPosition;
+    /** 入户门在户型图上相对坐标 */
+    positionInImage: FloorplanImagePosition;
+    /** 入户门与北的朝向 */
+    northRad: number;
+    /** 入户门所在房间 ID */
+    roomId: string;
+    /** 入户门所楼层 */
+    floorIndex: number;
+}
+/** 户型图 FloorplanBounding
+ * @description 坐标都是户型图坐标
+ */
+export interface FloorplanBounding {
+    /** 户型图在 X 和 Y 轴上的最大值 */
+    max: FloorplanPosition;
+    /** 户型图在 X 和 Y 轴上的最小值 */
+    min: FloorplanPosition;
+    /** 户型图的中心位置 */
+    origin: FloorplanPosition;
+}
+/** 户型图房屋标签 */
+export interface FloorplanRoomLabelItem {
+    /** 房间的中心点坐标 */
+    position: FloorplanPosition;
+    /** 房间的中心在户型图上的相对位置 */
+    positionInImage: FloorplanImagePosition;
+}
+/** 户型图房间数据 */
+export interface FloorplanRoomItem {
+    id: string;
+    /** 房间面积
+     * @description 单位是平方毫米
+     */
+    size: number;
+    name: string;
+    /** 围成房间区域的坐标路径
+     * @description 坐标类型是户型图坐标
+     */
+    path: FloorplanPosition[];
+    /** 房屋类型
+     * @description 对应关系参考上方 ROOM_TYPE_MAP
+     */
+    roomType: string;
+    /** 地板类型
+     * @description 对应关系参考上方 FLOOR_TYPE_MAP
+     */
+    floorType: number;
+    roomLabel: FloorplanRoomLabelItem;
+    /** 当前房间里的 observer 索引 */
+    observerIndexs: number[];
+}
+/** 户型图标尺 */
+export declare type FloorplanRuleLabels = Record<'top' | 'right' | 'bottom' | 'left', FloorplanPosition[][]>;
+export declare type RuleLabelsKey = RecordKeys<FloorplanRuleLabels>;
+export declare type RuleLabelsValue = RecordValue<FloorplanRuleLabels>;
+/** 当前楼层的数据 */
+export interface FloorplanFloorData {
+    floorName: string;
+    floorIndex: number;
+    rooms: FloorplanRoomItem[];
+    rules: FloorplanRuleLabels;
+}
+/** 对 observer 做一些样式上的计算
+ * @description 每一个 floorplanObserver 对应一个 observer
+ * @description floorplanObserver 和 observer 在自身数组中的索引坐标应该是相同的
+ */
+export interface FloorplanObserver {
+    index: number;
+    floorIndex: number;
+    position: FloorplanPosition;
+    positionInImage: FloorplanImagePosition;
+}
+/** 户型图内部使用的数据 */
+export interface FloorplanData {
+    outlines: FloorplanOutlineItem[];
+    floorDatas: FloorplanFloorData[];
+    entrance: FloorplanEntrance | null;
+    bounding: FloorplanBounding;
+    observers: FloorplanObserver[];
+}
+/** 能够映射到雷达图上的三维物体 */
+export interface FloorplanExtraObject3D {
+    id: string;
+    position: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    icon?: {
+        url: string;
+        width: number;
+        height: number;
+    };
+}
+/** 添加到户型图上的额外物体 */
+export interface FloorplanExtraObject {
+    id: string;
+    icon: {
+        url: string;
+        width: number;
+        height: number;
+    };
+    floorIndex: number;
+    /** 入户门所在的位置「户型图坐标系」 */
+    position: FloorplanPosition;
+    /** 入户门在户型图上相对坐标 */
+    positionInImage: FloorplanImagePosition;
+}

package/dist/floorplan/typings/floorplanServerData.d.ts

@@ -0,0 +1,144 @@
+/** 房屋数据映射表 */
+export declare const ROOM_FETILE_TYPE_MAP: ({
+    type: number;
+    floorType: number;
+    roomType: string;
+    name: string;
+    onlySubArea?: undefined;
+} | {
+    type: number;
+    floorType: number;
+    roomType: string;
+    name: string;
+    onlySubArea: boolean;
+})[];
+/** 地板信息映射表 */
+export declare const FLOOR_TYPE_MAP: {
+    type: number;
+    description: string;
+}[];
+/** 房屋类型映射表 */
+export declare const ROOM_TYPE_MAP: {
+    roomType: string;
+    description: string;
+}[];
+/** 户型图坐标，坐标原点时户型图中心点，单位是户型图单位 */
+export interface FloorplanServerPosition {
+    x: number;
+    y: number;
+}
+/** 户型图图片坐标，坐标原点是图片左上角，取值范围是 [0, 1]，表示距离左上角的相对距离 */
+export interface FloorplanServerImagePosition {
+    x: number;
+    y: number;
+}
+/** 户型图线框图 */
+export interface FloorplanServerOutlineItem {
+    url: string;
+    index: number;
+    checksum?: string;
+    svg_url?: string;
+}
+/** 户型图入户门 */
+export interface FloorplanServerEntrance {
+    /** 入户门角度 */
+    rad: number;
+    /** 入户门所在的位置「户型图坐标系」 */
+    position: FloorplanServerPosition;
+    /** 入户门在户型图上相对坐标 */
+    position_in_image: FloorplanServerImagePosition;
+    /** 入户门与北的朝向 */
+    north_rad: number;
+    /** 入户门所在房间 ID */
+    room_id: string;
+    /** 入户门所楼层 */
+    floor_index: number;
+}
+/** 户型图 FloorplanServerBounding
+ * @description 坐标都是户型图坐标
+ */
+export interface FloorplanServerBounding {
+    /** 户型图在 X 和 Y 轴上的最大值 */
+    max: FloorplanServerPosition;
+    /** 户型图在 X 和 Y 轴上的最小值 */
+    min: FloorplanServerPosition;
+    /** 户型图的中心位置 */
+    origin: FloorplanServerPosition;
+}
+/** 户型图房屋标签 */
+export interface FloorplanServerRoomLabelItem {
+    /** 房间的中心点坐标 */
+    position: FloorplanServerPosition;
+    /** 房间的中心在户型图上的相对位置 */
+    position_in_image: FloorplanServerImagePosition;
+}
+/** 户型图房间数据 */
+export interface FloorplanServerRoomItem {
+    id: string;
+    /** 房间面积
+     * @description 单位是平方毫米
+     */
+    size: number;
+    /** 房屋类型
+     * @description 对应关系参考上方 ROOM_DETAILS_TYPE_MAP
+     */
+    type: number;
+    name: string;
+    /** 围成房间区域的坐标路径
+     * @description 坐标类型是户型图坐标
+     */
+    path: FloorplanServerPosition[];
+    /** 房屋类型
+     * @description 对应关系参考上方 ROOM_TYPE_MAP
+     */
+    room_type: string;
+    /** 地板类型
+     * @description 对应关系参考上方 FLOOR_TYPE_MAP
+     */
+    floor_type: number;
+    room_label: FloorplanServerRoomLabelItem;
+    /** 当前房间里的 observer 索引 */
+    observer_indexs: number[];
+}
+export declare type FloorplanServerRuleLabels = Record<'top' | 'right' | 'bottom' | 'left', FloorplanServerPosition[][]>;
+/** 当前楼层的数据 */
+export interface FloorplanServerFloorData {
+    floor_name: string;
+    floor_index: number;
+    rooms: FloorplanServerRoomItem[];
+    rules: FloorplanServerRuleLabels;
+}
+/** 对 observer 做一些样式上的计算
+ * @description 每一个 FloorplanServer_observer 对应一个 observer
+ * @description FloorplanServer_observer 和 observer 在自身数组中的索引坐标应该是相同的
+ */
+export interface FloorplanServerObserver {
+    index: number;
+    floor_index: number;
+    position: FloorplanServerPosition;
+    position_in_image: FloorplanServerImagePosition;
+}
+export interface FloorplanServerDoorPosition {
+    x: number;
+    y: number;
+    z: number;
+}
+export interface FloorplanServerDoorItem {
+    id: string;
+    localName: string;
+    name: string;
+    position: FloorplanServerDoorPosition;
+    rad: number;
+}
+export interface FloorplanServerComputedData {
+    floor_datas: FloorplanServerFloorData[];
+    entrance: FloorplanServerEntrance | null;
+    bounding: FloorplanServerBounding;
+    observers: FloorplanServerObserver[];
+    doors: FloorplanServerDoorItem[];
+}
+/** 原始输入的户型图数据 */
+export interface FloorplanServerData {
+    outlines: FloorplanServerOutlineItem[];
+    computed_data: FloorplanServerComputedData;
+}