@realsee/five/docs/functions/react.useFiveAction.html

Realsee Renderer SDK

<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useFiveAction | 如视 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="../modules/react.html">react</a></li><li><a href="" aria-current="page">useFiveAction</a></li></ul><h1>Function useFiveAction</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="usefiveaction"><span class="tsd-kind-call-signature">useFiveAction</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/react.FiveActionReactCallbacks.html" class="tsd-signature-type tsd-kind-interface">FiveActionReactCallbacks</a><a href="#usefiveaction" 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></div><div class="tsd-description"><code class="tsd-tag">Function</code><div class="tsd-comment tsd-typography"><p>Five React Hooks: 使用 Five 的命令</p>
<p>updateCamera</p>
<pre><code><span class="hl-6">移动相机</span><span class="hl-1">。（</span><span class="hl-6">不触发点位移动</span><span class="hl-1">）</span><br/><span class="hl-6">如果动画中途被打断</span><span class="hl-1">（</span><span class="hl-6">用户触发行为</span><span class="hl-1">，</span><span class="hl-6">或者调用</span><span class="hl-1"> </span><span class="hl-6">setState</span><span class="hl-1">, </span><span class="hl-6">load</span><span class="hl-1">, </span><span class="hl-6">changeMode</span><span class="hl-1">）</span><span class="hl-6">的等</span><br/><span class="hl-6">会</span><span class="hl-1"> </span><span class="hl-7">Promise</span><span class="hl-1">.</span><span class="hl-6">reject</span><span class="hl-1">。</span><span class="hl-6">运动完成则</span><span class="hl-1"> </span><span class="hl-7">Promise</span><span class="hl-1">.</span><span class="hl-6">resolve</span><br/><br/><span class="hl-8">// params pose - 相机目标位置</span><br/><span class="hl-8">// params duration - 动画触发的时常</span><br/><span class="hl-8">// params Promise - 是否移动成功</span><br/><span class="hl-5">updateCamera</span><span class="hl-1">(</span><span class="hl-6">pose</span><span class="hl-1">: </span><span class="hl-6">Pose</span><span class="hl-1">, </span><span class="hl-6">duration</span><span class="hl-1">: </span><span class="hl-6">number</span><span class="hl-1">): </span><span class="hl-7">Promise</span><span class="hl-1">&lt;</span><span class="hl-3">void</span><span class="hl-1">&gt;</span>
</code><button>Copy</button></pre>

<p>getPixels</p>
<pre><code><span class="hl-6">获取画面中的像素颜色</span><br/><span class="hl-8">// param x - 获取像素区域的起始坐标 x</span><br/><span class="hl-8">// param y - 获取像素区域的起始坐标 y</span><br/><span class="hl-8">// param width - 获取像素区域的宽度</span><br/><span class="hl-8">// param height - 获取像素区域的高度</span><br/><span class="hl-8">// param pixelRatio - 获取区域的像素比</span><br/><span class="hl-8">// returns rgba颜色平铺的 Uint8Array</span><br/><span class="hl-5">getPixels</span><span class="hl-1">(</span><span class="hl-6">x</span><span class="hl-1">: </span><span class="hl-6">number</span><span class="hl-1">, </span><span class="hl-6">y</span><span class="hl-1">: </span><span class="hl-6">number</span><span class="hl-1">, </span><span class="hl-6">width</span><span class="hl-1">: </span><span class="hl-6">number</span><span class="hl-1">, </span><span class="hl-6">height</span><span class="hl-1">: </span><span class="hl-6">number</span><span class="hl-1">, </span><span class="hl-6">pixelRatio</span><span class="hl-1">?: </span><span class="hl-6">number</span><span class="hl-1">): </span><span class="hl-6">Uint8Array</span><span class="hl-1">,</span>
</code><button>Copy</button></pre>

<p>render</p>
<pre><code><span class="hl-6">强制渲染</span><br/><span class="hl-6">调用</span><span class="hl-1"> </span><span class="hl-5">render</span><span class="hl-1">() </span><span class="hl-6">和</span><span class="hl-1"> </span><span class="hl-5">needsRender</span><span class="hl-1">() </span><span class="hl-6">均可在按需渲染时</span><span class="hl-1">，</span><span class="hl-6">使得画面渲染一次</span><br/><span class="hl-6">区别在于</span><span class="hl-1">：</span><br/><span class="hl-1">- </span><span class="hl-5">needsRender</span><span class="hl-1">() </span><span class="hl-6">为在下帧渲染画面</span><br/><span class="hl-1">- </span><span class="hl-5">render</span><span class="hl-1">() </span><span class="hl-6">在当前帧渲染画面</span><br/><span class="hl-6">推荐使用</span><span class="hl-1"> </span><span class="hl-5">needsRender</span><span class="hl-1">(), </span><span class="hl-6">可以更加流畅</span><span class="hl-1">。</span><span class="hl-6">但是如果需要截图等同步操作</span><span class="hl-1">，</span><span class="hl-6">可以使用</span><span class="hl-1"> </span><span class="hl-5">render</span><span class="hl-1">()</span><br/><br/><span class="hl-8">// param callback 渲染完成回调</span><br/><span class="hl-5">render</span><span class="hl-1">(</span><span class="hl-6">callback</span><span class="hl-1">?: () </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-3">void</span><span class="hl-1">): </span><span class="hl-3">void</span><span class="hl-1">,</span>
</code><button>Copy</button></pre>

<p>needsRender</p>
<pre><code><span class="hl-6">下一帧渲染</span><br/><span class="hl-6">调用</span><span class="hl-1"> </span><span class="hl-5">render</span><span class="hl-1">() </span><span class="hl-6">和</span><span class="hl-1"> </span><span class="hl-5">needsRender</span><span class="hl-1">() </span><span class="hl-6">均可在按需渲染时</span><span class="hl-1">，</span><span class="hl-6">使得画面渲染一次</span><br/><span class="hl-6">区别在于</span><span class="hl-1">：</span><br/><span class="hl-1">- </span><span class="hl-5">needsRender</span><span class="hl-1">() </span><span class="hl-6">为在下帧渲染画面</span><br/><span class="hl-1">- </span><span class="hl-5">render</span><span class="hl-1">() </span><span class="hl-6">在当前帧渲染画面</span><br/><span class="hl-6">推荐使用</span><span class="hl-1"> </span><span class="hl-5">needsRender</span><span class="hl-1">(), </span><span class="hl-6">可以更加流畅</span><span class="hl-1">。</span><span class="hl-6">但是如果需要截图等同步操作</span><span class="hl-1">，</span><span class="hl-6">可以使用</span><span class="hl-1"> </span><span class="hl-5">render</span><span class="hl-1">()</span><br/><span class="hl-5">needsRender</span><span class="hl-1">(): </span><span class="hl-3">void</span><span class="hl-1">,</span>
</code><button>Copy</button></pre>

<p>preloadPano</p>
<pre><code><span class="hl-6">预加载点位图片资源</span><br/><span class="hl-8">// param panoIndex - 观察点序号</span><br/><span class="hl-8">// param callback - 加载完成回调, 并传递加载用时。</span><br/><span class="hl-8">// returns 加载完成的 Promise 参数同 callback</span><br/><span class="hl-5">preloadPano</span><span class="hl-1">(</span><span class="hl-6">panoIndex</span><span class="hl-1">: </span><span class="hl-6">number</span><span class="hl-1">, </span><span class="hl-6">callback</span><span class="hl-1">?: (</span><span class="hl-6">costs</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-3">void</span><span class="hl-1">): </span><span class="hl-7">Promise</span><span class="hl-1">&lt;</span><span class="hl-6">number</span><span class="hl-1">&gt;</span>
</code><button>Copy</button></pre>

</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/react.FiveActionReactCallbacks.html" class="tsd-signature-type tsd-kind-interface">FiveActionReactCallbacks</a></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#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></h4><pre><code><span class="hl-3">const</span><span class="hl-1"> { </span><span class="hl-4">updateCamera</span><span class="hl-1">, </span><span class="hl-4">initBasisLoader</span><span class="hl-1">, </span><span class="hl-4">getPixels</span><span class="hl-1">, </span><span class="hl-4">render</span><span class="hl-1">, </span><span class="hl-4">needsRender</span><span class="hl-1">, </span><span class="hl-4">preloadPano</span><span class="hl-1"> } = </span><span class="hl-5">useFiveAction</span><span class="hl-1">();</span>
</code><button>Copy</button></pre>

</div></div><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveAction.ts:166</li></ul></aside></div></li></ul></section></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></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>