@realsee/dnalogel 2.15.0 → 2.16.0-0

package/dist/CSS3DRenderPlugin/Controller.d.ts

@@ -79,4 +79,5 @@ export default class Controller extends CSS3DRender implements BasePlugin.Contro
         appendToElement: (element: HTMLElement) => import("./utils/three/CSS3DRenderer").default;
     };
     getBehindFiveElement(): HTMLElement;
+    isAbsoluteURL(url: string): string;
 }

package/dist/CruisePlugin/Controller.d.ts

@@ -1,8 +1,7 @@
 import type { Five } from '@realsee/five';
 import type { BaseOptions } from '../base/BasePlugin';
 import * as BasePluginWithData from '../base/BasePluginWithData';
-import type { PluginState, EventMap, PluginServerData, PluginData } from './typing';
-import type { Config } from '../base/BasePlugin';
+import type { PluginState, EventMap, PluginServerData, PluginData, Config } from './typing';
 export declare const pluginFlag: (name: string) => string;
 export default class CruisePluginController extends BasePluginWithData.Controller<PluginState, EventMap, PluginServerData, PluginData> {
     static PluginVersion: string;

package/dist/CruisePlugin/typing.d.ts

@@ -1,7 +1,8 @@
 import type { MovePanoOptions, Pose, State } from '@realsee/five';
 import type CruisePlugin from '.';
 import type * as BasePluginWithData from '../base/BasePluginWithData';
-import type { PluginData as GuideLinePluginData } from '../GuideLinePlugin/typing';
+import type * as BasePlugin from '../base/BasePlugin';
+import type { PluginDataV1 as GuideLinePluginData } from '../GuideLinePlugin/typing';
 declare type FivePoseAndState = Partial<Pose> & Partial<State>;
 export declare type MoveEffect = MovePanoOptions['effect'];
 export declare type CruiseData = {
@@ -26,7 +27,12 @@ export interface CruiseKeyframe {
 export interface PluginData {
     keyframesId: string;
     keyframes: CruiseKeyframe[];
-    guildPluginOptions?: GuideLinePluginData['config'];
+    guildPluginOptions?: {
+        arrowTextureUrl?: string;
+        skipPanoIndexMesh?: boolean;
+        unitWidth?: number;
+        unitHeight?: number;
+    };
 }
 export interface PluginServerData extends BasePluginWithData.ServerData {
     data: {
@@ -135,5 +141,9 @@ export interface EventMap extends BasePluginWithData.EventMap<PluginState, Plugi
         userAction: boolean;
     }) => void;
 }
+export interface Config extends BasePlugin.Config {
+    /** 漫游时是否加载路线 */
+    useGuideLine?: boolean;
+}
 export declare type CruisePluginExportType = ReturnType<typeof CruisePlugin>;
 export {};

package/dist/GuideLinePlugin/Controller.d.ts

@@ -1,10 +1,13 @@
 import * as BasePluginWithData from '../base/BasePluginWithData';
 import type { Five } from '@realsee/five';
 import type { EventMap, PluginData, PluginServerData, PluginState } from './typing';
+import type * as PluginType from './typing';
 import type { Config } from '../base/BasePlugin';
+import { GuideLineItem } from './GuideLineItem';
 export declare const pluginFlag: (name: string) => string;
 export default class Controller extends BasePluginWithData.Controller<PluginState, EventMap, PluginServerData, PluginData> {
-    static lasestVersion: string;
+    readonly version = "v1.1.0";
+    readonly name = "GuideLinePlugin";
     state: {
         visible: boolean;
         enabled: boolean;
@@ -12,40 +15,43 @@ export default class Controller extends BasePluginWithData.Controller<PluginStat
     };
     protected data?: PluginData;
     private linesGroup?;
+    /** GuideLineItem 索引 */
+    private itemMap;
     constructor(five: Five, config?: Config);
     load(serverData: PluginServerData | PluginData, state?: PluginState, userAction?: boolean): Promise<void>;
-    formatData(serverData: any): Promise<PluginData>;
+    formatData(serverData: any): Promise<PluginType.PluginDataV2>;
+    /** 展示插件 */
     show(options?: {
         userAction?: boolean;
     }): Promise<void>;
+    /** 隐藏插件 */
     hide(options?: {
         userAction?: boolean;
     }): Promise<void>;
+    /** 开启插件 */
     enable(options?: {
         userAction?: boolean;
     }): void;
+    /** 关闭插件 */
     disable(options?: {
         userAction?: boolean;
     }): void;
+    /** 销毁插件 */
     dispose(): void;
     setState(state: Partial<PluginState>, options?: {
         userAction?: boolean;
     }): void;
+    /** 添加一个 GuideLineItem */
+    addGuideLineItem(data?: PluginType.GuideLineItem): GuideLineItem;
+    /** 获取 Plugin 内的 GuideLineItem */
+    getGuideLineItemByID(id: string | number): GuideLineItem;
     private handleEnable;
     private handleVisible;
     private handleDispose;
-    /**
-     * 获取多条路线的 Mesh Group
-     */
-    private getLinesGroup;
-    /**
-     * 获取单条路线
-     */
-    private getLine;
     private disposedErrorLog;
-    private actionWhenEnabled;
     /**
      * @description: Wait for five model ready
      */
     private waitFiveModelLoaded;
+    private getDataWithoutVersion;
 }

package/dist/GuideLinePlugin/GuideLineItem.d.ts

@@ -0,0 +1,26 @@
+import type { Five } from '@realsee/five';
+import type GuideLinePlugin from './Controller';
+import type * as PluginType from './typing';
+import { GuideLineModeItem } from './GuideLineModeItem';
+/** 路线引导实例。
+ * - 路线包括两个部分：全景路线和模型路线。
+ * - Five 切换模态时，路线会自动切换。
+ * - GuideLineItem P
+ */
+declare class GuideLineItem {
+    readonly id: string | number;
+    readonly renderID?: string;
+    readonly isGuideLine = true;
+    readonly panoramaItem: GuideLineModeItem;
+    readonly modelItem: GuideLineModeItem;
+    private plugin;
+    private five;
+    constructor(options: {
+        five: Five;
+        id: string | number;
+        plugin: GuideLinePlugin;
+    });
+    setData(data: PluginType.GuideLineItem): void;
+    setDataByMode(mode: PluginType.GuideLineModeItemMode, data: PluginType.GuideLineItem): void;
+}
+export { GuideLineItem };

package/dist/GuideLinePlugin/GuideLineModeItem.d.ts

@@ -0,0 +1,61 @@
+import type GuideLinePlugin from './Controller';
+import type { Five } from '@realsee/five';
+import type * as PluginType from './typing';
+import * as THREE from 'three';
+/** @link https://threejs.org/docs/index.html#api/en/extras/curves/CatmullRomCurve3 */
+declare type CatmullRomCurve3RestParams = Omit<PluginType.CatmullRomCurve3, 'type' | 'points'>;
+/** 在不同模态下的 GuideLine */
+declare class GuideLineModeItem {
+    readonly mesh: THREE.Mesh<THREE.BufferGeometry, THREE.MeshBasicMaterial>;
+    private five;
+    private mode;
+    private path;
+    private color;
+    private opacity;
+    private textureUrl;
+    private scale;
+    private width;
+    private unitLength;
+    private visible;
+    /** 在当前模态下，是否展示 */
+    private modeVisible;
+    private customVisible;
+    private plugin;
+    private textureHasLoaded;
+    private disposed;
+    constructor(five: Five, options: {
+        mode: PluginType.GuideLineModeItemMode;
+        plugin: GuideLinePlugin;
+    });
+    /** 自定义展示 */
+    setCustomVisible(visible: boolean | null): void;
+    /** 设置模型态展示 */
+    setModeVisible(visible: boolean): void;
+    dispose(): void;
+    /** 基础宽、长 */
+    setUnitSize(width: number, length: number): void;
+    /** 设置缩放 */
+    setScale(scale: number): void;
+    /** 通过点位设置线条形状 */
+    setGeometryByPanoGroup(panoGroup: number[], options?: CatmullRomCurve3RestParams & PluginType.GuideLineGeometryStyle): void;
+    /** 通过路径设置线条形状 */
+    setGeometryByPath(path: PluginType.PathItem[], options?: PluginType.GuideLineGeometryStyle): void;
+    /** 设置线条材质 */
+    setMartial(options?: PluginType.GuideLineMaterialStyle): void;
+    setColor(color: number[]): void;
+    setOpacity(opacity: number): void;
+    setTextureUrl(url: string): void;
+    private onPluginShow;
+    private onPluginHide;
+    private onPluginEnable;
+    private onPluginDisable;
+    /** 模型状态变更 */
+    private onFiveModeChange;
+    private updateVisible;
+    private doShow;
+    private doHide;
+    private getPathFromPanoGroup;
+    private logWarning;
+    private logError;
+}
+export { GuideLineModeItem };

package/dist/GuideLinePlugin/index.d.ts

@@ -1,5 +1,8 @@
 import type { Five } from '@realsee/five';
 import Controller from './Controller';
+import * as GuideLineItem from './GuideLineItem';
+import * as GuideLineModeItem from './GuideLineModeItem';
 export declare const GuideLinePlugin: (five: Five, config?: ConstructorParameters<typeof Controller>[1]) => Controller;
 export type { GuideLinePluginExportType } from './typing';
 export default GuideLinePlugin;
+export { GuideLineItem, GuideLineModeItem };

package/dist/GuideLinePlugin/typing.d.ts

@@ -1,4 +1,5 @@
 import type GuideLinePlugin from '.';
+import type { RequireAtLeastOne } from 'type-fest';
 import type * as BasePluginWithData from '../base/BasePluginWithData';
 export interface RouteConfig {
     arrowTextureUrl?: string;
@@ -9,10 +10,15 @@ export interface RouteConfig {
 export interface Route extends RouteConfig {
     panoIndexList: number[];
 }
-export interface PluginData {
+export interface PluginDataV1 {
     routes: Route[];
     config?: RouteConfig;
 }
+export interface PluginDataV2 {
+    /** 路线数据 */
+    lines: GuideLineItem[];
+}
+export declare type PluginData = PluginDataV1 | PluginDataV2;
 export interface PluginServerData extends BasePluginWithData.ServerData {
     data: PluginData;
 }
@@ -35,3 +41,74 @@ export interface EventMap extends BasePluginWithData.EventMap<PluginState, Plugi
     }) => void;
 }
 export declare type GuideLinePluginExportType = ReturnType<typeof GuideLinePlugin>;
+export interface LineGeometriesConfig {
+    /** 是否越过点位圆环。可以开启此选项来使越过点位，使其不会重叠显示 */
+    skipPanoIndexMesh?: boolean;
+    unitWidth?: number;
+    unitLength?: number;
+}
+export declare type GuideLineModeItemMode = 'panorama' | 'model';
+export interface GuideLineItemContainer<T> {
+    onChildRemoved?: (child: T) => void;
+}
+/** 单条路线的数据 */
+export declare type GuideLineItem = RequireAtLeastOne<{
+    /** server ID */
+    id?: number;
+    /** client ID，不存在时，会使用 String(id) 作为 client ID */
+    render_id?: string;
+    /** 路线名称 */
+    name?: string;
+    /** 可展示的楼层 */
+    visible_floor_indexes?: null | number[];
+    /** 点位数组 */
+    pano_group?: number[];
+    /** 路径：由多个曲线组合而成的路径，路径为空时，会使用 pano_group 自动创建 */
+    path?: PathItem[];
+    /** 全景态是默认否展示
+     * - 全景态包括：
+     * - Panorama
+     * - DepthPanorama
+     * - VRPanorama
+     * - XRPanorama
+     */
+    panorama_like_visible?: boolean;
+    /** 模型态是默认否展示，不是全景态的都算模型态 */
+    model_like_visible?: boolean;
+    /** 全景态使用的数据 */
+    panorama_style?: GuideLineStyle;
+    /** 模型态使用的数据 */
+    model_style?: GuideLineStyle;
+}, 'id' | 'render_id'>;
+/** 影响形状的样式 */
+export interface GuideLineGeometryStyle {
+    /** scale 之前的路线宽度，默认值是 0.5 */
+    width?: number;
+    /** 每一段 scale 之前的 长度，默认值是 0.5 */
+    unit_length?: number;
+    /** 线宽缩放 */
+    scale?: number;
+}
+/** 影响材质的样式 */
+export interface GuideLineMaterialStyle {
+    /** rgb 颜色 [r, g, b] */
+    color?: number[];
+    /** 透明度 */
+    opacity?: number;
+    /** 贴图 */
+    texture?: {
+        /** 贴图地址 */
+        url: string;
+    };
+}
+/** 不同模态下的路线数据 */
+export declare type GuideLineStyle = GuideLineGeometryStyle & GuideLineMaterialStyle;
+/** 目前只支持 CatmullRomCurve3 */
+export declare type PathItem = CatmullRomCurve3;
+export interface CatmullRomCurve3 {
+    type: 'CatmullRomCurve3';
+    points: number[][];
+    closed?: boolean;
+    curve_type?: string;
+    tension?: number;
+}

package/dist/GuideLinePlugin/utils/createLineGeometry.d.ts

@@ -0,0 +1,19 @@
+import * as THREE from 'three';
+import type * as PluginType from '../typing';
+/** 生成曲线参数 */
+interface LineGeometryOption {
+    /** 路径 */
+    path: PluginType.PathItem[];
+    /** 线宽，默认是 0.5 */
+    width: number;
+    /** 每一段的长度，默认是 0.5 */
+    unitLength: number;
+}
+/** 创建路线的几何体
+ * @param curvePoints 三维点位
+ * @param unitWidth 线段宽度
+ * @param unitLength 每一段的长度
+ * @returns THREE BufferGeometry
+ */
+export declare function createLineGeometry(options: LineGeometryOption): THREE.BufferGeometry;
+export {};

package/dist/GuideLinePlugin/utils/index.d.ts

@@ -0,0 +1,7 @@
+import { GuideLineModeItem } from '../GuideLineModeItem';
+import type * as PluginType from '../typing';
+export declare function updateGuideLineModeItemByData(options: {
+    item: GuideLineModeItem;
+    data: PluginType.GuideLineItem;
+    mode: PluginType.GuideLineModeItemMode;
+}): void;

package/dist/base/BasePlugin.d.ts

@@ -95,6 +95,7 @@ declare abstract class Controller<PluginState extends State, PluginEventMap exte
      * @param options 配置项
      */
     setState?(state: Partial<PluginState>, options?: BaseOptions): void;
+    isAbsoluteURL(url: string): string;
     /**
      * 启用插件，让插件能够响应交互
      */