model-action 2.0.0 → 2.0.3

package/src/modules/{Track.ts → Path.ts}

@@ -2,12 +2,15 @@
 
 
 /**
- * 轨迹方法
+ * 路径方法
  */
 import { Action, SendParam } from "./Action";
 
 
-type TrackActionType = 'getRoadNet' | 'remove' | 'add' | 'show' | 'hide' | 'updateMovingParam' | 'start' | 'stop' | 'restart' | 'beginEdit' | 'endEdit'
+// 路径的用途
+type PathPublicUsedType = 'Normal' | 'Person' | 'Car'
+
+type PathActionType = 'getRoadNet' | 'remove' | 'add' | 'show' | 'hide' | 'updateMovingParam' | 'start' | 'stop' | 'restart' | 'beginEdit' | 'endEdit'
 
 // 路径模块类型
 export type PathModuleType = 'Edit' | 'PathTracer'
@@ -49,9 +52,10 @@ export interface PathEditParam {
 }
 
 // 轨迹添加的 data 结构
-interface TrackAddData {
+interface PathAddData {
     action: 'add';
     pathId: string;                 // 自定义轨迹ID
+    pathPublicUsedType?: PathPublicUsedType; // 路径的用途，默认 Normal
     pathDrawBaseType: PathDrawBaseType;  // 绘制方式
     roadNetId?: string;             // 路网ID，BaseOnRoadNet时需要
     rolerMoveParam?: RolerMoveParam;    // 沿路径移动的信息
@@ -59,35 +63,38 @@ interface TrackAddData {
     points: PathPoint[];            // 路径点数组
 }
 
-type TrackType = SendParam & {
+type PathType = SendParam & {
     cmd: "path";
     data: {
-        action: TrackActionType;
+        action: PathActionType;
         [key: string]: any;
     };
 }
 
-export class TrackAction extends Action {
+export class PathAction extends Action {
     /**
      * 请求三维绘制路径
      * @param pathId 自定义轨迹ID，后面删除的时候用，如果之前有编辑路径，这里就使用编辑路径的时候传入的路径 pathId
      * @param pathDrawBaseType 绘制方式：BaseOnRoadNet 基于路网，使用C++寻路；BaseOnPathEditInfo 基于编辑路径生成的点画路径，不基于路网
      * @param points 路径点数组
+     * @param pathPublicUsedType 路径的用途，默认 Normal
      * @param roadNetId 路网的ID，pathDrawBaseType = BaseOnRoadNet的时候，需要传值，如果场景就一个路网，也可以不用传
      * @param rolerMoveParam 沿路径移动的信息
      * @param pathStyle 路径样式
      */
-    static trackAdd(
+    static pathAdd(
         pathId: string,
         pathDrawBaseType: PathDrawBaseType,
         points: PathPoint[],
+        pathPublicUsedType?: PathPublicUsedType,
         roadNetId?: string,
         rolerMoveParam?: RolerMoveParam,
         pathStyle?: PathStyle
     ) {
-        const data: TrackAddData = {
+        const data: PathAddData = {
             action: "add",
             pathId,
+            pathPublicUsedType: pathPublicUsedType || 'Normal',
             pathDrawBaseType,
             points,
         };
@@ -107,7 +114,7 @@ export class TrackAction extends Action {
             data.pathStyle = pathStyle;
         }
 
-        const param: TrackType = {
+        const param: PathType = {
             cmd: "path",
             data
         };
@@ -120,7 +127,7 @@ export class TrackAction extends Action {
      * @param pathId 自定义轨迹ID，同前面，自定义的ID
      * @param module 显隐、删除哪一部分：Edit 编辑的部分 | PathTracer 根据设备点动态生成的路径部分，如果不传，则整个显隐或者删除
      */
-    static trackShowHideRemove(
+    static pathShowHideRemove(
         action: 'show' | 'hide' | 'remove',
         pathId: string,
         module?: PathModuleType
@@ -139,7 +146,7 @@ export class TrackAction extends Action {
             data.module = module;
         }
 
-        const param: TrackType = {
+        const param: PathType = {
             cmd: "path",
             data
         };
@@ -157,7 +164,7 @@ export class TrackAction extends Action {
      * @param pathId 自定义轨迹ID
      * @param rolerMoveParam 沿路径移动的参数
      */
-    static trackUpdateMovingParam(
+    static pathUpdateMovingParam(
         pathId: string,
         rolerMoveParam: RolerMoveParam
     ) {
@@ -171,7 +178,7 @@ export class TrackAction extends Action {
             rolerMoveParam
         };
 
-        const param: TrackType = {
+        const param: PathType = {
             cmd: "path",
             data
         };
@@ -184,19 +191,19 @@ export class TrackAction extends Action {
      * @param pathId 自定义轨迹ID
      * @param rolerMoveParam 沿路径移动的参数
      */
-    static trackMove(action: 'start', pathId: string, rolerMoveParam: RolerMoveParam): void;
+    static pathMove(action: 'start', pathId: string, rolerMoveParam: RolerMoveParam): void;
     /**
      * 在生成的路径上面移动 - 停止或重启
      * @param action 操作类型：stop 停止移动 | restart 重启移动
      */
-    static trackMove(action: 'stop' | 'restart'): void;
+    static pathMove(action: 'stop' | 'restart'): void;
     /**
      * 在生成的路径上面移动
      * @param action 操作类型：start 开始移动 | stop 停止移动 | restart 重启移动
      * @param pathId 自定义轨迹ID（仅 start 时需要）
      * @param rolerMoveParam 沿路径移动的参数（仅 start 时需要）
      */
-    static trackMove(
+    static pathMove(
         action: 'start' | 'stop' | 'restart',
         pathId?: string,
         rolerMoveParam?: RolerMoveParam
@@ -219,7 +226,7 @@ export class TrackAction extends Action {
         }
         // stop 和 restart 不需要 pathId 和 rolerMoveParam
 
-        const param: TrackType = {
+        const param: PathType = {
             cmd: "path",
             data
         };
@@ -238,7 +245,7 @@ export class TrackAction extends Action {
      * @param pathName 路径名称，前端配置界面提供数据，非必须
      * @param pathEditParam 路径编辑参数，前端配置界面提供数据
      */
-    static trackBeginEdit(
+    static pathBeginEdit(
         pathId?: string,
         pathName?: string,
         pathEditParam?: PathEditParam
@@ -267,7 +274,7 @@ export class TrackAction extends Action {
             data.pathEditParam = pathEditParam;
         }
 
-        const param: TrackType = {
+        const param: PathType = {
             cmd: "path",
             data
         };
@@ -277,14 +284,14 @@ export class TrackAction extends Action {
     /**
      * 停止路径编辑
      */
-    static trackEndEdit() {
+    static pathEndEdit() {
         const data: {
             action: 'endEdit';
         } = {
             action: 'endEdit'
         };
 
-        const param: TrackType = {
+        const param: PathType = {
             cmd: "path",
             data
         };