@realsee/dnalogel 2.20.0-alpha.1 → 2.20.0-dev.2

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

@@ -1,8 +1,8 @@
 export * from './controller';
-export * from './tag/Tag.d';
-export * from './tag/Utils.d';
-export * from './tag/TagData.d';
-export * from './tag/TagConfig.d';
-export * from './tag/TagInstance.d';
+export * from './tag/Tag';
+export * from './tag/Utils';
+export * from './tag/TagData';
+export * from './tag/TagConfig';
+export * from './tag/TagInstance';
 export * from '../Archive/deprecated';
 export type { ContentTypeMap, TagContentType } from './tag/TagData';

package/dist/PanoTagPlugin/typings/tag/Tag.d.ts

@@ -0,0 +1,48 @@
+import type { State as FiveState } from '@realsee/five';
+import type { TagConfig } from './TagConfig';
+import type { ContentTypeMap, TagContentType } from './TagData';
+import type { Position, TagId, StickType, TagStyle, ElementRenderer, PickTagContentTypeInContentTypeConfigKey, ContentTypeConfigKey } from './Utils';
+import type { DeprecatedTagProperty } from '../../Archive/deprecated';
+export interface Tags {
+    version?: string;
+    /** tag配置 > 按type配置 > 全局配置 */
+    /** 全局配置 */
+    globalConfig?: TagConfig;
+    /** 按type配置 */
+    contentTypeConfig?: {
+        [key in ContentTypeConfigKey]?: PickTagContentTypeInContentTypeConfigKey<key> extends TagContentType ? TagConfig<PickTagContentTypeInContentTypeConfigKey<key>> : unknown;
+    };
+    /** 标签列表配置 */
+    tagList: Tag[];
+}
+export type Tag<C extends TagContentType = TagContentType, S extends StickType = StickType> = DeprecatedTagProperty & {
+    /** 开启/禁用 */
+    enabled?: boolean;
+    /** 唯一标识 */
+    id: TagId;
+    /** @type {StickType} 附着方式 */
+    stickType: S;
+    /** @type {TagContentType} 内容类型，根据内容类型展示对应UI */
+    contentType: C;
+    /** 点 */
+    position: S extends 'Plane' ? [Position, Position, Position, Position] : S extends '2DPoint' | '3DPoint' | 'Model' ? Position : Position | [Position, Position, Position, Position];
+    /** 法向量 */
+    normal?: Position;
+    /** 自定义标签内容 */
+    element?: string | Element | ElementRenderer;
+    /** 标签 wrapper 的 classname */
+    className?: string;
+    /** 标签数据 */
+    data: C extends TagContentType ? ContentTypeMap[C] : ContentTypeMap[keyof ContentTypeMap];
+    /** 「展开/收起」 「可见/不可见」 的策略配置 */
+    config?: TagConfig<C>;
+    /** 打标签时的 five state */
+    fiveState?: FiveState;
+    /** 样式 */
+    style?: TagStyle;
+} & (S extends '3DPoint' ? {
+    normal: Position;
+} : unknown) & // 三维标签需要法向量
+(S extends 'Model' ? {
+    matrix: number[];
+} : unknown);

package/dist/PanoTagPlugin/typings/tag/TagConfig.d.ts

@@ -0,0 +1,129 @@
+import type { Create3DDomContainerParamsType } from '../../../CSS3DRenderPlugin/Controller';
+import type { Five, Mode } from '@realsee/five';
+import type { ContentTypeMap, TagContentType } from './TagData';
+import type { MinMax } from './Utils';
+import type { PartialObjectDeep } from './Utils';
+import type { TagInstance } from './TagInstance';
+type ConfigFunction<C extends TagContentType = TagContentType> = (five: Five, tagState: {
+    tag: TagInstance<C>;
+    /** 标签点或中心点的到摄像机的距离 */
+    distance: number;
+    /** 3D标签中 「标签所在平面或垂直于标签法线的平面」 与 「摄像机到标签点或中心点的向量」 的夹角 */
+    angleRange?: number;
+}) => boolean;
+export interface TagConfig<C extends TagContentType = TagContentType> {
+    /** 显示/隐藏配置 */
+    visibleConfig?: {
+        /**
+         * @description 保持可见/不可见, 设置后visibleConfig下所有其他配置都不生效
+         * @default undefined
+         */
+        keep?: 'visible' | 'hidden';
+        /**
+         * @description 在哪些 five mode 下可见
+         * @default ['Panorama']
+         */
+        visibleFiveMode?: Mode[];
+        /**
+         * @description 当 visibleFiveMode 包含 'Floorplan' 或者 'MapView' 时，是否仅在当前楼层模型下可见
+         * @default false
+         */
+        followModelVisibility?: boolean;
+        /**
+         * @description 走点时不隐藏
+         * @default false
+         */
+        alwaysShowWhenMovePano?: true;
+        /**
+         * @description min-max米内显示 | 无距离限制
+         * @default 'unLimited'
+         */
+        visibleDistance?: MinMax | 'unLimited';
+        /**
+         * @description: 限制xx点位上可见，默认为all
+         * @param all: 不限制
+         * @param current: 仅当前点位可见
+         * @param: number[] 仅指定点位可见
+         * @default 'all'
+         */
+        visiblePanoIndex?: 'all' | 'current' | number[];
+        /**
+         * @description 碰撞检测配置，默认开启
+         * @default true
+         */
+        intersectRaycaster?: boolean | {
+            /**
+             * @description 是否开启碰撞检测
+             * @default true
+             */
+            enabled?: boolean;
+            /**
+             * @description 碰撞检测的允许误差
+             * @default 0.01
+             */
+            distanceAccuracy?: number;
+        };
+        /**
+         * @description 3D标签中 「标签所在平面或垂直于标签法线的平面」 与 「摄像机到标签点或中心点的向量」 的夹角，范围内自动展开，范围外自动收起
+         * @default undefined
+         */
+        angleRange?: MinMax;
+    } | ConfigFunction<C>;
+    /** 展开/收起配置 */
+    unfoldedConfig?: {
+        /** 保持展开/收起，设置后unfoldedConfig下所有其他配置都不生效 */
+        keep?: 'unfolded' | 'folded';
+        /**
+         * @description 划动到不可见状态时，自动收起，disableFold: true 的标签不受此参数影响
+         * @note 部分标签是无法收起的
+         * @default true
+         */
+        autoFoldWhenHide?: false;
+        /**
+         * @deprecated replace by { keep: 'folded' }
+         * @deprecated 部分标签是无法打开的
+         * @default undefined
+         */
+        disableUnfold?: true;
+        /**
+         * @deprecated replace by { keep: 'unfolded' }
+         * @deprecated 部分标签是无法收起的
+         * @default undefined
+         */
+        disableFold?: true;
+        /** min-max米内自动展开,否则收起 */
+        unfoldDistance?: MinMax;
+        /** 自动展开策略,  false 时不自动展开 */
+        autoUnfold?: false | {
+            enable?: boolean;
+            /** 自动展开 策略 */
+            strategy?: 'ScreenPostion';
+            /** 自动展开策略，{min,max}为project(camera)后的x值 */
+            autoUnfoldProjectX?: MinMax;
+        } | {
+            enable?: boolean;
+            /** 自动展开：最近标签自动展开 */
+            strategy?: 'MinimumDistance';
+            /** 展开的最大数量, 默认为1 */
+            maxNumber?: number;
+            /** 展开的最大距离, 默认为无限制 */
+            distance?: MinMax;
+        };
+    } | ConfigFunction<C>;
+    /** 初始状态 */
+    initialState?: {
+        /** 显示/隐藏 */
+        visible?: boolean;
+        /** 展开/收起 */
+        unfolded?: boolean;
+    };
+    initialData?: PartialObjectDeep<ContentTypeMap[C]>;
+    tag3DConfig?: Create3DDomContainerParamsType['config'];
+    modelConfig?: {
+        autoLookAtEnabled?: boolean;
+    };
+    /** 当图片为一张时可以通过Mesh渲染 */
+    renderType?: 'Mesh' | 'Dom';
+    clickable?: false;
+}
+export {};

package/dist/PanoTagPlugin/typings/tag/TagData.d.ts

@@ -0,0 +1,152 @@
+import type { DeprecatedMediaPlaneProperty, ContentType } from '../../Archive/deprecated';
+import type { Position, TagIconUrl } from './Utils';
+export type MediaData = {
+    type: 'Image';
+    url: string;
+} | {
+    type: 'Video';
+    url: string;
+    videoCoverUrl?: string;
+};
+export type ObjectFit = 'fill' | 'contain' | 'cover' | 'none' | 'scale-down';
+type Object = Record<string | number | symbol, any>;
+export type TagContentType = keyof typeof ContentType;
+/**
+ * @description: 标签数据
+ */
+interface ContentTypeMapInterface {
+    /** 文字标签 */
+    Text: {
+        appearance?: 'line' | 'plane';
+        /** @deprecated: 'text' replace by 'title' */
+        text?: string;
+        title?: string;
+        description?: string;
+        edit?: {
+            title?: {
+                inputting?: boolean;
+                placeholder?: string;
+            };
+            description?: {
+                inputting?: boolean;
+                placeholder?: string;
+            };
+        };
+    };
+    /** 音频标签 */
+    Audio: {
+        /** @deprecated: 'text' replace by title */
+        text?: string;
+        title?: string;
+        /** @description: 'line' 是旧的那种有一条线的，默认为'line', 'plane' 是新的那种圆形的 */
+        appearance?: 'line' | 'plane';
+        theme?: 'dark' | 'light';
+        audioUrl: string;
+    };
+    /** 图文标签 */
+    ImageText: {
+        /** @deprecated: 'text' replace by 'title' */
+        text?: string;
+        title?: string;
+        mediaData: (MediaData & {
+            name?: string;
+        })[];
+    };
+    /** 图片标签 */
+    Image: ContentTypeMapInterface['ImageText'];
+    /** 视频标签 */
+    Video: ContentTypeMapInterface['ImageText'];
+    /** 跳转外链标签 */
+    Link: {
+        /** @deprecated: 'text' replace by 'title' */
+        text?: string;
+        title?: string;
+        /** @deprecated: linkType 不再和样式绑定，使用 iconUrl 代替 */
+        linkType?: 'vr' | 'normal';
+        icon?: TagIconUrl;
+    };
+    /** VR跳转标签 */
+    VRLink: ContentTypeMapInterface['Link'];
+    /** 贴纸标签 */
+    Sticker: ContentTypeMapInterface['Link'];
+    /** 全景跳转标签 */
+    PanoLink: ContentTypeMapInterface['Link'];
+    /** 营销标签 */
+    Marketing: {
+        /** 标题 */
+        title: string;
+        /** 高亮的标签 */
+        brandTags?: string[];
+        /** 普通标签 */
+        tags?: string[];
+        /** 头部宣传图 */
+        headerPictureUrl?: string;
+        /** 跳转文字 */
+        highlightText?: string;
+        /** 主题 */
+        theme?: 'dark' | 'light';
+        /** 限制营销标签大小 */
+        limitWidth?: boolean | number;
+        /** 价格 */
+        price?: {
+            value: string | number;
+            /** 单位 */
+            unit: string;
+        };
+    };
+    /** 营销贴片 */
+    MediaPlane: {
+        enableCarousel?: boolean;
+        /** 多媒体在容器中的适配规则 {@link https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-fit} */
+        objectFit?: ObjectFit;
+        autoplayConfig?: {
+            /**
+             * @description 是否自动播放视频
+             * @default autoplayVideo: false
+             */
+            autoplayVideo?: boolean;
+            /**
+             * @description 是否自动轮播
+             * @default autoplayCarousel: true
+             */
+            autoplayCarousel?: boolean;
+            /**
+             * @description 轮播中遇到视频是否要自动播放
+             * @default autoplayVideoInCarousel: false
+             */
+            autoplayVideoInCarousel?: boolean;
+        };
+        mediaData: MediaData[];
+        /** @description 暂停时的播放按钮url */
+        playIcon?: 'withText' | 'withoutText' | string;
+    } & DeprecatedMediaPlaneProperty;
+    MediaModel: {
+        modelUrl: string;
+        mediaData: MediaData[];
+        mediaPosition: [Position, Position, Position, Position];
+        matrix?: number[];
+        /** 多媒体在容器中的适配规则 {@link https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-fit} */
+        objectFit?: ObjectFit;
+        action?: {
+            url: string;
+            type: 'iframe' | 'window';
+        };
+    };
+    Model: {
+        modelUrl: string;
+        matrix?: number[];
+        action?: {
+            url?: string;
+            type: 'iframe' | 'window' | 'custom';
+        };
+    };
+    Custom: Object;
+    Unknown: Object;
+}
+type ContentTypeMapInterfaceWithExtraData = {
+    [key in keyof ContentTypeMapInterface]: ContentTypeMapInterface[key] & {
+        extraData?: Object;
+    };
+};
+export type ContentTypeMap = Pick<ContentTypeMapInterfaceWithExtraData, TagContentType>;
+export {};

package/dist/PanoTagPlugin/typings/tag/TagInstance.d.ts

@@ -0,0 +1,51 @@
+import type { Tag } from './Tag';
+import type TagContentSvelte from '../../Components/Tag/index.svelte';
+import type { TagContentType } from './TagData';
+import type { StickType, TagGLTFObject } from './Utils';
+import type { Create3DDomContainerReturnType } from '../../../CSS3DRenderPlugin';
+import type { Vector3 } from 'three';
+import type { ImagePlane, VideoPlane } from '../../utils/model/mediaPlane';
+import type { TagEvents } from '../controller';
+import type { TagConfig } from './TagConfig';
+import type { Subscribe } from '@realsee/five';
+import type { SetRequired } from 'type-fest';
+type RequiredTag<C extends TagContentType = TagContentType, S extends StickType = StickType> = SetRequired<Tag<C, S>, 'id' | 'data' | 'enabled' | 'config' | 'stickType' | 'contentType'>;
+export type TagInstance<C extends TagContentType = TagContentType, S extends StickType = StickType> = RequiredTag<C, S> & Partial<{
+    screenPosition: {
+        leftPercent: number;
+        topPercent: number;
+    } | null;
+    temporaryState: {
+        visible: boolean;
+    };
+    tag3DContentSvelte: {
+        svelteApp: TagContentSvelte;
+        /** @deprecated rename to css3DInstance */
+        domContainer: NonNullable<Create3DDomContainerReturnType>;
+        css3DInstance: NonNullable<Create3DDomContainerReturnType>;
+        initialNormal: Vector3;
+        currentNormal: Vector3;
+        dispose: () => void;
+    };
+    initialConfig: TagConfig<C>;
+    mediaPlane: ImagePlane | VideoPlane;
+    model: {
+        promise: Promise<TagGLTFObject>;
+        object?: TagGLTFObject;
+    };
+    mediaVisible: boolean;
+    play: () => void;
+    pause: () => void;
+}> & {
+    state: {
+        visible?: boolean;
+        unfolded: boolean;
+    };
+    hooks: Subscribe<TagEvents>;
+    unfold: () => void;
+    fold: () => void;
+    enable: () => void;
+    disable: () => void;
+    destroy: () => void;
+};
+export {};

package/dist/PanoTagPlugin/typings/tag/Utils.d.ts

@@ -0,0 +1,77 @@
+import type { GLTFObject } from '@realsee/five/gltf-loader';
+import type { Group } from 'three';
+import type { TagContentType } from './TagData';
+import type { ImagePlane } from '../../utils/model/mediaPlane';
+import type { PartialDeep } from 'type-fest';
+import type { TagInstance } from './TagInstance';
+export type TagId = string | number;
+export type ArrayPosition = number[];
+export type Position = ArrayPosition;
+export type PanoIndex = number;
+export type WorkCode = string;
+export type PartialObjectDeep<ObjectType extends object> = {
+    [KeyType in keyof ObjectType]?: PartialDeep<ObjectType[KeyType]>;
+};
+export interface MinMax {
+    min?: number;
+    max?: number;
+}
+export type StickType = '2DPoint' | '3DPoint' | 'Plane' | 'Model';
+export interface TagIconUrl {
+    url?: string;
+    /** 是否使用默认 tag point，默认为 true */
+    enabled?: boolean;
+    /** 指切图是几倍图，如 2倍图, 3倍图，默认值为 3 */
+    ratio?: number;
+    /** 指帧动画的雪碧图由几张图片构成 */
+    steps?: number;
+    /** 单位：帧/s, 默认每秒24帧，即 fps: 24 */
+    fps?: number;
+    /** 期望渲染在屏幕上的宽度，如果指定了scale，则最终渲染在屏幕上的宽度 = width * scale */
+    width?: number;
+    /** 缩放值。默认为1，如果指定了scale，则最终渲染在屏幕上的宽度 = width * scale */
+    scale?: number;
+}
+export interface TagStyle {
+    /** 小圆点样式 */
+    point?: {
+        /** @deprecated v2.11.0 废弃，使用 width: number 控制 */
+        size?: TagIconSize;
+    } & TagIconUrl;
+}
+export type TagGLTFObject = GLTFObject & {
+    customID: number | string;
+    isTagModel: boolean;
+    removeEventListener: () => void;
+    updateTagCss3DObjectMatrix?: () => void;
+};
+/** 返回一个销毁函数 */
+export type ElementRenderer = (container: HTMLElement) => () => void;
+export interface TagObjectGroup extends Group {
+    children: Array<TagGLTFObjectGroup>;
+}
+export interface TagGLTFObjectGroup extends Group {
+    children: TagGLTFObject[];
+}
+export interface ImagePlaneGroup extends Group {
+    children: ImagePlane[];
+}
+/**
+ * @description S: 18; M: 20; L: 24; XL: 28
+ */
+export type TagIconSize = 'S' | 'M' | 'L' | 'XL' | number;
+export type AudioAppearance = TagInstance<'Audio'>['data']['appearance'];
+export type AudioTagTypeConfigKey = `${StickType | 'Any'}-Audio-${AudioAppearance}`;
+export type ContentTypeConfigKey = `${StickType | 'Any'}-${TagContentType | 'Any'}` | TagContentType | AudioTagTypeConfigKey;
+/**
+ * @description: 从 ContentTypeConfigKey 中提取 ContentTypeConfigKey 对应的 TagContentType 是啥，没找到就是 never
+ */
+export type PickTagContentTypeInContentTypeConfigKey<T extends ContentTypeConfigKey> = T extends `${any}-Audio-${any}` ? 'Audio' : T extends `${any}-${infer C}` ? C : T extends TagContentType ? T : never;
+export type ContentTypeConfigKeySplit = [StickType | 'Any', TagContentType | 'Any'] | [TagContentType] | [StickType | 'Any', 'Audio', AudioAppearance];
+export type PointTag<C extends TagContentType = TagContentType> = TagInstance<C, '2DPoint' | '3DPoint'>;
+/** 二维标签 */
+export type Point2DTag<C extends TagContentType = TagContentType> = TagInstance<C, '2DPoint'>;
+/** 三维标签 */
+export type Point3DTag<C extends TagContentType = TagContentType> = TagInstance<C, '3DPoint'>;
+/** 三维贴片 */
+export type PlaneTag<C extends TagContentType = TagContentType> = TagInstance<C, 'Plane'>;