@realsee/five 6.3.0 → 6.4.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/assets/search.js +1 -1
- package/docs/classes/five.Five.html +26 -17
- package/docs/classes/five.Model.html +1 -1
- package/docs/classes/five.Tile3DModel.html +3 -4
- package/docs/classes/five.Trajectory.html +2 -2
- package/docs/classes/five.TrajectoryNode.html +6 -4
- package/docs/functions/five.loadB3dm.html +1 -1
- package/docs/functions/five.loadDome.html +1 -1
- package/docs/functions/five.loadDomez.html +1 -1
- package/docs/functions/five.loadPbm.html +1 -1
- package/docs/functions/five.loadPly.html +1 -1
- package/docs/functions/react.useFiveAction.html +1 -1
- package/docs/functions/vue.useFiveAction.html +1 -1
- package/docs/interfaces/five.Tile3DModelLoaderOptions.html +2 -2
- package/docs/interfaces/react.FiveActionReactCallbacks.html +19 -8
- package/docs/interfaces/react.FiveInjectionTypes.html +32 -23
- package/docs/interfaces/vue.FiveActionVueCallbacks.html +20 -9
- package/docs/types/five.ModelMaterialValues.html +1 -1
- package/docs/types/five.Models.html +5 -5
- package/docs/types/five.ParsedResultType.html +1 -1
- package/docs/types/five.TrajectoryContentData.html +1 -1
- package/five/index.d.ts +40 -10
- package/five/index.js +120 -116
- package/five/index.mjs +4561 -4357
- package/gltf-loader/index.js +3 -3
- package/gltf-loader/index.mjs +3 -3
- package/line/index.js +3 -3
- package/line/index.mjs +10 -10
- package/package.json +1 -1
- package/plugins/index.js +2 -2
- package/plugins/index.mjs +2 -2
- package/react/index.d.ts +26 -1
- package/react/index.js +3 -3
- package/react/index.mjs +33 -39
- package/shader-lib/index.js +2 -2
- package/shader-lib/index.mjs +2 -2
- package/sticker/index.js +3 -3
- package/sticker/index.mjs +7 -7
- package/umd/five-gltf-loader.js +3 -3
- package/umd/five-line.js +3 -3
- package/umd/five-plugins.js +2 -2
- package/umd/five-react.js +3 -3
- package/umd/five-shader-lib.js +2 -2
- package/umd/five-sticker.js +3 -3
- package/umd/five-vfx.js +2 -2
- package/umd/five-vue.js +3 -3
- package/umd/five.js +76 -72
- package/vfx/index.js +2 -2
- package/vfx/index.mjs +2 -2
- package/vue/index.d.ts +26 -1
- package/vue/index.js +3 -3
- package/vue/index.mjs +27 -29
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FiveInjectionTypes | 如视 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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/react.html">react</a></li><li><a href="react.FiveInjectionTypes.html">FiveInjectionTypes</a></li></ul><h1>Interface FiveInjectionTypes</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">FiveInjectionTypes</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#cameraDirection">cameraDirection</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#cameraRaycaster">cameraRaycaster</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#currentObserver">currentObserver</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#currentState">currentState</a><span class="tsd-signature-symbol">: </span><a href="five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#getPixels">getPixels</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#getPixels.__type.__type-1.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">y</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">width</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">height</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">pixelRatio</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">flipY</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, <span class="tsd-kind-parameter">buffer</span><span class="tsd-signature-symbol">?: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-1.T-1">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-1.T-1">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#helperVisible">helperVisible</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#initBasisLoader">initBasisLoader</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#intersectRaycaster">intersectRaycaster</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">raycaster</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Raycaster</span>, <span class="tsd-kind-parameter">floor</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">sortByDistance</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="five.Intersection.html" class="tsd-signature-type tsd-kind-interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#loadWork">loadWork</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">inputWork</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWorkWithExtrinsics.html" class="tsd-signature-type tsd-kind-type-alias">LooseWorkWithExtrinsics</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWorkWithExtrinsics.html" class="tsd-signature-type tsd-kind-type-alias">LooseWorkWithExtrinsics</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"initial"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"inherit"</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="five.FiveLoadOptions.html" class="tsd-signature-type tsd-kind-interface">FiveLoadOptions</a>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#model">model</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#modelReadyState">modelReadyState</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#needsRender">needsRender</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#off">off</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#off.__type-8.__type-9.K">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#off.off-1.K-1">K</a>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#off.off-1.K-1">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#off.off-1.K-1">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#on">on</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#on.__type-10.__type-11.K-1">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#on.on-1.K-2">K</a>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#on.on-1.K-2">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#on.on-1.K-2">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span>, <span class="tsd-kind-parameter">once</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#once">once</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#once.__type-14.__type-15.K-2">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#once.once-1.K-3">K</a>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#once.once-1.K-3">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#once.once-1.K-3">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#preloadPano">preloadPano</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pano</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../types/five.Pano.html" class="tsd-signature-type tsd-kind-type-alias">Pano</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-type">[</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-type">]</span><span class="tsd-signature-symbol">`</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">costs</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#project2d">project2d</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vector</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Vector3</span>, <span class="tsd-kind-parameter">testModel</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Vector2</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#render">render</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span>, <span class="tsd-kind-parameter">updateObjectResolution</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#scene">scene</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#setState">setState</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">immediately</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#showFloor">showFloor</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">floorIndex</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#shownFloor">shownFloor</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#state">state</a><span class="tsd-signature-symbol">: </span><a href="five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#toggleHelperVisible">toggleHelperVisible</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">visible</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#totalFloorLength">totalFloorLength</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#unsafe__fiveInstance">unsafe__fiveInstance</a><span class="tsd-signature-symbol">: </span><a href="../classes/five.Five.html" class="tsd-signature-type tsd-kind-class">Five</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#updateCamera">updateCamera</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pose</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="five.Pose.html" class="tsd-signature-type tsd-kind-interface">Pose</a><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">duration</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#works">works</a><span class="tsd-signature-symbol">: </span><a href="../types/five.Works.html" class="tsd-signature-type tsd-kind-type-alias">Works</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><a href="../types/react.FiveInjectionFeature.html" class="tsd-signature-type tsd-kind-type-alias">FiveInjectionFeature</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">FiveInjectionTypes</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.ts:330</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="react.FiveInjectionTypes.html#cameraDirection" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>camera<wbr/>Direction</span></a>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FiveInjectionTypes | 如视 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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">如视 Five SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">如视 Five SDK</a></li><li><a href="../modules/react.html">react</a></li><li><a href="react.FiveInjectionTypes.html">FiveInjectionTypes</a></li></ul><h1>Interface FiveInjectionTypes</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">FiveInjectionTypes</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#cameraDirection">cameraDirection</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#cameraRaycaster">cameraRaycaster</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#currentObserver">currentObserver</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#currentState">currentState</a><span class="tsd-signature-symbol">: </span><a href="five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#getPixels">getPixels</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#getPixels.__type.__type-1.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">y</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">width</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">height</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">pixelRatio</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">flipY</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, <span class="tsd-kind-parameter">buffer</span><span class="tsd-signature-symbol">?: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-1.T-1">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-1.T-1">T</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#getPixels.__type.__type-2.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">buffer</span><span class="tsd-signature-symbol">?: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-2.T-2">T</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">flipY</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">helperVisible</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pixelRatio</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">skipPanorama</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">x</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">y</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-2.T-2">T</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#helperVisible">helperVisible</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#initBasisLoader">initBasisLoader</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#intersectRaycaster">intersectRaycaster</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">raycaster</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Raycaster</span>, <span class="tsd-kind-parameter">floor</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">sortByDistance</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="five.Intersection.html" class="tsd-signature-type tsd-kind-interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#loadWork">loadWork</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">inputWork</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWorkWithExtrinsics.html" class="tsd-signature-type tsd-kind-type-alias">LooseWorkWithExtrinsics</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWorkWithExtrinsics.html" class="tsd-signature-type tsd-kind-type-alias">LooseWorkWithExtrinsics</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"initial"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"inherit"</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="five.FiveLoadOptions.html" class="tsd-signature-type tsd-kind-interface">FiveLoadOptions</a>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#model">model</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#modelReadyState">modelReadyState</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#needsRender">needsRender</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#off">off</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#off.__type-9.__type-10.K">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#off.off-1.K-1">K</a>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#off.off-1.K-1">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#off.off-1.K-1">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#on">on</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#on.__type-11.__type-12.K-1">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#on.on-1.K-2">K</a>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#on.on-1.K-2">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#on.on-1.K-2">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span>, <span class="tsd-kind-parameter">once</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#once">once</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#once.__type-15.__type-16.K-2">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#once.once-1.K-3">K</a>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#once.once-1.K-3">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#once.once-1.K-3">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#preloadPano">preloadPano</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pano</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../types/five.Pano.html" class="tsd-signature-type tsd-kind-type-alias">Pano</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-type">[</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-type">]</span><span class="tsd-signature-symbol">`</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">costs</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#project2d">project2d</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vector</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Vector3</span>, <span class="tsd-kind-parameter">testModel</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Vector2</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#render">render</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span>, <span class="tsd-kind-parameter">updateObjectResolution</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#scene">scene</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#setState">setState</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">immediately</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#showFloor">showFloor</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">floorIndex</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#shownFloor">shownFloor</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#state">state</a><span class="tsd-signature-symbol">: </span><a href="five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#toggleHelperVisible">toggleHelperVisible</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">visible</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#totalFloorLength">totalFloorLength</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#unsafe__fiveInstance">unsafe__fiveInstance</a><span class="tsd-signature-symbol">: </span><a href="../classes/five.Five.html" class="tsd-signature-type tsd-kind-class">Five</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#updateCamera">updateCamera</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pose</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="five.Pose.html" class="tsd-signature-type tsd-kind-interface">Pose</a><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">duration</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="react.FiveInjectionTypes.html#works">works</a><span class="tsd-signature-symbol">: </span><a href="../types/five.Works.html" class="tsd-signature-type tsd-kind-type-alias">Works</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><a href="../types/react.FiveInjectionFeature.html" class="tsd-signature-type tsd-kind-type-alias">FiveInjectionFeature</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">FiveInjectionTypes</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.ts:330</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="react.FiveInjectionTypes.html#cameraDirection" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>camera<wbr/>Direction</span></a>
|
|
2
2
|
<a href="react.FiveInjectionTypes.html#cameraRaycaster" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>camera<wbr/>Raycaster</span></a>
|
|
3
3
|
<a href="react.FiveInjectionTypes.html#currentObserver" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>current<wbr/>Observer</span></a>
|
|
4
4
|
<a href="react.FiveInjectionTypes.html#currentState" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>current<wbr/>State</span></a>
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
来迎合一些通过数据驱动的场景。
|
|
43
43
|
</code><button type="button">Copy</button></pre>
|
|
44
44
|
|
|
45
|
-
</div><aside class="tsd-sources"><p>Overrides Record.currentState</p><ul><li>Defined in lib/react/withFive.ts:378</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getPixels" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Pixels</span><a href="#getPixels" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Pixels</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">
|
|
45
|
+
</div><aside class="tsd-sources"><p>Overrides Record.currentState</p><ul><li>Defined in lib/react/withFive.ts:378</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getPixels" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Pixels</span><a href="#getPixels" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Pixels</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#getPixels.__type.__type-1.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">y</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">width</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">height</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">pixelRatio</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">flipY</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, <span class="tsd-kind-parameter">buffer</span><span class="tsd-signature-symbol">?: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-1.T-1">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-1.T-1">T</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#getPixels.__type.__type-2.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">buffer</span><span class="tsd-signature-symbol">?: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-2.T-2">T</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">flipY</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">helperVisible</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pixelRatio</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">skipPanorama</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">x</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">y</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-2.T-2">T</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>获取画面中的像素颜色</p>
|
|
46
46
|
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="getPixels.__type.__type-1"><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#getPixels.__type.__type-1.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span>, <span class="tsd-kind-parameter">y</span>, <span class="tsd-kind-parameter">width</span>, <span class="tsd-kind-parameter">height</span>, <span class="tsd-kind-parameter">pixelRatio</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">flipY</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">buffer</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-1.T-1">T</a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>获取画面中的像素颜色</p>
|
|
47
47
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="getPixels.__type.__type-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8ClampedArray</span> = <span class="tsd-signature-type">Uint8Array</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">x</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>获取像素区域的起始坐标 x</p>
|
|
48
48
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">y</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>获取像素区域的起始坐标 y</p>
|
|
@@ -52,14 +52,23 @@
|
|
|
52
52
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">flipY</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>是否Y轴翻转</p>
|
|
53
53
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">buffer</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-1.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>存储数组</p>
|
|
54
54
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-1.T-1">T</a></h4><p>rgba颜色平铺的 Uint8Array</p>
|
|
55
|
-
<div class="tsd-comment tsd-typography"></div></li
|
|
55
|
+
<div class="tsd-comment tsd-typography"></div></li><li class="tsd-signature" id="getPixels.__type.__type-2"><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#getPixels.__type.__type-2.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-2.T-2">T</a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>获取画面中的像素颜色</p>
|
|
56
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="getPixels.__type.__type-2.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8ClampedArray</span> = <span class="tsd-signature-type">Uint8Array</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">buffer</span><span class="tsd-signature-symbol">?: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-2.T-2">T</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">flipY</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">helperVisible</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">pixelRatio</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">skipPanorama</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">x</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">y</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>参数</p>
|
|
57
|
+
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">buffer</span><span class="tsd-signature-symbol">?: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-2.T-2">T</a></h5><div class="tsd-comment tsd-typography"><p>存储数组</p>
|
|
58
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">flipY</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>是否Y轴翻转</p>
|
|
59
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>获取像素区域的高度</p>
|
|
60
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">helper<wbr/>Visible</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">pixel<wbr/>Ratio</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>获取区域的像素比</p>
|
|
61
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">skip<wbr/>Panorama</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>获取像素区域的宽度</p>
|
|
62
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">x</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>获取像素区域的起始坐标 x</p>
|
|
63
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">y</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>获取像素区域的起始坐标 y</p>
|
|
64
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.Five.html#getPixels.getPixels-2.T-2">T</a></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Param: x" class="tsd-anchor"></a>Param: x<a href="#Param: x" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>获取像素区域的起始坐标 x</p>
|
|
56
65
|
<h4 class="tsd-anchor-link"><a id="Param: y" class="tsd-anchor"></a>Param: y<a href="#Param: y" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>获取像素区域的起始坐标 y</p>
|
|
57
66
|
<h4 class="tsd-anchor-link"><a id="Param: width" class="tsd-anchor"></a>Param: width<a href="#Param: width" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>获取像素区域的宽度</p>
|
|
58
67
|
<h4 class="tsd-anchor-link"><a id="Param: height" class="tsd-anchor"></a>Param: height<a href="#Param: height" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>获取像素区域的高度</p>
|
|
59
68
|
<h4 class="tsd-anchor-link"><a id="Param: pixelRatio" class="tsd-anchor"></a>Param: pixelRatio<a href="#Param: pixelRatio" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>获取区域的像素比</p>
|
|
60
69
|
<h4 class="tsd-anchor-link"><a id="Returns" class="tsd-anchor"></a>Returns<a href="#Returns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>rgba颜色平铺的 Uint8Array</p>
|
|
61
70
|
</div><aside class="tsd-sources"><p>Overrides Record.getPixels</p><ul><li>Defined in lib/react/withFive.ts:493</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="helperVisible" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>helper<wbr/>Visible</span><a href="#helperVisible" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">helper<wbr/>Visible</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from Record.helperVisible</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="initBasisLoader" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>init<wbr/>Basis<wbr/>Loader</span><a href="#initBasisLoader" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">init<wbr/>Basis<wbr/>Loader</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from Record.initBasisLoader</p></aside></section><section class="tsd-panel tsd-member"><a id="intersectRaycaster" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>intersect<wbr/>Raycaster</span><a href="#intersectRaycaster" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">intersect<wbr/>Raycaster</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">raycaster</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Raycaster</span>, <span class="tsd-kind-parameter">floor</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">sortByDistance</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="five.Intersection.html" class="tsd-signature-type tsd-kind-interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>计算模型射线碰撞检测</p>
|
|
62
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="intersectRaycaster.__type-
|
|
71
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="intersectRaycaster.__type-3.__type-4"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">raycaster</span>, <span class="tsd-kind-parameter">floor</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">sortByDistance</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="five.Intersection.html" class="tsd-signature-type tsd-kind-interface">Intersection</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>计算模型射线碰撞检测</p>
|
|
63
72
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">raycaster</span>: <span class="tsd-signature-type">Raycaster</span></span><div class="tsd-comment tsd-typography"><p>THREE 射线对象</p>
|
|
64
73
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">floor</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = null</span></span><div class="tsd-comment tsd-typography"><p>和某一楼层做碰撞检测, 不传为和所有楼层做碰撞检测</p>
|
|
65
74
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">sortByDistance</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="five.Intersection.html" class="tsd-signature-type tsd-kind-interface">Intersection</a><span class="tsd-signature-symbol">[]</span></h4><p>返回碰撞</p>
|
|
@@ -67,7 +76,7 @@
|
|
|
67
76
|
<h4 class="tsd-anchor-link"><a id="Param: floor" class="tsd-anchor"></a>Param: floor<a href="#Param: floor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>和某一楼层做碰撞检测, 不传为和所有楼层做碰撞检测</p>
|
|
68
77
|
<h4 class="tsd-anchor-link"><a id="Returns-1" class="tsd-anchor"></a>Returns<a href="#Returns-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>返回碰撞</p>
|
|
69
78
|
</div><aside class="tsd-sources"><p>Overrides Record.intersectRaycaster</p><ul><li>Defined in lib/react/withFive.ts:461</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="loadWork" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>load<wbr/>Work</span><a href="#loadWork" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">load<wbr/>Work</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">inputWork</span><span class="tsd-signature-symbol">: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWorkWithExtrinsics.html" class="tsd-signature-type tsd-kind-type-alias">LooseWorkWithExtrinsics</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWorkWithExtrinsics.html" class="tsd-signature-type tsd-kind-type-alias">LooseWorkWithExtrinsics</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"initial"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"inherit"</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="five.FiveLoadOptions.html" class="tsd-signature-type tsd-kind-interface">FiveLoadOptions</a>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>加载 Work 数据</p>
|
|
70
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="loadWork.__type-
|
|
79
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="loadWork.__type-5.__type-6"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">inputWork</span>, <span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>加载 Work 数据</p>
|
|
71
80
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">inputWork</span>: <br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">string</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWorkWithExtrinsics.html" class="tsd-signature-type tsd-kind-type-alias">LooseWorkWithExtrinsics</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../classes/five.Work.html" class="tsd-signature-type tsd-kind-class">Work</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWork.html" class="tsd-signature-type tsd-kind-type-alias">LooseWork</a><span class="tsd-signature-symbol">[]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><a href="../types/five.LooseWorkWithExtrinsics.html" class="tsd-signature-type tsd-kind-type-alias">LooseWorkWithExtrinsics</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Work 数据</p>
|
|
72
81
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">state</span>: <span class="tsd-signature-type">"initial"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"inherit"</span></span><div class="tsd-comment tsd-typography"><p>初始化姿态</p>
|
|
73
82
|
<ul>
|
|
@@ -92,11 +101,11 @@
|
|
|
92
101
|
<li><code>render()</code> 在当前帧渲染画面
|
|
93
102
|
推荐使用 <code>needsRender()</code>, 可以更加流畅。但是如果需要截图等同步操作,可以使用 <code>render()</code></li>
|
|
94
103
|
</ul>
|
|
95
|
-
</div><aside class="tsd-sources"><p>Overrides Record.needsRender</p><ul><li>Defined in lib/react/withFive.ts:518</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="off" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">off</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#off.__type-
|
|
96
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="off.__type-
|
|
104
|
+
</div><aside class="tsd-sources"><p>Overrides Record.needsRender</p><ul><li>Defined in lib/react/withFive.ts:518</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="off" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">off</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#off.__type-9.__type-10.K">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#off.off-1.K-1">K</a>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#off.off-1.K-1">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#off.off-1.K-1">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>解除事件绑定</p>
|
|
105
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="off.__type-9.__type-10"><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#off.__type-9.__type-10.K">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>解除事件</p>
|
|
97
106
|
<p>如果 name 不传的话解除对应所有事件
|
|
98
107
|
如果 name, callback 不传的话解除所有name的所有事件</p>
|
|
99
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="off.__type-
|
|
108
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="off.__type-9.__type-10.K" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">K</span><span class="tsd-signature-keyword"> extends </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"dispose"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.pan"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.tap"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.dbltap"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.press"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.pinch"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.mousewheel"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.mousemove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.momentum"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"initAnimation.start"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"initAnimation.end"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"camera.update"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"intersect.update"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.select"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.request"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.moveTo"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.moving"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.arrived"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.cancel"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.texture.load"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.texture.progress"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.texture.success"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.texture.error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.texture.abort"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.session.end"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.session.start"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.gesture.tap"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.gesture.press"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.gesture.buttonUp"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.gesture.buttonDown"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.controller.update"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">(</span>keyof LegacyEventType<span class="tsd-signature-symbol">)</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"works.request"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"works.load"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"works.ready"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"state.set"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"state.change"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"state.synced"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"currentState.change"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"model.request"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"model.load"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"model.error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"model.changeShownFloor"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"models.load"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"models.refined"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"render.prepare"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"render"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"mode.change.request"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"mode.change"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"helpers.visible"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"network.resource"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"fps"</span></span><div class="tsd-comment tsd-typography"><p>预设的监听事件名称</p>
|
|
100
109
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">name</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#off.off-1.K-1">K</a></span><div class="tsd-comment tsd-typography"><p>事件类型</p>
|
|
101
110
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#off.off-1.K-1">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#off.off-1.K-1">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>事件回调函数</p>
|
|
102
111
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#off.off-1.K-1">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#off.off-1.K-1">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#off.off-1.K-1">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Param: name" class="tsd-anchor"></a>Param: name<a href="#Param: name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>事件名 具体事件列表 请查看 Five.EventCallback</p>
|
|
@@ -104,34 +113,34 @@
|
|
|
104
113
|
<h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-4">$five</span><span class="hl-1">.</span><span class="hl-0">off</span><span class="hl-1">(</span><span class="hl-2">"panoArrived"</span><span class="hl-1">, () </span><span class="hl-6">=></span><span class="hl-1"> {});</span>
|
|
105
114
|
</code><button>Copy</button></pre>
|
|
106
115
|
|
|
107
|
-
</div><aside class="tsd-sources"><p>Overrides Record.off</p><ul><li>Defined in lib/react/withFive.ts:453</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="on" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#on.__type-
|
|
108
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="on.__type-
|
|
109
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="on.__type-
|
|
116
|
+
</div><aside class="tsd-sources"><p>Overrides Record.off</p><ul><li>Defined in lib/react/withFive.ts:453</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="on" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">on</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#on.__type-11.__type-12.K-1">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#on.on-1.K-2">K</a>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#on.on-1.K-2">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#on.on-1.K-2">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span>, <span class="tsd-kind-parameter">once</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>监听事件</p>
|
|
117
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="on.__type-11.__type-12"><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#on.__type-11.__type-12.K-1">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">callback</span>, <span class="tsd-kind-parameter">once</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>注册事件</p>
|
|
118
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="on.__type-11.__type-12.K-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">K</span><span class="tsd-signature-keyword"> extends </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"dispose"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.pan"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.tap"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.dbltap"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.press"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.pinch"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.mousewheel"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.mousemove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.momentum"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"initAnimation.start"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"initAnimation.end"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"camera.update"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"intersect.update"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.select"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.request"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.moveTo"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.moving"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.arrived"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.cancel"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.texture.load"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.texture.progress"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.texture.success"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.texture.error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.texture.abort"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.session.end"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.session.start"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.gesture.tap"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.gesture.press"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.gesture.buttonUp"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.gesture.buttonDown"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.controller.update"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">(</span>keyof LegacyEventType<span class="tsd-signature-symbol">)</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"works.request"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"works.load"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"works.ready"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"state.set"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"state.change"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"state.synced"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"currentState.change"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"model.request"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"model.load"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"model.error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"model.changeShownFloor"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"models.load"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"models.refined"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"render.prepare"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"render"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"mode.change.request"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"mode.change"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"helpers.visible"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"network.resource"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"fps"</span></span><div class="tsd-comment tsd-typography"><p>预设的监听事件名称</p>
|
|
110
119
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#on.on-1.K-2">K</a></span><div class="tsd-comment tsd-typography"><p>事件类型</p>
|
|
111
120
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#on.on-1.K-2">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#on.on-1.K-2">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>事件回调函数</p>
|
|
112
121
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#on.on-1.K-2">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#on.on-1.K-2">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#on.on-1.K-2">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">once</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>是否只执行一次</p>
|
|
113
122
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4><p>解除事件</p>
|
|
114
|
-
<ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="on.__type-
|
|
123
|
+
<ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="on.__type-11.__type-12.__type-13.__type-14"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Param: name-1" class="tsd-anchor"></a>Param: name<a href="#Param: name-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>事件名 具体事件列表 请查看 Five.EventCallback</p>
|
|
115
124
|
<h4 class="tsd-anchor-link"><a id="Param: callback-1" class="tsd-anchor"></a>Param: callback<a href="#Param: callback-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>回调函数</p>
|
|
116
125
|
<h4 class="tsd-anchor-link"><a id="Param: once" class="tsd-anchor"></a>Param: once<a href="#Param: once" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>是否一次触发</p>
|
|
117
126
|
<h4 class="tsd-anchor-link"><a id="Returns-2" class="tsd-anchor"></a>Returns<a href="#Returns-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>解除事件绑定</p>
|
|
118
127
|
<h4 class="tsd-anchor-link"><a id="Example-1" class="tsd-anchor"></a>Example<a href="#Example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-4">$five</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">"panoArrived"</span><span class="hl-1">, () </span><span class="hl-6">=></span><span class="hl-1"> {});</span>
|
|
119
128
|
</code><button>Copy</button></pre>
|
|
120
129
|
|
|
121
|
-
</div><aside class="tsd-sources"><p>Overrides Record.on</p><ul><li>Defined in lib/react/withFive.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="once" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">once</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#once.__type-
|
|
122
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="once.__type-
|
|
123
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="once.__type-
|
|
130
|
+
</div><aside class="tsd-sources"><p>Overrides Record.on</p><ul><li>Defined in lib/react/withFive.ts:430</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="once" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">once</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#once.__type-15.__type-16.K-2">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#once.once-1.K-3">K</a>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#once.once-1.K-3">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#once.once-1.K-3">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>监听事件一次触发</p>
|
|
131
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="once.__type-15.__type-16"><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="react.FiveInjectionTypes.html#once.__type-15.__type-16.K-2">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>注册事件(是否只执行一次)</p>
|
|
132
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="once.__type-15.__type-16.K-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">K</span><span class="tsd-signature-keyword"> extends </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"dispose"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.pan"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.tap"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.dbltap"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.press"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.pinch"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.mousewheel"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.mousemove"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"gesture.momentum"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"initAnimation.start"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"initAnimation.end"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"camera.update"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"intersect.update"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.select"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.request"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.moveTo"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.moving"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.arrived"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.cancel"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.texture.load"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.texture.progress"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.texture.success"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.texture.error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"pano.texture.abort"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.session.end"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.session.start"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.gesture.tap"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.gesture.press"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.gesture.buttonUp"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.gesture.buttonDown"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xr.controller.update"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">(</span>keyof LegacyEventType<span class="tsd-signature-symbol">)</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"works.request"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"works.load"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"works.ready"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"state.set"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"state.change"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"state.synced"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"currentState.change"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"model.request"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"model.load"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"model.error"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"model.changeShownFloor"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"models.load"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"models.refined"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"render.prepare"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"render"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"mode.change.request"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"mode.change"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"helpers.visible"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"network.resource"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"fps"</span></span><div class="tsd-comment tsd-typography"><p>预设的监听事件名称</p>
|
|
124
133
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#once.once-1.K-3">K</a></span><div class="tsd-comment tsd-typography"><p>事件类型</p>
|
|
125
134
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#once.once-1.K-3">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#once.once-1.K-3">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>事件回调函数</p>
|
|
126
135
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#once.once-1.K-3">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#once.once-1.K-3">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><a href="../types/five.EventTypes.html" class="tsd-signature-type tsd-kind-type-alias">EventTypes</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="../classes/five.NetworkSubscribe.html#once.once-1.K-3">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4><p>解除事件</p>
|
|
127
|
-
<ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="once.__type-
|
|
136
|
+
<ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="once.__type-15.__type-16.__type-17.__type-18"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Param: name-2" class="tsd-anchor"></a>Param: name<a href="#Param: name-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>事件名 具体事件列表 请查看 Five.EventCallback</p>
|
|
128
137
|
<h4 class="tsd-anchor-link"><a id="Param: callback-2" class="tsd-anchor"></a>Param: callback<a href="#Param: callback-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>回调函数</p>
|
|
129
138
|
<h4 class="tsd-anchor-link"><a id="Returns-3" class="tsd-anchor"></a>Returns<a href="#Returns-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>解除事件绑定</p>
|
|
130
139
|
<h4 class="tsd-anchor-link"><a id="Example-2" class="tsd-anchor"></a>Example<a href="#Example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-4">$five</span><span class="hl-1">.</span><span class="hl-0">once</span><span class="hl-1">(</span><span class="hl-2">"panoArrived"</span><span class="hl-1">, () </span><span class="hl-6">=></span><span class="hl-1"> {});</span>
|
|
131
140
|
</code><button>Copy</button></pre>
|
|
132
141
|
|
|
133
142
|
</div><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.ts:442</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="preloadPano" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>preload<wbr/>Pano</span><a href="#preloadPano" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">preload<wbr/>Pano</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pano</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../types/five.Pano.html" class="tsd-signature-type tsd-kind-type-alias">Pano</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-type">[</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-type">]</span><span class="tsd-signature-symbol">`</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">costs</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>预加载点位图片资源</p>
|
|
134
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="preloadPano.__type-
|
|
143
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="preloadPano.__type-19.__type-20"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pano</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>预加载点位图片资源</p>
|
|
135
144
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">pano</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="../types/five.Pano.html" class="tsd-signature-type tsd-kind-type-alias">Pano</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-type">[</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-type">]</span><span class="tsd-signature-symbol">`</span></span><div class="tsd-comment tsd-typography"><p>观察点序号</p>
|
|
136
145
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">costs</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = noop</span></span><div class="tsd-comment tsd-typography"><p>加载完成回调, 并传递加载用时。</p>
|
|
137
146
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">costs</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">costs</span>: <span class="tsd-signature-type">number</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>加载完成的 Promise 参数同 callback</p>
|
|
@@ -139,7 +148,7 @@
|
|
|
139
148
|
<h4 class="tsd-anchor-link"><a id="Param: callback-3" class="tsd-anchor"></a>Param: callback<a href="#Param: callback-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>加载完成回调, 并传递加载用时。</p>
|
|
140
149
|
<h4 class="tsd-anchor-link"><a id="Returns-4" class="tsd-anchor"></a>Returns<a href="#Returns-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>加载完成的 Promise 参数同 callback</p>
|
|
141
150
|
</div><aside class="tsd-sources"><p>Overrides Record.preloadPano</p><ul><li>Defined in lib/react/withFive.ts:526</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="project2d" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>project2d</span><a href="#project2d" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">project2d</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vector</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Vector3</span>, <span class="tsd-kind-parameter">testModel</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Vector2</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>计算三维坐标对应到屏幕的二维坐标</p>
|
|
142
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="project2d.__type-
|
|
151
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="project2d.__type-21.__type-22"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">vector</span>, <span class="tsd-kind-parameter">testModel</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Vector2</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>计算三维坐标对应到屏幕的二维坐标</p>
|
|
143
152
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">vector</span>: <span class="tsd-signature-type">Vector3</span></span><div class="tsd-comment tsd-typography"><p>三维坐标</p>
|
|
144
153
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">testModel</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>是否计算模型遮挡</p>
|
|
145
154
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Vector2</span></h4><p>二维坐标 或者 null</p>
|
|
@@ -149,7 +158,7 @@
|
|
|
149
158
|
<h4 class="tsd-anchor-link"><a id="Param: testModel" class="tsd-anchor"></a>Param: testModel<a href="#Param: testModel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>是否计算模型遮挡</p>
|
|
150
159
|
<h4 class="tsd-anchor-link"><a id="Returns-5" class="tsd-anchor"></a>Returns<a href="#Returns-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>二维坐标 或者 null</p>
|
|
151
160
|
</div><aside class="tsd-sources"><p>Overrides Record.project2d</p><ul><li>Defined in lib/react/withFive.ts:471</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="render" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>render</span><a href="#render" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">render</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span>, <span class="tsd-kind-parameter">updateObjectResolution</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>强制渲染</p>
|
|
152
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="render.__type-
|
|
161
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="render.__type-23.__type-24"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">updateObjectResolution</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>强制渲染</p>
|
|
153
162
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>渲染完成回调</p>
|
|
154
163
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li><span><span class="tsd-kind-parameter">updateObjectResolution</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Description-4" class="tsd-anchor"></a>Description<a href="#Description-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>调用 <code>five.render()</code> 和设置 <code>five.needsRender = true</code> 均可在按需渲染时,使得画面渲染一次
|
|
155
164
|
区别在于:</p>
|
|
@@ -167,7 +176,7 @@
|
|
|
167
176
|
</ul>
|
|
168
177
|
<h4 class="tsd-anchor-link"><a id="Param: callback-4" class="tsd-anchor"></a>Param: callback<a href="#Param: callback-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>渲染完成回调</p>
|
|
169
178
|
</div><aside class="tsd-sources"><p>Overrides Record.render</p><ul><li>Defined in lib/react/withFive.ts:506</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="scene" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>scene</span><a href="#scene" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">scene</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from Record.scene</p></aside></section><section class="tsd-panel tsd-member"><a id="setState" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>State</span><a href="#setState" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">set<wbr/>State</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">immediately</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>设置 State</p>
|
|
170
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="setState.__type-
|
|
179
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="setState.__type-25.__type-26"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span>, <span class="tsd-kind-parameter">immediately</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>设置 State</p>
|
|
171
180
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">state</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="five.State.html" class="tsd-signature-type tsd-kind-interface">State</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>目标状态</p>
|
|
172
181
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">immediately</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>是否马上转换,马上转换会尽快达到目标状态,尽量减少中间状态,更少动画。</p>
|
|
173
182
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">userAction</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>是否是用户触发的动作</p>
|
|
@@ -203,7 +212,7 @@
|
|
|
203
212
|
<h4 class="tsd-anchor-link"><a id="Param: state-1" class="tsd-anchor"></a>Param: state<a href="#Param: state-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>目标状态</p>
|
|
204
213
|
<h4 class="tsd-anchor-link"><a id="Param: immediately" class="tsd-anchor"></a>Param: immediately<a href="#Param: immediately" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>是否马上转换,马上转换会尽快达到目标状态,尽量减少中间状态,更少动画。</p>
|
|
205
214
|
</div><aside class="tsd-sources"><p>Overrides Record.setState</p><ul><li>Defined in lib/react/withFive.ts:406</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="showFloor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>show<wbr/>Floor</span><a href="#showFloor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">show<wbr/>Floor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">floorIndex</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>显示楼层</p>
|
|
206
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="showFloor.__type-
|
|
215
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="showFloor.__type-27.__type-28"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">floorIndex</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">floorIndex</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>楼层,如果不传则都显示</p>
|
|
207
216
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Record.showFloor</p><ul><li>Defined in lib/react/withFive.ts:532</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="shownFloor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>shown<wbr/>Floor</span><a href="#shownFloor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">shown<wbr/>Floor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from Record.shownFloor</p></aside></section><section class="tsd-panel tsd-member"><a id="state" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">:</span> <a href="five.State.html" class="tsd-signature-type tsd-kind-interface">State</a></div><div class="tsd-comment tsd-typography"><p>Five React Inject: Five 的目标状态</p>
|
|
208
217
|
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Description-8" class="tsd-anchor"></a>Description<a href="#Description-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="text">five 设置了以下状态
|
|
209
218
|
|
|
@@ -221,12 +230,12 @@
|
|
|
221
230
|
</code><button type="button">Copy</button></pre>
|
|
222
231
|
|
|
223
232
|
</div><aside class="tsd-sources"><p>Overrides Record.state</p><ul><li>Defined in lib/react/withFive.ts:357</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="toggleHelperVisible" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toggle<wbr/>Helper<wbr/>Visible</span><a href="#toggleHelperVisible" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">toggle<wbr/>Helper<wbr/>Visible</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">visible</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>帮助元素的隐藏/显示</p>
|
|
224
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="toggleHelperVisible.__type-
|
|
233
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="toggleHelperVisible.__type-29.__type-30"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">visible</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">visible</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>隐藏/显示</p>
|
|
225
234
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides Record.toggleHelperVisible</p><ul><li>Defined in lib/react/withFive.ts:538</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="totalFloorLength" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>total<wbr/>Floor<wbr/>Length</span><a href="#totalFloorLength" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">total<wbr/>Floor<wbr/>Length</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from Record.totalFloorLength</p></aside></section><section class="tsd-panel tsd-member"><a id="unsafe__fiveInstance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">unsafe__five<wbr/>Instance</span><a href="#unsafe__fiveInstance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">unsafe__five<wbr/>Instance</span><span class="tsd-signature-symbol">:</span> <a href="../classes/five.Five.html" class="tsd-signature-type tsd-kind-class">Five</a></div><div class="tsd-comment tsd-typography"><p>Five React Inject: 获取 five 实例</p>
|
|
226
235
|
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Description-9" class="tsd-anchor"></a>Description<a href="#Description-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>不到万不得已,并不推荐直接使用。</p>
|
|
227
236
|
<h4 class="tsd-anchor-link"><a id="Deprecated" class="tsd-anchor"></a>Deprecated<a href="#Deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>不到万不得已,并不推荐直接使用。</p>
|
|
228
237
|
</div><aside class="tsd-sources"><p>Overrides Record.unsafe__fiveInstance</p><ul><li>Defined in lib/react/withFive.ts:336</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="updateCamera" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Camera</span><a href="#updateCamera" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">update<wbr/>Camera</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pose</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="five.Pose.html" class="tsd-signature-type tsd-kind-interface">Pose</a><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">duration</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>移动相机。(不触发点位移动)</p>
|
|
229
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="updateCamera.__type-
|
|
238
|
+
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="updateCamera.__type-31.__type-32"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pose</span>, <span class="tsd-kind-parameter">duration</span>, <span class="tsd-kind-parameter">userAction</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>移动相机。(不触发点位移动)</p>
|
|
230
239
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">pose</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="five.Pose.html" class="tsd-signature-type tsd-kind-interface">Pose</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>相机目标位置</p>
|
|
231
240
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">duration</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>动画触发的时常</p>
|
|
232
241
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">userAction</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span><div class="tsd-comment tsd-typography"><p>是否用户触发</p>
|