@realsee/five 6.8.0-alpha.9 → 6.8.1

package/docs/documents/features_coordinate-system.html

@@ -20,6 +20,52 @@
 </code><button type="button">Copy</button></pre>
 
 <h2 id="concepts" class="tsd-anchor-link">Concepts<a href="#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></h2>
+<h3 id="overview-坐标系总览" class="tsd-anchor-link">Overview (坐标系总览)<a href="#overview-坐标系总览" 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 中涉及多个坐标系，它们在不同场景下各有用途。理解它们的关系是正确使用 Five 的关键。</p>
+<table>
+<thead>
+<tr>
+<th style="text-align:left">坐标系</th>
+<th style="text-align:left">上轴</th>
+<th style="text-align:left">适用场景</th>
+<th style="text-align:left">说明</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td style="text-align:left"><strong>Local (Y-up)</strong></td>
+<td style="text-align:left">Y</td>
+<td style="text-align:left">渲染场景、前端开发</td>
+<td style="text-align:left">Five 的 <code>five.scene</code>、Observer 位置、<code>project2d</code> 等均使用此坐标系。与 Three.js 默认一致。</td>
+</tr>
+<tr>
+<td style="text-align:left"><strong>ENU (Z-up)</strong></td>
+<td style="text-align:left">Z</td>
+<td style="text-align:left">算法交互、后端接口、模型原始数据</td>
+<td style="text-align:left">测绘行业习惯。3D Tiles 数据源、<code>loadGltf</code> 等加载器默认输出 Z-up。</td>
+</tr>
+<tr>
+<td style="text-align:left"><strong>ECEF</strong></td>
+<td style="text-align:left">-</td>
+<td style="text-align:left">RTK 定位、地球坐标</td>
+<td style="text-align:left">地心地固坐标系，用于包含 RTK 信息的模型。</td>
+</tr>
+<tr>
+<td style="text-align:left"><strong>World</strong></td>
+<td style="text-align:left">Y</td>
+<td style="text-align:left">Three.js 世界坐标</td>
+<td style="text-align:left">通常等同于 Local，除非有 Object3D 层级嵌套偏移。</td>
+</tr>
+</tbody>
+</table>
+<blockquote>
+<p><strong>关键区分</strong>：</p>
+<ul>
+<li><strong>开发者在 <code>five.scene</code> 中操作的所有对象</strong>（添加标签、射线检测结果、<code>project2d</code> 输入等）都处于 <strong>Local (Y-up)</strong> 坐标系。</li>
+<li><strong>模型数据源</strong>（3D Tiles、PLY、GLTF 等文件）通常以 <strong>ENU (Z-up)</strong> 存储。Five 在加载时会自动将其旋转对齐到 Local (Y-up)。</li>
+<li><strong>与后端/算法交互</strong>时，推荐使用 <strong>ENU (Z-up)</strong> 坐标系传输数据，通过 <code>viewLayer.localToEnu()</code> / <code>viewLayer.enuToLocal()</code> 进行转换。</li>
+</ul>
+</blockquote>
 <h3 id="local-coordinate-system-y-up" class="tsd-anchor-link">Local Coordinate System (Y-up)<a href="#local-coordinate-system-y-up" 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 的渲染场景 (<code>five.scene</code>) 和 Observers (观察点) 使用 <strong>Y-up</strong> (Y 轴向上) 的右手坐标系。
 这与 Three.js 的默认坐标系一致，便于前端开发和场景渲染。</p>
@@ -52,6 +98,9 @@
 </ul>
 </li>
 </ol>
+<blockquote>
+<p><strong>注意</strong>: 外部模型加载函数（如 <code>loadGltf</code>, <code>loadPly</code> 等）的 <code>upAxis</code> 参数默认为 <code>'Z'</code>，表示输出的模型以 Z-up 存储。这是因为这些函数返回的是<strong>原始模型对象</strong>，尚未经过 Five 的自动对齐。当你通过 <code>five.load(work)</code> 加载 Work 数据时，Five 会自动完成 Z-up → Y-up 的转换。如果你手动使用 <code>loadGltf</code> 并添加到 <code>five.scene</code>，需要自行处理坐标系旋转。详见 <a href="features_load-external-model.html">Load External Model</a>。</p>
+</blockquote>
 <h3 id="coordinate-in-files" class="tsd-anchor-link">Coordinate in Files<a href="#coordinate-in-files" 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>在 3D Tiles 的 <code>tileset.json</code> 中，<code>rootMeta</code> 字段用于描述坐标系转换信息（没有该字段则默认 Z-up）：</p>
 <ul>
@@ -118,10 +167,10 @@
 
 <h2 id="related" class="tsd-anchor-link">Related<a href="#related" 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><a href="features_load-external-model.html">load-external-model.md</a>: 加载外部模型时的坐标轴配置 (<code>upAxis</code>, <code>modelUpAxis</code>)。</li>
+<li><a href="features_load-external-model.html">Load External Model</a>: 加载外部模型时的坐标轴配置 (<code>upAxis</code>, <code>modelUpAxis</code>)。</li>
 </ul>
 <hr>
-<pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">coordinate-system</span><span class="hl-1">, </span><span class="hl-2">enu</span><span class="hl-1">, </span><span class="hl-2">ecef</span><span class="hl-1">, </span><span class="hl-2">z-up</span><span class="hl-1">, </span><span class="hl-2">y-up</span><span class="hl-1">, </span><span class="hl-2">transform</span><span class="hl-1">]</span>
+<pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">坐标系</span><span class="hl-1">, </span><span class="hl-2">坐标转换</span><span class="hl-1">, </span><span class="hl-2">右手坐标系</span><span class="hl-1">, </span><span class="hl-2">模型方向</span><span class="hl-1">, </span><span class="hl-2">旋转</span><span class="hl-1">, </span><span class="hl-2">地理坐标</span><span class="hl-1">, </span><span class="hl-2">coordinate-system</span><span class="hl-1">, </span><span class="hl-2">enu</span><span class="hl-1">, </span><span class="hl-2">ecef</span><span class="hl-1">, </span><span class="hl-2">z-up</span><span class="hl-1">, </span><span class="hl-2">y-up</span><span class="hl-1">, </span><span class="hl-2">transform</span><span class="hl-1">, </span><span class="hl-2">local</span><span class="hl-1">, </span><span class="hl-2">world</span><span class="hl-1">, </span><span class="hl-2">rtk</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="#坐标系-coordinate-system"><span>坐标系 (<wbr/>Coordinate <wbr/>System)</span></a><ul><li><a href="#schema"><span>Schema</span></a></li><li><ul><li><a href="#rootmeta"><span>Root<wbr/>Meta</span></a></li><li><a href="#coordinate"><span>Coordinate</span></a></li></ul></li><li><a href="#concepts"><span>Concepts</span></a></li><li><ul><li><a href="#local-coordinate-system-y-up"><span>Local <wbr/>Coordinate <wbr/>System (<wbr/>Y-<wbr/>up)</span></a></li><li><a href="#enu-coordinate-system-z-up"><span>ENU <wbr/>Coordinate <wbr/>System (<wbr/>Z-<wbr/>up)</span></a></li><li><a href="#ecef-coordinate-system"><span>ECEF <wbr/>Coordinate <wbr/>System</span></a></li><li><a href="#model-orientation-at3d-3dtiles"><span>Model <wbr/>Orientation (at3d / 3dtiles)</span></a></li><li><a href="#coordinate-in-files"><span>Coordinate in <wbr/>Files</span></a></li></ul></li><li><a href="#instance-methods"><span>Instance <wbr/>Methods</span></a></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#坐标转换-coordinate-transformation"><span>坐标转换 (<wbr/>Coordinate <wbr/>Transformation)</span></a></li></ul></li><li><a href="#related"><span>Related</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>
+</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="#坐标系-coordinate-system"><span>坐标系 (<wbr/>Coordinate <wbr/>System)</span></a><ul><li><a href="#schema"><span>Schema</span></a></li><li><ul><li><a href="#rootmeta"><span>Root<wbr/>Meta</span></a></li><li><a href="#coordinate"><span>Coordinate</span></a></li></ul></li><li><a href="#concepts"><span>Concepts</span></a></li><li><ul><li><a href="#overview-坐标系总览"><span>Overview (坐标系总览)</span></a></li><li><a href="#local-coordinate-system-y-up"><span>Local <wbr/>Coordinate <wbr/>System (<wbr/>Y-<wbr/>up)</span></a></li><li><a href="#enu-coordinate-system-z-up"><span>ENU <wbr/>Coordinate <wbr/>System (<wbr/>Z-<wbr/>up)</span></a></li><li><a href="#ecef-coordinate-system"><span>ECEF <wbr/>Coordinate <wbr/>System</span></a></li><li><a href="#model-orientation-at3d-3dtiles"><span>Model <wbr/>Orientation (at3d / 3dtiles)</span></a></li><li><a href="#coordinate-in-files"><span>Coordinate in <wbr/>Files</span></a></li></ul></li><li><a href="#instance-methods"><span>Instance <wbr/>Methods</span></a></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#坐标转换-coordinate-transformation"><span>坐标转换 (<wbr/>Coordinate <wbr/>Transformation)</span></a></li></ul></li><li><a href="#related"><span>Related</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>

package/docs/documents/features_event.html

@@ -1,9 +1,9 @@
 <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>features/event | 如视 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">features/event</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="events-事件系统" class="tsd-anchor-link">Events (事件系统)<a href="#events-事件系统" 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>
 <ul>
 <li><strong>Summary</strong>: Five 提供了一套基于发布/订阅模式的事件系统，用于监听用户交互、状态变更、数据加载及渲染生命周期。</li>
-<li><strong>Schema</strong>: <code>on</code> / <code>once</code> / <code>off</code> 接口定义。</li>
-<li><strong>Concepts</strong>: Gesture Events, State Events, Pano Events, Model Events, Lifecycle Events.</li>
-<li><strong>Examples</strong>: 监听全景移动、手势交互及状态变更。</li>
+<li><strong>Schema</strong>: <code>on</code> / <code>once</code> / <code>off</code> 接口定义；<code>BaseEvent</code> / <code>BaseExtendableEvent</code> 事件对象。</li>
+<li><strong>Concepts</strong>: Event 对象（<code>preventDefault</code> / <code>waitUntil</code>）、Gesture Events, State Events, Pano Events, Model Events, Lifecycle Events.</li>
+<li><strong>Examples</strong>: 监听全景移动、手势交互及状态变更；使用 <code>preventDefault</code> 拦截默认行为；使用 <code>waitUntil</code> 延迟点位切换。</li>
 </ul>
 <h2 id="schema" class="tsd-anchor-link">Schema<a href="#schema" 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>
@@ -35,6 +35,41 @@
 <li><strong>name</strong>: (可选) 若不传，则清空所有事件；若传，则取消指定类型的事件。</li>
 <li><strong>callback</strong>: (可选) 若传，则仅取消该特定的回调函数；若不传，则取消该类型下的所有回调。</li>
 </ul>
+<h2 id="event-对象" class="tsd-anchor-link">Event 对象<a href="#event-对象" 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>Definition</strong>: <a href="../../five/utils/event.d.ts">BaseEvent / BaseExtendableEvent</a></p>
+</blockquote>
+<p>Five 中所有事件回调的参数都是一个 Event 对象，分为两种基础类型：</p>
+<h3 id="baseevent" class="tsd-anchor-link">BaseEvent<a href="#baseevent" 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>
+<pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">BaseEvent</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-8">/** 事件类型名称 */</span><br/><span class="hl-1">  </span><span class="hl-6">type</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">;</span><br/><span class="hl-1">  </span><span class="hl-8">/** 事件触发时的时间戳 */</span><br/><span class="hl-1">  </span><span class="hl-6">timeStamp</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1">  </span><span class="hl-8">/** 阻止事件的默认行为 */</span><br/><span class="hl-1">  </span><span class="hl-5">preventDefault</span><span class="hl-1">(): </span><span class="hl-7">void</span><span class="hl-1">;</span><br/><span class="hl-1">  </span><span class="hl-8">/** 是否已调用过 preventDefault */</span><br/><span class="hl-1">  </span><span class="hl-3">readonly</span><span class="hl-1"> </span><span class="hl-6">defaultPrevented</span><span class="hl-1">: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
+</code><button type="button">Copy</button></pre>
+
+<h3 id="baseextendableevent" class="tsd-anchor-link">BaseExtendableEvent<a href="#baseextendableevent" 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>继承自 <code>BaseEvent</code>，额外提供 <code>waitUntil</code> 方法，用于在事件处理中插入异步等待逻辑：</p>
+<pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">BaseExtendableEvent</span><span class="hl-1"> </span><span class="hl-3">extends</span><span class="hl-1"> </span><span class="hl-7">BaseEvent</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-5">waitUntil</span><span class="hl-1">(</span><span class="hl-6">f</span><span class="hl-1">: </span><span class="hl-7">Promise</span><span class="hl-1">&lt;</span><span class="hl-7">any</span><span class="hl-1">&gt;): </span><span class="hl-7">void</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
+</code><button type="button">Copy</button></pre>
+
+<p>目前 <code>pano.prepare</code> 事件使用 <code>BaseExtendableEvent</code>（对应 <code>PanoPrepareEvent</code>），其余事件均基于 <code>BaseEvent</code>。</p>
+<h3 id="preventdefault" class="tsd-anchor-link">preventDefault<a href="#preventdefault" 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>调用 <code>event.preventDefault()</code> 可以阻止事件的默认行为。Five 内部会在触发事件后检查 <code>event.defaultPrevented</code>，若为 <code>true</code> 则跳过后续的默认处理逻辑。</p>
+<p>比如：</p>
+<ul>
+<li><code>gesture.tap</code>：阻止默认的点位跳转或相机弹跳动画。</li>
+<li><code>intersect.update</code>：阻止默认的交互高亮行为。</li>
+</ul>
+<pre><code class="typescript"><span class="hl-8">// 示例：阻止点击时的默认点位跳转</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&quot;gesture.tap&quot;</span><span class="hl-1">, (</span><span class="hl-6">event</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-10">if</span><span class="hl-1"> (</span><span class="hl-5">shouldBlockNavigation</span><span class="hl-1">()) {</span><br/><span class="hl-1">    </span><span class="hl-6">event</span><span class="hl-1">.</span><span class="hl-5">preventDefault</span><span class="hl-1">();</span><br/><span class="hl-1">    </span><span class="hl-8">// 执行自定义逻辑</span><br/><span class="hl-1">    </span><span class="hl-5">showCustomMenu</span><span class="hl-1">(</span><span class="hl-6">event</span><span class="hl-1">);</span><br/><span class="hl-1">  }</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-8">// 示例：阻止拖拽时的默认相机旋转</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&quot;gesture.pan&quot;</span><span class="hl-1">, (</span><span class="hl-6">event</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-6">event</span><span class="hl-1">.</span><span class="hl-5">preventDefault</span><span class="hl-1">();</span><br/><span class="hl-1">  </span><span class="hl-8">// 用拖拽手势实现自定义交互（如绘制标注）</span><br/><span class="hl-1">  </span><span class="hl-5">drawAnnotation</span><span class="hl-1">(</span><span class="hl-6">event</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
+</code><button type="button">Copy</button></pre>
+
+<h3 id="waituntil" class="tsd-anchor-link">waitUntil<a href="#waituntil" 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><code>waitUntil(promise)</code> 仅在 <code>ExtendableEvent</code> 上可用。调用后，Five 会等待传入的 Promise 完成后再继续后续流程。可多次调用，所有 Promise 会被并行等待。</p>
+<p>目前仅 <code>pano.prepare</code> 事件支持 <code>waitUntil</code>。</p>
+<pre><code class="typescript"><span class="hl-8">// 示例：在切换点位前预加载资源</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&quot;pano.prepare&quot;</span><span class="hl-1">, (</span><span class="hl-6">event</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-8">// 等待自定义资源加载完成后再继续点位切换</span><br/><span class="hl-1">  </span><span class="hl-6">event</span><span class="hl-1">.</span><span class="hl-5">waitUntil</span><span class="hl-1">(</span><br/><span class="hl-1">    </span><span class="hl-5">loadCustomResources</span><span class="hl-1">(</span><span class="hl-6">event</span><span class="hl-1">.</span><span class="hl-6">pano</span><span class="hl-1">)</span><br/><span class="hl-1">  );</span><br/><br/><span class="hl-1">  </span><span class="hl-8">// 可以多次调用，所有 Promise 会被并行等待</span><br/><span class="hl-1">  </span><span class="hl-6">event</span><span class="hl-1">.</span><span class="hl-5">waitUntil</span><span class="hl-1">(</span><br/><span class="hl-1">    </span><span class="hl-5">preloadTextures</span><span class="hl-1">(</span><span class="hl-6">event</span><span class="hl-1">.</span><span class="hl-6">pano</span><span class="hl-1">)</span><br/><span class="hl-1">  );</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-8">// 示例：通过 waitUntil reject 来取消走点</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&quot;pano.prepare&quot;</span><span class="hl-1">, (</span><span class="hl-6">event</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-6">event</span><span class="hl-1">.</span><span class="hl-5">waitUntil</span><span class="hl-1">(</span><br/><span class="hl-1">    </span><span class="hl-5">showConfirmDialog</span><span class="hl-1">(</span><span class="hl-9">&quot;是否前往该点位？&quot;</span><span class="hl-1">).</span><span class="hl-5">then</span><span class="hl-1">((</span><span class="hl-6">confirmed</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">      </span><span class="hl-10">if</span><span class="hl-1"> (!</span><span class="hl-6">confirmed</span><span class="hl-1">) {</span><br/><span class="hl-1">        </span><span class="hl-10">throw</span><span class="hl-1"> </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">Error</span><span class="hl-1">(</span><span class="hl-9">&quot;用户取消走点&quot;</span><span class="hl-1">);</span><br/><span class="hl-1">      }</span><br/><span class="hl-1">    })</span><br/><span class="hl-1">  );</span><br/><span class="hl-1">});</span>
+</code><button type="button">Copy</button></pre>
+
+<blockquote>
+<p><strong>注意</strong>: <code>preventDefault</code> 和 <code>waitUntil</code> 必须在事件回调的同步执行阶段调用，不能放在 <code>await</code> 之后。</p>
+</blockquote>
 <h2 id="concepts" class="tsd-anchor-link">Concepts<a href="#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></h2>
 <p>Five 的事件系统将事件主要分为以下几类：</p>
 <h3 id="gesture-events-交互手势" class="tsd-anchor-link">Gesture Events (交互手势)<a href="#gesture-events-交互手势" 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>
@@ -51,6 +86,7 @@
 <h3 id="pano-events-全景导航" class="tsd-anchor-link">Pano Events (全景导航)<a href="#pano-events-全景导航" 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><code>pano.prepare</code>: 准备切换到新点位。这是一个 <code>ExtendableEvent</code>，支持通过 <code>waitUntil(promise)</code> 延迟后续加载流程（如预加载资源），以及通过 <code>preventDefault()</code> 取消本次走点。</li>
 <li><code>pano.arrived</code>: 成功到达新点位（移动动画结束）。</li>
 <li><code>pano.moving</code>: 正在移动到新点位（动画进行中）。</li>
 <li><code>pano.willChange</code>: 即将发生点位变更（旧版兼容）。</li>
@@ -80,7 +116,7 @@
 <h2 id="examples" class="tsd-anchor-link">Examples<a href="#examples" 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="快速上手-quick-example" class="tsd-anchor-link">快速上手 (Quick Example)<a href="#快速上手-quick-example" 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>
-<pre><code class="typescript"><span class="hl-10">import</span><span class="hl-1"> { </span><span class="hl-6">Five</span><span class="hl-1"> } </span><span class="hl-10">from</span><span class="hl-1"> </span><span class="hl-9">&quot;@realsee/five&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">five</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">Five</span><span class="hl-1">();</span><br/><br/><span class="hl-8">// 监听点击事件</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&quot;gesture.tap&quot;</span><span class="hl-1">, (</span><span class="hl-6">pose</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">&quot;User tapped at:&quot;</span><span class="hl-1">, </span><span class="hl-6">pose</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-8">// 监听点位变更完成</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&quot;pano.arrived&quot;</span><span class="hl-1">, (</span><span class="hl-6">index</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">&quot;Arrived at pano index:&quot;</span><span class="hl-1">, </span><span class="hl-6">index</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
+<pre><code class="typescript"><span class="hl-10">import</span><span class="hl-1"> { </span><span class="hl-6">Five</span><span class="hl-1"> } </span><span class="hl-10">from</span><span class="hl-1"> </span><span class="hl-9">&quot;@realsee/five&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">five</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">Five</span><span class="hl-1">();</span><br/><br/><span class="hl-8">// 监听点击事件</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&quot;gesture.tap&quot;</span><span class="hl-1">, (</span><span class="hl-6">event</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">&quot;User tapped at:&quot;</span><span class="hl-1">, </span><span class="hl-6">event</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-8">// 监听点位变更完成</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">&quot;pano.arrived&quot;</span><span class="hl-1">, (</span><span class="hl-6">event</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">&quot;Arrived at pano:&quot;</span><span class="hl-1">, </span><span class="hl-6">event</span><span class="hl-1">.</span><span class="hl-6">pano</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
 </code><button type="button">Copy</button></pre>
 
 <h3 id="进阶用法-advanced-usage" class="tsd-anchor-link">进阶用法 (Advanced Usage)<a href="#进阶用法-advanced-usage" 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>
@@ -94,11 +130,11 @@
 </ul>
 <h2 id="related" class="tsd-anchor-link">Related<a href="#related" 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><a href="features_state.html">state.md</a>: 了解 State 的结构与变更机制。</li>
-<li><a href="features_five.html">five.md</a>: Five 核心类说明。</li>
+<li><a href="features_state.html">State</a>: 了解 State 的结构与变更机制。</li>
+<li><a href="features_five.html">Five</a>: Five 核心类说明。</li>
 </ul>
 <hr>
-<pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">events</span><span class="hl-1">, </span><span class="hl-2">interaction</span><span class="hl-1">, </span><span class="hl-2">lifecycle</span><span class="hl-1">, </span><span class="hl-2">gesture</span><span class="hl-1">, </span><span class="hl-2">state</span><span class="hl-1">]</span>
+<pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">事件监听</span><span class="hl-1">, </span><span class="hl-2">点击</span><span class="hl-1">, </span><span class="hl-2">拖拽</span><span class="hl-1">, </span><span class="hl-2">加载完成</span><span class="hl-1">, </span><span class="hl-2">渲染回调</span><span class="hl-1">, </span><span class="hl-2">生命周期</span><span class="hl-1">, </span><span class="hl-2">回调</span><span class="hl-1">, </span><span class="hl-2">events</span><span class="hl-1">, </span><span class="hl-2">interaction</span><span class="hl-1">, </span><span class="hl-2">lifecycle</span><span class="hl-1">, </span><span class="hl-2">gesture</span><span class="hl-1">, </span><span class="hl-2">state</span><span class="hl-1">, </span><span class="hl-2">preventDefault</span><span class="hl-1">, </span><span class="hl-2">waitUntil</span><span class="hl-1">, </span><span class="hl-3">on</span><span class="hl-1">, </span><span class="hl-3">off</span><span class="hl-1">, </span><span class="hl-2">subscribe</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="#events-事件系统"><span>Events (事件系统)</span></a><ul><li><a href="#schema"><span>Schema</span></a></li><li><ul><li><a href="#on"><span>on</span></a></li><li><a href="#once"><span>once</span></a></li><li><a href="#off"><span>off</span></a></li></ul></li><li><a href="#concepts"><span>Concepts</span></a></li><li><ul><li><a href="#gesture-events-交互手势"><span>Gesture <wbr/>Events (交互手势)</span></a></li><li><a href="#pano-events-全景导航"><span>Pano <wbr/>Events (全景导航)</span></a></li><li><a href="#state-events-状态变更"><span>State <wbr/>Events (状态变更)</span></a></li><li><a href="#model-work-events-数据加载"><span>Model &amp; <wbr/>Work <wbr/>Events (数据加载)</span></a></li><li><a href="#render-events-渲染循环"><span>Render <wbr/>Events (渲染循环)</span></a></li></ul></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#快速上手-quick-example"><span>快速上手 (<wbr/>Quick <wbr/>Example)</span></a></li><li><a href="#进阶用法-advanced-usage"><span>进阶用法 (<wbr/>Advanced <wbr/>Usage)</span></a></li></ul></li><li><a href="#debugging"><span>Debugging</span></a></li><li><a href="#related"><span>Related</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>
+</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="#events-事件系统"><span>Events (事件系统)</span></a><ul><li><a href="#schema"><span>Schema</span></a></li><li><ul><li><a href="#on"><span>on</span></a></li><li><a href="#once"><span>once</span></a></li><li><a href="#off"><span>off</span></a></li></ul></li><li><a href="#event-对象"><span>Event 对象</span></a></li><li><ul><li><a href="#baseevent"><span>Base<wbr/>Event</span></a></li><li><a href="#baseextendableevent"><span>Base<wbr/>Extendable<wbr/>Event</span></a></li><li><a href="#preventdefault"><span>prevent<wbr/>Default</span></a></li><li><a href="#waituntil"><span>wait<wbr/>Until</span></a></li></ul></li><li><a href="#concepts"><span>Concepts</span></a></li><li><ul><li><a href="#gesture-events-交互手势"><span>Gesture <wbr/>Events (交互手势)</span></a></li><li><a href="#pano-events-全景导航"><span>Pano <wbr/>Events (全景导航)</span></a></li><li><a href="#state-events-状态变更"><span>State <wbr/>Events (状态变更)</span></a></li><li><a href="#model-work-events-数据加载"><span>Model &amp; <wbr/>Work <wbr/>Events (数据加载)</span></a></li><li><a href="#render-events-渲染循环"><span>Render <wbr/>Events (渲染循环)</span></a></li></ul></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#快速上手-quick-example"><span>快速上手 (<wbr/>Quick <wbr/>Example)</span></a></li><li><a href="#进阶用法-advanced-usage"><span>进阶用法 (<wbr/>Advanced <wbr/>Usage)</span></a></li></ul></li><li><a href="#debugging"><span>Debugging</span></a></li><li><a href="#related"><span>Related</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>

package/docs/documents/features_five.html

@@ -49,7 +49,7 @@
 <td style="text-align:left"><code>imageOptions</code></td>
 <td style="text-align:left"><code>ImageOptions</code></td>
 <td style="text-align:left"><code>{}</code></td>
-<td style="text-align:left">图片加载策略，详见 <a href="features_image-options.html">image-options.md</a></td>
+<td style="text-align:left">图片加载策略，详见 <a href="features_image-options.html">Image Options</a></td>
 </tr>
 <tr>
 <td style="text-align:left"><code>textureOptions</code></td>
@@ -101,21 +101,21 @@
 
 <h3 id="实例属性-instance-properties" class="tsd-anchor-link">实例属性 (Instance Properties)<a href="#实例属性-instance-properties" 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><code>work</code></strong>: 当前加载的 Work 数据（主 Work）。详见 <a href="features_work.html">work.md</a>。</li>
-<li><strong><code>works</code></strong>: 当前加载的所有 Work 数据列表。详见 <a href="features_work.html">work.md</a>。</li>
-<li><strong><code>model</code></strong>: 当前加载的 Model 数据（主 Model）。详见 <a href="features_model.html">model.md</a>。</li>
-<li><strong><code>models</code></strong>: 当前加载的所有 Model 数据列表。详见 <a href="features_model.html">model.md</a>。</li>
+<li><strong><code>work</code></strong>: 当前加载的 Work 数据（主 Work）。详见 <a href="features_work.html">Work</a>。</li>
+<li><strong><code>works</code></strong>: 当前加载的所有 Work 数据列表。详见 <a href="features_work.html">Work</a>。</li>
+<li><strong><code>model</code></strong>: 当前加载的 Model 数据（主 Model）。详见 <a href="features_model.html">Model</a>。</li>
+<li><strong><code>models</code></strong>: 当前加载的所有 Model 数据列表。详见 <a href="features_model.html">Model</a>。</li>
 </ul>
 <h3 id="实例方法-instance-methods" class="tsd-anchor-link">实例方法 (Instance Methods)<a href="#实例方法-instance-methods" 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><code>appendTo(element: HTMLElement)</code></strong>: 将 canvas 挂载到指定 DOM 元素。</li>
-<li><strong><code>load(work: Work, state?: State, duration?: number)</code></strong>: 加载场景数据。详见 <a href="features_work.html">work.md</a>。</li>
+<li><strong><code>load(work: Work, state?: State, duration?: number)</code></strong>: 加载场景数据。详见 <a href="features_work.html">Work</a>。</li>
 <li><strong><code>dispose()</code></strong>: 销毁实例，释放 WebGL 上下文与内存。</li>
 <li><strong><code>updateCamera(pose: Partial&lt;Pose&gt;, duration: number, userAction?: boolean)</code></strong>: 移动相机（不触发点位移动）。移动相机的视角或位置，不会改变当前所在的 PanoIndex。如果动画中途被打断，Promise 会被 reject。</li>
 <li><strong><code>updateCameraWithKeyframes(keyframes: { progress: number; value: Pose; key?: string }[], duration: number, userAction?: boolean)</code></strong>: 通过关键帧动画移动相机。</li>
 <li><strong><code>refresh()</code></strong>: 强制刷新画布尺寸。通常在窗口 resize 时调用，Five 会自动监听 resize，但在某些布局变化场景下可能需要手动调用。</li>
 <li><strong><code>getPixels(x, y, width, height, ...)</code> / <code>getPixels(options)</code></strong>: 获取画布指定区域的像素数据。常用于截图、生成缩略图或颜色拾取。支持配置区域、像素比 (pixelRatio)、Y轴翻转 (flipY) 及是否忽略全景图 (skipPanorama) 等。</li>
-<li><strong><code>project2d(vector: THREE.Vector3, testModel?: boolean): THREE.Vector2 | null</code></strong>: 计算三维坐标对应到屏幕的二维坐标。如果坐标在视野外或被遮挡（开启 testModel 时），返回 null。详见 <a href="features_screen-project.html">screen-project.md</a>。</li>
+<li><strong><code>project2d(vector: THREE.Vector3, testModel?: boolean): THREE.Vector2 | null</code></strong>: 计算三维坐标对应到屏幕的二维坐标。如果坐标在视野外或被遮挡（开启 testModel 时），返回 null。详见 <a href="features_screen-project.html">Screen Project</a>。</li>
 <li><strong><code>ready(args?: { tile?: boolean })</code></strong>: Promise，当 Five 状态稳定时 resolve。
 <ul>
 <li><strong>Resolve 时机</strong>：
@@ -127,21 +127,21 @@
 </li>
 </ul>
 </li>
-<li><strong><code>setState(state: Partial&lt;State&gt;, options?: ChangeStateOptions)</code></strong>: 变更当前状态（如点位、视角）。详见 <a href="features_state.html">state.md</a>。</li>
-<li><strong><code>on(event, callback)</code> / <code>off(event, callback)</code></strong>: 事件监听。详见 <a href="features_event.html">event.md</a>。</li>
+<li><strong><code>setState(state: Partial&lt;State&gt;, options?: ChangeStateOptions)</code></strong>: 变更当前状态（如点位、视角）。详见 <a href="features_state.html">State</a>。</li>
+<li><strong><code>on(event, callback)</code> / <code>off(event, callback)</code></strong>: 事件监听。详见 <a href="features_event.html">Event</a>。</li>
 </ul>
 <h2 id="related" class="tsd-anchor-link">Related<a href="#related" 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><a href="features_work.html">work.md</a>: Work 数据结构说明。</li>
-<li><a href="features_model.html">model.md</a>: Model 数据结构说明。</li>
-<li><a href="features_state.html">state.md</a>: 状态管理详解。</li>
-<li><a href="features_event.html">event.md</a>: 事件系统说明。</li>
-<li><a href="features_image-options.html">image-options.md</a>: 图片加载配置。</li>
-<li><a href="features_mode.html">mode.md</a>: 模态切换说明。</li>
-<li><a href="features_parameter.html">parameter.md</a>: 其他核心参数。</li>
+<li><a href="features_work.html">Work</a>: Work 数据结构说明。</li>
+<li><a href="features_model.html">Model</a>: Model 数据结构说明。</li>
+<li><a href="features_state.html">State</a>: 状态管理详解。</li>
+<li><a href="features_event.html">Event</a>: 事件系统说明。</li>
+<li><a href="features_image-options.html">Image Options</a>: 图片加载配置。</li>
+<li><a href="features_mode.html">Mode</a>: 模态切换说明。</li>
+<li><a href="features_parameter.html">Parameter</a>: 其他核心参数。</li>
 </ul>
 <hr>
-<pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">five</span><span class="hl-1">, </span><span class="hl-2">initialization</span><span class="hl-1">, </span><span class="hl-2">core</span><span class="hl-1">, </span><span class="hl-2">instance</span><span class="hl-1">, </span><span class="hl-2">lifecycle</span><span class="hl-1">]</span>
+<pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">初始化</span><span class="hl-1">, </span><span class="hl-2">创建实例</span><span class="hl-1">, </span><span class="hl-2">渲染器</span><span class="hl-1">, </span><span class="hl-2">销毁</span><span class="hl-1">, </span><span class="hl-2">入口</span><span class="hl-1">, </span><span class="hl-2">构造函数</span><span class="hl-1">, </span><span class="hl-2">five</span><span class="hl-1">, </span><span class="hl-2">initialization</span><span class="hl-1">, </span><span class="hl-2">core</span><span class="hl-1">, </span><span class="hl-2">instance</span><span class="hl-1">, </span><span class="hl-2">lifecycle</span><span class="hl-1">, </span><span class="hl-2">canvas</span><span class="hl-1">, </span><span class="hl-2">appendTo</span><span class="hl-1">, </span><span class="hl-2">dispose</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-five-核心类"><span>Five (<wbr/>Five 核心类)</span></a><ul><li><a href="#schema"><span>Schema</span></a></li><li><ul><li><a href="#fiveinitargs"><span>Five<wbr/>Init<wbr/>Args</span></a></li></ul></li><li><a href="#concepts"><span>Concepts</span></a></li><li><ul><li><a href="#instance-management-实例管理"><span>Instance <wbr/>Management (实例管理)</span></a></li><li><a href="#rendering-loop-渲染循环"><span>Rendering <wbr/>Loop (渲染循环)</span></a></li><li><a href="#resource-loading-资源加载"><span>Resource <wbr/>Loading (资源加载)</span></a></li></ul></li><li><a href="#configuration"><span>Configuration</span></a></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#快速上手-quick-example"><span>快速上手 (<wbr/>Quick <wbr/>Example)</span></a></li><li><a href="#进阶用法：自定义渲染器与视口"><span>进阶用法：自定义渲染器与视口</span></a></li><li><a href="#进阶用法：自定义相机动画"><span>进阶用法：自定义相机动画</span></a></li><li><a href="#实例属性-instance-properties"><span>实例属性 (<wbr/>Instance <wbr/>Properties)</span></a></li><li><a href="#实例方法-instance-methods"><span>实例方法 (<wbr/>Instance <wbr/>Methods)</span></a></li></ul></li><li><a href="#related"><span>Related</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>