API 参考

本区分两层。手写概览页按 manager 组织,负责讲清设计意图、能力边界与典型用法——先读它来理解「该用哪个接口、怎么组合」;生成的 API 细节(左侧「生成的 API 细节」分组)由 TypeDoc 从 @modelcubes/viewer-core 源码自动生成,负责精确的签名、参数与类型定义。推荐的阅读方式:从概览页定位到目标 manager 与方法,再跳到生成页核对确切签名与类型。

浏览能力

任何集成都会用到的部分,从 Viewer 入口开始:

model、camera、selection、edges、lights、stats、background、navcube、renderMode、quality、section、explode、export、views。

编辑能力

只在需要修改并保存模型呈现的宿主(编辑器一类)里用得上,全景见编辑能力:

transform(零部件位置)、explodeEdit(编辑态爆炸)、labels(序号标签)、history(统一撤销栈)。结构删除 / 合并与外观编辑归在 model 内。

---

各 manager 在生成文档中以 Interface 形式出现,均通过 viewer.model、viewer.camera 等属性获取,不可也无需 new。

开发提示: docs/api/generated/ 由 npm run api:gen -w @fmb/viewer-docs 生成且不入库;fresh clone 后先跑一次 api:gen 再 docs:dev(npm run build 已内置该步骤)。

viewer.diagnostics 为实验性诊断接口,不建议外部集成使用。