@realsee/dnalogel 2.16.0-4 → 2.16.0-6

package/dist/CruisePlugin/index.d.ts

@@ -1,6 +1,8 @@
 import type { FivePlugin } from '@realsee/five';
 import CruisePluginController from './Controller';
+import * as CruisePluginTypes from './typing';
 export { CruisePluginController };
 export declare const CruisePlugin: FivePlugin<void, InstanceType<typeof CruisePluginController>>;
 export type { CruisePluginExportType } from './typing';
 export default CruisePlugin;
+export { CruisePluginTypes };

package/dist/CruisePlugin/typing.d.ts

@@ -34,47 +34,39 @@ export interface PluginData {
         unitHeight?: number;
     };
 }
+export interface MoveAction {
+    /** five走点动画 */
+    moveEffect?: MoveEffect;
+    /** 到第一个点的走点动画 / 续播到暂停处的走点动画 */
+    moveToFirstPanoEffect?: MoveEffect;
+    /** 到第一个点的走点时长 / 续播到暂停处的走点时长 */
+    moveToFirstPanoDuration?: number;
+    /** 漫游方式：justMove 为移动到指定点位，且朝向为下一个点的朝向；moveAndRotate 为先移动到指定点位且朝向不变，然后旋转到下一个点的朝向 */
+    moveType?: 'justMove' | 'moveAndRotate';
+    /** 停留时长 */
+    stay?: number;
+    /** 传递给 GuildPlugin 的参数 */
+    guildPluginOptions?: GuideLinePluginData['config'];
+}
+export interface MoveWithPanoIndexAction extends MoveAction {
+    /** 点位列表 */
+    panoIndexList: number[];
+    /** for ts check, no care */
+    keyframes?: undefined;
+}
+export interface MoveWithKeyframesAction extends MoveAction {
+    keyframes: {
+        uuid?: string;
+        id?: string;
+        start?: number;
+        end?: number;
+        data: CruiseData;
+    }[];
+    /** for ts check, no care */
+    panoIndexList?: undefined;
+}
 export interface PluginServerData extends BasePluginWithData.ServerData {
-    data: {
-        keyframes: {
-            uuid?: string;
-            id?: string;
-            start?: number;
-            end?: number;
-            data: CruiseData;
-        }[];
-        /** 传递给 GuildPlugin 的参数 */
-        guildPluginOptions?: GuideLinePluginData['config'];
-        /** for ts check, no care */
-        panoIndexList?: undefined;
-        /** for ts check, no care */
-        moveEffect?: undefined;
-        /** for ts check, no care */
-        moveType?: undefined;
-        /** for ts check, no care */
-        moveToFirstPanoEffect?: undefined;
-        /** for ts check, no care */
-        moveToFirstPanoDuration?: undefined;
-        /** for ts check, no care */
-        stay?: undefined;
-    } | {
-        /** 点位列表 */
-        panoIndexList: number[];
-        /** five走点动画 */
-        moveEffect?: MoveEffect;
-        /** 到第一个点的走点动画 / 续播到暂停处的走点动画 */
-        moveToFirstPanoEffect?: MoveEffect;
-        /** 到第一个点的走点时长 / 续播到暂停处的走点时长 */
-        moveToFirstPanoDuration?: number;
-        /** 漫游方式：justMove 为移动到指定点位，且朝向为下一个点的朝向；moveAndRotate 为先移动到指定点位且朝向不变，然后旋转到下一个点的朝向 */
-        moveType?: 'justMove' | 'moveAndRotate';
-        /** 停留时长 */
-        stay?: number;
-        /** 传递给 GuildPlugin 的参数 */
-        guildPluginOptions?: GuideLinePluginData['config'];
-        /** for ts check, no care */
-        keyframes?: undefined;
-    };
+    data: MoveWithKeyframesAction | MoveWithPanoIndexAction;
 }
 export interface PluginState extends BasePluginWithData.State {
     /** 是否可见 */

package/dist/GuideLinePlugin/Controller.d.ts

@@ -4,10 +4,12 @@ import type { EventMap, PluginData, PluginServerData, PluginState } from './typi
 import type * as PluginType from './typing';
 import type { Config } from '../base/BasePlugin';
 import { GuideLineItem } from './GuideLineItem';
+import CruisePluginController from '../CruisePlugin/Controller';
 export declare const pluginFlag: (name: string) => string;
 export default class Controller extends BasePluginWithData.Controller<PluginState, EventMap, PluginServerData, PluginData> {
     readonly version = "v1.1.0";
     readonly name = "GuideLinePlugin";
+    readonly cruisePlugin: CruisePluginController;
     state: {
         visible: boolean;
         enabled: boolean;

package/dist/GuideLinePlugin/GuideLineItem.d.ts

@@ -2,6 +2,8 @@ import type { Five } from '@realsee/five';
 import type GuideLinePlugin from './Controller';
 import type * as PluginType from './typing';
 import { GuideLineModeItem } from './GuideLineModeItem';
+import { CruisePluginTypes } from '../CruisePlugin';
+import { Subscribe } from '@realsee/five';
 /** 路线引导实例。
  * - 路线包括两个部分：全景路线和模型路线。
  * - Five 切换模态时，路线会自动切换。
@@ -13,6 +15,7 @@ declare class GuideLineItem {
     readonly isGuideLine = true;
     readonly panoramaItem: GuideLineModeItem;
     readonly modelItem: GuideLineModeItem;
+    readonly hooks: Subscribe<PluginType.GuideLineItemEventMap>;
     private plugin;
     private five;
     constructor(options: {
@@ -22,5 +25,8 @@ declare class GuideLineItem {
     });
     setData(data: PluginType.GuideLineItem): void;
     setDataByMode(mode: PluginType.GuideLineModeItemMode, data: PluginType.GuideLineItem): void;
+    dispose(): void;
+    walk(options?: CruisePluginTypes.MoveAction): Promise<void>;
+    private logError;
 }
 export { GuideLineItem };

package/dist/GuideLinePlugin/GuideLineModeItem.d.ts

@@ -2,61 +2,93 @@ import type GuideLinePlugin from './Controller';
 import type { Five } from '@realsee/five';
 import type * as PluginType from './typing';
 import * as THREE from 'three';
+import { GuideLineItem } from './GuideLineItem';
+import { PanoTagPluginController, Tag } from '../PanoTagPlugin';
 /** @link https://threejs.org/docs/index.html#api/en/extras/curves/CatmullRomCurve3 */
 declare type CatmullRomCurve3RestParams = Omit<PluginType.CatmullRomCurve3, 'type' | 'points'>;
 /** 在不同模态下的 GuideLine */
 declare class GuideLineModeItem {
+    get panoGroup(): number[];
+    startTagPlugin: PanoTagPluginController;
+    endTagPlugin: PanoTagPluginController;
     readonly mesh: THREE.Mesh<THREE.BufferGeometry, THREE.ShaderMaterial>;
     private five;
     private mode;
     private path;
+    private _panoGroup;
     private skippedPositions;
     private textureUrl;
     private scale;
     private width;
     private unitLength;
     private visible;
-    /** 在当前模态下，是否展示 */
+    /** Five Mode 是否满足 */
     private modeVisible;
+    /** 默认是否展示 */
+    private defaultVisible;
+    /** 走点动画 */
+    private inWalkAnimation;
     private customVisible;
+    private parent;
     private plugin;
     private textureHasLoaded;
     private disposed;
     constructor(five: Five, options: {
         mode: PluginType.GuideLineModeItemMode;
         plugin: GuideLinePlugin;
+        parent: GuideLineItem;
     });
     /** 自定义展示 */
     setCustomVisible(visible: boolean | null): void;
-    /** 设置模型态展示 */
-    setModeVisible(visible: boolean): void;
+    /** 设置默认展示 */
+    setDefaultVisible(visible: boolean): void;
     dispose(): void;
     /** 基础宽、长 */
     setUnitSize(width: number, length: number): void;
     /** 设置缩放 */
     setScale(scale: number): void;
     /** 通过点位设置线条形状 */
-    setGeometryByPanoGroup(panoGroup: number[], options?: CatmullRomCurve3RestParams & PluginType.GuideLineGeometryStyle): void;
+    setGeometryByPanoGroup(panoGroup: number[], options?: CatmullRomCurve3RestParams & PluginType.GuideLineGeometryStyle & {
+        skipPanoGroup?: boolean;
+    }): void;
     /** 通过路径设置线条形状 */
     setGeometryByPath(path: PluginType.PathItem[], options?: PluginType.GuideLineGeometryStyle): void;
-    setSkippedPanoGroup(panoGroup: null | number[]): void;
     /** 设置线条材质 */
     setMartial(options?: PluginType.GuideLineMaterialStyle): void;
+    /** 设置贴图颜色 */
     setColor(color: null | number[]): void;
+    /** 设置背景颜色 */
     setBackgroundColor(color: number[]): void;
+    /** 设置整体透明度 */
     setOpacity(opacity: number): void;
+    /** 设置背景透明度 */
     setBackgroundOpacity(opacity: number): void;
+    /** 设置贴图透明度 */
     setMapOpacity(opacity: number): void;
+    /** 设置贴图 */
     setTextureUrl(url: string): void;
+    setStartTag(tag: Tag): void;
+    setEndTag(tag: Tag): void;
+    private setTag;
+    /** 当设置 GuideLinePLugin 展示 */
     private onPluginShow;
+    /** 当设置 GuideLinePLugin 隐藏 */
     private onPluginHide;
+    /** 当设置 GuideLinePLugin 开启 */
     private onPluginEnable;
+    /** 当设置 GuideLinePLugin 关闭 */
     private onPluginDisable;
+    /** 开始走点动画 */
+    private onWalkAnimationStart;
+    /** 结束走点动画 */
+    private onWalkAnimationEnd;
     /** 模型状态变更 */
     private onFiveModeChange;
+    /** 更新可见性 */
     private updateVisible;
     private doShow;
     private doHide;
+    /** 通过 panoIndex 数组计算路径 */
     private getPathFromPanoGroup;
     private logWarning;
     private logError;

package/dist/GuideLinePlugin/typing.d.ts

@@ -1,6 +1,7 @@
 import type GuideLinePlugin from '.';
 import type { RequireAtLeastOne } from 'type-fest';
 import type * as BasePluginWithData from '../base/BasePluginWithData';
+import { Tag } from '../PanoTagPlugin';
 export interface RouteConfig {
     arrowTextureUrl?: string;
     skipPanoIndexMesh?: boolean;
@@ -40,6 +41,14 @@ export interface EventMap extends BasePluginWithData.EventMap<PluginState, Plugi
         userAction: boolean;
     }) => void;
 }
+export declare type GuideLineItemEventMap = {
+    walkStart: (options: {
+        userAction: boolean;
+    }) => void;
+    walkEnded: (options: {
+        userAction: boolean;
+    }) => void;
+};
 export declare type GuideLinePluginExportType = ReturnType<typeof GuideLinePlugin>;
 export interface LineGeometriesConfig {
     /** 是否越过点位圆环。可以开启此选项来使越过点位，使其不会重叠显示 */
@@ -66,10 +75,22 @@ export declare type GuideLineItem = RequireAtLeastOne<{
     /** 路径：由多个曲线组合而成的路径，路径为空时，会使用 pano_group 自动创建 */
     path?: PathItem[];
     /** 全景态使用的数据 */
-    panorama_style?: GuideLineStyle;
+    panorama_style?: PanoramaGuideLineStyle;
     /** 模型态使用的数据 */
-    model_style?: GuideLineStyle;
+    model_style?: ModelGuideLineStyle;
 }, 'id' | 'render_id'>;
+/** 全景路径样式 */
+export interface PanoramaGuideLineStyle extends GuideLineStyle {
+    start_tag?: Tag;
+    end_tag?: Tag;
+}
+/** 模型路径样式 */
+export interface ModelGuideLineStyle extends GuideLineStyle {
+    start_tag?: ModelGuideLineTag;
+    end_tag?: ModelGuideLineTag;
+}
+/** 不同模态下的路线数据 */
+export declare type GuideLineStyle = GuideLineGeometryStyle & GuideLineMaterialStyle;
 /** 影响形状的样式 */
 export interface GuideLineGeometryStyle {
     /** scale 之前的路线宽度，默认值是 0.5 */
@@ -97,10 +118,18 @@ export interface GuideLineMaterialStyle {
         url: string;
     };
 }
-/** 不同模态下的路线数据 */
-export declare type GuideLineStyle = GuideLineGeometryStyle & GuideLineMaterialStyle;
+/** 模型路线引导标签 */
+export interface ModelGuideLineTag extends Tag<'Custom', '2DPoint'> {
+    position: number[];
+    data: {
+        text: string;
+        icon_url: string;
+        text_background_url: string;
+    };
+}
 /** 目前只支持 CatmullRomCurve3 */
 export declare type PathItem = CatmullRomCurve3;
+/** @link https://threejs.org/docs/index.html?q=cu#api/zh/extras/curves/CatmullRomCurve3 */
 export interface CatmullRomCurve3 {
     type: 'CatmullRomCurve3';
     points: number[][];

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

@@ -31,7 +31,7 @@ export declare abstract class TagUtil extends TagCache {
      * @description: 获取merge后的配置
      * TODO: 缓存
      */
-    getTagConfig(tag: Tag<any, any>): TagConfig<"Image" | "Link" | "Audio" | "Text" | "ImageText" | "Video" | "Sticker" | "VRLink" | "PanoLink" | "Marketing" | "MediaPlane" | "MediaModel" | "Custom" | "Unknown", StickType>;
+    getTagConfig(tag: Tag<any, any>): TagConfig<"Audio" | "Text" | "ImageText" | "Image" | "Video" | "Link" | "Sticker" | "VRLink" | "PanoLink" | "Marketing" | "MediaPlane" | "MediaModel" | "Custom" | "Unknown", StickType>;
     protected loadVideoFirstFrame(): void;
     protected updateTagConfig(params?: {
         force?: boolean;
@@ -50,12 +50,12 @@ export declare abstract class TagUtil extends TagCache {
     protected preventWhenMouseDown: () => false | void;
     protected addObjectClickHandler(tag: TagElement, object: THREE.Object3D | undefined, handler: (event: Event) => any): () => void;
     protected getTagNormal(tag: TagElement<any, 'Plane'> | TagElement<any, 'Model'> | TagElement<any, '3DPoint'>): THREE.Vector3;
-    protected get filterPointTag(): PointTagElement<"Image" | "Link" | "Audio" | "Text" | "ImageText" | "Video" | "Sticker" | "VRLink" | "PanoLink" | "Marketing" | "MediaPlane" | "MediaModel" | "Custom" | "Unknown">[];
-    protected get filter2DPointTag(): Point2DElement<"Image" | "Link" | "Audio" | "Text" | "ImageText" | "Video" | "Sticker" | "VRLink" | "PanoLink" | "Marketing" | "MediaPlane" | "MediaModel" | "Custom" | "Unknown">[];
-    protected get filter3DPointTag(): Point3DElement<"Image" | "Link" | "Audio" | "Text" | "ImageText" | "Video" | "Sticker" | "VRLink" | "PanoLink" | "Marketing" | "MediaPlane" | "MediaModel" | "Custom" | "Unknown">[];
+    protected get filterPointTag(): PointTagElement<"Audio" | "Text" | "ImageText" | "Image" | "Video" | "Link" | "Sticker" | "VRLink" | "PanoLink" | "Marketing" | "MediaPlane" | "MediaModel" | "Custom" | "Unknown">[];
+    protected get filter2DPointTag(): Point2DElement<"Audio" | "Text" | "ImageText" | "Image" | "Video" | "Link" | "Sticker" | "VRLink" | "PanoLink" | "Marketing" | "MediaPlane" | "MediaModel" | "Custom" | "Unknown">[];
+    protected get filter3DPointTag(): Point3DElement<"Audio" | "Text" | "ImageText" | "Image" | "Video" | "Link" | "Sticker" | "VRLink" | "PanoLink" | "Marketing" | "MediaPlane" | "MediaModel" | "Custom" | "Unknown">[];
     protected get filterImagePlane(): PlaneTagElement<"MediaPlane">[];
     protected get filterMediaModel(): ModelElement<"MediaModel">[];
-    protected get filterModelTag(): ModelElement<"Image" | "Link" | "Audio" | "Text" | "ImageText" | "Video" | "Sticker" | "VRLink" | "PanoLink" | "Marketing" | "MediaPlane" | "MediaModel" | "Custom" | "Unknown">[];
+    protected get filterModelTag(): ModelElement<"Audio" | "Text" | "ImageText" | "Image" | "Video" | "Link" | "Sticker" | "VRLink" | "PanoLink" | "Marketing" | "MediaPlane" | "MediaModel" | "Custom" | "Unknown">[];
     protected get filterCSS3DTag(): (TagElement<any, "Plane"> | TagElement<any, "Model"> | TagElement<any, "3DPoint">)[];
     /**
      * @description 检查是否已经销毁