修复 SGS SDK 导览数据源与模型加载
升级 SDK API 数据契约,补齐 guideStops、业务 POI、诊断与路线数据接口。 修复 SDK 模式下 POI/模型/楼层混用静态数据的问题,并为 ThreeMap 模型加载增加短退避重试。
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# SGS Map SDK 交付包
|
||||
|
||||
> **版本**:V2.3.0
|
||||
> **版本**:V2.4.0
|
||||
> **定位**:深圳自然博物馆统一三维高精地图导航服务平台 H5 SDK
|
||||
|
||||
欢迎接入 SGS Map SDK!本 SDK 将复杂的 WebGL 三维渲染、GLB 模型管线与 NavMesh 物理寻路引擎封装在服务端基座中,业务端(H5 / 大屏 / 小程序)只需通过几行代码即可极速唤起 3D 地图。
|
||||
@@ -16,7 +16,13 @@ sgs-map-sdk-release/
|
||||
│ ├── index.mjs.map # ESM source map
|
||||
│ ├── index.d.ts # TypeScript 类型声明文件
|
||||
│ └── index.d.mts # TypeScript 模块声明文件
|
||||
├── demo/ # SDK 能力展示 Demo(可直接运行)
|
||||
│ ├── index.html # Demo 入口页面
|
||||
│ ├── app.js # Demo 应用逻辑
|
||||
│ └── styles.css # Demo 样式表
|
||||
├── package.json # NPM 元信息
|
||||
├── CHANGELOG.md # 版本变更日志
|
||||
├── RELEASE_NOTES_2.4.0.md # V2.4.0 正式发布说明
|
||||
├── sdk-quickstart.md # 【必读】10 分钟快速接入指南(含完整示例代码)
|
||||
├── sdk-api-reference.md # 【必读】第三方开发 API 参考手册
|
||||
├── sdk-protocol.md # 【选读】底层通信协议与安全沙箱规范说明
|
||||
@@ -52,6 +58,14 @@ sgs-map-sdk-release/
|
||||
|
||||
## 📚 如何开始?
|
||||
|
||||
- **快速体验 Demo**:
|
||||
发布包内附带 `demo/` 目录,是一个完整的 SDK 能力展示页面,支持空间查询、POI 查询、讲解点、导航规划、诊断等全部功能。运行方式:
|
||||
```bash
|
||||
npx -y serve . -l 5555
|
||||
# 浏览器打开(?server= 指向运行中的地图服务)
|
||||
# http://localhost:5555/demo/?server=http://localhost:3001
|
||||
```
|
||||
|
||||
- **如果您是普通前端业务开发 / 微信小程序开发**:
|
||||
直接打开 `sdk-quickstart.md`,复制里面的示例代码,10分钟即可完成接入。
|
||||
*(注:微信小程序团队完全无需引入 `dist` 下的代码,请仔细阅读文档中小程序 `<web-view>` 的原生接入方式)*
|
||||
@@ -59,12 +73,28 @@ sgs-map-sdk-release/
|
||||
- **如果您需要逐个查询 API 参数、返回值和错误码**:
|
||||
打开 `sdk-api-reference.md`,按方法名查阅第三方调用说明。
|
||||
|
||||
- **如果您需要了解 V2.4.0 新版本变化与发布边界**:
|
||||
打开 `RELEASE_NOTES_2.4.0.md`,查看业务 POI、精品路线、动线展示、兼容性和已验证范围。
|
||||
|
||||
- **如果您是对架构感兴趣的高级开发**:
|
||||
可以阅读 `sdk-protocol.md`,了解我们如何通过双域确权协议解决 `postMessage` 多实例安全问题,以及 WebGL 的安全释放机制。
|
||||
|
||||
---
|
||||
|
||||
## 🆕 V2.3.0 当前能力概览
|
||||
## 🆕 V2.4.0 当前能力概览
|
||||
|
||||
### V2.4.0 新增方法
|
||||
|
||||
| 方法 | 签名 | 说明 |
|
||||
|------|------|------|
|
||||
| `getBusinessPois` | `getBusinessPois(floorId: string \| number, options?: any)` | 获取指定楼层的业务 POI(例如商铺、餐饮等),与基础设施 POI 分离 |
|
||||
| `queryPois` | `queryPois(params: SgsPoiQueryParams)` | 灵活的多字段 POI 检索接口,支持按地图、楼层、分组、类型、关键词组合查询 |
|
||||
| `getFeaturedRoutes` | `getFeaturedRoutes(mapId: string \| number, options?: any)` | 获取当前地图关联的特色精选路线列表摘要 |
|
||||
| `getFeaturedRoute` | `getFeaturedRoute(routeId: string \| number)` | 根据路线 ID 获取特色精选路线的详细路点序列与说明 |
|
||||
| `showFlowline` | `showFlowline(routeId: string \| number)` | 在地图上高亮渲染展示一条特色动线(自动切换至全局俯瞰视角) |
|
||||
| `clearFlowline` | `clearFlowline()` | 清除当前展示的特色动线并恢复默认视图 |
|
||||
|
||||
## V2.3.0 基础数据能力
|
||||
|
||||
### V2.3.0 新增方法
|
||||
|
||||
|
||||
Reference in New Issue
Block a user