model-action 1.0.24 → 2.0.2

package/src/modules/Effect.ts

@@ -0,0 +1,127 @@
+/**
+ * 效果控制操作方法
+ */
+import { Action, SendParam } from "./Action";
+
+// 效果类型
+export type EffectType = 
+    | 'Elevator'           // 电梯效果
+    | 'PowerUsed'          // 能耗管理
+    | 'P'                  // 停车场
+    | 'ElectronicFence'    // 电子围栏
+    | 'MeetingRoom'        // 会议室盒子
+    | 'Pipe'               // 管线
+    | 'RoomArea'           // 房间区域盒子
+    | 'EscapeRoute'        // 逃生路线
+    | 'PeopleRoute'        // 人员轨迹
+    | 'Area'               // 区域效果
+    | string;              // 允许其他自定义类型
+
+// 效果操作类型
+export type EffectActionType = '1' | '0';  // '1' = 显示, '0' = 隐藏
+
+// 效果参数
+export interface EffectParam {
+    action: EffectActionType;
+    type: EffectType;
+    place: string;                    // 效果所在的位置，项目约定
+    extraContent?: Record<string, any>; // 补充内容，非必须，项目预定
+}
+
+// 效果模块类型
+type EffectModuleType = SendParam & {
+    cmd: "effect";
+    data: EffectParam;
+}
+
+export class EffectAction extends Action {
+    /**
+     * 显示效果
+     * @param type 效果类型，如 "Elevator"、"PowerUsed"、"P" 等
+     * @param place 效果所在的位置，项目约定，如 "ZHL"、"A"、"ZHL-1F" 等
+     * @param extraContent 补充内容，非必须
+     */
+    static show(
+        type: EffectType,
+        place: string,
+        extraContent?: Record<string, any>
+    ) {
+        const data: EffectParam = {
+            action: '1',
+            type,
+            place
+        };
+
+        if (extraContent) {
+            data.extraContent = extraContent;
+        }
+
+        const param: EffectModuleType = {
+            cmd: "effect",
+            data
+        };
+
+        this.sendParam(param, `显示效果 - type: ${type}, place: ${place}`);
+    }
+
+    /**
+     * 隐藏效果
+     * @param type 效果类型，如 "Elevator"、"PowerUsed"、"P" 等
+     * @param place 效果所在的位置，项目约定，如 "ZHL"、"A"、"ZHL-1F" 等
+     * @param extraContent 补充内容，非必须
+     */
+    static hide(
+        type: EffectType,
+        place: string,
+        extraContent?: Record<string, any>
+    ) {
+        const data: EffectParam = {
+            action: '0',
+            type,
+            place
+        };
+
+        if (extraContent) {
+            data.extraContent = extraContent;
+        }
+
+        const param: EffectModuleType = {
+            cmd: "effect",
+            data
+        };
+
+        this.sendParam(param, `隐藏效果 - type: ${type}, place: ${place}`);
+    }
+
+    /**
+     * 通用效果控制方法
+     * @param action 操作类型：'1' = 显示，'0' = 隐藏
+     * @param type 效果类型
+     * @param place 效果所在的位置
+     * @param extraContent 补充内容，非必须
+     */
+    static control(
+        action: EffectActionType,
+        type: EffectType,
+        place: string,
+        extraContent?: Record<string, any>
+    ) {
+        const data: EffectParam = {
+            action,
+            type,
+            place
+        };
+
+        if (extraContent) {
+            data.extraContent = extraContent;
+        }
+
+        const param: EffectModuleType = {
+            cmd: "effect",
+            data
+        };
+
+        const actionText = action === '1' ? '显示' : '隐藏';
+        this.sendParam(param, `${actionText}效果 - type: ${type}, place: ${place}`);
+    }
+}

package/src/modules/Environment.ts

@@ -0,0 +1,81 @@
+/**
+ * 场景环境操作方法
+ */
+import { Action, SendParam } from "./Action";
+
+type EnvironmentActionType = 'DayNight' | 'Weather' | 'Time'
+
+type EnvironmentType = SendParam & {
+    cmd: "environment";
+    data: {
+        action: EnvironmentActionType;
+        type: string;
+        [key: string]: any;
+    };
+}
+
+export class EnvironmentAction extends Action {
+    /**
+     * 昼夜切换
+     * @param type 0 = 白天，1 = 夜晚
+     */
+    static dayNight(type: "0" | "1") {
+        const data: {
+            action: 'DayNight';
+            type: string;
+        } = {
+            action: 'DayNight',
+            type
+        };
+
+        const param: EnvironmentType = {
+            cmd: "environment",
+            data
+        };
+        
+        const dayNightDesc = type === '0' ? '白天' : '夜晚';
+        this.sendParam(param, `昼夜切换 - ${dayNightDesc}`)
+    }
+
+    /**
+     * 天气切换
+     * @param type 天气类型：晴、阴、小雨、大雨、小雪、大雪、雾
+     */
+    static weather(type: string) {
+        const data: {
+            action: 'Weather';
+            type: string;
+        } = {
+            action: 'Weather',
+            type
+        };
+
+        const param: EnvironmentType = {
+            cmd: "environment",
+            data
+        };
+        
+        this.sendParam(param, `天气切换 - ${type}`)
+    }
+
+    /**
+     * 时间切换
+     * @param type 时间格式，如 "12:00"
+     */
+    static time(type: string) {
+        const data: {
+            action: 'Time';
+            type: string;
+        } = {
+            action: 'Time',
+            type
+        };
+
+        const param: EnvironmentType = {
+            cmd: "environment",
+            data
+        };
+        
+        this.sendParam(param, `时间切换 - ${type}`)
+    }
+}

package/src/modules/Focus.ts

@@ -0,0 +1,33 @@
+/**
+ * 聚焦操作方法
+ */
+import { Action } from "./Action";
+
+type FocusType = {
+    cmd: "focus";
+    data: {
+        id: string;
+    };
+}
+
+export class FocusAction extends Action {
+    /**
+     * 飞到指定ID的物体附近
+     * @param id 物体的ID（如POI、模型等）
+     */
+    static focus(id: string) {
+        const data: {
+            id: string;
+        } = {
+            id
+        };
+
+        const param: FocusType = {
+            cmd: "focus",
+            data
+        };
+
+        // 注意：focus 命令不需要 action 字段，直接发送参数
+        this.sendParam(param as any, `飞到指定物体附近 - id: ${id}`);
+    }
+}

package/src/modules/GameMode.ts

@@ -0,0 +1,60 @@
+/**
+ * 游戏模式切换
+ */
+import { Action, SendParam } from "./Action";
+
+// 游戏模式类型
+export type GameMode = 'Normal' | 'Edit' | 'Measure';
+
+// 模式操作类型
+type GameModeActionType = 'set' | 'get';
+
+type GameModeParamType = SendParam & {
+    cmd: "gameMode";
+    data: {
+        action: GameModeActionType;
+        mode?: GameMode;
+    };
+}
+
+export class GameModeAction extends Action {
+    /**
+     * 切换游戏模式
+     * @param mode 游戏模式：Normal(普通模式) | Edit(编辑模式) | Measure(绘制模式)
+     */
+    static setMode(mode: GameMode) {
+        const data: {
+            action: 'set';
+            mode: GameMode;
+        } = {
+            action: 'set',
+            mode
+        };
+
+        const param: GameModeParamType = {
+            cmd: "gameMode",
+            data
+        };
+
+        const modeDesc = mode === 'Normal' ? '普通模式' : mode === 'Edit' ? '编辑模式' : '绘制模式';
+        this.sendParam(param, `切换游戏模式 - ${modeDesc}`);
+    }
+
+    /**
+     * 获取当前游戏模式
+     */
+    static getMode() {
+        const data: {
+            action: 'get';
+        } = {
+            action: 'get'
+        };
+
+        const param: GameModeParamType = {
+            cmd: "gameMode",
+            data
+        };
+
+        this.sendParam(param, '获取当前游戏模式');
+    }
+}

package/src/modules/Init.ts

@@ -0,0 +1,104 @@
+/**
+ * 视频初始化操作方法
+ */
+import { Action } from "./Action";
+// 导入 peer-stream.js 以确保自定义元素在使用前被注册
+import "../peer-stream.js";
+
+// 初始化配置选项
+export interface InitVideoOptions {
+    /** 视频容器元素（DOM元素或ref） */
+    container: HTMLElement;
+    /** WebSocket连接地址 */
+    wsUrl: string;
+    /** 消息回调函数 */
+    onMessage?: (data: any) => void;
+    /** 播放开始回调函数 */
+    onPlaying?: () => void;
+    /** 排队人数变化回调函数 */
+    onQueueChange?: (seq: number) => void;
+    /** 视频元数据加载完成回调函数 */
+    onLoadedMetadata?: () => void;
+}
+
+export class InitAction extends Action {
+    /**
+     * 初始化视频流
+     * @param options 初始化配置选项
+     * @returns HTMLVideoElement 返回创建的video元素
+     */
+    static initVideo(options: InitVideoOptions): HTMLVideoElement {
+        // 创建 peer-stream video 元素
+        const ps = document.createElement("video", { is: "peer-stream" }) as any;
+
+        // 设置样式
+        ps.style.width = "100%";
+        ps.style.height = "100%";
+        ps.style.backgroundRepeat = "no-repeat";
+        ps.style.backgroundSize = "cover";
+        ps.style.backgroundPosition = "center";
+        ps.style.left = "0px";
+        ps.style.top = "0px";
+        ps.style.position = "absolute";
+
+        // 设置 WebSocket 连接地址
+        ps.id = options.wsUrl;
+
+        // 将 video 元素添加到容器
+        options.container.appendChild(ps);
+
+        // 注册键盘和鼠标事件
+        if (ps.registerKeyboardEvents) {
+            ps.registerKeyboardEvents();
+        }
+        if (ps.registerMouseHoverEvents) {
+            ps.registerMouseHoverEvents();
+        }
+
+        // 监听消息事件
+        if (options.onMessage) {
+            ps.addEventListener("message", (e: any) => {
+                try {
+                    const data = JSON.parse(e.detail);
+                    options.onMessage!(data);
+                } catch (error) {
+                    console.error("解析消息失败:", error);
+                }
+            });
+        }
+
+        // 监听元数据加载完成
+        ps.addEventListener("loadedmetadata", () => {
+            if (ps) {
+                ps.style.objectFit = "fill";
+                ps.style.width = "100%";
+                ps.style.height = "100%";
+            }
+            options.onLoadedMetadata?.();
+        });
+
+        // 监听排队人数变化
+        if (ps.ws && options.onQueueChange) {
+            ps.ws.addEventListener('message', (e: MessageEvent) => {
+                try {
+                    const data = JSON.parse(e.data);
+                    if (data.type === "playerqueue") {
+                        options.onQueueChange!(data.seq);
+                    }
+                } catch (error) {
+                    // 忽略解析错误，可能不是 JSON 数据
+                }
+            });
+        }
+
+        // 监听播放开始事件
+        if (options.onPlaying) {
+            ps.addEventListener("playing", () => {
+                options.onPlaying!();
+            });
+        }
+
+        return ps;
+    }
+}
+

package/src/modules/Path.ts

@@ -0,0 +1,293 @@
+
+
+
+/**
+ * 路径方法
+ */
+import { Action, SendParam } from "./Action";
+
+
+type PathActionType = '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 PathAddData {
+    action: 'add';
+    pathId: string;                 // 自定义轨迹ID
+    pathDrawBaseType: PathDrawBaseType;  // 绘制方式
+    roadNetId?: string;             // 路网ID，BaseOnRoadNet时需要
+    rolerMoveParam?: RolerMoveParam;    // 沿路径移动的信息
+    pathStyle?: PathStyle;          // 路径样式
+    points: PathPoint[];            // 路径点数组
+}
+
+type PathType = SendParam & {
+    cmd: "path";
+    data: {
+        action: PathActionType;
+        [key: string]: any;
+    };
+}
+
+export class PathAction extends Action {
+    /**
+     * 请求三维绘制路径
+     * @param pathId 自定义轨迹ID，后面删除的时候用，如果之前有编辑路径，这里就使用编辑路径的时候传入的路径 pathId
+     * @param pathDrawBaseType 绘制方式：BaseOnRoadNet 基于路网，使用C++寻路；BaseOnPathEditInfo 基于编辑路径生成的点画路径，不基于路网
+     * @param points 路径点数组
+     * @param roadNetId 路网的ID，pathDrawBaseType = BaseOnRoadNet的时候，需要传值，如果场景就一个路网，也可以不用传
+     * @param rolerMoveParam 沿路径移动的信息
+     * @param pathStyle 路径样式
+     */
+    static pathAdd(
+        pathId: string,
+        pathDrawBaseType: PathDrawBaseType,
+        points: PathPoint[],
+        roadNetId?: string,
+        rolerMoveParam?: RolerMoveParam,
+        pathStyle?: PathStyle
+    ) {
+        const data: PathAddData = {
+            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: PathType = {
+            cmd: "path",
+            data
+        };
+        this.sendParam(param, '请求三维绘制路径')
+    }
+
+    /**
+     * 显隐销毁路径
+     * @param action 操作类型：show 显示 | hide 隐藏 | remove 删除
+     * @param pathId 自定义轨迹ID，同前面，自定义的ID
+     * @param module 显隐、删除哪一部分：Edit 编辑的部分 | PathTracer 根据设备点动态生成的路径部分，如果不传，则整个显隐或者删除
+     */
+    static pathShowHideRemove(
+        action: 'show' | 'hide' | 'remove',
+        pathId: string,
+        module?: PathModuleType
+    ) {
+        const data: {
+            action: 'show' | 'hide' | 'remove';
+            pathId: string;
+            module?: PathModuleType;
+        } = {
+            action,
+            pathId
+        };
+
+        // 如果提供了模块类型，则添加
+        if (module) {
+            data.module = module;
+        }
+
+        const param: PathType = {
+            cmd: "path",
+            data
+        };
+        
+        const actionMap = {
+            show: '显示路径',
+            hide: '隐藏路径',
+            remove: '删除路径'
+        };
+        this.sendParam(param, actionMap[action])
+    }
+
+    /**
+     * 移动中更新移动参数
+     * @param pathId 自定义轨迹ID
+     * @param rolerMoveParam 沿路径移动的参数
+     */
+    static pathUpdateMovingParam(
+        pathId: string,
+        rolerMoveParam: RolerMoveParam
+    ) {
+        const data: {
+            action: 'updateMovingParam';
+            pathId: string;
+            rolerMoveParam: RolerMoveParam;
+        } = {
+            action: 'updateMovingParam',
+            pathId,
+            rolerMoveParam
+        };
+
+        const param: PathType = {
+            cmd: "path",
+            data
+        };
+        this.sendParam(param, '更新移动参数')
+    }
+
+    /**
+     * 在生成的路径上面移动 - 开始移动
+     * @param action 操作类型：start 开始移动
+     * @param pathId 自定义轨迹ID
+     * @param rolerMoveParam 沿路径移动的参数
+     */
+    static pathMove(action: 'start', pathId: string, rolerMoveParam: RolerMoveParam): void;
+    /**
+     * 在生成的路径上面移动 - 停止或重启
+     * @param action 操作类型：stop 停止移动 | restart 重启移动
+     */
+    static pathMove(action: 'stop' | 'restart'): void;
+    /**
+     * 在生成的路径上面移动
+     * @param action 操作类型：start 开始移动 | stop 停止移动 | restart 重启移动
+     * @param pathId 自定义轨迹ID（仅 start 时需要）
+     * @param rolerMoveParam 沿路径移动的参数（仅 start 时需要）
+     */
+    static pathMove(
+        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: PathType = {
+            cmd: "path",
+            data
+        };
+        
+        const actionMap = {
+            start: '开始移动',
+            stop: '停止移动',
+            restart: '重启移动'
+        };
+        this.sendParam(param, actionMap[action])
+    }
+
+    /**
+     * 开启路径编辑
+     * @param pathId 自定义轨迹ID，前端配置界面提供数据，为空或者不传，UE自动生成一个
+     * @param pathName 路径名称，前端配置界面提供数据，非必须
+     * @param pathEditParam 路径编辑参数，前端配置界面提供数据
+     */
+    static pathBeginEdit(
+        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: PathType = {
+            cmd: "path",
+            data
+        };
+        this.sendParam(param, '开启路径编辑')
+    }
+
+    /**
+     * 停止路径编辑
+     */
+    static pathEndEdit() {
+        const data: {
+            action: 'endEdit';
+        } = {
+            action: 'endEdit'
+        };
+
+        const param: PathType = {
+            cmd: "path",
+            data
+        };
+        this.sendParam(param, '停止路径编辑')
+    }
+}