@realsee/five 5.0.0-alpha.110 → 5.0.0-alpha.111

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 (104) hide show
  1. package/docs/assets/highlight.css +1 -1
  2. package/docs/assets/main.js +2 -2
  3. package/docs/assets/search.js +1 -1
  4. package/docs/assets/style.css +25 -0
  5. package/docs/classes/five.AnimationFrameLoop.html +2 -2
  6. package/docs/classes/five.BVH.html +2 -2
  7. package/docs/classes/five.BVHIntersect.html +1 -1
  8. package/docs/classes/five.BVHNode.html +2 -2
  9. package/docs/classes/five.BVHVector3.html +1 -1
  10. package/docs/classes/five.Camera.html +5 -5
  11. package/docs/classes/five.Five.html +49 -49
  12. package/docs/classes/five.InternalWebGLRenderer.html +1 -1
  13. package/docs/classes/five.IntersectMesh.html +1 -1
  14. package/docs/classes/five.LegacyPanoCircleMesh.html +3 -3
  15. package/docs/classes/five.Model.html +26 -26
  16. package/docs/classes/five.NetworkSubscribe.html +5 -5
  17. package/docs/classes/five.PBMContainer.html +8 -8
  18. package/docs/classes/five.PBMGroup.html +9 -9
  19. package/docs/classes/five.PBMMaterial.html +7 -7
  20. package/docs/classes/five.PBMMesh.html +3 -3
  21. package/docs/classes/five.PanoCircleMesh.html +4 -4
  22. package/docs/classes/five.Scene.html +2 -2
  23. package/docs/classes/five.Subscribe.html +6 -6
  24. package/docs/classes/five.Work.html +11 -11
  25. package/docs/classes/gltf_loader.GLTFLoader.html +4 -4
  26. package/docs/classes/gltf_loader.GLTFObject.html +3 -3
  27. package/docs/classes/line.Line.html +1 -1
  28. package/docs/classes/line.LineGeometry.html +1 -1
  29. package/docs/classes/line.LineMaterial.html +1 -1
  30. package/docs/classes/line.LineSegmentsGeometry.html +1 -1
  31. package/docs/classes/line.THREE_Line2.html +1 -1
  32. package/docs/classes/line.THREE_LineSegments2.html +1 -1
  33. package/docs/classes/react.Store.html +6 -6
  34. package/docs/classes/server.BVH.html +1 -1
  35. package/docs/classes/server.BVHIntersect.html +1 -1
  36. package/docs/classes/server.BVHNode.html +2 -2
  37. package/docs/classes/server.BVHVector3.html +1 -1
  38. package/docs/classes/server.Model.html +20 -20
  39. package/docs/classes/server.PBMGroup.html +4 -4
  40. package/docs/classes/server.PBMMesh.html +3 -3
  41. package/docs/classes/sticker.Sticker.html +6 -6
  42. package/docs/index.html +1 -1
  43. package/docs/interfaces/five.AddableObject.html +1 -1
  44. package/docs/interfaces/five.AnimationFrame.html +1 -1
  45. package/docs/interfaces/five.CameraPose.html +1 -1
  46. package/docs/interfaces/five.DepthPanoramaControllerCustomInitArgs.html +12 -12
  47. package/docs/interfaces/five.EventCallback.html +61 -61
  48. package/docs/interfaces/five.FiveInitArgs.html +23 -23
  49. package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +7 -7
  50. package/docs/interfaces/five.ImageOptions.html +6 -6
  51. package/docs/interfaces/five.ImageURLOptions.html +7 -7
  52. package/docs/interfaces/five.IntersectMeshInterface.html +2 -2
  53. package/docs/interfaces/five.Intersection.html +3 -3
  54. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +9 -9
  55. package/docs/interfaces/five.ModelEventCallback.html +7 -7
  56. package/docs/interfaces/five.MovePanoOptions.html +11 -11
  57. package/docs/interfaces/five.PBMPanoPicture.html +3 -3
  58. package/docs/interfaces/five.PBMParameters.html +7 -7
  59. package/docs/interfaces/five.PanoCircleMeshInterface.html +5 -5
  60. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +12 -12
  61. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +9 -9
  62. package/docs/interfaces/five.Pose.html +5 -5
  63. package/docs/interfaces/five.Scissor.html +5 -5
  64. package/docs/interfaces/five.State.html +7 -7
  65. package/docs/interfaces/five.SubscribeMixinType.emit.html +1 -1
  66. package/docs/interfaces/five.SubscribeMixinType.hasListener.html +1 -1
  67. package/docs/interfaces/five.SubscribeMixinType.off.html +1 -1
  68. package/docs/interfaces/five.SubscribeMixinType.on.html +1 -1
  69. package/docs/interfaces/five.SubscribeMixinType.once.html +1 -1
  70. package/docs/interfaces/five.TextureOptions.html +7 -7
  71. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +3 -3
  72. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +10 -10
  73. package/docs/interfaces/five.WorkCubeImage.html +6 -6
  74. package/docs/interfaces/five.WorkImage.html +10 -10
  75. package/docs/interfaces/five.WorkInitial.html +6 -6
  76. package/docs/interfaces/five.WorkModel.html +5 -5
  77. package/docs/interfaces/five.WorkObserver.html +12 -12
  78. package/docs/interfaces/five.WorkTile.html +1 -1
  79. package/docs/interfaces/five.WorkVideo.html +4 -4
  80. package/docs/interfaces/gltf_loader.GLTF.html +2 -2
  81. package/docs/interfaces/react.FiveActionReactCallbacks.html +7 -7
  82. package/docs/interfaces/react.FiveInjectionTypes.html +19 -19
  83. package/docs/interfaces/react.PropTypeOfFiveFeatures.html +1 -1
  84. package/docs/interfaces/server.Intersection.html +3 -3
  85. package/docs/interfaces/server.ModelEventCallback.html +6 -6
  86. package/docs/interfaces/sticker.IntersectionLike.html +3 -3
  87. package/docs/modules/five.SubscribeMixinType.html +1 -1
  88. package/docs/modules/five.html +10 -10
  89. package/docs/modules/gltf_loader.html +1 -1
  90. package/docs/modules/line.html +1 -1
  91. package/docs/modules/react.html +19 -19
  92. package/docs/modules/server.html +1 -1
  93. package/docs/modules/sticker.html +1 -1
  94. package/docs/modules.html +1 -1
  95. package/five/index.js +4 -4
  96. package/gltf-loader/index.js +2 -2
  97. package/line/index.js +2 -2
  98. package/package.json +3 -3
  99. package/react/index.js +3 -3
  100. package/scripts/five-staticify.js +1 -1
  101. package/server/index.js +3 -3
  102. package/sticker/index.js +2 -2
  103. package/umd/five-react.js +1 -1
  104. package/umd/five.js +1 -1
package/docs/modules/react.html CHANGED
@@ -1,4 +1,4 @@
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.110</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.110"/><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.110</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.110</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">
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.111</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.111"/><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.111</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.111</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 class="tsd-anchor-link">Five<wbr/>Injection<wbr/>Action<wbr/>Feature<a href="#FiveInjectionActionFeature" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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 class="tsd-anchor-link">Five<wbr/>Injection<wbr/>Data<wbr/>Feature<a href="#FiveInjectionDataFeature" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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 class="tsd-anchor-link">Five<wbr/>Injection<wbr/>Feature<a href="#FiveInjectionFeature" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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 class="tsd-anchor-link">Five<wbr/>Provider<wbr/>Prop<wbr/>Types<a href="#FiveProviderPropTypes" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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 class="tsd-anchor-link">Five<wbr/>Provider<wbr/>Type<a href="#FiveProviderType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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 class="tsd-anchor-link">Store<wbr/>Action<wbr/>Map<wbr/>Hanlder<a href="#StoreActionMapHanlder" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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 class="tsd-anchor-link">Store<wbr/>Action<wbr/>Map<wbr/>Type<a href="#StoreActionMapType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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 class="tsd-anchor-link">Store<wbr/>Provider<wbr/>Type<a href="#StoreProviderType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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 class="tsd-anchor-link">Store<wbr/>Value<wbr/>Map<wbr/>Type<a href="#StoreValueMapType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> Five<wbr/>Canvas<a href="#FiveCanvas" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
2
  <p>Five 渲染区域组件</p>
3
3
  </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>Five 渲染区域组件，请在 FiveProvider 内使用</p>
4
4
  </dd><dt>param width</dt><dd><p>渲染区域的宽度</p>
@@ -6,7 +6,7 @@
6
6
  </dd><dt>returns</dt><dd><p>React 元素</p>
7
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
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">
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 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> INJECTION_<wbr/>PROPNAME<a href="#INJECTION_PROPNAME" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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 class="tsd-anchor-link">create<wbr/>Five<wbr/>Feature<a href="#createFiveFeature" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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 class="tsd-anchor-link">create<wbr/>Five<wbr/>Provider<a href="#createFiveProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
10
  <p>创建一个 FiveProvider
11
11
  在 React 的体系下，使用 Provider 的方式来组织组件结构。
12
12
  在 FiveProvider 下，可以使用 FiveCanvas 来创建渲染画布。
@@ -16,7 +16,7 @@
16
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
17
  <p>Five 初始化参数</p>
18
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">
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 class="tsd-anchor-link">create<wbr/>Store<a href="#createStore" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
20
  <p>使用 Store</p>
21
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
22
  <p>获取的 Store 字段</p>
@@ -36,12 +36,12 @@
36
36
  <p>监听变化的回调函数</p>
37
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
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">
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 class="tsd-anchor-link">unsafe__use<wbr/>Five<wbr/>Instance<a href="#unsafe__useFiveInstance" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
40
  <p>Five React Hooks: 获取 five 实例</p>
41
41
  </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>不到万不得已，并不推荐直接使用。</p>
42
42
  </dd><dt>deprecated</dt><dd><p>不到万不得已，并不推荐直接使用。</p>
43
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">
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 class="tsd-anchor-link">use<wbr/>Five<wbr/>Action<a href="#useFiveAction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
45
  <p>Five React Hooks: 使用 Five 的命令</p>
46
46
  </div><dl class="tsd-comment-tags"><dt>function</dt><dd><p>updateCamera</p>
47
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>
@@ -63,63 +63,63 @@
63
63
  </code></pre>
64
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
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">
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 class="tsd-anchor-link">use<wbr/>Five<wbr/>Camera<wbr/>Direction<a href="#useFiveCameraDirection" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
67
  <p>Five React Hooks: 得到当前相机的方向（单位向量）</p>
68
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">
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 class="tsd-anchor-link">use<wbr/>Five<wbr/>Camera<wbr/>Raycaster<a href="#useFiveCameraRaycaster" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
70
  <p>Five React Hooks: 得到当前相机的方向（射线对象）</p>
71
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">
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 class="tsd-anchor-link">use<wbr/>Five<wbr/>Current<wbr/>Observer<a href="#useFiveCurrentObserver" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
73
  <p>Five React Hooks: Five 的当前观测点</p>
74
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
75
  </code></pre>
76
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">
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 class="tsd-anchor-link">use<wbr/>Five<wbr/>Current<wbr/>State<a href="#useFiveCurrentState" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
78
  <p>Five React Hooks: Five 的实时状态</p>
79
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
80
  </code></pre>
81
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">
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 class="tsd-anchor-link">use<wbr/>Five<wbr/>Event<wbr/>Callback<a href="#useFiveEventCallback" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
83
  <p>Five React Hooks: Five 事件监听
84
84
  具体事件列表 请查看 Five.EventCallback</p>
85
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
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">
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 class="tsd-anchor-link">use<wbr/>Five<wbr/>Floor<a href="#useFiveFloor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
88
  <p>Five React Hooks: Five 楼层</p>
89
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
90
  </code></pre>
91
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">
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 class="tsd-anchor-link">use<wbr/>Five<wbr/>Helper<a href="#useFiveHelper" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
93
  <p>Five React Hooks: Five 帮助元素的隐藏/显示</p>
94
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
95
  </code></pre>
96
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">
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 class="tsd-anchor-link">use<wbr/>Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster<a href="#useFiveModelIntersectRaycaster" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
98
  <p>Five React Hooks: 获取当前模型碰撞检测方法</p>
99
99
  </div><dl class="tsd-comment-tags"><dt>function</dt><dd><p>fiveModelIntersectRaycaster</p>
100
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
101
  </code></pre>
102
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
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">
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 class="tsd-anchor-link">use<wbr/>Five<wbr/>Model<wbr/>Ready<wbr/>State<a href="#useFiveModelReadyState" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
105
  <p>Five React Hooks: 获取当前模型加载状态</p>
106
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
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">
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 class="tsd-anchor-link">use<wbr/>Five<wbr/>Project2d<a href="#useFiveProject2d" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
109
  <p>Five React Hooks: 将三维的坐标对应到而为屏幕</p>
110
110
  </div><dl class="tsd-comment-tags"><dt>function</dt><dd><p>preject2d</p>
111
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
112
  </code></pre>
113
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
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">
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 class="tsd-anchor-link">use<wbr/>Five<wbr/>Scene<a href="#useFiveScene" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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 class="tsd-anchor-link">use<wbr/>Five<wbr/>Scene<wbr/>Effect<a href="#useFiveSceneEffect" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
117
  <p>Five React Hooks: 操作 Five 的 Scene</p>
118
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
119
  </code></pre>
120
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
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">
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 class="tsd-anchor-link">use<wbr/>Five<wbr/>State<a href="#useFiveState" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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 class="tsd-anchor-link">use<wbr/>Five<wbr/>Work<a href="#useFiveWork" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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
123
  <p>Five React Hooks: 获取/设置当前的 Work</p>
124
124
  </div><dl class="tsd-comment-tags"><dt>function</dt><dd><p>loadWork</p>
125
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>
@@ -127,4 +127,4 @@
127
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
128
  </code></pre>
129
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>
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 class="tsd-anchor-link">with<wbr/>Five<a href="#withFive" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></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>