@realsee/five 5.0.0-alpha.176 → 5.0.0-alpha.178
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/assets/search.js +1 -1
- package/docs/classes/five.AnimationFrameLoop.html +1 -1
- package/docs/classes/five.BVH.html +1 -1
- package/docs/classes/five.BVHIntersect.html +1 -1
- package/docs/classes/five.BVHNode.html +1 -1
- package/docs/classes/five.BVHVector3.html +1 -1
- package/docs/classes/five.Camera.html +5 -5
- package/docs/classes/five.Clipper.html +1 -1
- package/docs/classes/five.Five.html +54 -64
- package/docs/classes/five.InternalWebGLRenderer.html +1 -1
- package/docs/classes/five.IntersectMesh.html +1 -1
- package/docs/classes/five.Model.html +1 -1
- package/docs/classes/five.NetworkSubscribe.html +1 -1
- package/docs/classes/five.PBMContainer.html +1 -1
- package/docs/classes/five.PBMGroup.html +1 -1
- package/docs/classes/five.PBMMaterial.html +1 -1
- package/docs/classes/five.PBMMesh.html +1 -1
- package/docs/classes/five.PanoCircleMesh.html +1 -1
- package/docs/classes/five.PanoCircleMeshCustom.html +1 -1
- package/docs/classes/five.PanoCircleMeshSolid.html +1 -1
- package/docs/classes/five.Scene.html +1 -1
- package/docs/classes/five.Subscribe.html +1 -1
- package/docs/classes/five.TextureLoader.html +1 -1
- package/docs/classes/five.Tile3D.html +1 -1
- package/docs/classes/five.Tile3DModel.html +1 -1
- package/docs/classes/five.TileBoundingSphere.html +1 -1
- package/docs/classes/five.TileCacheNode.html +1 -1
- package/docs/classes/five.TileCubeTextureTarget.html +1 -1
- package/docs/classes/five.TileCullingVolume.html +1 -1
- package/docs/classes/five.TileOrientedBoundingBox.html +1 -1
- package/docs/classes/five.TileRequestScheduler.html +1 -1
- package/docs/classes/five.Tileset3D.html +1 -1
- package/docs/classes/five.Tileset3DTraverser.html +1 -1
- package/docs/classes/five.TilesetCache.html +1 -1
- package/docs/classes/five.Work.html +1 -1
- package/docs/classes/five.XRButton.html +1 -1
- package/docs/classes/gltf_loader.DDSLoader.html +1 -1
- package/docs/classes/gltf_loader.DRACOLoader.html +1 -1
- package/docs/classes/gltf_loader.GLTFLoader.html +1 -1
- package/docs/classes/gltf_loader.GLTFObject.html +1 -1
- package/docs/classes/gltf_loader.GLTFParser.html +1 -1
- package/docs/classes/gltf_loader.THREEGLTFLoader.html +1 -1
- package/docs/classes/line.Line.html +1 -1
- package/docs/classes/line.LineGeometry.html +1 -1
- package/docs/classes/line.LineMaterial.html +1 -1
- package/docs/classes/line.LineSegmentsGeometry.html +1 -1
- package/docs/classes/line.THREE_Line2.html +1 -1
- package/docs/classes/line.THREE_LineSegments2.html +1 -1
- package/docs/classes/react.Store.html +1 -1
- package/docs/classes/server.BVH.html +1 -1
- package/docs/classes/server.BVHIntersect.html +1 -1
- package/docs/classes/server.BVHNode.html +1 -1
- package/docs/classes/server.BVHVector3.html +1 -1
- package/docs/classes/server.Model.html +1 -1
- package/docs/classes/server.PBMContainer.html +1 -1
- package/docs/classes/server.PBMGroup.html +1 -1
- package/docs/classes/server.PBMMesh.html +1 -1
- package/docs/classes/sticker.Sticker.html +1 -1
- package/docs/classes/vfx.Airflow.html +1 -1
- package/docs/classes/vfx.Flame.html +1 -1
- package/docs/classes/vfx.Particle.html +1 -1
- package/docs/classes/vfx.SpotLight.html +1 -1
- package/docs/index.html +1 -1
- package/docs/interfaces/five.AddableObject.html +1 -1
- package/docs/interfaces/five.AnimationFrame.html +1 -1
- package/docs/interfaces/five.CameraPose.html +1 -1
- package/docs/interfaces/five.ClipperParameter.html +1 -1
- package/docs/interfaces/five.DepthPanoramaControllerCustomInitArgs.html +4 -4
- package/docs/interfaces/five.EventCallback.html +1 -1
- package/docs/interfaces/five.FiveInitArgs.html +1 -1
- package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +8 -8
- package/docs/interfaces/five.ImageOptions.html +1 -1
- package/docs/interfaces/five.ImageURLMappings.html +1 -1
- package/docs/interfaces/five.ImageURLOptions.html +7 -9
- package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
- package/docs/interfaces/five.Intersection.html +1 -1
- package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.ModelEventCallback.html +1 -1
- package/docs/interfaces/five.MotionKeyframe.html +1 -1
- package/docs/interfaces/five.MovePanoOptions.html +1 -1
- package/docs/interfaces/five.NetworkOptions.html +1 -1
- package/docs/interfaces/five.PBMPanoPicture.html +1 -1
- package/docs/interfaces/five.PBMParameters.html +1 -1
- package/docs/interfaces/five.PanoCircleMeshCustomOptions.html +1 -1
- package/docs/interfaces/five.PanoCircleMeshInterface.html +1 -1
- package/docs/interfaces/five.PanoCircleMeshOptions.html +1 -1
- package/docs/interfaces/five.PanoCircleMeshSolidOptions.html +1 -1
- package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +6 -6
- package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.Pose.html +1 -1
- package/docs/interfaces/five.Scissor.html +1 -1
- package/docs/interfaces/five.State.html +1 -1
- package/docs/interfaces/five.SubscribeMixinType.emit.html +1 -1
- package/docs/interfaces/five.SubscribeMixinType.hasListener.html +1 -1
- package/docs/interfaces/five.SubscribeMixinType.off.html +1 -1
- package/docs/interfaces/five.SubscribeMixinType.on.html +1 -1
- package/docs/interfaces/five.SubscribeMixinType.once.html +1 -1
- package/docs/interfaces/five.TextureOptions.html +1 -1
- package/docs/interfaces/five.Tile3DModelLoaderOptions.html +1 -1
- package/docs/interfaces/five.TileBoundingVolume.html +1 -1
- package/docs/interfaces/five.TileContent.html +1 -1
- package/docs/interfaces/five.TileCubeNode.html +1 -1
- package/docs/interfaces/five.TileCubeTree.html +1 -1
- package/docs/interfaces/five.Tileset3dOptions.html +1 -1
- package/docs/interfaces/five.TilesetJSON.html +1 -1
- package/docs/interfaces/five.TilesetJSONNode.html +1 -1
- package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +4 -4
- package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +6 -6
- package/docs/interfaces/five.WebXRSelectParams.html +1 -1
- package/docs/interfaces/five.WorkCubeImage.html +1 -1
- package/docs/interfaces/five.WorkImage.html +1 -1
- package/docs/interfaces/five.WorkInitial.html +1 -1
- package/docs/interfaces/five.WorkModel.html +1 -1
- package/docs/interfaces/five.WorkModelTiles.html +1 -1
- package/docs/interfaces/five.WorkObserver.html +1 -1
- package/docs/interfaces/five.WorkTile.html +1 -1
- package/docs/interfaces/five.WorkVideo.html +1 -1
- package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +6 -6
- package/docs/interfaces/gltf_loader.DDS.html +1 -1
- package/docs/interfaces/gltf_loader.GLTF.html +1 -1
- package/docs/interfaces/gltf_loader.GLTFReference.html +1 -1
- package/docs/interfaces/gltf_loader.THREEGLTF.html +1 -1
- package/docs/interfaces/react.FiveActionReactCallbacks.html +6 -16
- package/docs/interfaces/react.FiveInjectionTypes.html +19 -29
- package/docs/interfaces/react.PropTypeOfFiveFeatures.html +1 -1
- package/docs/interfaces/server.Intersection.html +1 -1
- package/docs/interfaces/server.ModelEventCallback.html +1 -1
- package/docs/interfaces/sticker.IntersectionLike.html +1 -1
- package/docs/interfaces/vfx.ParticleArgs.html +1 -1
- package/docs/interfaces/vfx.ParticleTweenKeyframe.html +1 -1
- package/docs/interfaces/vue.FiveActionVueCallbacks.html +7 -17
- package/docs/modules/five.SubscribeMixinType.html +1 -1
- package/docs/modules/five.html +3 -3
- package/docs/modules/gltf_loader.html +1 -1
- package/docs/modules/line.html +1 -1
- package/docs/modules/react.html +4 -7
- package/docs/modules/server.html +1 -1
- package/docs/modules/sticker.html +1 -1
- package/docs/modules/vfx.html +1 -1
- package/docs/modules/vue.html +2 -2
- package/docs/modules.html +1 -1
- package/five/index.d.ts +0 -24
- package/five/index.js +5 -5
- package/gltf-loader/index.js +3 -3
- package/line/index.js +3 -3
- package/package.json +1 -1
- package/react/index.d.ts +0 -52
- package/react/index.js +3 -3
- package/server/index.js +4 -4
- package/sticker/index.js +3 -3
- package/umd/five-gltf-loader.js +1 -1
- package/umd/five-line.js +1 -1
- package/umd/five-react.js +1 -1
- package/umd/five-sticker.js +1 -1
- package/umd/five-vue.js +1 -1
- package/umd/five.js +1 -1
- package/vfx/index.js +2 -2
- package/vue/index.d.ts +0 -20
- package/vue/index.js +3 -3
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.176</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.176"/><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.176</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.176</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">"loadWork"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setState"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"on"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"off"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"intersectRaycaster"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"project2d"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"updateCamera"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"initBasisLoader"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"getPixels"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"render"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"needsRender"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"preloadPano"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"showFloor"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"toggleHelperVisible"</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.ts: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">"unsafe__fiveInstance"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"currentState"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"currentObserver"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"state"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"work"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"model"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"scene"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"cameraDirection"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"cameraRaycaster"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"modelReadyState"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"shownFloor"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"totalFloorLength"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"helperVisible"</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.ts: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.ts: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">"inherit"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"initial"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><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-type">"offset"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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"><</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>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.ts: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">"inherit"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"initial"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><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-type">"offset"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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"><</span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">></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.ts: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.ts: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.ts: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.ts: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"><</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">></span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createProvider.ts:121</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"><</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">></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><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">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Pick</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><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span>, setValues<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"><</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-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>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</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">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><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">></span><span class="tsd-signature-symbol">)</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.ts: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"> extends </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"> extends </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"> extends </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.ts: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><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><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><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"><</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">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"StoreProvider"</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.ts: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"><</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">></span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.ts: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"><</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">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/canvas.ts: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.178</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.178"/><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.178</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.178</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">"loadWork"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setState"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"on"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"off"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"intersectRaycaster"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"project2d"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"updateCamera"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"initBasisLoader"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"getPixels"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"render"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"needsRender"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"preloadPano"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"showFloor"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"toggleHelperVisible"</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.ts: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">"unsafe__fiveInstance"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"currentState"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"currentObserver"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"state"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"work"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"model"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"scene"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"cameraDirection"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"cameraRaycaster"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"modelReadyState"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"shownFloor"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"totalFloorLength"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"helperVisible"</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.ts: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.ts: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">"inherit"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"initial"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><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-type">"offset"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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"><</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>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.ts: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">"inherit"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"initial"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><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-type">"offset"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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"><</span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">></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.ts: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.ts: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.ts: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.ts: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"><</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">></span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createProvider.ts:121</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"><</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">></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><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">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Pick</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><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span>, setValues<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"><</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-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>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Parameters</span><span class="tsd-signature-symbol"><</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">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</span><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">></span><span class="tsd-signature-symbol">)</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.ts: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"> extends </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"> extends </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"> extends </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.ts: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><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><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><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"><</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">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"StoreProvider"</span><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.ts: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"><</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">></span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.ts: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"><</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">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/canvas.ts: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"><</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">}></span><br/><span class="hl-0"> <</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">}/></span><br/><span class="hl-0"></</span><span class="hl-2">FiveProvider</span><span class="hl-0">></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 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">"$five"</span><span class="tsd-signature-symbol"> = "$five"</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.ts: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"><</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>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.ts:
|
|
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">"$five"</span><span class="tsd-signature-symbol"> = "$five"</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.ts: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"><</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>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.ts:643</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"> extends </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"><</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">"renderer"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"scissor"</span><span class="tsd-signature-symbol">></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.ts: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 来创建渲染画布。
|
|
@@ -44,14 +44,11 @@
|
|
|
44
44
|
</div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>不到万不得已,并不推荐直接使用。</p>
|
|
45
45
|
</dd><dt>deprecated</dt><dd><p>不到万不得已,并不推荐直接使用。</p>
|
|
46
46
|
</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>
|
|
47
|
-
</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:
|
|
47
|
+
</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:129</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
48
48
|
<p>Five React Hooks: 使用 Five 的命令</p>
|
|
49
49
|
</div><dl class="tsd-comment-tags"><dt>function</dt><dd><p>updateCamera</p>
|
|
50
50
|
<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"><</span><span class="hl-7">void</span><span class="hl-0">></span>
|
|
51
51
|
</code></pre>
|
|
52
|
-
</dd><dt>function</dt><dd><p>initBasisLoader</p>
|
|
53
|
-
<pre><code><span class="hl-2">初始化</span><span class="hl-0"> </span><span class="hl-2">initBasisLoader</span><br/><span class="hl-2">同初始化的</span><span class="hl-0"> </span><span class="hl-2">initBasisLoader</span><span class="hl-0"> </span><span class="hl-2">参数</span><span class="hl-0">。</span><span class="hl-2">用于初始化</span><span class="hl-0"> </span><span class="hl-2">basisLoader</span><span class="hl-0">。</span><br/><span class="hl-2">basisLoader</span><span class="hl-0"> </span><span class="hl-2">只会初始化一次</span><span class="hl-0">,</span><span class="hl-2">一旦初始化则不会再修改</span><span class="hl-0">。</span><br/><br/><span class="hl-4">// param transcoderResourcePath</span><br/><span class="hl-4">// 如果不设置,使用默认解析器 basis 解析器。</span><br/><span class="hl-4">// 可以传入解析器的 `resourcePath`, 则使用指定的解析器</span><br/><span class="hl-5">initBasisLoader</span><span class="hl-0">(</span><span class="hl-2">transcoderResourcePath</span><span class="hl-0">?: </span><span class="hl-2">string</span><span class="hl-0">): </span><span class="hl-7">void</span><span class="hl-0">,</span>
|
|
54
|
-
</code></pre>
|
|
55
52
|
</dd><dt>function</dt><dd><p>getPixels</p>
|
|
56
53
|
<pre><code><span class="hl-2">获取画面中的像素颜色</span><br/><span class="hl-4">// param x - 获取像素区域的起始坐标 x</span><br/><span class="hl-4">// param y - 获取像素区域的起始坐标 y</span><br/><span class="hl-4">// param width - 获取像素区域的宽度</span><br/><span class="hl-4">// param height - 获取像素区域的高度</span><br/><span class="hl-4">// param pixelRatio - 获取区域的像素比</span><br/><span class="hl-4">// returns rgba颜色平铺的 Uint8Array</span><br/><span class="hl-5">getPixels</span><span class="hl-0">(</span><span class="hl-2">x</span><span class="hl-0">: </span><span class="hl-2">number</span><span class="hl-0">, </span><span class="hl-2">y</span><span class="hl-0">: </span><span class="hl-2">number</span><span class="hl-0">, </span><span class="hl-2">width</span><span class="hl-0">: </span><span class="hl-2">number</span><span class="hl-0">, </span><span class="hl-2">height</span><span class="hl-0">: </span><span class="hl-2">number</span><span class="hl-0">, </span><span class="hl-2">pixelRatio</span><span class="hl-0">?: </span><span class="hl-2">number</span><span class="hl-0">): </span><span class="hl-8">Uint8Array</span><span class="hl-0">,</span>
|
|
57
54
|
</code></pre>
|
|
@@ -130,4 +127,4 @@
|
|
|
130
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>
|
|
131
128
|
</code></pre>
|
|
132
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><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">"inherit"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"initial"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><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-type">"offset"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span></h4><div><p>[ work: 获取当前的 Work, loadWork: 设置 Work ]</p>
|
|
133
|
-
</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"><</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>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">(</span><span class="tsd-signature-symbol"><</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">></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"> & </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</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-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"state"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setState"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"render"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUnmount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidCatch"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"context"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"forceUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"props"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"refs"</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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.ts: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"> extends </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">(</span><span class="tsd-signature-symbol"><</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">></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"> & </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</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-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"state"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setState"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"render"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUnmount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidCatch"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"context"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"forceUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"props"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"refs"</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></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"><</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">></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"> & </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</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-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"state"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setState"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"render"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUnmount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidCatch"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"context"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"forceUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"props"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"refs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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"> extends </span><a href="../interfaces/react.PropTypeOfFiveFeatures.html" class="tsd-signature-type" data-tsd-kind="Interface">PropTypeOfFiveFeatures</a><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-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">></span></h4></li><li><h4>C<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</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">></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"> & </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</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></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"state"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setState"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"render"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUnmount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidCatch"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"context"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"forceUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"props"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"refs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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><li class=" tsd-kind-module"><a href="vfx.html">vfx</a></li><li class=" tsd-kind-module"><a href="vue.html">vue</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"><</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>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">(</span><span class="tsd-signature-symbol"><</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">></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"> & </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</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-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"state"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setState"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"render"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUnmount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidCatch"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"context"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"forceUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"props"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"refs"</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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.ts:551</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"> extends </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">(</span><span class="tsd-signature-symbol"><</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">></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"> & </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</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-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"state"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setState"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"render"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUnmount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidCatch"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"context"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"forceUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"props"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"refs"</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></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"><</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">></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"> & </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</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-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"state"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setState"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"render"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUnmount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidCatch"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"context"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"forceUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"props"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"refs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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"> extends </span><a href="../interfaces/react.PropTypeOfFiveFeatures.html" class="tsd-signature-type" data-tsd-kind="Interface">PropTypeOfFiveFeatures</a><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-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">></span></h4></li><li><h4>C<span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</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">></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"> & </span><span class="tsd-signature-type">ComponentClass</span><span class="tsd-signature-symbol"><</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></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ForwardRefExoticComponent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PropsWithoutRef</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">P</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"$five"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">RefAttributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">InstanceType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">C</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"state"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"setState"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"render"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"shouldComponentUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUnmount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidCatch"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"getSnapshotBeforeUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentDidUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillMount"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillReceiveProps"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"UNSAFE_componentWillUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"context"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"forceUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"props"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"refs"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></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><li class=" tsd-kind-module"><a href="vfx.html">vfx</a></li><li class=" tsd-kind-module"><a href="vue.html">vue</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>
|