UNPKG

@realsee/five

Version:

Realsee Renderer SDK

95 lines (93 loc) • 16.9 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>glossary | 如视 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">glossary</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="glossary-术语表" class="tsd-anchor-link">Glossary (术语表)<a href="#glossary-术语表" 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 SDK 中的核心术语定义与解释。</li> <li><strong>Audience</strong>: 开发者、AI 助手。</li> </ul> <h2 id="core-entities-核心实体" class="tsd-anchor-link">Core Entities (核心实体)<a href="#core-entities-核心实体" 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="five" class="tsd-anchor-link">Five<a href="#five" 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>SDK 的核心入口类。一个 <code>Five</code> 实例对应一个 <code>&lt;canvas&gt;</code> 渲染上下文,负责管理场景生命周期、渲染循环、用户交互和状态更新。</p> <h3 id="work" class="tsd-anchor-link">Work<a href="#work" 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>VR 看房的<strong>运行时实体</strong>。通常指经过 <code>parseWork</code> 解析后生成的标准化数据对象。</p> <ul> <li><strong>LooseWork</strong>: 服务端下发的原始 JSON 数据,结构较宽松。</li> <li><strong>WorkJson</strong>: <code>workToJson</code> 生成的标准序列化数据,用于存储。</li> <li><strong>包含内容</strong>: Observers, Panorama, Model, Plan 等。</li> </ul> <h3 id="vertex-marks-顶点标记" class="tsd-anchor-link">Vertex Marks (顶点标记)<a href="#vertex-marks-顶点标记" 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>_feature_id_rsmask</code> 属性进行的标记。</p> <ul> <li>用于在特定视角(如俯视)下控制 Mesh 的显隐(例如隐藏天花板)。</li> <li>属于材质配置的一部分。</li> </ul> <h3 id="observer" class="tsd-anchor-link">Observer<a href="#observer" 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><strong>观察点</strong>。对应现实空间中拍摄全景图的一个物理位置。</p> <ul> <li>属性包含:位置 (position)、旋转 (quaternion)、关联的全景图信息。</li> <li>用户在“全景模式”下,实际上是在不同的 Observer 之间跳转。</li> </ul> <h2 id="state-coordinates-状态与坐标" class="tsd-anchor-link">State &amp; Coordinates (状态与坐标)<a href="#state-coordinates-状态与坐标" 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="mode-模式" class="tsd-anchor-link">Mode (模式)<a href="#mode-模式" 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> <ol> <li><strong>Panorama (全景)</strong>: 第一人称视角,固定在某个点位观察 360° 景象。</li> <li><strong>Floorplan (户型图)</strong>: 2D 顶视视角,查看房屋平面结构。</li> <li><strong>Topview (顶视)</strong>: 3D 俯视视角,可自由旋转查看房屋立体结构。</li> <li><strong>Model (模型)</strong>: 自由漫游视角,可像游戏一样在模型中自由行走(脱离全景点位)。</li> <li><strong>Map (地图)</strong>: 类似 Google Earth 的操作方式,用于大场景鸟瞰。</li> </ol> <h3 id="pose-位姿" class="tsd-anchor-link">Pose (位姿)<a href="#pose-位姿" 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><strong>Panorama 模式下</strong>: 使用球面坐标 <code>(Longitude, Latitude)</code> + <code>Fov</code>。</li> <li><strong>其他模式下</strong>: 使用 <code>(x, y, z)</code> 坐标或变换矩阵。</li> </ul> <h3 id="panoindex" class="tsd-anchor-link">PanoIndex<a href="#panoindex" 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><strong>全景索引</strong>。当前所在的 Observer 在 <code>work.observers</code> 数组中的下标 (从 0 开始)。</p> <h3 id="fov-field-of-view" class="tsd-anchor-link">Fov (Field of View)<a href="#fov-field-of-view" 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><strong>视场角</strong>。决定了视野的宽窄。</p> <ul> <li>数值越大,视野越广(广角)。</li> <li>数值越小,视野越窄(长焦/放大)。</li> </ul> <h2 id="rendering-渲染" class="tsd-anchor-link">Rendering (渲染)<a href="#rendering-渲染" 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="pano-tile-全景瓦片" class="tsd-anchor-link">Pano Tile (全景瓦片)<a href="#pano-tile-全景瓦片" 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>为了在移动端快速加载高分辨率全景图(如 8K/16K),将全景图切分为多个小块(瓦片)。Five 会根据当前视角按需加载可见区域的瓦片。</p> <h3 id="mesh-三维网格" class="tsd-anchor-link">Mesh (三维网格)<a href="#mesh-三维网格" 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><strong>三维模型</strong>。通过激光扫描或视觉算法重建的空间几何结构。在 Five 中,全景图贴在几何模型上,从而实现“从全景中看出立体感”的效果。</p> <h3 id="g-buffer-geometry-buffer" class="tsd-anchor-link">G-Buffer / Geometry Buffer<a href="#g-buffer-geometry-buffer" 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>用于后处理的几何缓冲区,包含深度 (Depth)、法线 (Normal)、ID 等信息,用于实现高级特效(如轮廓线、SSAO)。</p> <h3 id="viewlayer" class="tsd-anchor-link">ViewLayer<a href="#viewlayer" 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>Model</code> 内部特定 3D 资源(如 Mesh、PointCloud、Gaussian Splatting)的图层。</p> <ul> <li>继承自 <code>Tile3D</code>。</li> <li>拥有独立的 <code>Parameter</code> 配置(覆盖上层配置)。</li> <li>支持可见性控制 (<code>visible</code>) 和优先级加载。</li> </ul> <h3 id="gaussian-splatting" class="tsd-anchor-link">Gaussian Splatting<a href="#gaussian-splatting" 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 渲染技术,通过各向异性高斯球(Splat)来表示场景。</p> <ul> <li>相比传统 Mesh,能更真实地还原复杂光照和细节。</li> <li>Five 支持 <code>.spz</code> 和 <code>.splat</code> 格式的 Gaussian Splatting 渲染。</li> </ul> <h3 id="3d-tiles-refinement-细化" class="tsd-anchor-link">3D Tiles Refinement (细化)<a href="#3d-tiles-refinement-细化" 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 加载过程中的状态概念:</p> <ul> <li><strong>Loaded (已加载)</strong>: 瓦片的基本数据已下载并解析,满足最低显示要求 (<code>minLevelOfDetail</code>)。</li> <li><strong>Refined (已细化)</strong>: 瓦片已加载最高质量数据,满足当前视角的屏幕空间误差要求 (<code>maxScreenSpaceError</code>)。</li> <li><code>five.model.refineProgress</code> 可用于监控当前视角的细化进度。</li> </ul> <h2 id="interaction-交互" class="tsd-anchor-link">Interaction (交互)<a href="#interaction-交互" 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="raycast-射线检测" class="tsd-anchor-link">Raycast (射线检测)<a href="#raycast-射线检测" 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>将屏幕上的 2D 点击坐标转换为 3D 空间中的射线,用于检测用户点击了哪个物体(如点击地面移动、点击标签)。</p> <h3 id="tap-press--pan--pinch" class="tsd-anchor-link">Tap / Press / Pan / Pinch<a href="#tap-press--pan--pinch" 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>Tap</strong>: 轻触。</li> <li><strong>Press</strong>: 长按。</li> <li><strong>Pan</strong>: 拖拽/平移。</li> <li><strong>Pinch</strong>: 双指缩放。</li> </ul> <hr> <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">glossary</span><span class="hl-1">, </span><span class="hl-2">terminology</span><span class="hl-1">, </span><span class="hl-2">definitions</span><span class="hl-1">, </span><span class="hl-2">observer</span><span class="hl-1">, </span><span class="hl-2">pose</span><span class="hl-1">, </span><span class="hl-2">mode</span><span class="hl-1">, </span><span class="hl-2">work</span><span class="hl-1">, </span><span class="hl-2">panoindex</span><span class="hl-1">, </span><span class="hl-2">fov</span><span class="hl-1">, </span><span class="hl-2">viewlayer</span><span class="hl-1">, </span><span class="hl-2">gaussian-splatting</span><span class="hl-1">, </span><span class="hl-2">3dtile</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="#glossary-术语表"><span>Glossary (术语表)</span></a><ul><li><a href="#core-entities-核心实体"><span>Core <wbr/>Entities (核心实体)</span></a></li><li><ul><li><a href="#five"><span>Five</span></a></li><li><a href="#work"><span>Work</span></a></li><li><a href="#vertex-marks-顶点标记"><span>Vertex <wbr/>Marks (顶点标记)</span></a></li><li><a href="#observer"><span>Observer</span></a></li></ul></li><li><a href="#state-coordinates-状态与坐标"><span>State &amp; <wbr/>Coordinates (状态与坐标)</span></a></li><li><ul><li><a href="#mode-模式"><span>Mode (模式)</span></a></li><li><a href="#pose-位姿"><span>Pose (位姿)</span></a></li><li><a href="#panoindex"><span>Pano<wbr/>Index</span></a></li><li><a href="#fov-field-of-view"><span>Fov (<wbr/>Field of <wbr/>View)</span></a></li></ul></li><li><a href="#rendering-渲染"><span>Rendering (渲染)</span></a></li><li><ul><li><a href="#pano-tile-全景瓦片"><span>Pano <wbr/>Tile (全景瓦片)</span></a></li><li><a href="#mesh-三维网格"><span>Mesh (三维网格)</span></a></li><li><a href="#g-buffer-geometry-buffer"><span>G-<wbr/>Buffer / <wbr/>Geometry <wbr/>Buffer</span></a></li><li><a href="#viewlayer"><span>View<wbr/>Layer</span></a></li><li><a href="#gaussian-splatting"><span>Gaussian <wbr/>Splatting</span></a></li><li><a href="#3d-tiles-refinement-细化"><span>3<wbr/>D <wbr/>Tiles <wbr/>Refinement (细化)</span></a></li></ul></li><li><a href="#interaction-交互"><span>Interaction (交互)</span></a></li><li><ul><li><a href="#raycast-射线检测"><span>Raycast (射线检测)</span></a></li><li><a href="#tap-press--pan--pinch"><span>Tap / <wbr/>Press / <wbr/>Pan / <wbr/>Pinch</span></a></li></ul></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>