model-action 1.0.23 → 2.0.0

package/src/modules/Track.ts

@@ -4,61 +4,290 @@
 /**
  * 轨迹方法
  */
-import { Action, IdList, LocationList, SendParam } from "./Action";
+import { Action, SendParam } from "./Action";
 
 
-type TrackActionType = 'getRoadNet' | 'remove' | 'add'
-type TrackType = {
-    action: TrackActionType,
-    pathId?: string,         //自定义轨迹ID
-    rnId?: string,           //路网ID
-    roadNet?: string,        //路网信息
-    type?: string,
-    data?: LocationList | IdList
-} & SendParam
+type TrackActionType = 'getRoadNet' | 'remove' | 'add' | 'show' | 'hide' | 'updateMovingParam' | 'start' | 'stop' | 'restart' | 'beginEdit' | 'endEdit'
+
+// 路径模块类型
+export type PathModuleType = 'Edit' | 'PathTracer'
+
+// 角色类型
+export type RolerType = 'Person' | 'Camera' | 'UAV'
+
+// 绘制方式
+export type PathDrawBaseType = 'BaseOnRoadNet' | 'BaseOnPathEditInfo'
+
+// 路径样式类型
+export type PathStyleType = 'Arrow' | string
+
+// 沿路径移动参数
+export interface RolerMoveParam {
+    rolerMoveAlongPath?: boolean;  // 是否有模型跟随线走，默认false
+    rolerType?: RolerType;         // 角色类型，默认是 Camera
+    viewFollow?: boolean;           // 是否视角跟随，默认false
+    moveSpeed?: number;             // 移动速度
+    pauseAtPoint?: boolean;         // 到达一个点是否需要停在那里
+}
+
+// 路径样式
+export interface PathStyle {
+    color: string;                  // 颜色，格式如 "FFFFFFFF"
+    styleType: PathStyleType;      // 样式风格
+    width: number;                  // 路径宽度
+}
+
+// 路径点
+export interface PathPoint {
+    id: string;
+}
+
+// 路径编辑参数
+export interface PathEditParam {
+    searchRangeAtPathPoint?: number;  // 取点后，搜索的范围半径，单位（米）
+    searchDeviceType?: string;         // 取点后，需要参与搜索的设备类型。为空值或者不传，搜索所有的设备类型
+}
+
+// 轨迹添加的 data 结构
+interface TrackAddData {
+    action: 'add';
+    pathId: string;                 // 自定义轨迹ID
+    pathDrawBaseType: PathDrawBaseType;  // 绘制方式
+    roadNetId?: string;             // 路网ID，BaseOnRoadNet时需要
+    rolerMoveParam?: RolerMoveParam;    // 沿路径移动的信息
+    pathStyle?: PathStyle;          // 路径样式
+    points: PathPoint[];            // 路径点数组
+}
+
+type TrackType = SendParam & {
+    cmd: "path";
+    data: {
+        action: TrackActionType;
+        [key: string]: any;
+    };
+}
 
 export class TrackAction extends Action {
     /**
-     * 清除轨迹
-     * @param {*} pathId 自定义轨迹ID
+     * 请求三维绘制路径
+     * @param pathId 自定义轨迹ID，后面删除的时候用，如果之前有编辑路径，这里就使用编辑路径的时候传入的路径 pathId
+     * @param pathDrawBaseType 绘制方式：BaseOnRoadNet 基于路网，使用C++寻路；BaseOnPathEditInfo 基于编辑路径生成的点画路径，不基于路网
+     * @param points 路径点数组
+     * @param roadNetId 路网的ID，pathDrawBaseType = BaseOnRoadNet的时候，需要传值，如果场景就一个路网，也可以不用传
+     * @param rolerMoveParam 沿路径移动的信息
+     * @param pathStyle 路径样式
      */
-    static trackRemove(pathId: TrackType['pathId'] = "CameraTrack") {
+    static trackAdd(
+        pathId: string,
+        pathDrawBaseType: PathDrawBaseType,
+        points: PathPoint[],
+        roadNetId?: string,
+        rolerMoveParam?: RolerMoveParam,
+        pathStyle?: PathStyle
+    ) {
+        const data: TrackAddData = {
+            action: "add",
+            pathId,
+            pathDrawBaseType,
+            points,
+        };
+
+        // 如果绘制方式是基于路网，且提供了路网ID，则添加
+        if (pathDrawBaseType === 'BaseOnRoadNet' && roadNetId) {
+            data.roadNetId = roadNetId;
+        }
+
+        // 如果提供了沿路径移动参数，则添加
+        if (rolerMoveParam) {
+            data.rolerMoveParam = rolerMoveParam;
+        }
+
+        // 如果提供了路径样式，则添加
+        if (pathStyle) {
+            data.pathStyle = pathStyle;
+        }
+
         const param: TrackType = {
             cmd: "path",
-            action: "remove",
+            data
+        };
+        this.sendParam(param, '请求三维绘制路径')
+    }
+
+    /**
+     * 显隐销毁路径
+     * @param action 操作类型：show 显示 | hide 隐藏 | remove 删除
+     * @param pathId 自定义轨迹ID，同前面，自定义的ID
+     * @param module 显隐、删除哪一部分：Edit 编辑的部分 | PathTracer 根据设备点动态生成的路径部分，如果不传，则整个显隐或者删除
+     */
+    static trackShowHideRemove(
+        action: 'show' | 'hide' | 'remove',
+        pathId: string,
+        module?: PathModuleType
+    ) {
+        const data: {
+            action: 'show' | 'hide' | 'remove';
+            pathId: string;
+            module?: PathModuleType;
+        } = {
+            action,
             pathId
         };
-        this.sendParam(param, '删除指定轨迹线');
+
+        // 如果提供了模块类型，则添加
+        if (module) {
+            data.module = module;
+        }
+
+        const param: TrackType = {
+            cmd: "path",
+            data
+        };
+        
+        const actionMap = {
+            show: '显示路径',
+            hide: '隐藏路径',
+            remove: '删除路径'
+        };
+        this.sendParam(param, actionMap[action])
+    }
+
+    /**
+     * 移动中更新移动参数
+     * @param pathId 自定义轨迹ID
+     * @param rolerMoveParam 沿路径移动的参数
+     */
+    static trackUpdateMovingParam(
+        pathId: string,
+        rolerMoveParam: RolerMoveParam
+    ) {
+        const data: {
+            action: 'updateMovingParam';
+            pathId: string;
+            rolerMoveParam: RolerMoveParam;
+        } = {
+            action: 'updateMovingParam',
+            pathId,
+            rolerMoveParam
+        };
+
+        const param: TrackType = {
+            cmd: "path",
+            data
+        };
+        this.sendParam(param, '更新移动参数')
+    }
+
+    /**
+     * 在生成的路径上面移动 - 开始移动
+     * @param action 操作类型：start 开始移动
+     * @param pathId 自定义轨迹ID
+     * @param rolerMoveParam 沿路径移动的参数
+     */
+    static trackMove(action: 'start', pathId: string, rolerMoveParam: RolerMoveParam): void;
+    /**
+     * 在生成的路径上面移动 - 停止或重启
+     * @param action 操作类型：stop 停止移动 | restart 重启移动
+     */
+    static trackMove(action: 'stop' | 'restart'): void;
+    /**
+     * 在生成的路径上面移动
+     * @param action 操作类型：start 开始移动 | stop 停止移动 | restart 重启移动
+     * @param pathId 自定义轨迹ID（仅 start 时需要）
+     * @param rolerMoveParam 沿路径移动的参数（仅 start 时需要）
+     */
+    static trackMove(
+        action: 'start' | 'stop' | 'restart',
+        pathId?: string,
+        rolerMoveParam?: RolerMoveParam
+    ) {
+        const data: {
+            action: 'start' | 'stop' | 'restart';
+            pathId?: string;
+            rolerMoveParam?: RolerMoveParam;
+        } = {
+            action
+        };
+
+        // start 操作需要 pathId 和 rolerMoveParam
+        if (action === 'start') {
+            if (!pathId || !rolerMoveParam) {
+                throw new Error('start 操作需要提供 pathId 和 rolerMoveParam');
+            }
+            data.pathId = pathId;
+            data.rolerMoveParam = rolerMoveParam;
+        }
+        // stop 和 restart 不需要 pathId 和 rolerMoveParam
+
+        const param: TrackType = {
+            cmd: "path",
+            data
+        };
+        
+        const actionMap = {
+            start: '开始移动',
+            stop: '停止移动',
+            restart: '重启移动'
+        };
+        this.sendParam(param, actionMap[action])
     }
 
     /**
-     * 获取三维路网坐标
-     * @param {*} data
-     * @param {*} rnId 路网ID
+     * 开启路径编辑
+     * @param pathId 自定义轨迹ID，前端配置界面提供数据，为空或者不传，UE自动生成一个
+     * @param pathName 路径名称，前端配置界面提供数据，非必须
+     * @param pathEditParam 路径编辑参数，前端配置界面提供数据
      */
-    static trackGetRoadNet(data: TrackType['data'], rnId: TrackType['rnId'] = 'RN-1') {
+    static trackBeginEdit(
+        pathId?: string,
+        pathName?: string,
+        pathEditParam?: PathEditParam
+    ) {
+        const data: {
+            action: 'beginEdit';
+            pathId?: string;
+            pathName?: string;
+            pathEditParam?: PathEditParam;
+        } = {
+            action: 'beginEdit'
+        };
+
+        // 如果提供了 pathId，则添加
+        if (pathId) {
+            data.pathId = pathId;
+        }
+
+        // 如果提供了 pathName，则添加
+        if (pathName) {
+            data.pathName = pathName;
+        }
+
+        // 如果提供了 pathEditParam，则添加
+        if (pathEditParam) {
+            data.pathEditParam = pathEditParam;
+        }
+
         const param: TrackType = {
             cmd: "path",
-            action: "getRoadNet",
-            rnId,
             data
         };
-        this.sendParam(param, '获取三维路网坐标')
+        this.sendParam(param, '开启路径编辑')
     }
 
     /**
-     * 请求三维绘制路网
-     * @param {*} data
-     * @param {*} pathId 自定义轨迹ID
+     * 停止路径编辑
      */
-    static trackPath(data: TrackType['data'], pathId: TrackType['pathId'] = "CameraTrack") {
+    static trackEndEdit() {
+        const data: {
+            action: 'endEdit';
+        } = {
+            action: 'endEdit'
+        };
+
         const param: TrackType = {
             cmd: "path",
-            action: "add",
-            pathId,
-            type: "BaseOnRoadNet",
             data
         };
-        this.sendParam(param, '请求三维绘制路径')
+        this.sendParam(param, '停止路径编辑')
     }
 }

package/src/modules/VideoFusion.ts

@@ -1,122 +0,0 @@
-
-
-/**
- * 视频融合方法
- */
-import { Action, IdList, LocationList, SendParam } from "./Action";
-
-type VideoFusionActionType = 'init' | 'flyTo' | 'start' | 'stop' | 'pause' | 'resume' | 'refresh'
-type VideoFusionType = {
-    action: VideoFusionActionType,
-    token?: string,
-    ip?: string,
-    port?: string,
-    isHttps?: boolean,
-    id?: string,
-    fov?: number,        //视场角
-    backPlay?: boolean,
-    ids?: IdList,
-    isLocation?: boolean,    //是否定位到第一个点，true=定位到第一个，false=不定位
-    videoType?: 'Video' | 'Record',  //Video:实时流，Record：录像，默认实时流 Video
-    recordType?: 'Cloud' | 'Device',//     Cloud:中心录像，Device：设备录像，默认中心录像 Cloud，videoType为 Record 时有效
-} & SendParam
-
-
-export class VideoFusionAction extends Action {
-    /**
-     * 视频融合初始化
-     * @param {*} token TOKEN
-     * @param {*} ip IP
-     * @param {*} port 端口
-     * @param {*} token TOKEN
-     * @param {*} isHttps 是否https
-     */
-    static videoFusionInit(token: VideoFusionType['token'], ip: VideoFusionType['ip'], port: VideoFusionType['port'] = '1998', isHttps: VideoFusionType['isHttps'] = false) {
-        const param: VideoFusionType = {
-            cmd: "videoFusion",
-            action: "init",
-            token,
-            ip,
-            port,
-            isHttps,
-        };
-        this.sendParam(param, '视频融合初始化')
-    }
-
-    /**
-     * 飞行到视频融合点位
-     * @param {*} id 点ID
-     * @param {*} fov 视场角
-     */
-    static videoFusionFlyTo(id: VideoFusionType['id'], fov: VideoFusionType['fov']) {
-        const param: VideoFusionType = {
-            cmd: "videoFusion",
-            action: "flyTo",
-            id,
-            fov,
-        };
-        this.sendParam(param, `飞行到视频融合点位【${id}】`)
-    }
-
-    /**
-     * 开启视频融合
-     * @param {*} ids id列表
-     * @param {*} isLocation 是否定位到第一个点。 true = 定位第一个， false = 不定位
-     * @param {*} backPlay
-     * @param {*} videoType Video:实时流，Record：录像，默认实时流 Video
-     */
-    static videoFusionStart(ids: VideoFusionType['ids'], isLocation: boolean = false, backPlay: boolean = false, videoType: 'Video' | 'Record' = 'Video') {
-        const param: VideoFusionType = {
-            cmd: "videoFusion",
-            action: "start",
-            isLocation,
-            videoType,
-            backPlay,
-            ids,
-        };
-        this.sendParam(param, '开启视频融合')
-    }
-
-    /**
-     * 关闭视频融合
-     * @param {*} ids id列表
-     * @param {*} isLocation 是否定位到第一个点。 true = 定位第一个， false = 不定位
-     * @param {*} backPlay
-     * @param {*} videoType Video:实时流，Record：录像，默认实时流 Video
-     */
-    static videoFusionStop(ids: VideoFusionType['ids'], isLocation: boolean = false, backPlay: boolean = false, videoType: 'Video' | 'Record' = 'Video') {
-        const param: VideoFusionType = {
-            cmd: "videoFusion",
-            action: "stop",
-            isLocation,
-            videoType,
-            backPlay,
-            ids,
-        };
-        this.sendParam(param, '关闭视频融合')
-    }
-
-    /**
-     * 刷新视频融合
-     * @param {*} token TOKEN
-     */
-    static videoFusionRefresh(token: VideoFusionType['token']) {
-        const param: VideoFusionType = {
-            cmd: "videoFusion",
-            action: "refresh",
-            token,
-        };
-        this.sendParam(param, '刷新视频融合')
-    }
-
-    /**
-     * 获取融合点位列表
-     */
-    static videoFusionList() {
-        const param = {
-            cmd: "videoFusion",
-            action: "get",
-        };
-        this.sendParam(param, '获取视频融合点位列表')
-    }
-}

package/src/modules/Window.ts

@@ -1,40 +0,0 @@
-
-/**
- * 点POI打开外部弹窗
- * 用来让UE抛出POI位置
- */
-import { Action, } from "./Action";
-
-export class WindowAction extends Action {
-    /**
-      * 打开外部弹窗
-      * @param {*} attendId (必须）弹框的三维物体的唯一ID)
-      */
-    static openOut(attendId: string) {
-        const param: any = {
-            cmd: "window",
-            data: {
-                action: 'pop',
-                type: 'builtOut',
-                attendId,
-            }
-        };
-        this.sendParam(param, '打开外部弹窗')
-    }
-
-    /**
-     * 关闭外部弹窗
-     * @param {*} attendId (必须）弹框的三维物体的唯一ID)
-     */
-    static closeOut(attendId: string) {
-        const param: any = {
-            cmd: "window",
-            data: {
-                action: 'remove',
-                type: 'builtOut',
-                attendId,
-            }
-        };
-        this.sendParam(param, '关闭外部弹窗')
-    }
-}