@realsee/dnalogel 2.25.0 → 2.26.0

package/dist/CruisePlugin/typing.d.ts

@@ -68,7 +68,7 @@ export interface MoveWithKeyframesAction extends MoveAction {
     /** for ts check, no care */
     panoIndexList?: undefined;
 }
-export interface PluginServerData extends BasePluginWithData.ServerData {
+export interface PluginServerData {
     data: MoveWithKeyframesAction | MoveWithPanoIndexAction;
 }
 export interface PluginState extends BasePluginWithData.State {

package/dist/GuideLinePlugin/typing.d.ts

@@ -20,7 +20,7 @@ export type PluginData = {
     routes?: Route[];
     config?: RouteConfig;
 };
-export interface PluginServerData extends BasePluginWithData.ServerData {
+export interface PluginServerData {
     data: PluginData;
 }
 export interface PluginState extends BasePluginWithData.State {

package/dist/PanoCompassPlugin/typings.d.ts

@@ -49,7 +49,7 @@ export interface EventMap extends BasePlugin.EventMap<State, PluginData> {
         userAction: boolean;
     }) => void;
 }
-export interface PluginServerData extends BasePlugin.ServerData {
+export interface PluginServerData {
     version: number;
     data: PluginData;
 }

package/dist/PipelinePlugin/Controller.d.ts

@@ -0,0 +1,108 @@
+import type { Five } from '@realsee/five';
+import type { State, EventMap, ServerData, PluginData, LoadOptions, ShowHideOptions, SetSpeedOptions, ShowPipelinesOptions } from './typing';
+import * as THREE from 'three';
+import * as BasePlugin from '../base/BasePluginWithData';
+import { ObjectFlowPipe } from './utils/Objects/FlowPipe';
+export declare class Controller extends BasePlugin.Controller<State, EventMap, ServerData.RootObject, PluginData.RootObject> {
+    data?: PluginData.RootObject;
+    /** 插件状态
+     * @property `visible` `<boolean>` 是否可见
+     * @property `enabled` `<boolean>` 是否启用
+     * @property `visiblePipeIDs` `<string[]>` 可见的管道 ID
+     * @property `speed` `<Speed>` 水流速度
+     * @property `speed.flowSpeed` `<number>` 横向流动速度，默认是 0.6 m/s
+     * @property `speed.rotateSpeed` `<number>` 纵向旋转速度：默认是 0 deg/s
+     */
+    state: State;
+    /** 当前插件所有新增 THREE 相关副作用都在 group 下 */
+    group: THREE.Group;
+    /** 用于展示水流的水管 */
+    pipeObjects: ObjectFlowPipe[];
+    /** 水管贴图缓存 */
+    private texturePromiseCache;
+    constructor(five: Five);
+    /** 加载管道数据，重复调用会使用新数据覆盖旧数据
+     * @param `data` `<Plugin.ServerData>` Open API 接口返回的数据。
+     * @param `initialState` `<Plugin.State> | <undefined>` 数据加载后，要应用的 state，默认是 undefined。
+     * @param `userAction` `<boolean> | <undefined>` 是否是用户操作，默认是 true。
+     * @param `options` `<Plugin.LoadOptions> | <undefined>` 数据加载配置项。
+     * @param `options.getPipeRadius` `<(pipe: ServerData.LinesDataset) => number> | <undefined>` 允许用户通过函数自定义管道半径。
+     * @param `options.getPipeUrl` `<(water: Water) => string> | <undefined>` 允许用户通过函数自定义管道贴图，
+     * 函数返回的 string 就是当前 water 对应的贴图地址。
+     */
+    load(data: ServerData.RootObject, initialState?: Partial<State>, userAction?: boolean, options?: Partial<LoadOptions>): Promise<void>;
+    /** 更改插件 State
+     * @param `state` `<Partial<Plugin.State>>` 插件属性 `state` 的子集。
+     * @param `options` `<Option> | <undefined>`
+     * @param `options.userAction` `<boolean> | <undefined>` 是否是用户操作。默认是 true。
+     */
+    setState(state: Partial<State>, options?: BasePlugin.BaseOptions): void;
+    /** 启用插件
+     * @param `options` `<Option> | <undefined>`
+     * @param `options.userAction` `<boolean> | <undefined>` 是否是用户操作。默认是 true。
+     */
+    enable(options?: BasePlugin.BaseOptions): void;
+    /** 禁用插件
+     * @param `options` `<Option> | <undefined>`
+     * @param `options.userAction` `<boolean> | <undefined>` 是否是用户操作。默认是 true。
+     */
+    disable(options?: BasePlugin.BaseOptions): void;
+    /** 展示管道模型，注意如果通过 `switchPipelines` 更改过 `visibleIDs`，则只会展示这一部分模型。
+     * @param `options` `<Partial<ShowHideOptions>> | <undefined>`
+     * @param `options.userAction` `<boolean> | <undefined>` 是否是用户操作。默认是 true。
+     * @param `options.anime` `<AnimeOptions> | <undefined>` 动画配置。
+     * @param `options.anime.duration` `<number> | <undefined>` 动画时间，默认是 500ms。
+     */
+    show(options?: Partial<ShowHideOptions>): Promise<void>;
+    /** 插件内容整体隐藏
+     * @param `options` `<Partial<ShowHideOptions>> | <undefined>`
+     * @param `options.userAction` `<boolean> | <undefined>` 是否是用户操作。默认是 true。
+     * @param `options.anime` `<AnimeOptions> | <undefined>` 动画配置。
+     * @param `options.anime.duration` `<number> | <undefined>` 动画时间，默认是 500ms。
+     */
+    hide(options?: Partial<ShowHideOptions>): Promise<void>;
+    /** 切换管路
+     * @param `options` `Partial<ShowPipelinesOptions> | <undefined>`
+     * @param `options.target` `<{ startLibraryID: number; endLibraryID: number }[]> | <undefined>`
+     * 目标管路，存在时，展示目标管路包含的管道，同时隐藏其他管道。不存在则展示所有管道。
+     * startLibraryID 和 endLibraryID 是起始和结束的设备 ID。
+     * @param `options.showAnime` `<AnimeOptions> | <undefined>` 展示的动画配置。
+     * @param `options.hideAnime` `<AnimeOptions> | <undefined>` 隐藏的动画配置。
+     * @param `options.anime` `<AnimeOptions> | <undefined>` 兜底的动画配置。
+     * @param `options.userAction` `<boolean> | <undefined>` 是否是否是用户操作。
+     * */
+    switchPipelines(options?: Partial<ShowPipelinesOptions>): Promise<void>;
+    /** 开始流动 */
+    flow(options?: BasePlugin.BaseOptions): void;
+    /** 停止流动 */
+    stopFlow(options?: BasePlugin.BaseOptions): void;
+    /** 更改水管流速
+     * @param `options` `<SetSpeedOptions> | <undefined>`
+     * @param `options.speed` `<Speed> | <undefined>` 参考 `state.speed` 的描述。
+     * @param `options.userAction` `<boolean> | <undefined>` 是否是否是用户操作。
+     */
+    setSpeed(options?: Partial<SetSpeedOptions>): void;
+    /** 销毁插件，移除所有副作用，销毁后将不响应任何 API */
+    dispose: () => void;
+    protected formatData(data: ServerData.RootObject, options?: Partial<LoadOptions>): Promise<PluginData.RootObject>;
+    private _enable;
+    private _disable;
+    private _show;
+    private _hide;
+    private _switchPipelines;
+    private _flow;
+    private _stopFlow;
+    private _setSpeed;
+    private updateState;
+    /** 加载管道贴图，如果再加载中，复用之前的加载 Promise */
+    private loadPipeTexture;
+    /** 销毁所有动画 */
+    private disposeAnime;
+    /** 移除所有管道模型 */
+    private removeAllPipes;
+    /** 根据 ID 查找管道模型 */
+    private findPipeObjectWithID;
+    /** 根据 target 查找管道模型 */
+    private findPipeObjectWithTarget;
+    private onWantsFiveTapGesture;
+}

package/dist/PipelinePlugin/index.d.ts

@@ -0,0 +1,6 @@
+import type { FivePlugin } from '@realsee/five';
+import { Controller } from './Controller';
+export declare const PipelinePlugin: FivePlugin<undefined, Controller>;
+export type PipelinePluginParameterType = undefined;
+export type PipelinePluginReturnType = InstanceType<typeof Controller>;
+export default PipelinePlugin;

package/dist/PipelinePlugin/typing/PluginData.d.ts

@@ -0,0 +1,20 @@
+export interface Water {
+    isHot: boolean;
+    quality: number;
+}
+export interface Pipe {
+    id: string;
+    path: number[][];
+    texture?: string;
+    radius: number;
+    water: Water;
+}
+export interface Pipeline {
+    startLibraryID: number;
+    endLibraryID: number;
+    pipes: Pipe[];
+}
+export interface RootObject {
+    pipelines: Pipeline[];
+    pipes: Pipe[];
+}

package/dist/PipelinePlugin/typing/ServerData.d.ts

@@ -0,0 +1,28 @@
+export interface LinesDataset {
+    id: string;
+    type: string;
+    name: string;
+    data: number[][];
+}
+export interface ConnectsDataset {
+    waterType: number;
+    start: number;
+    end: number;
+    data: string[];
+}
+export interface WaterTypeMap {
+    name: string;
+    type: number;
+}
+export interface ModelMap {
+    library: number;
+    name: string;
+}
+/** LinesDataset 的别名 */
+export type PipeItem = LinesDataset;
+export interface RootObject {
+    LinesDataset: LinesDataset[];
+    ConnectsDataset: ConnectsDataset[];
+    WaterTypeMap: WaterTypeMap[];
+    ModelMap: ModelMap[];
+}

package/dist/PipelinePlugin/typing/index.d.ts

@@ -0,0 +1,79 @@
+import type * as THREE from 'THREE';
+import type * as PluginData from './PluginData';
+import type * as ServerData from './ServerData';
+import type * as BasePlugin from '../../base/BasePluginWithData';
+import type { EventCallback } from '@realsee/five';
+import type { AnimeOptions } from '../utils/Objects/Pipe';
+export interface PipelineTargetItem {
+    startLibraryID: number;
+    endLibraryID: number;
+}
+export interface State extends BasePlugin.State {
+    enabled: boolean;
+    visible: boolean;
+    isFlowing: boolean;
+    speed: Speed;
+    target: null | PipelineTargetItem[];
+}
+export interface LoadOptions {
+    /** 获取管道半径，单位是 m。默认是 0.016 m */
+    getPipeRadius: (pipe: ServerData.LinesDataset) => number;
+    /** 自定义不同水质的贴图 */
+    getPipeUrl: <T extends PluginData.Water>(water: T) => string;
+}
+export interface EventMap extends BasePlugin.EventMap<State, PluginData.RootObject> {
+    /** visible 从 false 到 true 的回调
+     * @param event.userAction 是否是用户操作
+     */
+    show: (event: {
+        userAction: boolean;
+    }) => void;
+    /** visible 从 true 到 false 的回调
+     * @param event.userAction 是否是用户操作
+     */
+    hide: (event: {
+        userAction: boolean;
+    }) => void;
+    /** enabled 从 false 到 true 的回调
+     * @param event.userAction 是否是用户操作
+     */
+    enable: (event: {
+        userAction: boolean;
+    }) => void;
+    /** enabled 从 true 到 false 的回调
+     * @param event.userAction 是否是用户操作
+     */
+    disable: (event: {
+        userAction: boolean;
+    }) => void;
+    tap: (data: {
+        pipe: PluginData.Pipe;
+        pipeline: PluginData.Pipeline;
+        intersectObjects: THREE.Intersection[];
+        wantsFiveTapGestureParams: Parameters<EventCallback['wantsTapGesture']>;
+    }) => any;
+}
+export interface ShowHideOptions {
+    userAction: boolean;
+    anime: AnimeOptions;
+}
+export interface ShowPipelinesOptions {
+    userAction: boolean;
+    showAnime: AnimeOptions;
+    hideAnime: AnimeOptions;
+    anime: AnimeOptions;
+    target: PipelineTargetItem[];
+}
+/** 流速 */
+export interface Speed {
+    /** 横向流速：m/s */
+    flowSpeed?: number;
+    /** 纵向旋转速度：deg/s */
+    rotateSpeed?: number;
+}
+export interface SetSpeedOptions {
+    speed: Speed;
+    userAction: boolean;
+}
+export * as ServerData from './ServerData';
+export * as PluginData from './PluginData';

package/dist/PipelinePlugin/utils/Objects/FlowPipe.d.ts

@@ -0,0 +1,34 @@
+import type { PipeParams as BasePipeParams } from './Pipe';
+import { ObjectPipe } from './Pipe';
+export type PipeParams = BasePipeParams;
+export declare class ObjectFlowPipe extends ObjectPipe {
+    /** 初始状态下，当前水管内的水流在整体管道上的位移
+     * @description 因为水管是不连续的，而要达到水流的连续效果，需要用过贴图的 uOffset 控制每根水管的初始状态
+     */
+    private initialDisplacement;
+    private oldTime;
+    /** 横向流动速度：m / s */
+    private flowSpeed;
+    /** 纵向旋转速度：deg / s */
+    private rotateSpeed;
+    constructor(params: PipeParams);
+    setInitialDisplacement(distance: number, direction?: 'forward' | 'backward'): void;
+    /** 水流移动「基于初始位置」
+     * @description 因为贴图的运动与 u 的 uOffset 相反，比较反直觉，所以封装方法易于理解
+     * @param displacement 位移：米 * 方向(向前 -> 正, 向后 -> 负)
+     */
+    moveFromOrigin(displacement: number): boolean;
+    /** 水流移动「基于调整管道差值之后的位置」
+     *
+     * @param distance 位移：米 * 方向
+     */
+    moveForwardFromInitialOffset(distance: number): void;
+    flow(): void;
+    stopFlow(): void;
+    setSpeed(speed?: {
+        flowSpeed?: number;
+        rotateSpeed?: number;
+    }): void;
+    disposeAnime(): void;
+    private flowAnimationDisposer;
+}

package/dist/PipelinePlugin/utils/Objects/Pipe.d.ts

@@ -0,0 +1,49 @@
+import * as THREE from 'three';
+import { BetterTween } from '../../../shared-utils';
+import { CustomBezierCurve3 } from '../../../shared-utils/three/Extras/Curves/BezierCurve3';
+export interface PipeParams {
+    id?: string;
+    path: number[][];
+    texture: THREE.Texture;
+    geometryConfig?: {
+        radius?: number;
+        radialSegments?: number;
+        tubularSegments?: number;
+    };
+}
+export interface AnimeOptions {
+    duration?: number;
+}
+export declare class ObjectPipe extends THREE.Mesh<THREE.TubeBufferGeometry, THREE.ShaderMaterial> {
+    /** 根据控制点数量计算管道路径
+     *
+     * @description 两个控制点使用直线路径，多个控制点使用贝塞尔路径
+     */
+    static calculatePath(points: THREE.Vector3[]): THREE.LineCurve3 | CustomBezierCurve3;
+    static formatGeometryUV<T extends THREE.BufferGeometry>(geometry: T, pathLength: number, uPreMeter: number): T;
+    /**
+     * 管道的 Texture 需要满足一定的要求，需要使用 formatTexture 先 format
+     */
+    static formatTexture(texture: THREE.Texture): THREE.Texture;
+    geometryConfig: {
+        radius: number;
+        tubularSegments: number;
+        radialSegments: number;
+    };
+    customID: string;
+    path: THREE.LineCurve3 | CustomBezierCurve3;
+    pathLength: number;
+    pathPoints: number[][];
+    texture: THREE.Texture;
+    protected opacityAnime?: BetterTween<{
+        progress: number;
+    }>;
+    /** u / m: 每米水管对应到贴图上，应该对应的 u 的长度 */
+    protected uPreMeter: number;
+    constructor(params: PipeParams, fragmentShader?: string);
+    hide(options?: AnimeOptions): Promise<boolean>;
+    show(options?: AnimeOptions): Promise<boolean>;
+    setOpacity(value: number): boolean;
+    disposeAnime(): void;
+    dispose(): void;
+}

package/dist/PipelinePlugin/utils/formatData.d.ts

@@ -0,0 +1,12 @@
+import type { PluginData, ServerData, LoadOptions } from '../typing';
+/** 从 PluginData 中找到符合「从 ID 为 startLibraryID 的设备到 ID 为 endLibraryID 的设备」的 pipe data */
+export declare function getPipesFromLibrary(params: {
+    data: PluginData.RootObject;
+    target: {
+        startLibraryID: number;
+        endLibraryID: number;
+    }[];
+}): PluginData.Pipe[];
+/** 获取默认的管道贴图 */
+export declare function getDefaultPipeUrl<T extends PluginData.Water>(water: T): string | undefined;
+export declare function format(origin: ServerData.RootObject, options?: Partial<LoadOptions>): PluginData.RootObject;

package/dist/base/BasePluginWithData.d.ts

@@ -7,20 +7,7 @@ interface EventMap<PluginState, PluginData> extends BasePlugin.EventMap<PluginSt
     /** 数据加载完成 */
     dataLoaded: (data: PluginData) => void;
 }
-/**
- * 插件的基础数据
- */
-interface ServerData {
-    /**
-     * 数据版本
-     */
-    version: number;
-    /**
-     * 数据
-     */
-    data?: unknown;
-}
-declare abstract class Controller<PluginState extends State, PluginEventMap extends EventMap<PluginState, PluginData>, PluginServerData extends ServerData, PluginData> extends BasePlugin.Controller<PluginState, PluginEventMap> {
+declare abstract class Controller<PluginState extends State, PluginEventMap extends EventMap<PluginState, PluginData>, PluginServerData, PluginData> extends BasePlugin.Controller<PluginState, PluginEventMap> {
     protected abstract data?: PluginData;
     /**
      * 加载插件依赖数据
@@ -31,5 +18,6 @@ declare abstract class Controller<PluginState extends State, PluginEventMap exte
     /** 把原始数据转化为插件数据 */
     protected abstract formatData?(serverData: PluginServerData): Promise<PluginData>;
 }
-export type { State, EventMap, ServerData, Config };
+export type { State, EventMap, Config };
+export type { BaseOptions } from './BasePlugin';
 export { Controller };

package/dist/floorplan/PanoFloorplanRadarPlugin/typing.d.ts

@@ -47,7 +47,7 @@ export interface Parameters extends Partial<Config> {
         cameraImageUrl?: string;
     };
 }
-export interface PluginServerData extends BasePlugin.ServerData {
+export interface PluginServerData {
     version: number;
     data: FloorplanServerData;
 }

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

@@ -60,7 +60,7 @@ export interface Parameters extends Partial<Config> {
     selector?: string | Element;
     scale?: number;
 }
-export interface PluginServerData extends BasePlugin.ServerData {
+export interface PluginServerData {
     version: number;
     data: FloorplanServerData;
 }