@realsee/five 6.8.0-alpha.0 → 6.8.0-alpha.10

package/ai_guides/features/camera-animation.md

@@ -0,0 +1,205 @@
+# 相机动画 (Camera Animation)
+
+- **Summary**: 介绍如何在 Five 中通过编程方式控制相机运动，包括旋转、位移、全景切换以及模态转换时的动画效果。
+- **Schema**: `State` (状态), `MovePanoOptions` (移动参数)。
+- **Concepts**: Pose (位姿), Animation Loop, Easing (缓动), Fly/Fade Effect。
+- **Configuration**: `modeChangeDuration`, `movePanoOptions`。
+- **Examples**: 旋转视角、切换全景点、模态切换动画。
+
+## Schema
+
+### MovePanoOptions
+
+> **Definition**: [MovePanoOptions](../../five/types/movePanoOptions.d.ts)
+
+点位移动参数配置。
+
+```typescript
+interface MovePanoOptions extends Partial<Omit<State, "offset" | 'distance' | 'mode'>> {
+  /** 动画效果: 'fly' | 'fade' | 'instant' ... */
+  effect?: MovePanoEffect;
+  /** 走点图片过度策略 */
+  effectEasing?: (progress: number) => number;
+  /**
+   * 运动耗时 (ms)
+   * - number: 固定时长
+   * - function: (distance, speed) => number 根据距离动态计算
+   */
+  duration?: number | ((distance: number, speed: number) => number) | string | null;
+  /** 运动开始回调 */
+  moveStartCallback?: (toState: State) => void;
+  /** 运动结束回调 */
+  moveEndCallback?: (state: State) => void;
+  /** 运动被取消回调 */
+  moveCancelCallback?: () => void;
+}
+```
+
+### MovePanoEffect
+
+```typescript
+type MovePanoEffect =
+  | "fly"     // 通过相机移动方式变化 (默认)
+  | "instant" // 直接变化 (无动画)
+  | "fade"    // 通过渐变方式变化
+  | "model";  // 通过过度到模型
+```
+
+## Core Methods (核心方法)
+
+Five 提供了多种层级的 API 来控制相机动画。
+
+### 1. setState
+
+最通用的状态更新方法。可以通过修改 `longitude` / `latitude` (旋转) 或 `fov` (缩放) 来产生动画。
+
+```typescript
+five.setState(state: Partial<State>, immediately?: boolean): void
+```
+
+*   `state`: 目标状态 (包含 mode, panoIndex, longitude, latitude, fov 等)。
+*   `immediately`: 是否立即跳转 (无动画)。默认为 `false` (有动画)。
+
+### 2. moveToPano
+
+专用于全景点位之间的切换。支持 "飞行" (Fly) 和 "渐变" (Fade) 两种效果。
+
+```typescript
+five.moveToPano(panoIndex: number, options?: MovePanoOptions): Promise<void>
+```
+
+*   `options.effect`: 切换效果。`'fly'` (空间飞行) 或 `'fade'` (淡入淡出)。
+*   `options.duration`: 动画时长 (ms)。
+*   `options.moveEndCallback`: 动画结束回调。
+
+### 3. changeMode
+
+切换交互模式 (如从全景切换到模型鸟瞰)。
+
+```typescript
+five.changeMode(mode: Mode, options?, animationOptions?): Promise<void>
+```
+
+## Concepts
+
+### Pose (位姿)
+
+相机的状态主要由位姿描述：
+
+*   **Longitude (经度)**: 水平旋转角度 (0 - 2π)。
+*   **Latitude (纬度)**: 垂直旋转角度 (-π/2 - π/2)。
+*   **FOV (视场角)**: 相机可视范围角度。
+
+### Animation Effects (动画效果)
+
+*   **Linear / Easing**: 大多数 `setState` 产生的旋转和缩放动画使用平滑的缓动函数 (Ease-in-out)。
+*   **Fly (飞行)**: 模拟真实空间中的移动，相机位置会发生物理位移。适用于 `Panorama` 模式下的点位切换。
+*   **Fade (渐变)**: 保持相机位置不变，通过透明度渐变切换场景。适用于距离较远或不通视的点位切换。
+
+## Configuration
+
+### Global Configuration (全局配置)
+
+在 `new Five(config)` 初始化时可以设置全局动画参数：
+
+| Parameter | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `modeChangeDuration` | `number` | `1000` | 模态切换 (如 Panorama -> Mapview) 的默认时长 (ms)。 |
+
+### MovePanoOptions Configuration (移动参数)
+
+调用 `five.moveToPano(index, options)` 时使用的配置参数：
+
+| Parameter | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `effect` | `MovePanoEffect` | `'fly'` | 动画效果。<br>`'fly'`: 空间移动（模拟行走）；<br>`'fade'`: 淡入淡出（保持位置不变）；<br>`'instant'`: 瞬间跳转。 |
+| `duration` | `number` \| `Function` | - | 动画时长 (ms)。若不传，则根据距离和速度自动计算。 |
+| `effectEasing` | `Function` | - | 自定义过渡效果的缓动函数。 |
+| `moveEndCallback` | `Function` | - | 动画结束后的回调函数。 |
+
+## Examples
+
+### 1. 旋转视角 (Rotate Camera)
+
+平滑旋转到指定角度。
+
+```typescript
+// 旋转到水平 0 度，垂直 0 度
+five.setState({
+  longitude: 0,
+  latitude: 0
+});
+
+// 立即跳转 (无动画)
+five.setState({ longitude: Math.PI }, true);
+```
+
+### 2. 切换全景点 (Change Pano)
+
+模拟行走效果切换到下一个房间。
+
+```typescript
+// 飞向索引为 2 的全景点
+five.moveToPano(2, {
+  effect: 'fly', // 飞行效果
+  duration: 1500, // 1.5秒
+  moveEndCallback: () => {
+    console.log("到达目的地");
+  }
+});
+```
+
+### 3. 模态切换 (Change Mode)
+
+从全景模式切换到户型图模式。
+
+```typescript
+// 切换到 Floorplan 模式
+five.changeMode('Floorplan');
+
+// 切换回 Panorama 模式，并指定进入时的视角
+five.setState({
+  mode: 'Panorama',
+  panoIndex: 0,
+  longitude: Math.PI / 2
+});
+```
+
+### 4. 自动巡更 (Auto Tour)
+
+通过连续调用 `setState` 或 `moveToPano` 实现简单的自动导览。
+
+```typescript
+async function startTour() {
+  // 1. 先看天花板
+  five.setState({ latitude: Math.PI / 3 });
+  await wait(2000); // 等待动画完成
+
+  // 2. 移动到下一个点
+  await five.moveToPano(1, { effect: 'fly' });
+
+  // 3. 切换到模型鸟瞰
+  await five.changeMode('Mapview');
+}
+
+function wait(ms: number) {
+  return new Promise(resolve => setTimeout(resolve, ms));
+}
+```
+
+## Common Pitfalls
+
+1.  **并发调用**: 尽量避免在动画过程中再次调用 `setState`，这可能会打断当前动画或导致状态突变。建议使用 `Promise` 或回调等待动画结束。
+3.  **相机位姿**: 确保传入的 `longitude` / `latitude` 符合 Five 的坐标系定义 (Y-up, 右手系)。
+
+## Related
+
+*   [Five](./five.md): Five 核心类及 `setState` 方法。
+*   [Mode](./mode.md): 各种交互模式说明。
+*   [State](./state.md): 状态对象的完整定义。
+
+---
+
+```yaml
+tags: [camera-animation, pose, state]
+```

package/ai_guides/features/clipper.md

@@ -0,0 +1,135 @@
+# 模型裁切 (Model Clipper)
+
+- **Summary**: 使用 `parameter.clippers` 定义裁切盒，用于隐藏 (discard) 模型中特定区域的点云或网格。
+- **Schema**: `PBMClipperParameter` 数组，包含变换矩阵和楼层索引。
+- **Concepts**: Clipping Box (裁切盒), Matrix Transformation (矩阵变换), Negative Space (负空间).
+- **Configuration**: `five.model.clippers`.
+- **Examples**: 创建裁切盒并应用。
+
+## Schema
+
+> **Definition**: [PBMClipperParameter](../../five/model/materials/pbmMaterial.d.ts)
+
+```typescript
+/** 模型裁切参数 */
+interface PBMClipperParameter {
+  /**
+   * 裁切盒的变换矩阵。
+   * @description
+   * 定义了一个变换后的立方体空间。
+   * 基础形状为边长为 1 的立方体，中心在 (0,0,0)，范围 [-0.5, 0.5]。
+   * 凡是落在这个变换后立方体内部的模型点，都会被丢弃 (discard)。
+   */
+  clippingBoxMatrix: THREE.Matrix4;
+
+  /**
+   * (可选) 楼层索引。
+   * @description
+   * 如果指定，则裁切仅对该楼层的点云生效。
+   * 如果未指定 (undefined)，则对所有楼层生效。
+   */
+  floorIndex?: number;
+}
+```
+
+## Concepts
+
+### Clipping Box (裁切盒)
+Five 的裁切机制是基于**负空间**的：
+- 默认情况下，所有模型点都是可见的。
+- 当你添加一个 Clipper 时，你实际上是在定义一个“不可见区域”。
+- 任何位于 Clipper 定义的 3D 盒体内部的点，都不会被渲染。
+
+### Matrix Transformation (矩阵变换)
+Clipper 的几何定义依赖于 `clippingBoxMatrix`。
+- shader 内部逻辑是将世界坐标系下的点，乘以 `clippingBoxMatrix` 的**逆矩阵**。
+- 然后判断该点是否在 `[-0.5, 0.5]` 的单位立方体范围内。
+- 这意味着你可以直接使用 `THREE.Mesh` (BoxGeometry 1x1x1) 的 `matrix` 属性作为 `clippingBoxMatrix`，所见即所得。
+
+## Configuration
+
+你可以通过 `five.model.clippers` 属性来读写裁切配置。
+
+| 属性 | 类型 | 说明 |
+| --- | --- | --- |
+| `five.model.clippers` | `PBMClipperParameter[]` | 设置裁切参数数组。设置新数组会覆盖旧配置。 |
+
+## Examples
+
+### 基础用法 (Basic Usage)
+
+创建一个不可见的 Box，将其位置和大小作为裁切区域。
+
+```typescript
+import * as THREE from 'three';
+import { Five } from '@realsee/five';
+
+// 1. 创建一个辅助 Mesh 来定义裁切区域
+// 注意：必须使用 1x1x1 的 BoxGeometry，因为 Shader 是基于单位立方体判断的
+const clipperMesh = new THREE.Mesh(
+  new THREE.BoxGeometry(1, 1, 1),
+  new THREE.MeshBasicMaterial({ color: 0xff0000, wireframe: true })
+);
+
+// 2. 设置裁切盒的位置、旋转和缩放
+clipperMesh.position.set(0, 1.5, 0); // 抬高位置
+clipperMesh.scale.set(2, 3, 2);      // 设定大小为 2x3x2
+clipperMesh.rotation.y = Math.PI / 4; // 旋转 45 度
+
+// 更新矩阵，确保 .matrix 属性是最新的
+clipperMesh.updateMatrix();
+
+// (可选) 将辅助 Mesh 加入场景以便调试看到范围
+five.scene.add(clipperMesh);
+
+// 3. 应用裁切参数
+five.model.clippers = [
+  {
+    clippingBoxMatrix: clipperMesh.matrix,
+    // floorIndex: 0 // 可选：仅裁切第 0 层
+  }
+];
+
+// 4. 触发重绘
+five.needsRender = true;
+```
+
+### 动态更新 (Dynamic Update)
+
+如果需要动态移动裁切盒，需要重新赋值 `five.model.clippers` 或手动触发更新机制（虽然 setter 会自动触发更新，但如果只修改数组内部对象可能需要重新赋值）。
+
+```typescript
+function updateClipper(mesh: THREE.Mesh) {
+  mesh.updateMatrix();
+
+  // 重新赋值以触发 Five 内部的 setter 和 uniform 更新
+  five.model.clippers = [{
+    clippingBoxMatrix: mesh.matrix
+  }];
+}
+
+// 在动画循环或交互事件中调用
+// ...
+```
+
+## Debugging
+
+- **辅助显示**: 始终建议在开发阶段将用于生成矩阵的 `THREE.Mesh` (Wireframe 模式) 添加到 `five.scene` 中，这样可以直观地看到裁切范围是否正确。
+- **单位问题**: 确保 `BoxGeometry` 构造时没有传入参数 (默认 1,1,1) 或者显式传入 `(1, 1, 1)`。如果使用了 `(10, 10, 10)` 的几何体，那么 `scale` 设置为 1 时实际裁切范围是 10，可能会导致误解。建议统一使用单位几何体 + `scale` 的方式。
+
+## Common Pitfalls
+
+1.  **矩阵未更新**: 修改了 Mesh 的 position/scale 后忘记调用 `updateMatrix()`，导致裁切位置没变。
+2.  **几何体尺寸**: 使用了非 `1x1x1` 的 BoxGeometry，导致裁切范围与 Mesh视觉大小不一致（Shader 始终假定是单位立方体）。
+3.  **楼层索引**: 设置了错误的 `floorIndex` 导致裁切看起来没生效（因为该区域的点可能属于另一个 floorIndex）。
+4.  **坐标系**: `clippingBoxMatrix` 是世界坐标系下的变换。如果模型本身有额外的父级变换（通常 Five 的模型直接在 Scene 下，或者是 Identity 变换），通常不需要额外处理。
+
+## Related
+
+*   [model.md](./model.md): 模型模块概览。
+
+---
+
+```yaml
+tags: [clipper, model, cut, discard, geometry]
+```

package/ai_guides/features/coordinate-system.md

@@ -0,0 +1,128 @@
+# 坐标系 (Coordinate System)
+
+- **Summary**: 详解 Five 中的坐标系定义（Local, ENU, ECEF）及其相互转换关系。
+- **Concepts**: Local (Y-up), ENU (Z-up), ECEF, ENU84, RootMeta, Observers.
+- **Configuration**: `rootMeta` `coordinate` 配置。
+- **Examples**: 坐标转换方法示例。
+
+## Schema
+
+> **Definition**: [TilesetHeader](../../five/model/tile3d/header.d.ts)
+
+### RootMeta
+
+3D Tiles `rootMeta` 字段中定义的坐标系元数据。
+
+```typescript
+interface RootMeta {
+  /** 模型垂直轴向 (如 "Z", "-Y") */
+  upAxis?: string;
+  /** 坐标系转换矩阵信息 */
+  coordinate?: Coordinate;
+}
+```
+
+### Coordinate
+
+描述 ECEF 与 ENU 之间的转换关系。
+
+```typescript
+interface Coordinate {
+  /** 地面高度 */
+  ground_height?: number;
+  /** ECEF 到 ENU 的转换矩阵 (4x4 数组) */
+  pose_ecef_to_enu?: number[];
+  /** ENU 到 ECEF 的转换矩阵 (4x4 数组) */
+  pose_enu_to_ecef?: number[];
+}
+```
+
+## Concepts
+
+### Local Coordinate System (Y-up)
+Five 的渲染场景 (`five.scene`) 和 Observers (观察点) 使用 **Y-up** (Y 轴向上) 的右手坐标系。
+这与 Three.js 的默认坐标系一致，便于前端开发和场景渲染。
+- **Y 轴**: 垂直向上。
+- **X/Z 轴**: 水平平面。
+
+### ENU Coordinate System (Z-up)
+在本项目及相关算法交互中，**ENU** 指代 **Z-up** (Z 轴向上) 的坐标系。这是为了和测绘行业习惯保持一致。
+- **Z 轴**: 垂直向上。
+- **X/Y 轴**: 水平平面。
+- **ENU84**: 特指 Y 轴正向指向正北 (North) 的 ENU 坐标系。（注：普通的 ENU 坐标系中，北向不一定对应 Y 轴，这与部分行业标准有所区别）。
+- **用途**: 推荐在给算法或后端接口传递模型数据时，使用 ENU 坐标系。
+
+### ECEF Coordinate System
+地心地固坐标系 (Earth-Centered, Earth-Fixed)。
+- 当模型包含 RTK (Real-time kinematic) 信息时，通常基于 ECEF 坐标系进行描述。
+- 可以通过 `ecefToEnu` 方法将 ECEF 坐标转换为 ENU 坐标。
+
+### Model Orientation (at3d / 3dtiles)
+模型 (如 `.at3d`, 3D Tiles) 的加载逻辑遵循以下原则：
+1.  **无 RTK 信息**: 默认为 **Z-up** (ENU)。
+2.  **有 RTK 信息**: 遵循 **ECEF** 坐标系。
+3.  **自动对齐**: Five 加载模型时（load 方法），会自动处理旋转和坐标系转换，将其对齐到 Five 的 Local (Y-up) 坐标系中。
+    - 开发者在 `five.scene` 中看到的所有模型都已处于统一的 Y-up 坐标系下。
+
+### Coordinate in Files
+在 3D Tiles 的 `tileset.json` 中，`rootMeta` 字段用于描述坐标系转换信息（没有该字段则默认 Z-up）：
+- 包含 `pose_ecef_to_enu` 和 `pose_enu_to_ecef` 变换矩阵。
+- Five 读取这些信息来计算并构建完整的坐标转换链, 进行模型-观察点的坐标对齐。
+
+在 model 的 `coordinate` 字段用于描述坐标系转换信息（没有该字段则默认 Z-up）：
+- 包含 `pose_ecef_to_enu` 和 `pose_enu_to_ecef` 变换矩阵。
+- Five 读取这些信息来计算并构建完整的坐标转换链，确保模型-观察点的坐标对齐。
+
+## Instance Methods
+
+`ViewLayer` (继承自 `Tile3D`) 提供了成套的坐标转换方法，用于在 Local, ENU, ECEF 和 World 之间进行转换。
+
+| 方法名 | 说明 |
+| --- | --- |
+| `localToEnu(vector)` | Local (Y-up) -> ENU (Z-up) |
+| `enuToLocal(vector)` | ENU (Z-up) -> Local (Y-up) |
+| `enuToEcef(vector)` | ENU (Z-up) -> ECEF |
+| `ecefToEnu(vector)` | ECEF -> ENU (Z-up) |
+| `localToEcef(vector)` | Local (Y-up) -> ECEF |
+| `ecefToLocal(vector)` | ECEF -> Local (Y-up) |
+| `worldToEnu(vector)` | World -> ENU (Z-up) |
+| `enuToWorld(vector)` | ENU (Z-up) -> World |
+
+> 注: `World` 坐标系通常指 Three.js 的世界坐标 (即 `five.scene` 的坐标)。在未通过 `Object3D` 层级嵌套偏移的情况下，`World` 等同于 `Local`。
+
+## Examples
+
+### 坐标转换 (Coordinate Transformation)
+
+推荐在与后端或算法交互时，将 Local 坐标转换为 ENU 坐标。
+
+```typescript
+import * as THREE from 'three';
+import { ViewLayer } from '@realsee/five';
+
+// 假设已加载 ViewLayer
+const viewLayer: ViewLayer = ...;
+
+// 1. 获取场景中某点的坐标 (Local Y-up)
+const localPosition = new THREE.Vector3(10, 20, 30);
+
+// 2. 转换为 ENU 坐标 (Z-up) 用于传输给后端/算法
+const enuPosition = viewLayer.localToEnu(localPosition.clone());
+
+console.log(`Local: ${localPosition.toArray()}`); // [x, y, z] (y-up)
+console.log(`ENU: ${enuPosition.toArray()}`);     // [x, y, z] (z-up)
+
+// 3. 将 ECEF 坐标转换为 Local 坐标用于显示
+const ecefPosition = new THREE.Vector3( ... );
+const displayPosition = viewLayer.ecefToLocal(ecefPosition.clone());
+```
+
+## Related
+
+*   [load-external-model.md](./load-external-model.md): 加载外部模型时的坐标轴配置 (`upAxis`, `modelUpAxis`)。
+
+---
+
+```yaml
+tags: [coordinate-system, enu, ecef, z-up, y-up, transform]
+```

package/ai_guides/features/event.md

@@ -0,0 +1,154 @@
+# Events (事件系统)
+
+- **Summary**: Five 提供了一套基于发布/订阅模式的事件系统，用于监听用户交互、状态变更、数据加载及渲染生命周期。
+- **Schema**: `on` / `once` / `off` 接口定义。
+- **Concepts**: Gesture Events, State Events, Pano Events, Model Events, Lifecycle Events.
+- **Examples**: 监听全景移动、手势交互及状态变更。
+
+## Schema
+
+> **Definition**: [Five](../../five/application/five.d.ts), [EventTypes](../../five/application/events.d.ts)
+
+Five 实例提供了以下方法来管理事件监听：
+
+### on
+注册持久化事件监听器。
+
+```typescript
+five.on(
+  name: string,
+  callback: (...args: any[]) => void,
+  once?: boolean
+): () => void
+```
+
+- **name**: 事件名称（支持的事件见 Concepts）。
+- **callback**: 事件触发时的回调函数。
+- **once**: (可选) 是否仅执行一次，默认为 `false`。
+- **返回**: 一个函数，调用该函数可取消当前监听。
+
+### once
+注册一次性事件监听器（触发一次后自动销毁）。
+
+```typescript
+five.once(
+  name: string,
+  callback: (...args: any[]) => void
+): () => void
+```
+
+### off
+取消事件监听。
+
+```typescript
+five.off(
+  name?: string,
+  callback?: (...args: any[]) => void
+): void
+```
+
+- **name**: (可选) 若不传，则清空所有事件；若传，则取消指定类型的事件。
+- **callback**: (可选) 若传，则仅取消该特定的回调函数；若不传，则取消该类型下的所有回调。
+
+## Concepts
+
+Five 的事件系统将事件主要分为以下几类：
+
+### Gesture Events (交互手势)
+监听用户的鼠标或触摸操作。
+
+- `gesture.tap`: 点击/轻触。
+- `gesture.dbltap`: 双击/双击轻触。
+- `gesture.press`: 长按。
+- `gesture.pan`: 平移/拖拽。
+- `gesture.pinch`: 缩放（双指或滚轮）。
+- `gesture.mousewheel`: 鼠标滚轮滚动。
+- `gesture.mousemove`: 鼠标移动。
+
+### Pano Events (全景导航)
+监听全景图的点位切换过程。
+
+- `pano.arrived`: 成功到达新点位（移动动画结束）。
+- `pano.moving`: 正在移动到新点位（动画进行中）。
+- `pano.willChange`: 即将发生点位变更（旧版兼容）。
+- `pano.error`: 点位加载或移动出错。
+
+### State Events (状态变更)
+监听 Five 内部状态（State）的变化，常用于 UI 同步或数据记录。
+
+- `state.change`: 状态发生变更（可能是用户操作或代码触发）。
+- `currentState.change`: 当前状态发生变更（通常指即时状态）。
+- `state.synced`: 状态已同步。
+
+### Model & Work Events (数据加载)
+监听场景数据（Work）或模型（Model）的加载生命周期。
+
+- `works.load`: Work 数据开始加载。
+- `works.ready`: Work 数据加载完成且 Controller 就绪。
+- `model.load`: 模型开始加载。
+- `models.load`: 所有模型加载完成。
+
+### Render Events (渲染循环)
+监听每一帧的渲染过程。
+
+- `render`: 每一帧渲染后触发。
+- `render.prepare`: 每一帧渲染前触发。
+
+## Examples
+
+### 快速上手 (Quick Example)
+监听点击事件并打印日志。
+
+```typescript
+import { Five } from "@realsee/five";
+
+const five = new Five();
+
+// 监听点击事件
+five.on("gesture.tap", (pose) => {
+  console.log("User tapped at:", pose);
+});
+
+// 监听点位变更完成
+five.on("pano.arrived", (index) => {
+  console.log("Arrived at pano index:", index);
+});
+```
+
+### 进阶用法 (Advanced Usage)
+使用 `once` 监听一次性初始化事件，使用返回值取消监听。
+
+```typescript
+// 1. 等待首次数据加载完成
+five.once("works.ready", () => {
+  console.log("Five is ready!");
+  // 执行初始化逻辑，如自动巡游
+});
+
+// 2. 动态绑定与解绑
+const onRender = () => {
+  // 每一帧执行的逻辑
+  updateUI();
+};
+
+// 开始监听
+five.on("render", onRender);
+
+// 在某个时刻取消监听（例如组件销毁时）
+// five.off("render", onRender);
+```
+
+## Debugging
+
+- 使用 `five.on("error", (err) => console.error(err))` 捕获全局错误。
+
+## Related
+
+- [state.md](./state.md): 了解 State 的结构与变更机制。
+- [five.md](./five.md): Five 核心类说明。
+
+---
+
+```yaml
+tags: [events, interaction, lifecycle, gesture, state]
+```