deep-engine-demo/packages/docs/api-examples.md

outline
2 3

文档说明

Deep Engine 是一个基于 Three.js WebGPU 进行封装的三维引擎库。本文档站用于说明该库的定位、能力范围以及文档阅读方式。

库定位

该项目并不是对 Three.js 的简单示例集合，而是在 Three.js WebGPU 能力基础上进行二次封装，形成一套更适合业务项目接入的 SDK。

它主要面向以下场景：

• 三维场景浏览与交互
• 行业模型加载与展示
• 参数化构件生成
• 剖切、选择、标注与面板管理
• 点云、体积数据与特效表现

文档内容

当前文档主要分为以下几部分：

• API 示例说明：说明文档的组织方式与阅读建议
• 首页：说明库的整体定位与核心能力
• API：按源码模块整理的接口文档

适合阅读人群

本文档更适合具备以下基础的开发者阅读和使用：

• 需要具备前端开发基础，能够理解工程结构、模块组织和基础构建流程
• 需要具备基础的三维图形能力，理解场景、相机、材质、几何体、坐标系等基本概念
• 需要具备 Three.js 使用经验，能够理解常见对象、渲染流程以及场景交互方式

文档导航布局

当前文档站已经调整为双栏导航结构，便于同时浏览模块层级与当前页面内容：

• 左侧显示大目录：按文档入口、API 模块分类、源码扩展分类组织页面
• 右侧显示小目录：自动提取当前页面的 H2 与 H3 标题，便于页内快速跳转

阅读建议

如果你是第一次接触这个库，建议按下面顺序阅读：

1. 先阅读文档说明，明确文档结构、阅读方式和前置能力要求。
2. 再阅读首页，了解该库是基于 Three.js WebGPU 的封装库。
3. 然后阅读 packages/docs/api 下的 API 文档，熟悉 Viewer、Tool、Parametric、Effect 等模块。
4. 最后结合 packages/demo/src 中的示例场景，对照查看具体调用方式。

与 Demo 的关系

文档中的很多示例都来自 packages/demo/src。
也就是说，文档并不是脱离项目的独立说明，而是与 Demo 保持对应关系，方便直接从真实业务代码理解 API 的使用方式。

说明

后续如果 SDK 能力继续扩展，这里的说明页也应同步更新，确保文档与源码、Demo 保持一致。