API 概述
Sightp SDK 包含 146 个 API 接口，分布在 5 个核心模块中。
模块列表
| 模块 | 接口数 | 说明 |
|---|---|---|
| ar-nav-system-core | 58 | 导航核心算法和类型定义 |
| ar-nav-system-pc | 53 | PC 端导航实现（PlayCanvas） |
| tiny-runtime | 49 | 应用运行时和资源管理 |
| tiny-ar-plugin | 21 | AR 功能集成和插件 |
| tiny-allinone | 4 | 整合包导出 |
通用类型
位置类型
typescript
interface commonPosition {
x: number
y: number
z: number
}导航设置
typescript
interface navSetting {
id: string | number // 路网 ID
requestRoute: Function // 路算请求方法
routeWidth?: number // 路径宽度 (默认 6)
arriveRadious?: number // 到达判定距离 (默认 5)
drawPathLength?: number // 绘制长度 (默认 -1 全部)
}事件系统
导航事件
| 事件名 | 参数 | 说明 |
|---|---|---|
nav_start | target | 开始导航 |
nav_cancel | - | 取消导航 |
nav_message | navMessage | 导航消息 (每1秒) |
nav_arrive | target, endAction | 到达终点 |
nav_break | planInfo | 到达中断点 |
nav_deviate | - | 偏离路线 |
route_ready | markers, plans | 路线准备就绪 |
运行时事件
| 事件名 | 参数 | 说明 |
|---|---|---|
inited | tinyRoot | 初始化完成 |
loaded | tinyRoot | 加载完成 |
load_progress | progress, tinyRoot | 加载进度 |