10:I[76231,["/_next/static/chunks/32rlls6mbzrm8.js","/_next/static/chunks/42xvukw-fxk70.js"],""] 11:I[85821,["/_next/static/chunks/32rlls6mbzrm8.js","/_next/static/chunks/42xvukw-fxk70.js"],"DocsShell"] 1a:I[46063,["/_next/static/chunks/32rlls6mbzrm8.js","/_next/static/chunks/42xvukw-fxk70.js","/_next/static/chunks/2sz-xx0p1qowz.js"],"SetBreadcrumbs"] 1b:I[98999,["/_next/static/chunks/32rlls6mbzrm8.js","/_next/static/chunks/42xvukw-fxk70.js","/_next/static/chunks/2sz-xx0p1qowz.js"],""] 1c:I[6750,["/_next/static/chunks/32rlls6mbzrm8.js","/_next/static/chunks/42xvukw-fxk70.js","/_next/static/chunks/2sz-xx0p1qowz.js"],"MarkdownBody"] :HL["https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github.min.css","style"] 12:T16d2,# CIMPro孪⼤师 API ⽂档 > 2026.08.18-17.50.05 CIMPro V6.7.3508 ![bg](res/p010.png) ![bg](res/home-bg.png) ## 📌 产品简介 **CIMPro孪大师** 是基于自研PiCIMOS图形引擎打造的一站式空间智能数字孪生开发平台，具备完全自主知识产权。平台创新融合C/S与B/S双架构，兼具零代码与低代码双模式开发能力，集成模型导入、场景编排、UI交互设计、仿真动画、数据接入等全链路能力。面向AEC与MFG领域开发者，平台开放标准化Javascript二次开发接口，支撑快速构建高可用、强扩展的行业级解决方案。目前，已在航天军工、高端制造、能源电力、船舶海洋、水利水电及产教融合等领域实现规模化落地。 --- ## 🚀 快速上手（3步） ### 第1步：安装与部署 1. 登录 [piadmin 管理后台](https://piadmin.picimos.com)，在「下载中心」下载 **PiStudio 客户端**。 2. 下载前端示例代码包：[`pixel前端示例.zip`](https://cc.picimos.com/static/files/pixel前端示例.zip) 3. 解压后获得 `pixel.html`、`index.umd.js`、`lib-pixelstreamingfrontend.js` 等文件。 > 📺 [视频教程：CIMPro孪大师-pistudio云渲染使用](https://www.bilibili.com/video/BV1DXGo6jEXD/?share_source=copy_web&vd_source=f3d9031201439c46a2330a2a24cd3e29) ### 第2步：连接云渲染在 `pixel.html` 中配置连接参数： ```javascript const initConfig = { $el: document.getElementById('renderContainer'), address: 'ws://127.0.0.1:8888', // 服务器地址 appKey: '', mode: 'pixelstreaming', showUI: false, StreamerId: 'client_' + Date.now(), initialSettings: { MatchViewportRes: false, WebRTCMinBitrate: 5000, WebRTCMaxBitrate: 100000, MaxReconnectAttempts: 0 } }; piclient.cloudrender.init(initConfig).then((baseDb) => { console.log('连接成功！'); piclient.emit('mode.enterPlayMode'); // 进入播放模式 }); ``` ### 第3步：调用第一个API ```javascript // 设置天气为晴天 piclient.emit('environment.setWeather', { weather: 1 }); // 相机飞行到指定对象 piclient.emit('camera.fly', { target: 'ObjectId', time: '3.0' }); ``` --- ## 📊 API 能力概览 ### 客户端 API（`piclient.emit`） | 模块 | API 数量 | 事件数量 | 核心能力 | |------|---------|---------|---------| | **Camera** | 11 | 0 | 相机聚焦、飞行、旋转、缩放、视角模式、VR模式 | | **Cloud** | 1 | 0 | 云渲染初始化 | | **Environment** | 7 | 0 | 时间设置、天气切换、后处理参数、天空参数 | | **General** | 6 | 0 | 打开URL、文件下载、程序退出、画质设置 | | **GIS** | 27 | 0 | POI管理、矢量图层、投影图片/视频、CFD对象、3D瓦片 | | **IOT** | 9 | 0 | 交互对象创建、状态更新、事件绑定、属性变更、路径移动 | | **Light** | 14 | 0 | 光源强度/颜色/角度/阴影、聚光/面光/定向光参数 | | **Mode** | 4 | 0 | 预览模式、UI穿透、通用事件、相机偏移 | | **Objects** | 30 | 10 | 对象创建/移动/销毁/更新、材质/动画/高亮/虚化、多选事件 | | **Path** | 5 | 1 | 巡检路线控制、位置参照更新、路线数据更新 | | **POI** | 6 | 0 | POI创建/修改、批量加载、网页展示、点聚合 | | **Project** | 13 | 0 | 录制回放、FPS控制、方案加载、PCZ读取 | | **UI** | 2 | 0 | 客户端界面组件显隐控制 | | **Water** | 11 | 0 | 水体网格加载、状态数据、热力图配置、播放控制 | | **Window** | 6 | 0 | 多窗口创建（相机/网页/UMG）、移动、缩放、关闭 | | **ModuleBase** | 0 | 0 | 基础模块 | > **统计：16 个模块 · 152 个 API · 11 个事件** ### UI 编辑器 API（`window.PiUtils`） | API | 说明 | |-----|------| | `piAlert` | 显示警告/提示框 | | `piClient` | 执行客户端操作 | | `piGoto` | 导航到指定页面 | | `piLink` | 打开URL链接 | | `piOpenDialog` / `closeAllDialog` | 打开/关闭弹窗 | | `piToggle` | 切换子页面显隐 | | `piUpdateGlobalParam` | 更新全局参数 | | `piGetGlobalParam` | 获取全局参数（传 `''` 返回全部） | | `toggleShow` | 切换元素显隐 | | `componentEvent` | 触发组件事件 | | `buttonSelect` | 设置单选/多选选中值 | | `getVideoStream` | 获取视频监控组件流地址 / 摄像头 id | | `setVideoStream` | 设置视频监控组件流地址 / 摄像头 id 并重新加载 | ### 数字人交互 API | API | 说明 | |-----|------| | `piAlert` | 显示警告/提示框 | | `piClient` | 执行客户端操作 | | `piGoto` | 导航到指定页面 | | `piLink` | 打开URL链接 | | `piOpenDialog` | 打开指定对话框 | | `piToggle` | 切换子页面显隐 | | `piUpdateGlobalParam` | 更新全局参数 | | `toggleShow` | 切换元素显示状态 | | `componentEvent` | 触发组件事件 | --- ## 📖 文档导航 * [首页](/) * [云渲染安装使用](install.md) * [嵌入式二次开发接入](piClient.md) * [客户端API手册](api.md) — 152 接口详细文档 * [UI编辑器API手册](Window.PiUtilsAPI.md) — 14 个前端工具方法 * [数字人交互API手册](数字人交互API文档.md) — 9 个数字人交互指令 * [CIMPro孪⼤师云渲染API示例中⼼](http://apiexamples.eimpro.com/doc) * [部署与文档数据更新](DEPLOY.md) — 如何发布文档站点 --- ## 📋 版本信息 | 项目 | 内容 | |------|------| | **当前版本** | v1.0 | | **文档生成时间** | 2026.08.18-17.50.05 | | **API文档状态** | 🔄 重构与更新中，接口可能产生变化 | ### 更新日志 > 详见各模块文档末尾的 `*-end-*` 标记。API 文档还在重构和更新中，接口可能会产生变化，请见谅。 --- 有任何疑问或者遇到任何问题请及时与我们联系。上海漂视网络股份有限公司13:T7c0,### Step 1：引入 SDK 在 HTML 中引入两个必需的脚本文件： ```html ``` ### Step 2：初始化 PiClient ```javascript // 检查 SDK 是否加载 if (!window.PiClientJS?.PiClient) { console.error('PiClientJS 库未加载'); } // 创建实例 const piclient = new PiClientJS.PiClient({ debug: true }); ``` ### Step 3：配置云渲染参数并连接 ```javascript const initConfig = { $el: document.getElementById('renderContainer'), // 渲染容器 DOM address: 'ws://127.0.0.1:8888', // 服务器地址 appKey: '', // AppKey（可选） mode: 'pixelstreaming', // 模式：pixelstreaming / embed editorMode: false, projectId: '', showUI: false, StreamerId: 'client_' + Date.now(), // 唯一标识 initialSettings: { MatchViewportRes: false, MinQP: 25, MaxQP: 35, WebRTCMinBitrate: 5000, WebRTCMaxBitrate: 100000, MaxReconnectAttempts: 0, // 禁用自动重连 TimeoutIfIdle: false, // 禁用空闲超时 AFKTimeout: 0 // 禁用 AFK 超时 }, onProgress: (percent) => { console.log('加载进度:', percent + '%'); }, onDisconnect: (msg) => { console.log('连接断开:', msg); } }; // 发起连接 piclient.cloudrender.init(initConfig).then((baseDb) => { console.log('连接成功', baseDb); // 进入播放模式 piclient.emit('mode.enterPlayMode'); }).catch((err) => { console.error('连接失败:', err); }); ``` ### Step 4：发送第一个 API 调用连接成功后，即可调用客户端 API： ```javascript // 设置天气为晴天 piclient.emit('environment.setWeather', { weather: 1 }); // 相机飞行到指定对象 piclient.emit('camera.fly', { target: 'ObjectId', time: '3.0' }); ``` ---14:Tb56,### 方式一：在 CIMPro孪大师客户端中运行适用于将网页嵌入 CIMPro孪大师客户端内部运行的场景。 #### 1. 引入 SDK（2 行）通过 ` ``` > 注：`index.umd.js` 可直接重命名为 `piclient.js`，功能完全一致。 #### 2. 初始化并等待场景就绪（6 行） ```javascript const piclient = new PiClientJS.PiClient({ debug: true }); // 等待客户端场景对象加载完成 await piclient.pageReady().then((baseDb) => { console.log('场景加载完成', baseDb); }).catch((err) => { console.error('加载失败:', err); }); ``` #### 3. 发送事件与监听回调 ```javascript // 发送事件：设置天气为多云 piclient.emit('environment.setWeather', { weather: 3 }); // 监听对象点击事件 piclient.on('object.onClick', '', (res) => { console.log('对象被点击:', res); }); // 全局监听所有事件 piclient.on('global', '', (res) => { console.log('全局事件:', res); }); ``` --- ### 方式二：在浏览器中通过云渲染加载适用于在浏览器中通过 WebRTC 像素流连接 CIMPro孪大师客户端的场景。 #### 1. 引入 SDK（同方式一） ```html ``` > 注：云渲染模式不支持原生 ES Modules 引入方式。 #### 2. 配置云渲染参数并连接 ```javascript const piclient = new PiClient({ debug: true }); const initConfig = { $el: document.getElementById('container'), // 渲染容器 DOM address: 'ws://192.168.3.73:9000/', // 信令服务器地址 appKey: '123', // AppKey（为空则使用云渲染） mode: 'pixelstreaming', // pixelstreaming | embed editorMode: false, showUI: false, initialSettings: { MatchViewportRes: true, WebRTCFPS: 30, WebRTCMaxBitrate: 8000, }, onDisconnect: (msg) => { console.log('连接断开:', msg); } }; // 如果已有连接，先销毁 if (connected) { piclient.cloudrender.destroy(); } piclient.cloudrender.init(initConfig).then((baseDb) => { console.log('连接成功', baseDb); console.log('可用事件列表:', piclient.classEvents); // 进入播放模式并隐藏编辑器 UI piclient.emit('mode.enterPlayMode'); setTimeout(() => { piclient.emit('ui.setClientUIVisible', { visible: 'hide' }); }, 1000); }).catch((err) => { console.error('初始化失败:', err); }); ``` ---15:T5ba,PiClient JS SDK **内置 TypeScript 类型定义**，无需额外安装 `@types` 包。 ### 类型声明 ```typescript // 从 npm 包导入时自动获得类型提示 import { PiClient } from 'new-piclient.js'; // 全局变量声明（CDN 引入方式） declare global { interface Window { PiClientJS: { PiClient: new (options?: { debug?: boolean }) => PiClientInstance; }; } } // 主要类型接口 interface PiClientInstance { emit(action: string, param?: Record): Promise; on(action: string, target: string, fn: (res: any) => void): void; once(action: string, target: string, fn: (res: any) => void): void; off(action: string, target?: string): boolean; pageReady(): Promise; cloudrender: { init(config: CloudRenderConfig): Promise; destroy(): void; }; classEvents: string[]; } interface CloudRenderConfig { $el: HTMLElement | null; address: string; appKey?: string; mode?: 'pixelstreaming' | 'embed'; editorMode?: boolean; projectId?: string; showUI?: boolean; StreamerId?: string; initialSettings?: Record; onProgress?: (percent: number) => void; onDisconnect?: (msg: string) => void; } ``` ### 版本要求 | 环境 | 最低版本 | 说明 | |------|---------|------| | TypeScript | ≥ 4.5 | 支持 `import type` 和 `satisfies` 运算符 | | Node.js | ≥ 16 | 配合构建工具使用 | ---16:T5da,> **以下示例基于 Vue 3 Composition API**，使用 ` ``` ### Vue 2 Options API ```vue ``` ---17:Ta74,### `emit` — 触发事件向 CIMPro孪大师客户端发送指令，支持 API 列表中的预定义事件或动态事件。 ```typescript piclient.emit(action: string, param?: object): Promise ``` | 参数 | 类型 | 必填 | 说明 | |------|------|------|------| | `action` | `string` | 是 | 事件名称，如 `object.visible` | | `param` | `object` | 否 | 事件参数对象 | **常用示例：** ```javascript // 对象显隐 piclient.emit('object.visible', { target: 'SceneMeshObject_0', visible: 'toggle' // show | hide | toggle }); // 相机飞行到对象 piclient.emit('camera.fly', { target: 'ObjectId', time: '3.0' // 飞行时长（秒） }); // 设置时间 piclient.emit('environment.setTime', { hour: 15, minute: 30 }); // 设置天气 piclient.emit('environment.setWeather', { weather: 3 // 3=多云，详见 API 手册 }); ``` ### `on` — 绑定事件监听监听客户端推送的事件，支持自定义回调和全局事件。 ```typescript piclient.on(action: string, target: string, fn: (res: any) => void): void ``` | 参数 | 类型 | 必填 | 说明 | |------|------|------|------| | `action` | `string` | 是 | 监听的事件名称 | | `target` | `string` | 是 | 目标对象 ID（全局监听传空字符串） | | `fn` | `function` | 是 | 回调函数 | **常用示例：** ```javascript // 监听云渲染初始化完成 piclient.on('cloud.init', '', (res) => { console.log('云渲染初始化:', res); }); // 监听对象点击（全局） piclient.on('object.onClick', '', (res) => { console.log('对象被点击:', res); }); // 监听特定对象点击 piclient.on('object.onClick', 'SceneMeshObject_0', (res) => { console.log('特定对象被点击:', res); }); // 全局监听所有事件 piclient.on('global', '', (res) => { console.log('全局事件:', res); // 输出示例： // {"action":"object.onUnSelect","target":"SceneMeshObject_0","params":{"objects":["SceneMeshObject_0"]}} }); ``` --- ### `once` — 单次监听同 `on`，但仅触发一次后自动解绑。 ```javascript // 只监听一次对象点击 piclient.once('object.onClick', 'SceneMeshObject_0', (res) => { console.log('首次点击:', res); // 再次点击不再触发 }); ``` --- ### `off` — 解绑监听 ```typescript piclient.off(action: string, target?: string): boolean ``` ```javascript // 解绑特定对象的点击事件 piclient.off('object.onClick', 'SceneMeshObject_0'); // 解绑所有对象的点击事件 piclient.off('object.onClick'); ``` ---18:T79d,piclient.emit("poi.createPOI",{ tag: "", //标记 geo: "", //经纬度，经度,纬度[,高程] 支持可选的高程 engine: "", //引擎坐标X,Y,Z rotate: "", //3D POI可选值 parentId: "", //附加的父对象，为空表示独立存在 parentTag: "", //附加的父对象，为空表示独立存在 offset: "", //x,y,z iconPath: "", //图片路径，内置/网络图片 iconPathHL: "", //图片路径，内置/网络图片 iconPathLeave: "", //图片路径，内置/网络图片 iconColor: "", ////图标颜色是‌十六进制颜色代码，常见‌红色‌: ‌红色‌：#FF0000;绿色‌：#00FF00;蓝色‌：#0000FF;黄色‌：#FFFF00;青色‌：#00FFFF;黑色‌：#000000;白色‌：#FFFFFF;灰色‌：#808080;深灰色‌：#A9A9A9;浅灰色‌：#D3D3D3;棕色‌：#A52A2A;橙色‌：#FFA500;粉红色‌：#FFC0CB;紫色‌：#800080; iconScale: "1", //图标缩放 focusFly: true, //双击飞行到POI，非瞬移 followCamera: true, //3D POI可选 iconSize: "", //50x50,长x宽 iconOffset: "", //0x0,左右x上下 labelText: "", //标题文本 labelOffset: "", //0x0,左右x上下 labelColor: "", ////图标颜色是‌十六进制颜色代码，常见‌红色‌: ‌红色‌：#FF0000;绿色‌：#00FF00;蓝色‌：#0000FF;黄色‌：#FFFF00;青色‌：#00FFFF;黑色‌：#000000;白色‌：#FFFFFF;灰色‌：#808080;深灰色‌：#A9A9A9;浅灰色‌：#D3D3D3;棕色‌：#A52A2A;橙色‌：#FFA500;粉红色‌：#FFC0CB;紫色‌：#800080; labelSize: "12", //文字大小 labelContent: "String", //内容文本/模板 labelContentColor: "String", //模板，内容颜色ff0000 templateId: "String", //0 menuOffset: "", //0x0,左右x上下 MenuWebUrl: "", poiType: "2D", //2D/3D/Dimension/2DTemplate styleType: "Horizontal", //图标和文本摆放状态：Horizontal(水平)/Vertica(垂直)/Overlay(覆盖)/IconOnly(只显示图标)/TextOnly(只显示文本) dataID: "", })2:["$","html",null,{"lang":"zh-CN","className":"inter_fe8b9d92-module__LINzvG__variable jetbrains_mono_c302529-module__OsiXdW__variable","suppressHydrationWarning":true,"children":[["$","head",null,{"children":["$","link",null,{"id":"hljs-theme","rel":"stylesheet","href":"https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github.min.css"}]}],["$","body",null,{"children":[["$","$L10",null,{"id":"theme-boot","strategy":"beforeInteractive","children":"(function(){try{var t=localStorage.getItem('theme')||'light';document.documentElement.setAttribute('data-theme',t);}catch(e){}})();"}],["$","$L11",null,{"data":{"site":{"productName":"CIMPro孪大师","subtitle":"API 文档中心","version":"v1.0","updatedAt":"2026.08.18"},"overview":{"id":1,"title":"CIMPro孪大师 API 文档","markdown":"$12"},"install":{"title":"云渲染安装使用","sections":[{"title":"前置准备","markdown":"### 1. 下载 PiStudio 客户端\n\n登录 [piadmin 管理后台](https://piadmin.picimos.com)，进入「下载中心」下载对应版本的 **PiStudio 云渲染客户端**。\n\n> 📺 [视频教程：CIMPro孪大师-pistudio云渲染使用](https://www.bilibili.com/video/BV1MFCvBpE77/?share_source=copy_web)\n\n### 2. 下载前端示例代码包\n\n[点击下载示例代码包](https://cc.picimos.com/static/files/pixel-frontend-example.zip)\n\n解压后得到以下文件：\n\n| 文件 | 说明 |\n|------|------|\n| `pixel.html` | 示例页面 |\n| `index.umd.js` | PiClient SDK（调用客户端接口） |\n| `lib-pixelstreamingfrontend.js` | 云渲染前端依赖库 |\n| `cloudrender.md` | 云渲染初始化参数文档 |\n\n---","sortOrder":0},{"title":"快速接入（4步）","markdown":"$13","sortOrder":1},{"title":"事件监听","markdown":"```javascript\n// 监听云渲染初始化完成\npiclient.on('cloud.init', '', (res) => {\n console.log('云渲染初始化:', res);\n});\n\n// 监听对象点击事件\npiclient.on('object.onClick', '', (res) => {\n console.log('对象被点击:', res);\n});\n\n// 全局监听所有事件\npiclient.on('global', '', (res) => {\n console.log('全局事件:', res);\n});\n```\n\n---","sortOrder":2},{"title":"资源释放","markdown":"页面卸载或需要断开连接时，务必调用销毁方法释放资源：\n\n```javascript\nfunction forceDestroy() {\n if (!piclient) return;\n try {\n const cloudRenderIns = piclient._cloudrenderIns;\n if (cloudRenderIns?.webRtcPlayerController) {\n const c = cloudRenderIns.webRtcPlayerController;\n if (c.peerConnection) {\n c.peerConnection.close();\n c.peerConnection = null;\n }\n if (c.videoPlayer?.videoElement) {\n c.videoPlayer.videoElement.srcObject = null;\n }\n if (c.signallingProtocol?.webSocket?.readyState === WebSocket.OPEN) {\n c.signallingProtocol.webSocket.close(1000, 'Client disconnect');\n }\n }\n document.getElementById('renderContainer').innerHTML = '';\n } catch (e) {\n console.error(e);\n }\n}\n\n// 页面卸载时自动清理\nwindow.addEventListener('beforeunload', forceDestroy);\n```\n\n---","sortOrder":3},{"title":"常见问题","markdown":"**Q：连接失败怎么办？**\n\n- 检查服务器地址是否正确（格式 `ws://ip:port`）\n- 确认 PiStudio 客户端已启动并处于等待连接状态\n- 检查浏览器控制台是否有 CORS 或 WebSocket 错误\n\n**Q：如何禁用自动重连？**\n\n在 `initialSettings` 中设置 `MaxReconnectAttempts: 0`。\n\n**Q：连接成功后画面黑屏？**\n\n- 确认已进入播放模式：`piclient.emit('mode.enterPlayMode')`\n- 检查 `showUI` 是否为 `false`，避免编辑器 UI 遮挡","sortOrder":4}]},"sdk":{"title":"SDK 开发指南","sections":[{"title":"快速开始","markdown":"$14","sortOrder":0},{"title":"使用构建工具（npm）","markdown":"```bash\r\nnpm install new-piclient.js\r\n```\r\n\r\n```typescript\r\nimport { PiClient } from 'new-piclient.js'\r\n\r\nconst piclient = ref(null);\r\n\r\nconst connect = async () => {\r\n piclient.value = new PiClient({ debug: true });\r\n await piclient.value.pageReady().then((baseDb) => {\r\n console.log('场景加载完成', baseDb);\r\n });\r\n};\r\n\r\nonMounted(async () => {\r\n await connect();\r\n\r\n piclient.value.on('cloud.init', '', (res) => {\r\n console.log(JSON.stringify(res));\r\n });\r\n\r\n piclient.value.on('environment.setWeather', '', (res) => {\r\n console.log(JSON.stringify(res));\r\n });\r\n\r\n piclient.value.on('global', '', (res) => {\r\n console.log(`<全局> ${JSON.stringify(res)}`);\r\n });\r\n});\r\n```\r\n\r\n---","sortOrder":1},{"title":"TypeScript 支持","markdown":"$15","sortOrder":2},{"title":"Vue 框架集成","markdown":"$16","sortOrder":3},{"title":"事件交互 API","markdown":"$17","sortOrder":4},{"title":"事件速查表","markdown":"| 事件名 | 说明 | 触发时机 |\r\n|--------|------|---------|\r\n| `cloud.init` | 云渲染初始化 | 云渲染连接成功 |\r\n| `object.onClick` | 对象点击 | 鼠标点击场景对象 |\r\n| `object.onDoubleClick` | 对象双击 | 鼠标双击场景对象 |\r\n| `object.onMoved` | 对象移动 | 对象位置发生变化 |\r\n| `object.onVisible` | 对象显隐 | 对象显示/隐藏状态变化 |\r\n| `object.onCreate` | 对象创建 | 新对象被创建 |\r\n| `object.onDestroy` | 对象销毁 | 对象被销毁 |\r\n| `pathfollow.onCheck` | 巡检检查 | 巡检路线到达检查点 |\r\n| `global` | 全局事件 | 所有事件的聚合通道 |\r\n\r\n> 完整事件列表请参考 [客户端API手册 - 事件清单](api.md)。\r\n\r\n---","sortOrder":5},{"title":"常见问题","markdown":"**Q：CDN 引入后 `PiClientJS` 未定义？**\r\n\r\n确认脚本已正确加载，可通过以下方式检测：\r\n\r\n```javascript\r\nif (window.PiClientJS && window.PiClientJS.PiClient) {\r\n console.log('SDK 加载成功');\r\n} else {\r\n console.error('SDK 未加载，请检查网络或路径');\r\n}\r\n```\r\n\r\n**Q：云渲染连接失败？**\r\n\r\n- 检查信令服务器地址是否正确（格式 `ws://ip:port/`）\r\n- 确认 PiStudio 客户端已启动并处于等待连接状态\r\n- 检查浏览器是否支持 WebRTC\r\n\r\n**Q：Vue 3 中使用 `ref` 报错？**\r\n\r\n确保使用 `ref` 导入自 `vue`，而非原生 DOM API：\r\n\r\n```typescript\r\nimport { ref } from 'vue'; // ✅ 正确\r\n// const ref = document.querySelector; // ❌ 错误\r\n```\r\n\r\n> 🐛 问题反馈：[提交 Issue](https://piadmin.picimos.com/feedback)","sortOrder":6}]},"api":{"title":"CIMPro孪大师 API","modules":[{"name":"Camera","description":"","sortOrder":0,"apis":[{"name":"camera.focus","title":"聚焦相机到对象","description":"聚焦相机到对象","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的任意对象","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"attach","type":"string","required":true,"defaultValue":"default","description":"default/true/false，目标是相机对象并且相机是子物体才能吸附","enumValues":["default","true","false"]}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"camera.focus\",{\n\ttarget: \"ObjectId\", //场景中的任意对象id target和tag二选一填写就可以\n\ttag: \"\",//场景中的任意对象标记\n\tattach: \"default\", //default/true/false，目标是相机对象并且相机是子物体才能吸附\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/camera.focus聚焦相机到对象-相机跟随api.mp4"],"remarks":"$undefined","sortOrder":0},{"name":"camera.fly","title":"相机飞行","description":"相机飞行","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的任意对象","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"engine","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"引擎坐标","enumValues":"$undefined"},{"name":"rotation","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"旋转 roll, pitch, yaw的角度值","enumValues":"$undefined"},{"name":"geo","type":"string","required":false,"defaultValue":"0.0, 0.0, 0.0","description":"经度,纬度,高程组成的格式，高程可选","enumValues":"$undefined"},{"name":"time","type":"string","required":true,"defaultValue":"3.0","description":"飞行时长，单位秒","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"camera.fly\",{\n\ttarget: \"\", //场景中的任意对象\n\ttag: \"\",\n\tengine: \"0.0, 0.0, 0.0\", //引擎坐标\n\trotation: \"0.0, 0.0, 0.0\", //旋转 roll, pitch, yaw的角度值\n\tgeo: \"0.0, 0.0, 0.0\", //经度,纬度,高程组成的格式，高程可选\n\ttime: \"3.0\", //飞行时长，单位秒\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/camera.fly相机飞行.mp4"],"remarks":"$undefined","sortOrder":1},{"name":"camera.animControl","title":"相机动画控制","description":"相机动画控制，设置动画时长，播放，暂停，停止","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的任意对象","enumValues":"$undefined"},{"name":"totalTime","type":"string","required":true,"defaultValue":"3.5","description":"动画的播放时长","enumValues":"$undefined"},{"name":"bFromStart","type":"string","required":true,"defaultValue":"true","description":"是否从头开始播放","enumValues":"$undefined"},{"name":"playState","type":"string","required":true,"defaultValue":"toggle","description":"动画的播放状态stop/pause/play/toggle","enumValues":["stop","pause","play","toggle"]}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"camera.animControl\",{\n\ttarget: \"ObjectId\", //场景中的任意对象\n\ttotalTime: \"3.5\", //动画的播放时长\n\tbFromStart: \"true\", //是否从头开始播放\n\tplayState: \"toggle\", //动画的播放状态stop/pause/play/toggle\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/camera.animControl相机动画控制.mp4"],"remarks":"$undefined","sortOrder":2},{"name":"camera.cameraSpeed","title":"相机-移动速度","description":"相机移动速度","params":[{"name":"cameraSpeed","type":"string","required":true,"defaultValue":"4.0","description":"相机移动速率调整","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"camera.cameraSpeed\",{\n\tcameraSpeed: \"4.0\", //相机移动速率调整\n\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/camera.cameraSpeed相机-移动速度.mp4"],"remarks":"$undefined","sortOrder":3},{"name":"camera.setViewMode","title":"相机-视角模式","description":"视角模式，漫游，第一人称，第三人称,无人机","params":[{"name":"viewMode","type":"string","required":true,"defaultValue":"auto","description":"auto/fpp/tpp/drone/ 自由视角漫游-auto，第一人称-fpp，第三人称-tpp，无人机视角-drone","enumValues":["auto","fpp","tpp","drone"]}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"camera.setViewMode\",{\n\tviewMode: \"auto\",//auto/fpp/tpp/drone/ 自由视角漫游-auto，第一人称-fpp，第三人称-tpp，无人机视角-drone\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/camera.setViewMode相机-视角模式.mp4"],"remarks":"$undefined","sortOrder":4},{"name":"camera.setObserverMode","title":"相机-观察模式","description":"局部观察物体模式","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectName","description":"场景中的物体","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"camera.setObserverMode\",{\n\ttarget: \"ObjectName\", //场景中的物体\n})"},"videos":[],"remarks":"$undefined","sortOrder":5},{"name":"camera.lookAt","title":"相机观察物体","description":"相机_观察物体","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的任意对象","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"offset","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"引擎坐标cm(0,0,0)","enumValues":"$undefined"},{"name":"time","type":"string","required":true,"defaultValue":"3.0","description":"飞行时长，单位秒","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"camera.lookAt\",{\n\ttarget: \"ObjectId\", //场景中的任意对象\n\ttag: \"\",\n\toffset: \"0.0, 0.0, 0.0\", //引擎坐标cm(0,0,0)\n\ttime: \"3.0\", //飞行时长，单位秒\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/camera.lookAt相机观察物体.mp4"],"remarks":"$undefined","sortOrder":6},{"name":"camera.info","title":"相机信息","description":"相机_信息","params":[{"name":"status","type":"boolean","required":true,"defaultValue":"true","description":"true","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"camera.info\",{\n\tstatus: true, //true\n})"},"videos":[],"remarks":"$undefined","sortOrder":7},{"name":"camera.toggleVRMode","title":"相机-VR模式","description":"VR操作模式，进入，退出","params":[{"name":"enter","type":"string","required":true,"defaultValue":"true","description":"进入VR模式","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"camera.toggleVRMode\",{\n\tenter: \"true\", //进入VR模式\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/camera.toggleVRMode相机-VR模式.mp4"],"remarks":"$undefined","sortOrder":8},{"name":"camera.move","title":"相机移动","description":"相机_移动","params":[{"name":"MoveForward","type":"string","required":true,"defaultValue":"1.0","description":"单位cm","enumValues":"$undefined"},{"name":"MoveRight","type":"string","required":true,"defaultValue":"1.0","description":"单位cm","enumValues":"$undefined"},{"name":"MoveHeight","type":"string","required":true,"defaultValue":"1.0","description":"单位cm","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"camera.move\",{\n\tMoveForward: \"1.0\", //单位cm\n\tMoveRight: \"1.0\", //单位cm\n\tMoveHeight: \"1.0\", //单位cm\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/camera.move相机移动.mp4"],"remarks":"$undefined","sortOrder":9},{"name":"camera.Rotate","title":"相机旋转","description":"相机_旋转","params":[{"name":"RotateX","type":"string","required":true,"defaultValue":"1.0","description":"角度","enumValues":"$undefined"},{"name":"RotateY","type":"string","required":true,"defaultValue":"1.0","description":"角度","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"camera.Rotate\",{\n\tRotateX: \"1.0\", //角度\n\tRotateY: \"1.0\", //角度\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/camera.Rotate相机旋转.mp4"],"remarks":"$undefined","sortOrder":10},{"name":"camera.zoom","title":"相机-缩放","description":"控制相机缩放值","params":[{"name":"value","type":"number","required":true,"defaultValue":"0.0","description":"缩放值","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"camera.zoom\",{\n\tvalue: 0.0, //缩放值\n})"},"videos":[],"remarks":"$undefined","sortOrder":11}]},{"name":"Cloud","description":"云渲染相关的接口","sortOrder":1,"apis":[{"name":"cloud.init","title":"云渲染-云渲染初始化","description":"云渲染初始化","params":[{"name":"accountId","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"accountName","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"token","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"projectId","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"showUI","type":"string","required":true,"defaultValue":"false","description":"是否显示编辑器UI","enumValues":"$undefined"},{"name":"editorMode","type":"string","required":true,"defaultValue":"false","description":"是否进入编辑模式","enumValues":"$undefined"}],"returns":[{"name":"success","type":"boolean","required":true,"defaultValue":"true","description":"","enumValues":"$undefined"},{"name":"msg","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"cloud.init\",{\n\taccountId: \"\",\n\taccountName: \"\",\n\ttoken: \"\",\n\tprojectId: \"\",\n\tshowUI: \"false\", //是否显示编辑器UI\n\teditorMode: \"false\" //是否进入编辑模式\n})"},"videos":[],"remarks":"$undefined","sortOrder":0}]},{"name":"Environment","description":"模式模块主要做环境的管理","sortOrder":2,"apis":[{"name":"environment.setTime","title":"环境-设置时间","description":"设置时间","params":[{"name":"hour","type":"string","required":true,"defaultValue":"13","description":"","enumValues":"$undefined"},{"name":"minute","type":"string","required":true,"defaultValue":"32","description":"","enumValues":"$undefined"},{"name":"percentOfDay","type":"string","required":true,"defaultValue":"0","description":"一天的百分比，大于0时hour/minute无效","enumValues":["hour","minute"]}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"environment.setTime\",{\n\thour:15, //小时, 0-23\n\tminute: 30, //分钟 0-59\n\tpercentOfDay: 0 //一天的百分比 0-1，大于0时hour/minute无效\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/environment.setTime环境-设置时间.mp4"],"remarks":"$undefined","sortOrder":0},{"name":"environment.setWeather","title":"环境-设置天气","description":"设置天气","params":[{"name":"weather","type":"string","required":true,"defaultValue":"2","description":"天气, 1-11 晴空万里/少云/多云/阴天/雾天/小雨/中雨/暴风雨/小雪/中雪/暴风雪","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"environment.setWeather\",{\n\tweather: \"2\" //天气, 1-11 晴空万里/少云/多云/阴天/雾天/小雨/中雨/暴风雨/小雪/中雪/暴风雪\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/environment.setWeather环境-设置天气.mp4"],"remarks":"$undefined","sortOrder":1},{"name":"environment.timePass","title":"环境-时间流逝","description":"时光流逝控制","params":[{"name":"timeSpeed","type":"string","required":true,"defaultValue":"1","description":"0表示不流逝","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"environment.timePass\",{\n\ttimeSpeed: \"1\", //0表示不流逝\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/environment.timePass环境-时间流逝.mp4"],"remarks":"$undefined","sortOrder":2},{"name":"environment.setPostProcessParam","title":"环境-设置后处理参数","description":"设置后处理参数","params":[{"name":"paramName","type":"string","required":true,"defaultValue":"$undefined","description":"生效的属性名自动曝光，最小曝光，最大曝光，全局着色","enumValues":"$undefined"},{"name":"paramValue","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"motionBlurs","type":"string","required":true,"defaultValue":"0.5","description":"运动模糊","enumValues":"$undefined"},{"name":"saturation","type":"string","required":true,"defaultValue":"1.0","description":"饱和度","enumValues":"$undefined"},{"name":"contrast","type":"string","required":true,"defaultValue":"1.0","description":"对比度","enumValues":"$undefined"},{"name":"exposure","type":"string","required":true,"defaultValue":"1.0","description":"自动曝光","enumValues":"$undefined"},{"name":"minBrightness","type":"string","required":true,"defaultValue":"-1.0","description":"最小曝光","enumValues":"$undefined"},{"name":"maxBrightness","type":"string","required":true,"defaultValue":"1.0","description":"最大曝光","enumValues":"$undefined"},{"name":"whiteBalance","type":"string","required":true,"defaultValue":"6500","description":"白平衡","enumValues":"$undefined"},{"name":"vignette","type":"string","required":true,"defaultValue":"0.4","description":"暗角强度","enumValues":"$undefined"},{"name":"colorGain","type":"string","required":true,"defaultValue":"1.0","description":"全局着色","enumValues":"$undefined"},{"name":"shadowContrast","type":"string","required":true,"defaultValue":"1.0","description":"暗部对比度","enumValues":"$undefined"},{"name":"lensFlare","type":"string","required":true,"defaultValue":"1.0","description":"镜头光晕","enumValues":"$undefined"},{"name":"LUT","type":"string","required":true,"defaultValue":"FFFFFFFF","description":"LUT","enumValues":"$undefined"},{"name":"ambientOcclusion","type":"string","required":true,"defaultValue":"0.5","description":"环境光遮蔽","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"environment.setPostProcessParam\",{\n\tparamName: \"\", // 生效的属性名自动曝光，最小曝光，最大曝光，全局着色\n\tparamValue: \"\",\n\tmotionBlurs: \"0.5\", //运动模糊\n\tsaturation: \"1.0\", //饱和度\n\tcontrast: \"1.0\", //对比度\n\texposure: \"1.0\", //自动曝光\n\tminBrightness: \"-1.0\", //最小曝光\n\tmaxBrightness: \"1.0\", //最大曝光\n\twhiteBalance: \"6500\", //白平衡\n\tvignette: \"0.4\", //暗角强度\n\tcolorGain: \"1.0\", //全局着色\n\tshadowContrast: \"1.0\", //暗部对比度\n\tlensFlare: \"1.0\", //镜头光晕\n\tLUT: \"FFFFFFFF\", //LUT\n\tambientOcclusion: \"0.5\", //环境光遮蔽\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/environment.setPostProcessParam环境-设置后处理参数.mp4"],"remarks":"$undefined","sortOrder":3},{"name":"environment.setWeatherParam","title":"环境-设置天气参数","description":"设置天气参数","params":[{"name":"Rain","type":"string","required":true,"defaultValue":"0.0","description":"雨量","enumValues":"$undefined"},{"name":"Snow","type":"string","required":true,"defaultValue":"0.0","description":"雪量","enumValues":"$undefined"},{"name":"WindDirection","type":"string","required":true,"defaultValue":"0.0","description":"风向","enumValues":"$undefined"},{"name":"WindIntensity","type":"string","required":true,"defaultValue":"0.0","description":"雨量","enumValues":"$undefined"},{"name":"CloudCoverage","type":"string","required":true,"defaultValue":"0.0","description":"云彩密度","enumValues":"$undefined"},{"name":"ThunderLightning","type":"string","required":true,"defaultValue":"0.0","description":"雷电强度","enumValues":"$undefined"},{"name":"Fog","type":"string","required":true,"defaultValue":"0.0","description":"雾强度","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"environment.setWeatherParam\",{\n\tRain: \"0.0\", //雨量\n\tSnow: \"0.0\", //雪量\n\tWindDirection: \"0.0\", //风向\n\tWindIntensity: \"0.0\", //雨量\n\tCloudCoverage: \"0.0\", //云彩密度\n\tThunderLightning: \"0.0\", //雷电强度\n\tFog: \"0.0\", //雾强度\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/environment.setWeatherParam环境-设置天气参数.mp4"],"remarks":"$undefined","sortOrder":4},{"name":"environment.setSkyParam","title":"环境-设置天空参数","description":"设置天空参数","params":[{"name":"cloudAltitude","type":"string","required":true,"defaultValue":"0.6","description":"云层高度","enumValues":"$undefined"},{"name":"cloudSpeed","type":"string","required":true,"defaultValue":"0.07","description":"云朵速度","enumValues":"$undefined"},{"name":"cloudDirection","type":"string","required":true,"defaultValue":"1.0","description":"云朵方向","enumValues":"$undefined"},{"name":"cloudShadows","type":"string","required":true,"defaultValue":"true","description":"云朵阴影","enumValues":"$undefined"},{"name":"fogDensity","type":"string","required":true,"defaultValue":"0.001","description":"雾密度","enumValues":"$undefined"},{"name":"fogDistance","type":"string","required":true,"defaultValue":"1.0","description":"雾范围","enumValues":"$undefined"},{"name":"skyLightIntensity","type":"string","required":true,"defaultValue":"1","description":"天光强度","enumValues":"$undefined"},{"name":"sunLightIntensity","type":"string","required":true,"defaultValue":"5","description":"日光强度","enumValues":"$undefined"},{"name":"sunAngle","type":"string","required":true,"defaultValue":"0","description":"日光角度","enumValues":"$undefined"},{"name":"moonShadow","type":"string","required":true,"defaultValue":"true","description":"月光阴影","enumValues":"$undefined"},{"name":"moonLightIntensity","type":"string","required":true,"defaultValue":"0.12","description":"月光强度","enumValues":"$undefined"},{"name":"moonScale","type":"string","required":true,"defaultValue":"0.7","description":"月亮大小","enumValues":"$undefined"},{"name":"moonPhase","type":"string","required":true,"defaultValue":"0.0","description":"月相","enumValues":"$undefined"},{"name":"showStar","type":"string","required":true,"defaultValue":"false","description":"显示星系","enumValues":"$undefined"},{"name":"starsIntensity","type":"string","required":true,"defaultValue":"0.75","description":"星光强度","enumValues":"$undefined"},{"name":"starsTiling","type":"string","required":true,"defaultValue":"3","description":"星星密度","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"environment.setSkyParam\",{\n\tcloudAltitude: \"0.6\", //云层高度\n\tcloudSpeed: \"0.07\", //云朵速度\n\tcloudDirection: \"1.0\", //云朵方向\n\tcloudShadows: \"true\", //云朵阴影\n\tfogDensity: \"0.001\", //雾密度\n\tfogDistance: \"1.0\", //雾范围\n\tskyLightIntensity: \"1\", //天光强度\n\tsunLightIntensity: \"5\", //日光强度\n\tsunAngle: \"0\", //日光角度\n\tmoonShadow: \"true\", //月光阴影\n\tmoonLightIntensity: \"0.12\", //月光强度\n\tmoonScale: \"0.7\", //月亮大小\n\tmoonPhase: \"0.0\", //月相\n\tshowStar: \"false\", //显示星系\n\tstarsIntensity: \"0.75\", //星光强度\n\tstarsTiling: \"3\", //星星密度\n})"},"videos":[],"remarks":"$undefined","sortOrder":5},{"name":"environment.setDisplayParam","title":"环境-设置显示参数","description":"设置显示参数","params":[{"name":"shadowDistance","type":"string","required":true,"defaultValue":"40000","description":"阴影距离","enumValues":"$undefined"},{"name":"POICullDistance","type":"string","required":true,"defaultValue":"0.0","description":"POI剔除距离","enumValues":"$undefined"}],"returns":[],"example":null,"videos":[],"remarks":"$undefined","sortOrder":6}]},{"name":"General","description":"通用模块，提供通用功能与服务","sortOrder":3,"apis":[{"name":"general.openUrl","title":"通用-用系统默认浏览器打开网页地址","description":"打开URL","params":[{"name":"url","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"general.openUrl\",{\n\turl: \"\" //地址\n})"},"videos":[],"remarks":"$undefined","sortOrder":0},{"name":"general.setSendWebFPS","title":"通用-屏幕信息发送帧率","description":"设置屏幕信息接口发送帧率（1-10）,代表每次间隔多少次信息只发送一次","params":[{"name":"sendWebFPS","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"general.SetSendWebFPS\",{\n\tSendWebFPS: 0.0,\n})"},"videos":[],"remarks":"$undefined","sortOrder":1},{"name":"general.httpDownload","title":"通用-URL下载","description":"下载文件到Saved/Download下","params":[{"name":"URL","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"general.httpDownload\",{\n\tURL: \"\",\n\ttag: \"\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":2},{"name":"general.quitGame","title":"通用-关闭程序","description":"关闭当前客户端程序","params":[{"name":"time","type":"string","required":true,"defaultValue":"0.0","description":"单位秒","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"general.quitGame\",{\n\ttime: \"0.0\", //单位秒\n})"},"videos":[],"remarks":"$undefined","sortOrder":3},{"name":"general.gameSetting","title":"通用-设置","description":"设置基础配置","params":[{"name":"renderQuality","type":"string","required":true,"defaultValue":"3","description":"低0，中1，高2，极致3，电影级4","enumValues":"$undefined"},{"name":"screenPercentage","type":"string","required":true,"defaultValue":"100","description":"单位","enumValues":"$undefined"},{"name":"maxFps","type":"string","required":true,"defaultValue":"60","description":"","enumValues":"$undefined"},{"name":"resolution","type":"string","required":true,"defaultValue":"1920x1080","description":"1920x1080,格式以x隔开","enumValues":"$undefined"},{"name":"illuminationMethod","type":"string","required":true,"defaultValue":"0","description":"0实时渲染 1全局照明","enumValues":"$undefined"},{"name":"characterLogo","type":"string","required":true,"defaultValue":"$undefined","description":"第三人称角色logo","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"general.gameSetting\",{\n\trenderQuality: \"3\", //低0，中1，高2，极致3，电影级4\n\tscreenPercentage: \"100\", //单位\n\tmaxFps: \"60\",\n\tresolution: \"1920x1080\", //1920x1080,格式以x隔开\n\tilluminationMethod: \"0\", //0实时渲染 1全局照明\n\tcharacterLogo: \"\", //第三人称角色logo\n})"},"videos":[],"remarks":"$undefined","sortOrder":4}]},{"name":"GIS","description":"GIS模块，提供地理消息行业支持","sortOrder":4,"apis":[{"name":"gis.setPOIOptions","title":"GIS-设置POI选项","description":"设置地理相关的POI的显示选项","params":[{"name":"enable","type":"boolean","required":true,"defaultValue":"true","description":"是否启用显示，false则不显示","enumValues":"$undefined"},{"name":"radius","type":"number","required":true,"defaultValue":"0.0","description":"显示半径多少米，相机为中心点方圆多少米内的poi点位","enumValues":"$undefined"},{"name":"level","type":"string","required":true,"defaultValue":"$undefined","description":"GIS比例尺级别，1-18, 0=自动","enumValues":"$undefined"},{"name":"queryType","type":"string","required":true,"defaultValue":"$undefined","description":"查询类型， 1（普通POI），2（统计），3（行政区)，4（建议词搜索），5（线路结果） http://lbs.tianditu.gov.cn/server/search2.html","enumValues":["cn","server","search2"]},{"name":"dataType","type":"string","required":true,"defaultValue":"$undefined","description":"行政地名, 加油站, 水利设施, //显示的类型，详情参考 https://download.tianditu.gov.cn/download/xzqh/Type.csv","enumValues":["cn","download","xzqh","Type"]},{"name":"maxNum","type":"string","required":true,"defaultValue":"$undefined","description":"最大显示数量","enumValues":"$undefined"},{"name":"color","type":"string","required":true,"defaultValue":"ff0000","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.setPOIOptions\",{\n\tenable: true, //是否启用显示，false则不显示\n\tradius: 0.0, //显示半径多少米，相机为中心点方圆多少米内的poi点位\n\tlevel: \"\", //GIS比例尺级别，1-18, 0=自动\n\tqueryType: \"\", //查询类型， 1（普通POI），2（统计），3（行政区)，4（建议词搜索），5（线路结果） http://lbs.tianditu.gov.cn/server/search2.html\n\tdataType: \"\", //行政地名, 加油站, 水利设施, //显示的类型，详情参考 https://download.tianditu.gov.cn/download/xzqh/Type.csv\n\tmaxNum: \"\", //最大显示数量\n\tcolor: \"ff0000\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":0},{"name":"gis.setDistrictOptions","title":"GIS-设置区域选项","description":"设置行政区域，项目区域等区域的显示选项","params":[{"name":"enable","type":"boolean","required":true,"defaultValue":"true","description":"是否启用显示，false则不显示","enumValues":"$undefined"},{"name":"borderThickness","type":"string","required":true,"defaultValue":"10","description":"边缘粗细，单位米","enumValues":"$undefined"},{"name":"borderHeight","type":"string","required":true,"defaultValue":"1.5","description":"边缘厚度，单位米","enumValues":"$undefined"},{"name":"borderColor","type":"string","required":true,"defaultValue":"ff00003F","description":"","enumValues":"$undefined"},{"name":"fillHeight","type":"string","required":true,"defaultValue":"1.1","description":"填充区域厚度，单位米","enumValues":"$undefined"},{"name":"fillColor","type":"string","required":true,"defaultValue":"2f3f001F","description":"","enumValues":"$undefined"},{"name":"textVisible","type":"boolean","required":true,"defaultValue":"true","description":"是否启用显示，false则不显示","enumValues":"$undefined"},{"name":"textColor","type":"string","required":true,"defaultValue":"2f3f001F","description":"","enumValues":"$undefined"},{"name":"textScale","type":"string","required":true,"defaultValue":"1.0","description":"缩放倍数","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.setDistrictOptions\",{\n\tenable: true, //是否启用显示，false则不显示\n\tborderThickness: \"10\", //边缘粗细，单位米\n\tborderHeight: \"1.5\", //边缘厚度，单位米\n\tborderColor: \"ff00003F\",\n\tfillHeight: \"1.1\", //填充区域厚度，单位米\n\tfillColor: \"2f3f001F\",\n\ttextVisible: true, //是否启用显示，false则不显示\n\ttextColor: \"2f3f001F\",\n\ttextScale: \"1.0\", //缩放倍数\n})"},"videos":[],"remarks":"$undefined","sortOrder":1},{"name":"gis.loadVectorLayerFile","title":"GIS-加载矢量数据文件","description":"全球环境下加载矢量数据文件","params":[{"name":"filePath","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"offset","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"layerType","type":"string","required":true,"defaultValue":"0","description":"0 SHP File，1 GeoJson，2 CustomJson","enumValues":"$undefined"},{"name":"enablePoint","type":"boolean","required":true,"defaultValue":"true","description":"是否启用显示，false则不显示","enumValues":"$undefined"},{"name":"enableLine","type":"string","required":true,"defaultValue":"1","description":"是否启用显示，false则不显示","enumValues":"$undefined"},{"name":"enableFace","type":"boolean","required":true,"defaultValue":"true","description":"是否启用显示，false则不显示","enumValues":"$undefined"},{"name":"snapLand","type":"boolean","required":true,"defaultValue":"true","description":"是否贴合地形，false则不显示","enumValues":"$undefined"},{"name":"pointColor","type":"string","required":true,"defaultValue":"#FFFFFF","description":"","enumValues":"$undefined"},{"name":"lineColor","type":"string","required":true,"defaultValue":"#FFFFFF","description":"","enumValues":"$undefined"},{"name":"faceColor","type":"string","required":true,"defaultValue":"#FFFFFF","description":"","enumValues":"$undefined"},{"name":"faceMaterialId","type":"string","required":true,"defaultValue":"materialId","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.loadVectorLayerFile\",{\n\tfilePath: \"\",\n\toffset: \"\",\n\tlayerType: \"0\", //0 SHP File，1 GeoJson，2 CustomJson\n\tenablePoint: true, //是否启用显示，false则不显示\n\tenableLine: \"1\", //是否启用显示，false则不显示\n\tenableFace: true, //是否启用显示，false则不显示\n\tsnapLand: true, //是否贴合地形，false则不显示\n\tpointColor: \"#FFFFFF\",\n\tlineColor: \"#FFFFFF\",\n\tfaceColor: \"#FFFFFF\",\n\tfaceMaterialId: \"materialId\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":2},{"name":"gis.loadVectorLayerData","title":"GIS-加载矢量图层数据","description":"全球环境下加载矢量图层数据","params":[{"name":"data","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"offset","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"layerType","type":"string","required":true,"defaultValue":"1","description":"1 GeoJson，2 CustomJson","enumValues":"$undefined"},{"name":"enablePoint","type":"boolean","required":true,"defaultValue":"true","description":"是否启用显示，false则不显示","enumValues":"$undefined"},{"name":"enableLine","type":"string","required":true,"defaultValue":"1","description":"是否启用显示，false则不显示","enumValues":"$undefined"},{"name":"enableFace","type":"boolean","required":true,"defaultValue":"true","description":"是否启用显示，false则不显示","enumValues":"$undefined"},{"name":"snapLand","type":"boolean","required":true,"defaultValue":"true","description":"是否贴合地形，false则不显示","enumValues":"$undefined"},{"name":"pointColor","type":"string","required":true,"defaultValue":"#FFFFFF","description":"","enumValues":"$undefined"},{"name":"lineColor","type":"string","required":true,"defaultValue":"#FFFFFF","description":"","enumValues":"$undefined"},{"name":"faceColor","type":"string","required":true,"defaultValue":"#FFFFFF","description":"","enumValues":"$undefined"},{"name":"faceMaterialId","type":"string","required":true,"defaultValue":"materialId","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.loadVectorLayerData\",{\n\t// 通过数据创建图层只支持 GeoJson和CustomJson\n\tfilePath: \"\",\n\toffset: \"\",\n\tlayerType: \"1\", //1 GeoJson，2 CustomJson\n\tenablePoint: true, //是否启用显示，false则不显示\n\tenableLine: \"1\", //是否启用显示，false则不显示\n\tenableFace: true, //是否启用显示，false则不显示\n\tsnapLand: true, //是否贴合地形，false则不显示\n\tpointColor: \"#FFFFFF\",\n\tlineColor: \"#FFFFFF\",\n\tfaceColor: \"#FFFFFF\",\n\tfaceMaterialId: \"materialId\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":3},{"name":"gis.updatePresetLayer","title":"GIS-更新地形预设层","description":"全球环境下更新地形预设层","params":[{"name":"markLayerType","type":"string","required":true,"defaultValue":"0","description":"0 不显示标记图层，1 仅显示地名标记，2 仅显示边界，3 仅显示地名和路网","enumValues":"$undefined"},{"name":"enableLandHeight","type":"string","required":true,"defaultValue":"true","description":"true 开启地形高度，false不开启地形高度","enumValues":"$undefined"},{"name":"backgroundLayerType","type":"string","required":true,"defaultValue":"0","description":"0 必应影像，1 天地图地形，2 天地图矢量，3 天地图影像","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.updatePresetLayer\",{\n\tmarkLayerType: \"0\", //0 不显示标记图层，1 仅显示地名标记，2 仅显示边界，3 仅显示地名和路网\n\tenableLandHeight: \"true\", //true 开启地形高度，false不开启地形高度\n\tbackgroundLayerType: \"0\", //0 必应影像，1 天地图地形，2 天地图矢量，3 天地图影像\n})"},"videos":[],"remarks":"$undefined","sortOrder":4},{"name":"gis.updateVectorLayerFileById","title":"GIS-更新矢量图层文件","description":"全球环境下更新矢量图层文件","params":[{"name":"layerId","type":"string","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"layerType","type":"string","required":true,"defaultValue":"0","description":"0 SHP File，1 GeoJson，2 CustomJson","enumValues":"$undefined"},{"name":"filePath","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"offset","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"enablePoint","type":"boolean","required":true,"defaultValue":"true","description":"是否启用显示，false则不显示","enumValues":"$undefined"},{"name":"enableLine","type":"string","required":true,"defaultValue":"1","description":"是否启用显示，false则不显示","enumValues":"$undefined"},{"name":"enableFace","type":"boolean","required":true,"defaultValue":"true","description":"是否启用显示，false则不显示","enumValues":"$undefined"},{"name":"snapLand","type":"boolean","required":true,"defaultValue":"true","description":"是否贴合地形，false则不显示","enumValues":"$undefined"},{"name":"pointColor","type":"string","required":true,"defaultValue":"#FFFFFF","description":"","enumValues":"$undefined"},{"name":"lineColor","type":"string","required":true,"defaultValue":"#FFFFFF","description":"","enumValues":"$undefined"},{"name":"faceColor","type":"string","required":true,"defaultValue":"#FFFFFF","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.updateVectorLayerFileById\",{\n\tlayerId: \"0\",\n\tlayerType: \"0\", //0 SHP File，1 GeoJson，2 CustomJson\n\tfilePath: \"\",\n\toffset: \"\",\n\tenablePoint: true, //是否启用显示，false则不显示\n\tenableLine: \"1\", //是否启用显示，false则不显示\n\tenableFace: true, //是否启用显示，false则不显示\n\tsnapLand: true, //是否贴合地形，false则不显示\n\tpointColor: \"#FFFFFF\",\n\tlineColor: \"#FFFFFF\",\n\tfaceColor: \"#FFFFFF\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":5},{"name":"gis.addOrUpdateWebMapLayer","title":"GIS-添加或更新网络图层","description":"GIS-添加或更新网络图层","params":[{"name":"bVisiable","type":"string","required":true,"defaultValue":"1","description":"","enumValues":"$undefined"},{"name":"url","type":"string","required":true,"defaultValue":"String","description":"","enumValues":"$undefined"},{"name":"protal","type":"string","required":true,"defaultValue":"WMTS","description":"","enumValues":"$undefined"},{"name":"layer","type":"string","required":true,"defaultValue":"String","description":"","enumValues":"$undefined"},{"name":"style","type":"string","required":true,"defaultValue":"String","description":"","enumValues":"$undefined"},{"name":"format","type":"string","required":true,"defaultValue":"String","description":"","enumValues":"$undefined"},{"name":"bCustomLevel","type":"boolean","required":true,"defaultValue":"true","description":"","enumValues":"$undefined"},{"name":"maxLevel","type":"string","required":true,"defaultValue":"18","description":"","enumValues":"$undefined"},{"name":"minLevel","type":"string","required":true,"defaultValue":"1","description":"","enumValues":"$undefined"},{"name":"tileMatrixSetId","type":"string","required":true,"defaultValue":"String","description":"","enumValues":"$undefined"},{"name":"tileMatrixLabelPrefix","type":"string","required":true,"defaultValue":"String","description":"","enumValues":"$undefined"},{"name":"bUseWebMercator","type":"boolean","required":true,"defaultValue":"true","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.addOrUpdateWebMapLayer\",{\n\tbVisiable: \"1\",\n\turl: \"String\",\n\tprotal: \"WMTS\",\n\tlayer: \"String\",\n\tstyle: \"String\",\n\tformat: \"String\",\n\tbCustomLevel: true,\n\tmaxLevel: \"18\",\n\tminLevel: \"1\",\n\ttileMatrixSetId: \"String\",\n\ttileMatrixLabelPrefix: \"String\",\n\tbUseWebMercator: true\n})"},"videos":[],"remarks":"$undefined","sortOrder":6},{"name":"gis.updateVectorLayerDataById","title":"GIS-更新矢量图层字符串","description":"全球环境下更新矢量图层字符串","params":[{"name":"layerId","type":"string","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"layerType","type":"string","required":true,"defaultValue":"1","description":"1 GeoJson，2 CustomJson","enumValues":"$undefined"},{"name":"data","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"offset","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"enablePoint","type":"boolean","required":true,"defaultValue":"true","description":"是否启用显示，false则不显示","enumValues":"$undefined"},{"name":"enableLine","type":"string","required":true,"defaultValue":"1","description":"是否启用显示，false则不显示","enumValues":"$undefined"},{"name":"enableFace","type":"boolean","required":true,"defaultValue":"true","description":"是否启用显示，false则不显示","enumValues":"$undefined"},{"name":"snapLand","type":"boolean","required":true,"defaultValue":"true","description":"是否贴合地形，false则不显示","enumValues":"$undefined"},{"name":"pointColor","type":"string","required":true,"defaultValue":"#FFFFFF","description":"","enumValues":"$undefined"},{"name":"lineColor","type":"string","required":true,"defaultValue":"#FFFFFF","description":"","enumValues":"$undefined"},{"name":"faceColor","type":"string","required":true,"defaultValue":"#FFFFFF","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.updateVectorLayerDataById\",{\n\tlayerId: \"0\",\n\tlayerType: \"1\", //1 GeoJson，2 CustomJson\n\tdata: \"\",\n\toffset: \"\",\n\tenablePoint: true, //是否启用显示，false则不显示\n\tenableLine: \"1\", //是否启用显示，false则不显示\n\tenableFace: true, //是否启用显示，false则不显示\n\tsnapLand: true, //是否贴合地形，false则不显示\n\tpointColor: \"#FFFFFF\",\n\tlineColor: \"#FFFFFF\",\n\tfaceColor: \"#FFFFFF\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":7},{"name":"gis.focusLayerById","title":"GIS-聚焦图层","description":"全球环境下聚焦到特定图层","params":[{"name":"layerId","type":"string","required":true,"defaultValue":"0","description":"对象ID","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.focusLayerById\",{\n\tlayerId : \"0\", // 对象ID\n})"},"videos":[],"remarks":"$undefined","sortOrder":8},{"name":"gis.removeLayerById","title":"GIS-删除图层","description":"全球环境下删除特定图层","params":[{"name":"layerId","type":"string","required":true,"defaultValue":"0","description":"对象ID","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.removeLayerById\",{\n\tlayerId : \"0\", // 对象ID\n})"},"videos":[],"remarks":"$undefined","sortOrder":9},{"name":"gis.setLayerVisibilityById","title":"GIS-设置图层可见性","description":"全球环境下设置图层可见性","params":[{"name":"layerId","type":"string","required":true,"defaultValue":"0","description":"对象ID","enumValues":"$undefined"},{"name":"visible","type":"string","required":true,"defaultValue":"true","description":"是否可见","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.setLayerVisibilityById\",{\n\tlayerId: \"0\",// 对象ID\n\tvisible: \"true\",// 是否可见\n})"},"videos":[],"remarks":"$undefined","sortOrder":10},{"name":"gis.createProjectionImage","title":"GIS-创建图片投影","description":"创建图片投影","params":[{"name":"imagePath","type":"string","required":true,"defaultValue":"$undefined","description":"投影图片，jpg/png","enumValues":["jpg","png"]},{"name":"position","type":"string","required":true,"defaultValue":"$undefined","description":"位置","enumValues":"$undefined"},{"name":"rotation","type":"string","required":true,"defaultValue":"$undefined","description":"朝向","enumValues":"$undefined"},{"name":"scale","type":"string","required":true,"defaultValue":"$undefined","description":"缩放","enumValues":"$undefined"},{"name":"alpha","type":"number","required":true,"defaultValue":"0.0","description":"透明度 0代表不可见，1代表可见","enumValues":"$undefined"},{"name":"color","type":"string","required":true,"defaultValue":"#FFFFFF","description":"叠加颜色","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.createProjectionImage\",{\n\timagePath: \"\",// 投影图片，jpg/png\n\tposition: \"\",// 位置\n\trotation: \"\",// 朝向\n\tscale: \"\",// 缩放\n\talpha: 0.0,// 透明度 0代表不可见，1代表可见\n\tcolor: \"#FFFFFF\",// 叠加颜色\n})"},"videos":[],"remarks":"$undefined","sortOrder":11},{"name":"gis.updateProjectionImage","title":"GIS-更新图片投影","description":"更新图片投影","params":[{"name":"id","type":"string","required":true,"defaultValue":"$undefined","description":"对象ID","enumValues":"$undefined"},{"name":"imagePath","type":"string","required":true,"defaultValue":"$undefined","description":"投影图片，jpg/png","enumValues":["jpg","png"]},{"name":"position","type":"string","required":true,"defaultValue":"$undefined","description":"位置","enumValues":"$undefined"},{"name":"rotation","type":"string","required":true,"defaultValue":"$undefined","description":"朝向","enumValues":"$undefined"},{"name":"scale","type":"string","required":true,"defaultValue":"$undefined","description":"缩放","enumValues":"$undefined"},{"name":"alpha","type":"number","required":true,"defaultValue":"0.0","description":"透明度","enumValues":"$undefined"},{"name":"color","type":"string","required":true,"defaultValue":"#FFFFFF","description":"叠加颜色","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.updateProjectionImage\",{\n\tid: \"\",// 对象ID\n\timagePath: \"\",// 投影图片，jpg/png\n\tposition: \"\",// 位置\n\trotation: \"\",// 朝向\n\tscale: \"\",// 缩放\n\talpha: 0.0,// 透明度\n\tcolor: \"#FFFFFF\",// 叠加颜色\n})"},"videos":[],"remarks":"$undefined","sortOrder":12},{"name":"gis.showProjectionImageInPipe","title":"GIS-创建管道投影","description":"创建管道外表面投影","params":[{"name":"startId","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"endId","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"deviceWith","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"},{"name":"pipeRadius","type":"string","required":true,"defaultValue":"$undefined","description":"设备半径","enumValues":"$undefined"},{"name":"pipeShowImageRotate","type":"number","required":true,"defaultValue":"0.0","description":"外表面相对于圆心的角度，,逆时针0-360","enumValues":"$undefined"},{"name":"distance","type":"number","required":true,"defaultValue":"0.0","description":"相对于起始点距离","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"imagePath","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"size","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.showProjectionImageInPipe\",{\n\tstartId: \"\",//起点模型id\n\tendId: \"\",//终点模型id\n\tdeviceWith: 0.0,\n\tpipeRadius: \"\", //设备半径\n\tpipeShowImageRotate: 0.0, //外表面相对于圆心的角度，,逆时针0-360\n\tdistance: 0.0, //相对于起始点距离\n\ttag: \"\",\n\timagePath: \"\",//图片路径\n\tsize: \"\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":13},{"name":"gis.createProjectionVideo","title":"GIS-创建投影视频","description":"创建投影视频","params":[{"name":"videoPath","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"position","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"","enumValues":"$undefined"},{"name":"rotation","type":"string","required":true,"defaultValue":"0.0, -90.0, 90.0","description":"","enumValues":"$undefined"},{"name":"scale","type":"string","required":true,"defaultValue":"1.0, 1.0, 1.0","description":"","enumValues":"$undefined"},{"name":"intensity","type":"string","required":true,"defaultValue":"1","description":"","enumValues":"$undefined"},{"name":"order","type":"string","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.createProjectionVideo\",{\n\tvideoPath: \"\",//视频路径\n\tposition: \"0.0, 0.0, 0.0\",//引擎坐标位置\n\trotation: \"0.0, -90.0, 90.0\",//朝向\n\tscale: \"1.0, 1.0, 1.0\",//缩放\n\tintensity: \"1\",\n\torder: \"0\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":14},{"name":"gis.updateProjectionVideo","title":"GIS-更新投影视频","description":"更新投影视频","params":[{"name":"id","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"videoPath","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"position","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"","enumValues":"$undefined"},{"name":"rotation","type":"string","required":true,"defaultValue":"0.0, -90.0, 90.0","description":"","enumValues":"$undefined"},{"name":"scale","type":"string","required":true,"defaultValue":"1.0, 1.0, 1.0","description":"","enumValues":"$undefined"},{"name":"intensity","type":"string","required":true,"defaultValue":"1","description":"","enumValues":"$undefined"},{"name":"order","type":"string","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.updateProjectionVideo\",{\n\tid: \"\",//投影视频对象id\n\tvideoPath: \"\",//视频路径\n\tposition: \"0.0, 0.0, 0.0\",//引擎坐标位置\n\trotation: \"0.0, -90.0, 90.0\",//朝向\n\tscale: \"1.0, 1.0, 1.0\",//缩放\n\tintensity: \"1\",\n\torder: \"0\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":15},{"name":"gis.createCFDObject","title":"GIS-创建CFD对象","description":"创建CFD对象","params":[{"name":"objectType","type":"string","required":true,"defaultValue":"0","description":"0 表面着色模型、1 矢量场模型、2 粒子轨迹模型","enumValues":"$undefined"},{"name":"filePath","type":"string","required":true,"defaultValue":"String","description":"文件路径","enumValues":"$undefined"},{"name":"position","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"位置","enumValues":"$undefined"},{"name":"rotation","type":"string","required":true,"defaultValue":"0.0, -90.0, 90.0","description":"朝向","enumValues":"$undefined"},{"name":"scale","type":"string","required":true,"defaultValue":"1.0, 1.0, 1.0","description":"缩放","enumValues":"$undefined"},{"name":"elementScale","type":"string","required":true,"defaultValue":"0","description":"元素缩放","enumValues":"$undefined"},{"name":"sampleGap","type":"string","required":true,"defaultValue":"0","description":"采样间隔","enumValues":"$undefined"},{"name":"renderType","type":"string","required":true,"defaultValue":"3","description":"渲染类型，0 cube、1 sphere、2 cone、3 arrow","enumValues":"$undefined"},{"name":"centralize","type":"boolean","required":true,"defaultValue":"true","description":"数据居中","enumValues":"$undefined"},{"name":"inverseFace","type":"boolean","required":true,"defaultValue":"true","description":"反转面","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.createCFDObject\",{\n\tobjectType: \"0\", //0 表面着色模型、1 矢量场模型、2 粒子轨迹模型\n\tfilePath: \"String\", //文件路径\n\tposition: \"0.0, 0.0, 0.0\", //位置\n\trotation: \"0.0, -90.0, 90.0\", //朝向\n\tscale: \"1.0, 1.0, 1.0\", //缩放\n\telementScale: \"0\", //元素缩放\n\tsampleGap: \"0\", //采样间隔\n\trenderType: \"3\", //渲染类型，0 cube、1 sphere、2 cone、3 arrow\n\tcentralize: true, //数据居中\n\tinverseFace: true, //反转面\n})"},"videos":[],"remarks":"$undefined","sortOrder":16},{"name":"gis.updateCFDObject","title":"GIS-更新CFD对象","description":"更新CFD对象","params":[{"name":"id","type":"string","required":true,"defaultValue":"String","description":"","enumValues":"$undefined"},{"name":"objectType","type":"string","required":true,"defaultValue":"0","description":"0 表面着色模型、1 矢量场模型、2 粒子轨迹模型","enumValues":"$undefined"},{"name":"filePath","type":"string","required":true,"defaultValue":"String","description":"文件路径","enumValues":"$undefined"},{"name":"position","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"位置","enumValues":"$undefined"},{"name":"rotation","type":"string","required":true,"defaultValue":"0.0, -90.0, 90.0","description":"朝向","enumValues":"$undefined"},{"name":"scale","type":"string","required":true,"defaultValue":"1.0, 1.0, 1.0","description":"缩放","enumValues":"$undefined"},{"name":"elementScale","type":"string","required":true,"defaultValue":"0","description":"元素缩放","enumValues":"$undefined"},{"name":"sampleGap","type":"string","required":true,"defaultValue":"0","description":"采样间隔","enumValues":"$undefined"},{"name":"renderType","type":"string","required":true,"defaultValue":"3","description":"渲染类型，0 cube、1 sphere、2 cone、3 arrow","enumValues":"$undefined"},{"name":"centralize","type":"boolean","required":true,"defaultValue":"true","description":"数据居中","enumValues":"$undefined"},{"name":"inverseFace","type":"boolean","required":true,"defaultValue":"true","description":"反转面","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.updateCFDObject\",{\n\tid: \"String\",\n\tobjectType: \"0\", //0 表面着色模型、1 矢量场模型、2 粒子轨迹模型\n\tfilePath: \"String\", //文件路径\n\tposition: \"0.0, 0.0, 0.0\", //位置\n\trotation: \"0.0, -90.0, 90.0\", //朝向\n\tscale: \"1.0, 1.0, 1.0\", //缩放\n\telementScale: \"0\", //元素缩放\n\tsampleGap: \"0\", //采样间隔\n\trenderType: \"3\", //渲染类型，0 cube、1 sphere、2 cone、3 arrow\n\tcentralize: true, //数据居中\n\tinverseFace: true, //反转面\n})"},"videos":[],"remarks":"$undefined","sortOrder":17},{"name":"gis.createProjectionVideo2","title":"GIS-创建视频融合2.0","description":"创建视频融合","params":[{"name":"videoPath","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"position","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"","enumValues":"$undefined"},{"name":"rotation","type":"string","required":true,"defaultValue":"0.0, -90.0, 0.0","description":"","enumValues":"$undefined"},{"name":"scale","type":"string","required":true,"defaultValue":"1.0, 1.0, 1.0","description":"","enumValues":"$undefined"},{"name":"intensity","type":"string","required":true,"defaultValue":"1","description":"","enumValues":"$undefined"},{"name":"distance","type":"string","required":true,"defaultValue":"100000","description":"","enumValues":"$undefined"},{"name":"FOV","type":"string","required":true,"defaultValue":"30","description":"","enumValues":"$undefined"},{"name":"aspectRatio","type":"string","required":true,"defaultValue":"1","description":"","enumValues":"$undefined"},{"name":"uvOffset","type":"string","required":true,"defaultValue":"0, 0","description":"","enumValues":"$undefined"},{"name":"uvScale","type":"string","required":true,"defaultValue":"1.0, 1.0","description":"","enumValues":"$undefined"},{"name":"featheringSize","type":"string","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"featheringAttenuation","type":"string","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.createProjectionVideo2\",{\n \"videoPath\": \"\", // 文件路径需额外添加转义符，如：\"D:\\project\\filename.mp4\"需要写成\"D:\\\\project\\\\filename.mp4\"\n \"position\": \"1131.05, -148.33, 161.1\", // 位置坐标\n \"rotation\": \"0.0, -33.900002 , -30.9\", //旋转坐标\n \"scale\": \"1.0, 1.0, 1.0\", // 缩放大小\n \"intensity\": \"1\", // 画面亮度\n \"distance\": \"100000\", // 投影距离\n \"FOV\": \"30\", // 视角FOV\n \"aspectRatio\": \"1\", // 画面宽高比\n \"uvOffset\": \"0, 0\", // UV偏移X,UV偏移Y\n \"uvScale\": \"1.0, 1.0\", // UV重复X,UV重复Y\n \"featheringSize\": \"0\", // 羽化率\n \"featheringAttenuation\": \"0\" // 羽化衰减\n})"},"videos":[],"remarks":"$undefined","sortOrder":18},{"name":"gis.updateProjectionVideo2","title":"GIS-更新视频融合2.0","description":"更新视频融合2.0","params":[{"name":"id","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"videoPath","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"position","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"","enumValues":"$undefined"},{"name":"rotation","type":"string","required":true,"defaultValue":"0.0, -90.0, 0.0","description":"","enumValues":"$undefined"},{"name":"scale","type":"string","required":true,"defaultValue":"1.0, 1.0, 1.0","description":"","enumValues":"$undefined"},{"name":"intensity","type":"string","required":true,"defaultValue":"1","description":"","enumValues":"$undefined"},{"name":"distance","type":"string","required":true,"defaultValue":"100000","description":"","enumValues":"$undefined"},{"name":"FOV","type":"string","required":true,"defaultValue":"30","description":"","enumValues":"$undefined"},{"name":"aspectRatio","type":"string","required":true,"defaultValue":"1","description":"","enumValues":"$undefined"},{"name":"uvOffset","type":"string","required":true,"defaultValue":"0, 0","description":"","enumValues":"$undefined"},{"name":"uvScale","type":"string","required":true,"defaultValue":"1.0, 1.0","description":"","enumValues":"$undefined"},{"name":"featheringSize","type":"string","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"featheringAttenuation","type":"string","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.updateProjectionVideo2\",{\n id: \"\",\n\tvideoPath: \"\",\n\tposition: \"0.0, 0.0, 0.0\",\n\trotation: \"0.0, -90.0, 0.0\",\n\tscale: \"1.0, 1.0, 1.0\",\n\tintensity: \"1\",\n\tdistance: \"100000\",\n\tFOV: \"30\",\n\taspectRatio: \"1\",\n\tuvOffset: \"0, 0\",\n\tuvScale: \"1.0, 1.0\",\n\tfeatheringSize: \"0\",\n\tfeatheringAttenuation: \"0\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":19},{"name":"gis.enableFieldViewPickup","title":"GIS-开启粒子场采样","description":"开启粒子场鼠标点选采样","params":[{"name":"enable","type":"string","required":true,"defaultValue":"true","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.enableFieldViewPickup\",{\n enable: \"true\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":20},{"name":"gis.playPathField","title":"GIS-播放粒子场轨迹","description":"播放粒子场轨迹","params":[{"name":"id","type":"string","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"type","type":"string","required":true,"defaultValue":"0","description":"0 停止播放，1从头开始播放，2暂停播放，3继续播放","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.playPathField\",{\n id: \"0\",\n\ttype: \"0\", //0 停止播放，1从头开始播放，2暂停播放，3继续播放\n})"},"videos":[],"remarks":"$undefined","sortOrder":21},{"name":"gis.highlight3DTileWithId","title":"GIS-高亮3D瓦片组件","description":"高亮3D瓦片组件","params":[{"name":"id","type":"string","required":true,"defaultValue":"0","description":"唯一标记组件的ID","enumValues":"$undefined"},{"name":"globalSelectColor","type":"string","required":true,"defaultValue":"#00FF00","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.highlight3DTileWithId\",{\n\tid: \"0\", //唯一标记组件的ID\n\tglobalSelectColor: \"#00FF00\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":22},{"name":"gis.flushProjectionVideo","title":"GIS-刷新投影视频组件","description":"刷新投影视频组件，刷新会更新组件","params":[{"name":"id","type":"string","required":true,"defaultValue":"0","description":"唯一标记组件的ID","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.flushProjectionVideo\",{\n\tid: \"0\", //唯一标记组件的ID\n})"},"videos":[],"remarks":"$undefined","sortOrder":23},{"name":"gis.initVisibleStateOf3DTiles","title":"GIS-初始化3D瓦片组件可见性","description":"初始化3D瓦片组件可见性","params":[{"name":"id","type":"string","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"visiableState","type":"string","required":true,"defaultValue":"0","description":"设置Feature的可见性，格式如下：","enumValues":"$undefined"},{"name":"resetVisibility","type":"boolean","required":true,"defaultValue":"true","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.initVisibleStateOf3DTiles\",{\n\tid: \"0\",\n\tvisiableState: \"0\", //设置Feature的可见性，格式如下：ID1：1 / ID2：0 ...\n\tresetVisibility: true,\n})"},"videos":[],"remarks":"$undefined","sortOrder":24},{"name":"gis.updateVisibilityOf3DTilesSection","title":"GIS-设置或更新3D瓦片组件可见性","description":"设置或更新3D瓦片组件可见性","params":[{"name":"id","type":"string","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"sectionId","type":"string","required":true,"defaultValue":"0","description":"可以是ID，也可以是分类，具体取决于瓦片设置里指定的哪个字段","enumValues":"$undefined"},{"name":"visiable","type":"boolean","required":true,"defaultValue":"true","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.updateVisibilityOf3DTilesSection\",{\n\tid: \"0\",\n\tsectionId: \"0\", //可以是ID，也可以是分类，具体取决于瓦片设置里指定的哪个字段\n\tvisiable: true,\n})"},"videos":[],"remarks":"$undefined","sortOrder":25},{"name":"gis.setUnControlSectionVisibilityOf3DTiles","title":"GIS-设置3D瓦片其余部分的可见性","description":"设置3D瓦片其余部分的可见性","params":[{"name":"id","type":"string","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"restVisiable","type":"boolean","required":true,"defaultValue":"true","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"gis.setUnControlSectionVisibilityOf3DTiles\",{\n\tid: \"0\",\n\trestVisiable: true,\n})"},"videos":[],"remarks":"$undefined","sortOrder":26}]},{"name":"IOT","description":"IOT模块，提供物联网行业支持","sortOrder":5,"apis":[{"name":"iot.createObject","title":"IOT-创建交互对象","description":"创建物联网交互对象","params":[{"name":"url","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"iot.createObject\",{\n\turl: \"\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":0},{"name":"iot.objectStatusUpdate","title":"IOT-交互对象状态更新","description":"交互对象的状态更新","params":[{"name":"url","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"iot.objectStatusUpdate\",{\n\turl: \"\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":1},{"name":"iot.objectEventBinding","title":"IOT-交互对象事件绑定","description":"交互对象事件绑定","params":[{"name":"url","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"iot.objectEventBinding\",{\n\turl: \"\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":2},{"name":"iot.objectPropertyChange","title":"IOT-交互对象属性变更","description":"交互对象属性变更","params":[{"name":"iotId","type":"string","required":true,"defaultValue":"$undefined","description":"原生模型和孪生体自定义的iotid","enumValues":"$undefined"},{"name":"propName","type":"string","required":true,"defaultValue":"$undefined","description":"原生模型和孪生体属性名称","enumValues":"$undefined"},{"name":"propValue","type":"string","required":true,"defaultValue":"$undefined","description":"原生模型和孪生体属性值","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"iot.objectPropertyChange\",{\n\tiotId: \"\",//原生模型和孪生体自定义的iotid\n\tpropName: \"\",//原生模型和孪生体属性名称\n\tpropValue: \"\",//原生模型和孪生体属性值\n})"},"videos":[],"remarks":"$undefined","sortOrder":3},{"name":"iot.objectEvent","title":"IOT-对象事件","description":"交互对象事件绑定","params":[{"name":"iotId","type":"string","required":true,"defaultValue":"$undefined","description":"原生模型和孪生体自定义的iotid","enumValues":"$undefined"},{"name":"eventName","type":"string","required":true,"defaultValue":"$undefined","description":"原生模型和孪生体属性名称","enumValues":"$undefined"},{"name":"props","type":"string","required":true,"defaultValue":"$undefined","description":"原生模型和孪生体属性值","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"iot.objectEvent\",{\n\tiotId: \"\",//原生模型和孪生体自定义的iotid\n\teventName: \"\",//原生模型和孪生体属性名称\n\tprops: \"\",//原生模型和孪生体属性值\n})"},"videos":[],"remarks":"$undefined","sortOrder":4},{"name":"iot.objectAction","title":"IOT-交互对象动作","description":"交互对象动作触发","params":[{"name":"iotId","type":"string","required":true,"defaultValue":"$undefined","description":"原生模型和孪生体自定义的iotid","enumValues":"$undefined"},{"name":"actionName","type":"string","required":true,"defaultValue":"$undefined","description":"动作名","enumValues":"$undefined"},{"name":"props","type":"string","required":true,"defaultValue":"$undefined","description":"参数","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"iot.objectAction\",{\n\tiotId: \"\",//原生模型和孪生体自定义的iotid\n\tactionName: \"\",//动作名\n\tprops: \"\",//参数\n})"},"videos":[],"remarks":"$undefined","sortOrder":5},{"name":"iot.offsetTransform","title":"IOT-位置偏移","description":"IOT对象位置偏移","params":[{"name":"iotId","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"location","type":"string","required":true,"defaultValue":"$undefined","description":"x,y,z","enumValues":"$undefined"},{"name":"rotation","type":"string","required":true,"defaultValue":"$undefined","description":"x,y,z","enumValues":"$undefined"},{"name":"scale","type":"string","required":true,"defaultValue":"$undefined","description":"x,y,z","enumValues":"$undefined"},{"name":"duration","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"},{"name":"rate","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"iot.offsetTransform\",{\n\tiotId: \"\",\n\tlocation: \"\", //x,y,z\n\trotation: \"\", //x,y,z\n\tscale: \"\", //x,y,z\n\tduration: 0.0,\n\trate: 0.0,\n})"},"videos":[],"remarks":"$undefined","sortOrder":6},{"name":"iot.attachTo","title":"IOT-附加","description":"IOT对象附加","params":[{"name":"iotId","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"iotAttachToId","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"iot.attachTo\",{\n\tiotId: \"\",\n\tiotAttachToId: \"\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":7},{"name":"iot.moveByPath","title":"IOT-路径移动","description":"IOT沿路径移动","params":[{"name":"iotId","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"path","type":"string","required":true,"defaultValue":"ObjectName","description":"","enumValues":"$undefined"},{"name":"duration","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"},{"name":"rate","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"iot.moveByPath\",{\n\tiotId: \"\",\n\tpath: \"ObjectName\",\n\tduration: 0.0,\n\trate: 0.0,\n})"},"videos":[],"remarks":"$undefined","sortOrder":8}]},{"name":"Light","description":"","sortOrder":6,"apis":[{"name":"light.intensity","title":"光源-强度","description":"光源-强度","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的光源","enumValues":"$undefined"},{"name":"lightIntensity","type":"number","required":true,"defaultValue":"0.0","description":"光源强度","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"light.intensity\",{\n\ttarget: \"ObjectId\", //场景中的光源\n\tlightIntensity: 0.0, //光源强度\n})"},"videos":[],"remarks":"$undefined","sortOrder":0},{"name":"light.pointLightradius","title":"光源-半径","description":"光源-半径","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的光源","enumValues":"$undefined"},{"name":"lightRadius","type":"number","required":true,"defaultValue":"0.0","description":"作用半径","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"light.pointLightradius\",{\n\ttarget: \"ObjectId\", //场景中的光源\n\tlightRadius: 0.0, //作用半径\n})"},"videos":[],"remarks":"$undefined","sortOrder":1},{"name":"light.color","title":"光源-颜色","description":"光源-颜色","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的光源","enumValues":"$undefined"},{"name":"lightcolor","type":"string","required":true,"defaultValue":"#FFFFFF","description":"光源颜色","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"light.color\",{\n\ttarget: \"ObjectId\", //场景中的光源\n\tlightcolor: \"#FFFFFF\", //光源颜色\n})"},"videos":[],"remarks":"$undefined","sortOrder":2},{"name":"light.lightRotation","title":"光源-角度","description":"光源-角度","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的光源","enumValues":"$undefined"},{"name":"lightRotation","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"光源角度","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"light.lightRotation\",{\n\ttarget: \"ObjectId\", //场景中的光源\n\tlightRotation: \"0.0, 0.0, 0.0\", //光源角度\n})"},"videos":[],"remarks":"$undefined","sortOrder":3},{"name":"light.shadowResolutionScale","title":"光源-阴影柔化","description":"光源-阴影柔化","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的光源","enumValues":"$undefined"},{"name":"shadowResolutionScale","type":"number","required":true,"defaultValue":"0.0","description":"阴影柔化","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"light.shadowResolutionScale\",{\n\ttarget: \"ObjectId\", //场景中的光源\n\tshadowResolutionScale: 0.0, //阴影柔化\n})"},"videos":[],"remarks":"$undefined","sortOrder":4},{"name":"light.shadowSharpen","title":"光源-阴影锐化","description":"光源-阴影锐化","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的光源","enumValues":"$undefined"},{"name":"shadowSharpen","type":"number","required":true,"defaultValue":"0.0","description":"阴影锐化","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"light.shadowSharpen\",{\n\ttarget: \"ObjectId\", //场景中的光源\n\tshadowSharpen: 0.0, //阴影锐化\n})"},"videos":[],"remarks":"$undefined","sortOrder":5},{"name":"light.sourceLength","title":"光源-长度","description":"光源-长度","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的光源","enumValues":"$undefined"},{"name":"sourceLength","type":"number","required":true,"defaultValue":"0.0","description":"光源长度","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"light.sourceLength\",{\n\ttarget: \"ObjectId\", //场景中的光源\n\tsourceLength: 0.0, //光源长度\n})"},"videos":[],"remarks":"$undefined","sortOrder":6},{"name":"light.innerConeAngle","title":"聚光源-内角","description":"聚光源-内角","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的聚光源","enumValues":"$undefined"},{"name":"innerConeAngle","type":"number","required":true,"defaultValue":"0.0","description":"光源内角","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"light.innerConeAngle\",{\n\ttarget: \"ObjectId\", //场景中的聚光源\n\tinnerConeAngle: 0.0, //光源内角\n})"},"videos":[],"remarks":"$undefined","sortOrder":7},{"name":"light.outerConeAngle","title":"聚光源-外角","description":"聚光源-外角","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的聚光源","enumValues":"$undefined"},{"name":"outerConeAngle","type":"number","required":true,"defaultValue":"0.0","description":"光源外角","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"light.outerConeAngle\",{\n\ttarget: \"ObjectId\", //场景中的聚光源\n\touterConeAngle: 0.0, //光源外角\n})"},"videos":[],"remarks":"$undefined","sortOrder":8},{"name":"light.sourceWidth","title":"面光源-宽度","description":"面光源-宽度","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的面光源","enumValues":"$undefined"},{"name":"sourceWidth","type":"number","required":true,"defaultValue":"0.0","description":"光源宽度","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"light.sourceWidth\",{\n\ttarget: \"ObjectId\", //场景中的面光源\n\tsourceWidth: 0.0, //光源宽度\n})"},"videos":[],"remarks":"$undefined","sortOrder":9},{"name":"light.sourceHeight","title":"面光源-高度","description":"面光源-高度","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的面光源","enumValues":"$undefined"},{"name":"sourceHeight","type":"number","required":true,"defaultValue":"0.0","description":"光源高度","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"light.sourceHeight\",{\n\ttarget: \"ObjectId\", //场景中的面光源\n\tsourceHeight: 0.0, //光源高度\n})"},"videos":[],"remarks":"$undefined","sortOrder":10},{"name":"light.barnDoorAngle","title":"面光源-矩边角度","description":"面光源-矩边角度","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的面光源","enumValues":"$undefined"},{"name":"barnDoorAngle","type":"number","required":true,"defaultValue":"0.0","description":"矩边角度","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"light.barnDoorAngle\",{\n\ttarget: \"ObjectId\", //场景中的面光源\n\tbarnDoorAngle: 0.0, //矩边角度\n})"},"videos":[],"remarks":"$undefined","sortOrder":11},{"name":"light.barnDoorLength","title":"面光源-矩边长度","description":"面光源-矩边长度","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的面光源","enumValues":"$undefined"},{"name":"barnDoorLength","type":"number","required":true,"defaultValue":"0.0","description":"矩边长度","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"light.barnDoorLength\",{\n\ttarget: \"ObjectId\", //场景中的面光源\n\tbarnDoorLength: 0.0, //矩边长度\n})"},"videos":[],"remarks":"$undefined","sortOrder":12},{"name":"light.shadowDistance","title":"定向光源-阴影距离","description":"定向光源-阴影距离","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的光源","enumValues":"$undefined"},{"name":"shadowDistance","type":"number","required":true,"defaultValue":"0.0","description":"阴影距离","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"light.shadowDistance\",{\n\ttarget: \"ObjectId\", //场景中的光源\n\tshadowDistance: 0.0, //阴影距离\n})"},"videos":[],"remarks":"$undefined","sortOrder":13}]},{"name":"Mode","description":"模式模块主要做编辑模式的管理","sortOrder":7,"apis":[{"name":"mode.enterPlayMode","title":"(模式-进入预览模式)","description":"(进入预览模式)","params":[{"name":"defaultPageId","type":"string","required":true,"defaultValue":"$undefined","description":"默认加载的页面ID","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"mode.enterPlayMode\",{ \n\tdefaultPageId: \"\", //默认加载的页面ID\n})"},"videos":[],"remarks":"$undefined","sortOrder":0},{"name":"mode.event","title":"(模式-通用事件)","description":"(通用的事件触发，从外部通知PiClient事件的发生)","params":[{"name":"action","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"params","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"mode.event\",{ \n\taction: \"\",\n\ttarget: \"ObjectId\",\n\tparams: \"\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":1},{"name":"mode.enableTransparency","title":"(模式-启用设计器UI穿透)","description":"(是否让设计器的UI可以穿透交互)","params":[{"name":"enable","type":"boolean","required":true,"defaultValue":"true","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"mode.enableTransparency\",{ \n\tenable: true,\n})"},"videos":[],"remarks":"$undefined","sortOrder":2},{"name":"scene.moveCameraByOffset","title":"(场景-相机平面偏移相机)","description":"(在相机平面偏移相机)","params":[{"name":"offsetX","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"},{"name":"offsetY","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"scene.moveCameraByOffset\",{ \n\toffsetX: 0.0,\n\toffsetY: 0.0,\n})"},"videos":[],"remarks":"$undefined","sortOrder":3}]},{"name":"Objects","description":"","sortOrder":8,"apis":[{"name":"object.create","title":"对象-创建","description":"创建对象","params":[{"name":"objectId","type":"string","required":true,"defaultValue":"$undefined","description":"对象Id,选择模型后点击模型栏右上角的切换预览面板显示状态按钮，预览面板的对象ID的值,只在编辑情况下生效","enumValues":"$undefined"},{"name":"objectPath","type":"string","required":true,"defaultValue":"$undefined","description":"对象路径,选择模型后点击模型栏右上角的切换预览面板显示状态按钮，预览面板的对象路径的值，必填，直接运行加载模式也能生效","enumValues":"$undefined"},{"name":"DTOID","type":"string","required":true,"defaultValue":"$undefined","description":"DTO对象资源ID","enumValues":"$undefined"},{"name":"objectType","type":"string","required":true,"defaultValue":"EAT_MESH","description":"EAT_MESH(模型)/EAT_SKELETAL(骨骼动画)/EAT_DATASMITH(Datasmith)/EAT_OBJECT(蓝图/POI等)/EAT_DTO(孪生体)/EAT_CAMERA(相机)","enumValues":"$undefined"},{"name":"parentId","type":"string","required":true,"defaultValue":"$undefined","description":"可以填写绑定到指定id的模型成为父级","enumValues":"$undefined"},{"name":"parentTag","type":"string","required":true,"defaultValue":"$undefined","description":"跟ID二选一，ID优先","enumValues":"$undefined"},{"name":"offset","type":"string","required":true,"defaultValue":"$undefined","description":"相对父级的位置偏移量===》 0,0,0格式，对应以父级为中心的x,y,z的偏移","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"标签，创建物体是可设置自定义标签，可以调用另一个api根据标签获取创建的模型id等数据","enumValues":"$undefined"},{"name":"iotID","type":"string","required":true,"defaultValue":"$undefined","description":"IOT对象设置iotID值","enumValues":"$undefined"},{"name":"engine","type":"string","required":true,"defaultValue":"$undefined","description":"引擎坐标","enumValues":"$undefined"},{"name":"geo","type":"string","required":false,"defaultValue":"$undefined","description":"经度,纬度,高程高程为可选值","enumValues":"$undefined"},{"name":"rotation","type":"string","required":true,"defaultValue":"$undefined","description":"朝向roll,pitch,yaw","enumValues":"$undefined"},{"name":"scale","type":"string","required":true,"defaultValue":"1.0,1.0,1.0","description":"缩放x,y,z","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.create\",{ \n objectId: \"\",//对象Id,选择模型后点击模型栏右上角的切换预览面板显示状态按钮，预览面板的对象ID的值,只在编辑情况下生效\n\tobjectPath: \"\",//对象路径,选择模型后点击模型栏右上角的切换预览面板显示状态按钮，预览面板的对象路径的值，必填，直接运行加载模式也能生效\n\tDTOID: \"\", //DTO对象资源ID\n\tobjectType: \"\",//EAT_MESH(模型)/EAT_SKELETAL(骨骼动画)/EAT_DATASMITH(Datasmith)/EAT_OBJECT(蓝图/POI等)/EAT_DTO(孪生体)/EAT_CAMERA(相机)\n\tparentId: \"\",//可以填写绑定到指定id的模型成为父级\n\tparentTag: \"\", //跟ID二选一，ID优先\n\toffset: \"\",//相对父级的位置偏移量===》 0,0,0格式，对应以父级为中心的x,y,z的偏移\n\ttag: \"\",//标签，创建物体是可设置自定义标签，可以调用另一个api根据标签获取创建的模型id等数据\n\tiotID: \"\", //IOT对象设置iotID值\n\tengine: \"\",//引擎坐标\n\tgeo: \"\", //经度,纬度,高程高程为可选值\n\trotation: \"\", //朝向roll,pitch,yaw\n\tscale: \"1.0,1.0,1.0\", //缩放x,y,z\n})"},"videos":[],"remarks":"$undefined","sortOrder":0},{"name":"object.move","title":"对象-移动","description":"移动对象，参数offset/engine/geo三选一，都提供则geo >> engine >> offset","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"目标","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"标签","enumValues":"$undefined"},{"name":"parent","type":"string","required":true,"defaultValue":"ObjectId","description":"父对象","enumValues":"$undefined"},{"name":"offset","type":"string","required":true,"defaultValue":"$undefined","description":"偏移 x,y,z","enumValues":"$undefined"},{"name":"engine","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"引擎坐标","enumValues":"$undefined"},{"name":"geo","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"经度,纬度,高程","enumValues":"$undefined"},{"name":"rotation","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"朝向 roll,pitch,yaw","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.move\",{\n\ttarget: \"ObjectId\",//目标\n\ttag: \"\",//标签\n\tparent: \"ObjectId\",//父对象\n\toffset: \"\", //偏移 x,y,z\n\tengine: \"0.0, 0.0, 0.0\",//引擎坐标\n\tgeo: \"0.0, 0.0, 0.0\", //经度,纬度,高程\n\trotation: \"0.0, 0.0, 0.0\", //朝向 roll,pitch,yaw\n})"},"videos":[],"remarks":"$undefined","sortOrder":1},{"name":"object.visible","title":"对象-显示隐藏","description":"显示隐藏对象","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"单个目标","enumValues":"$undefined"},{"name":"targets","type":"array","required":true,"defaultValue":"[Object1, Object2, Object3, ...]","description":"多个目标，单个目标和多个目标互斥，使用哪个另一个就需要删掉","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"tags","type":"array","required":true,"defaultValue":"[Object1, Object2, Object3, ...]","description":"多个目标，单个目标和多个目标互斥，使用哪个另一个就需要删掉","enumValues":"$undefined"},{"name":"visible","type":"string","required":true,"defaultValue":"toggle","description":"可见性 show / hide / toggle","enumValues":"$undefined"},{"name":"bAffectChild","type":"string","required":true,"defaultValue":"true","description":"true/false","enumValues":["true","false"]}],"returns":[{"name":"result","type":"示例数据","required":false,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"object.visible\",{\n\ttarget: \"ObjectId\",//单个目标\n\ttargets: [Object1, Object2, Object3, ...],//多个目标，单个目标和多个目标互斥，使用哪个另一个就需要删掉\n\ttag: \"\",\n\ttags: [Object1, Object2, Object3, ...],//多个目标，单个目标和多个目标互斥，使用哪个另一个就需要删掉\n\tvisible: \"toggle\",//可见性 show / hide / toggle\n\tbAffectChild: \"true\", //true/false\n})"},"videos":[],"remarks":"$undefined","sortOrder":2},{"name":"object.destroy","title":"对象-销毁","description":"销毁对象","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"模型id,两个参数二选一","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"模型id_Spawn","description":"模型名称+ _Spawn，只有车位场景才能使用","enumValues":"$undefined"}],"returns":[{"name":"result","type":"示例数据","required":false,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"object.destroy\",{\n\ttarget: \"ObjectId\",//目标\n\ttag: \"模型id_Spawn\",//模型名称+ _Spawn，只有车位场景才能使用\n})"},"videos":[],"remarks":"$undefined","sortOrder":3},{"name":"object.layerVisible","title":"对象-图层显隐","description":"图层显隐","params":[{"name":"layerName","type":"string","required":true,"defaultValue":"$undefined","description":"图层名","enumValues":"$undefined"},{"name":"visible","type":"string","required":true,"defaultValue":"toggle","description":"可见性 show / hide / toggle","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.layerVisible\",{\n\tlayerName: \"\",//图层名\n\tvisible: \"toggle\",//可见性 show / hide / toggle\n})"},"videos":[],"remarks":"$undefined","sortOrder":4},{"name":"object.setMaterial","title":"对象-设置材质","description":"设置材质","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"目标对象","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"模型标记","enumValues":"$undefined"},{"name":"componentIndex","type":"string","required":true,"defaultValue":"0","description":"组件序号,-1表示所有组件全部替换","enumValues":"$undefined"},{"name":"sectionIndex","type":"string","required":true,"defaultValue":"0","description":"材质位置序号，-1表示所有部位全部替换","enumValues":"$undefined"},{"name":"materialId","type":"string","required":true,"defaultValue":"$undefined","description":"从材质库中选择材质并从预览详情页面获取材质ID","enumValues":"$undefined"},{"name":"materialPath","type":"string","required":true,"defaultValue":"$undefined","description":"从材质库中选择材质并从预览详情页面获取材质路径","enumValues":"$undefined"},{"name":"children","type":"boolean","required":true,"defaultValue":"true","description":"是否连所有子对象一起处理","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.setMaterial\",{\n\ttarget: \"ObjectId\",//目标对象\n\ttag: \"\",//模型标记\n\tcomponentIndex: \"0\", //组件序号,-1表示所有组件全部替换\n\tsectionIndex: \"0\", //材质位置序号，-1表示所有部位全部替换\n\tmaterialId: \"\", //从材质库中选择材质并从详情页面获取材质ID\n\tmaterialPath: \"\", //从材质库中选择材质并从预览详情页面获取材质路径\n\tchildren: true, //是否连所有子对象一起处理\n})"},"videos":[],"remarks":"$undefined","sortOrder":5},{"name":"object.callFunction","title":"对象-调用函数","description":"调用函数，暂不支持传参，可以是Actor子类的蓝图目标","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"可以是Actor子类的蓝图目标(虽然大纲视图不显示)","enumValues":"$undefined"},{"name":"function","type":"string","required":true,"defaultValue":"$undefined","description":"暂不支持传参","enumValues":"$undefined"}],"returns":[{"name":"result","type":"示例数据","required":false,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"object.callFunction\",{\n\ttarget: \"ObjectId\", //可以是Actor子类的蓝图目标(虽然大纲视图不显示)\n\tfunction: \"\", //暂不支持传参\n})"},"videos":[],"remarks":"$undefined","sortOrder":6},{"name":"object.playAnimation","title":"对象-播放动画","description":"播放动画","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"必须是动画对象","enumValues":"$undefined"},{"name":"bPlay","type":"string","required":true,"defaultValue":"true","description":"true播放动画/false暂停动画","enumValues":"$undefined"},{"name":"LoopPlay","type":"string","required":false,"defaultValue":"1","description":"-1表示循环播放","enumValues":"$undefined"},{"name":"PlayRate","type":"string","required":false,"defaultValue":"1.0","description":"-1表示倒放动画","enumValues":"$undefined"},{"name":"StartOffset","type":"string","required":false,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"bRandomStart","type":"boolean","required":false,"defaultValue":"true","description":"是否随机开始","enumValues":"$undefined"},{"name":"bRestoreStatus","type":"boolean","required":false,"defaultValue":"true","description":"是否恢复","enumValues":"$undefined"},{"name":"playbackPercent","type":"string","required":false,"defaultValue":"$undefined","description":"播放到动画的百分比，0为开头，100为结尾","enumValues":"$undefined"}],"returns":[{"name":"result","type":"示例数据","required":false,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"object.playAnimation\",{\n\ttarget: \"ObjectId\", //必须是动画对象\n\tbPlay: \"true\", //true播放动画/false暂停动画\n\tLoopPlay: \"1\", //-1表示循环播放\n\tPlayRate: \"1.0\", //-1表示倒放动画\n\tStartOffset: \"0\",\n\tbRandomStart: true, //是否随机开始\n\tbRestoreStatus: true, //是否恢复\n})"},"videos":[],"remarks":"$undefined","sortOrder":7},{"name":"object.playAnimationSet","title":"对象-播放动画集","description":"播放动画集","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"必须是动画集对象","enumValues":"$undefined"},{"name":"Animation","type":"string","required":true,"defaultValue":"$undefined","description":"动画名称","enumValues":"$undefined"},{"name":"bPlay","type":"string","required":true,"defaultValue":"false","description":"播放动画/暂停动画","enumValues":"$undefined"},{"name":"LoopPlay","type":"string","required":true,"defaultValue":"1","description":"-1表示循环播放","enumValues":"$undefined"},{"name":"PlayRate","type":"string","required":true,"defaultValue":"1.0","description":"-1表示倒放动画","enumValues":"$undefined"},{"name":"StartOffset","type":"string","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"bRandomStart","type":"boolean","required":true,"defaultValue":"true","description":"是否随机开始","enumValues":"$undefined"},{"name":"bRestoreStatus","type":"boolean","required":true,"defaultValue":"true","description":"是否恢复","enumValues":"$undefined"},{"name":"RestoreLastStatus","type":"string","required":true,"defaultValue":"ERLS_RESET","description":"恢复上一个动画，ERLS_RESET(重置)/ERLS_REVERSE(反转)/ERLS_RETAIN(保留)","enumValues":"$undefined"}],"returns":[{"name":"result","type":"示例数据","required":false,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"object.playAnimationSet\",{\n\ttarget: \"ObjectId\", //必须是动画集对象\n\tAnimation: \"\", //动画名称\n\tbPlay: \"false\", //播放动画/暂停动画\n\tLoopPlay: \"1\", //-1表示循环播放\n\tPlayRate: \"1.0\", //-1表示倒放动画\n\tStartOffset: \"0\",\n\tbRandomStart: true, //是否随机开始\n\tbRestoreStatus: true, //是否恢复\n\tRestoreLastStatus: \"ERLS_RESET\", //恢复上一个动画，ERLS_RESET(重置)/ERLS_REVERSE(反转)/ERLS_RETAIN(保留)\n})"},"videos":[],"remarks":"$undefined","sortOrder":8},{"name":"object.playAnimationInstance","title":"对象-播放物体动画","description":"播放物体动画","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"必须带物体动画的对象","enumValues":"$undefined"},{"name":"bPlay","type":"string","required":true,"defaultValue":"true","description":"播放动画/暂停动画","enumValues":"$undefined"},{"name":"bLooping","type":"string","required":true,"defaultValue":"true","description":"true表示循环播放","enumValues":"$undefined"},{"name":"PlayRate","type":"string","required":true,"defaultValue":"1.0","description":"-1表示倒放动画","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.playAnimationInstance\",{\n\ttarget: \"ObjectId\", //必须带物体动画的对象\n\tbPlay: \"true\", //播放动画/暂停动画\n\tbLooping: \"true\", //true表示循环播放\n\tPlayRate: \"1.0\", //-1表示倒放动画\n})"},"videos":[],"remarks":"$undefined","sortOrder":9},{"name":"object.playScatterSetAnimation","title":"对象-播放阵列动画","description":"播放阵列对象特定的动画，前提是阵列对象存在，且设置好了动画参数","params":[{"name":"objectId","type":"string","required":true,"defaultValue":"$undefined","description":"阵列对象ID","enumValues":"$undefined"},{"name":"animationParameter","type":"string","required":true,"defaultValue":"$undefined","description":"两级阵列播放序列","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.playScatterSetAnimation\",{\n\tobjectId: \"\",// 阵列对象ID\n\tanimationParameter: \"\",// 两级阵列播放序列\n})"},"videos":[],"remarks":"$undefined","sortOrder":10},{"name":"object.resetScatterSetWithId","title":"对象-重置阵列对象","description":"重置阵列对象到配置的状态","params":[{"name":"objectId","type":"string","required":true,"defaultValue":"$undefined","description":"阵列对象ID","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.resetScatterSetWithId\",{\n\tobjectId: \"\",// 阵列对象ID\n})"},"videos":[],"remarks":"$undefined","sortOrder":11},{"name":"object.setWaterMaterialProperty","title":"对象-修改水材质属性","description":"修改水材质属性","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"PropertyFractionIn","type":"string","required":true,"defaultValue":"0.04","description":"透明浑浊度","enumValues":"$undefined"},{"name":"PropertyWaterRoughness","type":"string","required":true,"defaultValue":"0.05","description":"水面反射","enumValues":"$undefined"},{"name":"PropertyWaterSpecular","type":"string","required":true,"defaultValue":"0.22","description":"水面高光度","enumValues":"$undefined"},{"name":"PropertycColor","type":"string","required":true,"defaultValue":"FFFFFFFF","description":"水面颜色","enumValues":"$undefined"},{"name":"PropertyDirectionOffset","type":"string","required":true,"defaultValue":"0.5","description":"水流方向","enumValues":"$undefined"},{"name":"PropertyFoamOffset","type":"string","required":true,"defaultValue":"1","description":"泡沫流动方向","enumValues":"$undefined"},{"name":"PropertyGlobalSpeed","type":"string","required":true,"defaultValue":"1","description":"泡沫流动速率","enumValues":"$undefined"},{"name":"PropertySize","type":"string","required":true,"defaultValue":"6","description":"水面波浪大小","enumValues":"$undefined"},{"name":"PropertyWaveLength","type":"string","required":true,"defaultValue":"16384","description":"水面波浪强度","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.setWaterMaterialProperty\",{\n\ttarget: \"ObjectId\",\n\tPropertyFractionIn: \"0.04\", //透明浑浊度\n\tPropertyWaterRoughness: \"0.05\", //水面反射\n\tPropertyWaterSpecular: \"0.22\", //水面高光度\n\tPropertycColor: \"FFFFFFFF\", //水面颜色\n\tPropertyDirectionOffset: \"0.5\", //水流方向\n\tPropertyFoamOffset: \"1\", //泡沫流动方向\n\tPropertyGlobalSpeed: \"1\", //泡沫流动速率\n\tPropertySize: \"6\", //水面波浪大小\n\tPropertyWaveLength: \"16384\", //水面波浪强度\n})"},"videos":[],"remarks":"$undefined","sortOrder":12},{"name":"object.getRangeInfo","title":"对象-范围信息","description":"球形范围内其他对象信息","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"range","type":"string","required":true,"defaultValue":"10","description":"单位m","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"//调用触发事件\npiclient.emit(\"object.getRangeInfo\",{\n\ttarget: \"ObjectId\",\n\ttag: \"\",\n\trange: \"10\", //单位m\n})\n//监听事件获取回调信息\npiclient.on(\"object.getRangeInfo\",\"\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":13},{"name":"object.motionCorrection","title":"对象-运动纠偏","description":"对象运动纠偏同步，参数engine/geo二选一，都提供则geo >> engine","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"pathID","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"offsetXY","type":"string","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"offsetZ","type":"string","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"engine","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"","enumValues":"$undefined"},{"name":"geo","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"经度,纬度,高程","enumValues":"$undefined"},{"name":"rotation","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"roll,pitch,yaw","enumValues":"$undefined"},{"name":"speed","type":"string","required":true,"defaultValue":"0","description":"m/s 速度/时间两个只需要传一个，默认速度优先级最高，填0就是停止，只设置时间的话，需要把速度值置空清除","enumValues":["m","s"]},{"name":"length","type":"string","required":true,"defaultValue":"0","description":"m","enumValues":"$undefined"},{"name":"time","type":"string","required":true,"defaultValue":"2","description":"s 时间/速度两个只需要传一个，默认速度优先级最高，速度填0就是停止，只设置时间的话，需要把速度值置空清除","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.motionCorrection\",{\n\ttarget: \"ObjectId\",\n\ttag: \"\",\n\tpathID: \"ObjectId\",\n\toffsetXY: \"0\",\n\toffsetZ: \"0\",\n\tengine: \"0.0, 0.0, 0.0\",\n\tgeo: \"0.0, 0.0, 0.0\", //经度,纬度,高程\n\trotation: \"0.0, 0.0, 0.0\", //roll,pitch,yaw\n\tspeed: \"0\", //m/s 速度/时间两个只需要传一个，默认速度优先级最高，填0就是停止，只设置时间的话，需要把速度值置空清除\n\tlength: \"0\", //m\n\ttime: \"2\", //s 时间/速度两个只需要传一个，默认速度优先级最高，速度填0就是停止，只设置时间的话，需要把速度值置空清除\n})"},"videos":[],"remarks":"$undefined","sortOrder":14},{"name":"object.setCollision","title":"对象-碰撞","description":"对象碰撞","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"Collision","type":"string","required":true,"defaultValue":"toggle","description":"切换状态 toggle/true/false","enumValues":["toggle","true","false"]},{"name":"bAffectChild","type":"string","required":true,"defaultValue":"true","description":"true是开启，false是关闭","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.setCollision\",{\n\ttarget: \"ObjectId\",\n\ttag: \"\",\n\tCollision: \"toggle\",//切换状态 toggle/true/false\n\tbAffectChild: \"true\",//true是开启，false是关闭\n})"},"videos":[],"remarks":"$undefined","sortOrder":15},{"name":"object.highlight","title":"对象-高亮","description":"对象高亮","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"highlight","type":"string","required":true,"defaultValue":"toggle","description":"可见性 toggle/true/false","enumValues":["toggle","true","false"]},{"name":"bAffectChild","type":"string","required":true,"defaultValue":"true","description":"是否覆盖子级true/false","enumValues":["true","false"]}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.highlight\",{\n\ttarget: \"ObjectId\",\n\ttag: \"\",\n\thighlight: \"toggle\",//可见性toggle/true/false\n\tbAffectChild: \"true\",//是否覆盖子级true/false\n})"},"videos":[],"remarks":"$undefined","sortOrder":16},{"name":"object.blur","title":"对象-虚化","description":"对象虚化","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"blur","type":"string","required":true,"defaultValue":"toggle","description":"toggle/true/false","enumValues":["toggle","true","false"]},{"name":"bAffectChild","type":"string","required":true,"defaultValue":"true","description":"true/false","enumValues":["true","false"]},{"name":"tintColor","type":"string","required":true,"defaultValue":"#FFFFFF","description":"虚化颜色","enumValues":"$undefined"},{"name":"lightness","type":"string","required":true,"defaultValue":"0.5","description":"","enumValues":"$undefined"},{"name":"opacity","type":"string","required":true,"defaultValue":"0.2","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.blur\",{\n\ttarget: \"ObjectId\",\n\ttag: \"\",\n\tblur: \"toggle\", //toggle/true/false\n\tbAffectChild: \"true\",//true/false\n\ttintColor: \"#FFFFFF\", //虚化颜色\n\tlightness: \"0.5\",\n\topacity: \"0.2\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":17},{"name":"object.opacity","title":"对象-透明度","description":"对象设置透明度","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"opacity","type":"string","required":true,"defaultValue":"0.5","description":"","enumValues":"$undefined"},{"name":"bAffectChild","type":"string","required":true,"defaultValue":"true","description":"true/false","enumValues":["true","false"]}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.opacity\",{\n\ttarget: \"ObjectId\",\n\ttag: \"\",\n\topacity: \"0.5\",\n\tbAffectChild: \"true\",//true/false\n})"},"videos":[],"remarks":"$undefined","sortOrder":18},{"name":"object.getInfo","title":"对象-信息","description":"得到对象信息","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"对象id","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"对象自定义标签","enumValues":"$undefined"},{"name":"displayName","type":"string","required":true,"defaultValue":"String","description":"视图大纲中的名称","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"//调用触发事件\npiclient.emit(\"object.getInfo\",{\n\ttarget: \"ObjectId\",\n\ttag: \"\",//对象自定义标签\n\tdisplayName: \"String\", //视图大纲中的名称\n}) \n//监听事件获取回调信息\npiclient.on(\"object.getInfo\",\"\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":19},{"name":"object.getChild","title":"对象-子物体","description":"得到对象子物体列表","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectName","description":"场景中的任意对象","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"String","description":"","enumValues":"$undefined"},{"name":"displayName","type":"string","required":true,"defaultValue":"String","description":"视图大纲中的名称","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"//调用触发事件\npiclient.emit(\"object.getChild\",{\n\ttarget: \"ObjectName\", //场景中的任意对象\n\ttag: \"String\",\n\tdisplayName: \"String\", //视图大纲中的名称\n}) \n//监听事件获取回调信息\npiclient.on(\"object.getChild\",\"\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":20},{"name":"object.setTag","title":"对象-标记","description":"设置对象标记","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的任意对象","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"displayName","type":"string","required":true,"defaultValue":"$undefined","description":"视图大纲中的名称","enumValues":"$undefined"},{"name":"newTag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"clear","type":"boolean","required":true,"defaultValue":"true","description":"清除模型自身Tag","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"//调用触发事件\npiclient.emit(\"object.setTag\",{\n\ttarget: \"ObjectId\", //场景中的任意对象\n\ttag: \"\",\n\tdisplayName: \"\", //视图大纲中的名称\n\tnewTag: \"\",\n\tclear: true, //清除模型自身Tag\n})"},"videos":[],"remarks":"$undefined","sortOrder":21},{"name":"object.getScreenInfo","title":"对象-屏幕信息","description":"得到对象屏幕坐标","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"String","description":"","enumValues":"$undefined"},{"name":"selectionIndex","type":"string","required":true,"defaultValue":"String","description":"","enumValues":"$undefined"}],"returns":[{"name":"targetId","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"projectId","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"ScreenObjects","type":"array","required":true,"defaultValue":"[]","description":"","enumValues":"$undefined"}],"example":{"language":"typescript","code":"//调用触发事件\npiclient.emit(\"object.getScreenInfo\",{\n\ttarget: \"ObjectId\",\n\ttag: \"String\",\n\tselectionIndex: \"String\",\n})\n//监听事件获取回调信息\npiclient.on(\"object.getScreenInfo\",\"\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":22},{"name":"object.stopScreenInfo","title":"对象-停止屏幕信息","description":"停止推送对象屏幕信息","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"selectionIndex","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"isAll","type":"boolean","required":true,"defaultValue":"true","description":"true/false是否停止全部推送","enumValues":["true","false"]}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.stopScreenInfo\",{\n\ttarget: \"ObjectId\",\n\tselectionIndex: \"\",\n\tisAll: true, //true/false是否停止全部推送\n})"},"videos":[],"remarks":"$undefined","sortOrder":23},{"name":"object.getDroneInfo","title":"对象-无人机信息","description":"开启发送无人机信息","params":[{"name":"bSendDroneInfo","type":"string","required":true,"defaultValue":"false","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.getDroneInfo\",{\n\tbSendDroneInfo: \"false\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":24},{"name":"object.moveSync","title":"对象-位置同步","description":"对象位置同步，参数engine/geo二选一，都提供则geo >> engine","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"engine","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"","enumValues":"$undefined"},{"name":"geo","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"经度,纬度,高程","enumValues":"$undefined"},{"name":"rotation","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"roll,pitch,yaw","enumValues":"$undefined"},{"name":"speed","type":"string","required":true,"defaultValue":"0","description":"m/s","enumValues":["m","s"]},{"name":"time","type":"string","required":true,"defaultValue":"2","description":"s","enumValues":"$undefined"},{"name":"targetType","type":"string","required":true,"defaultValue":"mesh","description":"mesh/character/boat","enumValues":["mesh","character","boat"]}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.moveSync\",{\n\ttarget: \"ObjectId\",\n\ttag: \"\",\n\tengine: \"0.0, 0.0, 0.0\",//引擎坐标\n\tgeo: \"0.0, 0.0, 0.0\", //经度,纬度,高程\n\trotation: \"0.0, 0.0, 0.0\", //朝向roll,pitch,yaw\n\tspeed: \"0\", //m/s速度m/s 速度时间二选一，速度优先\n\ttime: \"2\", //时间s 为0则秒到\n})\n//监听事件获取回调信息\npiclient.on(\"object.moveSync\",\"\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":25},{"name":"object.scale","title":"对象-缩放","description":"缩放对象，默认时间是0","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"scale","type":"string","required":true,"defaultValue":"1.0,1.0,1.0","description":"x,y,z","enumValues":"$undefined"},{"name":"time","type":"string","required":true,"defaultValue":"0","description":"时间s","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.scale\",{\n\ttarget: \"ObjectId\",\n\ttag: \"\",\n\tscale: \"1.0,1.0,1.0\", //x,y,z\n\ttime: \"0\", //时间s\n})"},"videos":[],"remarks":"$undefined","sortOrder":26},{"name":"object.rotate","title":"对象-旋转","description":"旋转对象，默认时间是0","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"rotation","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"roll,pitch,yaw","enumValues":"$undefined"},{"name":"time","type":"string","required":true,"defaultValue":"0","description":"时间s","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.rotate\",{\n\ttarget: \"ObjectId\",\n\ttag: \"\",\n\trotation: \"0.0, 0.0, 0.0\", //roll,pitch,yaw\n\ttime: \"0\", //时间s\n})"},"videos":[],"remarks":"$undefined","sortOrder":27},{"name":"object.multiSelectSetTag","title":"对象-框选筛选","description":"开启框选对象tag筛选","params":[{"name":"tag","type":"string","required":true,"defaultValue":"String","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.multiSelectSetTag\",{\n\ttag: \"String\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":28},{"name":"object.update","title":"对象-更新","description":"更新对象属性","params":[{"name":"targets","type":"array","required":true,"defaultValue":"[Object1, Object2, Object3, ...]","description":"","enumValues":"$undefined"},{"name":"tags","type":"array","required":true,"defaultValue":"[Object1, Object2, Object3, ...]","description":"","enumValues":"$undefined"},{"name":"highlight","type":"string","required":true,"defaultValue":"0","description":"0/1点击高亮","enumValues":"$undefined"},{"name":"bAffectChild","type":"string","required":true,"defaultValue":"true","description":"true/false","enumValues":["true","false"]},{"name":"displayName","type":"string","required":true,"defaultValue":"String","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"object.update\",{\n\ttargets: [Object1, Object2, Object3, ...],\n\ttags: [Object1, Object2, Object3, ...],\n\thighlight: \"0\", //0/1点击高亮\n\tbAffectChild: \"true\", //true/false\n\tdisplayName: \"String\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":29}]},{"name":"Path","description":"","sortOrder":9,"apis":[{"name":"pathFollow.getCheckList","title":"巡检-获取巡检目标","description":"获取该巡检路线的所有巡检目标","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的巡检路线","enumValues":"$undefined"}],"returns":[{"name":"checktargetList","type":"array","required":true,"defaultValue":"[]","description":"","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"pathfollow.getCheckList\",{\n\ttarget: \"ObjectId\", //场景中的巡检路线\n}).then(data => {\n\tconsole.log(data)\n})"},"videos":[],"remarks":"$undefined","sortOrder":0},{"name":"pathFollow.control","title":"巡检-控制","description":"控制该巡检路线","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"场景中的巡检路线","enumValues":"$undefined"},{"name":"type","type":"string","required":true,"defaultValue":"play","description":"play/pause/stop","enumValues":["play","pause","stop"]}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"pathfollow.control\",{\n\ttarget: \"ObjectId\", //场景中的巡检路线\n\ttype: \"play\"//play/pause/stop\n})"},"videos":[],"remarks":"$undefined","sortOrder":1},{"name":"updateLocation.withReference","title":"更新位置-以参照物为基点","description":"以参照物为基点更新场景中物体的位置","params":[{"name":"reference","type":"string","required":true,"defaultValue":"ObjectId","description":"参照物（坐标基点）","enumValues":"$undefined"},{"name":"referenceRotation","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"参照物的旋转量roll,pitch,yaw","enumValues":"$undefined"},{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"需要更新位置的物体","enumValues":"$undefined"},{"name":"targetLocation","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"以参照物为基点要更新的位置","enumValues":"$undefined"},{"name":"targetRotation","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"//以参照物的旋转量为基点要更新的旋转量roll,pitch,yaw","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"updateLocation.withReference\",{\n\treference: \"ObjectId\",//参照物（坐标基点）\n\treferenceRotation: \"0.0, 0.0, 0.0\", //参照物的旋转量roll,pitch,yaw\n\ttarget: \"ObjectId\",//需要更新位置的物体\n\ttargetLocation: \"0.0, 0.0, 0.0\",//以参照物为基点要更新的位置\n\ttargetRotation: \"0.0, 0.0, 0.0\", ////以参照物的旋转量为基点要更新的旋转量roll,pitch,yaw\n})"},"videos":[],"remarks":"$undefined","sortOrder":2},{"name":"path.update","title":"路线-更新","description":"使用字符串形式的数据更新整条路线。\r\n路线字符串是多个点位的拼接，分为简洁版和完整版，可以在场景>>路线界面使用导出路线字符功能导出可视化编辑的路线的路线字符串。\r\n格式 point1|point2|point3|...|pointN\r\npoint位置可以使用简洁版点位字符串或者完整版点位字符串或者混用都行。\r\n\r\n点位字符串用于描述一个点的参数，分号分隔，保存为csv用excel加载，分为简洁版和完整版\r\nPosType local=本地直角坐标系，world=世界直角坐标系,geo=地理坐标经度、维度、高程(米)\r\nPointType Linear=线性,Curve=圆滑,Constant=固定,CurveClamped=限制范围的平滑,CurveCustomTangent=自定义切线\r\n简洁版，PosType;Position 如 geo;121.1234,31.1234,2000\r\n完整版，PosType;Position;Rotation;TangentIn;OutTangentOut;PointType\r\n完整版 geo;121.1234,31.1234,2000;0,0,0;121.20,31.10,2000;121.30,31.30,2000;Curve\r\n注意rotation是 pitch,yaw,roll的顺序","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"data","type":"string","required":true,"defaultValue":"$undefined","description":"使用字符串形式的数据更新整条路线。路线字符串是多个点位的拼接，分为简洁版和完整版，可以在场景>>路线界面使用导出路线字符功能导出可视化编辑的路线的路线字符串。格式 point1|point2|point3|...|pointNpoint位置可以使用简洁版点位字符串或者完整版点位字符串或者混用都行。点位字符串用于描述一个点的参数，分号分隔，保存为csv用excel加载，分为简洁版和完整版PosType local=本地直角坐标系，world=世界直角坐标系,geo=地理坐标经度、维度、高程(米)PointType Linear=线性,Curve=圆滑,Constant=固定,CurveClamped=限制范围的平滑,CurveCustomTangent=自定义切线简洁版，PosType;Position 如 geo;121.1234,31.1234,2000完整版，PosType;Position;Rotation;TangentIn;OutTangentOut;PointType完整版 geo;121.1234,31.1234,2000;0,0,0;121.20,31.10,2000;121.30,31.30,2000;Curve注意rotation是 pitch,yaw,roll的顺序","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"path.update\",{\n\ttarget: \"ObjectId\",\n\tdata: \"\", //使用字符串形式的数据更新整条路线。路线字符串是多个点位的拼接，分为简洁版和完整版，可以在场景>>路线界面使用导出路线字符功能导出可视化编辑的路线的路线字符串。格式 point1|point2|point3|...|pointNpoint位置可以使用简洁版点位字符串或者完整版点位字符串或者混用都行。点位字符串用于描述一个点的参数，分号分隔，保存为csv用excel加载，分为简洁版和完整版PosType local=本地直角坐标系，world=世界直角坐标系,geo=地理坐标经度、维度、高程(米)PointType Linear=线性,Curve=圆滑,Constant=固定,CurveClamped=限制范围的平滑,CurveCustomTangent=自定义切线简洁版，PosType;Position 如 geo;121.1234,31.1234,2000完整版，PosType;Position;Rotation;TangentIn;OutTangentOut;PointType完整版 geo;121.1234,31.1234,2000;0,0,0;121.20,31.10,2000;121.30,31.30,2000;Curve注意rotation是 pitch,yaw,roll的顺序\n})"},"videos":[],"remarks":"$undefined","sortOrder":3}]},{"name":"POI","description":"POI模块，提供点位显示支持","sortOrder":10,"apis":[{"name":"poi.createPOI","title":"POI-创建POI","description":"创建POI","params":[{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"标记","enumValues":"$undefined"},{"name":"geo","type":"string","required":false,"defaultValue":"$undefined","description":"经纬度，经度,纬度[,高程] 支持可选的高程","enumValues":"$undefined"},{"name":"engine","type":"string","required":true,"defaultValue":"$undefined","description":"引擎坐标X,Y,Z","enumValues":"$undefined"},{"name":"rotate","type":"string","required":false,"defaultValue":"$undefined","description":"3D POI可选值","enumValues":"$undefined"},{"name":"parentId","type":"string","required":true,"defaultValue":"$undefined","description":"附加的父对象，为空表示独立存在","enumValues":"$undefined"},{"name":"parentTag","type":"string","required":true,"defaultValue":"$undefined","description":"附加的父对象，为空表示独立存在","enumValues":"$undefined"},{"name":"offset","type":"string","required":true,"defaultValue":"$undefined","description":"x,y,z","enumValues":"$undefined"},{"name":"iconPath","type":"string","required":true,"defaultValue":"$undefined","description":"图片路径，内置/网络图片","enumValues":"$undefined"},{"name":"iconPathHL","type":"string","required":true,"defaultValue":"$undefined","description":"图片路径，内置/网络图片","enumValues":"$undefined"},{"name":"iconPathLeave","type":"string","required":true,"defaultValue":"$undefined","description":"图片路径，内置/网络图片","enumValues":"$undefined"},{"name":"iconColor","type":"string","required":true,"defaultValue":"$undefined","description":"//图标颜色是‌十六进制颜色代码，常见‌红色‌: ‌红色‌：#FF0000;绿色‌：#00FF00;蓝色‌：#0000FF;黄色‌：#FFFF00;青色‌：#00FFFF;黑色‌：#000000;白色‌：#FFFFFF;灰色‌：#808080;深灰色‌：#A9A9A9;浅灰色‌：#D3D3D3;棕色‌：#A52A2A;橙色‌：#FFA500;粉红色‌：#FFC0CB;紫色‌：#800080;","enumValues":"$undefined"},{"name":"iconScale","type":"string","required":true,"defaultValue":"1","description":"图标缩放","enumValues":"$undefined"},{"name":"focusFly","type":"boolean","required":true,"defaultValue":"true","description":"双击飞行到POI，非瞬移","enumValues":"$undefined"},{"name":"followCamera","type":"boolean","required":false,"defaultValue":"true","description":"3D POI可选","enumValues":"$undefined"},{"name":"iconSize","type":"string","required":true,"defaultValue":"$undefined","description":"50x50,长x宽","enumValues":"$undefined"},{"name":"iconOffset","type":"string","required":true,"defaultValue":"$undefined","description":"0x0,左右x上下","enumValues":"$undefined"},{"name":"labelText","type":"string","required":true,"defaultValue":"$undefined","description":"标题文本","enumValues":"$undefined"},{"name":"labelOffset","type":"string","required":true,"defaultValue":"$undefined","description":"0x0,左右x上下","enumValues":"$undefined"},{"name":"labelColor","type":"string","required":true,"defaultValue":"$undefined","description":"//图标颜色是‌十六进制颜色代码，常见‌红色‌: ‌红色‌：#FF0000;绿色‌：#00FF00;蓝色‌：#0000FF;黄色‌：#FFFF00;青色‌：#00FFFF;黑色‌：#000000;白色‌：#FFFFFF;灰色‌：#808080;深灰色‌：#A9A9A9;浅灰色‌：#D3D3D3;棕色‌：#A52A2A;橙色‌：#FFA500;粉红色‌：#FFC0CB;紫色‌：#800080;","enumValues":"$undefined"},{"name":"labelSize","type":"string","required":true,"defaultValue":"12","description":"文字大小","enumValues":"$undefined"},{"name":"labelContent","type":"string","required":true,"defaultValue":"String","description":"内容文本/模板","enumValues":"$undefined"},{"name":"labelContentColor","type":"string","required":true,"defaultValue":"String","description":"模板，内容颜色ff0000","enumValues":"$undefined"},{"name":"templateId","type":"string","required":true,"defaultValue":"String","description":"0","enumValues":"$undefined"},{"name":"menuOffset","type":"string","required":true,"defaultValue":"$undefined","description":"0x0,左右x上下","enumValues":"$undefined"},{"name":"MenuWebUrl","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"poiType","type":"string","required":true,"defaultValue":"2D","description":"2D/3D/Dimension/2DTemplate","enumValues":"$undefined"},{"name":"styleType","type":"string","required":true,"defaultValue":"Horizontal","description":"图标和文本摆放状态：Horizontal(水平)/Vertica(垂直)/Overlay(覆盖)/IconOnly(只显示图标)/TextOnly(只显示文本)","enumValues":"$undefined"},{"name":"dataID","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"$18"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/poi.createPOI创建POI-1.mp4"],"remarks":"$undefined","sortOrder":0},{"name":"poi.modifyPOI","title":"POI-修改POI","description":"修改POI","params":[{"name":"poiId","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"$undefined","description":"标记","enumValues":"$undefined"},{"name":"geo","type":"string","required":false,"defaultValue":"$undefined","description":"经纬度，经度,纬度[,高程] 支持可选的高程","enumValues":"$undefined"},{"name":"engine","type":"string","required":true,"defaultValue":"$undefined","description":"引擎坐标","enumValues":"$undefined"},{"name":"visibility","type":"string","required":true,"defaultValue":"0","description":"1显示/0隐藏","enumValues":"$undefined"},{"name":"modelStatus","type":"number","required":true,"defaultValue":"0.0","description":"气泡正常0/高亮1/离线2","enumValues":"$undefined"},{"name":"rotate","type":"string","required":false,"defaultValue":"$undefined","description":"3D POI可选值","enumValues":"$undefined"},{"name":"dataID","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"iconColor","type":"string","required":true,"defaultValue":"$undefined","description":"图标颜色ff0000","enumValues":"$undefined"},{"name":"iconScale","type":"string","required":true,"defaultValue":"1","description":"图标缩放","enumValues":"$undefined"},{"name":"iconPath","type":"string","required":true,"defaultValue":"$undefined","description":"图片路径，内置/网络图片","enumValues":"$undefined"},{"name":"iconPathHL","type":"string","required":true,"defaultValue":"$undefined","description":"图片路径，内置/网络图片","enumValues":"$undefined"},{"name":"iconPathLeave","type":"string","required":true,"defaultValue":"$undefined","description":"图片路径，内置/网络图片","enumValues":"$undefined"},{"name":"focusFly","type":"boolean","required":true,"defaultValue":"true","description":"双击飞行到POI，非瞬移","enumValues":"$undefined"},{"name":"followCamera","type":"boolean","required":false,"defaultValue":"true","description":"3D POI可选","enumValues":"$undefined"},{"name":"iconSize","type":"string","required":true,"defaultValue":"$undefined","description":"50x50,长x宽","enumValues":"$undefined"},{"name":"iconOffset","type":"string","required":true,"defaultValue":"$undefined","description":"0x0,左右x上下","enumValues":"$undefined"},{"name":"labelText","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"labelOffset","type":"string","required":true,"defaultValue":"$undefined","description":"0x0,左右x上下","enumValues":"$undefined"},{"name":"labelSize","type":"string","required":true,"defaultValue":"12","description":"文字大小","enumValues":"$undefined"},{"name":"labelColor","type":"string","required":true,"defaultValue":"FFFFFFFF","description":"标题颜色","enumValues":"$undefined"},{"name":"labelContent","type":"string","required":true,"defaultValue":"String","description":"内容文本/模板专用","enumValues":"$undefined"},{"name":"labelContentColor","type":"string","required":true,"defaultValue":"String","description":"模板专用，颜色ff0000","enumValues":"$undefined"},{"name":"menuOffset","type":"string","required":true,"defaultValue":"$undefined","description":"0x0,左右x上下","enumValues":"$undefined"},{"name":"menuWebUrl","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"poi.modifyPOI\",{\n\tpoiId: \"\",\n\ttag: \"\", //标记\n\tgeo: \"\", //经纬度，经度,纬度[,高程] 支持可选的高程\n\tengine: \"\", //引擎坐标\n\tvisibility: \"0\", //1显示/0隐藏\n\tmodelStatus: 0.0, //气泡正常0/高亮1/离线2\n\trotate: \"\", //3D POI可选值\n\tdataID: \"\",\n\ticonColor: \"\", //图标颜色ff0000\n\ticonScale: \"1\", //图标缩放\n\ticonPath: \"\", //图片路径，内置/网络图片\n\ticonPathHL: \"\", //图片路径，内置/网络图片\n\ticonPathLeave: \"\", //图片路径，内置/网络图片\n\tfocusFly: true, //双击飞行到POI，非瞬移\n\tfollowCamera: true, //3D POI可选\n\ticonSize: \"\", //50x50,长x宽\n\ticonOffset: \"\", //0x0,左右x上下\n\tlabelText: \"\",\n\tlabelOffset: \"\", //0x0,左右x上下\n\tlabelSize: \"12\", //文字大小\n\tlabelColor: \"FFFFFFFF\", //标题颜色\n\tlabelContent: \"String\", //内容文本/模板专用\n\tlabelContentColor: \"String\", //模板专用，颜色ff0000\n\tmenuOffset: \"\", //0x0,左右x上下\n\tmenuWebUrl: \"\",\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/poi.modifyPOI修改POI-1.mp4"],"remarks":"$undefined","sortOrder":1},{"name":"poi.loadPOIFromFile","title":"POI-从文件批量加载POI","description":"批量加载POI","params":[{"name":"append","type":"boolean","required":true,"defaultValue":"true","description":"是否追加模式，false=清空原有","enumValues":"$undefined"},{"name":"groupId","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"filePath","type":"string","required":true,"defaultValue":"$undefined","description":"文件地址，内容参考poi.loadPOIFromData","enumValues":"$undefined"}],"returns":[{"name":"groupId","type":"string","required":true,"defaultValue":"id","description":"poi组的ID","enumValues":"$undefined"}],"example":{"language":"javascript","code":"piclient.emit(\"poi.loadPOIFromFile\",{\n\tappend: true, //是否追加模式，false=清空原有\n\tgroupId: \"\",\n\tfilePath: \"\", //文件地址，内容参考poi.loadPOIFromData\n})"},"videos":[],"remarks":"$undefined","sortOrder":2},{"name":"poi.loadPOIFromData","title":"POI-从数据批量加载POI","description":"批量加载POI","params":[{"name":"append","type":"boolean","required":true,"defaultValue":"true","description":"是否追加模式，false=清空原有","enumValues":"$undefined"},{"name":"groupId","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"data","type":"string","required":true,"defaultValue":"$undefined","description":"格式 {\"groupId\":\"id\",\"data\":[{\"id\":\"\",\"name\":\"\",\"iconChar\":\"\\ue030\",\"level\":11,\"geoPos\":\"\",\"color\":\"\",\"type\":\"\",\"focusOnClick\":false},{}]}","enumValues":"$undefined"}],"returns":[{"name":"groupId","type":"string","required":true,"defaultValue":"id","description":"poi组的ID","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"poi.loadPOIFromData\",{\n\tappend: true, //是否追加模式，false=清空原有\n\tgroupId: \"\",\n\tdata: \"\", //格式 {\"groupId\":\"id\",\"data\":[{\"id\":\"\",\"name\":\"\",\"iconChar\":\"\\ue030\",\"level\":11,\"geoPos\":\"\",\"color\":\"\",\"type\":\"\",\"focusOnClick\":false},{}]}\n})"},"videos":[],"remarks":"$undefined","sortOrder":3},{"name":"poi.showPOIWeb","title":"POI-网页展示","description":"POI网页展示","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"playState","type":"string","required":true,"defaultValue":"toggle","description":"toggle/show/hide","enumValues":["toggle","show","hide"]}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"poi.showPOIWeb\",{\n\ttarget: \"ObjectId\",\n\tplayState: \"toggle\", //toggle/show/hide\n})"},"videos":[],"remarks":"$undefined","sortOrder":4},{"name":"poi.mergePOI","title":"POI-点聚合","description":"点聚合","params":[{"name":"mergePOI","type":"boolean","required":true,"defaultValue":"true","description":"点聚合开关","enumValues":"$undefined"},{"name":"mergePOIDistance","type":"string","required":true,"defaultValue":"50000","description":"点聚合距离","enumValues":"$undefined"},{"name":"iconPath","type":"string","required":true,"defaultValue":"String","description":"图片路径，内置/网络图片","enumValues":"$undefined"},{"name":"iconSize","type":"string","required":true,"defaultValue":"String","description":"50x50,长x宽","enumValues":"$undefined"},{"name":"labelOffset","type":"string","required":true,"defaultValue":"String","description":"0x0,左右x上下","enumValues":"$undefined"},{"name":"labelSize","type":"string","required":true,"defaultValue":"12","description":"文字大小","enumValues":"$undefined"},{"name":"labelColor","type":"string","required":true,"defaultValue":"FFFFFFFF","description":"文字颜色","enumValues":"$undefined"},{"name":"tag","type":"string","required":true,"defaultValue":"String","description":"分类带merge_的标记","enumValues":"$undefined"},{"name":"menuWebUrl","type":"string","required":true,"defaultValue":"String","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"poi.mergePOI\",{\n\tmergePOI: true, //点聚合开关\n\tmergePOIDistance: \"50000\", //点聚合距离\n\ticonPath: \"String\", //图片路径，内置/网络图片\n\ticonSize: \"String\", //50x50,长x宽\n\tlabelOffset: \"String\", //0x0,左右x上下\n\tlabelSize: \"12\", //文字大小\n\tlabelColor: \"FFFFFFFF\", //文字颜色\n\ttag: \"String\", //分类带merge_的标记\n\tmenuWebUrl: \"String\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":5}]},{"name":"Project","description":"项目相关的接口","sortOrder":11,"apis":[{"name":"project.recordReplay","title":"项目-录制回放","description":"录制回放数据","params":[{"name":"replayName","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"frequence","type":"number","required":true,"defaultValue":"0.0","description":"有变更时，间隔多少帧录制一次","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"project.recordReplay\",{\n\treplayName: \"\",\n\tfrequence: 0.0, //有变更时，间隔多少帧录制一次\n})"},"videos":[],"remarks":"$undefined","sortOrder":0},{"name":"project.stopRecordReplay","title":"项目-停止录制回放","description":"停止录制回放数据","params":[],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"project.stopRecordReplay\",{})"},"videos":[],"remarks":"$undefined","sortOrder":1},{"name":"project.playReplay","title":"项目-播放回放","description":"播放录制的回放数据","params":[{"name":"replayName","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"scale","type":"string","required":true,"defaultValue":"1.0","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"project.playReplay\",{\n\treplayName: \"\",\n\tscale: \"1.0\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":2},{"name":"project.pausePlayReplay","title":"项目-暂停播放回放","description":"是否暂停播放录制的回放数据","params":[{"name":"bPause","type":"boolean","required":true,"defaultValue":"true","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"project.pausePlayReplay\",{\n\tbPause: true,\n})"},"videos":[],"remarks":"$undefined","sortOrder":3},{"name":"project.stopPlayReplay","title":"项目-停止播放回放","description":"停止播放录制的回放数据","params":[],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"project.stopPlayReplay\",{})"},"videos":[],"remarks":"$undefined","sortOrder":4},{"name":"project.DeletePlayReplay","title":"项目-删除回放","description":"删除录制的回放数据","params":[{"name":"replayName","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"project.DeletePlayReplay\",{\n\treplayName: \"\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":5},{"name":"project.replayJumpTo","title":"项目-回放进度跳转","description":"跳转到特定回放进度","params":[{"name":"jumpPoint","type":"string","required":true,"defaultValue":"0.0","description":"0.0表示回放开头，1.0表示回放结尾","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"project.replayJumpTo\",{\n\tjumpPoint: \"0.0\", //0.0表示回放开头，1.0表示回放结尾\n})"},"videos":[],"remarks":"$undefined","sortOrder":6},{"name":"project.getReplays","title":"项目-本地回放","description":"获得当前方案的本地回放","params":[],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"project.getReplays\",{}).then(res => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":7},{"name":"project.setMaxFPS","title":"项目-设置最大帧数","description":"限制客户端渲染帧数上限，降低GPU消耗,此功能只能压低帧数以便降低GPU用量，不能强行拔高帧数。好比一个极速160码的汽车让限速到60码运行是可行的，但让限速200码运行不现实。","params":[{"name":"fps","type":"string","required":true,"defaultValue":"30.0","description":"0=不限制，注意这只能降低帧数，不能提升帧数","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"project.setMaxFPS\",{\n\tfps: \"30.0\", //0=不限制，注意这只能降低帧数，不能提升帧数\n})"},"videos":[],"remarks":"$undefined","sortOrder":8},{"name":"project.showDirIndicator","title":"项目-显示隐藏方位指示","description":"显示或者隐藏方位指示器，坐标系指示器和指南针","params":[{"name":"axis","type":"string","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"},{"name":"compass","type":"string","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"project.showDirIndicator\",{\n\taxis: \"0.0\",\n\tcompass: \"0.0\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":9},{"name":"project.getFPS","title":"项目-获取FPS","description":"获取当前项目FPS","params":[],"returns":[],"example":{"language":"typescript","code":"// 回调、监听两种方式都可以\n//回调 \npiclient.emit(\"project.getFPS\",{}).then(res => {\n\talert(JSON.stringify(res))\n}) \n//监听\npiclient.on(\"project.getFPS\",\"\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":10},{"name":"project.loadByID","title":"项目-通过ID加载方案","description":"通过ID加载方案","params":[{"name":"projectID","type":"string","required":true,"defaultValue":"$undefined","description":"需要当前有多个项目可用","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"project.loadByID\",{\n\tprojectID: \"\", //需要当前有多个项目可用\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/project.loadByID项目-通过ID加载方案.mp4"],"remarks":"$undefined","sortOrder":11},{"name":"project.loadPCZ","title":"项目-读取PCZ","description":"读取PCZ","params":[{"name":"pczPath","type":"string","required":true,"defaultValue":"$undefined","description":"放到saved/Release目录下C.pcz或者全局路径C:/B/C.pcz","enumValues":["saved","Release"]}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"project.loadPCZ\",{\n\tpczPath: \"\", //放到saved/Release目录下C.pcz或者全局路径C:/B/C.pcz\n})"},"videos":["https://picimos-1318215736.cos.ap-shanghai.myqcloud.com/static/api/project.loadPCZ项目-读取PCZ.mp4"],"remarks":"$undefined","sortOrder":12}]},{"name":"UI","description":"UI模块主要做全局的UI状态的控制","sortOrder":12,"apis":[{"name":"ui.showClientUI","title":"界面-显示客户端界面组件","description":"显示客户端界面组件","params":[{"name":"name","type":"string","required":true,"defaultValue":"SceneToolBar","description":"","enumValues":"$undefined"},{"name":"alignment","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"0,0","enumValues":"$undefined"},{"name":"visible","type":"string","required":true,"defaultValue":"toggle","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"ui.showClientUI\",{\n\tname: \"SceneToolBar\",\n\talignment: \"0.0, 0.0, 0.0\", //0,0\n\tvisible: \"toggle\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":0}]},{"name":"Water","description":"水利模块，提供水利行业支持","sortOrder":13,"apis":[{"name":"water.loadMesh","title":"水利-加载水体网格结构","description":"加载水体网格结构，包含地面覆盖层和水系河床网格，可整体加载，也可以分片增量加载","params":[{"name":"bAppend","type":"string","required":true,"defaultValue":"false","description":"追加还是清空重建","enumValues":"$undefined"},{"name":"filePath","type":"string","required":true,"defaultValue":"$undefined","description":".geojson或.data文件路径","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"water.loadMesh\",{\n\tbAppend: \"false\", //追加还是清空重建\n\tfilePath: \"\", //.geojson或.data文件路径\n})"},"videos":[],"remarks":"$undefined","sortOrder":0},{"name":"water.loadMeshFromData","title":"水利-从数据加载水体网格结构","description":"加载水体网格结构，包含地面覆盖层和水系河床网格，可整体加载，也可以分片增量加载","params":[{"name":"bAppend","type":"string","required":true,"defaultValue":"false","description":"追加还是清空重建","enumValues":"$undefined"},{"name":"data","type":"string","required":true,"defaultValue":"$undefined","description":".geojson对象","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"water.loadMeshFromData\",{\n\tbAppend: \"false\", //追加还是清空重建\n\tdata: \"\", //.geojson对象\n})"},"videos":[],"remarks":"$undefined","sortOrder":1},{"name":"water.focusOnTile","title":"水利-聚焦到网格","description":"聚焦到指定网格","params":[{"name":"tileId","type":"string","required":true,"defaultValue":"$undefined","description":"网格id","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"water.focusOnTile\",{\n\ttileId: \"\",//网格id\n})"},"videos":[],"remarks":"$undefined","sortOrder":2},{"name":"water.loadStatus","title":"水利-加载水体状态数据","description":"加载水体状态数据，用于更新网格的状态，可整体加载，也可以分片增量加载","params":[{"name":"filePath","type":"string","required":true,"defaultValue":"$undefined","description":".csv或.data文件路径","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"water.loadStatus\",{\n\tfilePath: \"\", //.csv或.data文件路径\n})"},"videos":[],"remarks":"$undefined","sortOrder":3},{"name":"water.playConfig","title":"水利-播放状态的控制","description":"播放状态的控制，播放速度，播放的时间范围，是否循环等","params":[{"name":"play","type":"string","required":true,"defaultValue":"toggle","description":"/toggle/play/stop","enumValues":["toggle","play","stop"]}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"water.playConfig\",{\n\tplay: \"toggle\",//play, stop, toggle\n})"},"videos":[],"remarks":"$undefined","sortOrder":4},{"name":"water.getMeshStat","title":"水利-水体网格的统计","description":"获取水体网格的统计信息，中心点，面积，三角形数量等","params":[{"name":"url","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"returns":[{"name":"nodeCount","type":"number","required":true,"defaultValue":"0","description":"节点数量","enumValues":"$undefined"},{"name":"nodeLoaded","type":"number","required":true,"defaultValue":"0","description":"加载的数量","enumValues":"$undefined"},{"name":"areaOrigin","type":"string","required":true,"defaultValue":"123.1234,31.1234","description":"区域面积","enumValues":"$undefined"},{"name":"areaExtent","type":"string","required":true,"defaultValue":"5000,2000","description":"区域半径","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"water.getMeshStat\",{\n\turl: \"\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":5},{"name":"water.getStatusStat","title":"水利-状态数据的统计","description":"获取水体状态数据的统计信息，比如总时长，总帧数等","params":[{"name":"url","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"returns":[{"name":"nodeCount","type":"number","required":true,"defaultValue":"0","description":"节点数量","enumValues":"$undefined"},{"name":"frameCount","type":"number","required":true,"defaultValue":"0","description":"状态帧数","enumValues":"$undefined"},{"name":"nodeLoaded","type":"number","required":true,"defaultValue":"0","description":"加载数量","enumValues":"$undefined"},{"name":"avgU","type":"number","required":true,"defaultValue":"0","description":"平均U","enumValues":"$undefined"},{"name":"avgV","type":"number","required":true,"defaultValue":"0","description":"平均V","enumValues":"$undefined"},{"name":"avgH","type":"number","required":true,"defaultValue":"0","description":"平均H","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"water.getStatusStat\",{\n\turl: \"\",\n})"},"videos":[],"remarks":"$undefined","sortOrder":6},{"name":"water.getStatusAtPos","title":"水利-获取指定位置状态","description":"获取指定位置（经纬度）的水体状态","params":[{"name":"geoPos","type":"string","required":true,"defaultValue":"$undefined","description":"地理地址","enumValues":"$undefined"},{"name":"nodeId","type":"number","required":true,"defaultValue":"0.0","description":"节点id，geoPos不为空则忽略此值","enumValues":"$undefined"}],"returns":[{"name":"id","type":"number","required":true,"defaultValue":"123","description":"","enumValues":"$undefined"},{"name":"x","type":"number","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"y","type":"number","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"eta","type":"number","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"u","type":"number","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"v","type":"number","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"h","type":"number","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"vMag","type":"number","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"},{"name":"dir","type":"number","required":true,"defaultValue":"0","description":"","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"water.getStatusAtPos\",{\n\tgeoPos: \"\",//地理地址\n\tnodeId: 0.0, //节点id，geoPos不为空则忽略此值\n}).then(data => {\n\tconsole.log(data)\n})"},"videos":[],"remarks":"$undefined","sortOrder":7},{"name":"water.setStatusAtPos","title":"水利-更新指定位置状态","description":"单独更新指定位置（经纬度）的水体状态","params":[{"name":"id","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"},{"name":"x","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"},{"name":"y","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"},{"name":"eta","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"},{"name":"u","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"},{"name":"v","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"},{"name":"h","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"},{"name":"vMag","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"},{"name":"dir","type":"number","required":true,"defaultValue":"0.0","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"water.setStatusAtPos\",{\n\tid: 0.0,\n\tx: 0.0,\n\ty: 0.0,\n\teta: 0.0,\n\tu: 0.0,\n\tv: 0.0,\n\th: 0.0,\n\tvMag: 0.0,\n\tdir: 0.0,\n})"},"videos":[],"remarks":"$undefined","sortOrder":8},{"name":"water.setStatusConfig","title":"水利-设置水体状态的配置","description":"设置水体状态的配置，比如不同流速，水位的配色，触发警报的阈值等","params":[{"name":"viewProp","type":"string","required":true,"defaultValue":"$undefined","description":"热力图呈现的使用的属性, 为空或者animation表示随机颜色","enumValues":"$undefined"},{"name":"rangeValues","type":"string","required":true,"defaultValue":"$undefined","description":"颜色分段数值范围比如 0.5,0.8,100,300","enumValues":"$undefined"},{"name":"rangeColors","type":"string","required":true,"defaultValue":"$undefined","description":"数值分段的颜色，比如 ff0000,ff1f00,ff2f00,ff3f00","enumValues":"$undefined"},{"name":"opaqueOnZero","type":"string","required":true,"defaultValue":"false","description":"数值为0时是否不透明","enumValues":"$undefined"},{"name":"snapGround","type":"string","required":true,"defaultValue":"false","description":"是否贴附地形","enumValues":"$undefined"},{"name":"altitude","type":"string","required":true,"defaultValue":"100","description":"高程，单位米，网格的高度","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"water.setStatusConfig\",{\n\tviewProp: \"\", //热力图呈现的使用的属性, 为空或者animation表示随机颜色\n\trangeValues: \"\", //颜色分段数值范围比如 0.5,0.8,100,300\n\trangeColors: \"\", //数值分段的颜色，比如 ff0000,ff1f00,ff2f00,ff3f00\n\topaqueOnZero: \"false\", //数值为0时是否不透明\n\tsnapGround: \"false\", //是否贴附地形\n\taltitude: \"100\", //高程，单位米，网格的高度\n})"},"videos":[],"remarks":"$undefined","sortOrder":9},{"name":"water.setDrawCount","title":"水利-设置绘制数量","description":"设置最大同屏绘制数量","params":[{"name":"drawCount","type":"string","required":true,"defaultValue":"$undefined","description":"最大同屏绘制数量","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"piclient.emit(\"water.setDrawCount\",{\n\tdrawCount: \"\", //最大同屏绘制数量\n})"},"videos":[],"remarks":"$undefined","sortOrder":10}]},{"name":"Window","description":"多窗口模块用于在主窗口内部或者独立于主窗口创建多个可以自由移动和改变尺寸的窗口。可以将UI界面，相机，三维模型，网页等内容放在独立的窗口中。窗口模块的很多功能需要C++或者蓝图才能使用，API层面只暴露方便直接使用的版本。","sortOrder":14,"apis":[{"name":"window.close","title":"窗口-关闭","description":"关闭指定窗口","params":[{"name":"windowId","type":"number","required":true,"defaultValue":"0.0","description":"窗口id","enumValues":"$undefined"}],"returns":[{"name":"id","type":"number","required":true,"defaultValue":"100","description":"窗口id，用于关闭操作","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"window.close\",{\n\twindowId: 0.0,//窗口id\n})"},"videos":[],"remarks":"$undefined","sortOrder":0},{"name":"window.move","title":"窗口-移动位置","description":"移动指定窗口的位置","params":[{"name":"windowId","type":"number","required":true,"defaultValue":"0.0","description":"窗口id","enumValues":"$undefined"},{"name":"position","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"位置","enumValues":"$undefined"}],"returns":[{"name":"id","type":"number","required":true,"defaultValue":"100","description":"窗口id，用于关闭操作","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"window.move\",{\n\twindowId: 0.0,//窗口id\n\tposition: \"0.0, 0.0, 0.0\",//位置\n})"},"videos":[],"remarks":"$undefined","sortOrder":1},{"name":"window.resize","title":"窗口-更改大小","description":"修改指定窗口的大小","params":[{"name":"windowId","type":"number","required":true,"defaultValue":"0.0","description":"窗口id","enumValues":"$undefined"},{"name":"size","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"尺寸","enumValues":"$undefined"}],"returns":[{"name":"id","type":"number","required":true,"defaultValue":"100","description":"窗口id，用于关闭操作","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"window.resize\",{\n\twindowId: 0.0,//窗口id\n\tsize: \"0.0, 0.0, 0.0\",//尺寸\n})"},"videos":[],"remarks":"$undefined","sortOrder":2},{"name":"window.createByCamera","title":"窗口-创建相机窗口","description":"创建新窗口，并显示指定摄像机的实时画面","params":[{"name":"title","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"standalone","type":"string","required":true,"defaultValue":"false","description":"是否独立窗口, false=在主窗口内显示，适合云渲染。true=独立于主窗口，适合多显示器","enumValues":"$undefined"},{"name":"position","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"位置","enumValues":"$undefined"},{"name":"size","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"尺寸","enumValues":"$undefined"},{"name":"cameraObject","type":"string","required":true,"defaultValue":"ObjectId","description":"任意带有相机组件的对象","enumValues":"$undefined"},{"name":"cameraIndex","type":"string","required":true,"defaultValue":"0","description":"第几个相机","enumValues":"$undefined"}],"returns":[{"name":"id","type":"number","required":true,"defaultValue":"100","description":"窗口id，用于关闭操作","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"window.createByCamera\",{\n\ttitle: \"\",\n\tstandalone: \"false\", //是否独立窗口, false=在主窗口内显示，适合云渲染。true=独立于主窗口，适合多显示器\n\tposition: \"0.0, 0.0, 0.0\",//位置\n\tsize: \"0.0, 0.0, 0.0\",//尺寸\n\tcameraObject: \"ObjectId\", //任意带有相机组件的对象\n\tcameraIndex: \"0\", //第几个相机\n})"},"videos":[],"remarks":"$undefined","sortOrder":3},{"name":"window.createByWidget","title":"窗口-创建原生界面窗口","description":"创建新窗口，并加载指定UMG原生页面","params":[{"name":"title","type":"string","required":true,"defaultValue":"$undefined","description":"窗口标题","enumValues":"$undefined"},{"name":"standalone","type":"string","required":true,"defaultValue":"false","description":"是否独立窗口, false=在主窗口内显示，适合云渲染。true=独立于主窗口，适合多显示器","enumValues":"$undefined"},{"name":"position","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"位置","enumValues":"$undefined"},{"name":"size","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"尺寸","enumValues":"$undefined"},{"name":"widget","type":"string","required":true,"defaultValue":"/Game/UI/TestUI.TestUI_C","description":"从UE编辑器的内容浏览器复制UMG界面的引用地址,注意蓝图路径后面的_C后缀","enumValues":"$undefined"}],"returns":[{"name":"id","type":"number","required":true,"defaultValue":"100","description":"窗口id，用于关闭操作","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"window.createByWidget\",{\n\ttitle: \"\",//窗口标题\n\tstandalone: \"false\", //是否独立窗口, false=在主窗口内显示，适合云渲染。true=独立于主窗口，适合多显示器\n\tposition: \"0.0, 0.0, 0.0\",//位置\n\tsize: \"0.0, 0.0, 0.0\",//尺寸\n\twidget: \"/Game/UI/TestUI.TestUI_C\", //从UE编辑器的内容浏览器复制UMG界面的引用地址,注意蓝图路径后面的_C后缀\n})"},"videos":[],"remarks":"$undefined","sortOrder":4},{"name":"window.createByWebPage","title":"窗口-创建网页窗口","description":"创建新窗口，并加载指定网页页面","params":[{"name":"title","type":"string","required":true,"defaultValue":"$undefined","description":"窗口标题","enumValues":"$undefined"},{"name":"standalone","type":"string","required":true,"defaultValue":"false","description":"是否独立窗口, false=在主窗口内显示，适合云渲染。true=独立于主窗口，适合多显示器","enumValues":"$undefined"},{"name":"position","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"位置","enumValues":"$undefined"},{"name":"size","type":"string","required":true,"defaultValue":"0.0, 0.0, 0.0","description":"尺寸","enumValues":"$undefined"},{"name":"url","type":"string","required":true,"defaultValue":"https://www.bing.com","description":"网页地址","enumValues":"$undefined"}],"returns":[{"name":"id","type":"number","required":true,"defaultValue":"100","description":"窗口id，用于关闭操作","enumValues":"$undefined"}],"example":{"language":"typescript","code":"piclient.emit(\"window.createByWebPage\",{\n\ttitle: \"\",//窗口标题\n\tstandalone: \"false\", //是否独立窗口, false=在主窗口内显示，适合云渲染。true=独立于主窗口，适合多显示器\n\tposition: \"0.0, 0.0, 0.0\",//位置\n\tsize: \"0.0, 0.0, 0.0\",//尺寸\n\turl: \"https://www.bing.com\",//网页地址\n})"},"videos":[],"remarks":"$undefined","sortOrder":5}]}],"events":[{"name":"object.onClick","title":"对象-被点击","description":"当对象被鼠标点击时触发","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"componentIndex","type":"string","required":true,"defaultValue":"0","description":"-1表示所有组件全部替换","enumValues":"$undefined"},{"name":"sectionIndex","type":"string","required":true,"defaultValue":"0","description":"-1表示所有部位全部替换","enumValues":"$undefined"},{"name":"materialId","type":"string","required":true,"defaultValue":"$undefined","description":"从材质库中选择材质并从详情页面获取材质ID","enumValues":"$undefined"},{"name":"children","type":"boolean","required":true,"defaultValue":"true","description":"是否连所有子对象一起处理","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"//监听事件获取回调信息\npiclient.on(\"object.onClick\",\"\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":0,"module":"Objects"},{"name":"object.onDoubleClick","title":"对象-被双击","description":"当对象被鼠标双击时触发","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"componentIndex","type":"string","required":true,"defaultValue":"0","description":"-1表示所有组件全部替换","enumValues":"$undefined"},{"name":"sectionIndex","type":"string","required":true,"defaultValue":"0","description":"-1表示所有部位全部替换","enumValues":"$undefined"},{"name":"materialId","type":"string","required":true,"defaultValue":"$undefined","description":"从材质库中选择材质并从详情页面获取材质ID","enumValues":"$undefined"},{"name":"children","type":"boolean","required":true,"defaultValue":"true","description":"是否连所有子对象一起处理","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"//监听事件获取回调信息\npiclient.on(\"object.onDoubleClick\",\"\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":1,"module":"Objects"},{"name":"object.onMoved","title":"对象-被移动","description":"当对象被坐标轴拖动或者通过设置位置移动后触发","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"},{"name":"geo","type":"string","required":true,"defaultValue":"0","description":"-1表示所有组件全部替换","enumValues":"$undefined"},{"name":"pos","type":"string","required":true,"defaultValue":"0","description":"-1表示所有部位全部替换","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"//监听事件获取回调信息\npiclient.on(\"object.onMoved\",\"\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":2,"module":"Objects"},{"name":"object.onScale","title":"对象-缩放","description":"对象缩放大小时触发","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"//监听事件获取回调信息\npiclient.on(\"object.onScale\",\"\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":3,"module":"Objects"},{"name":"object.onVisible","title":"对象-显隐","description":"对象显示隐藏状态变化时触发","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"//监听事件获取回调信息\npiclient.on(\"object.onVisible\",\"\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":4,"module":"Objects"},{"name":"object.onCreate","title":"对象-创建","description":"对象被创建时触发","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"//监听事件获取回调信息\npiclient.on(\"object.onCreate\",\"\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":5,"module":"Objects"},{"name":"object.onDestroy","title":"对象-销毁","description":"对象被销毁时触发","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"//监听事件获取回调信息\npiclient.on(\"object.onDestroy\",\"\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":6,"module":"Objects"},{"name":"object.onAttach","title":"对象-附加","description":"对象附加到另外一个对象时触发","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"//监听事件获取回调信息\npiclient.on(\"object.onAttach\",\"\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":7,"module":"Objects"},{"name":"object.onDetach","title":"对象-脱离","description":"对象从其他对象上脱离时触发","params":[{"name":"target","type":"string","required":true,"defaultValue":"ObjectId","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"//监听事件获取回调信息\npiclient.on(\"object.onDetach\",\"\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":8,"module":"Objects"},{"name":"object.multiSelect","title":"对象-多选","description":"shit+鼠标左键拖动，框选的物体会收集后触发","params":[{"name":"SelectedObjects","type":"array","required":true,"defaultValue":"[Object1, Object2, Object3, ...]","description":"","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"//监听事件获取回调信息\npiclient.on(\"object.multiSelect\",{SelectedObjects: [Object1, Object2, Object3, ...],},(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":9,"module":"Objects"},{"name":"pathFollow.onCheck","title":"巡检-检查对象","description":"当巡检到某对象时触发","params":[],"returns":[{"name":"pathfollow","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"},{"name":"checktarget","type":"string","required":true,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"example":{"language":"typescript","code":"//监听事件获取回调信息\npiclient.on(\"pathfollow.onCheck\",\"目标id\",(res) => {\n\talert(JSON.stringify(res))\n})"},"videos":[],"remarks":"$undefined","sortOrder":10,"module":"Path"}]},"piutils":{"title":"UI 编辑器 API（window.PiUtils）","apis":[{"name":"piAlert","title":"显示一个警告/提示框","description":"显示一个警告/提示框","params":[{"name":"msg","type":"String","required":true,"defaultValue":"\"\"","description":"要显示的提示信息","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"window.PiUtils.piAlert(\"操作成功完成！\")"},"videos":[],"remarks":"$undefined","sortOrder":0},{"name":"piClient","title":"执行客户端操作","description":"执行客户端操作","params":[{"name":"action","type":"String","required":true,"defaultValue":"$undefined","description":"要执行的操作类型","enumValues":"$undefined"},{"name":"ext","type":"Object","required":true,"defaultValue":"$undefined","description":"扩展参数对象","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"window.PiUtils.piClient(\"environment.setWeather\", {\"weather\": 2})"},"videos":[],"remarks":"$undefined","sortOrder":1},{"name":"piGoto","title":"导航到指定页面","description":"导航到指定页面","params":[{"name":"pageId","type":"String","required":true,"defaultValue":"$undefined","description":"目标页面的ID 可以从listV1接口查看","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"window.PiUtils.piGoto(\"页面ID\")"},"videos":[],"remarks":"$undefined","sortOrder":2},{"name":"piLink","title":"打开指定URL链接","description":"打开指定URL链接","params":[{"name":"url","type":"String","required":true,"defaultValue":"$undefined","description":"要打开的URL地址","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"window.PiUtils.piLink(\"https://www.example.com\")"},"videos":[],"remarks":"$undefined","sortOrder":3},{"name":"piOpenDialog","title":"打开关闭指定弹窗","description":"打开关闭指定弹窗","params":[{"name":"id","type":"String","required":true,"defaultValue":"$undefined","description":"对话框的ID 可以从listV1接口查看","enumValues":"$undefined"},{"name":"poiId","type":"String","required":false,"defaultValue":"$undefined","description":"POIID 非必填填写之后将根据poi点位移动","enumValues":"$undefined"},{"name":"show","type":"boolean","required":false,"defaultValue":"$undefined","description":"不传默认为false, false为打开弹窗, true为关闭弹窗","enumValues":"$undefined"},{"name":"width","type":"number","required":false,"defaultValue":"$undefined","description":"弹窗宽度","enumValues":"$undefined"},{"name":"height","type":"number","required":false,"defaultValue":"$undefined","description":"弹窗高度","enumValues":"$undefined"},{"name":"top","type":"number","required":false,"defaultValue":"$undefined","description":"弹窗距顶部位置；有值时优先于从 ext 解析出的 top","enumValues":"$undefined"},{"name":"left","type":"number","required":false,"defaultValue":"$undefined","description":"弹窗距左侧位置；有值时优先于从 ext 解析出的 left","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"// 打开弹窗\nwindow.PiUtils.piOpenDialog(\"弹窗ID\", \"\", false)\n\n// 关闭弹窗\nwindow.PiUtils.piOpenDialog(\"弹窗ID\", \"\", true)\n\n// 带 POI 点位移动打开弹窗\nwindow.PiUtils.piOpenDialog(\"弹窗ID\", \"POIID\", false)\n\n// 指定宽高与位置打开弹窗\nwindow.PiUtils.piOpenDialog(\"弹窗ID\", \"\", false, 800, 600, 100, 200)"},"videos":[],"remarks":"$undefined","sortOrder":4},{"name":"closeAllDialog","title":"关闭所有弹窗","description":"关闭当前所有已打开的弹窗，无需任何参数。","params":[],"returns":[],"example":{"language":"typescript","code":"window.PiUtils.closeAllDialog()"},"videos":[],"remarks":"$undefined","sortOrder":5},{"name":"piToggle","title":"切换指定子页面的显示/隐藏状态","description":"切换指定子页面的显示/隐藏状态","params":[{"name":"pageId","type":"String","required":true,"defaultValue":"$undefined","description":"要切换的子页面ID 可以从listV1接口查看 (children中)","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"window.PiUtils.piToggle(\"子页面ID\")"},"videos":[],"remarks":"$undefined","sortOrder":6},{"name":"piUpdateGlobalParam","title":"更新全局参数","description":"更新全局参数","params":[{"name":"param","type":"Object","required":true,"defaultValue":"$undefined","description":"包含要更新的参数键值对的对象","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"window.PiUtils.piUpdateGlobalParam({\"globalId\": \"1\"})"},"videos":[],"remarks":"$undefined","sortOrder":7},{"name":"toggleShow","title":"切换指定元素的显示状态","description":"切换指定元素的显示状态","params":[{"name":"ids","type":"String|Array","required":true,"defaultValue":"$undefined","description":"要切换的元素ID或ID数组","enumValues":"$undefined"},{"name":"type","type":"String","required":false,"defaultValue":"$undefined","description":"切换类型，默认为\"toggle\"（可选值：\"show\", \"hide\", \"toggle\"）","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"window.PiUtils.toggleShow([\"元素id1\", \"元素id2\"], \"show\")\n// or\nwindow.PiUtils.toggleShow(\"元素id1\", \"show\")"},"videos":[],"remarks":"$undefined","sortOrder":8},{"name":"componentEvent","title":"触发指定组件的事件","description":"触发指定组件的事件","params":[{"name":"trigger","type":"string","required":true,"defaultValue":"$undefined","description":"触发的事件类型 click dblclick mouseenter mouseleave","enumValues":"$undefined"},{"name":"id","type":"string","required":true,"defaultValue":"$undefined","description":"组件id","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"window.PiUtils.componentEvent({\"trigger\":\"click\",\"id\":\"组件id\"})"},"videos":[],"remarks":"$undefined","sortOrder":9},{"name":"buttonSelect","title":"设置单选多选组件的默认选中值","description":"设置单选多选组件的默认选中值","params":[{"name":"id","type":"string","required":true,"defaultValue":"$undefined","description":"组件 id","enumValues":"$undefined"},{"name":"value","type":"string | array","required":true,"defaultValue":"$undefined","description":"默认选中值。单选传空字符串、多选传空字符串或空数组即为清除选中；选中值对应列表配置项的 value","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"// 单选：选中值为 'a' 的项；清空\nwindow.PiUtils.buttonSelect('组件id', 'a')\nwindow.PiUtils.buttonSelect('组件id', '')\n\n// 多选：选中多项；清空\nwindow.PiUtils.buttonSelect('组件id', ['a', 'b'])\nwindow.PiUtils.buttonSelect('组件id', [])\nwindow.PiUtils.buttonSelect('组件id', '')"},"videos":[],"remarks":"$undefined","sortOrder":10},{"name":"getVideoStream","title":"获取视频监控组件的流地址","description":"获取视频监控组件的流地址","params":[{"name":"componentId","type":"String","required":true,"defaultValue":"$undefined","description":"视频监控组件 ID","enumValues":"$undefined"}],"returns":[{"name":"result","type":"string","required":false,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"example":{"language":"typescript","code":"window.PiUtils.getVideoStream('1gitov')"},"videos":[],"remarks":"$undefined","sortOrder":11},{"name":"setVideoStream","title":"设置视频监控组件的流地址","description":"设置视频监控组件的流地址","params":[{"name":"componentId","type":"String","required":true,"defaultValue":"$undefined","description":"视频监控组件 ID","enumValues":"$undefined"},{"name":"value","type":"String","required":true,"defaultValue":"$undefined","description":"流地址，或摄像头模式下的摄像头 id","enumValues":"$undefined"}],"returns":[],"example":{"language":"typescript","code":"window.PiUtils.setVideoStream('1gitov', 'xxx')"},"videos":[],"remarks":"$undefined","sortOrder":12},{"name":"piGetGlobalParam","title":"获取全局参数","description":"获取全局参数","params":[{"name":"key","type":"String","required":false,"defaultValue":"$undefined","description":"要获取的全局参数键名；传 '' 返回全部","enumValues":"$undefined"}],"returns":[{"name":"result","type":"any","required":false,"defaultValue":"$undefined","description":"","enumValues":"$undefined"}],"example":{"language":"typescript","code":"// 获取全部全局参数\nwindow.PiUtils.piGetGlobalParam('')\n\n// 获取指定 key\nwindow.PiUtils.piGetGlobalParam('globalId')"},"videos":[],"remarks":"$undefined","sortOrder":13}]},"digitalHuman":{"title":"数字人交互 API","apis":[{"name":"piAlert","title":"显示一个警告/提示框","description":"显示一个警告/提示框。","params":[{"name":"msg","type":"String","required":true,"defaultValue":"$undefined","description":"要显示的提示信息","enumValues":"$undefined"}],"returns":[],"example":{"language":"javascript","code":"// eventName: actionEvent\n// eventValue:\n{\n \"action\": \"piAlert\",\n \"value\": [\"操作成功完成!\"]\n}"},"videos":[],"remarks":"$undefined","sortOrder":0},{"name":"piClient","title":"执行客户端操作","description":"执行客户端操作。","params":[{"name":"action","type":"String","required":true,"defaultValue":"$undefined","description":"要执行的操作类型","enumValues":"$undefined"},{"name":"ext","type":"Object","required":true,"defaultValue":"$undefined","description":"扩展参数对象","enumValues":"$undefined"}],"returns":[],"example":{"language":"javascript","code":"// eventName: actionEvent\n// eventValue:\n{\n \"action\": \"piClient\",\n \"value\": [\n \"environment.setWeather\",\n {\n \"weather\": 2\n }\n ]\n}"},"videos":[],"remarks":"$undefined","sortOrder":1},{"name":"piGoto","title":"导航到指定页面","description":"导航到指定页面。","params":[{"name":"pageId","type":"String","required":true,"defaultValue":"$undefined","description":"目标页面的ID（可以从 `listV1` 接口查看）","enumValues":"$undefined"}],"returns":[],"example":{"language":"javascript","code":"// eventName: actionEvent\n// eventValue:\n{\n \"action\": \"piGoto\",\n \"value\": [\"页面ID\"]\n}"},"videos":[],"remarks":"$undefined","sortOrder":2},{"name":"piLink","title":"打开指定URL链接","description":"打开指定URL链接。","params":[{"name":"url","type":"String","required":true,"defaultValue":"$undefined","description":"要打开的URL地址","enumValues":"$undefined"}],"returns":[],"example":{"language":"javascript","code":"// eventName: actionEvent\n// eventValue:\n{\n \"action\": \"piLink\",\n \"value\": [\"https://example.com\"]\n}"},"videos":[],"remarks":"$undefined","sortOrder":3},{"name":"piOpenDialog","title":"打开指定对话框","description":"打开指定对话框。","params":[{"name":"id","type":"String","required":true,"defaultValue":"$undefined","description":"对话框的ID（可以从 `listV1` 接口查看）","enumValues":"$undefined"},{"name":"poiId","type":"String","required":false,"defaultValue":"$undefined","description":"POI ID，非必填。填写之后将根据POI点位移动","enumValues":"$undefined"}],"returns":[],"example":{"language":"javascript","code":"// eventName: actionEvent\n// eventValue:\n{\n \"action\": \"piOpenDialog\",\n \"value\": [\"弹窗ID\", \"poi123\"]\n}"},"videos":[],"remarks":"$undefined","sortOrder":4},{"name":"piToggle","title":"切换指定子页面的显示/隐藏状态","description":"切换指定子页面的显示/隐藏状态。","params":[{"name":"pageId","type":"String","required":true,"defaultValue":"$undefined","description":"要切换的子页面ID（可以从 `listV1` 接口查看，位于 `children` 中）","enumValues":"$undefined"}],"returns":[],"example":{"language":"javascript","code":"// eventName: actionEvent\n// eventValue:\n{\n \"action\": \"piToggle\",\n \"value\": [\"子页面ID\"]\n}"},"videos":[],"remarks":"$undefined","sortOrder":5},{"name":"piUpdateGlobalParam","title":"更新全局参数","description":"更新全局参数。","params":[{"name":"param","type":"Object","required":true,"defaultValue":"$undefined","description":"包含要更新的参数键值对的对象","enumValues":"$undefined"}],"returns":[],"example":{"language":"javascript","code":"// eventName: actionEvent\n// eventValue:\n{\n \"action\": \"piUpdateGlobalParam\",\n \"value\": [\n {\n \"globalId\": \"1\"\n }\n ]\n}"},"videos":[],"remarks":"$undefined","sortOrder":6},{"name":"toggleShow","title":"切换指定元素的显示状态","description":"切换指定元素的显示状态。","params":[{"name":"ids","type":"String` / `Array","required":true,"defaultValue":"$undefined","description":"要切换的元素ID或ID数组","enumValues":"$undefined"},{"name":"type","type":"String","required":false,"defaultValue":"$undefined","description":"切换类型，默认为 `\"toggle\"`。可选值：`\"show\"`、`\"hide\"`、`\"toggle\"","enumValues":"$undefined"}],"returns":[],"example":{"language":"javascript","code":"// eventName: actionEvent\n// eventValue:\n{\n \"action\": \"toggleShow\",\n \"value\": [\"元素id1\", \"show\"]\n}"},"videos":[],"remarks":"$undefined","sortOrder":7},{"name":"componentEvent","title":"触发指定组件的事件","description":"触发指定组件的事件。","params":[{"name":"trigger","type":"String","required":true,"defaultValue":"$undefined","description":"触发的事件类型。可选值：`click`、`dblclick`、`mouseenter`、`mouseleave","enumValues":"$undefined"},{"name":"id","type":"String","required":true,"defaultValue":"$undefined","description":"组件ID","enumValues":"$undefined"}],"returns":[],"example":{"language":"javascript","code":"// eventName: componentEvent\n// eventValue:\n{\n \"action\": \"componentEvent\",\n \"value\": {\n \"trigger\": \"click\",\n \"id\": \"组件id\"\n }\n}"},"videos":[],"remarks":"$undefined","sortOrder":8}]}},"children":"$L19"}]]}]]}] 5:[["$","$L1a",null,{"items":[{"label":"首页","href":"/"},{"label":"客户端 API","href":"/client-api/Camera"},{"label":"GIS","href":"/client-api/GIS"},{"label":"gis.highlight3DTileWithId","href":"/client-api/GIS/gis.highlight3DTileWithId"}]}],["$","div",null,{"className":"api-page-header","children":[["$","div",null,{"style":{"display":"flex","alignItems":"center","gap":12,"flexWrap":"wrap","marginBottom":12},"children":["$","$L1b",null,{"href":"/client-api/GIS","style":{"fontSize":14,"color":"var(--text-tertiary)"},"children":["← ","GIS"]}]}],["$","h1",null,{"children":["$","code",null,{"style":{"fontSize":"0.8em"},"children":"gis.highlight3DTileWithId"}]}],["$","p",null,{"style":{"color":"var(--text-secondary)","margin":"0 0 12px","fontSize":18},"children":"GIS-高亮3D瓦片组件"}],["$","div",null,{"className":"api-page-meta","children":[["$","span",null,{"children":["模块：","GIS"]}],["$","span",null,{"children":["调用：piclient.emit('","gis.highlight3DTileWithId","', ","{...}",")"]}]]}]]}],["$","div",null,{"className":"api-doc","children":[["$","p",null,{"className":"api-doc-desc","children":"高亮3D瓦片组件"}],["$","section",null,{"className":"api-doc-section","children":[["$","h4",null,{"children":"输入"}],["$","div",null,{"className":"markdown-body","children":["$","table",null,{"className":"api-param-table","children":[["$","thead",null,{"children":["$","tr",null,{"children":[["$","th",null,{"children":"参数"}],["$","th",null,{"children":"类型"}],["$","th",null,{"children":"必填"}],["$","th",null,{"children":"默认值"}],["$","th",null,{"children":"说明"}]]}]}],["$","tbody",null,{"children":[["$","tr","id",{"children":[["$","td",null,{"children":["$","code",null,{"children":"id"}]}],["$","td",null,{"children":["$","code",null,{"children":"string"}]}],["$","td",null,{"children":"是"}],["$","td",null,{"children":["$","code",null,{"children":"0"}]}],["$","td",null,{"children":["唯一标记组件的ID",null]}]]}],["$","tr","globalSelectColor",{"children":[["$","td",null,{"children":["$","code",null,{"children":"globalSelectColor"}]}],["$","td",null,{"children":["$","code",null,{"children":"string"}]}],["$","td",null,{"children":"是"}],["$","td",null,{"children":["$","code",null,{"children":"#00FF00"}]}],["$","td",null,{"children":["—",null]}]]}]]}]]}]}]]}],null,["$","section",null,{"className":"api-doc-section","children":[["$","h4",null,{"children":"调用"}],[],["$","$L1c",null,{"html":"\n

\n typescript\n \n

piclient.emit("gis.highlight3DTileWithId",{\n\tid: "0", //唯一标记组件的ID\n\tglobalSelectColor: "#00FF00",\n})\n

\n \n"}]]}],null]}],["$","div",null,{"style":{"marginTop":40,"paddingTop":24,"borderTop":"1px solid var(--border-primary)"},"children":["$","$L1b",null,{"href":"/client-api/GIS","className":"btn btn-secondary","children":["← 返回 ","GIS"," 模块"]}]}]]

参数	类型	必填	默认值	说明
`id`	`string`	是	`0`	唯一标记组件的ID
`globalSelectColor`	`string`	是	`#00FF00`	—