---
layout: home

hero:
  name: u-space
  text: WebGPU-ready 3D Engine
  tagline: 基于 Three.js 的插件化 3D 可视化库，支持 GIS 瓦片、动画、场景管理与交互系统。
  actions:
    - theme: brand
      text: 快速上手
      link: /getting-started
    - theme: alt
      text: API 文档
      link: /api-viewer
    - theme: alt
      text: 在线示例
      link: /examples/
      target: _self

features:
  - title: WebGPU 优先
    details: 基于 Three.js WebGPU 渲染器，支持 TSL（Three Shading Language）着色器节点，同时保持 WebGL 兼容回退。
  - title: 插件化架构
    details: 核心轻量，通过独立插件按需扩展：GIS 瓦片、小地图、键盘控制、场景管理、曲线动画等。
  - title: 交互系统
    details: 内置射线检测与事件冒泡，像操作 DOM 元素一样为 3D 对象添加 click、pointerenter 等事件。
---

## 文档目录

### 核心 API

| 文档 | 说明 |
| :--- | :--- |
| [Viewer](./api-viewer) | 核心类：渲染器、场景、相机、控制器、事件，以及带超大贴图保护的实验性 OffscreenCanvas Worker runtime |
| [CameraControls](./api-camera-controls) | 相机控制：飞行、视角切换、视点过渡 |
| [CSSRenderer](./api-css-renderer) | CSS 渲染器：CSS2D / CSS2.5D / CSS3D 叠加 HTML 元素 |
| [RenderPipeline](./api-render-pipeline) | 后处理管线：Bloom、SSGI、SSR 时空降噪、TRAA、自定义后处理 |
| [Objects](./api-objects) | 3D 对象：统一 `InstanceObject` API、模型加载、基础网格、Poi、Topology |
| [Batches](./api-batches) | 公共批处理：`ModelInstancedLayer`、`EditableGeometryBatchLayer`、fallback、materialize 与 raycast remap |
| [Interactions](./api-interactions) | 交互管理：射线检测、鼠标/触摸事件、框选 |
| [Managers](./api-managers) | 对象管理、场景管理、灯光管理 |
| [Animations](./api-animations) | 补间动画：`tweenAnimation`、`Tween`、缓动模式 |
| [Effects](./api-effects) | 视觉特效：高亮、呼吸、线框、淡入淡出、流动、流体与可组合 Outline（TSL） |
| [Tools](./api-tools) | 工具：测量（距离/面积/角度）、剖切（面/盒）、标注管理 |

### 插件

所有插件从 `u-space/plugins/<name>` 导入。

| 插件 | 说明 |
| :--- | :--- |
| [keyboard-controls](./api-plugin-keyboard-controls) | WASD / 方向键控制相机移动与旋转 |
| [minimap](./api-plugin-minimap) | 2D 小地图叠加层 |
| [tiles](./api-plugin-tiles) | ArcGIS 3D 瓦片 / GIS 地球渲染 |
| [u-manager](./api-plugin-u-manager) | 场景加载、可编辑静态 Geometry batching、模型 instancing、语义楼层/井道/设备、拓扑、动画、属性与视点管理 |
| [curve-movement](./api-plugin-curve-movement) | 沿样条曲线移动相机或对象 |
| [tracking-controls](./api-plugin-tracking-controls) | 相机跟随移动目标 |
| [atmosphere](./api-plugin-atmosphere) | 天空背景、天空环境、太阳/月亮光照与阴影 |
| [fire](./api-plugin-fire) | WebGPU 体积火焰、烟雾、湍流、动态光照与阴影 |
| [object-controls](./api-plugin-object-controls) | 交互式移动、旋转、缩放 3D 对象 |
| [topology-drawer](./api-plugin-topology-drawer) | 在场景任意表面交互式绘制拓扑路径图 |

### MCP

| 文档 | 说明 |
| :--- | :--- |
| [u-space MCP](./mcp) | 面向 Mastra、Claude Desktop、Cursor 等 MCP 客户端的只读文档检索服务器 |

### 维护

| 文档 | 说明 |
| :--- | :--- |
| [一键发布](./release) | 通过 GitHub Actions、npm Trusted Publishing 和 Vercel 发布 `u-space`、`u-space-mcp`、docs 与 examples |