@realsee/dnalogel 2.1.2-alpha.10 → 2.1.2-alpha.12

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

@@ -0,0 +1,117 @@
+import type { FloorplanRoomItem } from './floorplanData';
+import type { FLOOR_PLAN_ATTACHED_TO } from '../constant';
+import type { FloorplanData } from '../typings/floorplanData';
+import type * as BasePlugin from '../../base/BasePluginWithData';
+import type { FloorplanServerData } from '../typings/floorplanServerData';
+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;
+    /** 是否支持房屋标签自适应展示，默认为 true
+     * @description
+     * * 标签边框超过房间边框时，自动隐藏；不超过时自动展示。
+     * * 鼠标 hover 时，自动展示。
+     * */
+    adaptiveRoomLabelVisibleEnable: 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);
+    /** 自定义分间面积文本
+     * @param area 分间原始面积，单位是 mm²
+     */
+    getRoomAreaText: (areaSize: number) => string;
+    /** 自定义标尺距离文本
+     * @param distance 原始标尺距离，单位是 mm
+     */
+    getRuleDistanceText: (distance: number) => string;
+}
+/** 插件初始化参数 */
+export interface Parameters extends Partial<Config> {
+    selector?: string | Element;
+    scale?: number;
+}
+export interface PluginServerData extends BasePlugin.ServerData {
+    version: number;
+    data: FloorplanServerData;
+}
+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 | undefined;
+}
+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/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,23 @@
+export * from './components';
+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 './PanoRulerProPlugin';
+export * from './PanoCompassPlugin';
+export * from './PanoMeasurePlugin';
+export * from './PanoSpatialTagPlugin';
+export * from './ModelItemLabelPlugin';
+export * from './ModelTVVideoPlugin';
+export * from './ItemLabelPlugin';
+export * from './PanoDoorLabelPlugin';
+export * from './GuideLinePlugin';
+export * from './CruisePlugin';
+export * from './PanoTagPlugin';
+export * from './Object3DHelperPlugin';
+export * as Util from './shared-utils';