@realsee/five 5.0.0-alpha.100

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.
Files changed (173) hide show
  1. package/README.md +362 -0
  2. package/TERMS.txt +56 -0
  3. package/docs/.nojekyll +1 -0
  4. package/docs/assets/highlight.css +134 -0
  5. package/docs/assets/icons.css +1043 -0
  6. package/docs/assets/icons.png +0 -0
  7. package/docs/assets/icons@2x.png +0 -0
  8. package/docs/assets/main.js +52 -0
  9. package/docs/assets/search.js +1 -0
  10. package/docs/assets/style.css +1388 -0
  11. package/docs/assets/widgets.png +0 -0
  12. package/docs/assets/widgets@2x.png +0 -0
  13. package/docs/classes/five.AnimationFrameLoop.html +15 -0
  14. package/docs/classes/five.BVH.html +10 -0
  15. package/docs/classes/five.BVHIntersect.html +1 -0
  16. package/docs/classes/five.BVHNode.html +7 -0
  17. package/docs/classes/five.BVHVector3.html +1 -0
  18. package/docs/classes/five.Camera.html +11 -0
  19. package/docs/classes/five.Five.html +303 -0
  20. package/docs/classes/five.InternalWebGLRenderer.html +1 -0
  21. package/docs/classes/five.IntersectMesh.html +1 -0
  22. package/docs/classes/five.LegacyPanoCircleMesh.html +5 -0
  23. package/docs/classes/five.Model.html +77 -0
  24. package/docs/classes/five.NetworkSubscribe.html +50 -0
  25. package/docs/classes/five.PBMContainer.html +17 -0
  26. package/docs/classes/five.PBMGroup.html +19 -0
  27. package/docs/classes/five.PBMMaterial.html +15 -0
  28. package/docs/classes/five.PBMMesh.html +7 -0
  29. package/docs/classes/five.PanoCircleMesh.html +7 -0
  30. package/docs/classes/five.Scene.html +3 -0
  31. package/docs/classes/five.Subscribe.html +56 -0
  32. package/docs/classes/five.Work.html +30 -0
  33. package/docs/classes/gltf_loader.GLTFLoader.html +17 -0
  34. package/docs/classes/gltf_loader.GLTFObject.html +7 -0
  35. package/docs/classes/line.Line.html +1 -0
  36. package/docs/classes/line.LineGeometry.html +1 -0
  37. package/docs/classes/line.LineMaterial.html +1 -0
  38. package/docs/classes/line.LineSegmentsGeometry.html +1 -0
  39. package/docs/classes/line.THREE_Line2.html +1 -0
  40. package/docs/classes/line.THREE_LineSegments2.html +1 -0
  41. package/docs/classes/react.Store.html +29 -0
  42. package/docs/classes/server.BVH.html +10 -0
  43. package/docs/classes/server.BVHIntersect.html +1 -0
  44. package/docs/classes/server.BVHNode.html +7 -0
  45. package/docs/classes/server.BVHVector3.html +1 -0
  46. package/docs/classes/server.Model.html +63 -0
  47. package/docs/classes/server.PBMGroup.html +9 -0
  48. package/docs/classes/server.PBMMesh.html +7 -0
  49. package/docs/classes/sticker.Sticker.html +32 -0
  50. package/docs/index.html +182 -0
  51. package/docs/interfaces/five.AddableObject.html +1 -0
  52. package/docs/interfaces/five.AnimationFrame.html +1 -0
  53. package/docs/interfaces/five.CameraPose.html +1 -0
  54. package/docs/interfaces/five.DepthPanoramaControllerCustomInitArgs.html +28 -0
  55. package/docs/interfaces/five.EventCallback.html +391 -0
  56. package/docs/interfaces/five.FiveInitArgs.html +96 -0
  57. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +15 -0
  58. package/docs/interfaces/five.ImageOptions.html +16 -0
  59. package/docs/interfaces/five.ImageURLOptions.html +1 -0
  60. package/docs/interfaces/five.IntersectMeshInterface.html +3 -0
  61. package/docs/interfaces/five.Intersection.html +7 -0
  62. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +20 -0
  63. package/docs/interfaces/five.ModelEventCallback.html +22 -0
  64. package/docs/interfaces/five.MovePanoOptions.html +39 -0
  65. package/docs/interfaces/five.PBMPanoPicture.html +7 -0
  66. package/docs/interfaces/five.PBMParameters.html +15 -0
  67. package/docs/interfaces/five.PanoCircleMeshInterface.html +19 -0
  68. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +28 -0
  69. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +20 -0
  70. package/docs/interfaces/five.Pose.html +35 -0
  71. package/docs/interfaces/five.Scissor.html +14 -0
  72. package/docs/interfaces/five.State.html +19 -0
  73. package/docs/interfaces/five.SubscribeMixinType.emit.html +1 -0
  74. package/docs/interfaces/five.SubscribeMixinType.hasListener.html +1 -0
  75. package/docs/interfaces/five.SubscribeMixinType.off.html +1 -0
  76. package/docs/interfaces/five.SubscribeMixinType.on.html +1 -0
  77. package/docs/interfaces/five.SubscribeMixinType.once.html +1 -0
  78. package/docs/interfaces/five.TextureOptions.html +18 -0
  79. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +7 -0
  80. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +24 -0
  81. package/docs/interfaces/five.WorkCubeImage.html +13 -0
  82. package/docs/interfaces/five.WorkImage.html +21 -0
  83. package/docs/interfaces/five.WorkInitial.html +13 -0
  84. package/docs/interfaces/five.WorkModel.html +11 -0
  85. package/docs/interfaces/five.WorkObserver.html +25 -0
  86. package/docs/interfaces/five.WorkTile.html +1 -0
  87. package/docs/interfaces/five.WorkVideo.html +9 -0
  88. package/docs/interfaces/gltf_loader.GLTF.html +7 -0
  89. package/docs/interfaces/react.FiveActionReactCallbacks.html +62 -0
  90. package/docs/interfaces/react.FiveInjectionTypes.html +191 -0
  91. package/docs/interfaces/react.PropTypeOfFiveFeatures.html +1 -0
  92. package/docs/interfaces/server.Intersection.html +7 -0
  93. package/docs/interfaces/server.ModelEventCallback.html +18 -0
  94. package/docs/interfaces/sticker.IntersectionLike.html +8 -0
  95. package/docs/media/coordinate.jpg +0 -0
  96. package/docs/media/topview.jpg +0 -0
  97. package/docs/media/typescript.jpg +0 -0
  98. package/docs/modules/five.SubscribeMixinType.html +1 -0
  99. package/docs/modules/five.html +481 -0
  100. package/docs/modules/gltf_loader.html +1 -0
  101. package/docs/modules/line.html +1 -0
  102. package/docs/modules/react.html +130 -0
  103. package/docs/modules/server.html +18 -0
  104. package/docs/modules/sticker.html +1 -0
  105. package/docs/modules.html +1 -0
  106. package/exporters/staticify.js +203 -0
  107. package/five/index.d.ts +2061 -0
  108. package/five/index.js +372 -0
  109. package/gltf-loader/index.d.ts +75 -0
  110. package/gltf-loader/index.js +260 -0
  111. package/line/index.d.ts +68 -0
  112. package/line/index.js +260 -0
  113. package/package.json +36 -0
  114. package/react/index.d.ts +812 -0
  115. package/react/index.js +260 -0
  116. package/resource/basis/basis_transcoder.js +22 -0
  117. package/resource/basis/basis_transcoder.wasm +0 -0
  118. package/resource/gltf/draco_decoder.js +31 -0
  119. package/resource/gltf/draco_decoder.wasm +0 -0
  120. package/resource/gltf/draco_wasm_wrapper.js +119 -0
  121. package/scripts/five-plugin-init.js +83 -0
  122. package/scripts/five-quick-start-init.js +80 -0
  123. package/scripts/five-react-component-init.js +83 -0
  124. package/scripts/five-staticify.js +21 -0
  125. package/server/index.d.ts +568 -0
  126. package/server/index.js +367 -0
  127. package/sticker/index.d.ts +70 -0
  128. package/sticker/index.js +260 -0
  129. package/templates/plugin/README.md +38 -0
  130. package/templates/plugin/devtools/external-five.js +5 -0
  131. package/templates/plugin/devtools/external-three.js +5 -0
  132. package/templates/plugin/devtools/tsconfig.build.json +18 -0
  133. package/templates/plugin/devtools/webpack.bundle.js +44 -0
  134. package/templates/plugin/devtools/webpack.example.js +39 -0
  135. package/templates/plugin/docs/.gitkeep +0 -0
  136. package/templates/plugin/examples/data.json +507 -0
  137. package/templates/plugin/examples/index.html +28 -0
  138. package/templates/plugin/examples/index.ts +12 -0
  139. package/templates/plugin/lib/index.ts +30 -0
  140. package/templates/plugin/package.json +32 -0
  141. package/templates/plugin/tsconfig.json +26 -0
  142. package/templates/quick-start/README.md +47 -0
  143. package/templates/quick-start/assets/work.json +507 -0
  144. package/templates/quick-start/index.html +54 -0
  145. package/templates/quick-start/index.tsx +123 -0
  146. package/templates/quick-start/package.json +25 -0
  147. package/templates/quick-start/tsconfig.json +27 -0
  148. package/templates/quick-start/webpack.config.js +45 -0
  149. package/templates/quick-start/webpack.production.js +42 -0
  150. package/templates/react-component/README.md +32 -0
  151. package/templates/react-component/devtools/external-five.js +5 -0
  152. package/templates/react-component/devtools/external-react.js +5 -0
  153. package/templates/react-component/devtools/external-three.js +5 -0
  154. package/templates/react-component/devtools/tsconfig.build.json +19 -0
  155. package/templates/react-component/devtools/webpack.bundle.js +44 -0
  156. package/templates/react-component/devtools/webpack.example.js +39 -0
  157. package/templates/react-component/docs/.gitkeep +0 -0
  158. package/templates/react-component/examples/data.json +507 -0
  159. package/templates/react-component/examples/index.html +17 -0
  160. package/templates/react-component/examples/index.tsx +62 -0
  161. package/templates/react-component/lib/index.tsx +157 -0
  162. package/templates/react-component/package.json +38 -0
  163. package/templates/react-component/tsconfig.json +27 -0
  164. package/umd/five-gltf-loader.js +2 -0
  165. package/umd/five-gltf-loader.js.LICENSE.txt +14 -0
  166. package/umd/five-line.js +2 -0
  167. package/umd/five-line.js.LICENSE.txt +14 -0
  168. package/umd/five-react.js +2 -0
  169. package/umd/five-react.js.LICENSE.txt +14 -0
  170. package/umd/five-sticker.js +2 -0
  171. package/umd/five-sticker.js.LICENSE.txt +14 -0
  172. package/umd/five.js +2 -0
  173. package/umd/five.js.LICENSE.txt +116 -0
package/docs/modules/react.html ADDED
@@ -0,0 +1,130 @@
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>react | 如视 Five SDK - v5.0.0-alpha.100</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.100"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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 - v5.0.0-alpha.100</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">如视 Five SDK - v5.0.0-alpha.100</a></li><li><a href="react.html">react</a></li></ul><h1>Module react</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/react.Store.html" class="tsd-kind-icon">Store</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.FiveActionReactCallbacks.html" class="tsd-kind-icon">Five<wbr/>Action<wbr/>React<wbr/>Callbacks</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.FiveInjectionTypes.html" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Types</a></li><li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/react.PropTypeOfFiveFeatures.html" class="tsd-kind-icon">Prop<wbr/>Type<wbr/>Of<wbr/>Five<wbr/>Features</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveInjectionActionFeature" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Action<wbr/>Feature</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveInjectionDataFeature" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Data<wbr/>Feature</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveInjectionFeature" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Feature</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveProviderPropTypes" class="tsd-kind-icon">Five<wbr/>Provider<wbr/>Prop<wbr/>Types</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveProviderType" class="tsd-kind-icon">Five<wbr/>Provider<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#StoreActionMapHanlder" class="tsd-kind-icon">Store<wbr/>Action<wbr/>Map<wbr/>Hanlder</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#StoreActionMapType" class="tsd-kind-icon">Store<wbr/>Action<wbr/>Map<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#StoreProviderType" class="tsd-kind-icon">Store<wbr/>Provider<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#StoreValueMapType" class="tsd-kind-icon">Store<wbr/>Value<wbr/>Map<wbr/>Type</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable tsd-parent-kind-module"><a href="react.html#FiveCanvas" class="tsd-kind-icon">Five<wbr/>Canvas</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="react.html#INJECTION_PROPNAME" class="tsd-kind-icon">INJECTION_<wbr/>PROPNAME</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#createFiveFeature" class="tsd-kind-icon">create<wbr/>Five<wbr/>Feature</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#createFiveProvider" class="tsd-kind-icon">create<wbr/>Five<wbr/>Provider</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#createStore" class="tsd-kind-icon">create<wbr/>Store</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#unsafe__useFiveInstance" class="tsd-kind-icon">unsafe__use<wbr/>Five<wbr/>Instance</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveAction" class="tsd-kind-icon">use<wbr/>Five<wbr/>Action</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCameraDirection" class="tsd-kind-icon">use<wbr/>Five<wbr/>Camera<wbr/>Direction</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCameraRaycaster" class="tsd-kind-icon">use<wbr/>Five<wbr/>Camera<wbr/>Raycaster</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCurrentObserver" class="tsd-kind-icon">use<wbr/>Five<wbr/>Current<wbr/>Observer</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCurrentState" class="tsd-kind-icon">use<wbr/>Five<wbr/>Current<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#useFiveEventCallback" class="tsd-kind-icon">use<wbr/>Five<wbr/>Event<wbr/>Callback</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveFloor" class="tsd-kind-icon">use<wbr/>Five<wbr/>Floor</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveHelper" class="tsd-kind-icon">use<wbr/>Five<wbr/>Helper</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveModelIntersectRaycaster" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveModelReadyState" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Ready<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveProject2d" class="tsd-kind-icon">use<wbr/>Five<wbr/>Project2d</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveScene" class="tsd-kind-icon">use<wbr/>Five<wbr/>Scene</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveSceneEffect" class="tsd-kind-icon">use<wbr/>Five<wbr/>Scene<wbr/>Effect</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveState" class="tsd-kind-icon">use<wbr/>Five<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveWork" class="tsd-kind-icon">use<wbr/>Five<wbr/>Work</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#withFive" class="tsd-kind-icon">with<wbr/>Five</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveInjectionActionFeature" class="tsd-anchor"></a><h3>Five<wbr/>Injection<wbr/>Action<wbr/>Feature</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Injection<wbr/>Action<wbr/>Feature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;loadWork&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;setState&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;on&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;off&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;intersectRaycaster&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;project2d&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;updateCamera&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;initBasisLoader&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;getPixels&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;render&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;needsRender&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;preloadPano&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;showFloor&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;toggleHelperVisible&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.tsx:25</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveInjectionDataFeature" class="tsd-anchor"></a><h3>Five<wbr/>Injection<wbr/>Data<wbr/>Feature</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Injection<wbr/>Data<wbr/>Feature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;unsafe__fiveInstance&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;currentState&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;currentObserver&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;state&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;work&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;model&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;scene&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;cameraDirection&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;cameraRaycaster&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;modelReadyState&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;shownFloor&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;totalFloorLength&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;helperVisible&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.tsx:10</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveInjectionFeature" class="tsd-anchor"></a><h3>Five<wbr/>Injection<wbr/>Feature</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Injection<wbr/>Feature<span class="tsd-signature-symbol">:</span> <a href="react.html#FiveInjectionDataFeature" class="tsd-signature-type" data-tsd-kind="Type alias">FiveInjectionDataFeature</a><span class="tsd-signature-symbol"> | </span><a href="react.html#FiveInjectionActionFeature" class="tsd-signature-type" data-tsd-kind="Type alias">FiveInjectionActionFeature</a></div><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.tsx:41</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveProviderPropTypes" class="tsd-anchor"></a><h3>Five<wbr/>Provider<wbr/>Prop<wbr/>Types</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Provider<wbr/>Prop<wbr/>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>children<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">React.ReactNode</span><span class="tsd-signature-symbol">; </span>initialState<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;inherit&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;initial&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;offset&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>initialUserAction<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>initialWork<span class="tsd-signature-symbol">?: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>work<span class="tsd-signature-symbol">?: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">; </span>onCurrentStateChange<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>onError<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>onStateChange<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>onWorkChange<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createProvider.tsx:6</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>children<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">React.ReactNode</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> initial<wbr/>State<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;inherit&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;initial&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;offset&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> initial<wbr/>User<wbr/>Action<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> initial<wbr/>Work<span class="tsd-signature-symbol">?: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">&gt;</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> work<span class="tsd-signature-symbol">?: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a></h5></li><li class="tsd-parameter"><h5>on<wbr/>Current<wbr/>State<wbr/>Change<span class="tsd-signature-symbol">?:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">on<wbr/>Current<wbr/>State<wbr/>Change<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a>, userAction<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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createProvider.tsx:13</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a></h5></li><li><h5>userAction: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>on<wbr/>Error<span class="tsd-signature-symbol">?:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">on<wbr/>Error<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createProvider.tsx:14</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>error: <span class="tsd-signature-type">Error</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>on<wbr/>State<wbr/>Change<span class="tsd-signature-symbol">?:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">on<wbr/>State<wbr/>Change<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a>, userAction<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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createProvider.tsx:12</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a></h5></li><li><h5>userAction: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>on<wbr/>Work<wbr/>Change<span class="tsd-signature-symbol">?:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">on<wbr/>Work<wbr/>Change<span class="tsd-signature-symbol">(</span>work<span class="tsd-signature-symbol">: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createProvider.tsx:11</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>work: <a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveProviderType" class="tsd-anchor"></a><h3>Five<wbr/>Provider<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Provider<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">typeof </span><a href="react.html#createFiveProvider" class="tsd-signature-type" data-tsd-kind="Function">createFiveProvider</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createProvider.tsx:113</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a id="StoreActionMapHanlder" class="tsd-anchor"></a><h3>Store<wbr/>Action<wbr/>Map<wbr/>Hanlder</h3><div class="tsd-signature tsd-kind-icon">Store<wbr/>Action<wbr/>Map<wbr/>Hanlder<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[ </span><span class="tsd-signature-type">Key</span><span class="tsd-signature-symbol"> in </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>getValues<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span>, setValues<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Key</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">Key</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span>deps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">]</span> <span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.tsx:44</li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="react.html#StoreValueMapType" class="tsd-signature-type" data-tsd-kind="Type alias">StoreValueMapType</a></h4></li><li><h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4></li><li><h4>M<span class="tsd-signature-symbol">: </span><a href="react.html#StoreActionMapType" class="tsd-signature-type" data-tsd-kind="Type alias">StoreActionMapType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="StoreActionMapType" class="tsd-anchor"></a><h3>Store<wbr/>Action<wbr/>Map<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Store<wbr/>Action<wbr/>Map<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.tsx:40</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="StoreProviderType" class="tsd-anchor"></a><h3>Store<wbr/>Provider<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Store<wbr/>Provider<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">typeof </span><a href="react.html#createStore" class="tsd-signature-type" data-tsd-kind="Function">createStore</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;StoreProvider&quot;</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.tsx:262</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="StoreValueMapType" class="tsd-anchor"></a><h3>Store<wbr/>Value<wbr/>Map<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Store<wbr/>Value<wbr/>Map<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.tsx:33</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"><a id="FiveCanvas" class="tsd-anchor"></a><h3>Five<wbr/>Canvas</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Canvas<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">React.FC</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/canvas.tsx:23</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
2
+ <p>Five 渲染区域组件</p>
3
+ </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>Five 渲染区域组件，请在 FiveProvider 内使用</p>
4
+ </dd><dt>param width</dt><dd><p>渲染区域的宽度</p>
5
+ </dd><dt>param height</dt><dd><p>渲染区域的高度</p>
6
+ </dd><dt>returns</dt><dd><p>React 元素</p>
7
+ </dd><dt>example</dt><dd><pre><code class="language-typescript"><span class="hl-0">&lt;</span><span class="hl-2">FiveProvider</span><span class="hl-0"> </span><span class="hl-2">initialWork</span><span class="hl-0">={</span><span class="hl-2">work</span><span class="hl-0">}&gt;</span><br/><span class="hl-0"> &lt;</span><span class="hl-2">FiveCanvas</span><span class="hl-0"> </span><span class="hl-2">width</span><span class="hl-0">={</span><span class="hl-13">512</span><span class="hl-0">} </span><span class="hl-2">height</span><span class="hl-0">={</span><span class="hl-13">512</span><span class="hl-0">}/&gt;</span><br/><span class="hl-0">&lt;/</span><span class="hl-2">FiveProvider</span><span class="hl-0">&gt;</span>
8
+ </code></pre>
9
+ </dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"><a id="INJECTION_PROPNAME" class="tsd-anchor"></a><h3>INJECTION_<wbr/>PROPNAME</h3><div class="tsd-signature tsd-kind-icon">INJECTION_<wbr/>PROPNAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;$five&quot;</span><span class="tsd-signature-symbol"> = &quot;$five&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.tsx:6</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a id="createFiveFeature" class="tsd-anchor"></a><h3>create<wbr/>Five<wbr/>Feature</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">create<wbr/>Five<wbr/>Feature<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>features<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.tsx:671</li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="react.html#FiveInjectionFeature" class="tsd-signature-type" data-tsd-kind="Type alias">FiveInjectionFeature</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>features: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="createFiveProvider" class="tsd-anchor"></a><h3>create<wbr/>Five<wbr/>Provider</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">create<wbr/>Five<wbr/>Provider<span class="tsd-signature-symbol">(</span>fiveInitArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.FiveInitArgs.html" class="tsd-signature-type" data-tsd-kind="Interface">FiveInitArgs</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;renderer&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;scissor&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">FiveProvider</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createProvider.tsx:36</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
10
+ <p>创建一个 FiveProvider
11
+ 在 React 的体系下，使用 Provider 的方式来组织组件结构。
12
+ 在 FiveProvider 下，可以使用 FiveCanvas 来创建渲染画布。
13
+ 以及使用 useFiveState useFiveEvent等 Five React Hooks API 来对 FiveProvider 进行操作</p>
14
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-7">const</span><span class="hl-0"> </span><span class="hl-6">FiveProvider</span><span class="hl-0"> = </span><span class="hl-5">createFiveProvider</span><span class="hl-0">({...</span><span class="hl-2">fiveInitArgs</span><span class="hl-0">});</span><br/><span class="hl-7">const</span><span class="hl-0"> </span><span class="hl-5">App</span><span class="hl-0">: </span><span class="hl-8">React</span><span class="hl-0">.</span><span class="hl-8">FC</span><span class="hl-0"> = () </span><span class="hl-7">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">return</span><span class="hl-0"> &lt;</span><span class="hl-8">FiveProvider</span><span class="hl-0"> </span><span class="hl-8">initialWork</span><span class="hl-0">={</span><span class="hl-2">work</span><span class="hl-0">}&gt;</span><br/><span class="hl-0"> &lt;</span><span class="hl-2">FiveCanvas</span><span class="hl-0"> </span><span class="hl-2">width</span><span class="hl-0">={</span><span class="hl-13">512</span><span class="hl-0">} </span><span class="hl-2">height</span><span class="hl-0">={</span><span class="hl-13">512</span><span class="hl-0">} /&gt;</span><br/><span class="hl-0"> &lt;/</span><span class="hl-2">FiveProvider</span><span class="hl-0">&gt;</span><br/><span class="hl-0">};</span><br/><span class="hl-2">ReactDOM</span><span class="hl-0">.</span><span class="hl-5">render</span><span class="hl-0">(&lt;</span><span class="hl-8">App</span><span class="hl-0">/&gt;, </span><span class="hl-2">document</span><span class="hl-0">.</span><span class="hl-5">getElementById</span><span class="hl-0">(</span><span class="hl-3">&quot;app&quot;</span><span class="hl-0">));</span>
15
+ </code></pre>
16
+ </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>fiveInitArgs: <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.FiveInitArgs.html" class="tsd-signature-type" data-tsd-kind="Interface">FiveInitArgs</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;renderer&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;scissor&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
17
+ <p>Five 初始化参数</p>
18
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">FiveProvider</span></h4><div><p>FiveProvider React 组件</p>
19
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a id="createStore" class="tsd-anchor"></a><h3>create<wbr/>Store</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">create<wbr/>Store<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">A</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>actionHandler<span class="tsd-signature-symbol">: </span><a href="react.html#StoreActionMapHanlder" class="tsd-signature-type" data-tsd-kind="Type alias">StoreActionMapHanlder</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">A</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>StoreProvider<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">StoreProvider</span><span class="tsd-signature-symbol">; </span>useStore<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>useStoreAction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>useStoreSetter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>watchStore<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.tsx:143</li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="react.html#StoreValueMapType" class="tsd-signature-type" data-tsd-kind="Type alias">StoreValueMapType</a></h4></li><li><h4>A<span class="tsd-signature-symbol">: </span><a href="react.html#StoreActionMapType" class="tsd-signature-type" data-tsd-kind="Type alias">StoreActionMapType</a> = <span class="tsd-signature-symbol">{}</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>actionHandler: <a href="react.html#StoreActionMapHanlder" class="tsd-signature-type" data-tsd-kind="Type alias">StoreActionMapHanlder</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">A</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span>StoreProvider<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">StoreProvider</span><span class="tsd-signature-symbol">; </span>useStore<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>useStoreAction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>useStoreSetter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>watchStore<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>Store<wbr/>Provider<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">StoreProvider</span></h5></li><li class="tsd-parameter"><h5>use<wbr/>Store<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">use<wbr/>Store<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>names<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</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>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span>setValues<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.tsx:161</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
20
+ <p>使用 Store</p>
21
+ </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">symbol</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>names: <span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
22
+ <p>获取的 Store 字段</p>
23
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span>setValues<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></h4><div></div></li></ul></li><li class="tsd-parameter"><h5>use<wbr/>Store<wbr/>Action<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">use<wbr/>Store<wbr/>Action<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">N</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>actionName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">N</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.tsx:221</li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>N<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">symbol</span></h4></li><li><h4>F<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>actionName: <span class="tsd-signature-type" data-tsd-kind="Type parameter">N</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span></h4></li></ul></li><li class="tsd-parameter"><h5>use<wbr/>Store<wbr/>Setter<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">use<wbr/>Store<wbr/>Setter<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>names<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</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>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.tsx:190</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
24
+ <p>使用 Store (仅设置值)</p>
25
+ </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">symbol</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>names: <span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
26
+ <p>获取的 Store 字段</p>
27
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h4><div><p>修改值方法</p>
28
+ </div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
29
+ <p>使用 Store (仅设置值)</p>
30
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>values: <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div><p>修改值方法</p>
31
+ </div></li></ul></li></ul></li></ul></li><li class="tsd-parameter"><h5>watch<wbr/>Store<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">watch<wbr/>Store<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>names<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">[]</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span>, prevValues<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span>, deps<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DependencyList</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.tsx:205</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
32
+ <p>监听 Store 变化</p>
33
+ </div></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">symbol</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>names: <span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
34
+ <p>Store 字段</p>
35
+ </div></div></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span>, prevValues<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
36
+ <p>监听变化的回调函数</p>
37
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span>, prevValues<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>values: <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5>prevValues: <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> deps: <span class="tsd-signature-type">DependencyList</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
38
+ <p>依赖对象</p>
39
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="unsafe__useFiveInstance" class="tsd-anchor"></a><h3>unsafe__use<wbr/>Five<wbr/>Instance</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">unsafe__use<wbr/>Five<wbr/>Instance<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/five.Five.html" class="tsd-signature-type" data-tsd-kind="Class">Five</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/unsafe__useFiveInstance.ts:10</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
40
+ <p>Five React Hooks: 获取 five 实例</p>
41
+ </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>不到万不得已，并不推荐直接使用。</p>
42
+ </dd><dt>deprecated</dt><dd><p>不到万不得已，并不推荐直接使用。</p>
43
+ </dd></dl></div><h4 class="tsd-returns-title">Returns <a href="../classes/five.Five.html" class="tsd-signature-type" data-tsd-kind="Class">Five</a></h4><div><p>five 实例</p>
44
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveAction" class="tsd-anchor"></a><h3>use<wbr/>Five<wbr/>Action</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Action<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/react.FiveActionReactCallbacks.html" class="tsd-signature-type" data-tsd-kind="Interface">FiveActionReactCallbacks</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveAction.ts:162</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
45
+ <p>Five React Hooks: 使用 Five 的命令</p>
46
+ </div><dl class="tsd-comment-tags"><dt>function</dt><dd><p>updateCamera</p>
47
+ <pre><code><span class="hl-2">移动相机</span><span class="hl-0">。（</span><span class="hl-2">不触发点位移动</span><span class="hl-0">）</span><br/><span class="hl-2">如果动画中途被打断</span><span class="hl-0">（</span><span class="hl-2">用户触发行为</span><span class="hl-0">，</span><span class="hl-2">或者调用</span><span class="hl-0"> </span><span class="hl-2">setState</span><span class="hl-0">, </span><span class="hl-2">load</span><span class="hl-0">, </span><span class="hl-2">changeMode</span><span class="hl-0">）</span><span class="hl-2">的等</span><br/><span class="hl-2">会</span><span class="hl-0"> </span><span class="hl-8">Promise</span><span class="hl-0">.</span><span class="hl-2">reject</span><span class="hl-0">。</span><span class="hl-2">运动完成则</span><span class="hl-0"> </span><span class="hl-8">Promise</span><span class="hl-0">.</span><span class="hl-2">resolve</span><br/><br/><span class="hl-4">// params pose - 相机目标位置</span><br/><span class="hl-4">// params duration - 动画触发的时常</span><br/><span class="hl-4">// params Promise - 是否移动成功</span><br/><span class="hl-5">updateCamera</span><span class="hl-0">(</span><span class="hl-2">pose</span><span class="hl-0">: </span><span class="hl-2">Pose</span><span class="hl-0">, </span><span class="hl-2">duration</span><span class="hl-0">: </span><span class="hl-2">number</span><span class="hl-0">): </span><span class="hl-8">Promise</span><span class="hl-0">&lt;</span><span class="hl-7">void</span><span class="hl-0">&gt;</span>
48
+ </code></pre>
49
+ </dd><dt>function</dt><dd><p>initBasisLoader</p>
50
+ <pre><code><span class="hl-2">初始化</span><span class="hl-0"> </span><span class="hl-2">initBasisLoader</span><br/><span class="hl-2">同初始化的</span><span class="hl-0"> </span><span class="hl-2">initBasisLoader</span><span class="hl-0"> </span><span class="hl-2">参数</span><span class="hl-0">。</span><span class="hl-2">用于初始化</span><span class="hl-0"> </span><span class="hl-2">basisLoader</span><span class="hl-0">。</span><br/><span class="hl-2">basisLoader</span><span class="hl-0"> </span><span class="hl-2">只会初始化一次</span><span class="hl-0">，</span><span class="hl-2">一旦初始化则不会再修改</span><span class="hl-0">。</span><br/><br/><span class="hl-4">// param transcoderResourcePath</span><br/><span class="hl-4">// 如果不设置，使用默认解析器 basis 解析器。</span><br/><span class="hl-4">// 可以传入解析器的 `resourcePath`, 则使用指定的解析器</span><br/><span class="hl-5">initBasisLoader</span><span class="hl-0">(</span><span class="hl-2">transcoderResourcePath</span><span class="hl-0">?: </span><span class="hl-2">string</span><span class="hl-0">): </span><span class="hl-7">void</span><span class="hl-0">,</span>
51
+ </code></pre>
52
+ </dd><dt>function</dt><dd><p>getPixels</p>
53
+ <pre><code><span class="hl-2">获取画面中的像素颜色</span><br/><span class="hl-4">// param x - 获取像素区域的起始坐标 x</span><br/><span class="hl-4">// param y - 获取像素区域的起始坐标 y</span><br/><span class="hl-4">// param width - 获取像素区域的宽度</span><br/><span class="hl-4">// param height - 获取像素区域的高度</span><br/><span class="hl-4">// param pixelRatio - 获取区域的像素比</span><br/><span class="hl-4">// returns rgba颜色平铺的 Uint8Array</span><br/><span class="hl-5">getPixels</span><span class="hl-0">(</span><span class="hl-2">x</span><span class="hl-0">: </span><span class="hl-2">number</span><span class="hl-0">, </span><span class="hl-2">y</span><span class="hl-0">: </span><span class="hl-2">number</span><span class="hl-0">, </span><span class="hl-2">width</span><span class="hl-0">: </span><span class="hl-2">number</span><span class="hl-0">, </span><span class="hl-2">height</span><span class="hl-0">: </span><span class="hl-2">number</span><span class="hl-0">, </span><span class="hl-2">pixelRatio</span><span class="hl-0">?: </span><span class="hl-2">number</span><span class="hl-0">): </span><span class="hl-8">Uint8Array</span><span class="hl-0">,</span>
54
+ </code></pre>
55
+ </dd><dt>function</dt><dd><p>render</p>
56
+ <pre><code><span class="hl-2">强制渲染</span><br/><span class="hl-2">调用</span><span class="hl-0"> </span><span class="hl-5">render</span><span class="hl-0">() </span><span class="hl-2">和</span><span class="hl-0"> </span><span class="hl-5">needsRender</span><span class="hl-0">() </span><span class="hl-2">均可在按需渲染时</span><span class="hl-0">，</span><span class="hl-2">使得画面渲染一次</span><br/><span class="hl-2">区别在于</span><span class="hl-0">：</span><br/><span class="hl-0">- </span><span class="hl-5">needsRender</span><span class="hl-0">() </span><span class="hl-2">为在下帧渲染画面</span><br/><span class="hl-0">- </span><span class="hl-5">render</span><span class="hl-0">() </span><span class="hl-2">在当前帧渲染画面</span><br/><span class="hl-2">推荐使用</span><span class="hl-0"> </span><span class="hl-5">needsRender</span><span class="hl-0">(), </span><span class="hl-2">可以更加流畅</span><span class="hl-0">。</span><span class="hl-2">但是如果需要截图等同步操作</span><span class="hl-0">，</span><span class="hl-2">可以使用</span><span class="hl-0"> </span><span class="hl-5">render</span><span class="hl-0">()</span><br/><br/><span class="hl-4">// param callback 渲染完成回调</span><br/><span class="hl-5">render</span><span class="hl-0">(</span><span class="hl-2">callback</span><span class="hl-0">?: () </span><span class="hl-7">=&gt;</span><span class="hl-0"> </span><span class="hl-7">void</span><span class="hl-0">): </span><span class="hl-7">void</span><span class="hl-0">,</span>
57
+ </code></pre>
58
+ </dd><dt>function</dt><dd><p>needsRender</p>
59
+ <pre><code><span class="hl-2">下一帧渲染</span><br/><span class="hl-2">调用</span><span class="hl-0"> </span><span class="hl-5">render</span><span class="hl-0">() </span><span class="hl-2">和</span><span class="hl-0"> </span><span class="hl-5">needsRender</span><span class="hl-0">() </span><span class="hl-2">均可在按需渲染时</span><span class="hl-0">，</span><span class="hl-2">使得画面渲染一次</span><br/><span class="hl-2">区别在于</span><span class="hl-0">：</span><br/><span class="hl-0">- </span><span class="hl-5">needsRender</span><span class="hl-0">() </span><span class="hl-2">为在下帧渲染画面</span><br/><span class="hl-0">- </span><span class="hl-5">render</span><span class="hl-0">() </span><span class="hl-2">在当前帧渲染画面</span><br/><span class="hl-2">推荐使用</span><span class="hl-0"> </span><span class="hl-5">needsRender</span><span class="hl-0">(), </span><span class="hl-2">可以更加流畅</span><span class="hl-0">。</span><span class="hl-2">但是如果需要截图等同步操作</span><span class="hl-0">，</span><span class="hl-2">可以使用</span><span class="hl-0"> </span><span class="hl-5">render</span><span class="hl-0">()</span><br/><span class="hl-5">needsRender</span><span class="hl-0">(): </span><span class="hl-7">void</span><span class="hl-0">,</span>
60
+ </code></pre>
61
+ </dd><dt>function</dt><dd><p>preloadPano</p>
62
+ <pre><code><span class="hl-2">预加载点位图片资源</span><br/><span class="hl-4">// param panoIndex - 观察点序号</span><br/><span class="hl-4">// param callback - 加载完成回调, 并传递加载用时。</span><br/><span class="hl-4">// returns 加载完成的 Promise 参数同 callback</span><br/><span class="hl-5">preloadPano</span><span class="hl-0">(</span><span class="hl-2">panoIndex</span><span class="hl-0">: </span><span class="hl-2">number</span><span class="hl-0">, </span><span class="hl-2">callback</span><span class="hl-0">?: (</span><span class="hl-2">costs</span><span class="hl-0">: </span><span class="hl-8">number</span><span class="hl-0">) </span><span class="hl-7">=&gt;</span><span class="hl-0"> </span><span class="hl-7">void</span><span class="hl-0">): </span><span class="hl-8">Promise</span><span class="hl-0">&lt;</span><span class="hl-2">number</span><span class="hl-0">&gt;</span>
63
+ </code></pre>
64
+ </dd><dt>example</dt><dd><pre><code><span class="hl-7">const</span><span class="hl-0"> { </span><span class="hl-6">updateCamera</span><span class="hl-0">, </span><span class="hl-6">initBasisLoader</span><span class="hl-0">, </span><span class="hl-6">getPixels</span><span class="hl-0">, </span><span class="hl-6">render</span><span class="hl-0">, </span><span class="hl-6">needsRender</span><span class="hl-0">, </span><span class="hl-6">preloadPano</span><span class="hl-0"> } = </span><span class="hl-5">useFiveAction</span><span class="hl-0">();</span>
65
+ </code></pre>
66
+ </dd></dl></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/react.FiveActionReactCallbacks.html" class="tsd-signature-type" data-tsd-kind="Interface">FiveActionReactCallbacks</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveCameraDirection" class="tsd-anchor"></a><h3>use<wbr/>Five<wbr/>Camera<wbr/>Direction</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Camera<wbr/>Direction<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">THREE.Vector3</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveCameraDirection.ts:14</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
67
+ <p>Five React Hooks: 得到当前相机的方向（单位向量）</p>
68
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">THREE.Vector3</span></h4><div><p>当前相机的方向的单位向量</p>
69
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveCameraRaycaster" class="tsd-anchor"></a><h3>use<wbr/>Five<wbr/>Camera<wbr/>Raycaster</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Camera<wbr/>Raycaster<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">THREE.Raycaster</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveCameraRaycaster.ts:16</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
70
+ <p>Five React Hooks: 得到当前相机的方向（射线对象）</p>
71
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">THREE.Raycaster</span></h4><div><p>当前相机的方向的射线对象</p>
72
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveCurrentObserver" class="tsd-anchor"></a><h3>use<wbr/>Five<wbr/>Current<wbr/>Observer</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Current<wbr/>Observer<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">[</span><a href="../classes/five.Work.html#observers"><span class="tsd-signature-type">&quot;observers&quot;</span></a><span class="tsd-signature-symbol">]</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">null</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveCurrentObserver.ts:13</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
73
+ <p>Five React Hooks: Five 的当前观测点</p>
74
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-7">const</span><span class="hl-0"> </span><span class="hl-6">observer</span><span class="hl-0"> = </span><span class="hl-5">useFiveCurrentObserver</span><span class="hl-0">();</span>
75
+ </code></pre>
76
+ </dd></dl></div><h4 class="tsd-returns-title">Returns <a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">[</span><a href="../classes/five.Work.html#observers"><span class="tsd-signature-type">&quot;observers&quot;</span></a><span class="tsd-signature-symbol">]</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">null</span></h4><div><p>Work.observers[number] 当前观测点, 如果 work 未加载则为 null</p>
77
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveCurrentState" class="tsd-anchor"></a><h3>use<wbr/>Five<wbr/>Current<wbr/>State</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Current<wbr/>State<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span>currentState<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">, </span>setState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>prevState<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span>, immediately<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, userAction<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveCurrentState.ts:14</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
78
+ <p>Five React Hooks: Five 的实时状态</p>
79
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-7">const</span><span class="hl-0"> [ </span><span class="hl-6">currentState</span><span class="hl-0">, </span><span class="hl-6">setState</span><span class="hl-0"> ] = </span><span class="hl-2">useFiveCurrentState</span><span class="hl-0">;</span>
80
+ </code></pre>
81
+ </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span>currentState<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">, </span>setState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>prevState<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span>, immediately<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, userAction<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></h4><div><p>[ currentState: Five 的实时状态, setState: 设置 Five 的状态 ]</p>
82
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a id="useFiveEventCallback" class="tsd-anchor"></a><h3>use<wbr/>Five<wbr/>Event<wbr/>Callback</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Event<wbr/>Callback<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, callback<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.EventCallback.html" class="tsd-signature-type" data-tsd-kind="Interface">EventCallback</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">]</span>, deps<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DependencyList</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveEventCallback.ts:13</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
83
+ <p>Five React Hooks: Five 事件监听
84
+ 具体事件列表 请查看 Five.EventCallback</p>
85
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-5">useFiveEvent</span><span class="hl-0">(</span><span class="hl-3">&quot;cameraUpdate&quot;</span><span class="hl-0">, </span><span class="hl-2">pose</span><span class="hl-0"> </span><span class="hl-7">=&gt;</span><span class="hl-0"> {});</span>
86
+ </code></pre>
87
+ </dd></dl></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><a href="../interfaces/five.EventCallback.html" class="tsd-signature-type" data-tsd-kind="Interface">EventCallback</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li><li><h5>callback: <a href="../interfaces/five.EventCallback.html" class="tsd-signature-type" data-tsd-kind="Interface">EventCallback</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">]</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> deps: <span class="tsd-signature-type">DependencyList</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveFloor" class="tsd-anchor"></a><h3>use<wbr/>Five<wbr/>Floor</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Floor<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span>shownFloor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">, </span>totalFloorLength<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span>showFloor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>floorIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveFloor.ts:15</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
88
+ <p>Five React Hooks: Five 楼层</p>
89
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-7">const</span><span class="hl-0"> [ </span><span class="hl-6">shownFloor</span><span class="hl-0">, </span><span class="hl-6">showFloor</span><span class="hl-0"> ] = </span><span class="hl-2">useFiveHelper</span><span class="hl-0">;</span>
90
+ </code></pre>
91
+ </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span>shownFloor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">, </span>totalFloorLength<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span>showFloor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>floorIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></h4><div><p>[ shownFloor: Five 当前显示的楼层， null 为都显示, showFloor: 设置显示楼层，不传参数为都显示 ]</p>
92
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveHelper" class="tsd-anchor"></a><h3>use<wbr/>Five<wbr/>Helper</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Helper<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span>helperVisible<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span>toggleHelperVisible<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>visible<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveHelper.ts:14</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
93
+ <p>Five React Hooks: Five 帮助元素的隐藏/显示</p>
94
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-7">const</span><span class="hl-0"> [ </span><span class="hl-6">helperVisible</span><span class="hl-0">, </span><span class="hl-6">toggleHelperVisible</span><span class="hl-0"> ] = </span><span class="hl-2">useFiveHelper</span><span class="hl-0">;</span>
95
+ </code></pre>
96
+ </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span>helperVisible<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">, </span>toggleHelperVisible<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>visible<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></h4><div><p>[ helperVisible: Five 帮助元素是否显示显示, toggleHelperVisible: 设置 帮助元素的隐藏/显示 ]</p>
97
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveModelIntersectRaycaster" class="tsd-anchor"></a><h3>use<wbr/>Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>raycaster<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveModelIntersectRaycaster.ts:24</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
98
+ <p>Five React Hooks: 获取当前模型碰撞检测方法</p>
99
+ </div><dl class="tsd-comment-tags"><dt>function</dt><dd><p>fiveModelIntersectRaycaster</p>
100
+ <pre><code><span class="hl-2">计算模型射线碰撞检测</span><br/><span class="hl-4">// param raycaster THREE 射线对象</span><br/><span class="hl-4">// param floors 和某一楼层做碰撞检测， 不传为和所有楼层做碰撞检测</span><br/><span class="hl-4">// returns 返回碰撞</span><br/><span class="hl-5">intersectRaycaster</span><span class="hl-0">(</span><span class="hl-2">raycaster</span><span class="hl-0">: </span><span class="hl-6">THREE</span><span class="hl-0">.</span><span class="hl-2">Raycaster</span><span class="hl-0">, </span><span class="hl-2">floors</span><span class="hl-0">?: </span><span class="hl-2">number</span><span class="hl-0"> | </span><span class="hl-2">number</span><span class="hl-0">[]): </span><span class="hl-2">Intersection</span><span class="hl-0">[]</span>
101
+ </code></pre>
102
+ </dd><dt>example</dt><dd><pre><code><span class="hl-7">const</span><span class="hl-0"> </span><span class="hl-6">fiveModelIntersectRaycaster</span><span class="hl-0"> = </span><span class="hl-5">useFiveModelIntersectRaycaster</span><span class="hl-0">();</span><br/><span class="hl-7">const</span><span class="hl-0"> </span><span class="hl-6">intersects</span><span class="hl-0"> = </span><span class="hl-5">fiveModelIntersectRaycaster</span><span class="hl-0">(</span><span class="hl-2">raycaster</span><span class="hl-0">);</span>
103
+ </code></pre>
104
+ </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>raycaster<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>raycaster<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>raycaster: <span class="tsd-signature-type">Raycaster</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveModelReadyState" class="tsd-anchor"></a><h3>use<wbr/>Five<wbr/>Model<wbr/>Ready<wbr/>State</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Ready<wbr/>State<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;Loaded&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;Empty&quot;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveModelReadyState.ts:15</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
105
+ <p>Five React Hooks: 获取当前模型加载状态</p>
106
+ </div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;Loaded&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;Empty&quot;</span></h4><div><p>&quot;Loaded&quot;: 加载完成
107
+ &quot;Empty&quot; 加载未完成</p>
108
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveProject2d" class="tsd-anchor"></a><h3>use<wbr/>Five<wbr/>Project2d</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Project2d<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>vector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Vector3</span>, testModel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Vector2</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveProject2d.ts:22</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
109
+ <p>Five React Hooks: 将三维的坐标对应到而为屏幕</p>
110
+ </div><dl class="tsd-comment-tags"><dt>function</dt><dd><p>preject2d</p>
111
+ <pre><code><span class="hl-2">计算模型射线碰撞检测</span><br/><span class="hl-4">// param vector 三维的坐标</span><br/><span class="hl-4">// param testModel 是否和模型检测，如果检测，则被模型遮挡会返回 null</span><br/><span class="hl-4">// returns 三维的坐标 或者 null</span><br/><span class="hl-5">preject2d</span><span class="hl-0">(</span><span class="hl-2">vector</span><span class="hl-0">: </span><span class="hl-6">THREE</span><span class="hl-0">.</span><span class="hl-2">Vector3</span><span class="hl-0">, </span><span class="hl-2">testModel</span><span class="hl-0">: </span><span class="hl-2">boolean</span><span class="hl-0">): </span><span class="hl-6">THREE</span><span class="hl-0">.</span><span class="hl-2">Vector2</span><span class="hl-0"> ｜ </span><span class="hl-7">null</span>
112
+ </code></pre>
113
+ </dd><dt>example</dt><dd><pre><code><span class="hl-7">const</span><span class="hl-0"> </span><span class="hl-6">preject2d</span><span class="hl-0"> = </span><span class="hl-5">useFiveProject2d</span><span class="hl-0">();</span><br/><span class="hl-7">const</span><span class="hl-0"> { </span><span class="hl-2">x</span><span class="hl-0">: </span><span class="hl-6">width</span><span class="hl-0">, </span><span class="hl-2">y</span><span class="hl-0">: </span><span class="hl-6">height</span><span class="hl-0"> } = </span><span class="hl-5">preject2d</span><span class="hl-0">(</span><span class="hl-7">new</span><span class="hl-0"> </span><span class="hl-6">THREE</span><span class="hl-0">.</span><span class="hl-5">Vector3</span><span class="hl-0">(</span><span class="hl-13">0</span><span class="hl-0">, </span><span class="hl-13">0</span><span class="hl-0">, </span><span class="hl-13">0</span><span class="hl-0">));</span>
114
+ </code></pre>
115
+ </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span>vector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Vector3</span>, testModel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Vector2</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>vector<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Vector3</span>, testModel<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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>vector: <span class="tsd-signature-type">Vector3</span></h5></li><li><h5>testModel: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Vector2</span></h4></li></ul></li></ul></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveScene" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagConst">Const</span> use<wbr/>Five<wbr/>Scene</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Scene<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>scene<span class="tsd-signature-symbol">: </span><a href="../classes/five.Scene.html" class="tsd-signature-type" data-tsd-kind="Class">Scene</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span>, deps<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DependencyList</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveSceneEffect.ts:30</li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>deprecated</dt><dd><p>请使用 <code>useFiveSceneEffect</code> 替代</p>
116
+ </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>callback: <span class="tsd-signature-symbol">(</span>scene<span class="tsd-signature-symbol">: </span><a href="../classes/five.Scene.html" class="tsd-signature-type" data-tsd-kind="Class">Scene</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>scene<span class="tsd-signature-symbol">: </span><a href="../classes/five.Scene.html" class="tsd-signature-type" data-tsd-kind="Class">Scene</a><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-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>scene: <a href="../classes/five.Scene.html" class="tsd-signature-type" data-tsd-kind="Class">Scene</a></h5></li></ul><h4 class="tsd-returns-title">Returns <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-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4></li></ul></li></ul></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> deps: <span class="tsd-signature-type">DependencyList</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveSceneEffect" class="tsd-anchor"></a><h3>use<wbr/>Five<wbr/>Scene<wbr/>Effect</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Scene<wbr/>Effect<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>scene<span class="tsd-signature-symbol">: </span><a href="../classes/five.Scene.html" class="tsd-signature-type" data-tsd-kind="Class">Scene</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span>, deps<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DependencyList</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveSceneEffect.ts:17</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
117
+ <p>Five React Hooks: 操作 Five 的 Scene</p>
118
+ </div><dl class="tsd-comment-tags"><dt>example</dt><dd><pre><code><span class="hl-5">useFiveSceneEffect</span><span class="hl-0">(</span><span class="hl-2">scene</span><span class="hl-0"> </span><span class="hl-7">=&gt;</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-4">// object is a THREE.Object3D</span><br/><span class="hl-0"> </span><span class="hl-2">scene</span><span class="hl-0">.</span><span class="hl-5">add</span><span class="hl-0">(</span><span class="hl-2">object</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-1">return</span><span class="hl-0"> () </span><span class="hl-7">=&gt;</span><span class="hl-0"> </span><span class="hl-2">scene</span><span class="hl-0">.</span><span class="hl-5">remove</span><span class="hl-0">(</span><span class="hl-2">object</span><span class="hl-0">); </span><span class="hl-4">// 析构函数</span><br/><span class="hl-0">});</span>
119
+ </code></pre>
120
+ </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>callback: <span class="tsd-signature-symbol">(</span>scene<span class="tsd-signature-symbol">: </span><a href="../classes/five.Scene.html" class="tsd-signature-type" data-tsd-kind="Class">Scene</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
121
+ <p>获取 Five 的 Scene 的回调函数</p>
122
+ </div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>scene<span class="tsd-signature-symbol">: </span><a href="../classes/five.Scene.html" class="tsd-signature-type" data-tsd-kind="Class">Scene</a><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-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>scene: <a href="../classes/five.Scene.html" class="tsd-signature-type" data-tsd-kind="Class">Scene</a></h5></li></ul><h4 class="tsd-returns-title">Returns <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-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4></li></ul></li></ul></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> deps: <span class="tsd-signature-type">DependencyList</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveState" class="tsd-anchor"></a><h3>use<wbr/>Five<wbr/>State</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>State<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">, </span>setState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>prevState<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span>, immediately<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, userAction<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveState.ts:19</li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">, </span>setState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>prevState<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span>, immediately<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, userAction<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="useFiveWork" class="tsd-anchor"></a><h3>use<wbr/>Five<wbr/>Work</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">use<wbr/>Five<wbr/>Work<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span>work<span class="tsd-signature-symbol">: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">, </span>loadWork<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>work<span class="tsd-signature-symbol">: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a>, state<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;inherit&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;initial&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;offset&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span>, duration<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, userAction<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/hooks/useFiveWork.ts:28</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
123
+ <p>Five React Hooks: 获取/设置当前的 Work</p>
124
+ </div><dl class="tsd-comment-tags"><dt>function</dt><dd><p>loadWork</p>
125
+ <pre><code><span class="hl-2">加载</span><span class="hl-0"> </span><span class="hl-2">Work</span><span class="hl-0"> </span><span class="hl-2">数据</span><br/><span class="hl-4">// param work Work 数据</span><br/><span class="hl-4">// param state 初始化姿态</span><br/><span class="hl-4">// - &quot;inherit&quot; 使用当前姿态</span><br/><span class="hl-4">// - &quot;initial&quot; 使用 Work 数据中的 initial 姿态</span><br/><span class="hl-4">// - State 自定义姿态</span><br/><span class="hl-4">// param duration 切换时间</span><br/><span class="hl-0">(</span><span class="hl-2">work</span><span class="hl-0">: </span><span class="hl-8">Work</span><span class="hl-0">, </span><span class="hl-2">state</span><span class="hl-0">?: </span><span class="hl-3">&quot;inherit&quot;</span><span class="hl-0"> | </span><span class="hl-3">&quot;initial&quot;</span><span class="hl-0"> | </span><span class="hl-8">Partial</span><span class="hl-0">&lt;</span><span class="hl-8">Omit</span><span class="hl-0">&lt;</span><span class="hl-8">State</span><span class="hl-0">, </span><span class="hl-3">&quot;offset&quot;</span><span class="hl-0">&gt;&gt;, </span><span class="hl-2">duration</span><span class="hl-0">?: </span><span class="hl-8">number</span><span class="hl-0">) </span><span class="hl-7">=&gt;</span><span class="hl-0"> </span><span class="hl-7">void</span>
126
+ </code></pre>
127
+ </dd><dt>example</dt><dd><pre><code><span class="hl-7">const</span><span class="hl-0"> [ </span><span class="hl-6">work</span><span class="hl-0">, </span><span class="hl-6">loadWork</span><span class="hl-0"> ] = </span><span class="hl-2">useFiveWork</span><span class="hl-0">;</span>
128
+ </code></pre>
129
+ </dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span>work<span class="tsd-signature-symbol">: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">, </span>loadWork<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>work<span class="tsd-signature-symbol">: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a>, state<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;inherit&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;initial&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;offset&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span>, duration<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, userAction<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">]</span></h4><div><p>[ work: 获取当前的 Work, loadWork: 设置 Work ]</p>
130
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a id="withFive" class="tsd-anchor"></a><h3>with<wbr/>Five</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">with<wbr/>Five<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>features<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>Component<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;$five&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;setState&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;state&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;render&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentDidMount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;shouldComponentUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillUnmount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentDidCatch&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;getSnapshotBeforeUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentDidUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillMount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;UNSAFE_componentWillMount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillReceiveProps&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;UNSAFE_componentWillReceiveProps&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;UNSAFE_componentWillUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;context&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;forceUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;props&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;refs&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.tsx:578</li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>F<span class="tsd-signature-symbol">: </span><a href="react.html#FiveInjectionFeature" class="tsd-signature-type" data-tsd-kind="Type alias">FiveInjectionFeature</a><span class="tsd-signature-symbol">[]</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>features: <span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>Component<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;$five&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;setState&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;state&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;render&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentDidMount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;shouldComponentUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillUnmount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentDidCatch&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;getSnapshotBeforeUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentDidUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillMount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;UNSAFE_componentWillMount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillReceiveProps&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;UNSAFE_componentWillReceiveProps&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;UNSAFE_componentWillUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;context&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;forceUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;props&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;refs&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>Component<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;$five&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;setState&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;state&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;render&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentDidMount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;shouldComponentUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillUnmount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentDidCatch&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;getSnapshotBeforeUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentDidUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillMount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;UNSAFE_componentWillMount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillReceiveProps&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;UNSAFE_componentWillReceiveProps&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;UNSAFE_componentWillUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;context&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;forceUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;props&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;refs&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>P<span class="tsd-signature-symbol">: </span><a href="../interfaces/react.PropTypeOfFiveFeatures.html" class="tsd-signature-type" data-tsd-kind="Interface">PropTypeOfFiveFeatures</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">&gt;</span></h4></li><li><h4>C<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>Component: <span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;$five&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;setState&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;state&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;render&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentDidMount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;shouldComponentUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillUnmount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentDidCatch&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;getSnapshotBeforeUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentDidUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillMount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;UNSAFE_componentWillMount&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillReceiveProps&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;UNSAFE_componentWillReceiveProps&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;componentWillUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;UNSAFE_componentWillUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;context&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;forceUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;props&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;refs&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="five.html">five</a></li><li class=" tsd-kind-module"><a href="gltf_loader.html">gltf-<wbr/>loader</a></li><li class=" tsd-kind-module"><a href="line.html">line</a></li><li class="current tsd-kind-module"><a href="react.html">react</a></li><li class=" tsd-kind-module"><a href="server.html">server</a></li><li class=" tsd-kind-module"><a href="sticker.html">sticker</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/react.Store.html" class="tsd-kind-icon">Store</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.FiveActionReactCallbacks.html" class="tsd-kind-icon">Five<wbr/>Action<wbr/>React<wbr/>Callbacks</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.FiveInjectionTypes.html" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Types</a></li><li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/react.PropTypeOfFiveFeatures.html" class="tsd-kind-icon">Prop<wbr/>Type<wbr/>Of<wbr/>Five<wbr/>Features</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveInjectionActionFeature" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Action<wbr/>Feature</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveInjectionDataFeature" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Data<wbr/>Feature</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveInjectionFeature" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Feature</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveProviderPropTypes" class="tsd-kind-icon">Five<wbr/>Provider<wbr/>Prop<wbr/>Types</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveProviderType" class="tsd-kind-icon">Five<wbr/>Provider<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#StoreActionMapHanlder" class="tsd-kind-icon">Store<wbr/>Action<wbr/>Map<wbr/>Hanlder</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#StoreActionMapType" class="tsd-kind-icon">Store<wbr/>Action<wbr/>Map<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#StoreProviderType" class="tsd-kind-icon">Store<wbr/>Provider<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#StoreValueMapType" class="tsd-kind-icon">Store<wbr/>Value<wbr/>Map<wbr/>Type</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="react.html#FiveCanvas" class="tsd-kind-icon">Five<wbr/>Canvas</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="react.html#INJECTION_PROPNAME" class="tsd-kind-icon">INJECTION_<wbr/>PROPNAME</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#createFiveFeature" class="tsd-kind-icon">create<wbr/>Five<wbr/>Feature</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#createFiveProvider" class="tsd-kind-icon">create<wbr/>Five<wbr/>Provider</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#createStore" class="tsd-kind-icon">create<wbr/>Store</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#unsafe__useFiveInstance" class="tsd-kind-icon">unsafe__use<wbr/>Five<wbr/>Instance</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveAction" class="tsd-kind-icon">use<wbr/>Five<wbr/>Action</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCameraDirection" class="tsd-kind-icon">use<wbr/>Five<wbr/>Camera<wbr/>Direction</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCameraRaycaster" class="tsd-kind-icon">use<wbr/>Five<wbr/>Camera<wbr/>Raycaster</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCurrentObserver" class="tsd-kind-icon">use<wbr/>Five<wbr/>Current<wbr/>Observer</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCurrentState" class="tsd-kind-icon">use<wbr/>Five<wbr/>Current<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#useFiveEventCallback" class="tsd-kind-icon">use<wbr/>Five<wbr/>Event<wbr/>Callback</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveFloor" class="tsd-kind-icon">use<wbr/>Five<wbr/>Floor</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveHelper" class="tsd-kind-icon">use<wbr/>Five<wbr/>Helper</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveModelIntersectRaycaster" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveModelReadyState" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Ready<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveProject2d" class="tsd-kind-icon">use<wbr/>Five<wbr/>Project2d</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveScene" class="tsd-kind-icon">use<wbr/>Five<wbr/>Scene</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveSceneEffect" class="tsd-kind-icon">use<wbr/>Five<wbr/>Scene<wbr/>Effect</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveState" class="tsd-kind-icon">use<wbr/>Five<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveWork" class="tsd-kind-icon">use<wbr/>Five<wbr/>Work</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#withFive" class="tsd-kind-icon">with<wbr/>Five</a></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>