@realsee/dnalogel 2.16.1 → 2.17.0-alpha.3

package/dist/PanoTagPlugin/Archive/deprecated.d.ts

@@ -0,0 +1,22 @@
+/**  @deprecated 改用具体的string */
+export declare enum PointType {
+    PointTag = "PointTag",
+    PlaneTag = "PlaneTag"
+}
+/**  @deprecated 改用 stickType */
+export declare type TagPointType = keyof typeof PointType;
+/**  @deprecated */
+export declare type DeprecatedTagProperty = {
+    /**  @deprecated 2维/3维类型，已废弃，使用 stickType 代替 */
+    dimensionType?: '2D' | '3D';
+    /** @deprecated 一个点的标签/4个点的标签，已废弃，使用 stickType 代替 */
+    pointType?: 'PlaneTag' | 'PointTag';
+};
+/**  @deprecated */
+export declare type DeprecatedMediaPlaneProperty = {
+    /**
+     * @description stretch: 拉伸适配, proportional: 等比适配，默认值 'proportional'
+     * @deprecated replaced by objectFit
+     */
+    adaptationMode?: 'stretch' | 'proportional';
+};

package/dist/PanoTagPlugin/controller/TagComputer.d.ts

@@ -10,9 +10,7 @@ export declare abstract class TagComputer extends TagUtil {
      * @description: 获取是否可见
      */
     getVisibleByPanoIndex(tag: Tag<any, any>, panoIndex?: number): boolean;
-    getVisibleByFiveMode(tag: Tag<any, any>, mode: Mode): boolean;
-    /** 检测是否匹配当前楼层 */
-    getVisibleByFloorIndex(tag: TagElement<any, any>): boolean;
+    getVisibleByFiveMode(tag: TagElement<any, any>, mode?: Mode): boolean;
     /**
      * @description 获取标签当前状态
      * @return (this.state.visible && tag.state.visible) ?? true
@@ -52,4 +50,6 @@ export declare abstract class TagComputer extends TagUtil {
     };
     /** 获取点位看向标签的射线 */
     protected getRaycasterFromPanoIndex(tag: Tag, panoIndex: number): THREE.Raycaster;
+    /** 检测是否匹配当前楼层 */
+    private getVisibleByFloorIndex;
 }

package/dist/PanoTagPlugin/controller/TagUtil.d.ts

@@ -4,6 +4,7 @@ import type { Tag, Tags, Point2DElement, Point3DElement, PlaneTagElement, PointT
 import { TagCache } from './TagCache';
 import { CSS3DRenderPluginExportType } from '../../CSS3DRenderPlugin';
 import { Five } from '@realsee/five';
+import { FiveDomEvents } from '../../shared-utils/five/FiveDomEvents';
 export declare abstract class TagUtil extends TagCache {
     tags: TagElement[];
     config: Pick<Tags, 'globalConfig' | 'contentTypeConfig'>;
@@ -21,7 +22,7 @@ export declare abstract class TagUtil extends TagCache {
         disposed: boolean;
     };
     protected get isPanorama(): boolean;
-    private domEvents?;
+    protected domEvents: FiveDomEvents;
     private mouseInfo?;
     protected constructor(five: Five);
     getTagById<C extends TagContentType = any, S extends StickType = any>(id: TagId): TagElement<C, S> | undefined;

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

@@ -1,5 +1,5 @@
 import type { Tag, PartialDeep, TagId, Tags, TagElement, State, AddTagConfig, LoadTagConfig, ContentTypeConfigKey, TagConfig } from '../typings';
-import type { TagContentType } from '..';
+import type { PickTagContentTypeInContentTypeConfigKey, TagContentType } from '..';
 import type { ArrayPosition } from '../typings';
 import { Five } from '@realsee/five';
 import { TagRender } from './TagRender';
@@ -37,7 +37,7 @@ declare class PanoTagPluginController extends TagRender {
     /**
      * @description: 改变类型配置
      */
-    changeContentTypeConfig(key: ContentTypeConfigKey, contentTypeConfig: TagConfig, merge?: boolean): void;
+    changeContentTypeConfig<T extends ContentTypeConfigKey>(key: ContentTypeConfigKey, contentTypeConfig: PickTagContentTypeInContentTypeConfigKey<T> extends TagContentType ? TagConfig<PickTagContentTypeInContentTypeConfigKey<T>> : unknown, merge?: boolean): void;
     show(params?: {
         userAction?: boolean;
         withAnimation?: boolean;

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

@@ -28,7 +28,7 @@ export interface EventMap extends BasePlugin.EventMap<State> {
         tag: PointTagElement<any>;
     } | {
         target: 'TagContent';
-        tag: TagElement;
+        tag: TagElement<any, any>;
     } | {
         target: 'AudioTagPlayIcon';
         tag: TagElement;

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

@@ -1,7 +1,8 @@
 import type { State as FiveState } from '@realsee/five';
 import type { TagConfig } from './TagConfig';
 import { ContentTypeMap, ContentType, TagContentType } from './TagData';
-import type { ContentTypeConfigKey, Position, TagId, StickType, TagStyle, ElementRenderer } from './Utils';
+import type { Position, TagId, StickType, TagStyle, ElementRenderer, PickTagContentTypeInContentTypeConfigKey, ContentTypeConfigKey } from './Utils';
+import { DeprecatedTagProperty } from '../../Archive/deprecated';
 export type { ContentTypeMap, TagContentType };
 export { ContentType };
 export interface Tags {
@@ -10,21 +11,19 @@ export interface Tags {
     /** 全局配置 */
     globalConfig?: TagConfig;
     /** 按type配置 */
-    contentTypeConfig?: Partial<Record<ContentTypeConfigKey, TagConfig>>;
+    contentTypeConfig?: {
+        [key in ContentTypeConfigKey]?: PickTagContentTypeInContentTypeConfigKey<key> extends TagContentType ? TagConfig<PickTagContentTypeInContentTypeConfigKey<key>> : unknown;
+    };
     /** 标签列表配置 */
     tagList: Tag[];
 }
-export declare type Tag<C extends TagContentType = TagContentType, S extends StickType = StickType> = {
+export declare type Tag<C extends TagContentType = TagContentType, S extends StickType = StickType> = DeprecatedTagProperty & {
     /** 开启/禁用 */
     enabled?: boolean;
     /** 唯一标识 */
-    id: TagId;
-    /** @deprecated 一个点的标签/4个点的标签，已废弃，使用 stickType 代替 */
-    pointType?: 'PlaneTag' | 'PointTag';
+    id?: TagId;
     /** @type {StickType} 附着方式 */
     stickType: S;
-    /**  @deprecated 2维/3维类型，已废弃，使用 stickType 代替 */
-    dimensionType?: '2D' | '3D';
     /** @type {TagContentType} 内容类型，根据内容类型展示对应UI */
     contentType: C;
     /** 点 */

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

@@ -1,14 +1,18 @@
 import type { Create3DDomContainerParamsType } from '../../../CSS3DRenderPlugin/Controller';
 import type { Five, Mode } from '@realsee/five';
-import type { TagContentType } from './TagData';
+import type { ContentTypeMap, TagContentType } from './TagData';
 import type { Tag } from './Tag';
 import type { MinMax, StickType } from './Utils';
+import type { PartialDeep } from 'type-fest';
 export interface TagConfig<C extends TagContentType = TagContentType, S extends StickType = StickType> {
     /** 显示/隐藏配置 */
     visibleConfig?: {
         /** 保持可见/不可见, 设置后visibleConfig下所有其他配置都不生效 */
         keep?: 'visible' | 'hidden';
+        /** 在哪些 five mode 下可见，默认为 ['Panorama'] */
         visibleFiveMode?: Mode[];
+        /** 当 visibleFiveMode 包含 'Floorplan' 或者 'MapView' 时，是否仅在当前楼层模型下可见，默认为true */
+        followModelVisibility?: boolean;
         /** 走点时不隐藏 */
         alwaysShowWhenMovePano?: true;
         /** min-max米内显示 | 无距离限制 */
@@ -84,6 +88,7 @@ export interface TagConfig<C extends TagContentType = TagContentType, S extends
         /** 展开/收起 */
         unfolded?: boolean;
     };
+    initialData?: PartialDeep<ContentTypeMap[C]>;
     tag3DConfig?: Create3DDomContainerParamsType['config'];
     /** 当图片为一张时可以通过Mesh渲染 */
     renderType?: 'Mesh' | 'Dom';

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

@@ -1,3 +1,4 @@
+import { DeprecatedMediaPlaneProperty } from '../../Archive/deprecated';
 import type { Position, TagIconUrl } from './Utils';
 export declare type MediaData = {
     type: 'Image';
@@ -7,8 +8,8 @@ export declare type MediaData = {
     url: string;
     videoCoverUrl?: string;
 };
-declare type Object = Record<string | number | symbol, any>;
 export declare type ObjectFit = 'fill' | 'contain' | 'cover' | 'none' | 'scale-down';
+declare type Object = Record<string | number | symbol, any>;
 export declare enum ContentType {
     /** 音频标签 */
     Audio = "Audio",
@@ -51,7 +52,6 @@ interface ContentTypeMapInterface {
         text?: string;
         title?: string;
         description?: string;
-        extraData?: Object;
         edit?: {
             title?: {
                 inputting?: boolean;
@@ -72,7 +72,6 @@ interface ContentTypeMapInterface {
         appearance?: 'line' | 'plane';
         theme?: 'dark' | 'light';
         audioUrl: string;
-        extraData?: Object;
     };
     /** 图文标签 */
     ImageText: {
@@ -82,7 +81,6 @@ interface ContentTypeMapInterface {
         mediaData: (MediaData & {
             name?: string;
         })[];
-        extraData?: Object;
     };
     /** 图片标签 */
     Image: ContentTypeMapInterface['ImageText'];
@@ -96,7 +94,6 @@ interface ContentTypeMapInterface {
         /** @deprecated: linkType 不再和样式绑定，使用 iconUrl 代替 */
         linkType?: 'vr' | 'normal';
         icon?: TagIconUrl;
-        extraData?: Object;
     };
     /** VR跳转标签 */
     VRLink: ContentTypeMapInterface['Link'];
@@ -126,35 +123,33 @@ interface ContentTypeMapInterface {
             /** 单位 */
             unit: string;
         };
-        extraData?: Object;
     };
     /** 营销贴片 */
     MediaPlane: {
         enableCarousel?: boolean;
-        /**
-         * @description stretch: 拉伸适配, proportional: 等比适配，默认值 'proportional'
-         * @deprecated replaced by objectFit
-         */
-        adaptationMode?: 'stretch' | 'proportional';
         /** 多媒体在容器中的适配规则 {@link https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-fit} */
         objectFit?: ObjectFit;
-        /**
-         * @description 是否开启自动轮播
-         * @param autoplay true: 开启自动轮播, false: 关闭自动播放
-         * @param autoplayVideo 自动轮播时，如果是视频， 则自动播放视频
-         * @default 默认值 { autoplay: true, autoplayVideo: false }
-         */
         autoplayConfig?: {
-            autoplay: boolean;
-            autoplayVideo: boolean;
+            /**
+             * @description 是否自动播放视频
+             * @default autoplayVideo: false
+             */
+            autoplayVideo?: boolean;
+            /**
+             * @description 是否自动轮播
+             * @default autoplayCarousel: true
+             */
+            autoplayCarousel?: boolean;
+            /**
+             * @description 轮播中遇到视频是否要自动播放
+             * @default autoplayVideoInCarousel: false
+             */
+            autoplayVideoInCarousel?: boolean;
         };
         mediaData: MediaData[];
-        /**
-         * @description 暂停时的播放按钮url
-         */
+        /** @description 暂停时的播放按钮url */
         playIcon?: 'withText' | 'withoutText' | string;
-        extraData?: Object;
-    };
+    } & DeprecatedMediaPlaneProperty;
     MediaModel: {
         modelUrl: string;
         mediaData: MediaData[];
@@ -170,5 +165,10 @@ interface ContentTypeMapInterface {
     Custom: Object;
     Unknown: Object;
 }
-export declare type ContentTypeMap = Pick<ContentTypeMapInterface, TagContentType>;
+declare type ContentTypeMapInterfaceWithextraData = {
+    [key in keyof ContentTypeMapInterface]: ContentTypeMapInterface[key] & {
+        extraData?: Object;
+    };
+};
+export declare type ContentTypeMap = Pick<ContentTypeMapInterfaceWithextraData, TagContentType>;
 export {};

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

@@ -62,6 +62,10 @@ export declare type TagIconSize = 'S' | 'M' | 'L' | 'XL' | number;
 export declare type AudioAppearance = Tag<'Audio'>['data']['appearance'];
 export declare type AudioTagTypeConfigKey = `${StickType | 'Any'}-Audio-${AudioAppearance}`;
 export declare type ContentTypeConfigKey = `${StickType | 'Any'}-${TagContentType | 'Any'}` | TagContentType | AudioTagTypeConfigKey;
+/**
+ * @description: 从 ContentTypeConfigKey 中提取 ContentTypeConfigKey 对应的 ContentType 是啥，没找到就是 never
+ */
+export declare type PickTagContentTypeInContentTypeConfigKey<T extends ContentTypeConfigKey> = T extends `${any}-Audio-${any}` ? 'Audio' : T extends `${any}-${infer C}` ? C : T extends TagContentType ? T : never;
 export declare type ContentTypeConfigKeySplit = [StickType | 'Any', TagContentType | 'Any'] | [TagContentType] | [StickType | 'Any', 'Audio', AudioAppearance];
 export declare type PointTag<C extends TagContentType = TagContentType> = Tag<C, '2DPoint' | '3DPoint'>;
 /** 二维标签 */

package/dist/PanoTagPlugin/utils/model/mediaPlane.d.ts

@@ -1,13 +1,16 @@
 import * as THREE from 'three';
 import { Vector3 } from 'three';
 import { ObjectFit } from '../../typings';
+import DomEvents from '../../../shared-utils/threex/domevents';
+import { Overwrite } from '../../../typings/utils.type';
 declare type Src = string;
-declare type VideoTexture = Omit<THREE.VideoTexture, 'image'> & {
+declare type VideoTexture = Overwrite<THREE.VideoTexture, {
     image: HTMLVideoElement;
-};
-declare type ImageTexture = Omit<THREE.Texture, 'image'> & {
+    metadataLoaded: boolean;
+}>;
+declare type ImageTexture = Overwrite<THREE.Texture, {
     image: HTMLImageElement;
-};
+}>;
 declare abstract class MediaPlane extends THREE.Mesh<THREE.BufferGeometry | THREE.Geometry, THREE.MeshBasicMaterial> {
     name: string;
     src?: string;
@@ -22,10 +25,10 @@ declare class ImagePlane extends MediaPlane {
 declare class VideoPlane extends MediaPlane {
     readonly isVideoPlane = true;
     name: string;
-    videoInstance: HTMLVideoElement;
+    videoInstance?: HTMLVideoElement;
+    onVideoReady?: (videoInstance?: HTMLVideoElement) => void;
     private objectFit;
     private buttonSrc;
-    private paused;
     private videoCoverSrc?;
     private domEvents?;
     private disposers;
@@ -37,39 +40,26 @@ declare class VideoPlane extends MediaPlane {
     private videoTextureMap;
     private ImageTextureMap;
     constructor(videoSrc: string, cornerPoints: Vector3[], params?: {
-        videoInstance?: HTMLVideoElement;
+        paused?: boolean;
         playButton?: 'withText' | 'withoutText' | string;
         videoCoverSrc?: string;
         objectFit?: ObjectFit;
         videoTextureMap?: Map<Src, VideoTexture>;
         ImageTextureMap?: Map<Src, ImageTexture>;
     });
-    play(): Promise<void>;
+    play(muted?: boolean): Promise<void>;
     pause(): void;
-    initialDomEvents(five: any): void;
-    initialRenderHooks(five: any): void;
+    initialDomEvents(domEvents: DomEvents): void;
+    initialRenderHooks(func: (render: () => void) => () => any): void;
     private showPauseUI;
     private render;
-    private addAutoEventListener;
+    private addAutoBindEventListener;
     private addDomEventListener;
     private removeDomEventListener;
     private addCoverMesh;
     private addVideoMesh;
     private addButtonMesh;
-    /**
-     * @description: 将视频封面Mesh
-     */
-    private getCoverMesh;
-    /**
-     * @description: 获取视频Mesh
-     */
-    private getVideoMesh;
-    /**
-     * @description: 获取点击播放按钮Mesh
-     */
-    private getButtonMesh;
-    private getButtonTexture;
-    private getCoverTexture;
+    private getImageTexture;
     private getVideoTexture;
 }
 export { ImagePlane, VideoPlane };