@realsee/five 6.8.0-alpha.2 → 6.8.0-alpha.21
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 +9 -6
- package/{guides → ai_guides}/README.md +12 -2
- package/ai_guides/ai-doc-guidelines.md +102 -0
- package/{guides → ai_guides}/api.md +24 -1
- package/ai_guides/features/3dtile.md +172 -0
- package/{guides → ai_guides}/features/camera-animation.md +24 -3
- package/{guides → ai_guides}/features/clipper.md +2 -0
- package/{guides/features/coordnate-system.md → ai_guides/features/coordinate-system.md} +2 -0
- package/{guides → ai_guides}/features/event.md +2 -0
- package/{guides → ai_guides}/features/five.md +4 -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/{guides → ai_guides}/features/gesture.md +3 -0
- package/{guides → ai_guides}/features/get-screen-pixels.md +2 -0
- package/{guides → ai_guides}/features/image-options.md +3 -0
- package/{guides → ai_guides}/features/load-external-model.md +21 -0
- package/ai_guides/features/load-progress.md +140 -0
- package/ai_guides/features/material.md +153 -0
- package/{guides → ai_guides}/features/mode.md +4 -0
- package/{guides → ai_guides}/features/model.md +4 -1
- package/{guides → ai_guides}/features/move-pano-effect.md +2 -0
- package/{guides → ai_guides}/features/multi-work.md +2 -0
- package/ai_guides/features/pano-filter.md +148 -0
- package/{guides → ai_guides}/features/pano-tile.md +7 -14
- 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/{guides → ai_guides}/features/postprocessing.md +39 -4
- package/{guides → ai_guides}/features/raycast.md +11 -0
- package/{guides → ai_guides}/features/request-proxy.md +2 -0
- package/{guides → ai_guides}/features/screen-project.md +2 -0
- package/{guides → ai_guides}/features/state.md +2 -0
- package/ai_guides/features/view-layer.md +187 -0
- package/{guides → ai_guides}/features/work.md +63 -2
- package/{guides → ai_guides}/glossary.md +26 -5
- package/{guides → ai_guides}/intro.md +1 -1
- package/{guides → ai_guides}/quick-start.md +1 -0
- package/ai_guides/release_notes/6.8.md +208 -0
- package/{guides → ai_guides}/template.md +17 -3
- package/docs/00_FOR_AI_AGENTS.md +11 -0
- package/docs/README.md +4 -7
- package/docs/assets/hierarchy.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.BoundingMesh.html +2 -2
- package/docs/classes/five.Camera.html +1 -1
- package/docs/classes/five.EyeDomeLightingPass.html +1 -1
- package/docs/classes/five.Five.html +73 -72
- 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 +31 -31
- package/docs/classes/five.ModelScene.html +1 -1
- package/docs/classes/five.NetworkSubscribe.html +1 -1
- 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 +16 -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 -53
- package/docs/classes/five.Scene.html +1 -1
- package/docs/classes/five.Subscribe.html +1 -1
- 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 +27 -2
- package/docs/classes/gltf-loader.DDSLoader.html +1 -1
- package/docs/classes/gltf-loader.DRACOLoader.html +1 -1
- package/docs/classes/gltf-loader.GLTFLoader.html +1 -1
- package/docs/classes/gltf-loader.GLTFObject.html +1 -1
- package/docs/classes/gltf-loader.GLTFParser.html +1 -1
- package/docs/classes/gltf-loader.THREEGLTFLoader.html +1 -1
- package/docs/classes/line.Line.html +1 -1
- package/docs/classes/line.LineGeometry.html +1 -1
- package/docs/classes/line.LineMaterial.html +1 -1
- package/docs/classes/line.LineSegmentsGeometry.html +1 -1
- package/docs/classes/line.THREE_Line2.html +1 -1
- package/docs/classes/line.THREE_LineSegments2.html +1 -1
- package/docs/classes/plugins.BasePlugin.Controller.html +1 -1
- 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 +1 -1
- package/docs/classes/vfx.ParticleGPU.html +1 -1
- package/docs/classes/vfx.SpotLight.html +1 -1
- package/docs/documents/README.html +11 -2
- package/docs/documents/ai-doc-guidelines.html +60 -15
- package/docs/documents/api.html +40 -15
- package/docs/documents/features_3dtile.html +142 -45
- package/docs/documents/features_camera-animation.html +62 -5
- package/docs/documents/features_clipper.html +3 -0
- package/docs/documents/{features_coordnate-system.html → features_coordinate-system.html} +4 -1
- package/docs/documents/features_event.html +3 -0
- package/docs/documents/features_five.html +4 -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 +4 -0
- package/docs/documents/features_get-screen-pixels.html +3 -0
- package/docs/documents/features_image-options.html +3 -0
- package/docs/documents/features_load-external-model.html +25 -2
- package/docs/documents/features_load-progress.html +110 -0
- package/docs/documents/features_material.html +341 -0
- package/docs/documents/features_mode.html +5 -0
- package/docs/documents/features_model.html +5 -1
- package/docs/documents/features_move-pano-effect.html +3 -0
- package/docs/documents/features_multi-work.html +3 -0
- package/docs/documents/features_pano-filter.html +122 -0
- package/docs/documents/features_pano-tile.html +34 -19
- package/docs/documents/features_pano-uv.html +82 -0
- package/docs/documents/features_parameter.html +76 -56
- package/docs/documents/features_plugin.html +105 -0
- package/docs/documents/features_postprocessing.html +22 -5
- package/docs/documents/features_raycast.html +4 -1
- package/docs/documents/features_request-proxy.html +3 -0
- package/docs/documents/features_screen-project.html +3 -0
- package/docs/documents/features_state.html +3 -0
- package/docs/documents/features_view-layer.html +158 -0
- package/docs/documents/features_work.html +63 -2
- package/docs/documents/glossary.html +31 -6
- package/docs/documents/intro.html +1 -1
- package/docs/documents/quick-start.html +1 -0
- package/docs/documents/release_notes_6.8.html +189 -0
- package/docs/documents/template.html +45 -4
- 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/vue.useFiveWorks.html +2 -2
- package/docs/hierarchy.html +1 -1
- package/docs/index.html +11 -2
- 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 +53 -47
- package/docs/interfaces/five.FloorplanControllerCustomInitArgs.html +9 -9
- 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.MapviewControllerCustomInitArgs.html +9 -9
- 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 +7 -7
- 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.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 +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 +42 -38
- package/docs/interfaces/five.ParameterTilesetValue.html +15 -15
- package/docs/interfaces/five.ParameterValue.html +56 -52
- package/docs/interfaces/five.Pose.html +1 -1
- package/docs/interfaces/five.RenderEvent.html +2 -2
- package/docs/interfaces/five.ResolvedParameterValue.html +56 -52
- 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 +2 -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 +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 +27 -2
- 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 +13 -13
- package/docs/modules/five.html +1 -1
- package/docs/modules.html +1 -1
- package/docs/types/five.ControllerEventTypes.html +27 -25
- package/docs/types/five.EasingFunction.html +1 -0
- package/docs/types/five.EventTypes.html +27 -25
- 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.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/plugins.BasePlugin.EventMap.html +1 -1
- package/docs/variables/five.PROXY_CONTROLLER_EVENT_NAMES.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 +519 -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-png-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 +167 -0
- package/five/controllers/events.d.ts +71 -0
- package/five/controllers/floorplan.d.ts +119 -0
- package/five/controllers/mapview.d.ts +139 -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/gaussian-splatting/util/renderData.d.ts +52 -0
- package/five/gaussian-splatting/wasm/data.d.ts +20 -0
- package/five/gaussian-splatting/wasm/sort.d.ts +18 -0
- package/five/gaussian-splatting/worker/dataWorker.d.ts +1 -0
- package/five/gaussian-splatting/worker/sortWorker.d.ts +1 -0
- package/five/index.d.ts +60 -4637
- package/five/index.js +193 -341
- package/five/index.mjs +26455 -31011
- 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 +137 -0
- package/five/model/materials/pbmMeshMaterial.d.ts +126 -0
- package/five/model/materials/pbmPointCloudMaterial.d.ts +70 -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/pbmGaussianSplattingObject.d.ts +43 -0
- package/five/model/objects/pbmGaussianSplattingRenderMesh.d.ts +55 -0
- package/five/model/objects/pbmGaussianSplattingTestMesh.d.ts +7 -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 +140 -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 +17 -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-cube-to-equirectangular.d.ts +7 -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/histogram.d.ts +54 -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/texture/textureData.d.ts +11 -0
- package/five/thirdparty/fflate.d.ts +1407 -0
- package/five/thirdparty/hammer.d.ts +375 -0
- package/five/thirdparty/jsrsasign.d.ts +753 -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 +36 -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 +159 -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 +9 -9
- package/gltf-loader/index.mjs +1351 -1451
- 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 +4 -4
- package/line/index.mjs +334 -513
- 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 +43 -31
- package/package.json +11 -2
- 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 +17 -21
- package/plugins/index.mjs +3342 -4245
- 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 +3 -3
- package/react/index.mjs +572 -783
- 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 +13 -14
- package/shader-lib/index.mjs +424 -824
- package/sticker/geometry.d.ts +3 -0
- package/sticker/index.d.ts +68 -71
- 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 +17 -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 +188 -336
- 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 +21 -21
- package/vfx/index.mjs +454 -910
- 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 +3 -3
- package/vue/index.mjs +309 -301
- 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 +3 -3
- package/work-downloader/index.mjs +317 -556
- 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/five.FivePlugin.plugin.html +0 -60
- package/docs/documents/plugin.html +0 -60
- package/docs/media/five.ts +0 -2881
- package/docs/media/pass.ts +0 -64
- package/guides/ai-doc-guidelines.md +0 -72
- package/guides/features/3dtile.md +0 -264
- package/guides/features/parameter.md +0 -178
- package/guides/plugin.md +0 -206
- /package/{guides → ai_guides}/release_notes/6.6.md +0 -0
- /package/{guides → ai_guides}/release_notes/6.7.md +0 -0
- /package/{guides → ai_guides}/support.md +0 -0
|
@@ -7,12 +7,16 @@
|
|
|
7
7
|
|
|
8
8
|
## Schema
|
|
9
9
|
|
|
10
|
+
> **Definition**: [Work](../../five/work/work.d.ts), [LooseWork](../../five/work/looseWorkType.d.ts), [WorkJson](../../five/work/workJsonType.d.ts)
|
|
11
|
+
|
|
10
12
|
`Work` 及其相关核心接口定义如下:
|
|
11
13
|
|
|
12
14
|
```ts
|
|
13
15
|
import * as THREE from "three";
|
|
14
16
|
import type { Mode } from "@realsee/five";
|
|
15
17
|
|
|
18
|
+
type CubeFace = 'up' | 'down' | 'left' | 'right' | 'front' | 'back';
|
|
19
|
+
|
|
16
20
|
/** Work 实体:VR 项目的根对象 */
|
|
17
21
|
export interface Work {
|
|
18
22
|
/** 唯一标识 (Work ID) */
|
|
@@ -72,6 +76,21 @@ export interface WorkObserver {
|
|
|
72
76
|
|
|
73
77
|
/** 点位全景图资源信息 */
|
|
74
78
|
images: WorkImage;
|
|
79
|
+
|
|
80
|
+
/** 获取点位的全局坐标 */
|
|
81
|
+
getWorldPosition(this: WorkObserver): THREE.Vector3;
|
|
82
|
+
|
|
83
|
+
/** 获取点位的全局地面坐标 */
|
|
84
|
+
getWorldStandingPosition(this: WorkObserver): THREE.Vector3;
|
|
85
|
+
|
|
86
|
+
/** 将方向向量转化为全景图 uv */
|
|
87
|
+
vectorToEquirectangularUv(vector: THREE.Vector3, uvOrigin?: 'top-left' | 'bottom-left'): THREE.Vector2;
|
|
88
|
+
/** 将全景图 uv 转化为方向向量 */
|
|
89
|
+
equirectangularUvToVector(uv: THREE.Vector2, uvOrigin?: 'top-left' | 'bottom-left'): THREE.Vector3;
|
|
90
|
+
/** 将方向向量转化为获六视图 uv */
|
|
91
|
+
vectorToCubemapUv(vector: THREE.Vector3, uvOrigin?: 'top-left' | 'bottom-left'): [cubeFace: CubeFace, cubemapUv: THREE.Vector2];
|
|
92
|
+
/** 将六视图 uv 转化为方向向量 */
|
|
93
|
+
cubemapUvToVector(cubeFace: CubeFace, uv: THREE.Vector2, uvOrigin?: 'top-left' | 'bottom-left'): THREE.Vector3;
|
|
75
94
|
}
|
|
76
95
|
|
|
77
96
|
/** 初始化位姿参数 */
|
|
@@ -113,8 +132,8 @@ export interface WorkModel {
|
|
|
113
132
|
export interface WorkModelLayer {
|
|
114
133
|
/** work */
|
|
115
134
|
work: Work;
|
|
116
|
-
/** 模型类型 point_cloud mesh */
|
|
117
|
-
type: 'point_cloud' | 'mesh';
|
|
135
|
+
/** 模型类型 point_cloud mesh gaussian_splatting */
|
|
136
|
+
type: 'point_cloud' | 'mesh' | 'gaussian_splatting';
|
|
118
137
|
/** 模型名称 */
|
|
119
138
|
name: string;
|
|
120
139
|
/** 指定上方向 */
|
|
@@ -140,6 +159,48 @@ export interface WorkImage {
|
|
|
140
159
|
### Work Entity (项目实体)
|
|
141
160
|
Work 是 Five 渲染内容的基石。它不仅包含资源地址,还包含空间结构数据。由于数据通常带有数字签名(防止篡改),开发者**不应手动修改** Work 对象中的属性,尤其是资源路径和坐标数据。
|
|
142
161
|
|
|
162
|
+
### Data Types (数据类型)
|
|
163
|
+
Five 中有三种与 Work 相关的类型,它们分别对应不同的使用场景:
|
|
164
|
+
|
|
165
|
+
* **LooseWork (宽泛数据)**:
|
|
166
|
+
* **来源**: 通常是服务端下发的原始 JSON 数据。
|
|
167
|
+
* **特点**: 结构宽松,允许缺省值(如使用默认模态)、简写(如 URL 模板)和非标准类型(如数组表示向量)。
|
|
168
|
+
* **用途**: 作为 `parseWork(json)` 的输入。
|
|
169
|
+
* **Work (运行时实体)**:
|
|
170
|
+
* **来源**: 由 `parseWork` 解析生成。
|
|
171
|
+
* **特点**: 结构严谨,数据已标准化(如 URL 已补全,向量转为 `THREE.Vector3`),且被冻结(不可变)。
|
|
172
|
+
* **用途**: Five 内部渲染使用的核心对象,传给 `five.load(work)`。
|
|
173
|
+
* **WorkJson (标准序列化)**:
|
|
174
|
+
* **来源**: 由 `workToJson(work)` 生成。
|
|
175
|
+
* **特点**: 纯 JSON 结构,去除了运行时对象(如 THREE.Vector3),但保留了标准化的数据结构。
|
|
176
|
+
* **用途**: 用于数据持久化存储或跨端传输。
|
|
177
|
+
|
|
178
|
+
### Layers vs File (数据源关系)
|
|
179
|
+
|
|
180
|
+
`WorkModel` 提供了两种定义模型数据的方式,其中 `layers` 是现代标准,`file` 主要用于兼容旧数据或简单场景。
|
|
181
|
+
|
|
182
|
+
* **`layers`**: (推荐) 数组结构,用于定义多层级、多类型的模型资源。
|
|
183
|
+
* 支持 **3DTiles** 格式的分块加载。
|
|
184
|
+
* 支持多种类型混合:`mesh` (模型), `point_cloud` (点云), `gaussian_splatting` (高斯泼溅)。
|
|
185
|
+
* **默认行为**: 列表中的所有图层默认都会被加载并显示。
|
|
186
|
+
* **`file`**: (兼容) 字符串路径,用于定义单文件的 Mesh 模型。
|
|
187
|
+
* 仅支持部分格式(如 `.at3d`, `.obj`, `.glb`)。
|
|
188
|
+
* 不支持点云或高斯泼溅。
|
|
189
|
+
|
|
190
|
+
**加载优先级与兼容逻辑 (Fallback)**:
|
|
191
|
+
|
|
192
|
+
Five 在运行时会将 `file` 视为一个虚拟的 `mesh` 图层。加载逻辑如下:
|
|
193
|
+
|
|
194
|
+
1. **优先加载 Layers**:
|
|
195
|
+
Five 会遍历 `work.model.layers` 并加载其中定义的所有图层(包括 Mesh, PointCloud, GaussianSplatting 等)。
|
|
196
|
+
|
|
197
|
+
2. **File 的条件加载**:
|
|
198
|
+
检查当前已加载的图层中是否存在 `type: 'mesh'` 的图层。
|
|
199
|
+
* **存在 Mesh 层**: 忽略 `work.model.file` 字段(认为 `layers` 已经提供了更高精度的模型)。
|
|
200
|
+
* **不存在 Mesh 层**: 如果 `work.model.file` 有值,Five 会自动创建一个临时的 Mesh ViewLayer 来加载该文件。
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
143
204
|
### Observer (观察点)
|
|
144
205
|
Observer 是 VR 空间中预设的观察位置。在 **Panorama (全景)** 模式下,相机必须停留在某个 Observer 上。
|
|
145
206
|
* **position**: 相机镜头的物理位置。
|
|
@@ -9,11 +9,15 @@
|
|
|
9
9
|
SDK 的核心入口类。一个 `Five` 实例对应一个 `<canvas>` 渲染上下文,负责管理场景生命周期、渲染循环、用户交互和状态更新。
|
|
10
10
|
|
|
11
11
|
### Work
|
|
12
|
-
VR
|
|
13
|
-
- **
|
|
14
|
-
- **
|
|
15
|
-
-
|
|
16
|
-
|
|
12
|
+
VR 看房的**运行时实体**。通常指经过 `parseWork` 解析后生成的标准化数据对象。
|
|
13
|
+
- **LooseWork**: 服务端下发的原始 JSON 数据,结构较宽松。
|
|
14
|
+
- **WorkJson**: `workToJson` 生成的标准序列化数据,用于存储。
|
|
15
|
+
- **包含内容**: Observers, Panorama, Model, Plan 等。
|
|
16
|
+
|
|
17
|
+
### Vertex Marks (顶点标记)
|
|
18
|
+
在模型顶点上通过 `_feature_id_rsmask` 属性进行的标记。
|
|
19
|
+
- 用于在特定视角(如俯视)下控制 Mesh 的显隐(例如隐藏天花板)。
|
|
20
|
+
- 属于材质配置的一部分。
|
|
17
21
|
|
|
18
22
|
### Observer
|
|
19
23
|
**观察点**。对应现实空间中拍摄全景图的一个物理位置。
|
|
@@ -54,6 +58,23 @@ Five 定义的五种浏览状态:
|
|
|
54
58
|
### G-Buffer / Geometry Buffer
|
|
55
59
|
用于后处理的几何缓冲区,包含深度 (Depth)、法线 (Normal)、ID 等信息,用于实现高级特效(如轮廓线、SSAO)。
|
|
56
60
|
|
|
61
|
+
### ViewLayer
|
|
62
|
+
管理 `Model` 内部特定 3D 资源(如 Mesh、PointCloud、Gaussian Splatting)的图层。
|
|
63
|
+
- 继承自 `Tile3D`。
|
|
64
|
+
- 拥有独立的 `Parameter` 配置(覆盖上层配置)。
|
|
65
|
+
- 支持可见性控制 (`visible`) 和优先级加载。
|
|
66
|
+
|
|
67
|
+
### Gaussian Splatting (3DGS)
|
|
68
|
+
一种基于点的 3D 渲染技术,通过各向异性高斯球(Splat)来表示场景。
|
|
69
|
+
- 相比传统 Mesh,能更真实地还原复杂光照和细节。
|
|
70
|
+
- Five 支持 `.spz` 和 `.splat` 格式的 3DGS 渲染。
|
|
71
|
+
|
|
72
|
+
### 3D Tiles Refinement (细化)
|
|
73
|
+
3D Tiles 加载过程中的状态概念:
|
|
74
|
+
- **Loaded (已加载)**: 瓦片的基本数据已下载并解析,满足最低显示要求 (`minLevelOfDetail`)。
|
|
75
|
+
- **Refined (已细化)**: 瓦片已加载最高质量数据,满足当前视角的屏幕空间误差要求 (`maxScreenSpaceError`)。
|
|
76
|
+
- `five.model.refineProgress` 可用于监控当前视角的细化进度。
|
|
77
|
+
|
|
57
78
|
## Interaction (交互)
|
|
58
79
|
|
|
59
80
|
### Raycast (射线检测)
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
* **全景浏览**: 支持高分辨率全景图的高效加载与平滑浏览。详见 [Pano Tile](./features/pano-tile.md)。
|
|
10
10
|
* **空间漫游**: 支持在三维模型中自由行走、跳转。详见 [Mode](./features/mode.md)。
|
|
11
|
-
* **模型渲染**: 内置高效的模型加载策略 (3DTile)
|
|
11
|
+
* **模型渲染**: 内置高效的模型加载策略 (3DTile) 与灵活的材质配置。详见 [Model](./features/model.md) 与 [Material](./features/material.md)。
|
|
12
12
|
* **交互事件**: 完善的事件系统,支持手势、射线检测等。详见 [Event](./features/event.md) 与 [Raycast](./features/raycast.md)。
|
|
13
13
|
* **状态管理**: 统一的 State 设计,便于状态保存与还原。详见 [State](./features/state.md)。
|
|
14
14
|
|
|
@@ -60,6 +60,7 @@ fetch(workURL)
|
|
|
60
60
|
* **控制视角与移动**: 了解如何通过代码控制相机。 -> [Five.updateCamera](./features/five.md) / [State](./features/state.md)
|
|
61
61
|
* **切换模态**: 在全景、模型、平面图之间切换。 -> [Mode](./features/mode.md)
|
|
62
62
|
* **监听事件**: 响应用户的点击和交互。 -> [Event](./features/event.md)
|
|
63
|
+
* **视觉调整**: 修改材质参数或开启后处理效果。 -> [Material](./features/material.md) / [Postprocessing](./features/postprocessing.md)
|
|
63
64
|
* **自定义配置**: 修改图片加载参数或渲染效果。 -> [ImageOptions](./features/image-options.md)
|
|
64
65
|
|
|
65
66
|
## Related
|
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
# Release Note 6.8.x
|
|
2
|
+
> 6.8.x 版本发布日志
|
|
3
|
+
|
|
4
|
+
```shell
|
|
5
|
+
npm install @realsee/five@6.8
|
|
6
|
+
```
|
|
7
|
+
|
|
8
|
+
## Gaussian Splatting (3DGS) 支持
|
|
9
|
+
> Five 现已支持 Gaussian Splatting (3DGS) 渲染管线。这是一种基于点的渲染技术,能够提供高质量的实时渲染效果。
|
|
10
|
+
> 仅在 WebGL2 环境下可用。
|
|
11
|
+
|
|
12
|
+
### 文件格式支持
|
|
13
|
+
1. `.splat` 文档及工具 [GitHub - antimatter15/splat: WebGL 3D Gaussian Splat Viewer](https://github.com/antimatter15/splat)
|
|
14
|
+
2. `.spz` 文档及工具 GitHub - [nianticlabs/spz: File format for 3D Gaussian splats. About 10x smaller than the PLY equival](https://github.com/nianticlabs/spz)
|
|
15
|
+
3. `.glb` `.gltf` 对应的 KHR_gaussian_splatting_compression_spz 扩展。
|
|
16
|
+
|
|
17
|
+
### 支持 3d-tile
|
|
18
|
+
> 通过 3d-tile 标准,使用 glb 作为模型格式。
|
|
19
|
+
|
|
20
|
+
```json
|
|
21
|
+
{
|
|
22
|
+
"asset": {
|
|
23
|
+
"version": "1.0",
|
|
24
|
+
},
|
|
25
|
+
"geometricError": 265.4529731527354,
|
|
26
|
+
"root": {
|
|
27
|
+
"boundingVolume": {
|
|
28
|
+
"box": [
|
|
29
|
+
0.9499778747558594, 3.5037269592285156, 17.48550033569336,
|
|
30
|
+
97.01779174804688, 0.0, 0.0,
|
|
31
|
+
0.0, 88.27268981933594, 0.0,
|
|
32
|
+
0.0, 0.0, 20.292869567871094
|
|
33
|
+
]
|
|
34
|
+
},
|
|
35
|
+
"content": {
|
|
36
|
+
"uri": "splat.glb"
|
|
37
|
+
},
|
|
38
|
+
"geometricError": 66.36324328818385,
|
|
39
|
+
"refine": "ADD"
|
|
40
|
+
},
|
|
41
|
+
"transform": [
|
|
42
|
+
1.0, 0.0, 0.0, 0.0,
|
|
43
|
+
0.0, 1.0, 0.0, 0.0,
|
|
44
|
+
0.0, 0.0, 1.0, 0.0,
|
|
45
|
+
0.0, 0.0, 0.0, 1.0
|
|
46
|
+
]
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### 通过 Work 加载
|
|
51
|
+
|
|
52
|
+
```json
|
|
53
|
+
{
|
|
54
|
+
"work_code": "",
|
|
55
|
+
"model": {
|
|
56
|
+
"layers": {
|
|
57
|
+
"tileset_url": "tileset.json",
|
|
58
|
+
"name": "poincare_3dgs",
|
|
59
|
+
"type": "gaussian_splatting"
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### 配置球谐光照阶数 (SH Degree)
|
|
66
|
+
可以通过 five.parameter.gSHDegree 设置球谐光照阶数,支持 0, 1, 2 阶,默认为 0 阶。
|
|
67
|
+
```
|
|
68
|
+
const five = new Five({
|
|
69
|
+
parameters: {
|
|
70
|
+
gaussianSplattingSHDegree: 1 // 设置为 1 阶 SH
|
|
71
|
+
}
|
|
72
|
+
});
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### 模型的射线检测
|
|
76
|
+
gaussian_splatting 的模型同时也支持 rayscast 射线检测。同点云的处理保持一致。但是因为 gaussian_splatting 的射线交点对应的法线方向是一个估算值,精度并不高。请酌情使用。
|
|
77
|
+
|
|
78
|
+
## glTF 模型支持增强
|
|
79
|
+
> 新增了对更多 glTF 扩展的支持,提升了模型的表现力和动画能力。
|
|
80
|
+
|
|
81
|
+
### 扩展新增及优化
|
|
82
|
+
|
|
83
|
+
#### KHR_animation_pointer
|
|
84
|
+
> KHR_animation_pointer 允许动画通道指向 glTF 资产中任何对象的任何属性。
|
|
85
|
+
|
|
86
|
+
默认的 animtion 只能修改 node 的 transform 实现节点的平移、旋转和缩放
|
|
87
|
+
|
|
88
|
+
这个能力可以实现材质动画。比如:
|
|
89
|
+
- 通过 uv transform 实现 texture 的移动,变化贴图位置。
|
|
90
|
+
- 通过修改 material 上的材质属性,可以动态修改金属粗糙,透明度,自发光程度。
|
|
91
|
+
- 通过修改 node 的 KHR_node_visibility 的扩展值,显隐某个节点。
|
|
92
|
+
- 等等
|
|
93
|
+
|
|
94
|
+
#### KHR_node_visibility
|
|
95
|
+
> 允许设置节点的可见性属性。
|
|
96
|
+
用于 配合 KHR_animation_pointer 实现显隐效果。
|
|
97
|
+
|
|
98
|
+
#### KHR_materials_clearcoat
|
|
99
|
+
> 用于在材质上添加一层透明涂层,模拟车漆、碳纤维、清漆木材等真实世界中的表面效果。
|
|
100
|
+
|
|
101
|
+
这个能力可以实现材质动画。比如
|
|
102
|
+
- 漆面等光滑的表面
|
|
103
|
+
- 塑料薄膜
|
|
104
|
+
- 等等
|
|
105
|
+
|
|
106
|
+
#### KHR_materials_transmission
|
|
107
|
+
> 物理透光材质扩展,用于实现光线真正穿过物体的透明 / 半透明效果。
|
|
108
|
+
|
|
109
|
+
这个能力可以实现材质动画。比如
|
|
110
|
+
- 玻璃等即透光也反射的表面
|
|
111
|
+
- 等等
|
|
112
|
+
|
|
113
|
+
#### KHR_materials_emissive_strength
|
|
114
|
+
> 调整自发光强度
|
|
115
|
+
|
|
116
|
+
#### KHR_materials_unlit
|
|
117
|
+
> 不感光材质
|
|
118
|
+
正确解析 KHR_materials_unlit。是否感光作用到对应的 material 上,而不是 gltf 中的所有元素。
|
|
119
|
+
|
|
120
|
+
### 动画优化
|
|
121
|
+
处理额外动画骨骼未绑定导致的错误, 出现的抖动。
|
|
122
|
+
|
|
123
|
+
## 模型 ViewLayer 加载策略优化
|
|
124
|
+
> 优化了 ViewLayer 的加载和显隐逻辑,以减少内存占用并提高性能。
|
|
125
|
+
|
|
126
|
+
#### 默认加载策略变更
|
|
127
|
+
默认情况下,Five 不再加载所有图层,而是根据优先级仅加载一个图层。
|
|
128
|
+
优先级顺序:mesh > point_cloud > gaussian_splatting > 其他类型。
|
|
129
|
+
|
|
130
|
+
#### 显隐与内存管理
|
|
131
|
+
- 显示: 当 viewLayer.visible = true 时,开始加载资源。
|
|
132
|
+
- 隐藏: 当 viewLayer.visible = false 时,释放该图层占用的所有内存资源。
|
|
133
|
+
|
|
134
|
+
#### 加载进度
|
|
135
|
+
- 新增 tile.content.loadProgress 属性,用于查看每个瓦片的加载进度 (0-1)。
|
|
136
|
+
- 新增 tile.content.byteLength 属性,可在加载过程中获取瓦片内容的字节长度。
|
|
137
|
+
- 同时,model.tileLoad 和 model.tileUnload 事件被添加,用于监控瓦片的生命周期。
|
|
138
|
+
- 加载函数(loadGltf, loadPly 等)现在支持 onDownloadProgress 回调,用于监控文件下载进度。
|
|
139
|
+
|
|
140
|
+
#### 射线检测增强
|
|
141
|
+
- 射线交点 Intersection 对象新增了 tile, model, viewLayer 字段,便于在射线检测时获取更详细的上下文信息。
|
|
142
|
+
- raycaster.hitFilter 回调函数的参数类型定义已更新,包含 model, viewLayer, tile 等上下文信息。
|
|
143
|
+
|
|
144
|
+
## Work 增强
|
|
145
|
+
### Observer 支持 uv 计算工具函数
|
|
146
|
+
为 WorkObserver 提供了更多实用的工具函数,便于进行坐标和 UV 转换。
|
|
147
|
+
UV 转换工具函数
|
|
148
|
+
- observer.vectorToEquirectangularUv: 将方向向量转化为全景图 uv。
|
|
149
|
+
- observer.equirectangularUvToVector: 将全景图 uv 转化为方向向量。
|
|
150
|
+
- observer.vectorToCubemapUv: 将方向向量转化为立方体贴图 uv。
|
|
151
|
+
- observer.cubemapUvToVector: 将立方体贴图 uv 转化为方向向量。
|
|
152
|
+
|
|
153
|
+
## 全景图滤镜
|
|
154
|
+
|
|
155
|
+
新增了全景图滤镜功能,支持实时调整全景图的亮度、对比度、饱和度、色温和色调等参数。
|
|
156
|
+
|
|
157
|
+
通过 `five.modelScene.parameter.set('panoFilter', filter)` 绑定。
|
|
158
|
+
支持的参数如下:
|
|
159
|
+
- color: 颜色调整,包含色温 (Temperature) 和色调 (Tint)。
|
|
160
|
+
- highlightShadow: 高光和阴影的独立调节。包括高光 (Highlight) 和阴影 (Shadow) 全局(Global)。
|
|
161
|
+
- contrast: 对比度调整。
|
|
162
|
+
- saturation: 饱和度调整。
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
## 新增后处理效果 (Post-Processing Passes)
|
|
166
|
+
新增了三个可选的内置后处理 Pass,用于增强视觉效果。
|
|
167
|
+
|
|
168
|
+
- FlowingLight2DPass: 2D 流光效果,通常用于在屏幕空间绘制流动的光线(如道路流光)。
|
|
169
|
+
- FlowingLight3DPass: 3D 流光效果,基于深度缓冲区在三维模型表面绘制流光。
|
|
170
|
+
- GaussianBlurPass: 高斯模糊效果,可用于实现毛玻璃等视觉特效。
|
|
171
|
+
|
|
172
|
+
## 工具优化
|
|
173
|
+
### Work Viewer
|
|
174
|
+
> https://vradmin.lianjia.com/project/
|
|
175
|
+
- 支持 debug -> stateSync。可以打开两个页面,均开启 stateSync。两边同步相机状态。
|
|
176
|
+
- 支持 work.json 拖拽加载加载。
|
|
177
|
+
|
|
178
|
+
### Model Viewer
|
|
179
|
+
> https://vradmin.lianjia.com/poincare/
|
|
180
|
+
- 支持 debug -> stateSync。可以打开两个页面,均开启 stateSync。两边同步相机状态。
|
|
181
|
+
- 支持 模型文件拖拽加载加载。
|
|
182
|
+
|
|
183
|
+
### glTF Viewer
|
|
184
|
+
> https://vradmin.lianjia.com/gltf/
|
|
185
|
+
- 支持 debug -> stateSync。可以打开两个页面,均开启 stateSync。两边同步相机状态。
|
|
186
|
+
- 支持 模型文件拖拽加载加载。
|
|
187
|
+
- 支持 额外绑定动画文件(仅读取 gltf 的 animations 的部分,并绑定到当前的模型上)。
|
|
188
|
+
- 支持 额外绑定动画的单独播放和暂停。
|
|
189
|
+
|
|
190
|
+
## 友好文档
|
|
191
|
+
全面重构了文档结构,使其更适合 AI 辅助编程工具 (如 Cursor, Copilot) 阅读和索引。
|
|
192
|
+
|
|
193
|
+
- 文档目录迁移至 ai_guides/,并在 package.json 中新增 ai 字段指向该目录。
|
|
194
|
+
- 文档内容包含源码链接 (source 字段),直接指向对应的 .ts 定义文件。
|
|
195
|
+
- 提供了更清晰的 API 定义和概念说明,例如新增了 ViewLayer 的详细文档。
|
|
196
|
+
- TypeScript 支持: 优化了 .d.ts 打包方式,声明文件现在与源码文件一一对应,提升了 IDE 的跳转体验。
|
|
197
|
+
|
|
198
|
+
## 其他
|
|
199
|
+
1. 优化 mapview 下滚动缩放。避免滚落所发有时会退回的问题。
|
|
200
|
+
2. 优化 floorplan 从下向上看时的交互的屏幕上下滑动反人类下意识的问题。
|
|
201
|
+
3. 优化 camera.autoNearFar 的计算结果。优化对于小物品的 near 过远以及 出现 z-fighting 的问题。
|
|
202
|
+
4. 添加了 gesture.create 事件,发生在所有事件创建时。
|
|
203
|
+
5. gestureEvent.center gestureEvent.pointers 中加入了 buttons button shiftKey ctrlKey metaKey altKey 字段。
|
|
204
|
+
|
|
205
|
+
## 内部机制改动
|
|
206
|
+
1. glTF 加载 mesh / points 都将直接使用 PBM 材质,而不是作为 PBM_Mesh 扩展形式去替换覆盖使用three内置材质的方式。
|
|
207
|
+
2. 应用 animation pointer 以及 动画优化的原因。目前会重写 hack THREE.PropertyBinding.findNode。
|
|
208
|
+
3. 打包不再合并 .d.ts 文件。便于文档可以更便于找到对应的类型声明。
|
|
@@ -8,7 +8,9 @@
|
|
|
8
8
|
|
|
9
9
|
## Schema
|
|
10
10
|
|
|
11
|
-
(
|
|
11
|
+
> **Definition**: `[InterfaceName](../../five/path/to/source.d.ts)` 或多个 `[Main](../../lib/...)`, `[Options](../../lib/...)`
|
|
12
|
+
|
|
13
|
+
(这里放置 Interface 定义、TS 类型或参数表。务必包含 Definition 源码链接。)
|
|
12
14
|
|
|
13
15
|
## Concepts
|
|
14
16
|
|
|
@@ -16,7 +18,19 @@
|
|
|
16
18
|
|
|
17
19
|
## Configuration
|
|
18
20
|
|
|
19
|
-
(
|
|
21
|
+
(可选:初始化参数、配置项说明。若参数较多,请按以下分类展示)
|
|
22
|
+
|
|
23
|
+
### Common Configuration (常用配置)
|
|
24
|
+
|
|
25
|
+
| Parameter | Type | Default | Description |
|
|
26
|
+
| :--- | :--- | :--- | :--- |
|
|
27
|
+
| `key` | `type` | `default` | Description. |
|
|
28
|
+
|
|
29
|
+
### Advanced Configuration (进阶配置)
|
|
30
|
+
|
|
31
|
+
| Parameter | Type | Default | Description |
|
|
32
|
+
| :--- | :--- | :--- | :--- |
|
|
33
|
+
| `key` | `type` | `default` | Description. |
|
|
20
34
|
|
|
21
35
|
## Instance Properties
|
|
22
36
|
|
|
@@ -47,7 +61,7 @@
|
|
|
47
61
|
|
|
48
62
|
## Related
|
|
49
63
|
|
|
50
|
-
* [
|
|
64
|
+
* `[RelatedConcept](./related-concept.md)`: 简述关联关系。
|
|
51
65
|
|
|
52
66
|
---
|
|
53
67
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# FOR_AI_AGENTS
|
|
2
|
+
> **⚠️ Note for AI Agents:**
|
|
3
|
+
>
|
|
4
|
+
> This directory contains auto-generated HTML documentation which is dense and difficult to parse effectively.
|
|
5
|
+
>
|
|
6
|
+
> **PLEASE IGNORE THE CONTENTS OF THIS DIRECTORY.**
|
|
7
|
+
>
|
|
8
|
+
> Instead, refer to the **ai_guides** directory in the package root. It contains high-quality, structured Markdown documentation specifically optimized for comprehension and retrieval.
|
|
9
|
+
>
|
|
10
|
+
> * **Go to Guides**: [../ai_guides/README.md](../ai_guides/README.md)
|
|
11
|
+
> * **Go to API Index**: [../ai_guides/api.md](../ai_guides/api.md)
|
package/docs/README.md
CHANGED
|
@@ -1,14 +1,11 @@
|
|
|
1
|
-
|
|
2
|
-
# Documentation Directory
|
|
3
|
-
|
|
1
|
+
# Documentation Directory
|
|
4
2
|
> **⚠️ Note for AI Agents:**
|
|
5
3
|
>
|
|
6
4
|
> This directory contains auto-generated HTML documentation which is dense and difficult to parse effectively.
|
|
7
5
|
>
|
|
8
6
|
> **PLEASE IGNORE THE CONTENTS OF THIS DIRECTORY.**
|
|
9
7
|
>
|
|
10
|
-
> Instead, refer to the **
|
|
8
|
+
> Instead, refer to the **ai_guides** directory in the package root. It contains high-quality, structured Markdown documentation specifically optimized for comprehension and retrieval.
|
|
11
9
|
>
|
|
12
|
-
> * **Go to Guides**: [../
|
|
13
|
-
> * **Go to API Index**: [../
|
|
14
|
-
|
|
10
|
+
> * **Go to Guides**: [../ai_guides/README.md](../ai_guides/README.md)
|
|
11
|
+
> * **Go to API Index**: [../ai_guides/api.md](../ai_guides/api.md)
|
package/docs/assets/hierarchy.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
window.hierarchyData = "
|
|
1
|
+
window.hierarchyData = "eJytWltP4zgU/i959rBxfA1vA8PMItGhouzsSiO0Mq1pPeTCJikLGvHfV06m1E7T5hj2BSQ4X77vXGwfX35GVVk2dXT8HSeSIBwLhmSKMBcpwiIlSAhCEJcSYcETREjMEROMISZSiniSckQkIYiQlCMsiEAsQQLHSAjBkeAJQ1RwjJjkCWIpJjcoqvRdpueNKYs6Ov4ZMWx/FirX0XF0omo9zdZLU0QoujfFIjqmKFpXWXQc5eVinen6t4f2//XR1vZo1eRZhKJ5puo6Oo6aevHBgj/Yr9YPaq6jFxSxxCGaNarRrxwJ4xsWUzS6ulPzYaIWtpfuFRuhaF2Yf9b6q8r1VFW6aGPM8A2K5iuTLSpdRMffOeMx4gJTxFOZIoFJjASJk5sXFMnUUXtaFk1VZpmuXiXjRG4ktzqG9W6Be0V3f+jpkhRxQTjiKSFIxDahmAskCGNWHOZuLL9cXH++KNXisLpl1tx9yFqzoy1iRJZNW8wcrq+6+bes7mfr23pemVt9iPHOPOqjPmCckHsV+fGHerp86Kr1cLm0dI45oEwsm5S77gUQ+ghQaXqZxjafAsfu2AAHFxpVj5PFDGEZJ4hQIZBMcFvvdupxJ4JyXSxMsfxWZut8bKC2WnxEaCAwpgRhbOe+hMhWEKbEE/T0Fk1PwbJaam/0X+mlKYtw9iEcUEBC3KqcPax0pcMFDOGgAiTpLQtnj7poQEHfGAfXACEEYcIShAnHCBMR2x8CYSIFwjTmCFNsfyQEYUowwpTGCFNm/8u7mTHxUvdF1826gmt37YGRIsSN1Ln9X63nDZjSR0BJqbsATMqFPl2pYgl3tAeB0rI+bXZtsjDWLQJKynGfNIwwiEzEfbLZXBeBLm4hYFqxuwpd6bpcV3M49xAOKkC6Ai5vf4SUsGMOpUupQzdVRQkmezUGUtGY96iu9VPQpNDHQIkx9xaRYqErMKdjDqVLSL+/BrNtrYPn7MQu2YTaOTul7QxMiTte/yyr+xosZGsN9Zq64/Wvq9AJ30dASZnwSGe6rk1ZBJC6CCgpZx7pdmsRwNsDAan9LcCmn5joejXaobrG460/Zlj2BuupqeaZBnH55hA23p+FtvBZmZlFIGWLAfDyON3Le7qumzIPJO5AEGYeDzUrXnghvcrBAPvFw4Xr7Hmuljpge+XaB89NPO22Njx125ZfU3mACB8B9FsQd5KYljWoZbd2wX4KSlo/Bd1ZAsCzP9Qr7+TBr8JzRx5oUR2ABvvOsER2QCE7mrsopIMNebDCYWR4EfK4lSVjN3KfzeP49t4ajQ9qkmDW71m383w3NZwXpvlYLUHVfvADsDIhibcpsrmuVK7eo2rsG0BhZKcbtB+9MPf6/xB36DuhhWPTimwgb1rdqaf7ZAJbETu7kNMhu9i3jNTbkkxPJn88LFSj1W02XriedQg7YZwhwmXnNPNanunJxMb5s8mawyedGwlba8Ag4t6Bx/Rk0mVvtho7V92wufYAPkl6fBPV6MqoDFRvW/PgspJMIpLKtI2wZHK3rHaUjJTXqJSt16l3OmNzVJqiOc3K9SKEdRc1zm3vQdwuwGSafBol68xCSpimgtvY2t8O3zej/71Qz04tHcjvqzFsVmOc+rNapXLd6OqbytbAxdhFhJYUE3G7xNnf3o63LrNHvQiXM4wExkIwNhSLTaGEx8RDBseGU97Fpnfi8evjtr5q3YSrcoFvFiW9bs5uvk/Xt7rtuaG79VdAsAgpYsRSJjol3rmb/XCQCqgCS5Vi0qO6vK119Qgbmq598G0Plu2GxHrdk2DTCaW3tsDLLSz7Cd6MrR2f982AQyDAJV4i+u3utJsqx1teaxh0XUpwgjjpatreiXsDrQZ2cAc496UzEW06Lb97Y7lQD4151Bfr3BSqmMMcH0QB4ky8qf/sWX8qc31hlqvGFEsQ8wAGcknrHTeeNzqfqPq+u/a+fn7YFvPe9wO7GNg7Antr/8aXBAOU73tRYMPQlgCTdCAcA+8GYAIB7wb8gS68I7rLyuiiUfa4IiQjgzBgUgSmb0zKMOs78yK6XYx9RHEoLsEJOvAFYKZS4t+szu+XlT0kfaOg/R+A6vHO535lQOcPmWo0rGx2McCa8XcDITUzQPnOgklFuyOyb23cXUKl7NVWWT0HJ2YICkuJwEnsLWFF+bEwuQ4ZygMgWFLsI6i3JmWA831ZsZHo3sdwMRSR4KQMIIE5Sai7e/z0XKjczKeqWV2YIigze6HA/JD4re/o9jO/M0sJ7V4xEW/rNUgXnLGRrwCzxxNX2fXvV2dn4a/merCgUzXedorCvwyxDn3RZa6b6vmQiMwU+sg1Hu/P7LvRHtNML3ObsSDGPijEaett67XgpB/9v+3Hk1EJji3EZ+/EZYvdOBHC94oJ8ljwth20j+p6u5/z4kf36NYOuLEtSaXVvDnahUGq/eXlP4QFs5E="
|
|
@@ -1 +1 @@
|
|
|
1
|
-
window.navigationData = "
|
|
1
|
+
window.navigationData = "eJy1nVlzI7cRx7+L8mo69spZb/wmUccqFlcMKe9uKuVSgRyQhDUcjOfgSk7lu6cwJ45Gd3PNvBL//jUGA2DQuPjv/5xV8qU6++lscX1xNbs+++YsF9Xu7KezRK/rvcyq8q9tyre7ap+efXP2rLLk7Kd35+/evf3u3X+/GeyFmiR6PdnWKpGpymQJoQIRSc0VyMkVZblNdVmK4hUy79MohsqqQkOAJoGy/r1W6+dJWYmighhWMkUq6zzXMKVLogiV3OepqCSE6NMoxkaKqi6aF7veqTQpZHb207+H5POkUinooDd8aiWUn7XYy0JMRKb2olI6Q5G+mISnKs9lgTNbDYnSukhUJio5KV/LSu5xqK+m8PIgM/CVD8hGQb41dcBfihGQkFR/Udl2kqrtrpq8SSa5KMEGPlIhi+PcnB/t5pznZivqslQim6zSuqB9hHLSgSyNKU5tNTSqmpTrQspskqsXmRJZ9dVkD7cXWznRuWk6ONpRUthUi2QiXypZZCKd7HUiUxQO6Fku8kJvC0m8P0dJYfeikoUSeHZ7EQnTCV4JjIADIbLDKa+9PshJLjI9kZuNXOM9iy8m4XVaqckXXTzj2EFGARvfG5VWRFdt6VhI8hM1qFi4+kDD6gONKsRe0o/aqUhcWm8V/tVsJSRIl1Ve6LUsS5VtcaAjpcCFeF2LEq+CnYZEyd9rWVamfb+AY70RaCvJEVfXiRb6N6qtuFISXEVGYSOvYozFDkp+maTilagzo4wCkm033mp/dV5HKkUpnzJdRQeKb799C3lyTJ/efvuWyvLbb3/kcH6kOe84nHf007tjrb1O6lSWfw0HWG/ggvmo03ov56nI5F1WyaJ0qp7M6n0Hg4Re7qxcXSQir9RB3td7lYlsLefOiGedirLsswlqXfT3bxx4P/C+Mb3TvdZ5jBwIMeylrrNEZduZLHcRoC3BUNMmQohA2kTM/Lr5AE71Ptel3docjCtCca/ySu/lvRmvqmyLvApAiYFvZLXeRTPYpaIAp/K61kENDk2RJ+mTKcRCZoks4s9gSVBUnabLplP+Zy2SGMwRYbj3qqz0thD7CGlIxyBNM81E+kmubu+J5wS1GHzmjhAd2CwcGwLGy7XMYi9/FOAYN1T3EGFo7pp/kJX5wCzrVbku1CqWF1+GIeci01NVrFOJdCKuiI+b1mWlYzUCkvLRS52qWK0FlDg4GFh6OHBI6UEuZ1OdVUJlcY4lCVDftFrzbZV5IdeiksmZx2+KaLkTCerCUhEZvi10HfsQ9clfk9Hb5cPKHRAG6E5BZBCrkm0qAzALYlUINAOD1QBoqtaNF3D5uFFDwbTKqmmq62hFtjVsGP3AoZaAL59VlskEfx+WiMD9kieikmKVxnowR4PBsC6Z7I2pfpTVgT7KFzP0v9dIs3Q0KExFi+QxiLZD0/MrxPj8ijKfivUOc9+kU5APzmxOwPgQzOWEiEUbgy7XO2lig2ipAlIKXcpYr9SlooBCmE5L28slLmMQ8DBYWTkiDPfJiUkdyKcgGg1NF7LU6UEmD6tSFodoYUNSDP15cVlXVXSs0yejQVOSmObvf0uUGfhtxHoMxiyZF0H+7a3N+028PPhzuAFtFKEsJ05DcI6OTzQDBfM7E9zJMf6lKOW1u1jiMwcJyukCyja6RmCODie+8KEvfG4btc51iQBHDUqq05SRO0eG8a4KsdZxTpOM2TcvaSrSdCXWz3GOI8N4Jma8y1R1UWyRpmGrKJr51JFtzROizFTrIk9FZmp6odNUFu1Al5FtyhTze9uuPxENx1ZhtDuzOkQWi60iab8s7mciz1WGFYGv5FB52RyFKLOffiPK0dWxiE44HeUFcXWE5g5wo7hwiIvw7noKEzzoMQ8/P35+E+eZVMz6XutSmjDFHTv4GEdG8hgsNsc0TSeCieI6JYvqzQBFmcBsUIQYDpqiUHjQFOGaQi/EXjC4vZTF/agSiXx4XB2L+ElVu+uXqlBZqdZIbxExwHzMRG5WZo7v8QlD1KdO5HQnsi3V5XtCipl+xVNgZqQ/RvZTXs7JD4GtImlNUM7J3CgkmSZ04yAHHU40D/KzfN3gI3tXhxMPTS/KKEhHiDG7Kd6LlS6q66LQSA8USBncG1WsVJLIjMd25Qw+WRSujkGcm/VqXm5HKYNrYt66WFP1C1Lz6LnOSsnLuKNm0B/VXuqaWT9sMcZu42yiOCwRxoKWAMiqgRjxfTEGZREDvo8jn+ToZ2gWNo50YttQnoh3PEgojhmdHP/5oyw5Xu/Vs/x6z5g15b2b8WUUoa3Eqd0qVD9l/1GkNVp9IT3LQzcVynVgy1l8LphBLNH36C+me9aXs2m7hxlYAQxgoZhiWwtxjEoHGxzhY5nqiu+gURP0cCEJgMIrSCHLWmMbShDPLmxC+DFN6krmFRLG2yoGrV3Ko+psoGWQ52rtboCOUDsdRQwW9ZjljBkSPhdyozKZtFtEUCeOEqWi87XUTO1CbpXOuNPJkBqnm20mRKduiXBWu5jC7RVhPephuxJXokImEXoFRlnmO1lIbolCapyeigrP5CBBOe6G0YAR7hYF7IkXO2owUvc9J8dlrg4lNou3NNCWUbzpcM5m6R3KgbC+mqK/l+5iOMRsNRSplBUHNsgYPFZBjjqUqL9yhoowRH0OC8NkwXhKjPpRyS/37kZpHzdIKI57CA/ChGfxPMri6+MG2hbz/EmuPi8uXmTZdLOIG09IMsfMsMi+HOXr4nlar2SzIINwbRnFY7B4HGoinzmHb8n+UWJLPp6QYtIwDoVYWGCtKQwiOkuDjMUjmrWr4xOZ2Ry0FJleSuGuotg6Ope2kqL2PQtNtZVcasnHlhxuSYxnRg1FcrelQZxwd1pIIRafWOtOds9IPF4gxbm8lX5XhxO//htG2+Kel+aAmc7IZ7F11M6pfvL58TW36kL1mts7p2yRB/zu7z9+/7c3CLTbnMBid1rSRXCaJp57UEo5cAMdt/1a8FBGg1/YbEBJ4aFqZZ63BF1E1Xw3TRXjeBiFJLxeyRtnBt8GdokU5FqYk5g3debtJLFQroQE4g/Kf7zmOJB3RtUCjcl8kHlvBMxIjgGWlTn+RkJbGQXuutZ46dkCCnYvt2L9OpQ3yPM0JFKLZCHLOkWIjoQCzpz9vxZmFuz5hY1TuJzaJBpgKnS7NhTBjAImTGcbBXfhtoAHM3UxWOYIiJaKh6WATFS7VH/t3RLg0GwJBexWYb21WgtnC46BhdtEI9DIRlEI3ozupT1p5zL7dGY+592tE5ys+lqmi37wgKF7DRPpTTmGPGjSMQqr12tmCXhSpoNoj2WlUyhTm0GGSeAY3yVR87uEBhRlOK3qYEYBCbucXaT5TkR7YFvAgE11qotl9RrpSR0FA9fsWUZxo4KBa1b+m2W/aDUIVAxss3B0GauutoALa1ah6JxCWq6L5U4Q4EbBxqk/CJr6gwN7LERWqugg1FGQOF1W8+GakXhBBjIKDK2XRQOTmJh20hzpcgMyN152vETUlJvlWpVl5FvbpYEI6vwrtAIWLaOYmMx8fzKxGbvORA7TfRWFHQ75Yd2sL2JBzfmkzFvo85mjhoPsXvxD4ayBeExbdAR0OE5IlUNEz3FVyqqpq/FhRKAiscOCD1nekJLCewsTP8tXkB3KjgRHOyxAR6LNHCcMMymU+XpwVl7JjajTKpy8O4hCmQOIHTdu4jo7t/0k7oEwD5mE58Ec6+fq5U3U2CQitvPFw+d/PU0fPjwuHu7vrxdP1x+vPzw+fbiYXS+jTMwI8TVe7lg+6o9N/RtdbLoJlqEYA61LfvuDTS6kqOSVXNVb+E4cnw7rSQ9edQKpQMVySElXK7rjU81nfaOLfRQbM0B8bGXVr7Mu18IeRXpsX4gwd1KYcnrU9zrbqqpO4tRQ6nOpr2hzj+LSv9DVc2OLkIyrMrZ7xeeV2MYVj+nHMwELimochrlx8aI6jzN6AcG4PE/ilacXEAxzhxLKMAIG4w8S8gdBuVm9oIyb1QtBuE2rDYowAoIxX+FFOl9RJTpPX3FC+koRsire1/QCgtFsnkIhjYKk4O91mVNv9fN5jhI+n+cooetGHvX7tmtBYL702K5nL56j2908Z6EUeQhzzeX177W9GcLDDQqC0kx0oJRGQVCW5gzeVm3i1dRRobTCP/4ZkAro9KdDOTQf+Uc9bjaL135Ai5Cb+S3tBmEecJQgHPgCpuACw7+sG13Z61rSD9///Yfz72K46a7O7JEFDl33ag46HLHicGUm1Ft9DN+sLzjnClB6c/NufxvwoZfH4M2m53DjcojNV/vcFsaA7cZIb49OiDPX2Z4n/T3CDFh7nU8QIqLktLEZb5J23di3ZG7TajNJNVzXrEQvhIHvzLy6WsYuKLJRg8yFuteyXC0upg8s2ijEeLf3jzcc3KijaLHbx3wafQeZUTV9KSNvrQ6jPb5fXF9zH9cTo2/kygrVrF0e3qvFdngYRyTDiCjIQm5kIbPIwTqfNqgx7FASJHJQhji7aZn/1AjblPmV1ZjuFXTlWGN+HzDcN2XSb6Xeywq6Q2pA9BIKFb/pbUBxLngzuqXcNhf6MnLnS8kq/2Ss3kSIloIH6t3TwEHJLUfou9NOGQXlGT0i080h2fWtvUcc+ER0CaxaZ5ZRtoUZbLabKtxZMp8IqV03P8BuPokiU9l2qhNvp1d7sTLK92xdf85lw942Aas5ow7A3QPhzUjOfDiXHZkjD08wwvv2UDa9h7sVm1nYu9hpDNyDY495miloiwEKb02+ZjMLjuUsrQ7PdRR6NCNXUqDpd5SNTMXbjd5cpubv3wpbaQlu4oq0zXHqO+z6AOQox/o/Y4AdiQHAlglW01it3M4t0bbjZ7wAHO/EV3uDC6tZu2Tb8Lj+yK9hAxdfpLOr1tVrJvZqPRfVznySON+DqAm34lFvMu7gRJ123MGJeu64A0b3LardnyqkEfDnWkDcA9kg6K4WyT6/v20OW3ydl9GWbiPmMzgT5TOncYTaU7UKgHyi5gCQOe3AmLmFwWP3dujIQpTPX8Pu7f5k+wXIdMOlWxSAPUFTgjJ7wjYEZfqIxvNQKJlVzX4aTvsB5adqQjD8RK0Ihp/ogwLDT1EnYfIJqmUkyyesmZGsH1E5zbqq2e7FGvcA4lNVTAhNV8tWQV0xSPtg3j3IagWQlxO1AQh9ihYAcU9Q/8HsnrD2g9k+pu63Zt1f0RJVP9CerOaH5BP1xwD5VBUxJJ+kHobYU1RDILOnrIVApo+ohNPl8vwq/u9MvRdHhs1APBQrVXWTFcCfY41fDkuG8RZmwkYml/olPpndQ0MtPlfizgdBEzKMGbvYxIxbTcA4iOmRsKUiBDN0ZHoK5RgcvVa1R3LuVA2GEczsInZ4B9P120w3gB7vEcSryrac7mYUoktmzv5eRoYhA8yBX6WhjRWx6o/ssADrLcYGDRAHbmCEkV0lggyqFEYNxAjYGyxgWE+KQMcXTVN9bYB1/9NU2Gvu/Wik+Zm1wLWsdAGsq7aAJhHrms1p44sm/wtj0J+OgwcFLTNmgtV7YzMV2UGU80LnFN1SUtC77Lf2fwq8088g1xWjPUvRXmTwsDF2N93f1CJ42ICd+7Y8OzN//AE8gKOnRjaOpRmr8P1Y6qO88D0cQZ8X+qASWfRlHaw2j/hAegwfOkgRojnHKJrm176rmcjfiywFTt1YLdWXHseP5zvUsch0gQQyFrfZ+kZn2JZx3l/bbYzA8fSF37W4NOewxd2Hf1xPH+8ePjzNFw9zczQjDgy1CLgupcmA9897PtJW+TBqB257jsLqf6CPVOsmkCKfvlHbv2gOt9eSYO/7BROB75iDqrNSbOTTU1d84QUbPjZi4Lugirwzv/CuQQm82TLsMVpd++9aV6rw/6gnwvX0XAcL8boWZYW9T1jPcFAXhcyq8HKymANXz3bgDf1xOjD8h9CRfwmLsJE/C4PgzflzEtqoaNh7meaMwm1lNK7ZnTv8pxK/dkTsmA4XUiSvvPfo6WkH80KbYcYb8KyQgx6UNLT9hxXvApMI1tIywKxCYD567FyBwyKOFnxR1c7943af0yvQEKes1PoZ2o7dJTDDHA/SBzo9ZAnBgP9J7/7XzPxLATie73m+GN8be9i8hM932Lywnu1CFZtUfwmfzQC6RDSIS525Idu6ScJs56Ko1Br6+1xj3qdyCLfzX3DI7fwXjLPMdXWvtjtgB7qhDMmcvETvCbTzQ/8hxZBvFq/TMZGPX6TE/y/JYzsGHCfHeTgab7IEDOD9XLMuyOmyQODiLKcp1sDqziG4mwpuiuMw7WMt8dkQg4TlVNhPfmi7R+8csL6veEg71ftcZ86yqesjEJLvLPy0jsTI1/TYsK3PHBm0wcFJCIKDEjdM8wOD3yLfecMExSePIRpPJ48gLOr/I34I8KeNHmz8qWOHkH2qyMEinypusJB/OmqwWEfFDAQLuMM7iuqPBXOQvfakkY3v5P8U1/huThbVWOBjYxoCB8xJHRXF2Ch+DAMeZrZQ8LUhv/731/8BX+NcKA=="
|