@realsee/dnalogel 2.0.0-alpha.7 → 2.0.0-beta.36

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

@@ -0,0 +1 @@
+export declare const pluginStyle: Partial<CSSStyleDeclaration>;

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

@@ -0,0 +1,86 @@
+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 Config {
+    /** 指北针的显示文案，默认为 '北' */
+    northDesc: string;
+    /** 户型图展示时，模型的透明度，默认为 1 */
+    modelOpacity: number;
+    /** 鼠标放置在分间上时，是否要自动高亮分间，默认为 true */
+    hoverEnable: boolean;
+    /** 是否开启放大缩小和拖动功能，默认为 false */
+    gestureEnable: boolean;
+    /** 是否要启用指北针功能，默认为 true */
+    compassEnable: boolean;
+    /** Five 切换到 Topview Mode 时，是否自动展示户型图，默认为 true */
+    autoShowEnable: boolean;
+    /** 是否要启用户型图分间标尺功能，默认为 true */
+    ruleLabelsEnable: boolean;
+    /** 是否要启用户型图分间标签功能，默认为 true */
+    roomLabelsEnable: boolean;
+    /** 自定义「雷达」图标 */
+    cameraImageUrl: string;
+    /** 点击房间时，是否需要跳转到被点房间的全景态点位上，默认为 true */
+    preventRoomClick?: boolean;
+    /** 计算户型图大小时，以模型的哪个高度为依据，默认为 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 State extends BasePlugin.State {
+    visible: boolean;
+    config: Config;
+}
+export interface EventMap extends BasePlugin.EventMap<State, FloorplanData> {
+    /** 展示结束的回调
+     * @param event.userAction 是否是用户操作
+     */
+    showAnimationEnded: (event: {
+        userAction: boolean;
+    }) => void;
+    /** 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> {
+    selector?: string | Element;
+    scale?: number;
+}
+export interface PluginServerData extends BasePlugin.ServerData {
+    version: number;
+    data: FloorplanServerData;
+}
+export { FloorplanData as PluginData };

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,6 @@
+export * from './constant';
+export * from './TopviewFloorplanPlugin';
+export * from './PanoFloorplanRadarPlugin';
+export * from './ModelFloorplanPlugin';
+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,131 @@
+/** 房屋数据映射表 */
+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 FloorplanServerComputedData {
+    floor_datas: FloorplanServerFloorData[];
+    entrance: FloorplanServerEntrance | null;
+    bounding: FloorplanServerBounding;
+    observers: FloorplanServerObserver[];
+}
+/** 原始输入的户型图数据 */
+export interface FloorplanServerData {
+    outlines: FloorplanServerOutlineItem[];
+    computed_data: FloorplanServerComputedData;
+}

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

@@ -0,0 +1,2 @@
+export declare type RecordKeys<T> = T extends Record<infer P, any> ? P : any;
+export declare type RecordValue<T> = T extends Record<any, infer P> ? P : any;

package/dist/floorplan/utils/constant.d.ts

@@ -0,0 +1,22 @@
+export declare const enum FloorplanErrorType {
+    /** 意料之外的错误 */
+    UnknownError = "UnknownError",
+    /** 数据未加载 */
+    DataNotLoaded = "DataNotLoaded",
+    /** 展示过程被隐藏打断 */
+    BreakOffByHide = "BreakOffByHide",
+    /** 展示过程中插件被禁用 */
+    BreakOffByDisable = "BreakOffByDisable",
+    /** 模型未加载完成 */
+    ModelNotLoaded = "ModelNotLoaded",
+    /** Five changeMode 行为不符合预期 */
+    ChangeModeError = "ChangeModeError",
+    /** Five updateCamera 行为不符合预期 */
+    UpdateCameraError = "UpdateCameraError"
+}
+/** 户型图展示 & 模型消失的默认时间 */
+export declare const SHOW_ANIME_DURATION = 500;
+/** Five camera 默认 fov */
+export declare const FIVE_CAMERA_DEFAULT_FOV = 80;
+/** 展示户型图时，默认模型的透明度 */
+export declare const DEFAULT_SHOW_MODEL_OPACITY = 0.01;

package/dist/floorplan/utils/correctFiveState.d.ts

@@ -0,0 +1,15 @@
+import type { Five, Mode } from '@realsee/five';
+export interface ShowState {
+    latitude: number;
+    longitude: number;
+    fov: number;
+    mode: Mode;
+}
+/** 判断当前状态是否可以展示户型图 */
+export declare function checkShowState(five: Five, showState: ShowState): boolean;
+/** 更改 Five 状态到展示户型图的状态
+ * 1. 判断状态不符合时，会纠正到正确的状态
+ * 2. 内置了相应的动画时间计算
+ * 3. 纠正成功会返回 true，失败「可能会被用户行为中断」会返回 false
+ */
+export default function correctFiveState(five: Five, showState: ShowState, userAction?: boolean): Promise<void>;

package/dist/floorplan/utils/formatData.d.ts

@@ -0,0 +1,5 @@
+import type { Five } from '@realsee/five';
+import type { FloorplanData, FloorplanExtraObject, FloorplanExtraObject3D } from '../typings/floorplanData';
+import type { FloorplanServerData } from '../typings/floorplanServerData';
+export default function formatData(data: FloorplanServerData): Promise<FloorplanData>;
+export declare function formatExtraObjects(data: FloorplanExtraObject3D[], five: Five, floorplanData: FloorplanData): FloorplanExtraObject[];

package/dist/floorplan/utils/formatPosition.d.ts

@@ -0,0 +1,36 @@
+import type { Five } from '@realsee/five';
+import type { Vector2Position } from '../../typings/math.type';
+import type { FloorplanData, FloorplanBounding } from '../typings/floorplanData';
+export declare function pathD(points: Vector2Position[], options?: {
+    needZ?: boolean;
+    needA?: Record<number, string>;
+    format?: (vector: Vector2Position) => Vector2Position;
+}): string;
+/** 把户型图上点点位转换到 SVG 上的点位 */
+export default function formatFloorplanPoint({ x, y }: Vector2Position, bounding: FloorplanBounding): {
+    x: number;
+    y: number;
+};
+/** 模型坐标转户型图坐标 */
+export declare function modelPosition2FloorplanPosition(position: {
+    x: number;
+    y: number;
+    z: number;
+}, floorplanData: FloorplanData): {
+    x: number;
+    y: number;
+};
+/** 户型图点位转在图片上的相对坐标 */
+export declare function floorplanPosition2ImagePosition(position: {
+    x: number;
+    y: number;
+}, floorplanData: FloorplanData): {
+    x: number;
+    y: number;
+};
+/** 求三维坐标点所在的楼层 */
+export declare function getFloorIndexFromModelPosition(position: {
+    x: number;
+    y: number;
+    z: number;
+}, five: Five): number;

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+export * from './ModelViewPlugin';
+export * from './CSS3DRenderPlugin';
+export * from './PanoCursorRaycasterPlugin';
+export * from './ModelRoomLabelPlugin';
+export * from './floorplan';
+export * from './ModelChassisCompassPlugin';
+export * from './ModelEntryDoorGuidePlugin';
+export * from './CameraMovementPlugin';
+export * from './PanoRulerPlugin';
+export * from './PanoCompassPlugin';
+export * from './PanoMeasurePlugin';
+export * from './PanoSpatialTagPlugin';
+export * from './ModelItemLabelPlugin';
+export * from './ModelTVVideoPlugin';
+export * from './ItemLabelPlugin';