@realsee/five 5.0.0-alpha.73 → 5.0.0-alpha.77
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.BVHNode.html +1 -1
- package/docs/classes/five.BVHVector3.html +1 -1
- package/docs/classes/five.Camera.html +1 -1
- package/docs/classes/five.Five.html +27 -27
- package/docs/classes/five.InternalWebGLRenderer.html +1 -1
- package/docs/classes/five.Model.html +2 -2
- 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.Scene.html +1 -1
- package/docs/classes/five.Subscribe.html +1 -1
- package/docs/classes/five.Work.html +1 -1
- package/docs/classes/gltf_loader.GLTFLoader.html +1 -1
- package/docs/classes/gltf_loader.GLTFObject.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.BVHNode.html +1 -1
- package/docs/classes/server.BVHVector3.html +1 -1
- package/docs/classes/server.Model.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/index.html +1 -1
- package/docs/interfaces/five.AddableObject.html +1 -1
- package/docs/interfaces/five.AnimationFrame.html +1 -1
- package/docs/interfaces/five.BVHIntersect.html +1 -1
- package/docs/interfaces/five.CameraPose.html +1 -1
- package/docs/interfaces/five.DepthPanoramaControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.EventCallback.html +1 -1
- package/docs/interfaces/five.FiveInitArgs.html +1 -1
- package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.ImageOptions.html +1 -1
- package/docs/interfaces/five.ImageURLOptions.html +1 -1
- package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
- package/docs/interfaces/five.Intersection.html +1 -1
- package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.ModelEventCallback.html +1 -1
- package/docs/interfaces/five.MovePanoOptions.html +1 -1
- package/docs/interfaces/five.PBMPanoPicture.html +1 -1
- package/docs/interfaces/five.PBMParameters.html +1 -1
- package/docs/interfaces/five.PanoCircleMeshInterface.html +1 -1
- package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +1 -1
- 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.TopviewControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.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 +2 -2
- 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/gltf_loader.GLTF.html +1 -1
- package/docs/interfaces/react.FiveActionReactCallbacks.html +1 -1
- package/docs/interfaces/react.FiveInjectionTypes.html +1 -1
- package/docs/interfaces/react.PropTypeOfFiveFeatures.html +1 -1
- package/docs/interfaces/server.BVHIntersect.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/modules/five.SubscribeMixinType.html +1 -1
- package/docs/modules/five.html +4 -6
- package/docs/modules/gltf_loader.html +1 -1
- package/docs/modules/line.html +1 -1
- package/docs/modules/react.html +1 -1
- package/docs/modules/server.html +1 -1
- package/docs/modules/sticker.html +1 -1
- package/docs/modules.html +1 -1
- package/five/index.d.ts +1 -3
- package/five/index.js +5 -5
- package/gltf-loader/index.js +2 -2
- package/line/index.js +2 -2
- package/package.json +1 -1
- package/react/index.js +2 -2
- package/server/index.d.ts +0 -3
- package/server/index.js +3 -3
- package/sticker/index.js +2 -2
- package/umd/five.js +1 -1
package/docs/modules/line.html
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>line | 如视 Five SDK - v5.0.0-alpha.
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>line | 如视 Five SDK - v5.0.0-alpha.77</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.77"/><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.77</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.77</a></li><li><a href="line.html">line</a></li></ul><h1>Module line</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"><a href="../classes/line.Line.html" class="tsd-kind-icon">Line</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/line.LineGeometry.html" class="tsd-kind-icon">Line<wbr/>Geometry</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/line.LineMaterial.html" class="tsd-kind-icon">Line<wbr/>Material</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/line.LineSegmentsGeometry.html" class="tsd-kind-icon">Line<wbr/>Segments<wbr/>Geometry</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/line.THREE_Line2.html" class="tsd-kind-icon">THREE_<wbr/>Line2</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/line.THREE_LineSegments2.html" class="tsd-kind-icon">THREE_<wbr/>Line<wbr/>Segments2</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="line.html#LineMaterialParameters" class="tsd-kind-icon">Line<wbr/>Material<wbr/>Parameters</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="LineMaterialParameters" class="tsd-anchor"></a><h3>Line<wbr/>Material<wbr/>Parameters</h3><div class="tsd-signature tsd-kind-icon">Line<wbr/>Material<wbr/>Parameters<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>color<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol">; </span>dashScale<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>dashSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>dashed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>gapSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>linewidth<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>resolution<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">THREE.Vector2</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in lib/line/utils/LineMaterial.ts:234</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> color<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">THREE.Vector3</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> dash<wbr/>Scale<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> dash<wbr/>Size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> dashed<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> gap<wbr/>Size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> linewidth<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> resolution<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">THREE.Vector2</span></h5></li></ul></div></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="current tsd-kind-module"><a href="line.html">line</a></li><li class=" tsd-kind-module"><a href="react.html">react</a></li><li class=" tsd-kind-module"><a href="server.html">server</a></li><li class=" tsd-kind-module"><a href="sticker.html">sticker</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/line.Line.html" class="tsd-kind-icon">Line</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/line.LineGeometry.html" class="tsd-kind-icon">Line<wbr/>Geometry</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/line.LineMaterial.html" class="tsd-kind-icon">Line<wbr/>Material</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/line.LineSegmentsGeometry.html" class="tsd-kind-icon">Line<wbr/>Segments<wbr/>Geometry</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/line.THREE_Line2.html" class="tsd-kind-icon">THREE_<wbr/>Line2</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/line.THREE_LineSegments2.html" class="tsd-kind-icon">THREE_<wbr/>Line<wbr/>Segments2</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="line.html#LineMaterialParameters" class="tsd-kind-icon">Line<wbr/>Material<wbr/>Parameters</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>
|
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.73</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.73"/><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.73</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.73</a></li><li><a href="react.html">react</a></li></ul><h1>Module react</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/react.Store.html" class="tsd-kind-icon">Store</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.FiveActionReactCallbacks.html" class="tsd-kind-icon">Five<wbr/>Action<wbr/>React<wbr/>Callbacks</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.FiveInjectionTypes.html" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Types</a></li><li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/react.PropTypeOfFiveFeatures.html" class="tsd-kind-icon">Prop<wbr/>Type<wbr/>Of<wbr/>Five<wbr/>Features</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveInjectionActionFeature" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Action<wbr/>Feature</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveInjectionDataFeature" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Data<wbr/>Feature</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveInjectionFeature" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Feature</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveProviderPropTypes" class="tsd-kind-icon">Five<wbr/>Provider<wbr/>Prop<wbr/>Types</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveProviderType" class="tsd-kind-icon">Five<wbr/>Provider<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#StoreActionMapHanlder" class="tsd-kind-icon">Store<wbr/>Action<wbr/>Map<wbr/>Hanlder</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#StoreActionMapType" class="tsd-kind-icon">Store<wbr/>Action<wbr/>Map<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#StoreProviderType" class="tsd-kind-icon">Store<wbr/>Provider<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#StoreValueMapType" class="tsd-kind-icon">Store<wbr/>Value<wbr/>Map<wbr/>Type</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable tsd-parent-kind-module"><a href="react.html#FiveCanvas" class="tsd-kind-icon">Five<wbr/>Canvas</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="react.html#INJECTION_PROPNAME" class="tsd-kind-icon">INJECTION_<wbr/>PROPNAME</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#createFiveFeature" class="tsd-kind-icon">create<wbr/>Five<wbr/>Feature</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#createFiveProvider" class="tsd-kind-icon">create<wbr/>Five<wbr/>Provider</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#createStore" class="tsd-kind-icon">create<wbr/>Store</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#unsafe__useFiveInstance" class="tsd-kind-icon">unsafe__use<wbr/>Five<wbr/>Instance</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveAction" class="tsd-kind-icon">use<wbr/>Five<wbr/>Action</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCameraDirection" class="tsd-kind-icon">use<wbr/>Five<wbr/>Camera<wbr/>Direction</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCameraRaycaster" class="tsd-kind-icon">use<wbr/>Five<wbr/>Camera<wbr/>Raycaster</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCurrentObserver" class="tsd-kind-icon">use<wbr/>Five<wbr/>Current<wbr/>Observer</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCurrentState" class="tsd-kind-icon">use<wbr/>Five<wbr/>Current<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#useFiveEventCallback" class="tsd-kind-icon">use<wbr/>Five<wbr/>Event<wbr/>Callback</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveFloor" class="tsd-kind-icon">use<wbr/>Five<wbr/>Floor</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveHelper" class="tsd-kind-icon">use<wbr/>Five<wbr/>Helper</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveModelIntersectRaycaster" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveModelReadyState" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Ready<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveProject2d" class="tsd-kind-icon">use<wbr/>Five<wbr/>Project2d</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveScene" class="tsd-kind-icon">use<wbr/>Five<wbr/>Scene</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveSceneEffect" class="tsd-kind-icon">use<wbr/>Five<wbr/>Scene<wbr/>Effect</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveState" class="tsd-kind-icon">use<wbr/>Five<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveWork" class="tsd-kind-icon">use<wbr/>Five<wbr/>Work</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#withFive" class="tsd-kind-icon">with<wbr/>Five</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveInjectionActionFeature" class="tsd-anchor"></a><h3>Five<wbr/>Injection<wbr/>Action<wbr/>Feature</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Injection<wbr/>Action<wbr/>Feature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"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.tsx:25</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveInjectionDataFeature" class="tsd-anchor"></a><h3>Five<wbr/>Injection<wbr/>Data<wbr/>Feature</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Injection<wbr/>Data<wbr/>Feature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"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.tsx:10</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveInjectionFeature" class="tsd-anchor"></a><h3>Five<wbr/>Injection<wbr/>Feature</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Injection<wbr/>Feature<span class="tsd-signature-symbol">:</span> <a href="react.html#FiveInjectionDataFeature" class="tsd-signature-type" data-tsd-kind="Type alias">FiveInjectionDataFeature</a><span class="tsd-signature-symbol"> | </span><a href="react.html#FiveInjectionActionFeature" class="tsd-signature-type" data-tsd-kind="Type alias">FiveInjectionActionFeature</a></div><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.tsx:41</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveProviderPropTypes" class="tsd-anchor"></a><h3>Five<wbr/>Provider<wbr/>Prop<wbr/>Types</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Provider<wbr/>Prop<wbr/>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>children<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">React.ReactNode</span><span class="tsd-signature-symbol">; </span>initialState<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"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.tsx:6</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>children<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">React.ReactNode</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> initial<wbr/>State<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"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.tsx:13</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a></h5></li><li><h5>userAction: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>on<wbr/>Error<span class="tsd-signature-symbol">?:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">on<wbr/>Error<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createProvider.tsx:14</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>error: <span class="tsd-signature-type">Error</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>on<wbr/>State<wbr/>Change<span class="tsd-signature-symbol">?:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">on<wbr/>State<wbr/>Change<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a>, userAction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createProvider.tsx:12</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a></h5></li><li><h5>userAction: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>on<wbr/>Work<wbr/>Change<span class="tsd-signature-symbol">?:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">on<wbr/>Work<wbr/>Change<span class="tsd-signature-symbol">(</span>work<span class="tsd-signature-symbol">: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createProvider.tsx:11</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>work: <a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveProviderType" class="tsd-anchor"></a><h3>Five<wbr/>Provider<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Provider<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</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.tsx:113</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a id="StoreActionMapHanlder" class="tsd-anchor"></a><h3>Store<wbr/>Action<wbr/>Map<wbr/>Hanlder</h3><div class="tsd-signature tsd-kind-icon">Store<wbr/>Action<wbr/>Map<wbr/>Hanlder<span class="tsd-signature-symbol"><</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>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-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>, setValues<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</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>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>deps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">]</span> <span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.tsx:44</li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="react.html#StoreValueMapType" class="tsd-signature-type" data-tsd-kind="Type alias">StoreValueMapType</a></h4></li><li><h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4></li><li><h4>M<span class="tsd-signature-symbol">: </span><a href="react.html#StoreActionMapType" class="tsd-signature-type" data-tsd-kind="Type alias">StoreActionMapType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="StoreActionMapType" class="tsd-anchor"></a><h3>Store<wbr/>Action<wbr/>Map<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Store<wbr/>Action<wbr/>Map<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.tsx:40</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="StoreProviderType" class="tsd-anchor"></a><h3>Store<wbr/>Provider<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Store<wbr/>Provider<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</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.tsx:262</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="StoreValueMapType" class="tsd-anchor"></a><h3>Store<wbr/>Value<wbr/>Map<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Store<wbr/>Value<wbr/>Map<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</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.tsx:33</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"><a id="FiveCanvas" class="tsd-anchor"></a><h3>Five<wbr/>Canvas</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Canvas<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">React.FC</span><span class="tsd-signature-symbol"><</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.tsx:23</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>react | 如视 Five SDK - v5.0.0-alpha.77</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.77"/><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.77</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.77</a></li><li><a href="react.html">react</a></li></ul><h1>Module react</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="../classes/react.Store.html" class="tsd-kind-icon">Store</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.FiveActionReactCallbacks.html" class="tsd-kind-icon">Five<wbr/>Action<wbr/>React<wbr/>Callbacks</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/react.FiveInjectionTypes.html" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Types</a></li><li class="tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter"><a href="../interfaces/react.PropTypeOfFiveFeatures.html" class="tsd-kind-icon">Prop<wbr/>Type<wbr/>Of<wbr/>Five<wbr/>Features</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveInjectionActionFeature" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Action<wbr/>Feature</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveInjectionDataFeature" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Data<wbr/>Feature</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveInjectionFeature" class="tsd-kind-icon">Five<wbr/>Injection<wbr/>Feature</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveProviderPropTypes" class="tsd-kind-icon">Five<wbr/>Provider<wbr/>Prop<wbr/>Types</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#FiveProviderType" class="tsd-kind-icon">Five<wbr/>Provider<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#StoreActionMapHanlder" class="tsd-kind-icon">Store<wbr/>Action<wbr/>Map<wbr/>Hanlder</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#StoreActionMapType" class="tsd-kind-icon">Store<wbr/>Action<wbr/>Map<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#StoreProviderType" class="tsd-kind-icon">Store<wbr/>Provider<wbr/>Type</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="react.html#StoreValueMapType" class="tsd-kind-icon">Store<wbr/>Value<wbr/>Map<wbr/>Type</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable tsd-parent-kind-module"><a href="react.html#FiveCanvas" class="tsd-kind-icon">Five<wbr/>Canvas</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="react.html#INJECTION_PROPNAME" class="tsd-kind-icon">INJECTION_<wbr/>PROPNAME</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#createFiveFeature" class="tsd-kind-icon">create<wbr/>Five<wbr/>Feature</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#createFiveProvider" class="tsd-kind-icon">create<wbr/>Five<wbr/>Provider</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#createStore" class="tsd-kind-icon">create<wbr/>Store</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#unsafe__useFiveInstance" class="tsd-kind-icon">unsafe__use<wbr/>Five<wbr/>Instance</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveAction" class="tsd-kind-icon">use<wbr/>Five<wbr/>Action</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCameraDirection" class="tsd-kind-icon">use<wbr/>Five<wbr/>Camera<wbr/>Direction</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCameraRaycaster" class="tsd-kind-icon">use<wbr/>Five<wbr/>Camera<wbr/>Raycaster</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCurrentObserver" class="tsd-kind-icon">use<wbr/>Five<wbr/>Current<wbr/>Observer</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveCurrentState" class="tsd-kind-icon">use<wbr/>Five<wbr/>Current<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#useFiveEventCallback" class="tsd-kind-icon">use<wbr/>Five<wbr/>Event<wbr/>Callback</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveFloor" class="tsd-kind-icon">use<wbr/>Five<wbr/>Floor</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveHelper" class="tsd-kind-icon">use<wbr/>Five<wbr/>Helper</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveModelIntersectRaycaster" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveModelReadyState" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Ready<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveProject2d" class="tsd-kind-icon">use<wbr/>Five<wbr/>Project2d</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveScene" class="tsd-kind-icon">use<wbr/>Five<wbr/>Scene</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveSceneEffect" class="tsd-kind-icon">use<wbr/>Five<wbr/>Scene<wbr/>Effect</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveState" class="tsd-kind-icon">use<wbr/>Five<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="react.html#useFiveWork" class="tsd-kind-icon">use<wbr/>Five<wbr/>Work</a></li><li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="react.html#withFive" class="tsd-kind-icon">with<wbr/>Five</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveInjectionActionFeature" class="tsd-anchor"></a><h3>Five<wbr/>Injection<wbr/>Action<wbr/>Feature</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Injection<wbr/>Action<wbr/>Feature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"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.tsx:25</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveInjectionDataFeature" class="tsd-anchor"></a><h3>Five<wbr/>Injection<wbr/>Data<wbr/>Feature</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Injection<wbr/>Data<wbr/>Feature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"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.tsx:10</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveInjectionFeature" class="tsd-anchor"></a><h3>Five<wbr/>Injection<wbr/>Feature</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Injection<wbr/>Feature<span class="tsd-signature-symbol">:</span> <a href="react.html#FiveInjectionDataFeature" class="tsd-signature-type" data-tsd-kind="Type alias">FiveInjectionDataFeature</a><span class="tsd-signature-symbol"> | </span><a href="react.html#FiveInjectionActionFeature" class="tsd-signature-type" data-tsd-kind="Type alias">FiveInjectionActionFeature</a></div><aside class="tsd-sources"><ul><li>Defined in lib/react/withFive.tsx:41</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveProviderPropTypes" class="tsd-anchor"></a><h3>Five<wbr/>Provider<wbr/>Prop<wbr/>Types</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Provider<wbr/>Prop<wbr/>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>children<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">React.ReactNode</span><span class="tsd-signature-symbol">; </span>initialState<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"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.tsx:6</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>children<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">React.ReactNode</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> initial<wbr/>State<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"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.tsx:13</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a></h5></li><li><h5>userAction: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>on<wbr/>Error<span class="tsd-signature-symbol">?:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">on<wbr/>Error<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createProvider.tsx:14</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>error: <span class="tsd-signature-type">Error</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>on<wbr/>State<wbr/>Change<span class="tsd-signature-symbol">?:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">on<wbr/>State<wbr/>Change<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a>, userAction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createProvider.tsx:12</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a></h5></li><li><h5>userAction: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li><li class="tsd-parameter"><h5>on<wbr/>Work<wbr/>Change<span class="tsd-signature-symbol">?:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">on<wbr/>Work<wbr/>Change<span class="tsd-signature-symbol">(</span>work<span class="tsd-signature-symbol">: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/react/createProvider.tsx:11</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>work: <a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveProviderType" class="tsd-anchor"></a><h3>Five<wbr/>Provider<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Provider<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</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.tsx:113</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a id="StoreActionMapHanlder" class="tsd-anchor"></a><h3>Store<wbr/>Action<wbr/>Map<wbr/>Hanlder</h3><div class="tsd-signature tsd-kind-icon">Store<wbr/>Action<wbr/>Map<wbr/>Hanlder<span class="tsd-signature-symbol"><</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>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-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>, setValues<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</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>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>deps<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">K</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">]</span> <span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.tsx:44</li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="react.html#StoreValueMapType" class="tsd-signature-type" data-tsd-kind="Type alias">StoreValueMapType</a></h4></li><li><h4>K<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4></li><li><h4>M<span class="tsd-signature-symbol">: </span><a href="react.html#StoreActionMapType" class="tsd-signature-type" data-tsd-kind="Type alias">StoreActionMapType</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="StoreActionMapType" class="tsd-anchor"></a><h3>Store<wbr/>Action<wbr/>Map<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Store<wbr/>Action<wbr/>Map<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div><aside class="tsd-sources"><ul><li>Defined in lib/react/createStore.tsx:40</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-index-signature"><h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="StoreProviderType" class="tsd-anchor"></a><h3>Store<wbr/>Provider<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Store<wbr/>Provider<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ReturnType</span><span class="tsd-signature-symbol"><</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.tsx:262</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="StoreValueMapType" class="tsd-anchor"></a><h3>Store<wbr/>Value<wbr/>Map<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Store<wbr/>Value<wbr/>Map<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</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.tsx:33</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"><a id="FiveCanvas" class="tsd-anchor"></a><h3>Five<wbr/>Canvas</h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Canvas<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">React.FC</span><span class="tsd-signature-symbol"><</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.tsx:23</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
2
|
<p>Five 渲染区域组件</p>
|
|
3
3
|
</div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>Five 渲染区域组件，请在 FiveProvider 内使用</p>
|
|
4
4
|
</dd><dt>param width</dt><dd><p>渲染区域的宽度</p>
|
package/docs/modules/server.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>server | 如视 Five SDK - v5.0.0-alpha.73</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.73"/><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.73</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.73</a></li><li><a href="server.html">server</a></li></ul><h1>Module server</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>References</h3><ul class="tsd-index-list"><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#EventCallback" class="tsd-kind-icon">Event<wbr/>Callback</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#EventType" class="tsd-kind-icon">Event<wbr/>Type</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWork" class="tsd-kind-icon">Loose<wbr/>Work</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkInitial" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Initial</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkModel" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Model</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkObserver" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Observer</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkPanorama" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Panorama</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkVideo" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Video</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Mode" class="tsd-kind-icon">Mode</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#ParseWorkOptions" class="tsd-kind-icon">Parse<wbr/>Work<wbr/>Options</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Pose" class="tsd-kind-icon">Pose</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#State" class="tsd-kind-icon">State</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Subscribe" class="tsd-kind-icon">Subscribe</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#SubscribeEventMap" class="tsd-kind-icon">Subscribe<wbr/>Event<wbr/>Map</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#SubscribeMixinType" class="tsd-kind-icon">Subscribe<wbr/>Mixin<wbr/>Type</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Work" class="tsd-kind-icon">Work</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkCubeImage" class="tsd-kind-icon">Work<wbr/>Cube<wbr/>Image</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkImage" class="tsd-kind-icon">Work<wbr/>Image</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkInitial" class="tsd-kind-icon">Work<wbr/>Initial</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkModel" class="tsd-kind-icon">Work<wbr/>Model</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkObserver" class="tsd-kind-icon">Work<wbr/>Observer</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkTile" class="tsd-kind-icon">Work<wbr/>Tile</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkVideo" class="tsd-kind-icon">Work<wbr/>Video</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#parseWork" class="tsd-kind-icon">parse<wbr/>Work</a></li></ul></section><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.BVH.html" class="tsd-kind-icon">BVH</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.BVHNode.html" class="tsd-kind-icon">BVHNode</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.BVHVector3.html" class="tsd-kind-icon">BVHVector3</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.Model.html" class="tsd-kind-icon">Model</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.PBMGroup.html" class="tsd-kind-icon">PBMGroup</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.PBMMesh.html" class="tsd-kind-icon">PBMMesh</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/server.BVHIntersect.html" class="tsd-kind-icon">BVHIntersect</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/server.Intersection.html" class="tsd-kind-icon">Intersection</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/server.ModelEventCallback.html" class="tsd-kind-icon">Model<wbr/>Event<wbr/>Callback</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="server.html#ModelEventType" class="tsd-kind-icon">Model<wbr/>Event<wbr/>Type</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>References</h2><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="EventCallback" class="tsd-anchor"></a><h3>Event<wbr/>Callback</h3>Renames and re-exports <a href="../interfaces/server.ModelEventCallback.html">ModelEventCallback</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="EventType" class="tsd-anchor"></a><h3>Event<wbr/>Type</h3>Renames and re-exports <a href="server.html#ModelEventType">ModelEventType</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWork" class="tsd-anchor"></a><h3>Loose<wbr/>Work</h3>Re-exports <a href="five.html#LooseWork">LooseWork</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWorkInitial" class="tsd-anchor"></a><h3>Loose<wbr/>Work<wbr/>Initial</h3>Re-exports <a href="five.html#LooseWorkInitial">LooseWorkInitial</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWorkModel" class="tsd-anchor"></a><h3>Loose<wbr/>Work<wbr/>Model</h3>Re-exports <a href="five.html#LooseWorkModel">LooseWorkModel</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWorkObserver" class="tsd-anchor"></a><h3>Loose<wbr/>Work<wbr/>Observer</h3>Re-exports <a href="five.html#LooseWorkObserver">LooseWorkObserver</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWorkPanorama" class="tsd-anchor"></a><h3>Loose<wbr/>Work<wbr/>Panorama</h3>Re-exports <a href="five.html#LooseWorkPanorama">LooseWorkPanorama</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWorkVideo" class="tsd-anchor"></a><h3>Loose<wbr/>Work<wbr/>Video</h3>Re-exports <a href="five.html#LooseWorkVideo">LooseWorkVideo</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Mode" class="tsd-anchor"></a><h3>Mode</h3>Re-exports <a href="five.html#Mode">Mode</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="ParseWorkOptions" class="tsd-anchor"></a><h3>Parse<wbr/>Work<wbr/>Options</h3>Re-exports <a href="five.html#ParseWorkOptions">ParseWorkOptions</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Pose" class="tsd-anchor"></a><h3>Pose</h3>Re-exports <a href="../interfaces/five.Pose.html">Pose</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="State" class="tsd-anchor"></a><h3>State</h3>Re-exports <a href="../interfaces/five.State.html">State</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Subscribe" class="tsd-anchor"></a><h3>Subscribe</h3>Re-exports <a href="../classes/five.Subscribe.html">Subscribe</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="SubscribeEventMap" class="tsd-anchor"></a><h3>Subscribe<wbr/>Event<wbr/>Map</h3>Re-exports <a href="five.html#SubscribeEventMap">SubscribeEventMap</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="SubscribeMixinType" class="tsd-anchor"></a><h3>Subscribe<wbr/>Mixin<wbr/>Type</h3>Re-exports <a href="five.SubscribeMixinType.html">SubscribeMixinType</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Work" class="tsd-anchor"></a><h3>Work</h3>Re-exports <a href="../classes/five.Work.html">Work</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkCubeImage" class="tsd-anchor"></a><h3>Work<wbr/>Cube<wbr/>Image</h3>Re-exports <a href="../interfaces/five.WorkCubeImage.html">WorkCubeImage</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkImage" class="tsd-anchor"></a><h3>Work<wbr/>Image</h3>Re-exports <a href="../interfaces/five.WorkImage.html">WorkImage</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkInitial" class="tsd-anchor"></a><h3>Work<wbr/>Initial</h3>Re-exports <a href="../interfaces/five.WorkInitial.html">WorkInitial</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkModel" class="tsd-anchor"></a><h3>Work<wbr/>Model</h3>Re-exports <a href="../interfaces/five.WorkModel.html">WorkModel</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkObserver" class="tsd-anchor"></a><h3>Work<wbr/>Observer</h3>Re-exports <a href="../interfaces/five.WorkObserver.html">WorkObserver</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkTile" class="tsd-anchor"></a><h3>Work<wbr/>Tile</h3>Re-exports <a href="../interfaces/five.WorkTile.html">WorkTile</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkVideo" class="tsd-anchor"></a><h3>Work<wbr/>Video</h3>Re-exports <a href="../interfaces/five.WorkVideo.html">WorkVideo</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="parseWork" class="tsd-anchor"></a><h3>parse<wbr/>Work</h3>Re-exports <a href="five.html#parseWork">parseWork</a></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="ModelEventType" class="tsd-anchor"></a><h3>Model<wbr/>Event<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Model<wbr/>Event<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>bvhLoaded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>geometryLoaded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>loaded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>materialLoaded<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/five/server/model/index.ts:50</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>server | 如视 Five SDK - v5.0.0-alpha.77</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.77"/><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.77</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.77</a></li><li><a href="server.html">server</a></li></ul><h1>Module server</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>References</h3><ul class="tsd-index-list"><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#EventCallback" class="tsd-kind-icon">Event<wbr/>Callback</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#EventType" class="tsd-kind-icon">Event<wbr/>Type</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWork" class="tsd-kind-icon">Loose<wbr/>Work</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkInitial" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Initial</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkModel" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Model</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkObserver" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Observer</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkPanorama" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Panorama</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#LooseWorkVideo" class="tsd-kind-icon">Loose<wbr/>Work<wbr/>Video</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Mode" class="tsd-kind-icon">Mode</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#ParseWorkOptions" class="tsd-kind-icon">Parse<wbr/>Work<wbr/>Options</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Pose" class="tsd-kind-icon">Pose</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#State" class="tsd-kind-icon">State</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Subscribe" class="tsd-kind-icon">Subscribe</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#SubscribeEventMap" class="tsd-kind-icon">Subscribe<wbr/>Event<wbr/>Map</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#SubscribeMixinType" class="tsd-kind-icon">Subscribe<wbr/>Mixin<wbr/>Type</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#Work" class="tsd-kind-icon">Work</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkCubeImage" class="tsd-kind-icon">Work<wbr/>Cube<wbr/>Image</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkImage" class="tsd-kind-icon">Work<wbr/>Image</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkInitial" class="tsd-kind-icon">Work<wbr/>Initial</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkModel" class="tsd-kind-icon">Work<wbr/>Model</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkObserver" class="tsd-kind-icon">Work<wbr/>Observer</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkTile" class="tsd-kind-icon">Work<wbr/>Tile</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#WorkVideo" class="tsd-kind-icon">Work<wbr/>Video</a></li><li class="tsd-kind-reference tsd-parent-kind-module"><a href="server.html#parseWork" class="tsd-kind-icon">parse<wbr/>Work</a></li></ul></section><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.BVH.html" class="tsd-kind-icon">BVH</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.BVHNode.html" class="tsd-kind-icon">BVHNode</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.BVHVector3.html" class="tsd-kind-icon">BVHVector3</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.Model.html" class="tsd-kind-icon">Model</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.PBMGroup.html" class="tsd-kind-icon">PBMGroup</a></li><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/server.PBMMesh.html" class="tsd-kind-icon">PBMMesh</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/server.BVHIntersect.html" class="tsd-kind-icon">BVHIntersect</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/server.Intersection.html" class="tsd-kind-icon">Intersection</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/server.ModelEventCallback.html" class="tsd-kind-icon">Model<wbr/>Event<wbr/>Callback</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="server.html#ModelEventType" class="tsd-kind-icon">Model<wbr/>Event<wbr/>Type</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>References</h2><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="EventCallback" class="tsd-anchor"></a><h3>Event<wbr/>Callback</h3>Renames and re-exports <a href="../interfaces/server.ModelEventCallback.html">ModelEventCallback</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="EventType" class="tsd-anchor"></a><h3>Event<wbr/>Type</h3>Renames and re-exports <a href="server.html#ModelEventType">ModelEventType</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWork" class="tsd-anchor"></a><h3>Loose<wbr/>Work</h3>Re-exports <a href="five.html#LooseWork">LooseWork</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWorkInitial" class="tsd-anchor"></a><h3>Loose<wbr/>Work<wbr/>Initial</h3>Re-exports <a href="five.html#LooseWorkInitial">LooseWorkInitial</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWorkModel" class="tsd-anchor"></a><h3>Loose<wbr/>Work<wbr/>Model</h3>Re-exports <a href="five.html#LooseWorkModel">LooseWorkModel</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWorkObserver" class="tsd-anchor"></a><h3>Loose<wbr/>Work<wbr/>Observer</h3>Re-exports <a href="five.html#LooseWorkObserver">LooseWorkObserver</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWorkPanorama" class="tsd-anchor"></a><h3>Loose<wbr/>Work<wbr/>Panorama</h3>Re-exports <a href="five.html#LooseWorkPanorama">LooseWorkPanorama</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="LooseWorkVideo" class="tsd-anchor"></a><h3>Loose<wbr/>Work<wbr/>Video</h3>Re-exports <a href="five.html#LooseWorkVideo">LooseWorkVideo</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Mode" class="tsd-anchor"></a><h3>Mode</h3>Re-exports <a href="five.html#Mode">Mode</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="ParseWorkOptions" class="tsd-anchor"></a><h3>Parse<wbr/>Work<wbr/>Options</h3>Re-exports <a href="five.html#ParseWorkOptions">ParseWorkOptions</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Pose" class="tsd-anchor"></a><h3>Pose</h3>Re-exports <a href="../interfaces/five.Pose.html">Pose</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="State" class="tsd-anchor"></a><h3>State</h3>Re-exports <a href="../interfaces/five.State.html">State</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Subscribe" class="tsd-anchor"></a><h3>Subscribe</h3>Re-exports <a href="../classes/five.Subscribe.html">Subscribe</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="SubscribeEventMap" class="tsd-anchor"></a><h3>Subscribe<wbr/>Event<wbr/>Map</h3>Re-exports <a href="five.html#SubscribeEventMap">SubscribeEventMap</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="SubscribeMixinType" class="tsd-anchor"></a><h3>Subscribe<wbr/>Mixin<wbr/>Type</h3>Re-exports <a href="five.SubscribeMixinType.html">SubscribeMixinType</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Work" class="tsd-anchor"></a><h3>Work</h3>Re-exports <a href="../classes/five.Work.html">Work</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkCubeImage" class="tsd-anchor"></a><h3>Work<wbr/>Cube<wbr/>Image</h3>Re-exports <a href="../interfaces/five.WorkCubeImage.html">WorkCubeImage</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkImage" class="tsd-anchor"></a><h3>Work<wbr/>Image</h3>Re-exports <a href="../interfaces/five.WorkImage.html">WorkImage</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkInitial" class="tsd-anchor"></a><h3>Work<wbr/>Initial</h3>Re-exports <a href="../interfaces/five.WorkInitial.html">WorkInitial</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkModel" class="tsd-anchor"></a><h3>Work<wbr/>Model</h3>Re-exports <a href="../interfaces/five.WorkModel.html">WorkModel</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkObserver" class="tsd-anchor"></a><h3>Work<wbr/>Observer</h3>Re-exports <a href="../interfaces/five.WorkObserver.html">WorkObserver</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkTile" class="tsd-anchor"></a><h3>Work<wbr/>Tile</h3>Re-exports <a href="../interfaces/five.WorkTile.html">WorkTile</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="WorkVideo" class="tsd-anchor"></a><h3>Work<wbr/>Video</h3>Re-exports <a href="../interfaces/five.WorkVideo.html">WorkVideo</a></section><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="parseWork" class="tsd-anchor"></a><h3>parse<wbr/>Work</h3>Re-exports <a href="five.html#parseWork">parseWork</a></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="ModelEventType" class="tsd-anchor"></a><h3>Model<wbr/>Event<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Model<wbr/>Event<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>bvhLoaded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>geometryLoaded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>loaded<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>materialLoaded<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/five/server/model/index.ts:50</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
2
|
<p>模型事件列表</p>
|
|
3
3
|
</div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>具体事件列表 请查看 <a href="../interfaces/server.ModelEventCallback.html">ModelEventCallback</a></p>
|
|
4
4
|
</dd></dl></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>bvh<wbr/>Loaded<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">bvh<wbr/>Loaded<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in lib/five/server/model/index.ts:57</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
@@ -1 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>sticker | 如视 Five SDK - v5.0.0-alpha.
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>sticker | 如视 Five SDK - v5.0.0-alpha.77</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.77"/><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.77</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.77</a></li><li><a href="sticker.html">sticker</a></li></ul><h1>Module sticker</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"><a href="../classes/sticker.Sticker.html" class="tsd-kind-icon">Sticker</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/sticker.IntersectionLike.html" class="tsd-kind-icon">Intersection<wbr/>Like</a></li></ul></section></div></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=" tsd-kind-module"><a href="react.html">react</a></li><li class=" tsd-kind-module"><a href="server.html">server</a></li><li class="current tsd-kind-module"><a href="sticker.html">sticker</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/sticker.Sticker.html" class="tsd-kind-icon">Sticker</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/sticker.IntersectionLike.html" class="tsd-kind-icon">Intersection<wbr/>Like</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>
|
package/docs/modules.html
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>如视 Five SDK - v5.0.0-alpha.
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>如视 Five SDK - v5.0.0-alpha.77</title><meta name="description" content="Documentation for 如视 Five SDK - v5.0.0-alpha.77"/><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.77</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"><h1> 如视 Five SDK - v5.0.0-alpha.77</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>Modules</h3><ul class="tsd-index-list"><li class="tsd-kind-module"><a href="modules/five.html" class="tsd-kind-icon">five</a></li><li class="tsd-kind-module"><a href="modules/gltf_loader.html" class="tsd-kind-icon">gltf-<wbr/>loader</a></li><li class="tsd-kind-module"><a href="modules/line.html" class="tsd-kind-icon">line</a></li><li class="tsd-kind-module"><a href="modules/react.html" class="tsd-kind-icon">react</a></li><li class="tsd-kind-module"><a href="modules/server.html" class="tsd-kind-icon">server</a></li><li class="tsd-kind-module"><a href="modules/sticker.html" class="tsd-kind-icon">sticker</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/five.html">five</a></li><li class=" tsd-kind-module"><a href="modules/gltf_loader.html">gltf-<wbr/>loader</a></li><li class=" tsd-kind-module"><a href="modules/line.html">line</a></li><li class=" tsd-kind-module"><a href="modules/react.html">react</a></li><li class=" tsd-kind-module"><a href="modules/server.html">server</a></li><li class=" tsd-kind-module"><a href="modules/sticker.html">sticker</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>
|
package/five/index.d.ts
CHANGED
|
@@ -780,6 +780,7 @@ export declare class Five extends Subscribe<EventTypes> {
|
|
|
780
780
|
set enableIOSEDR(enable: boolean);
|
|
781
781
|
get enablePostProcessing(): boolean;
|
|
782
782
|
set enablePostProcessing(enable: boolean);
|
|
783
|
+
updateConfiguration(args: Pick<FiveInitArgs, "panorama" | "model" | "floorplan" | "topview" | "depthPanorama" | "vrPanorama" | "imageOptions">): void;
|
|
783
784
|
/**
|
|
784
785
|
* 将显示区域加载到页面 DOM 中
|
|
785
786
|
* @description
|
|
@@ -1622,8 +1623,6 @@ export declare type ParseWorkOptions = {
|
|
|
1622
1623
|
shortPath?: boolean;
|
|
1623
1624
|
/** work 中的资源使用 jsonp 方式发布 */
|
|
1624
1625
|
jsonp?: boolean;
|
|
1625
|
-
/** work 中模型加载是否同步， 默认异步 true */
|
|
1626
|
-
modelAsync?: boolean;
|
|
1627
1626
|
/** work 中模型是否计算bvh碰撞数，默认计算 true */
|
|
1628
1627
|
modelBvh?: boolean;
|
|
1629
1628
|
};
|
|
@@ -1914,7 +1913,6 @@ export declare interface WorkModel {
|
|
|
1914
1913
|
textures: string[];
|
|
1915
1914
|
textureBase: string;
|
|
1916
1915
|
bvh: boolean;
|
|
1917
|
-
async: boolean;
|
|
1918
1916
|
}
|
|
1919
1917
|
|
|
1920
1918
|
/** 每个点位的数据 */
|