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

package/dist/Object3DHelperPlugin/PanoTagPlugin/mocks/mock6.d.ts

@@ -0,0 +1,16 @@
+declare const _default: {
+    tagList: {
+        dimensionType: string;
+        pointType: string;
+        contentType: string;
+        position: number[][];
+        data: {
+            mediaData: {
+                url: string;
+                videoCoverUrl: string;
+                type: string;
+            }[];
+        };
+    }[];
+};
+export default _default;

package/dist/Object3DHelperPlugin/PanoTagPlugin/mocks/mock7.d.ts

@@ -0,0 +1,22 @@
+declare const _default: {
+    tagList: ({
+        id: string;
+        dimensionType: string;
+        pointType: string;
+        contentType: string;
+        position: number[][];
+        element: string;
+        data: {
+            text: string;
+        };
+    } | {
+        id: string;
+        dimensionType: string;
+        pointType: string;
+        contentType: string;
+        position: number[][];
+        element: string;
+        data?: undefined;
+    })[];
+};
+export default _default;

package/dist/Object3DHelperPlugin/PanoTagPlugin/tag.config.d.ts

@@ -0,0 +1,7 @@
+import type { Tags } from './typings';
+declare const DefaultConfig: {
+    globalConfig?: Tags['globalConfig'];
+    contentTypeConfig?: Tags['contentTypeConfig'];
+};
+export { DefaultConfig };
+export default DefaultConfig;

package/dist/Object3DHelperPlugin/PanoTagPlugin/typings/controller.d.ts

@@ -0,0 +1,99 @@
+import type { PanoTagPluginController } from '../index';
+import type { ContentType, DimensionType, TagId, PointType, Tag } from '../typings';
+import type * as BasePlugin from '../../base/BasePlugin';
+import type TagContentSvelte from '../Components/Tag/index.svelte';
+import type { Vector3 } from 'three';
+import type { Create3DDomContainerReturnType } from '../../CSS3DRenderPlugin';
+import type { Writable } from 'svelte/store';
+import type { Subscribe } from '@realsee/five';
+export declare type PanoIndex = number;
+export declare type WorkCode = string;
+export declare type Hooks = InstanceType<typeof PanoTagPluginController>['hooks'];
+declare type NonNullable<T> = T extends null | undefined | void ? never : T;
+export interface State extends BasePlugin.State {
+}
+export interface TemporaryState {
+    visible?: boolean;
+}
+export interface EventMap extends BasePlugin.EventMap<State> {
+    click: (params: {
+        event: MouseEvent & {
+            currentTarget: EventTarget;
+        };
+    } & ({
+        target: 'TagPoint';
+        tag: PointTagElement;
+    } | {
+        target: 'TagContent';
+        tag: TagElement;
+    } | {
+        target: 'AudioTagPlayIcon';
+        tag: TagElement;
+        audioInstance: HTMLAudioElement;
+    })) => void;
+    playStateChange: (params: {
+        event: Event;
+        state: 'playing' | 'paused';
+        tag: TagElement;
+        mediaInstance: HTMLMediaElement;
+    }) => void;
+    exposure: (params: {
+        id: TagId;
+        type: 'start' | 'end';
+    }) => void;
+    show: (options: {
+        userAction: boolean;
+        withAnimation: boolean;
+    }) => void;
+    hide: (options: {
+        userAction: boolean;
+        withAnimation: boolean;
+    }) => void;
+    enable: (options: {
+        userAction: boolean;
+    }) => void;
+    disable: (options: {
+        userAction: boolean;
+    }) => void;
+}
+export declare type TagEvents = {
+    unfolded: () => void;
+    folded: () => void;
+    show: () => void;
+    hide: () => void;
+};
+export interface TagCache {
+    visible?: boolean;
+    unfolded?: boolean;
+    minimumDistanceResult?: boolean;
+    distance?: number;
+    angle?: number;
+}
+export declare type TagElement<C extends ContentType = ContentType, P extends PointType = PointType, D extends DimensionType = DimensionType, CustomDataType extends Object = {}> = Tag<C, P, D, CustomDataType> & Partial<{
+    pointTagStyle: {
+        leftPercent: number;
+        topPercent: number;
+    };
+    state: {
+        visible?: boolean;
+        unfolded: boolean;
+    };
+    temporaryState: {
+        visible: boolean;
+    };
+    tag3DContentSvelte: {
+        svelteApp: TagContentSvelte;
+        domContainer: NonNullable<Create3DDomContainerReturnType>;
+        initialNormal: Vector3;
+        currentNormal: Vector3;
+    };
+    hooks: Subscribe<TagEvents>;
+}>;
+export declare type MediaStore = Writable<{
+    currentMediaUrl: string;
+}>;
+export declare type PointTagElement<C extends ContentType = ContentType> = TagElement<C, PointType.PointTag, DimensionType>;
+export declare type PlaneTagElement<C extends ContentType = ContentType> = TagElement<C, PointType.PlaneTag, DimensionType.Three>;
+export declare type Tag2DElement<C extends ContentType = ContentType> = TagElement<C, PointType.PointTag, DimensionType.Two>;
+export declare type Tag3DElement<C extends ContentType = ContentType> = TagElement<C, PointType.PointTag, DimensionType.Three>;
+export {};

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

@@ -0,0 +1,2 @@
+export * from './tag';
+export * from './controller';

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

@@ -0,0 +1,226 @@
+import type { Five } from '@realsee/five';
+import type { Create3DDomContainerParamsType } from '../../CSS3DRenderPlugin/Controller';
+export type { PartialDeep } from 'type-fest';
+export declare type TagId = string | number;
+export declare type ArrayPosition = [number, number, number];
+export declare type Position = ArrayPosition;
+declare type Object = Record<string | number | symbol, any>;
+/** 返回一个销毁函数 */
+declare type ElementRenderer = (container: HTMLElement) => () => void;
+interface MinMax {
+    min?: number;
+    max?: number;
+}
+export declare enum DimensionType {
+    Two = "2D",
+    Three = "3D"
+}
+export declare enum PointType {
+    PointTag = "PointTag",
+    PlaneTag = "PlaneTag"
+}
+export declare enum ContentType {
+    /** 音频标签 */
+    Audio = "Audio",
+    /** 文本标签 */
+    Text = "Text",
+    /** 图文标签 */
+    ImageText = "ImageText",
+    /** VR跳转标签 */
+    Link = "Link",
+    /** 营销标签 */
+    Marketing = "Marketing",
+    /** 图片视频贴片 */
+    MediaPlane = "MediaPlane",
+    /** 其他/自定义标签 */
+    Custom = "Custom"
+}
+export interface Tags {
+    version?: string;
+    /** tag配置 > 按type配置 > 全局配置 */
+    /** 全局配置 */
+    globalConfig?: TagConfig;
+    /** 按type配置 */
+    contentTypeConfig?: Partial<Record<ContentTypeConfigKey, TagConfig>>;
+    tagList: Tag[];
+}
+export declare type ContentTypeConfigKeyArray = [DimensionType | 'Any', ContentType | 'Any', PointType | 'Any'];
+export declare type ContentTypeConfigKey = `${ContentTypeConfigKeyArray[0]}-${ContentTypeConfigKeyArray[1]}-${ContentTypeConfigKeyArray[2]}`;
+export declare type Tag<C extends ContentType = any, P extends PointType = any, D extends DimensionType = any, CustomDataType extends Object = {}> = {
+    /** 开启/禁用 */
+    enabled?: boolean;
+    /** 唯一标识 */
+    id: TagId;
+    /** 一个点的标签/4个点的标签 */
+    pointType: P;
+    /** 2维/3维类型 */
+    dimensionType: D;
+    /** 内容类型，根据内容类型展示对应UI */
+    contentType: C;
+    /** 点 */
+    position: P extends PointType.PointTag ? Position : P extends PointType.PlaneTag ? [Position, Position, Position, Position] : any;
+    /** 自定义标签内容 */
+    element?: string | Element | ElementRenderer;
+    /** 标签数据 */
+    data: C extends ContentType.Custom ? CustomDataType : ContentTypeMap[C];
+    /** 「展开/收起」 「可见/不可见」 的策略配置 */
+    config?: TagConfig<C, P, D, CustomDataType>;
+    /** 法向量 */
+    normal?: Position;
+    /** 样式 */
+    style?: {
+        /** 小圆点样式 */
+        point?: {
+            style: 'Default';
+        } | {
+            style: 'CustomIcon';
+            iconUrl: string;
+        } | {
+            style: 'noPoint';
+        };
+        /** 收起的时候的动画延时，单位：ms */
+        foldedPointDelay?: number;
+    };
+} & (D extends DimensionType.Three ? (P extends PointType.PointTag ? {
+    normal: Position;
+} : unknown) : unknown); /** 三维标签需要法向量 */
+export interface TagConfig<C extends ContentType = ContentType, T extends PointType = PointType, D extends DimensionType = DimensionType, CustomDataType extends Object = {}> {
+    /** 显示/隐藏配置 */
+    visibleConfig?: {
+        /** 走点时不隐藏 */
+        alwaysShowWhenMovePano?: true;
+        /** min-max米内显示 | 无距离限制 */
+        visibleDistance?: MinMax | 'unLimited';
+        /** 限制xx点位上可见，不传则不限制 */
+        visiblePanoIndex?: number[];
+        /** 碰撞检测配置 */
+        intersectRaycaster?: {
+            /** 是否开启碰撞检测 */
+            enabled?: false;
+            /** 碰撞检测的允许误差, 默认值建议为0.01 */
+            distanceAccuracy?: number;
+        };
+        /** 3D标签中 「标签所在平面或垂直于标签法线的平面」 与 「摄像机到标签点或中心点的向量」 的夹角，范围内自动展开，范围外自动收起 */
+        angleRange?: MinMax;
+    } | ((five: Five, tagState: {
+        tag: Tag<C, T, D, CustomDataType>;
+        /** 标签点或中心点的到摄像机的距离 */
+        distance: number;
+        /** 3D标签中 「标签所在平面或垂直于标签法线的平面」 与 「摄像机到标签点或中心点的向量」 的夹角 */
+        angleRange?: number;
+    }) => boolean);
+    /** 展开/收起配置 */
+    unfoldedConfig?: {
+        /** 划动到不可见状态时，自动收起，disableFold: true 的标签不受此参数影响 */
+        autoUnfoldWhenHide?: false;
+        /** 部分标签是无法打开的 */
+        disableUnfold?: true;
+        /** 部分标签是无法收起的 */
+        disableFold?: true;
+        /** min-max米内自动展开,否则收起 */
+        unfoldDistance?: MinMax;
+        /** 自动展开策略 */
+        autoUnfold?: {
+            /** 自动展开 策略 */
+            strategy?: 'ScreenPostion';
+            /** 自动展开策略，{min,max}为project(camera)后的x值 */
+            autoUnfoldProjectX?: MinMax;
+        } | {
+            /** 自动展开 策略 */
+            strategy?: 'MinimumDistance';
+            /** 展开的最大数量, 默认为1 */
+            maxNumber?: number;
+        };
+    } | ((five: Five, tagState: {
+        tag: Tag<C, T, D, CustomDataType>;
+        /** 标签点或中心点的到摄像机的距离 */
+        distance: number;
+        /** 3D标签中 「标签所在平面或垂直于标签法线的平面」 与 「摄像机到标签点或中心点的向量」 的夹角 */
+        angleRange?: number;
+    }) => boolean);
+    /** 初始状态 */
+    initialState?: {
+        /** 显示/隐藏 */
+        visible?: boolean;
+        /** 展开/收起 */
+        unfolded?: boolean;
+    };
+    tag3DConfig?: Create3DDomContainerParamsType['config'];
+}
+export declare enum LinkType {
+    VrLink = "vr",
+    NormalLink = "normal"
+}
+export declare type MediaData = {
+    type: 'Image';
+    url: string;
+} | {
+    type: 'Video';
+    url: string;
+    videoCoverUrl?: string;
+};
+export declare type ObjectFit = 'fill' | 'contain' | 'cover' | 'none' | 'scale-down';
+interface ContentTypeMap {
+    [ContentType.Audio]: {
+        text: string;
+        audioUrl: string;
+        extraData?: Object;
+    };
+    [ContentType.ImageText]: {
+        text?: string;
+        mediaData: (MediaData & {
+            name?: string;
+        })[];
+        extraData?: Object;
+    };
+    [ContentType.Text]: {
+        text: string;
+        extraData?: Object;
+    };
+    [ContentType.Link]: {
+        linkType: LinkType;
+        text: string;
+        extraData?: Object;
+    };
+    [ContentType.Marketing]: {
+        /** 标题 */
+        title: string;
+        /** 高亮的标签 */
+        brandTags?: string[];
+        /** 普通标签 */
+        tags?: string[];
+        /** 头部宣传图 */
+        headerPictureUrl?: string;
+        /** 跳转文字 */
+        highlightText?: string;
+        /** 价格 */
+        price?: {
+            value: string;
+            /** 单位 */
+            unit: string;
+        };
+        extraData?: Object;
+    };
+    [ContentType.MediaPlane]: {
+        enableCarousel?: boolean;
+        /**
+         * @description stretch: 拉伸适配, proportional: 等比适配，默认值 'proportional'
+         * @deprecated replaced by objectFit
+         */
+        adaptationMode?: 'stretch' | 'proportional';
+        /** object-fit doc {@link https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-fit} */
+        objectFit?: ObjectFit;
+        mediaData: MediaData[];
+        extraData?: Object;
+    };
+    [ContentType.Custom]: unknown;
+}
+/** 内置一些基础标签 */
+/** 一个点的标签 */
+export declare type PointTag<C extends ContentType = ContentType, D extends DimensionType = DimensionType, CustomDataType extends Object = {}> = Tag<C, PointType.PointTag, D, CustomDataType>;
+/** 二维标签 */
+export declare type Tag2D<C extends ContentType = ContentType, CustomDataType extends Object = {}> = Tag<C, PointType.PointTag, DimensionType.Two, CustomDataType>;
+/** 三维标签 */
+export declare type Tag3D<C extends ContentType = ContentType, CustomDataType extends Object = {}> = Tag<C, PointType.PointTag, DimensionType.Three, CustomDataType>;
+/** 三维贴片 */
+export declare type PlaneTag<C extends ContentType = ContentType, CustomDataType extends Object = {}> = Tag<C, PointType.PlaneTag, DimensionType.Three, CustomDataType>;

package/dist/Object3DHelperPlugin/PanoTagPlugin/utils/actionAfterFiveModelLoad.d.ts

@@ -0,0 +1,2 @@
+import type { Five } from '@realsee/five';
+export declare function actionAfterFiveModelLoad(five: Five, fuc: () => any): void;

package/dist/Object3DHelperPlugin/PanoTagPlugin/utils/addDebugPoints.d.ts

@@ -0,0 +1,3 @@
+import type { Five } from '@realsee/five';
+import type { Tag } from '../typings';
+export declare function addDebugPoints(five: Five, tags: Tag[]): void;

package/dist/Object3DHelperPlugin/PanoTagPlugin/utils/checkRange.d.ts

@@ -0,0 +1,4 @@
+export declare function checkRange(value?: number, range?: {
+    min?: number;
+    max?: number;
+}): boolean;

package/dist/Object3DHelperPlugin/PanoTagPlugin/utils/debounce.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 函数防抖：指触发事件后，在 `n` 秒内函数只能执行一次，如果触发事件后在 `n` 秒内又触发了事件，则会重新计算函数延执行时间。
+ * @param callback 回调函数
+ * @param waitFor 等待时间
+ * @returns
+ */
+export declare const debounce: <F extends (...args: any) => any>(callback: F, waitFor?: number) => (...args: Parameters<F>) => ReturnType<F>;

package/dist/Object3DHelperPlugin/PanoTagPlugin/utils/index.d.ts

@@ -0,0 +1,12 @@
+export * from '../../CSS3DRenderPlugin/utils';
+export * from './addDebugPoints';
+export * from './noTypecheck';
+export * from './planeNormal';
+export * from './tagPosition';
+export * from './checkRange';
+export * from './actionAfterFiveModelLoad';
+export * from './normalPositionToPositions';
+export * from './debounce';
+export * from './throttle';
+export * from './search';
+export * from './resizeObserver';

package/dist/Object3DHelperPlugin/PanoTagPlugin/utils/noTypecheck.d.ts

@@ -0,0 +1 @@
+export declare const noTypecheck: (x: any) => any;

package/dist/Object3DHelperPlugin/PanoTagPlugin/utils/normalPositionToPositions.d.ts

@@ -0,0 +1,2 @@
+import type { Vector3 } from 'three';
+export declare function normalPositionToPositions(cameraPosition: Vector3, position: Vector3, normal: Vector3): [Vector3, Vector3, Vector3, Vector3];

package/dist/Object3DHelperPlugin/PanoTagPlugin/utils/planeNormal.d.ts

@@ -0,0 +1,4 @@
+import type { Vector3 } from 'three';
+import { AnyPosition } from '.';
+export declare function planeNormal(points: [AnyPosition, AnyPosition, AnyPosition] | [AnyPosition, AnyPosition, AnyPosition, AnyPosition]): Vector3;
+export declare function planeNormal(points: AnyPosition[]): Vector3 | void;

package/dist/Object3DHelperPlugin/PanoTagPlugin/utils/resizeObserver.d.ts

@@ -0,0 +1,4 @@
+export declare function resizeObserver(func: () => any, element?: HTMLElement): {
+    observe: () => void;
+    unobserve: () => void;
+};

package/dist/Object3DHelperPlugin/PanoTagPlugin/utils/search.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 二分查找，查找第一个大于等于给定值的元素
+ * 数组必须有序，存在重复
+ * @param {array} arr 待排序数组
+ * @param {number} target 目标数据
+ */
+export declare function binarySearchFirstBig(getValueByIndex: (index: number) => number, indexRange: [number, number], target: number): number;
+/**
+ * @description: 查找第一个小于前一个数字的值
+ */
+export declare function searchFirstValueSmallThanLastValue(getValueByIndex: (index: number) => number, indexRange: [number, number]): number;

package/dist/Object3DHelperPlugin/PanoTagPlugin/utils/tagPosition.d.ts

@@ -0,0 +1,3 @@
+import type { Vector3 } from 'three';
+import { AnyPosition } from '.';
+export declare function tagPosition(position: AnyPosition | [AnyPosition, AnyPosition, AnyPosition, AnyPosition]): Vector3;

package/dist/Object3DHelperPlugin/PanoTagPlugin/utils/throttle.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 创建一个防抖动函数，该函数在高频调用时会每隔 wait 毫秒后调用 func 方法
+ * `throttle` 会在第一次调用时立刻调用一次
+ * @param func - 要防抖动的函数
+ * @param wait - 需要延迟的毫秒数
+ */
+export declare function throttle<T>(func: (...args: T[]) => void, wait?: number): (this: any, ...args: T[]) => void;