@realsee/five 6.8.0-alpha.8 → 6.8.0
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 +6 -1
- package/AI_CONTEXT.md +6 -1
- package/README.md +10 -3
- package/ai_guides/README.md +32 -2
- package/ai_guides/api.md +92 -21
- package/ai_guides/features/3dtile.md +1 -1
- package/ai_guides/features/camera-animation.md +18 -1
- package/ai_guides/features/clipper.md +2 -2
- package/ai_guides/features/coordinate-system.md +20 -2
- package/ai_guides/features/event.md +106 -10
- package/ai_guides/features/five.md +17 -17
- package/ai_guides/features/flowing-light-2d-pass.md +280 -56
- package/ai_guides/features/flowing-light-3d-pass.md +224 -39
- package/ai_guides/features/gaussian-blur-pass.md +1 -1
- package/ai_guides/features/gesture.md +2 -1
- package/ai_guides/features/get-screen-pixels.md +2 -2
- package/ai_guides/features/image-options.md +2 -2
- package/ai_guides/features/load-external-model.md +6 -2
- package/ai_guides/features/load-progress.md +1 -1
- package/ai_guides/features/material.md +20 -12
- package/ai_guides/features/mode.md +1 -1
- package/ai_guides/features/model.md +1 -1
- package/ai_guides/features/move-pano-effect.md +1 -1
- package/ai_guides/features/multi-work.md +1 -1
- package/ai_guides/features/pano-filter.md +149 -0
- package/ai_guides/features/pano-tile.md +1 -1
- package/ai_guides/features/pano-uv.md +1 -1
- package/ai_guides/features/parameter.md +26 -2
- package/ai_guides/features/plugin.md +1 -1
- package/ai_guides/features/postprocessing.md +1 -1
- package/ai_guides/features/raycast.md +5 -2
- package/ai_guides/features/request-proxy.md +1 -1
- package/ai_guides/features/screen-project.md +2 -1
- package/ai_guides/features/state.md +23 -3
- package/ai_guides/features/view-layer.md +1 -1
- package/ai_guides/features/work.md +1 -1
- package/ai_guides/glossary.md +4 -4
- package/ai_guides/release_notes/6.8.md +190 -58
- package/ai_guides/template.md +11 -0
- package/docs/00_FOR_AI_AGENTS.md +3 -2
- package/docs/README.md +3 -2
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/main.js +1 -1
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/five.AdaptiveLuminancePass.html +7 -6
- package/docs/classes/five.AnimationFrameLoop.html +1 -1
- package/docs/classes/five.BoundingMesh.html +2 -2
- package/docs/classes/five.Camera.html +3 -3
- package/docs/classes/five.EyeDomeLightingPass.html +1 -1
- package/docs/classes/five.Five.html +77 -76
- package/docs/classes/five.FivePass.html +1 -1
- package/docs/classes/five.Histogram.html +19 -0
- package/docs/classes/five.InternalWebGLRenderer.html +1 -1
- package/docs/classes/five.Model.html +8 -8
- package/docs/classes/five.ModelScene.html +1 -1
- package/docs/classes/five.NetworkSubscribe.html +5 -5
- package/docs/classes/five.PBMContainer.html +1 -1
- package/docs/classes/five.PBMCustomShader.html +42 -3
- package/docs/classes/five.PBMGSObject.html +5 -3
- package/docs/classes/five.PBMGroup.html +1 -1
- package/docs/classes/five.PBMMesh.html +1 -1
- package/docs/classes/five.PBMMeshMaterial.html +7 -7
- package/docs/classes/five.PBMPanoFilter.html +61 -0
- package/docs/classes/five.PBMPointCloud.html +1 -1
- package/docs/classes/five.PBMPointCloudMaterial.html +5 -6
- package/docs/classes/five.PBMSkinnedMesh.html +1 -1
- package/docs/classes/five.PBMUpdateable.html +41 -0
- 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 +57 -55
- package/docs/classes/five.Scene.html +1 -1
- package/docs/classes/five.Subscribe.html +5 -5
- package/docs/classes/five.Tile.html +1 -1
- package/docs/classes/five.Tile3D.html +24 -24
- package/docs/classes/five.TileNode.html +1 -1
- package/docs/classes/five.Tileset.html +3 -2
- package/docs/classes/five.TrajectoryNode.html +1 -1
- package/docs/classes/five.Work.html +16 -16
- package/docs/classes/five.WorkResolvedObserver.html +22 -22
- 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.GLTFParser.html +1 -1
- package/docs/classes/gltf-loader.THREEGLTFLoader.html +2 -2
- 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.CSS3DObject.html +9 -0
- package/docs/classes/plugins.CSS3DRenderer.html +4 -2
- package/docs/classes/plugins.CSS3DSprite.html +11 -0
- package/docs/classes/plugins.Object3DHelperController.html +43 -0
- package/docs/classes/plugins.RoundedBoxGeometry.html +1 -1
- package/docs/classes/sticker.Sticker.html +1 -1
- package/docs/classes/vfx.Airflow.html +1 -1
- package/docs/classes/vfx.Flame.html +1 -1
- package/docs/classes/vfx.Particle.html +6 -6
- package/docs/classes/vfx.ParticleGPU.html +3 -3
- package/docs/classes/vfx.SpotLight.html +1 -1
- package/docs/documents/README.html +124 -3
- package/docs/documents/api.html +163 -35
- package/docs/documents/features_3dtile.html +1 -1
- package/docs/documents/features_camera-animation.html +18 -2
- package/docs/documents/features_clipper.html +2 -2
- package/docs/documents/features_coordinate-system.html +52 -3
- package/docs/documents/features_event.html +44 -8
- package/docs/documents/features_five.html +17 -17
- package/docs/documents/features_flowing-light-2d-pass.html +176 -41
- package/docs/documents/features_flowing-light-3d-pass.html +160 -40
- package/docs/documents/features_gaussian-blur-pass.html +6 -6
- package/docs/documents/features_gesture.html +2 -1
- package/docs/documents/features_get-screen-pixels.html +2 -2
- package/docs/documents/features_image-options.html +2 -2
- package/docs/documents/features_load-external-model.html +6 -2
- package/docs/documents/features_load-progress.html +1 -1
- package/docs/documents/features_material.html +11 -4
- package/docs/documents/features_mode.html +1 -1
- package/docs/documents/features_model.html +1 -1
- package/docs/documents/features_move-pano-effect.html +1 -1
- package/docs/documents/features_multi-work.html +1 -1
- package/docs/documents/features_pano-filter.html +123 -0
- package/docs/documents/features_pano-tile.html +1 -1
- package/docs/documents/features_pano-uv.html +1 -1
- package/docs/documents/features_parameter.html +11 -3
- package/docs/documents/features_plugin.html +1 -1
- package/docs/documents/features_postprocessing.html +1 -1
- package/docs/documents/features_raycast.html +5 -2
- package/docs/documents/features_request-proxy.html +1 -1
- package/docs/documents/features_screen-project.html +2 -1
- package/docs/documents/features_state.html +9 -2
- package/docs/documents/features_view-layer.html +1 -1
- package/docs/documents/features_work.html +1 -1
- package/docs/documents/glossary.html +5 -5
- package/docs/documents/release_notes_6.8.html +164 -64
- package/docs/documents/template.html +9 -0
- package/docs/functions/five.createDebugBoundingMesh.html +1 -1
- package/docs/functions/five.parseWork.html +1 -1
- package/docs/functions/plugins.CSS3DPlugin.html +1 -0
- package/docs/functions/plugins.GaussianSplattingEntranceAnimationPlugin.html +1 -0
- package/docs/functions/plugins.Object3DHelperPlugin.html +1 -0
- package/docs/functions/react.useFiveCurrentObserver.html +2 -2
- package/docs/functions/react.useFiveFloor.html +2 -2
- package/docs/functions/react.useFiveProject2d.html +2 -2
- package/docs/functions/vue.useFiveCurrentObserver.html +2 -2
- package/docs/functions/vue.useFiveFloor.html +2 -2
- package/docs/functions/vue.useFiveWorks.html +2 -2
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +124 -3
- package/docs/interfaces/five.AddableObject.html +1 -1
- package/docs/interfaces/five.AjaxOptions.html +1 -1
- package/docs/interfaces/five.BaseEvent.html +7 -2
- package/docs/interfaces/five.BaseExtendableEvent.html +11 -0
- package/docs/interfaces/five.EventCallback.html +58 -54
- package/docs/interfaces/five.FiveInitArgs.html +2 -2
- package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +9 -9
- package/docs/interfaces/five.GestureEvent.html +21 -2
- package/docs/interfaces/five.GesturePointer.html +20 -0
- package/docs/interfaces/five.ImageOptions.html +1 -1
- package/docs/interfaces/five.IntersectEvent.html +10 -2
- package/docs/interfaces/five.IntersectMesh.html +1 -1
- package/docs/interfaces/five.IntersectMeshInterface.html +1 -1
- package/docs/interfaces/five.Intersection.html +1 -1
- package/docs/interfaces/five.LooseWorkObserver.html +2 -2
- package/docs/interfaces/five.LooseWorkPanorama.html +2 -2
- package/docs/interfaces/five.LooseWorkWithExtrinsics.html +6 -6
- package/docs/interfaces/five.MapviewControllerCustomInitArgs.html +10 -10
- package/docs/interfaces/five.ModeChangeEvent.html +9 -2
- package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.ModelEvent.html +7 -2
- package/docs/interfaces/five.ModelSceneEvent.html +7 -2
- package/docs/interfaces/five.ModelTileEvent.html +7 -2
- package/docs/interfaces/five.MovePanoOptions.html +8 -8
- 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 +7 -2
- package/docs/interfaces/five.NetworkResponseError.html +1 -1
- package/docs/interfaces/five.NetworkTimeoutError.html +1 -1
- package/docs/interfaces/five.ObjectEvent.html +7 -2
- package/docs/interfaces/five.PBMClipperParameter.html +2 -2
- package/docs/interfaces/five.PBMCustomShaderInitArgs.html +2 -2
- package/docs/interfaces/five.PBMCustomShaderSlots.html +2 -2
- package/docs/interfaces/five.PBMMaterial.html +1 -1
- package/docs/interfaces/five.PBMMeshMaterialParameters.html +5 -3
- package/docs/interfaces/five.PBMPanoDepth.html +5 -5
- package/docs/interfaces/five.PBMPanoFilterValue.html +6 -0
- package/docs/interfaces/five.PBMPanoPicture.html +8 -6
- package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +2 -3
- package/docs/interfaces/five.PBMRefinedScreen.html +2 -2
- package/docs/interfaces/five.PanoCircleMeshInterface.html +2 -2
- package/docs/interfaces/five.PanoEvent.html +15 -2
- package/docs/interfaces/five.PanoPrepareEvent.html +15 -0
- package/docs/interfaces/five.PanoTextureEvent.html +11 -2
- package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.ParameterMaterialValue.html +40 -38
- package/docs/interfaces/five.ParameterTilesetValue.html +15 -15
- package/docs/interfaces/five.ParameterValue.html +54 -52
- package/docs/interfaces/five.Pose.html +1 -1
- package/docs/interfaces/five.RenderEvent.html +7 -2
- package/docs/interfaces/five.ResolvedParameterValue.html +55 -54
- package/docs/interfaces/five.RgbaData.html +7 -0
- package/docs/interfaces/five.SplatData.html +2 -2
- package/docs/interfaces/five.State.html +1 -1
- package/docs/interfaces/five.StateEvent.html +9 -2
- package/docs/interfaces/five.TextureOptions.html +1 -1
- package/docs/interfaces/five.Tile3DOptions.html +2 -2
- package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +7 -7
- package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.ViewLayer.html +24 -24
- package/docs/interfaces/five.WorkCubeImage.html +3 -2
- package/docs/interfaces/five.WorkImage.html +6 -5
- package/docs/interfaces/five.WorkInitial.html +8 -8
- package/docs/interfaces/five.WorkModel.html +8 -8
- package/docs/interfaces/five.WorkModelLayer.html +6 -6
- package/docs/interfaces/five.WorkObserver.html +29 -29
- package/docs/interfaces/five.WorkObserverJson.html +2 -2
- package/docs/interfaces/five.WorkObserverProto.html +26 -0
- package/docs/interfaces/five.WorkPanoramaJson.html +2 -2
- package/docs/interfaces/five.WorkTile.html +6 -5
- package/docs/interfaces/five.WorkVideo.html +4 -4
- package/docs/interfaces/five.WorksEvent.html +7 -2
- package/docs/interfaces/five.XRControllerEvent.html +10 -2
- package/docs/interfaces/five.XRControllerState.html +8 -0
- package/docs/interfaces/five.XRGestureEvent.html +13 -2
- package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +1 -1
- package/docs/interfaces/five.XRSessionEvent.html +9 -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.CSS3DPluginController.html +52 -0
- package/docs/interfaces/plugins.CSS3DPluginType.Config.html +2 -0
- package/docs/interfaces/plugins.CSS3DPluginType.CreateCSS3DObjectType.html +10 -0
- package/docs/interfaces/plugins.CSS3DPluginType.EventMap.html +10 -0
- package/docs/interfaces/plugins.CSS3DPluginType.Params.html +4 -0
- package/docs/interfaces/plugins.CSS3DPluginType.State.html +8 -0
- package/docs/interfaces/plugins.CSS3DRendererParameters.html +2 -0
- package/docs/interfaces/plugins.DynamicPathLinePluginController.html +3 -3
- package/docs/interfaces/plugins.DynamicPathLinePluginType.EventMap.html +1 -1
- package/docs/interfaces/plugins.DynamicPathLinePluginType.State.html +1 -1
- package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationController.html +44 -0
- package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.BoundingAABB2D.html +3 -0
- package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.Config.html +8 -0
- package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.EventMap.html +10 -0
- package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.Keyframe.html +3 -0
- package/docs/interfaces/plugins.GaussianSplattingEntranceAnimationPluginType.State.html +8 -0
- package/docs/interfaces/plugins.ItemMaskController.html +1 -1
- package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +1 -1
- package/docs/interfaces/plugins.ItemMaskPluginType.State.html +2 -2
- package/docs/interfaces/plugins.Object3DHelperPluginType.BaseController.html +30 -0
- package/docs/interfaces/plugins.Object3DHelperPluginType.BaseHelper.html +22 -0
- package/docs/interfaces/plugins.Object3DHelperPluginType.BoundingBoxController.html +30 -0
- package/docs/interfaces/plugins.Object3DHelperPluginType.HelperOffset.html +4 -0
- package/docs/interfaces/plugins.Object3DHelperPluginType.MoveController.html +36 -0
- package/docs/interfaces/plugins.Object3DHelperPluginType.MoveHelperAbstract.html +32 -0
- package/docs/interfaces/plugins.Object3DHelperPluginType.Object3DHelper.html +12 -0
- package/docs/interfaces/plugins.Object3DHelperPluginType.Object3DHelperPluginState.html +4 -0
- package/docs/interfaces/plugins.Object3DHelperPluginType.Object3DHelperState.html +4 -0
- package/docs/interfaces/plugins.Object3DHelperPluginType.ObjectHelperControllers.html +4 -0
- package/docs/interfaces/plugins.Object3DHelperPluginType.RotateController.html +36 -0
- package/docs/interfaces/plugins.Object3DHelperPluginType.RotateHelperAbstract.html +28 -0
- package/docs/interfaces/plugins.Object3DHelperPluginType.Scissor.html +5 -0
- package/docs/interfaces/plugins.Object3DHelperPluginType.Vector2Position.html +3 -0
- package/docs/interfaces/plugins.Object3DHelperPluginType.Vector3Position.html +4 -0
- package/docs/interfaces/plugins.OrientationPluginController.html +6 -6
- 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.PlayingState.html +2 -2
- package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +1 -1
- package/docs/interfaces/plugins.PluginTemplateType.State.html +1 -1
- package/docs/interfaces/plugins.TrajectoryController.html +8 -8
- package/docs/interfaces/react.FiveInjectionTypes.html +21 -21
- package/docs/interfaces/sticker.IntersectionLike.html +2 -2
- package/docs/interfaces/vfx.ParticleArgs.html +4 -4
- package/docs/interfaces/vue.FiveActionVueCallbacks.html +3 -3
- package/docs/modules/five.html +1 -1
- package/docs/modules/plugins.CSS3DPluginType.html +1 -0
- package/docs/modules/plugins.GaussianSplattingEntranceAnimationPluginType.html +1 -0
- package/docs/modules/plugins.Object3DHelperPluginType.html +1 -0
- package/docs/modules/plugins.html +1 -1
- package/docs/modules.html +1 -1
- package/docs/types/five.ControllerEventTypes.html +30 -26
- package/docs/types/five.EasingFunction.html +1 -0
- package/docs/types/five.EventTypes.html +26 -26
- package/docs/types/five.LegacyEventType.html +7 -7
- package/docs/types/five.PBMAlphaMode.html +1 -1
- package/docs/types/five.PBMColorStyle.html +1 -1
- package/docs/types/five.PBMFloorStyle.html +1 -1
- package/docs/types/five.PBMMeshShaderType.html +1 -1
- package/docs/types/five.PBMPointBack.html +1 -1
- package/docs/types/five.PBMPointCloudShaderType.html +1 -1
- package/docs/types/five.PBMPointShape.html +1 -1
- package/docs/types/five.PBMPointSize.html +1 -1
- package/docs/types/five.PBMTransition.html +1 -1
- package/docs/types/five.ParseOptions.html +6 -6
- package/docs/types/five.Works.html +1 -1
- package/docs/types/plugins.BasePlugin.EventMap.html +1 -1
- package/docs/types/plugins.CSS3DPluginType.PluginData.html +1 -0
- package/docs/types/plugins.CSS3DPluginType.ServerData.html +1 -0
- package/docs/types/plugins.Object3DHelperPluginType.AddObject3DHelperConfig.html +13 -0
- package/docs/types/plugins.Object3DHelperPluginType.Circle.html +1 -0
- package/docs/types/plugins.Object3DHelperPluginType.Color.html +1 -0
- package/docs/types/plugins.Object3DHelperPluginType.Direction.html +1 -0
- package/docs/types/plugins.Object3DHelperPluginType.Direction4.html +1 -0
- package/docs/types/plugins.Object3DHelperPluginType.HelperConfig.html +1 -0
- package/docs/types/plugins.Object3DHelperPluginType.HelperEventMap.html +17 -0
- package/docs/types/plugins.Object3DHelperPluginType.InternalHelperEventMap.html +8 -0
- package/docs/types/plugins.Object3DHelperPluginType.Object3DHelperEventMap.html +1 -0
- package/docs/types/plugins.Object3DHelperPluginType.Object3DHelperPluginEventMap.html +7 -0
- package/docs/types/plugins.Object3DHelperPluginType.PositionFrom.html +1 -0
- package/docs/types/plugins.Object3DHelperPluginType.ScaleCallback.html +1 -0
- package/docs/types/plugins.Object3DHelperPluginType.ScalePosition.html +4 -0
- package/docs/types/plugins.Object3DHelperPluginType.UseFaceNormalInterface.html +4 -0
- package/docs/types/plugins.Object3DHelperPluginType.Vector2WithArray.html +1 -0
- package/docs/types/plugins.Object3DHelperPluginType.Vector3WithArray.html +1 -0
- package/docs/variables/five.PROXY_CONTROLLER_EVENT_NAMES.html +1 -1
- package/five/application/events.d.ts +1 -1
- package/five/application/five.d.ts +6 -5
- package/five/bvh/bvhObject.d.ts +2 -2
- package/five/controllers/base.d.ts +1 -0
- package/five/controllers/events.d.ts +5 -1
- package/five/controllers/mapview.d.ts +1 -0
- package/five/controllers/model.d.ts +2 -2
- package/five/controllers/panorama.d.ts +3 -2
- package/five/controllers/xrPanorama.d.ts +1 -1
- package/five/core/camera.d.ts +1 -1
- package/five/gaussian-splatting/util/renderData.d.ts +66 -0
- package/five/index.d.ts +4 -1
- package/five/index.js +272 -748
- package/five/index.mjs +26894 -32055
- package/five/meshes/boundingMesh.d.ts +1 -0
- package/five/model/index.d.ts +2 -2
- package/five/model/loaders/glTF-helpers/extensions/CESIUM_RTC.d.ts +1 -1
- package/five/model/loaders/glTF-helpers/extensions/EXT_meshopt_compression.d.ts +1 -1
- package/five/model/loaders/glTF-helpers/extensions/EXT_texture_webp.d.ts +1 -1
- package/five/model/loaders/glTF-helpers/extensions/KHR_binary_glTF.d.ts +2 -2
- package/five/model/loaders/glTF-helpers/extensions/KHR_draco_mesh_compression.d.ts +1 -1
- package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting.d.ts +26 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz.d.ts +8 -6
- package/five/model/loaders/glTF-helpers/extensions/KHR_gaussian_splatting_compression_spz_2.d.ts +13 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_materials_clearcoat.d.ts +4 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_materials_emissive_strength.d.ts +4 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_materials_sheen.d.ts +4 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_materials_transmission.d.ts +4 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_materials_unlit.d.ts +4 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_node_visibility.d.ts +4 -0
- package/five/model/loaders/glTF-helpers/extensions/KHR_texture_basisu.d.ts +1 -1
- package/five/model/loaders/glTF-helpers/extensions/KHR_texture_transform.d.ts +1 -1
- package/five/model/loaders/glTF-helpers/extensions/REALSEE_materials_lightmap.d.ts +1 -1
- package/five/model/loaders/glTF-helpers/extensions/base.d.ts +3 -1
- package/five/model/loaders/glTF-helpers/index.d.ts +4 -2
- package/five/model/loaders/glTF-helpers/parser.d.ts +16 -14
- package/five/model/loaders/spz.d.ts +2 -2
- package/five/model/materials/pbmMaterial.d.ts +54 -4
- package/five/model/materials/pbmMeshMaterial.d.ts +5 -3
- package/five/model/materials/pbmPointCloudMaterial.d.ts +0 -2
- package/five/model/objects/{pbmGSObject.d.ts → pbmGaussianSplattingObject.d.ts} +4 -1
- package/five/model/objects/pbmGaussianSplattingRenderMesh.d.ts +59 -0
- package/five/model/objects/pbmGaussianSplattingTestMesh.d.ts +7 -0
- package/five/model/parameter.d.ts +11 -6
- package/five/model/tile3d/index.d.ts +5 -3
- package/five/model/tile3d/tile-node.d.ts +2 -2
- package/five/model/tile3d/tileset.d.ts +1 -0
- package/five/renderer/postprocessing/passes/adaptive-luminance-pass.d.ts +9 -7
- package/five/renderer/postprocessing/passes/flowing-light-2d-pass.d.ts +16 -2
- package/five/renderer/postprocessing/passes/flowing-light-3d-pass.d.ts +16 -2
- package/five/renderer/postprocessing/passes/gaussian-blur-pass.d.ts +1 -1
- package/five/renderer/tools/render-cube-to-equirectangular.d.ts +7 -0
- package/five/renderer/tools/render-full-screen.d.ts +1 -1
- package/five/texture/histogram.d.ts +54 -0
- package/five/texture/loader.d.ts +1 -1
- package/five/texture/textureData.d.ts +11 -0
- package/five/thirdparty/hammer.d.ts +371 -255
- package/five/thirdparty/jsrsasign.d.ts +5 -20
- package/five/types/movePanoOptions.d.ts +4 -3
- package/five/utils/error.d.ts +1 -0
- package/five/utils/event.d.ts +98 -37
- package/five/utils/imageURL.d.ts +1 -1
- package/five/utils/memoryUsage.d.ts +2 -2
- package/five/utils/subscribe.d.ts +2 -2
- package/five/webxr/motionHelper.d.ts +1 -1
- package/five/work/index.d.ts +1 -0
- package/five/work/looseWorkType.d.ts +2 -2
- package/five/work/work.d.ts +5 -35
- package/five/work/workJsonType.d.ts +2 -2
- package/five/work/workObserverProto.d.ts +39 -0
- package/gltf-loader/index.js +9 -9
- package/gltf-loader/index.mjs +1351 -1451
- package/line/index.js +4 -4
- package/line/index.mjs +334 -513
- package/llms.txt +40 -3
- package/package.json +4 -4
- package/plugins/CSS3DPlugin/Controller.d.ts +64 -0
- package/plugins/CSS3DPlugin/index.d.ts +5 -0
- package/plugins/CSS3DPlugin/typing.d.ts +32 -0
- package/plugins/GaussianSplattingEntranceAnimationPlugin/Controller.d.ts +30 -0
- package/plugins/GaussianSplattingEntranceAnimationPlugin/index.d.ts +5 -0
- package/plugins/GaussianSplattingEntranceAnimationPlugin/typing.d.ts +28 -0
- package/plugins/Object3DHelperPlugin/Controller.d.ts +99 -0
- package/plugins/Object3DHelperPlugin/Controllers/BaseController.d.ts +142 -0
- package/plugins/Object3DHelperPlugin/Controllers/BoundingBoxController.d.ts +16 -0
- package/plugins/Object3DHelperPlugin/Controllers/MoveController.d.ts +66 -0
- package/plugins/Object3DHelperPlugin/Controllers/RotateController.d.ts +61 -0
- package/plugins/Object3DHelperPlugin/FiveControllerWrapper.d.ts +17 -0
- package/plugins/Object3DHelperPlugin/Helper/BaseHelper.d.ts +97 -0
- package/plugins/Object3DHelperPlugin/Helper/BoundingBoxHelper.d.ts +16 -0
- package/plugins/Object3DHelperPlugin/Helper/MoveHelper.d.ts +37 -0
- package/plugins/Object3DHelperPlugin/Helper/RotateHelper.d.ts +93 -0
- package/plugins/Object3DHelperPlugin/constant.d.ts +27 -0
- package/plugins/Object3DHelperPlugin/index.d.ts +6 -0
- package/plugins/Object3DHelperPlugin/typing.d.ts +143 -0
- package/plugins/Object3DHelperPlugin/utils/ArrowGroup.d.ts +22 -0
- package/plugins/Object3DHelperPlugin/utils/CenterHandle.d.ts +23 -0
- package/plugins/Object3DHelperPlugin/utils/PlaneHandle.d.ts +19 -0
- package/plugins/Object3DHelperPlugin/utils/calculateScaleByCamera.d.ts +5 -0
- package/plugins/Object3DHelperPlugin/utils/cameraHooks.d.ts +2 -0
- package/plugins/Object3DHelperPlugin/utils/direction.d.ts +14 -0
- package/plugins/Object3DHelperPlugin/utils/getMouseRaycaster.d.ts +5 -0
- package/plugins/Object3DHelperPlugin/utils/getOrthographicCameraDirection.d.ts +8 -0
- package/plugins/Object3DHelperPlugin/utils/setObjectQuaternion.d.ts +8 -0
- package/plugins/Object3DHelperPlugin/utils/solidGuide.d.ts +27 -0
- package/plugins/Object3DHelperPlugin/utils/tipsDom.d.ts +8 -0
- package/plugins/TrajectoryPlugin/Controller.d.ts +1 -1
- package/plugins/index.d.ts +4 -1
- package/plugins/index.js +35 -21
- package/plugins/index.mjs +5418 -4238
- package/plugins/thirdParty/CSS3DRenderer.d.ts +16 -3
- package/plugins/thirdParty/domevents.d.ts +36 -0
- package/plugins/utils/uuid.d.ts +1 -4
- package/react/context.d.ts +3 -2
- package/react/createProvider.d.ts +4 -4
- package/react/createStore.d.ts +3 -3
- package/react/hooks/useFiveProject2d.d.ts +1 -1
- package/react/index.js +3 -3
- package/react/index.mjs +572 -783
- package/react/rendererPool.d.ts +2 -2
- package/shader-lib/index.js +13 -14
- package/shader-lib/index.mjs +424 -824
- package/sticker/index.js +3 -3
- package/sticker/index.mjs +102 -142
- package/umd/five-gltf-loader.js +9 -9
- package/umd/five-line.js +4 -4
- package/umd/five-plugins.js +35 -21
- package/umd/five-react.js +3 -3
- package/umd/five-shader-lib.js +13 -14
- package/umd/five-sticker.js +3 -3
- package/umd/five-vfx.js +21 -21
- package/umd/five-vue.js +3 -3
- package/umd/five.js +267 -743
- package/vfx/index.js +21 -21
- package/vfx/index.mjs +454 -910
- package/vue/index.js +3 -3
- package/vue/index.mjs +309 -301
- package/vue/rendererPool.d.ts +5 -5
- package/work-downloader/index.js +3 -3
- package/work-downloader/index.mjs +339 -556
- package/five/gs/util/renderData.d.ts +0 -32
- package/five/model/loaders/glTF-helpers/extensions/PBM_mesh.d.ts +0 -11
- package/five/model/objects/pbmGSRenderMesh.d.ts +0 -29
- package/five/work/workObserverUtils.d.ts +0 -36
- /package/five/assets/{realsee-pmg-data-url.d.ts → realsee-png-data-url.d.ts} +0 -0
- /package/five/{gs → gaussian-splatting}/wasm/data.d.ts +0 -0
- /package/five/{gs → gaussian-splatting}/wasm/sort.d.ts +0 -0
- /package/five/{gs → gaussian-splatting}/worker/dataWorker.d.ts +0 -0
- /package/five/{gs → gaussian-splatting}/worker/sortWorker.d.ts +0 -0
|
@@ -86,10 +86,11 @@ Before writing or updating any documentation, YOU MUST READ <a href="ai-doc-guid
|
|
|
86
86
|
<li><a href="features_pano-tile.html">Pano Tile</a>: 全景瓦片渲染机制(高分辨率分片加载)。</li>
|
|
87
87
|
<li><a href="features_model.html">Model</a>: 内置模型渲染 (Mesh/Geometry)。</li>
|
|
88
88
|
<li><a href="features_postprocessing.html">Postprocessing</a>: 后处理效果 (Pass, EffectComposer)。</li>
|
|
89
|
-
<li><a href="features_flowing-light-2d-pass.html">Flowing Light 2D Pass</a>:
|
|
90
|
-
<li><a href="features_flowing-light-3d-pass.html">Flowing Light 3D Pass</a>:
|
|
89
|
+
<li><a href="features_flowing-light-2d-pass.html">Flowing Light 2D Pass</a>: 屏幕空间流光特效(InstancedMesh 优化)。</li>
|
|
90
|
+
<li><a href="features_flowing-light-3d-pass.html">Flowing Light 3D Pass</a>: 3D 世界坐标流光特效(InstancedMesh 优化)。</li>
|
|
91
91
|
<li><a href="features_gaussian-blur-pass.html">Gaussian Blur Pass</a>: 高斯模糊特效。</li>
|
|
92
92
|
<li><a href="features_material.html">Material</a>: 材质参数配置 (透明度、点云大小、顶点标记)。</li>
|
|
93
|
+
<li><a href="features_pano-filter.html">Pano Filter</a>: 全景图滤镜 (亮度、对比度、色温调节)。</li>
|
|
93
94
|
<li><a href="features_get-screen-pixels.html">Get Screen Pixels</a>: 获取屏幕像素 (放大镜/截图)。</li>
|
|
94
95
|
<li><a href="features_move-pano-effect.html">Move Pano Effect</a>: 全景点位切换的过渡效果。</li>
|
|
95
96
|
<li><a href="features_clipper.html">Clipper</a>: 模型裁切功能 (房屋剖面)。</li>
|
|
@@ -123,6 +124,126 @@ Before writing or updating any documentation, YOU MUST READ <a href="ai-doc-guid
|
|
|
123
124
|
</ul>
|
|
124
125
|
</li>
|
|
125
126
|
</ul>
|
|
127
|
+
<h2 id="common-scenarios-场景-→-文档速查" class="tsd-anchor-link">Common Scenarios (场景 → 文档速查)<a href="#common-scenarios-场景-→-文档速查" 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>
|
|
128
|
+
<blockquote>
|
|
129
|
+
<p><strong>Keyword Search Tip:</strong> Each doc in <code>features/</code> has a <code>tags</code> yaml block at the bottom with Chinese and English keywords. Use these for keyword matching when the scenario table below doesn't cover your need.</p>
|
|
130
|
+
</blockquote>
|
|
131
|
+
<table>
|
|
132
|
+
<thead>
|
|
133
|
+
<tr>
|
|
134
|
+
<th style="text-align:left">Scenario</th>
|
|
135
|
+
<th style="text-align:left">Docs</th>
|
|
136
|
+
<th style="text-align:left">Tags</th>
|
|
137
|
+
</tr>
|
|
138
|
+
</thead>
|
|
139
|
+
<tbody>
|
|
140
|
+
<tr>
|
|
141
|
+
<td style="text-align:left">点击拾取物体 / Object picking</td>
|
|
142
|
+
<td style="text-align:left"><a href="features_raycast.html">Raycast</a></td>
|
|
143
|
+
<td style="text-align:left">click, hit-test, floor-detection, 碰撞检测, 物体选择</td>
|
|
144
|
+
</tr>
|
|
145
|
+
<tr>
|
|
146
|
+
<td style="text-align:left">3D 标签 / HTML overlay on 3D point</td>
|
|
147
|
+
<td style="text-align:left"><a href="features_screen-project.html">Screen Project</a></td>
|
|
148
|
+
<td style="text-align:left">label, HUD, tooltip, 坐标转换, 3D转2D</td>
|
|
149
|
+
</tr>
|
|
150
|
+
<tr>
|
|
151
|
+
<td style="text-align:left">全景滤镜 / 色温调节 / Color correction</td>
|
|
152
|
+
<td style="text-align:left"><a href="features_pano-filter.html">Pano Filter</a></td>
|
|
153
|
+
<td style="text-align:left">warm, cool, brightness, contrast, saturation, 暖色, 冷色, 饱和度</td>
|
|
154
|
+
</tr>
|
|
155
|
+
<tr>
|
|
156
|
+
<td style="text-align:left">加载外部 GLTF/OBJ/FBX 模型</td>
|
|
157
|
+
<td style="text-align:left"><a href="features_load-external-model.html">Load External Model</a></td>
|
|
158
|
+
<td style="text-align:left">gltf, glb, ply, splat, fbx, draco, point-cloud, dispose</td>
|
|
159
|
+
</tr>
|
|
160
|
+
<tr>
|
|
161
|
+
<td style="text-align:left">相机巡航 / 自动导览 / Camera fly-through</td>
|
|
162
|
+
<td style="text-align:left"><a href="features_camera-animation.html">Camera Animation</a></td>
|
|
163
|
+
<td style="text-align:left">rotate, zoom, auto-tour, 运镜, 旋转, 缩放</td>
|
|
164
|
+
</tr>
|
|
165
|
+
<tr>
|
|
166
|
+
<td style="text-align:left">截图 / 放大镜 / Screen capture</td>
|
|
167
|
+
<td style="text-align:left"><a href="features_get-screen-pixels.html">Get Screen Pixels</a></td>
|
|
168
|
+
<td style="text-align:left">magnifier, screenshot, color-picker, 取色器</td>
|
|
169
|
+
</tr>
|
|
170
|
+
<tr>
|
|
171
|
+
<td style="text-align:left">模型裁切 / 房屋剖面</td>
|
|
172
|
+
<td style="text-align:left"><a href="features_clipper.html">Clipper</a></td>
|
|
173
|
+
<td style="text-align:left">clipping-box, section-view, discard, 开盖, 剖面</td>
|
|
174
|
+
</tr>
|
|
175
|
+
<tr>
|
|
176
|
+
<td style="text-align:left">流光特效 / Flowing light effect</td>
|
|
177
|
+
<td style="text-align:left"><a href="features_flowing-light-2d-pass.html">Flowing Light 2D</a>, <a href="features_flowing-light-3d-pass.html">Flowing Light 3D</a></td>
|
|
178
|
+
<td style="text-align:left">光带, 导航路径, 动态路径, instanced</td>
|
|
179
|
+
</tr>
|
|
180
|
+
<tr>
|
|
181
|
+
<td style="text-align:left">模糊特效 / Blur effect</td>
|
|
182
|
+
<td style="text-align:left"><a href="features_gaussian-blur-pass.html">Gaussian Blur Pass</a></td>
|
|
183
|
+
<td style="text-align:left">毛玻璃, 背景虚化, gaussian</td>
|
|
184
|
+
</tr>
|
|
185
|
+
<tr>
|
|
186
|
+
<td style="text-align:left">保存/恢复场景状态</td>
|
|
187
|
+
<td style="text-align:left"><a href="features_state.html">State</a></td>
|
|
188
|
+
<td style="text-align:left">snapshot, save, restore, 快照, 场景还原</td>
|
|
189
|
+
</tr>
|
|
190
|
+
<tr>
|
|
191
|
+
<td style="text-align:left">多场景切换 / 沙盘</td>
|
|
192
|
+
<td style="text-align:left"><a href="features_multi-work.html">Multi-Work</a></td>
|
|
193
|
+
<td style="text-align:left">sandbox, 多户型, 拼接, workCode</td>
|
|
194
|
+
</tr>
|
|
195
|
+
<tr>
|
|
196
|
+
<td style="text-align:left">请求鉴权 / CDN 替换</td>
|
|
197
|
+
<td style="text-align:left"><a href="features_request-proxy.html">Request Proxy</a></td>
|
|
198
|
+
<td style="text-align:left">authentication, token, url-rewrite, cors, 私有化</td>
|
|
199
|
+
</tr>
|
|
200
|
+
<tr>
|
|
201
|
+
<td style="text-align:left">插件开发</td>
|
|
202
|
+
<td style="text-align:left"><a href="features_plugin.html">Plugin</a></td>
|
|
203
|
+
<td style="text-align:left">lifecycle, extension, baseplugin, 状态管理</td>
|
|
204
|
+
</tr>
|
|
205
|
+
<tr>
|
|
206
|
+
<td style="text-align:left">事件监听 / 拦截默认行为</td>
|
|
207
|
+
<td style="text-align:left"><a href="features_event.html">Event</a></td>
|
|
208
|
+
<td style="text-align:left">preventDefault, waitUntil, on, off, gesture, 回调</td>
|
|
209
|
+
</tr>
|
|
210
|
+
<tr>
|
|
211
|
+
<td style="text-align:left">手势交互 / 自定义拖拽</td>
|
|
212
|
+
<td style="text-align:left"><a href="features_gesture.html">Gesture</a></td>
|
|
213
|
+
<td style="text-align:left">tap, pan, pinch, press, 触摸, 鼠标</td>
|
|
214
|
+
</tr>
|
|
215
|
+
<tr>
|
|
216
|
+
<td style="text-align:left">后处理特效 / 自定义 Shader</td>
|
|
217
|
+
<td style="text-align:left"><a href="features_postprocessing.html">Postprocessing</a></td>
|
|
218
|
+
<td style="text-align:left">effect-composer, addPass, edl, 描边, 景深</td>
|
|
219
|
+
</tr>
|
|
220
|
+
<tr>
|
|
221
|
+
<td style="text-align:left">材质 / 透明度 / 点云样式</td>
|
|
222
|
+
<td style="text-align:left"><a href="features_material.html">Material</a></td>
|
|
223
|
+
<td style="text-align:left">opacity, pointcloud, roof, ceiling, 天花板, 顶点标记</td>
|
|
224
|
+
</tr>
|
|
225
|
+
<tr>
|
|
226
|
+
<td style="text-align:left">模式切换 / 全景↔模型↔户型图</td>
|
|
227
|
+
<td style="text-align:left"><a href="features_mode.html">Mode</a></td>
|
|
228
|
+
<td style="text-align:left">panorama, floorplan, mapview, topview, VR</td>
|
|
229
|
+
</tr>
|
|
230
|
+
<tr>
|
|
231
|
+
<td style="text-align:left">全景高清瓦片 / 分片加载</td>
|
|
232
|
+
<td style="text-align:left"><a href="features_pano-tile.html">Pano Tile</a></td>
|
|
233
|
+
<td style="text-align:left">LOD, tile, 按需加载, 高清全景</td>
|
|
234
|
+
</tr>
|
|
235
|
+
<tr>
|
|
236
|
+
<td style="text-align:left">图片 CDN / 私有化部署</td>
|
|
237
|
+
<td style="text-align:left"><a href="features_image-options.html">Image Options</a></td>
|
|
238
|
+
<td style="text-align:left">avif, webp, cdn, private-deployment</td>
|
|
239
|
+
</tr>
|
|
240
|
+
<tr>
|
|
241
|
+
<td style="text-align:left">加载进度 / 首屏优化</td>
|
|
242
|
+
<td style="text-align:left"><a href="features_load-progress.html">Load Progress</a></td>
|
|
243
|
+
<td style="text-align:left">refined, loaded, loading-bar, 首屏</td>
|
|
244
|
+
</tr>
|
|
245
|
+
</tbody>
|
|
246
|
+
</table>
|
|
126
247
|
<h2 id="terminology-summary" class="tsd-anchor-link">Terminology Summary<a href="#terminology-summary" 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>
|
|
127
248
|
<ul>
|
|
128
249
|
<li><strong>Work</strong>: 包含全景图、模型、户型数据的 JSON 对象。</li>
|
|
@@ -135,4 +256,4 @@ Before writing or updating any documentation, YOU MUST READ <a href="ai-doc-guid
|
|
|
135
256
|
<pre><code class="yaml"><span class="hl-0">tags</span><span class="hl-1">: [</span><span class="hl-2">index</span><span class="hl-1">, </span><span class="hl-2">readme</span><span class="hl-1">, </span><span class="hl-2">guide</span><span class="hl-1">, </span><span class="hl-2">map</span><span class="hl-1">]</span>
|
|
136
257
|
</code><button type="button">Copy</button></pre>
|
|
137
258
|
|
|
138
|
-
</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-sdk-documentation"><span>Five <wbr/>SDK <wbr/>Documentation</span></a><ul><li><a href="#context-for-ai-agents"><span>Context for <wbr/>AI <wbr/>Agents</span></a></li><li><ul><li><a href="#1-documentation-maintenance-文档维护"><span>1. <wbr/>Documentation <wbr/>Maintenance (文档维护)</span></a></li><li><a href="#2-application-development-strategy-应用开发建议"><span>2. <wbr/>Application <wbr/>Development <wbr/>Strategy (应用开发建议)</span></a></li><li><a href="#3-general-retrieval-通用检索"><span>3. <wbr/>General <wbr/>Retrieval (通用检索)</span></a></li></ul></li><li><a href="#documentation-map"><span>Documentation <wbr/>Map</span></a></li><li><ul><li><a href="#1-essential-reference-必读速查"><span>1. <wbr/>Essential <wbr/>Reference (必读/速查)</span></a></li><li><a href="#2-core-concepts-核心概念"><span>2. <wbr/>Core <wbr/>Concepts (核心概念)</span></a></li><li><a href="#3-data-resource-数据与资源"><span>3. <wbr/>Data & <wbr/>Resource (数据与资源)</span></a></li><li><a href="#4-rendering-visuals-渲染与视觉"><span>4. <wbr/>Rendering & <wbr/>Visuals (渲染与视觉)</span></a></li><li><a href="#5-interaction-control-交互与控制"><span>5. <wbr/>Interaction & <wbr/>Control (交互与控制)</span></a></li><li><a href="#6-advanced-extensions-进阶与扩展"><span>6. <wbr/>Advanced & <wbr/>Extensions (进阶与扩展)</span></a></li><li><a href="#7-meta-support-其他"><span>7. <wbr/>Meta & <wbr/>Support (其他)</span></a></li></ul></li><li><a href="#terminology-summary"><span>Terminology <wbr/>Summary</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>
|
|
259
|
+
</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-sdk-documentation"><span>Five <wbr/>SDK <wbr/>Documentation</span></a><ul><li><a href="#context-for-ai-agents"><span>Context for <wbr/>AI <wbr/>Agents</span></a></li><li><ul><li><a href="#1-documentation-maintenance-文档维护"><span>1. <wbr/>Documentation <wbr/>Maintenance (文档维护)</span></a></li><li><a href="#2-application-development-strategy-应用开发建议"><span>2. <wbr/>Application <wbr/>Development <wbr/>Strategy (应用开发建议)</span></a></li><li><a href="#3-general-retrieval-通用检索"><span>3. <wbr/>General <wbr/>Retrieval (通用检索)</span></a></li></ul></li><li><a href="#documentation-map"><span>Documentation <wbr/>Map</span></a></li><li><ul><li><a href="#1-essential-reference-必读速查"><span>1. <wbr/>Essential <wbr/>Reference (必读/速查)</span></a></li><li><a href="#2-core-concepts-核心概念"><span>2. <wbr/>Core <wbr/>Concepts (核心概念)</span></a></li><li><a href="#3-data-resource-数据与资源"><span>3. <wbr/>Data & <wbr/>Resource (数据与资源)</span></a></li><li><a href="#4-rendering-visuals-渲染与视觉"><span>4. <wbr/>Rendering & <wbr/>Visuals (渲染与视觉)</span></a></li><li><a href="#5-interaction-control-交互与控制"><span>5. <wbr/>Interaction & <wbr/>Control (交互与控制)</span></a></li><li><a href="#6-advanced-extensions-进阶与扩展"><span>6. <wbr/>Advanced & <wbr/>Extensions (进阶与扩展)</span></a></li><li><a href="#7-meta-support-其他"><span>7. <wbr/>Meta & <wbr/>Support (其他)</span></a></li></ul></li><li><a href="#common-scenarios-场景-→-文档速查"><span>Common <wbr/>Scenarios (场景 → 文档速查)</span></a></li><li><a href="#terminology-summary"><span>Terminology <wbr/>Summary</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>
|
package/docs/documents/api.html
CHANGED
|
@@ -92,78 +92,122 @@
|
|
|
92
92
|
</table>
|
|
93
93
|
<h2 id="initialization-configuration-" class="tsd-anchor-link">Initialization Configuration (<code>FiveInitArgs</code>)<a href="#initialization-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>
|
|
94
94
|
<p>Configuration object passed to the <code>Five</code> constructor.</p>
|
|
95
|
-
<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">/** External WebGLRenderer. If provided, internal renderer creation is skipped. */</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/><br/><span class="hl-1"> </span><span class="hl-8">/** Width/Height of the viewport relative to container (0-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-7">number</span><span class="hl-1">; </span><span class="hl-6">bottom</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">; </span><span class="hl-6">width</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">; </span><span class="hl-6">height</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1"> };</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Canvas background color. Default: 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/><br/><span class="hl-1"> </span><span class="hl-8">/** Canvas background alpha (0-1). Default: 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/><br/><span class="hl-1"> </span><span class="hl-8">/** Enable antialiasing. Default: 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/><br/><span class="hl-1"> </span><span class="hl-8">/** Auto-play rendering loop. Default: true */</span><br/><span class="hl-1"> </span><span class="hl-6">play</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Enable on-demand rendering to save battery. Default: 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/><br/><span class="hl-1"> </span><span class="hl-8">/** Max FPS limit. false = unlimited. Default: false */</span><br/><span class="hl-1"> </span><span class="hl-6">maxFps</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1"> | </span><span class="hl-7">false</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Mode transition duration in ms. Default:
|
|
95
|
+
<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">/** External WebGLRenderer. If provided, internal renderer creation is skipped. */</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/><br/><span class="hl-1"> </span><span class="hl-8">/** Width/Height of the viewport relative to container (0-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-7">number</span><span class="hl-1">; </span><span class="hl-6">bottom</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">; </span><span class="hl-6">width</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1">; </span><span class="hl-6">height</span><span class="hl-1">: </span><span class="hl-7">number</span><span class="hl-1"> };</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Canvas background color. Default: 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/><br/><span class="hl-1"> </span><span class="hl-8">/** Canvas background alpha (0-1). Default: 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/><br/><span class="hl-1"> </span><span class="hl-8">/** Enable antialiasing. Default: 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/><br/><span class="hl-1"> </span><span class="hl-8">/** Auto-play rendering loop. Default: true */</span><br/><span class="hl-1"> </span><span class="hl-6">play</span><span class="hl-1">?: </span><span class="hl-7">boolean</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Enable on-demand rendering to save battery. Default: 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/><br/><span class="hl-1"> </span><span class="hl-8">/** Max FPS limit. false = unlimited. Default: false */</span><br/><span class="hl-1"> </span><span class="hl-6">maxFps</span><span class="hl-1">?: </span><span class="hl-7">number</span><span class="hl-1"> | </span><span class="hl-7">false</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Mode transition duration in ms. Default: 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/><br/><span class="hl-1"> </span><span class="hl-8">/** Enable mouse wheel zoom. Default: 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/><br/><span class="hl-1"> </span><span class="hl-8">/** Initial plugins to load. */</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/><br/><span class="hl-1"> </span><span class="hl-8">/** Dynamic image configuration for optimization. */</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/><br/><span class="hl-1"> </span><span class="hl-8">/** Dynamic texture configuration for optimization. */</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/><br/><span class="hl-1"> </span><span class="hl-8">/** Request URL interceptor for auth/CDN. */</span><br/><span class="hl-1"> </span><span class="hl-5">requestProxy</span><span class="hl-1">?: (</span><span class="hl-6">url</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">) </span><span class="hl-3">=></span><span class="hl-1"> </span><span class="hl-7">string</span><span class="hl-1"> | </span><span class="hl-7">Promise</span><span class="hl-1"><</span><span class="hl-7">string</span><span class="hl-1">>;</span><br/><br/><span class="hl-1"> </span><span class="hl-8">/** Per-mode configuration (panorama, mapview, floorplan, topview, model). */</span><br/><span class="hl-1"> </span><span class="hl-6">panorama</span><span class="hl-1">?: </span><span class="hl-7">PanoramaConfig</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">mapview</span><span class="hl-1">?: </span><span class="hl-7">MapviewConfig</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">floorplan</span><span class="hl-1">?: </span><span class="hl-7">FloorplanConfig</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">topview</span><span class="hl-1">?: </span><span class="hl-7">TopviewConfig</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">model</span><span class="hl-1">?: </span><span class="hl-7">ModelConfig</span><span class="hl-1">;</span><br/><span class="hl-1">}</span>
|
|
96
96
|
</code><button type="button">Copy</button></pre>
|
|
97
97
|
|
|
98
|
+
<blockquote>
|
|
99
|
+
<p>详细的模式配置参数见 <a href="../../ai_guides/features/mode.md#configuration">Mode</a>。
|
|
100
|
+
图片加载策略见 <a href="features_image-options.html">ImageOptions</a>。
|
|
101
|
+
请求代理见 <a href="features_request-proxy.html">Request Proxy</a>。
|
|
102
|
+
完整初始化参数见 <a href="features_five.html">Five</a> 和 <a href="features_parameter.html">Parameter</a>。</p>
|
|
103
|
+
</blockquote>
|
|
98
104
|
<h2 id="core-methods" class="tsd-anchor-link">Core Methods<a href="#core-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></h2>
|
|
99
|
-
<h3 id="" class="tsd-anchor-link"><code>load(work, state?, options?)</code></h3>
|
|
105
|
+
<h3 id="_" class="tsd-anchor-link"><code>load(work, state?, options?)</code><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>
|
|
100
106
|
<p>Loads a "Work" (dataset) into the Five instance.</p>
|
|
101
107
|
<ul>
|
|
102
108
|
<li><strong>work</strong>: The data object (<code>LooseWork</code> or <code>Work</code>) containing scene information.</li>
|
|
103
109
|
<li><strong>state</strong>: Initial state overrides. <code>"inherit"</code>, <code>"initial"</code>, or a <code>State</code> object.</li>
|
|
104
|
-
<li><strong>options</strong>: Loading options (e.g., transition duration).</li>
|
|
110
|
+
<li><strong>options</strong>: Loading options (e.g., transition duration, <code>mode: "add" | "replace"</code>).</li>
|
|
105
111
|
</ul>
|
|
106
|
-
<
|
|
112
|
+
<blockquote>
|
|
113
|
+
<p>详见 <a href="features_work.html">Work</a> 和 <a href="features_multi-work.html">Multi-Work</a>。</p>
|
|
114
|
+
</blockquote>
|
|
115
|
+
<h3 id="_-1" class="tsd-anchor-link"><code>appendTo(element, size?)</code><a href="#_-1" 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>
|
|
107
116
|
<p>Mounts the Five canvas to a DOM element.</p>
|
|
108
117
|
<ul>
|
|
109
118
|
<li><strong>element</strong>: HTMLElement to append to.</li>
|
|
110
119
|
<li><strong>size</strong>: Optional <code>{ width, height }</code>. Defaults to element size.</li>
|
|
111
120
|
</ul>
|
|
112
|
-
<h3 id="-2" class="tsd-anchor-link"><code>setState(state, immediately?, userAction?)</code><a href="
|
|
121
|
+
<h3 id="_-2" class="tsd-anchor-link"><code>setState(state, immediately?, userAction?)</code><a href="#_-2" 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>
|
|
113
122
|
<p>Updates the current state (position, mode, etc.).</p>
|
|
114
123
|
<ul>
|
|
115
124
|
<li><strong>state</strong>: Partial <code>State</code> object to merge.</li>
|
|
116
125
|
<li><strong>immediately</strong>: If <code>true</code>, skips animation.</li>
|
|
117
126
|
<li><strong>userAction</strong>: Marks the change as triggered by user interaction.</li>
|
|
118
127
|
</ul>
|
|
119
|
-
<
|
|
128
|
+
<blockquote>
|
|
129
|
+
<p>详见 <a href="features_state.html">State</a>。</p>
|
|
130
|
+
</blockquote>
|
|
131
|
+
<h3 id="_-3" class="tsd-anchor-link"><code>changeMode(mode, state?, options?)</code><a href="#_-3" 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>
|
|
120
132
|
<p>Switches the viewing mode (e.g., from <code>Panorama</code> to <code>Model</code>).</p>
|
|
121
133
|
<ul>
|
|
122
134
|
<li><strong>mode</strong>: Target <code>Five.Mode</code>.</li>
|
|
123
135
|
<li><strong>state</strong>: Target state after mode change.</li>
|
|
124
136
|
<li><strong>options</strong>: Animation duration and effect.</li>
|
|
125
137
|
</ul>
|
|
126
|
-
<
|
|
138
|
+
<blockquote>
|
|
139
|
+
<p>详见 <a href="features_mode.html">Mode</a>。</p>
|
|
140
|
+
</blockquote>
|
|
141
|
+
<h3 id="_-4" class="tsd-anchor-link"><code>moveToPano(panoIndex, options?)</code><a href="#_-4" 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>
|
|
127
142
|
<p>Moves to a specific panorama spot.</p>
|
|
128
143
|
<ul>
|
|
129
144
|
<li><strong>panoIndex</strong>: Index of the panorama.</li>
|
|
130
|
-
<li><strong>options</strong>: <code>{ effect?: MovePanoEffect, duration?: number }</code>.</li>
|
|
145
|
+
<li><strong>options</strong>: <code>{ effect?: MovePanoEffect, duration?: number, effectEasing?: Function }</code>.</li>
|
|
131
146
|
</ul>
|
|
132
|
-
<
|
|
147
|
+
<blockquote>
|
|
148
|
+
<p>详见 <a href="features_move-pano-effect.html">Move Pano Effect</a> 和 <a href="features_camera-animation.html">Camera Animation</a>。</p>
|
|
149
|
+
</blockquote>
|
|
150
|
+
<h3 id="_-5" class="tsd-anchor-link"><code>updateCamera(pose, duration, userAction?)</code><a href="#_-5" 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>
|
|
151
|
+
<p>Animates the camera to a target pose without changing pano index.</p>
|
|
152
|
+
<ul>
|
|
153
|
+
<li><strong>pose</strong>: Partial <code>Pose</code> object (longitude, latitude, fov, etc.).</li>
|
|
154
|
+
<li><strong>duration</strong>: Animation duration in ms.</li>
|
|
155
|
+
<li><strong>returns</strong>: <code>Promise<void></code> (rejects if interrupted).</li>
|
|
156
|
+
</ul>
|
|
157
|
+
<blockquote>
|
|
158
|
+
<p>详见 <a href="features_camera-animation.html">Camera Animation</a>。</p>
|
|
159
|
+
</blockquote>
|
|
160
|
+
<h3 id="_-6" class="tsd-anchor-link"><code>ready(args?)</code><a href="#_-6" 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>
|
|
161
|
+
<p>Returns a Promise that resolves when Five is stable (state synced, model loaded, optionally tiles loaded).</p>
|
|
162
|
+
<ul>
|
|
163
|
+
<li><strong>args</strong>: <code>{ tile?: boolean }</code> — if <code>tile: true</code> in Panorama mode, waits for tile loading.</li>
|
|
164
|
+
</ul>
|
|
165
|
+
<h3 id="_-7" class="tsd-anchor-link"><code>refresh(size?)</code><a href="#_-7" 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>
|
|
133
166
|
<p>Resizes the renderer to fit the container or specified size.</p>
|
|
134
|
-
<h3 id="-
|
|
167
|
+
<h3 id="_-8" class="tsd-anchor-link"><code>getElement()</code><a href="#_-8" 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>
|
|
135
168
|
<p>Returns the <code><canvas></code> element used by Five.</p>
|
|
136
|
-
<h3 id="-
|
|
169
|
+
<h3 id="_-9" class="tsd-anchor-link"><code>project2d(vector, testModel?)</code><a href="#_-9" 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>
|
|
137
170
|
<p>Projects a 3D point to 2D screen coordinates.</p>
|
|
138
171
|
<ul>
|
|
139
172
|
<li><strong>vector</strong>: <code>THREE.Vector3</code> (World Space).</li>
|
|
140
173
|
<li><strong>testModel</strong>: <code>boolean</code> (default <code>false</code>). If <code>true</code>, checks for occlusion.</li>
|
|
141
174
|
<li><strong>returns</strong>: <code>THREE.Vector2</code> (Screen Space, px) or <code>null</code>.</li>
|
|
142
175
|
</ul>
|
|
143
|
-
<
|
|
176
|
+
<blockquote>
|
|
177
|
+
<p>详见 <a href="features_screen-project.html">Screen & Space Projection</a>。</p>
|
|
178
|
+
</blockquote>
|
|
179
|
+
<h3 id="_-10" class="tsd-anchor-link"><code>getPixels(options)</code><a href="#_-10" 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>
|
|
144
180
|
<p>Get pixel data from the renderer (e.g. for color picking or magnifier).</p>
|
|
145
181
|
<ul>
|
|
146
|
-
<li><strong>x, y
|
|
147
|
-
<li><strong>width, height</strong>: Size of the rectangle.</li>
|
|
182
|
+
<li><strong>options</strong>: <code>{ x, y, width, height, pixelRatio?, flipY?, buffer?, skipPanorama?, helperVisible? }</code></li>
|
|
148
183
|
<li><strong>returns</strong>: <code>Uint8Array</code> (RGBA data).</li>
|
|
149
184
|
</ul>
|
|
150
|
-
<
|
|
185
|
+
<blockquote>
|
|
186
|
+
<p>详见 <a href="features_get-screen-pixels.html">Get Screen Pixels</a>。</p>
|
|
187
|
+
</blockquote>
|
|
188
|
+
<h3 id="_-11" class="tsd-anchor-link"><code>intersectRaycaster(raycaster)</code><a href="#_-11" 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>
|
|
151
189
|
<p>(On <code>five.model</code>) Performs raycasting against the scene models.</p>
|
|
152
190
|
<ul>
|
|
153
|
-
<li><strong>raycaster</strong>: <code>THREE.Raycaster</code
|
|
154
|
-
<li><strong>returns</strong>: <code>THREE.Intersection[]</code
|
|
155
|
-
</ul>
|
|
156
|
-
<h3 id="-10" class="tsd-anchor-link"><code>addPass(pass)</code><a href="#-10" 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>
|
|
157
|
-
<p>Add a post-processing pass to the rendering chain.</p>
|
|
158
|
-
<ul>
|
|
159
|
-
<li><strong>pass</strong>: <code>FivePass</code> instance (e.g. <code>Gaussian Blur Pass</code>).</li>
|
|
191
|
+
<li><strong>raycaster</strong>: <code>THREE.Raycaster</code> (supports extended props: <code>firstHitOnly</code>, <code>hitFilter</code>, <code>sortByDistance</code>, <code>floorIndex</code>).</li>
|
|
192
|
+
<li><strong>returns</strong>: <code>THREE.Intersection[]</code> (extended with <code>tile</code>, <code>viewLayer</code>, <code>model</code> fields).</li>
|
|
160
193
|
</ul>
|
|
161
|
-
<
|
|
162
|
-
<p
|
|
194
|
+
<blockquote>
|
|
195
|
+
<p>详见 <a href="features_raycast.html">Raycast</a>。</p>
|
|
196
|
+
</blockquote>
|
|
197
|
+
<h3 id="_-12" class="tsd-anchor-link"><code>addPass(pass)</code> / <code>removePass(pass)</code><a href="#_-12" 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>
|
|
198
|
+
<p>Add or remove a post-processing pass to/from the rendering chain.</p>
|
|
163
199
|
<ul>
|
|
164
|
-
<li><strong>pass</strong>: <code>FivePass</code> instance
|
|
200
|
+
<li><strong>pass</strong>: <code>FivePass</code> instance (e.g. <code>GaussianBlurPass</code>, <code>FlowingLight2DPass</code>).</li>
|
|
165
201
|
</ul>
|
|
166
|
-
<
|
|
202
|
+
<blockquote>
|
|
203
|
+
<p>详见 <a href="features_postprocessing.html">Postprocessing</a>。</p>
|
|
204
|
+
</blockquote>
|
|
205
|
+
<h3 id="_-13" class="tsd-anchor-link"><code>updateConfiguration(config)</code><a href="#_-13" 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>
|
|
206
|
+
<p>Dynamically update mode configurations after initialization (e.g., panorama, mapview settings).</p>
|
|
207
|
+
<blockquote>
|
|
208
|
+
<p>详见 <a href="../../ai_guides/features/mode.md#%E5%8A%A8%E6%80%81%E4%BF%AE%E6%94%B9%E9%85%8D%E7%BD%AE-update-configuration">Mode</a>。</p>
|
|
209
|
+
</blockquote>
|
|
210
|
+
<h3 id="_-14" class="tsd-anchor-link"><code>dispose()</code><a href="#_-14" 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>
|
|
167
211
|
<p>Destroys the Five instance and releases resources.</p>
|
|
168
212
|
<h2 id="state-management" class="tsd-anchor-link">State Management<a href="#state-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></h2>
|
|
169
213
|
<p>The <code>State</code> interface defines the complete status of the Five instance at any moment.</p>
|
|
@@ -171,7 +215,10 @@
|
|
|
171
215
|
</code><button type="button">Copy</button></pre>
|
|
172
216
|
|
|
173
217
|
<h2 id="data-structures" class="tsd-anchor-link">Data Structures<a href="#data-structures" 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>
|
|
174
|
-
<
|
|
218
|
+
<blockquote>
|
|
219
|
+
<p>以下为核心数据结构摘要。完整定义见 <a href="features_work.html">Work</a>、<a href="features_state.html">State</a>、<a href="features_model.html">Model</a>。</p>
|
|
220
|
+
</blockquote>
|
|
221
|
+
<h3 id="_-15" class="tsd-anchor-link"><code>Work</code><a href="#_-15" 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>
|
|
175
222
|
<p>The main data object containing the scene description.</p>
|
|
176
223
|
<pre><code class="typescript"><span class="hl-3">interface</span><span class="hl-1"> </span><span class="hl-7">Work</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">workCode</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">; </span><span class="hl-8">// Unique identifier</span><br/><span class="hl-1"> </span><span class="hl-6">name</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">; </span><span class="hl-8">// Project name</span><br/><span class="hl-1"> </span><span class="hl-6">observers</span><span class="hl-1">: </span><span class="hl-7">WorkObserver</span><span class="hl-1">[]; </span><span class="hl-8">// List of panorama points</span><br/><span class="hl-1"> </span><span class="hl-6">model</span><span class="hl-1">: </span><span class="hl-7">WorkModel</span><span class="hl-1">; </span><span class="hl-8">// 3D model data</span><br/><span class="hl-1"> </span><span class="hl-6">initial</span><span class="hl-1">: </span><span class="hl-7">WorkInitial</span><span class="hl-1">; </span><span class="hl-8">// Initial view state</span><br/><span class="hl-1"> </span><span class="hl-6">transform</span><span class="hl-1">: </span><span class="hl-7">THREE</span><span class="hl-1">.</span><span class="hl-7">Matrix4</span><span class="hl-1">; </span><span class="hl-8">// World transform matrix</span><br/><span class="hl-1">}</span>
|
|
177
224
|
</code><button type="button">Copy</button></pre>
|
|
@@ -199,25 +246,53 @@
|
|
|
199
246
|
<tr>
|
|
200
247
|
<td style="text-align:left"><code>gesture.tap</code></td>
|
|
201
248
|
<td style="text-align:left">Triggered on tap/click. Replaces <code>wantsTapGesture</code>.</td>
|
|
202
|
-
<td style="text-align:left"><code>
|
|
249
|
+
<td style="text-align:left"><code>GestureEvent</code></td>
|
|
250
|
+
</tr>
|
|
251
|
+
<tr>
|
|
252
|
+
<td style="text-align:left"><code>gesture.dbltap</code></td>
|
|
253
|
+
<td style="text-align:left">Triggered on double tap/click.</td>
|
|
254
|
+
<td style="text-align:left"><code>GestureEvent</code></td>
|
|
203
255
|
</tr>
|
|
204
256
|
<tr>
|
|
205
257
|
<td style="text-align:left"><code>gesture.pan</code></td>
|
|
206
258
|
<td style="text-align:left">Triggered on pan/drag.</td>
|
|
207
|
-
<td style="text-align:left"><code>
|
|
259
|
+
<td style="text-align:left"><code>GestureEvent</code></td>
|
|
208
260
|
</tr>
|
|
209
261
|
<tr>
|
|
210
262
|
<td style="text-align:left"><code>gesture.pinch</code></td>
|
|
211
263
|
<td style="text-align:left">Triggered on pinch/zoom.</td>
|
|
212
|
-
<td style="text-align:left"><code>
|
|
264
|
+
<td style="text-align:left"><code>GestureEvent</code></td>
|
|
213
265
|
</tr>
|
|
214
266
|
<tr>
|
|
215
267
|
<td style="text-align:left"><code>gesture.press</code></td>
|
|
216
268
|
<td style="text-align:left">Triggered on long press.</td>
|
|
217
|
-
<td style="text-align:left"><code>
|
|
269
|
+
<td style="text-align:left"><code>GestureEvent</code></td>
|
|
270
|
+
</tr>
|
|
271
|
+
<tr>
|
|
272
|
+
<td style="text-align:left"><code>gesture.mousewheel</code></td>
|
|
273
|
+
<td style="text-align:left">Triggered on mouse wheel scroll.</td>
|
|
274
|
+
<td style="text-align:left"><code>GestureEvent</code></td>
|
|
275
|
+
</tr>
|
|
276
|
+
<tr>
|
|
277
|
+
<td style="text-align:left"><code>gesture.mousemove</code></td>
|
|
278
|
+
<td style="text-align:left">Triggered on mouse move.</td>
|
|
279
|
+
<td style="text-align:left"><code>GestureEvent</code></td>
|
|
280
|
+
</tr>
|
|
281
|
+
<tr>
|
|
282
|
+
<td style="text-align:left"><code>gesture.momentum</code></td>
|
|
283
|
+
<td style="text-align:left">Triggered on inertia movement after pan.</td>
|
|
284
|
+
<td style="text-align:left"><code>GestureEvent</code></td>
|
|
285
|
+
</tr>
|
|
286
|
+
<tr>
|
|
287
|
+
<td style="text-align:left"><code>gesture.fire</code></td>
|
|
288
|
+
<td style="text-align:left">Triggered when any gesture event fires.</td>
|
|
289
|
+
<td style="text-align:left"><code>GestureEvent</code></td>
|
|
218
290
|
</tr>
|
|
219
291
|
</tbody>
|
|
220
292
|
</table>
|
|
293
|
+
<blockquote>
|
|
294
|
+
<p>手势事件详解及不同 Mode 下的默认行为见 <a href="features_gesture.html">Gesture</a>。</p>
|
|
295
|
+
</blockquote>
|
|
221
296
|
<h4 id="state-mode" class="tsd-anchor-link">State & Mode<a href="#state-mode" 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></h4>
|
|
222
297
|
<table>
|
|
223
298
|
<thead>
|
|
@@ -245,6 +320,9 @@
|
|
|
245
320
|
</tr>
|
|
246
321
|
</tbody>
|
|
247
322
|
</table>
|
|
323
|
+
<blockquote>
|
|
324
|
+
<p>状态管理详见 <a href="features_state.html">State</a>,模式切换详见 <a href="features_mode.html">Mode</a>。</p>
|
|
325
|
+
</blockquote>
|
|
248
326
|
<h4 id="lifecycle-resources" class="tsd-anchor-link">Lifecycle & Resources<a href="#lifecycle-resources" 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></h4>
|
|
249
327
|
<table>
|
|
250
328
|
<thead>
|
|
@@ -261,19 +339,49 @@
|
|
|
261
339
|
<td style="text-align:left"><code>WorksEvent</code></td>
|
|
262
340
|
</tr>
|
|
263
341
|
<tr>
|
|
342
|
+
<td style="text-align:left"><code>works.ready</code></td>
|
|
343
|
+
<td style="text-align:left">Triggered when work data is loaded and controller is ready.</td>
|
|
344
|
+
<td style="text-align:left"><code>WorksEvent</code></td>
|
|
345
|
+
</tr>
|
|
346
|
+
<tr>
|
|
264
347
|
<td style="text-align:left"><code>models.load</code></td>
|
|
265
348
|
<td style="text-align:left">Triggered when models are loaded.</td>
|
|
266
349
|
<td style="text-align:left"><code>ModelSceneEvent</code></td>
|
|
267
350
|
</tr>
|
|
268
351
|
<tr>
|
|
352
|
+
<td style="text-align:left"><code>models.refined</code></td>
|
|
353
|
+
<td style="text-align:left">Triggered when all models finish texture refinement.</td>
|
|
354
|
+
<td style="text-align:left"><code>ModelSceneEvent</code></td>
|
|
355
|
+
</tr>
|
|
356
|
+
<tr>
|
|
357
|
+
<td style="text-align:left"><code>model.load</code></td>
|
|
358
|
+
<td style="text-align:left">Triggered when a single model geometry is loaded.</td>
|
|
359
|
+
<td style="text-align:left"><code>ModelEvent</code></td>
|
|
360
|
+
</tr>
|
|
361
|
+
<tr>
|
|
269
362
|
<td style="text-align:left"><code>model.tileLoad</code></td>
|
|
270
363
|
<td style="text-align:left">Triggered when a 3D tile is loaded.</td>
|
|
271
|
-
<td style="text-align:left"><code>
|
|
364
|
+
<td style="text-align:left"><code>ModelTileEvent</code></td>
|
|
272
365
|
</tr>
|
|
273
366
|
<tr>
|
|
274
367
|
<td style="text-align:left"><code>model.tileUnload</code></td>
|
|
275
368
|
<td style="text-align:left">Triggered when a 3D tile is unloaded.</td>
|
|
276
|
-
<td style="text-align:left"><code>
|
|
369
|
+
<td style="text-align:left"><code>ModelTileEvent</code></td>
|
|
370
|
+
</tr>
|
|
371
|
+
<tr>
|
|
372
|
+
<td style="text-align:left"><code>model.changeShownFloor</code></td>
|
|
373
|
+
<td style="text-align:left">Triggered when floor visibility changes.</td>
|
|
374
|
+
<td style="text-align:left"><code>ModelEvent</code></td>
|
|
375
|
+
</tr>
|
|
376
|
+
<tr>
|
|
377
|
+
<td style="text-align:left"><code>model.error</code></td>
|
|
378
|
+
<td style="text-align:left">Triggered when model loading fails.</td>
|
|
379
|
+
<td style="text-align:left"><code>ModelErrorEvent</code></td>
|
|
380
|
+
</tr>
|
|
381
|
+
<tr>
|
|
382
|
+
<td style="text-align:left"><code>pano.prepare</code></td>
|
|
383
|
+
<td style="text-align:left">Triggered before switching to a new pano. <code>ExtendableEvent</code>, supports <code>waitUntil</code>.</td>
|
|
384
|
+
<td style="text-align:left"><code>PanoPrepareEvent</code></td>
|
|
277
385
|
</tr>
|
|
278
386
|
<tr>
|
|
279
387
|
<td style="text-align:left"><code>pano.arrived</code></td>
|
|
@@ -281,9 +389,19 @@
|
|
|
281
389
|
<td style="text-align:left"><code>PanoEvent</code></td>
|
|
282
390
|
</tr>
|
|
283
391
|
<tr>
|
|
392
|
+
<td style="text-align:left"><code>pano.moving</code></td>
|
|
393
|
+
<td style="text-align:left">Triggered during pano transition animation.</td>
|
|
394
|
+
<td style="text-align:left"><code>PanoEvent</code></td>
|
|
395
|
+
</tr>
|
|
396
|
+
<tr>
|
|
397
|
+
<td style="text-align:left"><code>pano.error</code></td>
|
|
398
|
+
<td style="text-align:left">Triggered when pano loading or movement fails.</td>
|
|
399
|
+
<td style="text-align:left"><code>PanoEvent</code></td>
|
|
400
|
+
</tr>
|
|
401
|
+
<tr>
|
|
284
402
|
<td style="text-align:left"><code>pano.texture.progress</code></td>
|
|
285
403
|
<td style="text-align:left">Triggered when panorama texture loading progresses.</td>
|
|
286
|
-
<td style="text-align:left"><code>
|
|
404
|
+
<td style="text-align:left"><code>PanoTextureEvent</code></td>
|
|
287
405
|
</tr>
|
|
288
406
|
<tr>
|
|
289
407
|
<td style="text-align:left"><code>render</code></td>
|
|
@@ -291,12 +409,22 @@
|
|
|
291
409
|
<td style="text-align:left"><code>RenderEvent</code></td>
|
|
292
410
|
</tr>
|
|
293
411
|
<tr>
|
|
412
|
+
<td style="text-align:left"><code>render.prepare</code></td>
|
|
413
|
+
<td style="text-align:left">Triggered before each render frame.</td>
|
|
414
|
+
<td style="text-align:left"><code>RenderEvent</code></td>
|
|
415
|
+
</tr>
|
|
416
|
+
<tr>
|
|
294
417
|
<td style="text-align:left"><code>error</code></td>
|
|
295
418
|
<td style="text-align:left">Triggered on internal errors.</td>
|
|
296
419
|
<td style="text-align:left"><code>Error</code></td>
|
|
297
420
|
</tr>
|
|
298
421
|
</tbody>
|
|
299
422
|
</table>
|
|
423
|
+
<blockquote>
|
|
424
|
+
<p>事件系统详解见 <a href="features_event.html">Event</a>。手势事件详解见 <a href="features_gesture.html">Gesture</a>。
|
|
425
|
+
<code>pano.prepare</code> 的 <code>waitUntil</code> / <code>preventDefault</code> 用法见 <a href="../../ai_guides/features/event.md#event-%E5%AF%B9%E8%B1%A1">Event - Event 对象</a>。
|
|
426
|
+
模型生命周期事件见 <a href="../../ai_guides/features/model.md#events">Model</a> 和 <a href="features_load-progress.html">Load Progress</a>。</p>
|
|
427
|
+
</blockquote>
|
|
300
428
|
<h3 id="legacy-events-deprecated" class="tsd-anchor-link">Legacy Events (Deprecated)<a href="#legacy-events-deprecated" 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>
|
|
301
429
|
<p>Older events are still supported for compatibility but should be avoided in new code.</p>
|
|
302
430
|
<table>
|
|
@@ -334,4 +462,4 @@
|
|
|
334
462
|
<pre><code class="typescript"><span class="hl-8">// Recommended: Use the new event system</span><br/><span class="hl-6">five</span><span class="hl-1">.</span><span class="hl-5">on</span><span class="hl-1">(</span><span class="hl-9">'gesture.tap'</span><span class="hl-1">, (</span><span class="hl-6">event</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">'User tapped at:'</span><span class="hl-1">, </span><span class="hl-6">event</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-8">// Legacy (Avoid):</span><br/><span class="hl-8">// five.on('wantsTapGesture', (raycaster) => { ... });</span>
|
|
335
463
|
</code><button type="button">Copy</button></pre>
|
|
336
464
|
|
|
337
|
-
</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-sdk-api-reference"><span>Five <wbr/>SDK <wbr/>API <wbr/>Reference</span></a><ul><li><a href="#core-class"><span>Core <wbr/>Class: </span></a></li><li><ul><li><a href="#constructor"><span>Constructor</span></a></li><li><a href="#properties"><span>Properties</span></a></li><li><a href="#static-properties"><span>Static <wbr/>Properties</span></a></li></ul></li><li><a href="#initialization-configuration-"><span>Initialization <wbr/>Configuration ()</span></a></li><li><a href="#core-methods"><span>Core <wbr/>Methods</span></a></li><li><ul><li><a href="#"><span></span></a></li><li><a href="
|
|
465
|
+
</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-sdk-api-reference"><span>Five <wbr/>SDK <wbr/>API <wbr/>Reference</span></a><ul><li><a href="#core-class"><span>Core <wbr/>Class: </span></a></li><li><ul><li><a href="#constructor"><span>Constructor</span></a></li><li><a href="#properties"><span>Properties</span></a></li><li><a href="#static-properties"><span>Static <wbr/>Properties</span></a></li></ul></li><li><a href="#initialization-configuration-"><span>Initialization <wbr/>Configuration ()</span></a></li><li><a href="#core-methods"><span>Core <wbr/>Methods</span></a></li><li><ul><li><a href="#_"><span></span></a></li><li><a href="#_-1"><span></span></a></li><li><a href="#_-2"><span></span></a></li><li><a href="#_-3"><span></span></a></li><li><a href="#_-4"><span></span></a></li><li><a href="#_-5"><span></span></a></li><li><a href="#_-6"><span></span></a></li><li><a href="#_-7"><span></span></a></li><li><a href="#_-8"><span></span></a></li><li><a href="#_-9"><span></span></a></li><li><a href="#_-10"><span></span></a></li><li><a href="#_-11"><span></span></a></li><li><a href="#_-12"><span> / </span></a></li><li><a href="#_-13"><span></span></a></li><li><a href="#_-14"><span></span></a></li></ul></li><li><a href="#state-management"><span>State <wbr/>Management</span></a></li><li><a href="#data-structures"><span>Data <wbr/>Structures</span></a></li><li><ul><li><a href="#_-15"><span></span></a></li><li><a href="#panorama-point"><span> (<wbr/>Panorama <wbr/>Point)</span></a></li></ul></li><li><a href="#events"><span>Events</span></a></li><li><ul><li><a href="#recommended-events-modern"><span>Recommended <wbr/>Events (<wbr/>Modern)</span></a></li><li><ul><li><a href="#interaction-gestures"><span>Interaction & <wbr/>Gestures</span></a></li><li><a href="#state-mode"><span>State & <wbr/>Mode</span></a></li><li><a href="#lifecycle-resources"><span>Lifecycle & <wbr/>Resources</span></a></li></ul></li><li><a href="#legacy-events-deprecated"><span>Legacy <wbr/>Events (<wbr/>Deprecated)</span></a></li><li><a href="#usage-example"><span>Usage <wbr/>Example</span></a></li></ul></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>
|