UNPKG

@realsee/five

Version:

Realsee Renderer SDK

266 lines (264 loc) • 25.4 kB
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>README | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">README</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="five-sdk-documentation" class="tsd-anchor-link">Five SDK Documentation<a href="#five-sdk-documentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1> <p><a href="https://www.npmjs.com/package/@realsee/five"><img src="https://img.shields.io/npm/v/@realsee/five.svg?style=flat-square&amp;logo=npm&amp;label=npm%20install%20@realsee/five" alt="npm version"></a></p> <ul> <li><strong>Summary</strong>: Five SDK 的文档索引与阅读指南,旨在帮助开发者与 AI 助手快速定位所需信息。</li> <li><strong>Audience</strong>: 开发者、AI 辅助编程工具。</li> </ul> <h2 id="context-for-ai-agents" class="tsd-anchor-link">Context for AI Agents<a href="#context-for-ai-agents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2> <p><strong>Five</strong> 是贝壳如视 (Realsee) 提供的三维空间渲染 SDK。</p> <h3 id="1-documentation-maintenance-文档维护" class="tsd-anchor-link">1. Documentation Maintenance (文档维护)<a href="#1-documentation-maintenance-文档维护" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3> <div class="tsd-alert tsd-alert-important"><div class="tsd-alert-title"><svg width="16" height="16" viewBox="0 0 16 16" aria-hidden="true"><use href="../assets/icons.svg#icon-alertImportant"></use></svg><span>Important</span></div><p> Before writing or updating any documentation, YOU MUST READ <a href="ai-doc-guidelines.html">AI Documentation Guidelines</a>. 在书写文档时,务必遵循 <a href="ai-doc-guidelines.html">AI Documentation Guidelines</a> 中的规范。</p> </div> <h3 id="2-application-development-strategy-应用开发建议" class="tsd-anchor-link">2. Application Development Strategy (应用开发建议)<a href="#2-application-development-strategy-应用开发建议" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3> <p>当协助用户编写代码或构建 Five 应用时,请遵循以下阅读与检索策略:</p> <ul> <li><strong>Initialization (初始化)</strong>: <ul> <li>阅读 <a href="quick-start.html">Quick Start</a> 掌握最小化启动流程。</li> <li>查阅 <a href="features_parameter.html">Parameter</a> 获取 <code>new Five(config)</code> 的完整配置项(如 canvas 尺寸、资源路径、纹理压缩设置)。</li> </ul> </li> <li><strong>Data Handling (数据加载)</strong>: <ul> <li>核心 VR 数据:深入理解 <a href="features_work.html">Work</a> 结构,它是 Five 渲染的基础。</li> <li>外部模型:参考 <a href="features_load-external-model.html">Load External Model</a> 加载 GLTF/OBJ 等格式。</li> <li>多场景/沙盘:参考 <a href="features_multi-work.html">Multi-Work (Sandbox)</a> 处理复杂场景切换。</li> </ul> </li> <li><strong>Interaction &amp; Logic (交互逻辑)</strong>: <ul> <li>事件监听:查阅 <a href="features_event.html">Event</a> 处理用户点击 (Tap)、手势 (Gesture) 及状态变更 (StateChange)。</li> <li>空间操作:使用 <a href="features_raycast.html">Raycast</a> 实现物体拾取,使用 <a href="features_screen-project.html">Screen &amp; Space Projection</a> 实现 3D 标签挂载。</li> <li>动画控制:参考 <a href="features_camera-animation.html">Camera Animation</a> 和 <a href="features_move-pano-effect.html">Move Pano Effect</a> 实现平滑运镜。</li> </ul> </li> <li><strong>State Management (状态管理)</strong>: <ul> <li>保存/恢复场景:<strong>必须</strong> 深刻理解 <a href="features_state.html">State</a>。它是 Five 的核心快照机制,包含 Pose、Mode 和 PanoIndex。不要尝试手动管理零散的相机参数,应统一使用 State。</li> </ul> </li> <li><strong>Coding Standards (代码规范)</strong>: <ul> <li>优先使用 TypeScript 类型提示。</li> <li>确保从 <code>@realsee/five</code> 导入核心类与类型 (e.g., <code>import { Five, Mode, Work, State } from &quot;@realsee/five&quot;</code>).</li> </ul> </li> </ul> <h3 id="3-general-retrieval-通用检索" class="tsd-anchor-link">3. General Retrieval (通用检索)<a href="#3-general-retrieval-通用检索" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3> <ul> <li><strong>API Signatures</strong>: <a href="api.html">API Reference</a> 是最权威的接口定义来源,包含方法的参数与返回值。</li> <li><strong>Terminology</strong>: 遇到不确定的术语 (e.g., Pose vs State, Observer) 时,务必查阅 <a href="glossary.html">Glossary</a>。</li> <li><strong>Core Relationships</strong>: 理解 <a href="features_five.html">Five</a> (渲染器) 与 <a href="features_work.html">Work</a> (数据) 的分离设计。</li> </ul> <h2 id="documentation-map" class="tsd-anchor-link">Documentation Map<a href="#documentation-map" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2> <h3 id="1-essential-reference-必读速查" class="tsd-anchor-link">1. Essential Reference (必读/速查)<a href="#1-essential-reference-必读速查" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3> <p>最常用的入口文档。</p> <ul> <li><a href="intro.html">Intro</a>: Five SDK 简介与能力概览。</li> <li><a href="quick-start.html">Quick Start</a>: 快速集成指南。</li> <li><a href="api.html">API Reference</a>: <strong>核心 API 索引</strong> (Five 类, State, Events, Methods)。</li> <li><a href="glossary.html">Glossary</a>: <strong>术语表</strong> (Work, Observer, Pose, etc.)。</li> </ul> <h3 id="2-core-concepts-核心概念" class="tsd-anchor-link">2. Core Concepts (核心概念)<a href="#2-core-concepts-核心概念" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3> <p>基础架构与生命周期管理。</p> <ul> <li><a href="features_five.html">Five</a>: 核心类 <code>Five</code>,管理渲染循环与全局状态。</li> <li><a href="features_work.html">Work</a>: 数据载体,描述三维空间的数据结构 (VR 看房数据)。</li> <li><a href="features_pano-uv.html">Panorama UV</a>: 全景图 UV 与空间方向转换工具。</li> <li><a href="features_mode.html">Mode</a>: 五种核心浏览模式 (Panorama, Floorplan, Topview, Model, Map)。</li> <li><a href="features_state.html">State</a>: 状态管理 (Pose, Mode, PanoIndex),用于复原场景。</li> <li><a href="features_coordinate-system.html">Coordinate System</a>: 坐标系定义 (右手坐标系, Y轴向上)。</li> </ul> <h3 id="3-data-resource-数据与资源" class="tsd-anchor-link">3. Data &amp; Resource (数据与资源)<a href="#3-data-resource-数据与资源" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3> <p>数据加载与资源管理配置。</p> <ul> <li><a href="features_load-external-model.html">Load External Model</a>: 加载外部 3D 模型 (GLTF, OBJ 等)。</li> <li><a href="features_load-progress.html">Load Progress</a>: 监控模型与全景图的加载进度 (Loaded/Refined)。</li> <li><a href="features_multi-work.html">Multi-Work (Sandbox)</a>: 多 Work 加载与沙盘场景管理。</li> <li><a href="features_request-proxy.html">Request Proxy</a>: 请求拦截与代理 (CDN 替换、鉴权)。</li> <li><a href="features_image-options.html">Image Options</a>: 图片资源配置 (CDN, 格式, 尺寸)。</li> </ul> <h3 id="4-rendering-visuals-渲染与视觉" class="tsd-anchor-link">4. Rendering &amp; Visuals (渲染与视觉)<a href="#4-rendering-visuals-渲染与视觉" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3> <p>画面表现与渲染管线配置。</p> <ul> <li><a href="features_pano-tile.html">Pano Tile</a>: 全景瓦片渲染机制(高分辨率分片加载)。</li> <li><a href="features_model.html">Model</a>: 内置模型渲染 (Mesh/Geometry)。</li> <li><a href="features_postprocessing.html">Postprocessing</a>: 后处理效果 (Pass, EffectComposer)。</li> <li><a href="features_flowing-light-2d-pass.html">Flowing Light 2D Pass</a>: 屏幕空间流光特效(InstancedMesh 优化)。</li> <li><a href="features_flowing-light-3d-pass.html">Flowing Light 3D Pass</a>: 3D 世界坐标流光特效(InstancedMesh 优化)。</li> <li><a href="features_flowing-fireworks-3d-pass.html">Flowing Fireworks 3D Pass</a>: 流光尾部喷射的烟花粒子特效(GPU 粒子)。</li> <li><a href="features_gaussian-blur-pass.html">Gaussian Blur Pass</a>: 高斯模糊特效。</li> <li><a href="features_material.html">Material</a>: 材质参数配置 (透明度、点云大小、顶点标记)。</li> <li><a href="features_pano-filter.html">Pano Filter</a>: 全景图滤镜 (亮度、对比度、色温调节)。</li> <li><a href="features_get-screen-pixels.html">Get Screen Pixels</a>: 获取屏幕像素 (放大镜/截图)。</li> <li><a href="features_move-pano-effect.html">Move Pano Effect</a>: 全景点位切换的过渡效果。</li> <li><a href="features_clipper.html">Clipper</a>: 模型裁切功能 (房屋剖面)。</li> <li><a href="features_3dtile.html">3D Tile</a>: 大场景 3D Tile 渲染策略。</li> </ul> <h3 id="5-interaction-control-交互与控制" class="tsd-anchor-link">5. Interaction &amp; Control (交互与控制)<a href="#5-interaction-control-交互与控制" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3> <p>用户输入与相机控制。</p> <ul> <li><a href="features_event.html">Event</a>: 事件系统 (Tap, Gesture, StateChange)。</li> <li><a href="features_gesture.html">Gesture</a>: 手势交互详解。</li> <li><a href="features_screen-project.html">Screen &amp; Space Projection</a>: 屏幕坐标与空间坐标转换 (标签/射线)。</li> <li><a href="features_raycast.html">Raycast</a>: 射线检测 (点击拾取物体)。</li> <li><a href="features_camera-animation.html">Camera Animation</a>: 相机动画控制 API。</li> </ul> <h3 id="6-advanced-extensions-进阶与扩展" class="tsd-anchor-link">6. Advanced &amp; Extensions (进阶与扩展)<a href="#6-advanced-extensions-进阶与扩展" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3> <p>复杂配置与功能扩展。</p> <ul> <li><a href="features_plugin.html">Plugin</a>: 插件开发指南。</li> <li><a href="features_view-layer.html">ViewLayer</a>: 视图层。</li> <li><a href="features_parameter.html">Parameter</a>: Five 初始化详细参数配置。</li> </ul> <h3 id="7-meta-support-其他" class="tsd-anchor-link">7. Meta &amp; Support (其他)<a href="#7-meta-support-其他" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3> <ul> <li><a href="support.html">Support</a>: 浏览器兼容性。</li> <li><a href="ai-doc-guidelines.html">AI Documentation Guidelines</a>: AI 文档编写与维护规范 (必读)。</li> <li>Release Notes: 版本更新记录。 <ul> <li><a href="release_notes_6.8.html">6.8</a></li> <li><a href="release_notes_6.7.html">6.7</a></li> <li><a href="release_notes_6.6.html">6.6</a></li> </ul> </li> </ul> <h2 id="common-scenarios-场景-→-文档速查" class="tsd-anchor-link">Common Scenarios (场景 → 文档速查)<a href="#common-scenarios-场景-→-文档速查" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2> <blockquote> <p><strong>Keyword Search Tip:</strong> Each doc in <code>features/</code> has a <code>tags</code> 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.</p> </blockquote> <table> <thead> <tr> <th style="text-align:left">Scenario</th> <th style="text-align:left">Docs</th> <th style="text-align:left">Tags</th> </tr> </thead> <tbody> <tr> <td style="text-align:left">点击拾取物体 / Object picking</td> <td style="text-align:left"><a href="features_raycast.html">Raycast</a></td> <td style="text-align:left">click, hit-test, floor-detection, 碰撞检测, 物体选择</td> </tr> <tr> <td style="text-align:left">3D 标签 / HTML overlay on 3D point</td> <td style="text-align:left"><a href="features_screen-project.html">Screen Project</a></td> <td style="text-align:left">label, HUD, tooltip, 坐标转换, 3D转2D</td> </tr> <tr> <td style="text-align:left">全景滤镜 / 色温调节 / Color correction</td> <td style="text-align:left"><a href="features_pano-filter.html">Pano Filter</a></td> <td style="text-align:left">warm, cool, brightness, contrast, saturation, 暖色, 冷色, 饱和度</td> </tr> <tr> <td style="text-align:left">加载外部 GLTF/OBJ/FBX 模型</td> <td style="text-align:left"><a href="features_load-external-model.html">Load External Model</a></td> <td style="text-align:left">gltf, glb, ply, splat, fbx, draco, point-cloud, dispose</td> </tr> <tr> <td style="text-align:left">相机巡航 / 自动导览 / Camera fly-through</td> <td style="text-align:left"><a href="features_camera-animation.html">Camera Animation</a></td> <td style="text-align:left">rotate, zoom, auto-tour, 运镜, 旋转, 缩放</td> </tr> <tr> <td style="text-align:left">截图 / 放大镜 / Screen capture</td> <td style="text-align:left"><a href="features_get-screen-pixels.html">Get Screen Pixels</a></td> <td style="text-align:left">magnifier, screenshot, color-picker, 取色器</td> </tr> <tr> <td style="text-align:left">模型裁切 / 房屋剖面</td> <td style="text-align:left"><a href="features_clipper.html">Clipper</a></td> <td style="text-align:left">clipping-box, section-view, discard, 开盖, 剖面</td> </tr> <tr> <td style="text-align:left">流光特效 / Flowing light effect</td> <td style="text-align:left"><a href="features_flowing-light-2d-pass.html">Flowing Light 2D</a>, <a href="features_flowing-light-3d-pass.html">Flowing Light 3D</a></td> <td style="text-align:left">光带, 导航路径, 动态路径, instanced</td> </tr> <tr> <td style="text-align:left">烟花 / 火花 / 流光拖尾粒子 / Fireworks sparks</td> <td style="text-align:left"><a href="features_flowing-fireworks-3d-pass.html">Flowing Fireworks 3D</a></td> <td style="text-align:left">烟花, 火花, 粒子, 发散, 爆裂, fireworks, particle, sparks</td> </tr> <tr> <td style="text-align:left">模糊特效 / Blur effect</td> <td style="text-align:left"><a href="features_gaussian-blur-pass.html">Gaussian Blur Pass</a></td> <td style="text-align:left">毛玻璃, 背景虚化, gaussian</td> </tr> <tr> <td style="text-align:left">保存/恢复场景状态</td> <td style="text-align:left"><a href="features_state.html">State</a></td> <td style="text-align:left">snapshot, save, restore, 快照, 场景还原</td> </tr> <tr> <td style="text-align:left">多场景切换 / 沙盘</td> <td style="text-align:left"><a href="features_multi-work.html">Multi-Work</a></td> <td style="text-align:left">sandbox, 多户型, 拼接, workCode</td> </tr> <tr> <td style="text-align:left">请求鉴权 / CDN 替换</td> <td style="text-align:left"><a href="features_request-proxy.html">Request Proxy</a></td> <td style="text-align:left">authentication, token, url-rewrite, cors, 私有化</td> </tr> <tr> <td style="text-align:left">插件开发</td> <td style="text-align:left"><a href="features_plugin.html">Plugin</a></td> <td style="text-align:left">lifecycle, extension, baseplugin, 状态管理</td> </tr> <tr> <td style="text-align:left">事件监听 / 拦截默认行为</td> <td style="text-align:left"><a href="features_event.html">Event</a></td> <td style="text-align:left">preventDefault, waitUntil, on, off, gesture, 回调</td> </tr> <tr> <td style="text-align:left">手势交互 / 自定义拖拽</td> <td style="text-align:left"><a href="features_gesture.html">Gesture</a></td> <td style="text-align:left">tap, pan, pinch, press, 触摸, 鼠标</td> </tr> <tr> <td style="text-align:left">后处理特效 / 自定义 Shader</td> <td style="text-align:left"><a href="features_postprocessing.html">Postprocessing</a></td> <td style="text-align:left">effect-composer, addPass, edl, 描边, 景深</td> </tr> <tr> <td style="text-align:left">材质 / 透明度 / 点云样式</td> <td style="text-align:left"><a href="features_material.html">Material</a></td> <td style="text-align:left">opacity, pointcloud, roof, ceiling, 天花板, 顶点标记</td> </tr> <tr> <td style="text-align:left">模式切换 / 全景↔模型↔户型图</td> <td style="text-align:left"><a href="features_mode.html">Mode</a></td> <td style="text-align:left">panorama, floorplan, mapview, topview, VR</td> </tr> <tr> <td style="text-align:left">全景高清瓦片 / 分片加载</td> <td style="text-align:left"><a href="features_pano-tile.html">Pano Tile</a></td> <td style="text-align:left">LOD, tile, 按需加载, 高清全景</td> </tr> <tr> <td style="text-align:left">图片 CDN / 私有化部署</td> <td style="text-align:left"><a href="features_image-options.html">Image Options</a></td> <td style="text-align:left">avif, webp, cdn, private-deployment</td> </tr> <tr> <td style="text-align:left">加载进度 / 首屏优化</td> <td style="text-align:left"><a href="features_load-progress.html">Load Progress</a></td> <td style="text-align:left">refined, loaded, loading-bar, 首屏</td> </tr> </tbody> </table> <h2 id="terminology-summary" class="tsd-anchor-link">Terminology Summary<a href="#terminology-summary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2> <ul> <li><strong>Work</strong>: 包含全景图、模型、户型数据的 JSON 对象。</li> <li><strong>Observer</strong>: 观察点,通常对应一个全景拍摄点位。</li> <li><strong>PanoIndex</strong>: 全景点位的索引下标。</li> <li><strong>Pose</strong>: 相机位姿 (Longitude, Latitude, Fov)。</li> <li><strong>Mode</strong>: 浏览模式 (Panorama, Model, etc.)。</li> </ul> <hr> <pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">index</span><span class="hl-1">, </span><span class="hl-2">readme</span><span class="hl-1">, </span><span class="hl-2">guide</span><span class="hl-1">, </span><span class="hl-2">map</span><span class="hl-1">]</span> </code><button type="button">Copy</button></pre> </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#five-sdk-documentation"><span>Five <wbr/>SDK <wbr/>Documentation</span></a><ul><li><a href="#context-for-ai-agents"><span>Context for <wbr/>AI <wbr/>Agents</span></a></li><li><ul><li><a href="#1-documentation-maintenance-文档维护"><span>1. <wbr/>Documentation <wbr/>Maintenance (文档维护)</span></a></li><li><a href="#2-application-development-strategy-应用开发建议"><span>2. <wbr/>Application <wbr/>Development <wbr/>Strategy (应用开发建议)</span></a></li><li><a href="#3-general-retrieval-通用检索"><span>3. <wbr/>General <wbr/>Retrieval (通用检索)</span></a></li></ul></li><li><a href="#documentation-map"><span>Documentation <wbr/>Map</span></a></li><li><ul><li><a href="#1-essential-reference-必读速查"><span>1. <wbr/>Essential <wbr/>Reference (必读/速查)</span></a></li><li><a href="#2-core-concepts-核心概念"><span>2. <wbr/>Core <wbr/>Concepts (核心概念)</span></a></li><li><a href="#3-data-resource-数据与资源"><span>3. <wbr/>Data &amp; <wbr/>Resource (数据与资源)</span></a></li><li><a href="#4-rendering-visuals-渲染与视觉"><span>4. <wbr/>Rendering &amp; <wbr/>Visuals (渲染与视觉)</span></a></li><li><a href="#5-interaction-control-交互与控制"><span>5. <wbr/>Interaction &amp; <wbr/>Control (交互与控制)</span></a></li><li><a href="#6-advanced-extensions-进阶与扩展"><span>6. <wbr/>Advanced &amp; <wbr/>Extensions (进阶与扩展)</span></a></li><li><a href="#7-meta-support-其他"><span>7. <wbr/>Meta &amp; <wbr/>Support (其他)</span></a></li></ul></li><li><a href="#common-scenarios-场景-→-文档速查"><span>Common <wbr/>Scenarios (场景 → 文档速查)</span></a></li><li><a href="#terminology-summary"><span>Terminology <wbr/>Summary</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>