# Five SDK Documentation Index

> Five is a 3D space rendering SDK by Realsee. This index is optimized for AI agents to locate relevant documentation.

** Documentation for @realsee/five is located in the `ai_guides/` directory. Do NOT use docs/ **

> **Quick Lookup:** For API signatures, go directly to **[ai_guides/api.md](ai_guides/api.md)**. For terminology, see **[ai_guides/glossary.md](ai_guides/glossary.md)**.

> **Keyword Search Tip:** Each doc in `ai_guides/features/` has a `tags` yaml block at the bottom with Chinese and English keywords. Use these for keyword matching when the scenario table below doesn't cover your need.

> **Full Documentation Map:** For a categorized index with development strategies and architecture guidance, see **[ai_guides/README.md](ai_guides/README.md)**.

## Context & Guidelines

*   **[AI Documentation Guidelines](ai_guides/ai-doc-guidelines.md)**: RULES for writing and updating documentation. **Only read this when maintaining or writing docs, NOT when developing applications.**
*   **[Intro](ai_guides/intro.md)**: High-level overview of Five SDK capabilities.
*   **[Glossary](ai_guides/glossary.md)**: Terminology definitions — READ THIS to understand core concepts (Observer, Pose, Mode, Work, PanoIndex, etc.) before writing code.

## Development Strategies

### Initialization
*   **[Quick Start](ai_guides/quick-start.md)**: Minimal setup guide.
*   **[Parameter](ai_guides/features/parameter.md)**: Configuration for `new Five(config)`.

### Data Handling
*   **[Panorama UV](ai_guides/features/pano-uv.md)**: 全景图 UV 与空间方向转换工具
*   **[Work](ai_guides/features/work.md)**: Understanding the core data structure (VR data).
*   **[Load External Model](ai_guides/features/load-external-model.md)**: Loading GLTF/OBJ/etc.
*   **[Load Progress](ai_guides/features/load-progress.md)**: Monitoring loading status (Loaded vs Refined).
*   **[Multi-Work](ai_guides/features/multi-work.md)**: Handling multiple works (Sandbox mode).
*   **[Request Proxy](ai_guides/features/request-proxy.md)**: Intercepting/modifying requests (Auth/CDN).
*   **[Image Options](ai_guides/features/image-options.md)**: Configuring image resources.

### State & Core Concepts
*   **[State](ai_guides/features/state.md)**: CRITICAL for saving/restoring scenes (Pose, Mode, PanoIndex).
*   **[Five](ai_guides/features/five.md)**: The main renderer class.
*   **[Mode](ai_guides/features/mode.md)**: Viewing modes (Panorama, Model, Floorplan, etc.).
*   **[Coordinate System](ai_guides/features/coordinate-system.md)**: Coordinate system definitions.

### Interaction & Animation
*   **[Event](ai_guides/features/event.md)**: Tap, Gesture, and StateChange events.
*   **[Camera Animation](ai_guides/features/camera-animation.md)**: Controlling camera movement.
*   **[Move Pano Effect](ai_guides/features/move-pano-effect.md)**: Transitions between panorama points.
*   **[Raycast](ai_guides/features/raycast.md)**: Object picking/interaction.
*   **[Screen Project](ai_guides/features/screen-project.md)**: 3D to 2D coordinate conversion (for tags/labels).
*   **[Gesture](ai_guides/features/gesture.md)**: Gesture details.

### Rendering & Visuals
*   **[Pano Tile](ai_guides/features/pano-tile.md)**: Panorama tiling mechanism.
*   **[Pano Filter](ai_guides/features/pano-filter.md)**: Color/Tone adjustments for panoramas.
*   **[Model](ai_guides/features/model.md)**: Built-in model rendering.
*   **[Material](ai_guides/features/material.md)**: Material parameters (Opacity, PointScale, VertexMarks).
*   **[Postprocessing](ai_guides/features/postprocessing.md)**: Visual effects.
*   **[Flowing Light 2D Pass](ai_guides/features/flowing-light-2d-pass.md)**: Flowing light screen-space effect with InstancedMesh rendering.
*   **[Flowing Light 3D Pass](ai_guides/features/flowing-light-3d-pass.md)**: Flowing light effect with 3D world-space projection and InstancedMesh rendering.
*   **[Gaussian Blur Pass](ai_guides/features/gaussian-blur-pass.md)**: Gaussian blur post-processing effect.
*   **[Clipper](ai_guides/features/clipper.md)**: Model clipping.
*   **[3D Tile](ai_guides/features/3dtile.md)**: Large scene 3D tiles.
*   **[Get Screen Pixels](ai_guides/features/get-screen-pixels.md)**: Screen capture/magnifier.

## References

*   **[API Reference](ai_guides/api.md)**: Comprehensive API signature index.
*   **[Glossary](ai_guides/glossary.md)**: Terminology definitions (Observer, Pose, etc.).
*   **[Plugin](ai_guides/features/plugin.md)**: Plugin development guide.
*   **[ViewLayer](ai_guides/features/view-layer.md)**: ViewLayer documentation.
*   **[Support](ai_guides/support.md)**: Browser compatibility.

## Common Scenarios (场景 → 文档速查)

> Use the `tags` column for keyword matching when your requirement doesn't exactly match the scenario description.

| Scenario | Docs | Tags |
| :--- | :--- | :--- |
| 点击拾取物体 / Object picking | [Raycast](ai_guides/features/raycast.md) | click, hit-test, floor-detection, 碰撞检测, 物体选择 |
| 3D 标签 / HTML overlay on 3D point | [Screen Project](ai_guides/features/screen-project.md) | label, HUD, tooltip, 坐标转换, 3D转2D |
| 全景滤镜 / 色温调节 / Color correction | [Pano Filter](ai_guides/features/pano-filter.md) | warm, cool, brightness, contrast, saturation, 暖色, 冷色, 饱和度 |
| 加载外部 GLTF/OBJ/FBX 模型 | [Load External Model](ai_guides/features/load-external-model.md) | gltf, glb, ply, splat, fbx, draco, point-cloud, dispose |
| 相机巡航 / 自动导览 / Camera fly-through | [Camera Animation](ai_guides/features/camera-animation.md) | rotate, zoom, auto-tour, 运镜, 旋转, 缩放 |
| 截图 / 放大镜 / Screen capture | [Get Screen Pixels](ai_guides/features/get-screen-pixels.md) | magnifier, screenshot, color-picker, 取色器 |
| 模型裁切 / 房屋剖面 | [Clipper](ai_guides/features/clipper.md) | clipping-box, section-view, discard, 开盖, 剖面 |
| 流光特效 / Flowing light effect | [Flowing Light 2D](ai_guides/features/flowing-light-2d-pass.md), [Flowing Light 3D](ai_guides/features/flowing-light-3d-pass.md) | 光带, 导航路径, 动态路径, instanced |
| 模糊特效 / Blur effect | [Gaussian Blur Pass](ai_guides/features/gaussian-blur-pass.md) | 毛玻璃, 背景虚化, gaussian |
| 保存/恢复场景状态 | [State](ai_guides/features/state.md) | snapshot, save, restore, 快照, 场景还原 |
| 多场景切换 / 沙盘 | [Multi-Work](ai_guides/features/multi-work.md) | sandbox, 多户型, 拼接, workCode |
| 请求鉴权 / CDN 替换 | [Request Proxy](ai_guides/features/request-proxy.md) | authentication, token, url-rewrite, cors, 私有化 |
| 插件开发 | [Plugin](ai_guides/features/plugin.md) | lifecycle, extension, baseplugin, 状态管理 |
| 事件监听 / 拦截默认行为 | [Event](ai_guides/features/event.md) | preventDefault, waitUntil, on, off, gesture, 回调 |
| 手势交互 / 自定义拖拽 | [Gesture](ai_guides/features/gesture.md) | tap, pan, pinch, press, 触摸, 鼠标 |
| 后处理特效 / 自定义 Shader | [Postprocessing](ai_guides/features/postprocessing.md) | effect-composer, addPass, edl, 描边, 景深 |
| 材质 / 透明度 / 点云样式 | [Material](ai_guides/features/material.md) | opacity, pointcloud, roof, ceiling, 天花板, 顶点标记 |
| 模式切换 / 全景↔模型↔户型图 | [Mode](ai_guides/features/mode.md) | panorama, floorplan, mapview, topview, VR |
| 全景高清瓦片 / 分片加载 | [Pano Tile](ai_guides/features/pano-tile.md) | LOD, tile, 按需加载, 高清全景 |
| 图片 CDN / 私有化部署 | [Image Options](ai_guides/features/image-options.md) | avif, webp, cdn, private-deployment |
| 加载进度 / 首屏优化 | [Load Progress](ai_guides/features/load-progress.md) | refined, loaded, loading-bar, 首屏 |

## Release Notes
*   [6.8](ai_guides/release_notes/6.8.md)
*   [6.7](ai_guides/release_notes/6.7.md)
*   [6.6](ai_guides/release_notes/6.6.md)

