@realsee/five 6.8.0-alpha.1 → 6.8.0-alpha.11
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/AGENTS_READ_ME.md +4 -0
- package/AI_CONTEXT.md +4 -0
- package/README.md +64 -13
- package/ai_guides/README.md +122 -0
- package/ai_guides/ai-doc-guidelines.md +102 -0
- package/ai_guides/api.md +274 -0
- package/ai_guides/features/3dtile.md +172 -0
- package/ai_guides/features/camera-animation.md +205 -0
- package/ai_guides/features/clipper.md +135 -0
- package/ai_guides/features/coordinate-system.md +128 -0
- package/ai_guides/features/event.md +154 -0
- package/ai_guides/features/five.md +184 -0
- package/ai_guides/features/flowing-light-2d-pass.md +438 -0
- package/ai_guides/features/flowing-light-3d-pass.md +420 -0
- package/ai_guides/features/gaussian-blur-pass.md +202 -0
- package/ai_guides/features/gesture.md +180 -0
- package/ai_guides/features/get-screen-pixels.md +182 -0
- package/ai_guides/features/image-options.md +164 -0
- package/ai_guides/features/load-external-model.md +350 -0
- package/ai_guides/features/load-progress.md +140 -0
- package/ai_guides/features/material.md +151 -0
- package/ai_guides/features/mode.md +269 -0
- package/ai_guides/features/model.md +186 -0
- package/ai_guides/features/move-pano-effect.md +145 -0
- package/ai_guides/features/multi-work.md +146 -0
- package/ai_guides/features/pano-tile.md +132 -0
- package/ai_guides/features/pano-uv.md +131 -0
- package/ai_guides/features/parameter.md +153 -0
- package/ai_guides/features/plugin.md +210 -0
- package/ai_guides/features/postprocessing.md +259 -0
- package/ai_guides/features/raycast.md +175 -0
- package/ai_guides/features/request-proxy.md +112 -0
- package/ai_guides/features/screen-project.md +165 -0
- package/ai_guides/features/state.md +101 -0
- package/ai_guides/features/view-layer.md +187 -0
- package/ai_guides/features/work.md +303 -0
- package/ai_guides/glossary.md +93 -0
- package/ai_guides/intro.md +23 -0
- package/ai_guides/quick-start.md +69 -0
- package/ai_guides/release_notes/6.6.md +86 -0
- package/ai_guides/release_notes/6.7.md +401 -0
- package/ai_guides/release_notes/6.8.md +90 -0
- package/ai_guides/support.md +23 -0
- package/ai_guides/template.md +70 -0
- package/docs/00_FOR_AI_AGENTS.md +11 -0
- package/docs/README.md +11 -0
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/highlight.css +33 -19
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/five.AdaptiveLuminancePass.html +1 -1
- package/docs/classes/five.BoundingMesh.html +1 -1
- package/docs/classes/five.Camera.html +1 -1
- package/docs/classes/five.EyeDomeLightingPass.html +1 -1
- package/docs/classes/five.Five.html +75 -81
- package/docs/classes/five.FivePass.html +1 -1
- package/docs/classes/five.InternalWebGLRenderer.html +1 -1
- package/docs/classes/five.Model.html +32 -32
- package/docs/classes/five.ModelScene.html +1 -1
- package/docs/classes/five.NetworkSubscribe.html +2 -2
- package/docs/classes/five.PBMContainer.html +1 -1
- package/docs/classes/five.PBMGSObject.html +14 -12
- package/docs/classes/five.PBMGroup.html +1 -1
- package/docs/classes/five.PBMMesh.html +1 -1
- package/docs/classes/five.PBMMeshMaterial.html +15 -6
- package/docs/classes/five.PBMPointCloud.html +1 -1
- package/docs/classes/five.PBMPointCloudMaterial.html +1 -1
- package/docs/classes/five.PBMSkinnedMesh.html +1 -1
- package/docs/classes/five.PanoCircleMesh.html +1 -1
- package/docs/classes/five.PanoCircleMeshCustom.html +1 -1
- package/docs/classes/five.PanoCircleMeshSolid.html +1 -1
- package/docs/classes/five.Parameter.html +54 -50
- package/docs/classes/five.Scene.html +1 -1
- package/docs/classes/five.Subscribe.html +2 -2
- package/docs/classes/five.Tile.html +1 -1
- package/docs/classes/five.Tile3D.html +30 -26
- package/docs/classes/five.TileNode.html +1 -1
- package/docs/classes/five.Trajectory.html +1 -1
- package/docs/classes/five.TrajectoryNode.html +1 -1
- package/docs/classes/five.Work.html +16 -16
- package/docs/classes/five.WorkResolvedObserver.html +28 -3
- 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 +2 -2
- package/docs/classes/gltf-loader.GLTFObject.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/plugins.BasePlugin.Controller.html +1 -1
- package/docs/classes/plugins.RoundedBoxGeometry.html +1 -1
- package/docs/classes/react.Store.html +1 -1
- package/docs/classes/sticker.Sticker.html +2 -2
- 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.ParticleGPU.html +1 -1
- package/docs/classes/vfx.SpotLight.html +1 -1
- package/docs/documents/README.html +138 -0
- package/docs/documents/ai-doc-guidelines.html +117 -0
- package/docs/documents/api.html +337 -0
- package/docs/documents/features_3dtile.html +216 -0
- package/docs/documents/features_camera-animation.html +157 -0
- package/docs/documents/features_clipper.html +80 -0
- package/docs/documents/features_coordinate-system.html +127 -0
- package/docs/documents/features_event.html +104 -0
- package/docs/documents/features_five.html +147 -0
- package/docs/documents/features_flowing-light-2d-pass.html +356 -0
- package/docs/documents/features_flowing-light-3d-pass.html +351 -0
- package/docs/documents/features_gaussian-blur-pass.html +182 -0
- package/docs/documents/features_gesture.html +120 -0
- package/docs/documents/features_get-screen-pixels.html +88 -0
- package/docs/documents/features_image-options.html +108 -0
- package/docs/documents/features_load-external-model.html +600 -0
- package/docs/documents/features_load-progress.html +110 -0
- package/docs/documents/features_material.html +334 -0
- package/docs/documents/features_mode.html +114 -0
- package/docs/documents/features_model.html +141 -0
- package/docs/documents/features_move-pano-effect.html +110 -0
- package/docs/documents/features_multi-work.html +97 -0
- package/docs/documents/features_pano-tile.html +100 -0
- package/docs/documents/features_pano-uv.html +82 -0
- package/docs/documents/features_parameter.html +101 -0
- package/docs/documents/features_plugin.html +105 -0
- package/docs/documents/features_postprocessing.html +109 -0
- package/docs/documents/features_raycast.html +98 -0
- package/docs/documents/features_request-proxy.html +78 -0
- package/docs/documents/features_screen-project.html +112 -0
- package/docs/documents/features_state.html +71 -0
- package/docs/documents/features_view-layer.html +158 -0
- package/docs/documents/features_work.html +129 -0
- package/docs/documents/glossary.html +94 -0
- package/docs/documents/intro.html +24 -6
- package/docs/documents/quick-start.html +23 -45
- package/docs/documents/release_notes_6.6.html +79 -0
- package/docs/documents/release_notes_6.7.html +14 -14
- package/docs/documents/release_notes_6.8.html +103 -0
- package/docs/documents/support.html +39 -15
- package/docs/documents/template.html +80 -0
- package/docs/functions/five.loadAt3d.html +1 -1
- package/docs/functions/five.loadB3dm.html +1 -1
- package/docs/functions/five.loadDome.html +1 -1
- package/docs/functions/five.loadDomez.html +1 -1
- package/docs/functions/five.loadFbx.html +1 -1
- package/docs/functions/five.loadGltf.html +1 -1
- package/docs/functions/five.loadPbm.html +1 -1
- package/docs/functions/five.loadPly.html +1 -1
- package/docs/functions/five.loadPnts.html +1 -1
- package/docs/functions/five.loadSplat.html +1 -1
- package/docs/functions/five.loadSpz.html +1 -1
- package/docs/functions/five.loadX3p.html +1 -1
- package/docs/functions/five.parseWork.html +1 -1
- package/docs/functions/react.createFiveProvider.html +1 -1
- package/docs/functions/react.useFiveAction.html +6 -6
- package/docs/functions/react.useFiveCurrentObserver.html +1 -1
- package/docs/functions/react.useFiveCurrentState.html +1 -1
- package/docs/functions/react.useFiveEventCallback.html +1 -1
- package/docs/functions/react.useFiveFloor.html +1 -1
- package/docs/functions/react.useFiveHelper.html +1 -1
- package/docs/functions/react.useFiveModelIntersectRaycaster.html +2 -2
- package/docs/functions/react.useFiveProject2d.html +2 -2
- package/docs/functions/react.useFiveSceneEffect.html +1 -1
- package/docs/functions/react.useFiveWork.html +2 -2
- package/docs/functions/vue.useFiveAction.html +8 -8
- package/docs/functions/vue.useFiveCurrentObserver.html +1 -1
- package/docs/functions/vue.useFiveCurrentState.html +1 -1
- package/docs/functions/vue.useFiveEventCallback.html +1 -1
- package/docs/functions/vue.useFiveFloor.html +1 -1
- package/docs/functions/vue.useFiveHelper.html +1 -1
- package/docs/functions/vue.useFiveModelIntersectRaycaster.html +2 -2
- package/docs/functions/vue.useFiveProject2d.html +2 -2
- package/docs/functions/vue.useFiveState.html +1 -1
- package/docs/functions/vue.useFiveWorks.html +4 -4
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +135 -34
- package/docs/interfaces/five.AddableObject.html +1 -1
- package/docs/interfaces/five.AjaxOptions.html +1 -1
- package/docs/interfaces/five.BaseEvent.html +2 -2
- package/docs/interfaces/five.EventCallback.html +15 -11
- package/docs/interfaces/five.FiveInitArgs.html +2 -2
- package/docs/interfaces/five.GestureEvent.html +2 -2
- package/docs/interfaces/five.ImageOptions.html +1 -1
- package/docs/interfaces/five.IntersectEvent.html +2 -2
- package/docs/interfaces/five.IntersectMesh.html +1 -1
- package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
- package/docs/interfaces/five.Intersection.html +4 -3
- package/docs/interfaces/five.LooseWorkWithExtrinsics.html +6 -6
- package/docs/interfaces/five.ModeChangeEvent.html +2 -2
- package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.ModelEvent.html +2 -2
- package/docs/interfaces/five.ModelSceneEvent.html +2 -2
- package/docs/interfaces/five.ModelTileEvent.html +8 -0
- package/docs/interfaces/five.MovePanoOptions.html +4 -4
- package/docs/interfaces/five.NetworkAbortError.html +1 -1
- package/docs/interfaces/five.NetworkFirbiddenError.html +1 -1
- package/docs/interfaces/five.NetworkOptions.html +1 -1
- package/docs/interfaces/five.NetworkProxyError.html +1 -1
- package/docs/interfaces/five.NetworkResourceEvent.html +2 -2
- package/docs/interfaces/five.NetworkResponseError.html +1 -1
- package/docs/interfaces/five.NetworkTimeoutError.html +1 -1
- package/docs/interfaces/five.ObjectEvent.html +2 -2
- package/docs/interfaces/five.PBMMaterial.html +1 -1
- package/docs/interfaces/five.PBMMeshMaterialParameters.html +1 -1
- package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +1 -1
- package/docs/interfaces/five.PanoCircleMeshInterface.html +1 -1
- package/docs/interfaces/five.PanoEvent.html +2 -2
- package/docs/interfaces/five.PanoTextureEvent.html +2 -2
- package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.ParameterMaterialValue.html +39 -35
- package/docs/interfaces/five.ParameterTilesetValue.html +15 -15
- package/docs/interfaces/five.ParameterValue.html +53 -49
- package/docs/interfaces/five.Pose.html +6 -7
- package/docs/interfaces/five.RenderEvent.html +2 -2
- package/docs/interfaces/five.ResolvedParameterValue.html +53 -49
- package/docs/interfaces/five.SplatData.html +10 -0
- package/docs/interfaces/five.State.html +6 -6
- package/docs/interfaces/five.StateEvent.html +2 -2
- package/docs/interfaces/five.TextureOptions.html +1 -1
- package/docs/interfaces/five.Tile3DOptions.html +2 -2
- package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.ViewLayer.html +30 -26
- package/docs/interfaces/five.WorkCubeImage.html +1 -1
- package/docs/interfaces/five.WorkImage.html +1 -1
- package/docs/interfaces/five.WorkModel.html +8 -8
- package/docs/interfaces/five.WorkModelLayer.html +6 -6
- package/docs/interfaces/five.WorkObserver.html +28 -3
- package/docs/interfaces/five.WorkTile.html +1 -1
- package/docs/interfaces/five.WorksEvent.html +2 -2
- package/docs/interfaces/five.XRControllerEvent.html +2 -2
- package/docs/interfaces/five.XRGestureEvent.html +2 -2
- package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.XRSessionEvent.html +2 -2
- package/docs/interfaces/plugins.BackgroundPluginController.html +1 -1
- package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +1 -1
- package/docs/interfaces/plugins.BasePlugin.State.html +1 -1
- package/docs/interfaces/plugins.DynamicPathLinePluginController.html +1 -1
- package/docs/interfaces/plugins.DynamicPathLinePluginType.EventMap.html +1 -1
- package/docs/interfaces/plugins.DynamicPathLinePluginType.State.html +1 -1
- package/docs/interfaces/plugins.ItemMaskController.html +1 -1
- package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +1 -1
- package/docs/interfaces/plugins.ItemMaskPluginType.State.html +1 -1
- package/docs/interfaces/plugins.OrientationPluginController.html +1 -1
- package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +1 -1
- package/docs/interfaces/plugins.OrientationPluginType.State.html +1 -1
- package/docs/interfaces/plugins.PanoAnimeController.html +1 -1
- package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +1 -1
- package/docs/interfaces/plugins.PanoAnimePluginType.State.html +1 -1
- package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +1 -1
- package/docs/interfaces/plugins.PluginTemplateType.State.html +1 -1
- package/docs/interfaces/plugins.TrajectoryController.html +1 -1
- package/docs/interfaces/react.FiveInjectionTypes.html +14 -14
- package/docs/modules/five.html +1 -1
- package/docs/modules.html +1 -1
- package/docs/types/five.EventTypes.html +12 -10
- package/docs/types/five.FivePlugin.html +1 -1
- package/docs/types/five.FivePluginInit.html +1 -1
- package/docs/types/five.FivePluginInstance.html +1 -1
- package/docs/types/five.NetworkProgressCallback.html +1 -1
- package/docs/types/five.ParseOptions.html +6 -6
- package/docs/types/plugins.BasePlugin.EventMap.html +1 -1
- package/docs/variables/react.FiveCanvas.html +1 -1
- package/docs/variables/react.useFiveScene.html +1 -1
- package/docs/variables/vue.FiveCanvas.html +1 -1
- package/docs/variables/vue.FiveProvider.html +1 -1
- package/five/application/analysis.d.ts +40 -0
- package/five/application/controllers.d.ts +41 -0
- package/five/application/events-legacy.d.ts +454 -0
- package/five/application/events.d.ts +69 -0
- package/five/application/five.d.ts +518 -0
- package/five/application/fiveInitArgs.d.ts +176 -0
- package/five/application/fiveLoadOptions.d.ts +21 -0
- package/five/application/generateDefaultVideoElement.d.ts +2 -0
- package/five/application/getViewportScale.d.ts +2 -0
- package/five/application/initLights.d.ts +3 -0
- package/five/application/mode.d.ts +28 -0
- package/five/application/renderPoweredByRealsee.d.ts +3 -0
- package/five/assets/cardboard-png-data-url.d.ts +2 -0
- package/five/assets/gradient-png-data-url.d.ts +2 -0
- package/five/assets/loading-png-data-url.d.ts +2 -0
- package/five/assets/phone-png-data-url.d.ts +2 -0
- package/five/assets/realsee-pmg-data-url.d.ts +2 -0
- package/five/bvh/bvhMath.d.ts +33 -0
- package/five/bvh/bvhMesh.d.ts +7 -0
- package/five/bvh/bvhNode.d.ts +29 -0
- package/five/bvh/bvhObject.d.ts +18 -0
- package/five/bvh/bvhPoints.d.ts +6 -0
- package/five/bvh/index.d.ts +10 -0
- package/five/bvh/worker.d.ts +35 -0
- package/five/cardboard/helper.d.ts +2 -0
- package/five/cardboard/index.d.ts +13 -0
- package/five/cardboard/sensor.d.ts +158 -0
- package/five/certificates/hardware.d.ts +1 -0
- package/five/controllers/base.d.ts +166 -0
- package/five/controllers/events.d.ts +69 -0
- package/five/controllers/floorplan.d.ts +119 -0
- package/five/controllers/mapview.d.ts +138 -0
- package/five/controllers/model.d.ts +57 -0
- package/five/controllers/panorama.d.ts +143 -0
- package/five/controllers/panoramaLike.d.ts +87 -0
- package/five/controllers/topview.d.ts +42 -0
- package/five/controllers/vrPanorama.d.ts +56 -0
- package/five/controllers/xrPanorama.d.ts +81 -0
- package/five/core/camera.d.ts +65 -0
- package/five/core/internalWebGLRenderer.d.ts +14 -0
- package/five/core/panoVideo.d.ts +18 -0
- package/five/core/scene.d.ts +10 -0
- package/five/core/tiling.d.ts +43 -0
- package/five/declare.d.ts +2 -1
- package/five/gs/util/renderData.d.ts +32 -0
- package/five/gs/wasm/data.d.ts +20 -0
- package/five/gs/wasm/sort.d.ts +18 -0
- package/five/gs/worker/dataWorker.d.ts +1 -0
- package/five/gs/worker/sortWorker.d.ts +1 -0
- package/five/index.d.ts +57 -4644
- package/five/index.js +503 -78
- package/five/index.mjs +6386 -5154
- package/five/meshes/boundingMesh.d.ts +12 -0
- package/five/meshes/intersectMesh.d.ts +8 -0
- package/five/meshes/panoCircleMesh.d.ts +35 -0
- package/five/meshes/panoCircleMeshCustom.d.ts +40 -0
- package/five/meshes/panoCircleMeshSolid.d.ts +34 -0
- package/five/meshes/panoSphereMesh.d.ts +27 -0
- package/five/model/helpers/coordinate-transform.d.ts +3 -0
- package/five/model/helpers/ellipsoid-coordinates.d.ts +14 -0
- package/five/model/helpers/get-edges-by-sphere.d.ts +8 -0
- package/five/model/helpers/get-recommend-tile3d-parameters.d.ts +8 -0
- package/five/model/index.d.ts +70 -0
- package/five/model/intersection.d.ts +18 -0
- package/five/model/loaders/at3d.d.ts +12 -0
- package/five/model/loaders/b3dm.d.ts +9 -0
- package/five/model/loaders/dome.d.ts +22 -0
- package/five/model/loaders/domez.d.ts +11 -0
- package/five/model/loaders/fbx.d.ts +8 -0
- package/five/model/loaders/glTF-helpers/extensions/CESIUM_RTC.d.ts +9 -0
- package/five/model/loaders/glTF-helpers/extensions/EXT_meshopt_compression.d.ts +8 -0
- package/five/model/loaders/glTF-helpers/extensions/EXT_texture_webp.d.ts +11 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_animation_pointer.d.ts +6 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_binary_glTF.d.ts +25 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_draco_mesh_compression.d.ts +11 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz.d.ts +9 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_materials_clearcoat.d.ts +10 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_materials_emissive_strength.d.ts +10 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_materials_sheen.d.ts +10 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_materials_transmission.d.ts +10 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_materials_unlit.d.ts +10 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_mesh_quantization.d.ts +6 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_node_visibility.d.ts +10 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_texture_basisu.d.ts +9 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_texture_transform.d.ts +10 -0
- package/five/model/loaders/glTF-helpers/extensions/REALSEE_materials_lightmap.d.ts +7 -0
- package/five/model/loaders/glTF-helpers/extensions/base.d.ts +24 -0
- package/five/model/loaders/glTF-helpers/glTF.d.ts +713 -0
- package/five/model/loaders/glTF-helpers/index.d.ts +47 -0
- package/five/model/loaders/glTF-helpers/parser.d.ts +114 -0
- package/five/model/loaders/glTF-helpers/type.d.ts +14 -0
- package/five/model/loaders/gltf.d.ts +10 -0
- package/five/model/loaders/obj.d.ts +9 -0
- package/five/model/loaders/pbm.d.ts +26 -0
- package/five/model/loaders/ply.d.ts +24 -0
- package/five/model/loaders/pnts.d.ts +8 -0
- package/five/model/loaders/protobuf/dome.d.ts +540 -0
- package/five/model/loaders/protobuf/pbm.d.ts +203 -0
- package/five/model/loaders/shared.d.ts +16 -0
- package/five/model/loaders/splat.d.ts +8 -0
- package/five/model/loaders/spz.d.ts +14 -0
- package/five/model/loaders/tile3d-helpers/feature-table.d.ts +15 -0
- package/five/model/loaders/tile3d-helpers/gl-type.d.ts +20 -0
- package/five/model/loaders/tile3d-helpers/parse-gltf-array-buffer.d.ts +2 -0
- package/five/model/loaders/tile3d-helpers/parse-header.d.ts +2 -0
- package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.d.ts +2 -0
- package/five/model/loaders/tile3d-helpers/parse-point-cloud-attributes.worker.d.ts +6 -0
- package/five/model/loaders/tile3d-helpers/parse-table.d.ts +3 -0
- package/five/model/loaders/tile3d-helpers/tile3d-type.d.ts +35 -0
- package/five/model/loaders/x3p.d.ts +22 -0
- package/five/model/materials/pbmMaterial.d.ts +87 -0
- package/five/model/materials/pbmMeshMaterial.d.ts +124 -0
- package/five/model/materials/pbmPointCloudMaterial.d.ts +72 -0
- package/five/model/model-scene.d.ts +172 -0
- package/five/model/model.d.ts +209 -0
- package/five/model/objects/pbmContainer.d.ts +28 -0
- package/five/model/objects/pbmGSObject.d.ts +40 -0
- package/five/model/objects/pbmGSRenderMesh.d.ts +32 -0
- package/five/model/objects/pbmGroup.d.ts +8 -0
- package/five/model/objects/pbmMesh.d.ts +10 -0
- package/five/model/objects/pbmPointCloud.d.ts +7 -0
- package/five/model/parameter.d.ts +136 -0
- package/five/model/shaders/pbm_gaussian_splatting/fragment.d.ts +2 -0
- package/five/model/shaders/pbm_gaussian_splatting/vertex.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_basic/fragment.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_basic/vertex.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_none/fragment.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_none/vertex.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_phong/fragment.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_phong/vertex.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_standard/fragment.d.ts +2 -0
- package/five/model/shaders/pbm_mesh_standard/vertex.d.ts +2 -0
- package/five/model/shaders/pbm_pointcloud/fragment.d.ts +2 -0
- package/five/model/shaders/pbm_pointcloud/vertex.d.ts +2 -0
- package/five/model/tile3d/header.d.ts +88 -0
- package/five/model/tile3d/index.d.ts +214 -0
- package/five/model/tile3d/tile-cache.d.ts +18 -0
- package/five/model/tile3d/tile-content.d.ts +10 -0
- package/five/model/tile3d/tile-node.d.ts +24 -0
- package/five/model/tile3d/tile-request-scheduler.d.ts +17 -0
- package/five/model/tile3d/tile.d.ts +79 -0
- package/five/model/tile3d/tileset-base-traverser.d.ts +59 -0
- package/five/model/tile3d/tileset-most-detail-traverser.d.ts +14 -0
- package/five/model/tile3d/tileset-normal-traverser.d.ts +15 -0
- package/five/model/tile3d/tileset-skip-traverser.d.ts +60 -0
- package/five/model/tile3d/tileset.d.ts +69 -0
- package/five/model/tile3d/trajectory-content.d.ts +9 -0
- package/five/model/tile3d/trajectory-node.d.ts +15 -0
- package/five/model/tile3d/trajectory.d.ts +30 -0
- package/five/model/tile3d/types.d.ts +33 -0
- package/five/model/view-layer.d.ts +20 -0
- package/five/renderer/five-renderer.d.ts +17 -0
- package/five/renderer/index.d.ts +3 -0
- package/five/renderer/postprocessing/composer.d.ts +37 -0
- package/five/renderer/postprocessing/index.d.ts +7 -0
- package/five/renderer/postprocessing/passes/adaptive-luminance-pass.d.ts +15 -0
- package/five/renderer/postprocessing/passes/eye-dome-lighting-pass.d.ts +14 -0
- package/five/renderer/postprocessing/passes/flowing-light-2d-pass.d.ts +36 -0
- package/five/renderer/postprocessing/passes/flowing-light-3d-pass.d.ts +36 -0
- package/five/renderer/postprocessing/passes/gaussian-blur-pass.d.ts +12 -0
- package/five/renderer/postprocessing/passes/pass.d.ts +38 -0
- package/five/renderer/scene-renderers/point-cloud-high-quality-scene-renderer.d.ts +11 -0
- package/five/renderer/scene-renderers/scene-renderer.d.ts +9 -0
- package/five/renderer/scene-renderers/ssaa-scene-renderer.d.ts +15 -0
- package/five/renderer/tools/full-screen-quad.d.ts +15 -0
- package/five/renderer/tools/render-full-screen-depth.d.ts +2 -0
- package/five/renderer/tools/render-full-screen.d.ts +2 -0
- package/five/texture/imageBitmap.d.ts +13 -0
- package/five/texture/initTexture.d.ts +3 -0
- package/five/texture/loader.d.ts +39 -0
- package/five/thirdparty/fflate.d.ts +1407 -0
- package/five/thirdparty/hammer.d.ts +259 -0
- package/five/thirdparty/jsrsasign.d.ts +768 -0
- package/five/thirdparty/meshopt_decoder.d.ts +15 -0
- package/five/three-version-check.d.ts +1 -0
- package/five/types/addableObject.d.ts +12 -0
- package/five/types/cube.d.ts +1 -0
- package/five/types/gestureInput.d.ts +24 -0
- package/five/types/imageOptions.d.ts +20 -0
- package/five/types/intersectMeshInterface.d.ts +8 -0
- package/five/types/movePanoEffect.d.ts +13 -0
- package/five/types/movePanoOptions.d.ts +35 -0
- package/five/types/panoCircleMeshInterface.d.ts +34 -0
- package/five/types/plugin.d.ts +25 -0
- package/five/types/pose.d.ts +17 -0
- package/five/types/state.d.ts +20 -0
- package/five/types/viewport.d.ts +22 -0
- package/five/utils/ajax.d.ts +66 -0
- package/five/utils/animationFrameLoop.d.ts +45 -0
- package/five/utils/array.d.ts +31 -0
- package/five/utils/asyncTaskQueue.d.ts +8 -0
- package/five/utils/bufferGeometry.d.ts +33 -0
- package/five/utils/calculateProgress.d.ts +39 -0
- package/five/utils/calculateThreeMouse.d.ts +13 -0
- package/five/utils/canplayVideo.d.ts +2 -0
- package/five/utils/clamp.d.ts +2 -0
- package/five/utils/clock.d.ts +17 -0
- package/five/utils/createSymbol.d.ts +5 -0
- package/five/utils/decodeText.d.ts +2 -0
- package/five/utils/deepEqual.d.ts +2 -0
- package/five/utils/deepFreeze.d.ts +2 -0
- package/five/utils/defineProperty.d.ts +9 -0
- package/five/utils/detector.d.ts +14 -0
- package/five/utils/distance.d.ts +10 -0
- package/five/utils/draco.d.ts +26 -0
- package/five/utils/easing.d.ts +63 -0
- package/five/utils/event.d.ts +149 -0
- package/five/utils/formatRad.d.ts +7 -0
- package/five/utils/imageSupport.d.ts +6 -0
- package/five/utils/imageURL.d.ts +42 -0
- package/five/utils/isEmptyObject.d.ts +2 -0
- package/five/utils/isNil.d.ts +6 -0
- package/five/utils/isNumber.d.ts +2 -0
- package/five/utils/isPowerOfTwo.d.ts +2 -0
- package/five/utils/isPromise.d.ts +2 -0
- package/five/utils/isSimilar.d.ts +6 -0
- package/five/utils/json.d.ts +7 -0
- package/five/utils/ktx2.d.ts +30 -0
- package/five/utils/lzma/index.d.ts +2 -0
- package/five/utils/lzma/lzma.d.ts +3 -0
- package/five/utils/lzma/lzmaWASM.d.ts +2 -0
- package/five/utils/lzma/lzmaWorker.d.ts +14 -0
- package/five/utils/memoryUsage.d.ts +29 -0
- package/five/utils/motion.d.ts +38 -0
- package/five/utils/noop.d.ts +6 -0
- package/five/utils/now.d.ts +7 -0
- package/five/utils/pano.d.ts +9 -0
- package/five/utils/pick.d.ts +3 -0
- package/five/utils/poseUtils.d.ts +5 -0
- package/five/utils/renderCubeTextureToCubeRenderTarget.d.ts +3 -0
- package/five/utils/renderDepth.d.ts +2 -0
- package/five/utils/renderTexturesToCubeRenderTarget.d.ts +10 -0
- package/five/utils/requestPermission.d.ts +3 -0
- package/five/utils/shaderContentFix.d.ts +7 -0
- package/five/utils/shaderMaterial.d.ts +20 -0
- package/five/utils/stateUtils.d.ts +5 -0
- package/five/utils/string-pattern.d.ts +8 -0
- package/five/utils/subscribe.d.ts +67 -0
- package/five/utils/tileCube.d.ts +19 -0
- package/five/utils/toFastProperties.d.ts +1 -0
- package/five/utils/typedCache.d.ts +10 -0
- package/five/utils/uniform.d.ts +15 -0
- package/five/utils/url.d.ts +35 -0
- package/five/utils/uuid.d.ts +5 -0
- package/five/utils/values.d.ts +2 -0
- package/five/utils/vectorCoordinates.d.ts +29 -0
- package/five/utils/volume.d.ts +111 -0
- package/five/utils/webglError.d.ts +7 -0
- package/five/utils/worker.d.ts +26 -0
- package/five/webxr/XRControllerModelFactory.d.ts +28 -0
- package/five/webxr/motionHelper.d.ts +68 -0
- package/five/webxr/xrButton.d.ts +4 -0
- package/five/webxr/xrController.d.ts +24 -0
- package/five/webxr/xrManager.d.ts +84 -0
- package/five/work/_ALLOW_HOST.d.ts +2 -0
- package/five/work/index.d.ts +6 -0
- package/five/work/keychain.d.ts +5 -0
- package/five/work/looseWorkType.d.ts +121 -0
- package/five/work/verify.d.ts +7 -0
- package/five/work/work.d.ts +236 -0
- package/five/work/workFetcher.d.ts +4 -0
- package/five/work/workJson.d.ts +3 -0
- package/five/work/workJsonType.d.ts +73 -0
- package/five/work/workObserverUtils.d.ts +36 -0
- package/five/work/workParser.d.ts +6 -0
- package/five/work/workResolvedObserver.d.ts +12 -0
- package/five/work/workVerify.d.ts +2 -0
- package/five/work/works.d.ts +10 -0
- package/gltf-loader/gltf-object.d.ts +17 -0
- package/gltf-loader/index.d.ts +60 -160
- package/gltf-loader/index.js +3 -3
- package/gltf-loader/index.mjs +3 -3
- package/gltf-loader/thirdparty/DDSLoader.d.ts +23 -0
- package/gltf-loader/thirdparty/DRACOLoader.d.ts +18 -0
- package/gltf-loader/thirdparty/GLTFLoader.d.ts +59 -0
- package/line/circle_png.d.ts +1 -0
- package/line/index.d.ts +19 -69
- package/line/index.js +3 -3
- package/line/index.mjs +3 -3
- package/line/utils/Line2.d.ts +7 -0
- package/line/utils/LineGeometry.d.ts +10 -0
- package/line/utils/LineMaterial.d.ts +20 -0
- package/line/utils/LineSegments2.d.ts +11 -0
- package/line/utils/LineSegmentsGeometry.d.ts +15 -0
- package/llms.txt +65 -0
- package/package.json +10 -1
- package/plugins/BackgroundPlugin/Controller.d.ts +20 -0
- package/plugins/BackgroundPlugin/index.d.ts +5 -0
- package/plugins/BackgroundPlugin/typings.d.ts +44 -0
- package/plugins/BasePlugin/index.d.ts +119 -0
- package/plugins/DynamicPathLinePlugin/Controller.d.ts +167 -0
- package/plugins/DynamicPathLinePlugin/index.d.ts +5 -0
- package/plugins/DynamicPathLinePlugin/line2/Line2.d.ts +7 -0
- package/plugins/DynamicPathLinePlugin/line2/LineGeometry.d.ts +10 -0
- package/plugins/DynamicPathLinePlugin/line2/LineMaterial.d.ts +17 -0
- package/plugins/DynamicPathLinePlugin/line2/LineSegments2.d.ts +11 -0
- package/plugins/DynamicPathLinePlugin/line2/LineSegmentsGeometry.d.ts +15 -0
- package/plugins/DynamicPathLinePlugin/typing.d.ts +129 -0
- package/plugins/DynamicPathLinePlugin/typings.d.ts +72 -0
- package/plugins/ItemMaskPlugin/Controller.d.ts +48 -0
- package/plugins/ItemMaskPlugin/index.d.ts +5 -0
- package/plugins/ItemMaskPlugin/typing.d.ts +58 -0
- package/plugins/OrientationPlugin/Controller.d.ts +82 -0
- package/plugins/OrientationPlugin/RoundedBoxGeometry.d.ts +11 -0
- package/plugins/OrientationPlugin/index.d.ts +6 -0
- package/plugins/OrientationPlugin/typing.d.ts +25 -0
- package/plugins/PanoAnimePlugin/Controller.d.ts +46 -0
- package/plugins/PanoAnimePlugin/index.d.ts +5 -0
- package/plugins/PanoAnimePlugin/typing.d.ts +37 -0
- package/plugins/PluginTemplate/Controller.d.ts +27 -0
- package/plugins/PluginTemplate/index.d.ts +5 -0
- package/plugins/PluginTemplate/typing.d.ts +21 -0
- package/plugins/TrajectoryPlugin/Controller.d.ts +85 -0
- package/plugins/TrajectoryPlugin/index.d.ts +6 -0
- package/plugins/TrajectoryPlugin/typing.d.ts +25 -0
- package/plugins/index.d.ts +9 -1102
- package/plugins/index.js +2 -2
- package/plugins/index.mjs +2 -2
- package/plugins/thirdParty/CSS3DRenderer.d.ts +32 -0
- package/plugins/thirdParty/OrbitControls.d.ts +78 -0
- package/plugins/utils/absoluteUrl.d.ts +5 -0
- package/plugins/utils/clamp.d.ts +2 -0
- package/plugins/utils/loadImage.d.ts +1 -0
- package/plugins/utils/motion.d.ts +38 -0
- package/plugins/utils/now.d.ts +6 -0
- package/plugins/utils/uuid.d.ts +5 -0
- package/react/canvas.d.ts +19 -0
- package/react/context.d.ts +11 -0
- package/react/createProvider.d.ts +95 -0
- package/react/createStore.d.ts +144 -0
- package/react/hooks/unsafe__useFiveInstance.d.ts +9 -0
- package/react/hooks/useFiveAction.d.ts +147 -0
- package/react/hooks/useFiveCameraDirection.d.ts +7 -0
- package/react/hooks/useFiveCameraRaycaster.d.ts +7 -0
- package/react/hooks/useFiveCurrentObserver.d.ts +11 -0
- package/react/hooks/useFiveCurrentState.d.ts +15 -0
- package/react/hooks/useFiveEventCallback.d.ts +12 -0
- package/react/hooks/useFiveFloor.d.ts +15 -0
- package/react/hooks/useFiveHelper.d.ts +14 -0
- package/react/hooks/useFiveModelBounding.d.ts +5 -0
- package/react/hooks/useFiveModelEffect.d.ts +14 -0
- package/react/hooks/useFiveModelIntersectRaycaster.d.ts +22 -0
- package/react/hooks/useFiveModelReadyState.d.ts +8 -0
- package/react/hooks/useFiveProject2d.d.ts +20 -0
- package/react/hooks/useFiveSceneEffect.d.ts +21 -0
- package/react/hooks/useFiveState.d.ts +6 -0
- package/react/hooks/useFiveWork.d.ts +29 -0
- package/react/index.d.ts +24 -830
- package/react/index.js +2 -2
- package/react/index.mjs +2 -2
- package/react/rendererPool.d.ts +7 -0
- package/react/withFive.d.ts +213 -0
- package/shader-lib/EvenessPlane/index.d.ts +10 -0
- package/shader-lib/PointCloudExpand/index.d.ts +59 -0
- package/shader-lib/PolygonCuter/index.d.ts +52 -0
- package/shader-lib/PolygonCuter/worker.d.ts +14 -0
- package/shader-lib/ShineModel/index.d.ts +7 -0
- package/shader-lib/SweepModel/index.d.ts +7 -0
- package/shader-lib/index.d.ts +5 -86
- package/shader-lib/index.js +2 -2
- package/shader-lib/index.mjs +2 -2
- package/sticker/geometry.d.ts +3 -0
- package/sticker/index.d.ts +68 -71
- package/sticker/index.js +3 -3
- package/sticker/index.mjs +3 -3
- package/umd/five-gltf-loader.js +3 -3
- package/umd/five-line.js +3 -3
- package/umd/five-plugins.js +2 -2
- package/umd/five-react.js +2 -2
- package/umd/five-shader-lib.js +2 -2
- package/umd/five-sticker.js +3 -3
- package/umd/five-vfx.js +2 -2
- package/umd/five-vue.js +2 -2
- package/umd/five.js +503 -78
- package/vfx/airflow/airflow.d.ts +18 -0
- package/vfx/airflow/fragment-shader.d.ts +2 -0
- package/vfx/airflow/vertex-shader.d.ts +2 -0
- package/vfx/common/scale-shader.d.ts +2 -0
- package/vfx/common/simplex-noise-shader.d.ts +2 -0
- package/vfx/frame/fragment-shader.d.ts +2 -0
- package/vfx/frame/frame.d.ts +22 -0
- package/vfx/frame/vertex-shader.d.ts +2 -0
- package/vfx/index.d.ts +7 -363
- package/vfx/index.js +2 -2
- package/vfx/index.mjs +2 -2
- package/vfx/particle/fragment-shader.d.ts +2 -0
- package/vfx/particle/instance.d.ts +36 -0
- package/vfx/particle/particle.d.ts +205 -0
- package/vfx/particle/utils.d.ts +11 -0
- package/vfx/particle/vertex-shader.d.ts +2 -0
- package/vfx/particle-gpu/fragment-shader.d.ts +2 -0
- package/vfx/particle-gpu/instance.d.ts +36 -0
- package/vfx/particle-gpu/particle.d.ts +95 -0
- package/vfx/particle-gpu/utils.d.ts +11 -0
- package/vfx/particle-gpu/vertex-shader.d.ts +2 -0
- package/vfx/spotLight/fragment-shader.d.ts +2 -0
- package/vfx/spotLight/spotLight.d.ts +15 -0
- package/vfx/spotLight/vertex-shader.d.ts +2 -0
- package/vue/context.d.ts +7 -0
- package/vue/hooks/FiveCanvas.d.ts +36 -0
- package/vue/hooks/FiveProvider.d.ts +35 -0
- package/vue/hooks/unsafe__useFiveInject.d.ts +9 -0
- package/vue/hooks/useFiveAction.d.ts +178 -0
- package/vue/hooks/useFiveCameraDirection.d.ts +8 -0
- package/vue/hooks/useFiveCameraRaycaster.d.ts +8 -0
- package/vue/hooks/useFiveCurrentObserver.d.ts +12 -0
- package/vue/hooks/useFiveCurrentState.d.ts +16 -0
- package/vue/hooks/useFiveEventCallback.d.ts +11 -0
- package/vue/hooks/useFiveFloor.d.ts +16 -0
- package/vue/hooks/useFiveHelper.d.ts +15 -0
- package/vue/hooks/useFiveModel.d.ts +7 -0
- package/vue/hooks/useFiveModelBounding.d.ts +7 -0
- package/vue/hooks/useFiveModelIntersectRaycaster.d.ts +23 -0
- package/vue/hooks/useFiveModelReadyState.d.ts +9 -0
- package/vue/hooks/useFiveProject2d.d.ts +26 -0
- package/vue/hooks/useFiveScene.d.ts +6 -0
- package/vue/hooks/useFiveState.d.ts +16 -0
- package/vue/hooks/useFiveWork.d.ts +30 -0
- package/vue/index.d.ts +23 -467
- package/vue/index.js +2 -2
- package/vue/index.mjs +2 -2
- package/vue/rendererPool.d.ts +10 -0
- package/work-downloader/components/model-3d-tile.d.ts +2 -0
- package/work-downloader/components/model.d.ts +3 -0
- package/work-downloader/components/observer.d.ts +7 -0
- package/work-downloader/download.d.ts +16 -0
- package/work-downloader/index.d.ts +2 -33
- package/work-downloader/index.js +2 -2
- package/work-downloader/index.mjs +2 -2
- package/work-downloader/type.d.ts +28 -0
- package/work-downloader/utils/download-to-file.d.ts +1 -0
- package/work-downloader/utils/image-processing.d.ts +7 -0
- package/work-downloader/utils/join-url.d.ts +2 -0
- package/work-downloader/utils/log.d.ts +1 -0
- package/work-downloader/utils/relative-url.d.ts +1 -0
- package/docs/documents/coordinate.html +0 -13
- package/docs/documents/five.FivePlugin.plugins.html +0 -92
- package/docs/documents/five.Pose.coordinate.html +0 -13
- package/docs/documents/mode.html +0 -15
- package/docs/documents/plugins.html +0 -92
- package/docs/documents/state.html +0 -2
- package/docs/documents/work.html +0 -67
- package/docs/media/coordinate.jpg +0 -0
- package/docs_markdown/README.md +0 -33
- package/docs_markdown/_media/coordinate.jpg +0 -0
- package/docs_markdown/documents/coordinate.md +0 -29
- package/docs_markdown/documents/intro.md +0 -15
- package/docs_markdown/documents/mode.md +0 -21
- package/docs_markdown/documents/plugins.md +0 -226
- package/docs_markdown/documents/quick-start.md +0 -105
- package/docs_markdown/documents/release_notes/6.7.md +0 -407
- package/docs_markdown/documents/state.md +0 -7
- package/docs_markdown/documents/support.md +0 -13
- package/docs_markdown/documents/work.md +0 -148
- package/docs_markdown/five/README.md +0 -309
- package/docs_markdown/five/classes/AdaptiveLuminancePass.md +0 -238
- package/docs_markdown/five/classes/AnimationFrameLoop.md +0 -195
- package/docs_markdown/five/classes/BoundingMesh.md +0 -75
- package/docs_markdown/five/classes/Camera.md +0 -527
- package/docs_markdown/five/classes/EffectComposer.md +0 -241
- package/docs_markdown/five/classes/EyeDomeLightingPass.md +0 -232
- package/docs_markdown/five/classes/Fetcher.md +0 -133
- package/docs_markdown/five/classes/Five.md +0 -2231
- package/docs_markdown/five/classes/FivePass.md +0 -193
- package/docs_markdown/five/classes/FiveRenderer.md +0 -107
- package/docs_markdown/five/classes/FullScreenQuad.md +0 -95
- package/docs_markdown/five/classes/InternalWebGLRenderer.md +0 -65
- package/docs_markdown/five/classes/Model.md +0 -1009
- package/docs_markdown/five/classes/ModelScene.md +0 -495
- package/docs_markdown/five/classes/Motion.md +0 -235
- package/docs_markdown/five/classes/NetworkSubscribe.md +0 -289
- package/docs_markdown/five/classes/PBMContainer.md +0 -137
- package/docs_markdown/five/classes/PBMCustomShader.md +0 -171
- package/docs_markdown/five/classes/PBMGSObject.md +0 -257
- package/docs_markdown/five/classes/PBMGroup.md +0 -35
- package/docs_markdown/five/classes/PBMMesh.md +0 -43
- package/docs_markdown/five/classes/PBMMeshMaterial.md +0 -889
- package/docs_markdown/five/classes/PBMPointCloud.md +0 -41
- package/docs_markdown/five/classes/PBMPointCloudMaterial.md +0 -371
- package/docs_markdown/five/classes/PBMSkinnedMesh.md +0 -67
- package/docs_markdown/five/classes/PanoCircleMesh.md +0 -296
- package/docs_markdown/five/classes/PanoCircleMeshCustom.md +0 -296
- package/docs_markdown/five/classes/PanoCircleMeshSolid.md +0 -296
- package/docs_markdown/five/classes/Parameter.md +0 -905
- package/docs_markdown/five/classes/Scene.md +0 -109
- package/docs_markdown/five/classes/Subscribe.md +0 -271
- package/docs_markdown/five/classes/TextureLoader.md +0 -199
- package/docs_markdown/five/classes/Tile.md +0 -517
- package/docs_markdown/five/classes/Tile3D.md +0 -1287
- package/docs_markdown/five/classes/TileCache.md +0 -123
- package/docs_markdown/five/classes/TileNode.md +0 -171
- package/docs_markdown/five/classes/TileRequestScheduler.md +0 -69
- package/docs_markdown/five/classes/Tileset.md +0 -379
- package/docs_markdown/five/classes/Trajectory.md +0 -111
- package/docs_markdown/five/classes/TrajectoryNode.md +0 -129
- package/docs_markdown/five/classes/Work.md +0 -299
- package/docs_markdown/five/classes/WorkResolvedObserver.md +0 -302
- package/docs_markdown/five/classes/XRButton.md +0 -37
- package/docs_markdown/five/enumerations/VolumePlaneIntersect.md +0 -33
- package/docs_markdown/five/functions/coordinatesToVector.md +0 -33
- package/docs_markdown/five/functions/createDebugBoundingMesh.md +0 -25
- package/docs_markdown/five/functions/createWorks.md +0 -21
- package/docs_markdown/five/functions/defaultImageURLTransform.md +0 -33
- package/docs_markdown/five/functions/getViewportScale.md +0 -15
- package/docs_markdown/five/functions/headingToLongitude.md +0 -29
- package/docs_markdown/five/functions/imageSupport.md +0 -15
- package/docs_markdown/five/functions/isBoundingVolume.md +0 -21
- package/docs_markdown/five/functions/isPanoId.md +0 -21
- package/docs_markdown/five/functions/loadAt3d.md +0 -47
- package/docs_markdown/five/functions/loadB3dm.md +0 -39
- package/docs_markdown/five/functions/loadDome.md +0 -43
- package/docs_markdown/five/functions/loadDomez.md +0 -43
- package/docs_markdown/five/functions/loadFbx.md +0 -35
- package/docs_markdown/five/functions/loadGltf.md +0 -39
- package/docs_markdown/five/functions/loadPbm.md +0 -47
- package/docs_markdown/five/functions/loadPly.md +0 -61
- package/docs_markdown/five/functions/loadPnts.md +0 -35
- package/docs_markdown/five/functions/loadSplat.md +0 -35
- package/docs_markdown/five/functions/loadSpz.md +0 -35
- package/docs_markdown/five/functions/loadX3p.md +0 -39
- package/docs_markdown/five/functions/longitudeToHeading.md +0 -29
- package/docs_markdown/five/functions/makeBoundingVolume.md +0 -21
- package/docs_markdown/five/functions/panoEqual.md +0 -25
- package/docs_markdown/five/functions/panoParse.md +0 -21
- package/docs_markdown/five/functions/panoStringify.md +0 -21
- package/docs_markdown/five/functions/parseWork.md +0 -33
- package/docs_markdown/five/functions/vectorToCoordinates.md +0 -31
- package/docs_markdown/five/functions/workToJson.md +0 -21
- package/docs_markdown/five/interfaces/AddableObject.md +0 -77
- package/docs_markdown/five/interfaces/AjaxOptions.md +0 -81
- package/docs_markdown/five/interfaces/AnimationFrame.md +0 -67
- package/docs_markdown/five/interfaces/AnimationFrameContext.md +0 -55
- package/docs_markdown/five/interfaces/BaseEvent.md +0 -60
- package/docs_markdown/five/interfaces/BoundingVolume.md +0 -241
- package/docs_markdown/five/interfaces/BoxBoundingVolume.md +0 -325
- package/docs_markdown/five/interfaces/CameraPose.md +0 -49
- package/docs_markdown/five/interfaces/CullingVolume.md +0 -141
- package/docs_markdown/five/interfaces/Draco.md +0 -219
- package/docs_markdown/five/interfaces/EventCallback.md +0 -3374
- package/docs_markdown/five/interfaces/FiveInitArgs.md +0 -435
- package/docs_markdown/five/interfaces/FiveLoadOptions.md +0 -71
- package/docs_markdown/five/interfaces/FloorplanControllerCustomInitArgs.md +0 -93
- package/docs_markdown/five/interfaces/GestureEvent.md +0 -233
- package/docs_markdown/five/interfaces/ImageOptions.md +0 -147
- package/docs_markdown/five/interfaces/ImageURLMappings.md +0 -13
- package/docs_markdown/five/interfaces/ImageURLOptions.md +0 -89
- package/docs_markdown/five/interfaces/IntersectEvent.md +0 -89
- package/docs_markdown/five/interfaces/IntersectMesh.md +0 -33
- package/docs_markdown/five/interfaces/IntersectMeshInterface.md +0 -27
- package/docs_markdown/five/interfaces/Intersection.md +0 -53
- package/docs_markdown/five/interfaces/KTX2.md +0 -131
- package/docs_markdown/five/interfaces/LoosePanoWork.md +0 -81
- package/docs_markdown/five/interfaces/LooseWork.md +0 -145
- package/docs_markdown/five/interfaces/LooseWorkInitial.md +0 -89
- package/docs_markdown/five/interfaces/LooseWorkModel.md +0 -113
- package/docs_markdown/five/interfaces/LooseWorkObserver.md +0 -153
- package/docs_markdown/five/interfaces/LooseWorkPanorama.md +0 -121
- package/docs_markdown/five/interfaces/LooseWorkVideo.md +0 -33
- package/docs_markdown/five/interfaces/LooseWorkWithExtrinsics.md +0 -93
- package/docs_markdown/five/interfaces/MapviewControllerCustomInitArgs.md +0 -96
- package/docs_markdown/five/interfaces/ModeChangeEvent.md +0 -105
- package/docs_markdown/five/interfaces/ModelControllerCustomInitArgs.md +0 -147
- package/docs_markdown/five/interfaces/ModelEvent.md +0 -89
- package/docs_markdown/five/interfaces/ModelOptions.md +0 -54
- package/docs_markdown/five/interfaces/ModelSceneEvent.md +0 -73
- package/docs_markdown/five/interfaces/MotionKeyframe.md +0 -39
- package/docs_markdown/five/interfaces/MovePanoOptions.md +0 -192
- package/docs_markdown/five/interfaces/NetworkAbortError.md +0 -13
- package/docs_markdown/five/interfaces/NetworkFirbiddenError.md +0 -13
- package/docs_markdown/five/interfaces/NetworkOptions.md +0 -53
- package/docs_markdown/five/interfaces/NetworkProxyError.md +0 -13
- package/docs_markdown/five/interfaces/NetworkResourceEvent.md +0 -97
- package/docs_markdown/five/interfaces/NetworkResponseError.md +0 -21
- package/docs_markdown/five/interfaces/NetworkTimeoutError.md +0 -13
- package/docs_markdown/five/interfaces/ObjectEvent.md +0 -73
- package/docs_markdown/five/interfaces/PBMClipperParameter.md +0 -25
- package/docs_markdown/five/interfaces/PBMCustomShaderInitArgs.md +0 -57
- package/docs_markdown/five/interfaces/PBMCustomShaderSlots.md +0 -53
- package/docs_markdown/five/interfaces/PBMMaterial.md +0 -18
- package/docs_markdown/five/interfaces/PBMMeshMaterialParameters.md +0 -221
- package/docs_markdown/five/interfaces/PBMPanoDepth.md +0 -49
- package/docs_markdown/five/interfaces/PBMPanoPicture.md +0 -59
- package/docs_markdown/five/interfaces/PBMPointCloudMaterialParameters.md +0 -221
- package/docs_markdown/five/interfaces/PBMRefinedScreen.md +0 -49
- package/docs_markdown/five/interfaces/PanoCircleMeshCustomOptions.md +0 -73
- package/docs_markdown/five/interfaces/PanoCircleMeshInterface.md +0 -222
- package/docs_markdown/five/interfaces/PanoCircleMeshOptions.md +0 -25
- package/docs_markdown/five/interfaces/PanoCircleMeshSolidOptions.md +0 -25
- package/docs_markdown/five/interfaces/PanoEvent.md +0 -121
- package/docs_markdown/five/interfaces/PanoTextureEvent.md +0 -97
- package/docs_markdown/five/interfaces/PanoramaControllerCustomInitArgs.md +0 -260
- package/docs_markdown/five/interfaces/PanoramaLikeControllerCustomInitArgs.md +0 -112
- package/docs_markdown/five/interfaces/ParameterMaterialValue.md +0 -363
- package/docs_markdown/five/interfaces/ParameterTilesetValue.md +0 -161
- package/docs_markdown/five/interfaces/ParameterValue.md +0 -715
- package/docs_markdown/five/interfaces/Pass.md +0 -100
- package/docs_markdown/five/interfaces/Pose.md +0 -69
- package/docs_markdown/five/interfaces/RegionBoundingVolume.md +0 -349
- package/docs_markdown/five/interfaces/RenderEvent.md +0 -73
- package/docs_markdown/five/interfaces/ResolvedParameterValue.md +0 -727
- package/docs_markdown/five/interfaces/SphereBoundingVolume.md +0 -317
- package/docs_markdown/five/interfaces/State.md +0 -123
- package/docs_markdown/five/interfaces/StateEvent.md +0 -87
- package/docs_markdown/five/interfaces/TextureOptions.md +0 -157
- package/docs_markdown/five/interfaces/Tile3DOptions.md +0 -83
- package/docs_markdown/five/interfaces/TileCoordinateSystem.md +0 -25
- package/docs_markdown/five/interfaces/TileHeader.md +0 -89
- package/docs_markdown/five/interfaces/TilesetHeader.md +0 -209
- package/docs_markdown/five/interfaces/TilesetOptions.md +0 -205
- package/docs_markdown/five/interfaces/TopviewControllerCustomInitArgs.md +0 -101
- package/docs_markdown/five/interfaces/TrajectoryHeader.md +0 -41
- package/docs_markdown/five/interfaces/VRPanoramaControllerCustomInitArgs.md +0 -264
- package/docs_markdown/five/interfaces/ViewLayer.md +0 -1505
- package/docs_markdown/five/interfaces/Viewport.md +0 -57
- package/docs_markdown/five/interfaces/WebXRAxesParams.md +0 -57
- package/docs_markdown/five/interfaces/WebXRControllerParams.md +0 -25
- package/docs_markdown/five/interfaces/WorkCubeImage.md +0 -86
- package/docs_markdown/five/interfaces/WorkImage.md +0 -117
- package/docs_markdown/five/interfaces/WorkInitial.md +0 -89
- package/docs_markdown/five/interfaces/WorkInitialJson.md +0 -65
- package/docs_markdown/five/interfaces/WorkJson.md +0 -89
- package/docs_markdown/five/interfaces/WorkModel.md +0 -113
- package/docs_markdown/five/interfaces/WorkModelJson.md +0 -49
- package/docs_markdown/five/interfaces/WorkModelLayer.md +0 -59
- package/docs_markdown/five/interfaces/WorkModelLayerJson.md +0 -41
- package/docs_markdown/five/interfaces/WorkObserver.md +0 -184
- package/docs_markdown/five/interfaces/WorkObserverJson.md +0 -97
- package/docs_markdown/five/interfaces/WorkPanoramaJson.md +0 -125
- package/docs_markdown/five/interfaces/WorkPanoramasJson.md +0 -25
- package/docs_markdown/five/interfaces/WorkTile.md +0 -115
- package/docs_markdown/five/interfaces/WorkVideo.md +0 -49
- package/docs_markdown/five/interfaces/WorksEvent.md +0 -89
- package/docs_markdown/five/interfaces/XRControllerEvent.md +0 -177
- package/docs_markdown/five/interfaces/XRGestureEvent.md +0 -125
- package/docs_markdown/five/interfaces/XRPanoramaControllerCustomInitArgs.md +0 -264
- package/docs_markdown/five/interfaces/XRSessionEvent.md +0 -81
- package/docs_markdown/five/interfaces/documents/coordinate.md +0 -29
- package/docs_markdown/five/type-aliases/AjaxResponseType.md +0 -11
- package/docs_markdown/five/type-aliases/AjaxResponseTypeMapping.md +0 -17
- package/docs_markdown/five/type-aliases/AnimationFrameLoopType.md +0 -11
- package/docs_markdown/five/type-aliases/BoundingVolumeJson.md +0 -11
- package/docs_markdown/five/type-aliases/BoxBoundingVolumeJson.md +0 -19
- package/docs_markdown/five/type-aliases/ControllerCustomInitTypes.md +0 -67
- package/docs_markdown/five/type-aliases/ControllerEventTypes.md +0 -669
- package/docs_markdown/five/type-aliases/CubeFace.md +0 -11
- package/docs_markdown/five/type-aliases/EventTypes.md +0 -381
- package/docs_markdown/five/type-aliases/FivePlugin.md +0 -31
- package/docs_markdown/five/type-aliases/FivePluginInit.md +0 -21
- package/docs_markdown/five/type-aliases/FivePluginInstance.md +0 -21
- package/docs_markdown/five/type-aliases/GestureTypes.md +0 -11
- package/docs_markdown/five/type-aliases/LegacyEventType.md +0 -1852
- package/docs_markdown/five/type-aliases/LoadResultType.md +0 -109
- package/docs_markdown/five/type-aliases/Mode.md +0 -19
- package/docs_markdown/five/type-aliases/Models.md +0 -121
- package/docs_markdown/five/type-aliases/MotionCircle.md +0 -13
- package/docs_markdown/five/type-aliases/MotionConfig.md +0 -17
- package/docs_markdown/five/type-aliases/MotionInitalValue.md +0 -17
- package/docs_markdown/five/type-aliases/MotionValue.md +0 -17
- package/docs_markdown/five/type-aliases/MovePanoEffect.md +0 -24
- package/docs_markdown/five/type-aliases/NetWorkMeta.md +0 -71
- package/docs_markdown/five/type-aliases/NetworkError.md +0 -11
- package/docs_markdown/five/type-aliases/NetworkErrorCallback.md +0 -21
- package/docs_markdown/five/type-aliases/NetworkProgressCallback.md +0 -21
- package/docs_markdown/five/type-aliases/NetworkResponse.md +0 -37
- package/docs_markdown/five/type-aliases/NetworkState.md +0 -11
- package/docs_markdown/five/type-aliases/NetworkSuccessCallback.md +0 -27
- package/docs_markdown/five/type-aliases/NetworkType.md +0 -11
- package/docs_markdown/five/type-aliases/PBMAlphaMode.md +0 -11
- package/docs_markdown/five/type-aliases/PBMColorStyle.md +0 -11
- package/docs_markdown/five/type-aliases/PBMFloorStyle.md +0 -11
- package/docs_markdown/five/type-aliases/PBMMeshShaderType.md +0 -11
- package/docs_markdown/five/type-aliases/PBMPointBack.md +0 -11
- package/docs_markdown/five/type-aliases/PBMPointCloudShaderType.md +0 -11
- package/docs_markdown/five/type-aliases/PBMPointShape.md +0 -11
- package/docs_markdown/five/type-aliases/PBMPointSize.md +0 -11
- package/docs_markdown/five/type-aliases/PBMTransition.md +0 -11
- package/docs_markdown/five/type-aliases/Pano.md +0 -27
- package/docs_markdown/five/type-aliases/PanoId.md +0 -11
- package/docs_markdown/five/type-aliases/ParseOptions.md +0 -65
- package/docs_markdown/five/type-aliases/PostProcessingType.md +0 -11
- package/docs_markdown/five/type-aliases/RegionBoundingVolumeJson.md +0 -19
- package/docs_markdown/five/type-aliases/RequestAnimationFrameArgs.md +0 -17
- package/docs_markdown/five/type-aliases/Scissor.md +0 -15
- package/docs_markdown/five/type-aliases/SphereBoundingVolumeJson.md +0 -19
- package/docs_markdown/five/type-aliases/SubscribeEventMap.md +0 -15
- package/docs_markdown/five/type-aliases/TileCacheOptions.md +0 -47
- package/docs_markdown/five/type-aliases/TileContentData.md +0 -51
- package/docs_markdown/five/type-aliases/TileRequestOrder.md +0 -11
- package/docs_markdown/five/type-aliases/TileRequestSchedulerOptions.md +0 -69
- package/docs_markdown/five/type-aliases/TilesetFrameState.md +0 -199
- package/docs_markdown/five/type-aliases/TrajectoryContentData.md +0 -59
- package/docs_markdown/five/type-aliases/WebXRControllerKey.md +0 -11
- package/docs_markdown/five/type-aliases/WebXRControllerType.md +0 -11
- package/docs_markdown/five/type-aliases/Works.md +0 -59
- package/docs_markdown/five/type-aliases/documents/plugins.md +0 -226
- package/docs_markdown/five/variables/PROXY_CONTROLLER_EVENT_NAMES.md +0 -11
- package/docs_markdown/five/variables/controllersDefaultInitArgs.md +0 -41
- package/docs_markdown/five/variables/draco.md +0 -11
- package/docs_markdown/five/variables/ktx2.md +0 -11
- package/docs_markdown/gltf-loader/README.md +0 -23
- package/docs_markdown/gltf-loader/classes/DDSLoader.md +0 -57
- package/docs_markdown/gltf-loader/classes/DRACOLoader.md +0 -143
- package/docs_markdown/gltf-loader/classes/GLTFLoader.md +0 -208
- package/docs_markdown/gltf-loader/classes/GLTFObject.md +0 -76
- package/docs_markdown/gltf-loader/classes/GLTFParser.md +0 -75
- package/docs_markdown/gltf-loader/classes/THREEGLTFLoader.md +0 -151
- package/docs_markdown/gltf-loader/interfaces/DDS.md +0 -57
- package/docs_markdown/gltf-loader/interfaces/GLTF.md +0 -98
- package/docs_markdown/gltf-loader/interfaces/GLTFReference.md +0 -25
- package/docs_markdown/gltf-loader/interfaces/THREEGLTF.md +0 -89
- package/docs_markdown/line/README.md +0 -20
- package/docs_markdown/line/classes/Line.md +0 -151
- package/docs_markdown/line/classes/LineGeometry.md +0 -273
- package/docs_markdown/line/classes/LineMaterial.md +0 -83
- package/docs_markdown/line/classes/LineSegmentsGeometry.md +0 -219
- package/docs_markdown/line/classes/THREE_Line2.md +0 -81
- package/docs_markdown/line/classes/THREE_LineSegments2.md +0 -81
- package/docs_markdown/line/type-aliases/LineMaterialParameters.md +0 -67
- package/docs_markdown/modules.md +0 -28
- package/docs_markdown/plugins/README.md +0 -43
- package/docs_markdown/plugins/classes/CSS3DRenderer.md +0 -93
- package/docs_markdown/plugins/classes/OrbitControls.md +0 -461
- package/docs_markdown/plugins/classes/RoundedBoxGeometry.md +0 -79
- package/docs_markdown/plugins/functions/BackgroundPlugin.md +0 -25
- package/docs_markdown/plugins/functions/DynamicPathLinePlugin.md +0 -25
- package/docs_markdown/plugins/functions/ItemMaskPlugin.md +0 -25
- package/docs_markdown/plugins/functions/OrientationPlugin.md +0 -25
- package/docs_markdown/plugins/functions/PanoAnimePlugin.md +0 -25
- package/docs_markdown/plugins/functions/TrajectoryPlugin.md +0 -25
- package/docs_markdown/plugins/interfaces/BackgroundPluginController.md +0 -313
- package/docs_markdown/plugins/interfaces/DynamicPathLinePluginController.md +0 -755
- package/docs_markdown/plugins/interfaces/ItemMaskController.md +0 -393
- package/docs_markdown/plugins/interfaces/Keyframe.md +0 -25
- package/docs_markdown/plugins/interfaces/OrientationPluginController.md +0 -491
- package/docs_markdown/plugins/interfaces/PanoAnimeController.md +0 -365
- package/docs_markdown/plugins/interfaces/PlayingState.md +0 -25
- package/docs_markdown/plugins/interfaces/TrajectoryController.md +0 -609
- package/docs_markdown/plugins/namespaces/BackgroundPluginType/README.md +0 -25
- package/docs_markdown/plugins/namespaces/BackgroundPluginType/enumerations/WarningCodeType.md +0 -17
- package/docs_markdown/plugins/namespaces/BackgroundPluginType/interfaces/Config.md +0 -9
- package/docs_markdown/plugins/namespaces/BackgroundPluginType/interfaces/EventMap.md +0 -205
- package/docs_markdown/plugins/namespaces/BackgroundPluginType/interfaces/Params.md +0 -25
- package/docs_markdown/plugins/namespaces/BackgroundPluginType/interfaces/PluginDataItem.md +0 -9
- package/docs_markdown/plugins/namespaces/BackgroundPluginType/type-aliases/Mirror.md +0 -17
- package/docs_markdown/plugins/namespaces/BackgroundPluginType/type-aliases/Mode.md +0 -11
- package/docs_markdown/plugins/namespaces/BackgroundPluginType/type-aliases/PluginData.md +0 -11
- package/docs_markdown/plugins/namespaces/BackgroundPluginType/type-aliases/State.md +0 -19
- package/docs_markdown/plugins/namespaces/BasePlugin/README.md +0 -22
- package/docs_markdown/plugins/namespaces/BasePlugin/classes/Controller.md +0 -318
- package/docs_markdown/plugins/namespaces/BasePlugin/interfaces/BaseOptions.md +0 -19
- package/docs_markdown/plugins/namespaces/BasePlugin/interfaces/Config.md +0 -39
- package/docs_markdown/plugins/namespaces/BasePlugin/interfaces/State.md +0 -49
- package/docs_markdown/plugins/namespaces/BasePlugin/interfaces/StateChangeParams.md +0 -45
- package/docs_markdown/plugins/namespaces/BasePlugin/type-aliases/EventMap.md +0 -110
- package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/README.md +0 -20
- package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/interfaces/Config.md +0 -181
- package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/interfaces/EventMap.md +0 -261
- package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/interfaces/Params.md +0 -37
- package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/interfaces/PathConfig.md +0 -141
- package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/interfaces/State.md +0 -67
- package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/type-aliases/PluginData.md +0 -21
- package/docs_markdown/plugins/namespaces/DynamicPathLinePluginType/type-aliases/ServerData.md +0 -73
- package/docs_markdown/plugins/namespaces/ItemMaskPluginType/README.md +0 -21
- package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/Config.md +0 -11
- package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/EventMap.md +0 -109
- package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/ItemType.md +0 -121
- package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/MaskType.md +0 -33
- package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/Params.md +0 -27
- package/docs_markdown/plugins/namespaces/ItemMaskPluginType/interfaces/State.md +0 -87
- package/docs_markdown/plugins/namespaces/ItemMaskPluginType/type-aliases/PluginData.md +0 -27
- package/docs_markdown/plugins/namespaces/ItemMaskPluginType/type-aliases/ServerData.md +0 -27
- package/docs_markdown/plugins/namespaces/OrientationPluginType/README.md +0 -19
- package/docs_markdown/plugins/namespaces/OrientationPluginType/interfaces/Config.md +0 -27
- package/docs_markdown/plugins/namespaces/OrientationPluginType/interfaces/EventMap.md +0 -109
- package/docs_markdown/plugins/namespaces/OrientationPluginType/interfaces/Params.md +0 -27
- package/docs_markdown/plugins/namespaces/OrientationPluginType/interfaces/State.md +0 -67
- package/docs_markdown/plugins/namespaces/OrientationPluginType/type-aliases/PluginData.md +0 -11
- package/docs_markdown/plugins/namespaces/OrientationPluginType/type-aliases/ServerData.md +0 -11
- package/docs_markdown/plugins/namespaces/PanoAnimePluginType/README.md +0 -20
- package/docs_markdown/plugins/namespaces/PanoAnimePluginType/interfaces/Config.md +0 -19
- package/docs_markdown/plugins/namespaces/PanoAnimePluginType/interfaces/ConfigChangeEvent.md +0 -39
- package/docs_markdown/plugins/namespaces/PanoAnimePluginType/interfaces/EventMap.md +0 -157
- package/docs_markdown/plugins/namespaces/PanoAnimePluginType/interfaces/Params.md +0 -27
- package/docs_markdown/plugins/namespaces/PanoAnimePluginType/interfaces/State.md +0 -57
- package/docs_markdown/plugins/namespaces/PanoAnimePluginType/type-aliases/PluginData.md +0 -11
- package/docs_markdown/plugins/namespaces/PanoAnimePluginType/type-aliases/ServerData.md +0 -11
- package/docs_markdown/plugins/namespaces/PluginTemplateType/README.md +0 -19
- package/docs_markdown/plugins/namespaces/PluginTemplateType/interfaces/Config.md +0 -19
- package/docs_markdown/plugins/namespaces/PluginTemplateType/interfaces/EventMap.md +0 -109
- package/docs_markdown/plugins/namespaces/PluginTemplateType/interfaces/Params.md +0 -27
- package/docs_markdown/plugins/namespaces/PluginTemplateType/interfaces/State.md +0 -57
- package/docs_markdown/plugins/namespaces/PluginTemplateType/type-aliases/PluginData.md +0 -11
- package/docs_markdown/plugins/namespaces/PluginTemplateType/type-aliases/ServerData.md +0 -19
- package/docs_markdown/react/README.md +0 -58
- package/docs_markdown/react/classes/Store.md +0 -184
- package/docs_markdown/react/functions/createFiveFeature.md +0 -27
- package/docs_markdown/react/functions/createFiveProvider.md +0 -42
- package/docs_markdown/react/functions/createStore.md +0 -158
- package/docs_markdown/react/functions/unsafe__useFiveInstance.md +0 -27
- package/docs_markdown/react/functions/useFiveAction.md +0 -82
- package/docs_markdown/react/functions/useFiveCameraDirection.md +0 -19
- package/docs_markdown/react/functions/useFiveCameraRaycaster.md +0 -19
- package/docs_markdown/react/functions/useFiveCurrentObserver.md +0 -25
- package/docs_markdown/react/functions/useFiveCurrentState.md +0 -25
- package/docs_markdown/react/functions/useFiveEventCallback.md +0 -44
- package/docs_markdown/react/functions/useFiveFloor.md +0 -25
- package/docs_markdown/react/functions/useFiveHelper.md +0 -25
- package/docs_markdown/react/functions/useFiveModelIntersectRaycaster.md +0 -45
- package/docs_markdown/react/functions/useFiveModelReadyState.md +0 -20
- package/docs_markdown/react/functions/useFiveProject2d.md +0 -49
- package/docs_markdown/react/functions/useFiveSceneEffect.md +0 -39
- package/docs_markdown/react/functions/useFiveState.md +0 -15
- package/docs_markdown/react/functions/useFiveWork.md +0 -39
- package/docs_markdown/react/functions/withFive.md +0 -47
- package/docs_markdown/react/interfaces/FiveActionReactCallbacks.md +0 -270
- package/docs_markdown/react/interfaces/FiveCanvasProps.md +0 -29
- package/docs_markdown/react/interfaces/FiveInjectionTypes.md +0 -1075
- package/docs_markdown/react/interfaces/PropTypeOfFiveFeatures.md +0 -23
- package/docs_markdown/react/type-aliases/FiveInjectionActionFeature.md +0 -11
- package/docs_markdown/react/type-aliases/FiveInjectionDataFeature.md +0 -11
- package/docs_markdown/react/type-aliases/FiveInjectionFeature.md +0 -11
- package/docs_markdown/react/type-aliases/FiveProviderPropTypes.md +0 -139
- package/docs_markdown/react/type-aliases/FiveProviderType.md +0 -11
- package/docs_markdown/react/type-aliases/StoreActionMapHanlder.md +0 -25
- package/docs_markdown/react/type-aliases/StoreActionMapType.md +0 -15
- package/docs_markdown/react/type-aliases/StoreProviderType.md +0 -11
- package/docs_markdown/react/type-aliases/StoreValueMapType.md +0 -11
- package/docs_markdown/react/variables/FiveCanvas.md +0 -25
- package/docs_markdown/react/variables/INJECTION_PROPNAME.md +0 -11
- package/docs_markdown/react/variables/useFiveScene.md +0 -43
- package/docs_markdown/sticker/README.md +0 -15
- package/docs_markdown/sticker/classes/Sticker.md +0 -208
- package/docs_markdown/sticker/interfaces/IntersectionLike.md +0 -39
- package/docs_markdown/vfx/README.md +0 -27
- package/docs_markdown/vfx/classes/Airflow.md +0 -175
- package/docs_markdown/vfx/classes/Flame.md +0 -241
- package/docs_markdown/vfx/classes/Particle.md +0 -488
- package/docs_markdown/vfx/classes/ParticleGPU.md +0 -195
- package/docs_markdown/vfx/classes/SpotLight.md +0 -159
- package/docs_markdown/vfx/interfaces/ParticleArgs.md +0 -338
- package/docs_markdown/vfx/interfaces/ParticleGPUArgs.md +0 -301
- package/docs_markdown/vfx/interfaces/ParticleGPUTweenKeyframe.md +0 -31
- package/docs_markdown/vfx/interfaces/ParticleTweenKeyframe.md +0 -31
- package/docs_markdown/vfx/type-aliases/ParticleGPUType.md +0 -11
- package/docs_markdown/vfx/type-aliases/ParticleType.md +0 -11
- package/docs_markdown/vue/README.md +0 -42
- package/docs_markdown/vue/functions/unsafe__useFiveInject.md +0 -27
- package/docs_markdown/vue/functions/useFiveAction.md +0 -104
- package/docs_markdown/vue/functions/useFiveCameraDirection.md +0 -19
- package/docs_markdown/vue/functions/useFiveCameraRaycaster.md +0 -19
- package/docs_markdown/vue/functions/useFiveCurrentObserver.md +0 -25
- package/docs_markdown/vue/functions/useFiveCurrentState.md +0 -25
- package/docs_markdown/vue/functions/useFiveEventCallback.md +0 -40
- package/docs_markdown/vue/functions/useFiveFloor.md +0 -25
- package/docs_markdown/vue/functions/useFiveHelper.md +0 -25
- package/docs_markdown/vue/functions/useFiveModel.md +0 -17
- package/docs_markdown/vue/functions/useFiveModelBounding.md +0 -17
- package/docs_markdown/vue/functions/useFiveModelIntersectRaycaster.md +0 -35
- package/docs_markdown/vue/functions/useFiveModelReadyState.md +0 -20
- package/docs_markdown/vue/functions/useFiveProject2d.md +0 -38
- package/docs_markdown/vue/functions/useFiveScene.md +0 -17
- package/docs_markdown/vue/functions/useFiveState.md +0 -25
- package/docs_markdown/vue/functions/useFiveWorks.md +0 -39
- package/docs_markdown/vue/interfaces/FiveActionVueCallbacks.md +0 -301
- package/docs_markdown/vue/type-aliases/FiveModelIntersectRaycaster.md +0 -21
- package/docs_markdown/vue/type-aliases/FiveProviderComponent.md +0 -11
- package/docs_markdown/vue/type-aliases/Project2d.md +0 -25
- package/docs_markdown/vue/variables/FiveCanvas.md +0 -37
- package/docs_markdown/vue/variables/FiveProvider.md +0 -32
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>features/five | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">features/five</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="five-five-核心类" class="tsd-anchor-link">Five (Five 核心类)<a href="#five-five-核心类" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1>
|
|
2
|
+
<ul>
|
|
3
|
+
<li><strong>Summary</strong>: Five 是 @realsee/five 的核心类,负责 3D 场景的渲染、资源加载、用户交互和状态管理。</li>
|
|
4
|
+
<li><strong>Schema</strong>: FiveInitArgs 初始化参数接口。</li>
|
|
5
|
+
<li><strong>Concepts</strong>: Instance Management, Rendering Loop, Resource Loading, State Sync.</li>
|
|
6
|
+
<li><strong>Configuration</strong>: Five 初始化参数详解。</li>
|
|
7
|
+
<li><strong>Examples</strong>: 基础初始化、加载数据、销毁实例。</li>
|
|
8
|
+
</ul>
|
|
9
|
+
<h2 id="schema" class="tsd-anchor-link">Schema<a href="#schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
10
|
+
<h3 id="fiveinitargs" class="tsd-anchor-link">FiveInitArgs<a href="#fiveinitargs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
11
|
+
<blockquote>
|
|
12
|
+
<p><strong>Definition</strong>: <a href="../../five/application/fiveInitArgs.d.ts">FiveInitArgs</a></p>
|
|
13
|
+
</blockquote>
|
|
14
|
+
<p><code>new Five(args)</code> 的初始化参数对象。</p>
|
|
15
|
+
<pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">FiveInitArgs</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">/** 外部传入的渲染器 (如果传入,部分渲染配置将失效) */</span><br/><span class="hl-1"> </span><span class="hl-6">renderer</span><span class="hl-1">?: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">WebGLRenderer</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/**</span><br/><span class="hl-8"> * 屏幕渲染区域 { left, bottom, width, height }</span><br/><span class="hl-8"> * 必须配合外部 renderer 使用</span><br/><span class="hl-8"> */</span><br/><span class="hl-1"> </span><span class="hl-6">viewport</span><span class="hl-1">?: </span><span class="hl-7">Viewport</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 背景颜色 (默认 0x181A1C) */</span><br/><span class="hl-1"> </span><span class="hl-6">backgroundColor</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1"> | </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Color</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 背景透明度 (0-1, 默认 1) */</span><br/><span class="hl-1"> </span><span class="hl-6">backgroundAlpha</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 是否开启抗锯齿 (默认 false) */</span><br/><span class="hl-1"> </span><span class="hl-6">antialias</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 全景图配置 (见 image-options.md) */</span><br/><span class="hl-1"> </span><span class="hl-6">imageOptions</span><span class="hl-1">?: </span><span class="hl-7">ImageOptions</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 贴图配置 (见 image-options.md) */</span><br/><span class="hl-1"> </span><span class="hl-6">textureOptions</span><span class="hl-1">?: </span><span class="hl-7">TextureOptions</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 是否按需渲染 (默认 true, 推荐开启以节省性能) */</span><br/><span class="hl-1"> </span><span class="hl-6">onlyRenderIfNeeds</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 模式切换动画时长 (ms, 默认 1000) */</span><br/><span class="hl-1"> </span><span class="hl-6">modeChangeDuration</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 是否支持滚轮缩放 (默认 true) */</span><br/><span class="hl-1"> </span><span class="hl-6">enableWheel</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-8">/** 插件列表 */</span><br/><span class="hl-1"> </span><span class="hl-6">plugins</span><span class="hl-1">?: </span><span class="hl-7">FivePlugin</span><span class="hl-1">[];</span><br/><span class="hl-1"> </span><span class="hl-8">/** 是否显示 Powered by Realsee */</span><br/><span class="hl-1"> </span><span class="hl-6">poweredByRealsee</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
|
|
16
|
+
</code><button type="button">Copy</button></pre>
|
|
17
|
+
|
|
18
|
+
<h2 id="concepts" class="tsd-anchor-link">Concepts<a href="#concepts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
19
|
+
<h3 id="instance-management-实例管理" class="tsd-anchor-link">Instance Management (实例管理)<a href="#instance-management-实例管理" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
20
|
+
<p>Five 实例是整个 3D 场景的入口。</p>
|
|
21
|
+
<ul>
|
|
22
|
+
<li><strong>Singleton-like</strong>: 虽然支持多实例,但在同一个 DOM 容器中通常只维护一个 Five 实例。</li>
|
|
23
|
+
<li><strong>Lifecycle</strong>: 包含 <code>appendTo</code> (挂载)、<code>load</code> (加载数据)、<code>dispose</code> (销毁) 等生命周期方法。</li>
|
|
24
|
+
</ul>
|
|
25
|
+
<h3 id="rendering-loop-渲染循环" class="tsd-anchor-link">Rendering Loop (渲染循环)<a href="#rendering-loop-渲染循环" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
26
|
+
<p>Five 内部维护了一个 <code>requestAnimationFrame</code> 循环。</p>
|
|
27
|
+
<ul>
|
|
28
|
+
<li><strong>按需渲染</strong>: 默认开启 <code>onlyRenderIfNeeds</code>,仅在画面发生变化(如视角移动、数据加载)时才触发 WebGL 绘制,大幅降低能耗。</li>
|
|
29
|
+
<li><strong>手动触发</strong>: 可以通过 <code>five.needsRender = true</code> 强制下一帧进行渲染。</li>
|
|
30
|
+
</ul>
|
|
31
|
+
<h3 id="resource-loading-资源加载" class="tsd-anchor-link">Resource Loading (资源加载)<a href="#resource-loading-资源加载" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
32
|
+
<p>通过 <code>load()</code> 方法加载 Work 数据。</p>
|
|
33
|
+
<ul>
|
|
34
|
+
<li><strong>数据解析</strong>: 自动解析 Work 数据结构,生成场景图。</li>
|
|
35
|
+
<li><strong>预加载</strong>: 支持配置预加载策略,平衡首屏速度与流量。</li>
|
|
36
|
+
</ul>
|
|
37
|
+
<h2 id="configuration" class="tsd-anchor-link">Configuration<a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
38
|
+
<table>
|
|
39
|
+
<thead>
|
|
40
|
+
<tr>
|
|
41
|
+
<th style="text-align:left">参数</th>
|
|
42
|
+
<th style="text-align:left">类型</th>
|
|
43
|
+
<th style="text-align:left">默认值</th>
|
|
44
|
+
<th style="text-align:left">说明</th>
|
|
45
|
+
</tr>
|
|
46
|
+
</thead>
|
|
47
|
+
<tbody>
|
|
48
|
+
<tr>
|
|
49
|
+
<td style="text-align:left"><code>imageOptions</code></td>
|
|
50
|
+
<td style="text-align:left"><code>ImageOptions</code></td>
|
|
51
|
+
<td style="text-align:left"><code>{}</code></td>
|
|
52
|
+
<td style="text-align:left">图片加载策略,详见 <a href="features_image-options.html">image-options.md</a></td>
|
|
53
|
+
</tr>
|
|
54
|
+
<tr>
|
|
55
|
+
<td style="text-align:left"><code>textureOptions</code></td>
|
|
56
|
+
<td style="text-align:left"><code>TextureOptions</code></td>
|
|
57
|
+
<td style="text-align:left"><code>{}</code></td>
|
|
58
|
+
<td style="text-align:left">贴图加载策略,同上</td>
|
|
59
|
+
</tr>
|
|
60
|
+
<tr>
|
|
61
|
+
<td style="text-align:left"><code>onlyRenderIfNeeds</code></td>
|
|
62
|
+
<td style="text-align:left"><code>boolean</code></td>
|
|
63
|
+
<td style="text-align:left"><code>true</code></td>
|
|
64
|
+
<td style="text-align:left">是否仅在需要时渲染,建议保持 <code>true</code></td>
|
|
65
|
+
</tr>
|
|
66
|
+
<tr>
|
|
67
|
+
<td style="text-align:left"><code>antialias</code></td>
|
|
68
|
+
<td style="text-align:left"><code>boolean</code></td>
|
|
69
|
+
<td style="text-align:left"><code>false</code></td>
|
|
70
|
+
<td style="text-align:left">抗锯齿,开启会增加性能消耗</td>
|
|
71
|
+
</tr>
|
|
72
|
+
<tr>
|
|
73
|
+
<td style="text-align:left"><code>modeChangeDuration</code></td>
|
|
74
|
+
<td style="text-align:left"><code>number</code></td>
|
|
75
|
+
<td style="text-align:left"><code>1000</code></td>
|
|
76
|
+
<td style="text-align:left">模式切换动画时长 (ms)</td>
|
|
77
|
+
</tr>
|
|
78
|
+
<tr>
|
|
79
|
+
<td style="text-align:left"><code>enableWheel</code></td>
|
|
80
|
+
<td style="text-align:left"><code>boolean</code></td>
|
|
81
|
+
<td style="text-align:left"><code>true</code></td>
|
|
82
|
+
<td style="text-align:left">是否支持滚轮缩放</td>
|
|
83
|
+
</tr>
|
|
84
|
+
</tbody>
|
|
85
|
+
</table>
|
|
86
|
+
<h2 id="examples" class="tsd-anchor-link">Examples<a href="#examples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
87
|
+
<h3 id="快速上手-quick-example" class="tsd-anchor-link">快速上手 (Quick Example)<a href="#快速上手-quick-example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
88
|
+
<p>创建一个全屏的 Five 实例并加载数据。</p>
|
|
89
|
+
<pre><code class="typescript"><span class="hl-10">import</span><span class="hl-1"> { </span><span class="hl-6">Five</span><span class="hl-1">, </span><span class="hl-6">parseWork</span><span class="hl-1"> } </span><span class="hl-10">from</span><span class="hl-1"> </span><span class="hl-9">"@realsee/five"</span><span class="hl-1">;</span><br/><br/><span class="hl-8">// 1. 初始化实例</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">five</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">Five</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">imageOptions:</span><span class="hl-1"> { </span><span class="hl-6">size:</span><span class="hl-1"> </span><span class="hl-11">512</span><span class="hl-1"> }, </span><span class="hl-8">// 初始加载小图</span><br/><span class="hl-1"> </span><span class="hl-6">onlyRenderIfNeeds:</span><span class="hl-1"> </span><span class="hl-3">true</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-8">// 2. 挂载到 DOM</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">appendTo</span><span class="hl-1">(</span><span class="hl-6">document</span><span class="hl-1">.</span><span class="hl-5">getElementById</span><span class="hl-1">(</span><span class="hl-9">"app"</span><span class="hl-1">));</span><br/><br/><span class="hl-8">// 3. 加载数据</span><br/><span class="hl-8">// workData 通常来自服务端 API</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">load</span><span class="hl-1">(</span><span class="hl-6">workData</span><span class="hl-1">);</span>
|
|
90
|
+
</code><button type="button">Copy</button></pre>
|
|
91
|
+
|
|
92
|
+
<h3 id="进阶用法:自定义渲染器与视口" class="tsd-anchor-link">进阶用法:自定义渲染器与视口<a href="#进阶用法:自定义渲染器与视口" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
93
|
+
<p>使用外部渲染器并指定视口区域(例如用于分屏渲染)。</p>
|
|
94
|
+
<pre><code class="typescript"><span class="hl-10">import</span><span class="hl-1"> </span><span class="hl-3">*</span><span class="hl-1"> </span><span class="hl-10">as</span><span class="hl-1"> </span><span class="hl-6">THREE</span><span class="hl-1"> </span><span class="hl-10">from</span><span class="hl-1"> </span><span class="hl-9">"three"</span><span class="hl-1">;</span><br/><span class="hl-10">import</span><span class="hl-1"> { </span><span class="hl-6">Five</span><span class="hl-1"> } </span><span class="hl-10">from</span><span class="hl-1"> </span><span class="hl-9">"@realsee/five"</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">renderer</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-4">THREE</span><span class="hl-1">.</span><span class="hl-5">WebGLRenderer</span><span class="hl-1">();</span><br/><span class="hl-6">renderer</span><span class="hl-1">.</span><span class="hl-5">setSize</span><span class="hl-1">(</span><span class="hl-6">window</span><span class="hl-1">.</span><span class="hl-6">innerWidth</span><span class="hl-1">, </span><span class="hl-6">window</span><span class="hl-1">.</span><span class="hl-6">innerHeight</span><span class="hl-1">);</span><br/><span class="hl-6">document</span><span class="hl-1">.</span><span class="hl-6">body</span><span class="hl-1">.</span><span class="hl-5">appendChild</span><span class="hl-1">(</span><span class="hl-6">renderer</span><span class="hl-1">.</span><span class="hl-6">domElement</span><span class="hl-1">);</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">five</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-5">Five</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-6">renderer:</span><span class="hl-1"> </span><span class="hl-6">renderer</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-6">viewport:</span><span class="hl-1"> { </span><span class="hl-6">left:</span><span class="hl-1"> </span><span class="hl-11">0</span><span class="hl-1">, </span><span class="hl-6">bottom:</span><span class="hl-1"> </span><span class="hl-11">0</span><span class="hl-1">, </span><span class="hl-6">width:</span><span class="hl-1"> </span><span class="hl-11">0.5</span><span class="hl-1">, </span><span class="hl-6">height:</span><span class="hl-1"> </span><span class="hl-11">1</span><span class="hl-1"> } </span><span class="hl-8">// 仅占用左半屏</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">load</span><span class="hl-1">(</span><span class="hl-6">workData</span><span class="hl-1">);</span>
|
|
95
|
+
</code><button type="button">Copy</button></pre>
|
|
96
|
+
|
|
97
|
+
<h3 id="进阶用法:自定义相机动画" class="tsd-anchor-link">进阶用法:自定义相机动画<a href="#进阶用法:自定义相机动画" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
98
|
+
<p>使用 <code>updateCamera</code> 或 <code>updateCameraWithKeyframes</code> 实现平滑的视角漫游。</p>
|
|
99
|
+
<pre><code class="typescript"><span class="hl-8">// 简单移动到指定视角</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">updateCamera</span><span class="hl-1">(</span><br/><span class="hl-1"> { </span><span class="hl-6">longitude:</span><span class="hl-1"> </span><span class="hl-6">Math</span><span class="hl-1">.</span><span class="hl-4">PI</span><span class="hl-1"> / </span><span class="hl-11">2</span><span class="hl-1">, </span><span class="hl-6">latitude:</span><span class="hl-1"> </span><span class="hl-11">0</span><span class="hl-1"> }, </span><span class="hl-8">// 目标姿态</span><br/><span class="hl-1"> </span><span class="hl-11">1000</span><span class="hl-1"> </span><span class="hl-8">// 动画时长 1秒</span><br/><span class="hl-1">).</span><span class="hl-5">then</span><span class="hl-1">(() </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">"移动完成"</span><span class="hl-1">);</span><br/><span class="hl-1">}).</span><span class="hl-5">catch</span><span class="hl-1">(() </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">"移动被打断"</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-8">// 复杂关键帧动画</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">keyframes</span><span class="hl-1"> = [</span><br/><span class="hl-1"> { </span><span class="hl-6">progress:</span><span class="hl-1"> </span><span class="hl-11">0</span><span class="hl-1">, </span><span class="hl-6">value:</span><span class="hl-1"> { </span><span class="hl-6">longitude:</span><span class="hl-1"> </span><span class="hl-11">0</span><span class="hl-1">, </span><span class="hl-6">latitude:</span><span class="hl-1"> </span><span class="hl-11">0</span><span class="hl-1"> } },</span><br/><span class="hl-1"> { </span><span class="hl-6">progress:</span><span class="hl-1"> </span><span class="hl-11">0.5</span><span class="hl-1">, </span><span class="hl-6">value:</span><span class="hl-1"> { </span><span class="hl-6">longitude:</span><span class="hl-1"> </span><span class="hl-6">Math</span><span class="hl-1">.</span><span class="hl-4">PI</span><span class="hl-1"> / </span><span class="hl-11">4</span><span class="hl-1">, </span><span class="hl-6">latitude:</span><span class="hl-1"> </span><span class="hl-11">0.2</span><span class="hl-1"> } },</span><br/><span class="hl-1"> { </span><span class="hl-6">progress:</span><span class="hl-1"> </span><span class="hl-11">1</span><span class="hl-1">, </span><span class="hl-6">value:</span><span class="hl-1"> { </span><span class="hl-6">longitude:</span><span class="hl-1"> </span><span class="hl-6">Math</span><span class="hl-1">.</span><span class="hl-4">PI</span><span class="hl-1"> / </span><span class="hl-11">2</span><span class="hl-1">, </span><span class="hl-6">latitude:</span><span class="hl-1"> </span><span class="hl-11">0</span><span class="hl-1"> } }</span><br/><span class="hl-1">];</span><br/><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">updateCameraWithKeyframes</span><span class="hl-1">(</span><span class="hl-6">keyframes</span><span class="hl-1">, </span><span class="hl-11">2000</span><span class="hl-1">).</span><span class="hl-5">then</span><span class="hl-1">(() </span><span class="hl-3">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-9">"关键帧动画完成"</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
100
|
+
</code><button type="button">Copy</button></pre>
|
|
101
|
+
|
|
102
|
+
<h3 id="实例属性-instance-properties" class="tsd-anchor-link">实例属性 (Instance Properties)<a href="#实例属性-instance-properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
103
|
+
<ul>
|
|
104
|
+
<li><strong><code>work</code></strong>: 当前加载的 Work 数据(主 Work)。详见 <a href="features_work.html">work.md</a>。</li>
|
|
105
|
+
<li><strong><code>works</code></strong>: 当前加载的所有 Work 数据列表。详见 <a href="features_work.html">work.md</a>。</li>
|
|
106
|
+
<li><strong><code>model</code></strong>: 当前加载的 Model 数据(主 Model)。详见 <a href="features_model.html">model.md</a>。</li>
|
|
107
|
+
<li><strong><code>models</code></strong>: 当前加载的所有 Model 数据列表。详见 <a href="features_model.html">model.md</a>。</li>
|
|
108
|
+
</ul>
|
|
109
|
+
<h3 id="实例方法-instance-methods" class="tsd-anchor-link">实例方法 (Instance Methods)<a href="#实例方法-instance-methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
110
|
+
<ul>
|
|
111
|
+
<li><strong><code>appendTo(element: HTMLElement)</code></strong>: 将 canvas 挂载到指定 DOM 元素。</li>
|
|
112
|
+
<li><strong><code>load(work: Work, state?: State, duration?: number)</code></strong>: 加载场景数据。详见 <a href="features_work.html">work.md</a>。</li>
|
|
113
|
+
<li><strong><code>dispose()</code></strong>: 销毁实例,释放 WebGL 上下文与内存。</li>
|
|
114
|
+
<li><strong><code>updateCamera(pose: Partial<Pose>, duration: number, userAction?: boolean)</code></strong>: 移动相机(不触发点位移动)。移动相机的视角或位置,不会改变当前所在的 PanoIndex。如果动画中途被打断,Promise 会被 reject。</li>
|
|
115
|
+
<li><strong><code>updateCameraWithKeyframes(keyframes: { progress: number; value: Pose; key?: string }[], duration: number, userAction?: boolean)</code></strong>: 通过关键帧动画移动相机。</li>
|
|
116
|
+
<li><strong><code>refresh()</code></strong>: 强制刷新画布尺寸。通常在窗口 resize 时调用,Five 会自动监听 resize,但在某些布局变化场景下可能需要手动调用。</li>
|
|
117
|
+
<li><strong><code>getPixels(x, y, width, height, ...)</code> / <code>getPixels(options)</code></strong>: 获取画布指定区域的像素数据。常用于截图、生成缩略图或颜色拾取。支持配置区域、像素比 (pixelRatio)、Y轴翻转 (flipY) 及是否忽略全景图 (skipPanorama) 等。</li>
|
|
118
|
+
<li><strong><code>project2d(vector: THREE.Vector3, testModel?: boolean): THREE.Vector2 | null</code></strong>: 计算三维坐标对应到屏幕的二维坐标。如果坐标在视野外或被遮挡(开启 testModel 时),返回 null。详见 <a href="features_screen-project.html">screen-project.md</a>。</li>
|
|
119
|
+
<li><strong><code>ready(args?: { tile?: boolean })</code></strong>: Promise,当 Five 状态稳定时 resolve。
|
|
120
|
+
<ul>
|
|
121
|
+
<li><strong>Resolve 时机</strong>:
|
|
122
|
+
<ol>
|
|
123
|
+
<li><strong>状态同步</strong>:相机姿态已通过动画过渡到目标状态(<code>stateSynced</code> 为 true)。</li>
|
|
124
|
+
<li><strong>模型加载</strong>:如果是 Floorplan/Topview/Mapview/Model 模态,需等待模型加载完成 (<code>modelScene.loaded</code>)。</li>
|
|
125
|
+
<li><strong>瓦片加载</strong>:如果是 Panorama 模态且传入了 <code>{ tile: true }</code>,需等待当前视角的瓦片加载完成。</li>
|
|
126
|
+
</ol>
|
|
127
|
+
</li>
|
|
128
|
+
</ul>
|
|
129
|
+
</li>
|
|
130
|
+
<li><strong><code>setState(state: Partial<State>, options?: ChangeStateOptions)</code></strong>: 变更当前状态(如点位、视角)。详见 <a href="features_state.html">state.md</a>。</li>
|
|
131
|
+
<li><strong><code>on(event, callback)</code> / <code>off(event, callback)</code></strong>: 事件监听。详见 <a href="features_event.html">event.md</a>。</li>
|
|
132
|
+
</ul>
|
|
133
|
+
<h2 id="related" class="tsd-anchor-link">Related<a href="#related" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2>
|
|
134
|
+
<ul>
|
|
135
|
+
<li><a href="features_work.html">work.md</a>: Work 数据结构说明。</li>
|
|
136
|
+
<li><a href="features_model.html">model.md</a>: Model 数据结构说明。</li>
|
|
137
|
+
<li><a href="features_state.html">state.md</a>: 状态管理详解。</li>
|
|
138
|
+
<li><a href="features_event.html">event.md</a>: 事件系统说明。</li>
|
|
139
|
+
<li><a href="features_image-options.html">image-options.md</a>: 图片加载配置。</li>
|
|
140
|
+
<li><a href="features_mode.html">mode.md</a>: 模态切换说明。</li>
|
|
141
|
+
<li><a href="features_parameter.html">parameter.md</a>: 其他核心参数。</li>
|
|
142
|
+
</ul>
|
|
143
|
+
<hr>
|
|
144
|
+
<pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">five</span><span class="hl-1">, </span><span class="hl-2">initialization</span><span class="hl-1">, </span><span class="hl-2">core</span><span class="hl-1">, </span><span class="hl-2">instance</span><span class="hl-1">, </span><span class="hl-2">lifecycle</span><span class="hl-1">]</span>
|
|
145
|
+
</code><button type="button">Copy</button></pre>
|
|
146
|
+
|
|
147
|
+
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#five-five-核心类"><span>Five (<wbr/>Five 核心类)</span></a><ul><li><a href="#schema"><span>Schema</span></a></li><li><ul><li><a href="#fiveinitargs"><span>Five<wbr/>Init<wbr/>Args</span></a></li></ul></li><li><a href="#concepts"><span>Concepts</span></a></li><li><ul><li><a href="#instance-management-实例管理"><span>Instance <wbr/>Management (实例管理)</span></a></li><li><a href="#rendering-loop-渲染循环"><span>Rendering <wbr/>Loop (渲染循环)</span></a></li><li><a href="#resource-loading-资源加载"><span>Resource <wbr/>Loading (资源加载)</span></a></li></ul></li><li><a href="#configuration"><span>Configuration</span></a></li><li><a href="#examples"><span>Examples</span></a></li><li><ul><li><a href="#快速上手-quick-example"><span>快速上手 (<wbr/>Quick <wbr/>Example)</span></a></li><li><a href="#进阶用法:自定义渲染器与视口"><span>进阶用法:自定义渲染器与视口</span></a></li><li><a href="#进阶用法:自定义相机动画"><span>进阶用法:自定义相机动画</span></a></li><li><a href="#实例属性-instance-properties"><span>实例属性 (<wbr/>Instance <wbr/>Properties)</span></a></li><li><a href="#实例方法-instance-methods"><span>实例方法 (<wbr/>Instance <wbr/>Methods)</span></a></li></ul></li><li><a href="#related"><span>Related</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">如视 Five SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|