npm - @realsee/five - Versions diffs - 6.0.0-alpha.4 → 6.0.0-alpha.5 - Mend

@realsee/five 6.0.0-alpha.4 → 6.0.0-alpha.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (166) hide show

package/docs/assets/search.js +1 -1
package/docs/classes/five.AnimationFrameLoop.html +1 -1
package/docs/classes/five.BVH.html +1 -1
package/docs/classes/five.BVHIntersect.html +1 -1
package/docs/classes/five.BVHNode.html +1 -1
package/docs/classes/five.BVHVector3.html +1 -1
package/docs/classes/five.BoxBoundingVolume.html +1 -1
package/docs/classes/five.Camera.html +1 -1
package/docs/classes/five.Clipper.html +1 -1
package/docs/classes/five.CullingVolume.html +1 -1
package/docs/classes/five.Five.html +38 -36
package/docs/classes/five.InternalWebGLRenderer.html +1 -1
package/docs/classes/five.IntersectMesh.html +1 -1
package/docs/classes/five.Model.html +21 -21
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.PBMMaterialReferenceCache.html +1 -1
package/docs/classes/five.PBMMesh.html +1 -1
package/docs/classes/five.PBMMeshMaterial.html +15 -11
package/docs/classes/five.PanoCircleMesh.html +1 -1
package/docs/classes/five.PanoCircleMeshCustom.html +1 -1
package/docs/classes/five.PanoCircleMeshSolid.html +1 -1
package/docs/classes/five.RegionBoundingVolume.html +1 -1
package/docs/classes/five.RequestScheduler.html +1 -1
package/docs/classes/five.Scene.html +1 -1
package/docs/classes/five.SphereBoundingVolume.html +1 -1
package/docs/classes/five.Subscribe.html +1 -1
package/docs/classes/five.TextureLoader.html +1 -1
package/docs/classes/five.Tile.html +1 -1
package/docs/classes/five.Tile3DModel.html +1 -1
package/docs/classes/five.TileCubeTextureTarget.html +1 -1
package/docs/classes/five.TileNode.html +1 -1
package/docs/classes/five.Tileset.html +1 -1
package/docs/classes/five.TilesetCache.html +1 -1
package/docs/classes/five.TilesetTraverser.html +1 -1
package/docs/classes/five.Work.html +1 -1
package/docs/classes/five.XRButton.html +1 -1
package/docs/classes/gltf_loader.DDSLoader.html +1 -1
package/docs/classes/gltf_loader.DRACOLoader.html +1 -1
package/docs/classes/gltf_loader.GLTFLoader.html +1 -1
package/docs/classes/gltf_loader.GLTFObject.html +1 -1
package/docs/classes/gltf_loader.GLTFParser.html +1 -1
package/docs/classes/gltf_loader.THREEGLTFLoader.html +1 -1
package/docs/classes/line.Line.html +1 -1
package/docs/classes/line.LineGeometry.html +1 -1
package/docs/classes/line.LineMaterial.html +1 -1
package/docs/classes/line.LineSegmentsGeometry.html +1 -1
package/docs/classes/line.THREE_Line2.html +1 -1
package/docs/classes/line.THREE_LineSegments2.html +1 -1
package/docs/classes/react.Store.html +1 -1
package/docs/classes/sticker.Sticker.html +1 -1
package/docs/classes/vfx.Airflow.html +1 -1
package/docs/classes/vfx.Flame.html +1 -1
package/docs/classes/vfx.Particle.html +1 -1
package/docs/classes/vfx.SpotLight.html +1 -1
package/docs/enums/five.PBMPointColorType.html +1 -1
package/docs/enums/five.PBMPointShapeType.html +1 -1
package/docs/enums/five.PBMPointSizeType.html +1 -1
package/docs/enums/five.VolumePlaneIntersect.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.BaseEvent.html +1 -1
package/docs/interfaces/five.BoundingVolume.html +1 -1
package/docs/interfaces/five.CameraPose.html +1 -1
package/docs/interfaces/five.ClipperParameter.html +1 -1
package/docs/interfaces/five.DepthPanoramaControllerCustomInitArgs.html +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.GestureEvent.html +1 -1
package/docs/interfaces/five.ImageOptions.html +1 -1
package/docs/interfaces/five.ImageURLMappings.html +1 -1
package/docs/interfaces/five.ImageURLOptions.html +1 -1
package/docs/interfaces/five.IntersectEvent.html +1 -1
package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
package/docs/interfaces/five.Intersection.html +1 -1
package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +5 -5
package/docs/interfaces/five.ModeChangeEvent.html +1 -1
package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
package/docs/interfaces/five.ModelEvent.html +1 -1
package/docs/interfaces/five.ModelLodOptions.html +1 -1
package/docs/interfaces/five.ModelsEvent.html +1 -1
package/docs/interfaces/five.MotionKeyframe.html +1 -1
package/docs/interfaces/five.MovePanoOptions.html +1 -1
package/docs/interfaces/five.NetworkOptions.html +1 -1
package/docs/interfaces/five.NetworkResourceEvent.html +1 -1
package/docs/interfaces/five.ObjectEvent.html +1 -1
package/docs/interfaces/five.PBMPanoPicture.html +1 -1
package/docs/interfaces/five.PBMParameters.html +15 -11
package/docs/interfaces/five.PanoCircleMeshCustomOptions.html +1 -1
package/docs/interfaces/five.PanoCircleMeshInterface.html +1 -1
package/docs/interfaces/five.PanoCircleMeshOptions.html +1 -1
package/docs/interfaces/five.PanoCircleMeshSolidOptions.html +1 -1
package/docs/interfaces/five.PanoEvent.html +1 -1
package/docs/interfaces/five.PanoTextureEvent.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.RenderEvent.html +1 -1
package/docs/interfaces/five.Scissor.html +1 -1
package/docs/interfaces/five.State.html +1 -1
package/docs/interfaces/five.StateEvent.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.SubscribeMixinType.waitUnitl.html +1 -1
package/docs/interfaces/five.TextureOptions.html +1 -1
package/docs/interfaces/five.Tile3DModelLoaderOptions.html +1 -1
package/docs/interfaces/five.TileCubeNode.html +1 -1
package/docs/interfaces/five.TileCubeTree.html +1 -1
package/docs/interfaces/five.TileHeader.html +1 -1
package/docs/interfaces/five.TilesetHeader.html +1 -1
package/docs/interfaces/five.TilesetOptions.html +1 -1
package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +1 -1
package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +1 -1
package/docs/interfaces/five.WebXRControllerParams.html +1 -1
package/docs/interfaces/five.WorkCubeImage.html +1 -1
package/docs/interfaces/five.WorkImage.html +1 -1
package/docs/interfaces/five.WorkInitial.html +1 -1
package/docs/interfaces/five.WorkModel.html +1 -1
package/docs/interfaces/five.WorkObserver.html +1 -1
package/docs/interfaces/five.WorkOptions.html +1 -1
package/docs/interfaces/five.WorkResolvedObserver.html +1 -1
package/docs/interfaces/five.WorkTile.html +1 -1
package/docs/interfaces/five.WorkVideo.html +1 -1
package/docs/interfaces/five.WorksEvent.html +1 -1
package/docs/interfaces/five.XRGestureEvent.html +1 -1
package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +1 -1
package/docs/interfaces/five.XRSessionEvent.html +1 -1
package/docs/interfaces/gltf_loader.DDS.html +1 -1
package/docs/interfaces/gltf_loader.GLTF.html +1 -1
package/docs/interfaces/gltf_loader.GLTFReference.html +1 -1
package/docs/interfaces/gltf_loader.THREEGLTF.html +1 -1
package/docs/interfaces/react.FiveActionReactCallbacks.html +1 -1
package/docs/interfaces/react.FiveInjectionTypes.html +1 -1
package/docs/interfaces/react.PropTypeOfFiveFeatures.html +1 -1
package/docs/interfaces/sticker.IntersectionLike.html +1 -1
package/docs/interfaces/vfx.ParticleArgs.html +1 -1
package/docs/interfaces/vfx.ParticleTweenKeyframe.html +1 -1
package/docs/interfaces/vue.FiveActionVueCallbacks.html +1 -1
package/docs/modules/five.SubscribeMixinType.html +1 -1
package/docs/modules/five.html +4 -4
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/sticker.html +1 -1
package/docs/modules/vfx.html +1 -1
package/docs/modules/vue.html +1 -1
package/docs/modules.html +1 -1
package/five/index.d.ts +17 -1
package/five/index.js +4 -4
package/gltf-loader/index.js +2 -2
package/line/index.js +2 -2
package/package.json +1 -1
package/react/index.js +1 -1
package/sticker/index.js +2 -2
package/umd/five-gltf-loader.js +1 -1
package/umd/five-line.js +1 -1
package/umd/five-sticker.js +1 -1
package/umd/five.js +1 -1
package/vfx/index.js +1 -1
package/vue/index.js +1 -1

package/docs/modules/vue.html CHANGED Viewed

@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>vue | 如视 Five SDK - v6.0.0-alpha.4</title><meta name="description" content="Documentation for 如视 Five SDK - v6.0.0-alpha.4"/><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 - v6.0.0-alpha.4</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 - v6.0.0-alpha.4</a></li><li><a href="vue.html">vue</a></li></ul><h1>Module vue </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>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/vue.FiveActionVueCallbacks.html" class="tsd-kind-icon">Five<wbr/>Action<wbr/>Vue<wbr/>Callbacks</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="vue.html#FiveModelIntersectRaycaster" class="tsd-kind-icon">Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="vue.html#FiveProviderComponent" class="tsd-kind-icon">Five<wbr/>Provider<wbr/>Component</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="vue.html#Project2d" class="tsd-kind-icon">Project2d</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="vue.html#FiveCanvas" class="tsd-kind-icon">Five<wbr/>Canvas</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="vue.html#FiveProvider" class="tsd-kind-icon">Five<wbr/>Provider</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"><a href="vue.html#unsafe__useFiveInject" class="tsd-kind-icon">unsafe__use<wbr/>Five<wbr/>Inject</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveAction" class="tsd-kind-icon">use<wbr/>Five<wbr/>Action</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.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="vue.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="vue.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="vue.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="vue.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="vue.html#useFiveFloor" class="tsd-kind-icon">use<wbr/>Five<wbr/>Floor</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveHelper" class="tsd-kind-icon">use<wbr/>Five<wbr/>Helper</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveModel" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveModelBounding" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Bounding</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.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="vue.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="vue.html#useFiveProject2d" class="tsd-kind-icon">use<wbr/>Five<wbr/>Project2d</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveScene" class="tsd-kind-icon">use<wbr/>Five<wbr/>Scene</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveState" class="tsd-kind-icon">use<wbr/>Five<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveWorks" class="tsd-kind-icon">use<wbr/>Five<wbr/>Works</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="FiveModelIntersectRaycaster" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster<a href="#FiveModelIntersectRaycaster" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>raycaster<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveModelIntersectRaycaster.ts:7</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>raycaster<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>raycaster: <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">THREE.Raycaster</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveProviderComponent" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Five<wbr/>Provider<wbr/>Component<a href="#FiveProviderComponent" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Provider<wbr/>Component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DefineComponent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>fiveInitArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.FiveInitArgs.html" class="tsd-signature-type" data-tsd-kind="Interface">FiveInitArgs</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;renderer&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;scissor&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>default<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>initialState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">&quot;inherit&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;initial&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;offset&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>initialUserAction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BooleanConstructor</span><span class="tsd-signature-symbol">; </span>initialWorks<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>onCurrentStateChange<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a>, userAction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>onError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>onStateChange<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a>, userAction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>onWorksChange<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>work<span class="tsd-signature-symbol">: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ObjectConstructor</span><span class="tsd-signature-symbol">; </span>works<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>five<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Five.html" class="tsd-signature-type" data-tsd-kind="Class">Five</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/FiveProvider.ts:37</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="Project2d" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Project2d<a href="#Project2d" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Project2d<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>vector3<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol">&gt;</span>, testModel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveProject2d.ts:5</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>vector3<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol">&gt;</span>, testModel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>vector3: <span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5>testModel: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"><a id="FiveCanvas" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> Five<wbr/>Canvas<a href="#FiveCanvas" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Canvas<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DefineComponent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">VNode</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">RendererNode</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">RendererElement</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ComponentOptionsMixin</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ComponentOptionsMixin</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">PublicProps</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ExtractPropTypes</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/FiveCanvas.ts:23</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>vue | 如视 Five SDK - v6.0.0-alpha.5</title><meta name="description" content="Documentation for 如视 Five SDK - v6.0.0-alpha.5"/><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 - v6.0.0-alpha.5</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 - v6.0.0-alpha.5</a></li><li><a href="vue.html">vue</a></li></ul><h1>Module vue </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>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/vue.FiveActionVueCallbacks.html" class="tsd-kind-icon">Five<wbr/>Action<wbr/>Vue<wbr/>Callbacks</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="vue.html#FiveModelIntersectRaycaster" class="tsd-kind-icon">Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="vue.html#FiveProviderComponent" class="tsd-kind-icon">Five<wbr/>Provider<wbr/>Component</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="vue.html#Project2d" class="tsd-kind-icon">Project2d</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="vue.html#FiveCanvas" class="tsd-kind-icon">Five<wbr/>Canvas</a></li><li class="tsd-kind-variable tsd-parent-kind-module"><a href="vue.html#FiveProvider" class="tsd-kind-icon">Five<wbr/>Provider</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"><a href="vue.html#unsafe__useFiveInject" class="tsd-kind-icon">unsafe__use<wbr/>Five<wbr/>Inject</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveAction" class="tsd-kind-icon">use<wbr/>Five<wbr/>Action</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.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="vue.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="vue.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="vue.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="vue.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="vue.html#useFiveFloor" class="tsd-kind-icon">use<wbr/>Five<wbr/>Floor</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveHelper" class="tsd-kind-icon">use<wbr/>Five<wbr/>Helper</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveModel" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveModelBounding" class="tsd-kind-icon">use<wbr/>Five<wbr/>Model<wbr/>Bounding</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.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="vue.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="vue.html#useFiveProject2d" class="tsd-kind-icon">use<wbr/>Five<wbr/>Project2d</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveScene" class="tsd-kind-icon">use<wbr/>Five<wbr/>Scene</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveState" class="tsd-kind-icon">use<wbr/>Five<wbr/>State</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="vue.html#useFiveWorks" class="tsd-kind-icon">use<wbr/>Five<wbr/>Works</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="FiveModelIntersectRaycaster" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster<a href="#FiveModelIntersectRaycaster" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Model<wbr/>Intersect<wbr/>Raycaster<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>raycaster<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveModelIntersectRaycaster.ts:7</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>raycaster<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>raycaster: <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Raycaster</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">THREE.Raycaster</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.Intersection.html" class="tsd-signature-type" data-tsd-kind="Interface">Intersection</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="FiveProviderComponent" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Five<wbr/>Provider<wbr/>Component<a href="#FiveProviderComponent" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Provider<wbr/>Component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DefineComponent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>fiveInitArgs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.FiveInitArgs.html" class="tsd-signature-type" data-tsd-kind="Interface">FiveInitArgs</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;renderer&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;scissor&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>default<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>initialState<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">&quot;inherit&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;initial&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;offset&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>initialUserAction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BooleanConstructor</span><span class="tsd-signature-symbol">; </span>initialWorks<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>onCurrentStateChange<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a>, userAction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>onError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>onStateChange<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../interfaces/five.State.html" class="tsd-signature-type" data-tsd-kind="Interface">State</a>, userAction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>onWorksChange<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>work<span class="tsd-signature-symbol">: </span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ObjectConstructor</span><span class="tsd-signature-symbol">; </span>works<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Work.html" class="tsd-signature-type" data-tsd-kind="Class">Work</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>five<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/five.Five.html" class="tsd-signature-type" data-tsd-kind="Class">Five</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/FiveProvider.ts:37</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="Project2d" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Project2d<a href="#Project2d" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Project2d<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>vector3<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol">&gt;</span>, testModel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/useFiveProject2d.ts:5</li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>vector3<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol">&gt;</span>, testModel<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>vector3: <span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector3</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5>testModel: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Ref</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">THREE.Vector2</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module"><a id="FiveCanvas" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> Five<wbr/>Canvas<a href="#FiveCanvas" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Five<wbr/>Canvas<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DefineComponent</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">VNode</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">RendererNode</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">RendererElement</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ComponentOptionsMixin</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ComponentOptionsMixin</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">PublicProps</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">ExtractPropTypes</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>required<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PropType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in lib/vue/hooks/FiveCanvas.ts:23</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
 <p>Five 渲染区域组件</p>
 </div><dl class="tsd-comment-tags"><dt>description</dt><dd><p>Five 渲染区域组件，请在 FiveProvider 内使用</p>
 </dd><dt>param width</dt><dd><p>渲染区域的宽度</p>

package/docs/modules.html CHANGED Viewed

	@@ -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 - v6.0.0-alpha.4</title><meta name="description" content="Documentation for 如视 Five SDK - v6.0.0-alpha.4"/><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 - v6.0.0-alpha.4</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 - v6.0.0-alpha.4 </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/sticker.html" class="tsd-kind-icon">sticker</a></li><li class="tsd-kind-module"><a href="modules/vfx.html" class="tsd-kind-icon">vfx</a></li><li class="tsd-kind-module"><a href="modules/vue.html" class="tsd-kind-icon">vue</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/sticker.html">sticker</a></li><li class=" tsd-kind-module"><a href="modules/vfx.html">vfx</a></li><li class=" tsd-kind-module"><a href="modules/vue.html">vue</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><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</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>
1	+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>如视 Five SDK - v6.0.0-alpha.5</title><meta name="description" content="Documentation for 如视 Five SDK - v6.0.0-alpha.5"/><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 - v6.0.0-alpha.5</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 - v6.0.0-alpha.5 </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/sticker.html" class="tsd-kind-icon">sticker</a></li><li class="tsd-kind-module"><a href="modules/vfx.html" class="tsd-kind-icon">vfx</a></li><li class="tsd-kind-module"><a href="modules/vue.html" class="tsd-kind-icon">vue</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/sticker.html">sticker</a></li><li class=" tsd-kind-module"><a href="modules/vfx.html">vfx</a></li><li class=" tsd-kind-module"><a href="modules/vue.html">vue</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><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</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 Viewed

@@ -604,11 +604,17 @@ export declare class Five extends Subscribe<EventTypes> {
      */
     get enableIOSEDR(): boolean;
     set enableIOSEDR(enable: boolean);
+    /**
+     * 后处理类型
+     */
+    get postProcessingType(): PostProcessingType;
     /**
      * 是否开启EDL模式
      */
     get enableEDL(): boolean;
     set enableEDL(enable: boolean);
+    get enableHQ(): boolean;
+    set enableHQ(enable: boolean);
     /**
      * 是否开启后处理
      */
@@ -1836,7 +1842,7 @@ export declare interface ModelLodOptions {
     maxDepth?: number;
 }
-export declare type ModelMaterialValues = Pick<PBMParameters, 'pano0' | 'pano1' | 'modelAlpha' | 'progress' | 'useBlackTransition' | 'opacity' | 'constantColor' | 'useEDL' | 'pointShape' | 'pointColorType' | 'pointSizeType' | 'pointSize' | 'pointMinSize' | 'pointMaxSize' | 'pointSizeAdaptiveScale' | 'gradientTexture'>;
+export declare type ModelMaterialValues = Pick<PBMParameters, 'pano0' | 'pano1' | 'modelAlpha' | 'progress' | 'useBlackTransition' | 'opacity' | 'constantColor' | 'useEDL' | 'useHQWeight' | 'useHQDepth' | 'pointShape' | 'pointColorType' | 'pointSizeType' | 'pointSize' | 'pointMinSize' | 'pointMaxSize' | 'pointSizeAdaptiveScale' | 'gradientTexture'>;
 export declare type Models = Model[] & {
     needsRender: boolean;
@@ -2258,6 +2264,10 @@ export declare class PBMMeshMaterial extends THREE_2.ShaderMaterial implements P
     clippers: ClipperParameter[] | null;
     /** edl*/
     useEDL: boolean;
+    /** hq*/
+    useHQWeight: boolean;
+    /** HQDepthMask*/
+    useHQDepth: boolean;
     /** 点云着色方式*/
     pointColorType: PBMPointColorType;
     /** 点云大小绘制方式*/
@@ -2309,6 +2319,10 @@ export declare interface PBMParameters {
     constantColor: THREE_2.Vector3 | null;
     /** 是否使用EDL*/
     useEDL: boolean;
+    /** 是否使用HQ*/
+    useHQWeight: boolean;
+    /** 是否使用HQ_DEPTH_MASK*/
+    useHQDepth: boolean;
     /** 点云形状*/
     pointShape: PBMPointShapeType;
     /** 点云着色方式*/
@@ -2359,6 +2373,8 @@ export declare interface Pose {
     distance: number;
 }
+export declare type PostProcessingType = 'edl' | 'hq' | 'luminance' | null;
 export declare const PROXY_CONTROLLER_EVENT_NAMES: readonly ["gesture.pan", "gesture.tap", "gesture.press", "gesture.pinch", "gesture.mousewheel", "gesture.mousemove", "gesture.momentum", "initAnimation.start", "initAnimation.end", "camera.update", "intersect.update", "pano.select", "pano.moveTo", "pano.moving", "pano.arrived", "pano.cancel", "pano.error", "pano.texture.load", "pano.texture.progress", "pano.texture.success", "pano.texture.error", "pano.texture.abort", "xr.session.start", "xr.session.end", "xr.gesture.tap"];
 export declare class RegionBoundingVolume implements BoundingVolume {