@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
|
@@ -0,0 +1,420 @@
|
|
|
1
|
+
# Flowing Light 3D Pass (流光 3D 通道)
|
|
2
|
+
|
|
3
|
+
- **Summary**: `FlowingLight3DPass` 基于 3D 世界坐标绘制流光效果,使用 InstancedMesh 实例化渲染优化性能,自动投影到屏幕空间,适合沿模型表面、路径或空间轨迹演示动态流动光带。
|
|
4
|
+
- **Schema**: `FlowingLight3DPass` 类及 Line 数据结构。
|
|
5
|
+
- **Concepts**: 基于相机投影的 3D 光带、InstancedMesh 实例化渲染、世界坐标到屏幕坐标映射、头尾追逐动画。
|
|
6
|
+
- **Configuration**: 3D 路径点、颜色、不透明度、线宽、动画周期、延迟。
|
|
7
|
+
- **Examples**: 空间轨迹演示、结合相机动画、多条 3D 路径、高 DPR 场景优化。
|
|
8
|
+
|
|
9
|
+
## Schema
|
|
10
|
+
|
|
11
|
+
> **Definition**: [FlowingLight3DPass](../../five/renderer/postprocessing/passes/flowing-light-3d-pass.d.ts)
|
|
12
|
+
|
|
13
|
+
`FlowingLight3DPass` 继承自 `FivePass`,支持投影到当前相机视锥。核心接口如下:
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import * as THREE from 'three';
|
|
17
|
+
import { FivePass } from './pass';
|
|
18
|
+
import { type Camera } from '../../../core/camera';
|
|
19
|
+
|
|
20
|
+
type Line = {
|
|
21
|
+
id?: string; // 可选的唯一标识符,不传则自动生成 UUID
|
|
22
|
+
points: THREE.Vector3[]; // 世界坐标系路径点
|
|
23
|
+
totalLength: number; // 路径总长度(世界单位)
|
|
24
|
+
color: THREE.Color; // 光带颜色
|
|
25
|
+
opacity?: number; // 光带不透明度(0-1)
|
|
26
|
+
duration?: number; // 动画周期(毫秒)
|
|
27
|
+
delay?: number; // 动画延迟(毫秒)
|
|
28
|
+
lineWidth?: number; // 线宽(像素)
|
|
29
|
+
tailLengthRatio?: number; // 尾巴长度比例(0-1),默认 0.2
|
|
30
|
+
};
|
|
31
|
+
|
|
32
|
+
export class FlowingLight3DPass extends FivePass {
|
|
33
|
+
constructor(camera: Camera);
|
|
34
|
+
|
|
35
|
+
// 设置要渲染的路径列表
|
|
36
|
+
public setLines(lines: Line[]): void;
|
|
37
|
+
|
|
38
|
+
// 修改单条线的参数(通过 id)
|
|
39
|
+
public setLine(params: { id: string } & Partial<Omit<Line, 'id'>>): void;
|
|
40
|
+
|
|
41
|
+
public render(
|
|
42
|
+
renderer: THREE.WebGLRenderer,
|
|
43
|
+
writeBuffer: THREE.WebGLRenderTarget,
|
|
44
|
+
readBuffer: THREE.WebGLRenderTarget,
|
|
45
|
+
deltaTime: number,
|
|
46
|
+
maskActive?: boolean,
|
|
47
|
+
): void;
|
|
48
|
+
|
|
49
|
+
public dispose(): void;
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
## Concepts
|
|
53
|
+
|
|
54
|
+
### InstancedMesh 实例化渲染 (Instanced Rendering)
|
|
55
|
+
为了优化高 DPR(Device Pixel Ratio)场景下的性能,该 Pass 使用 InstancedMesh 代替全屏着色器。每个线段作为一个实例,只渲染线段覆盖的区域,避免了对每个像素的全屏检查,显著提升了渲染效率。
|
|
56
|
+
|
|
57
|
+
### 世界空间路径与投影 (World-space Projection)
|
|
58
|
+
路径点定义在 3D 世界坐标系中。Pass 内部自动根据当前相机投影矩阵将 3D 点映射到屏幕空间,从而实现"随相机变化"的动态光带效果。
|
|
59
|
+
|
|
60
|
+
### 头尾追逐动画 (Head-Tail Chase Animation)
|
|
61
|
+
流光效果采用"头尾追逐"模式:
|
|
62
|
+
- **头部(Head)**: 光流的前端,沿路径循环移动
|
|
63
|
+
- **尾部(Tail)**: 光流的后端,跟随头部移动
|
|
64
|
+
- **渐变**: 从尾部(透明度 0)到头部(透明度 1)线性渐变
|
|
65
|
+
- **尾长**: 尾部长度由 `tailLengthRatio` 参数控制(默认 0.2,即路径总长的 20%)
|
|
66
|
+
|
|
67
|
+
光头在路径上循环流动,通过 `gl_FragCoord` 投影到线段上计算每个像素的渐变位置,确保渐变效果准确。尾巴长度会在动画开始时逐渐增长,直到达到 `tailLengthRatio * totalLength`。
|
|
68
|
+
|
|
69
|
+
### 相机同步
|
|
70
|
+
Pass 自动同步相机的投影矩阵和视图矩阵,无需手动管理。支持相机运动时光带跟随。
|
|
71
|
+
|
|
72
|
+
### DPR 处理
|
|
73
|
+
自动处理高 DPR 场景,渲染目标尺寸根据 `readBuffer` 自动调整,确保在 Retina 等高分辨率屏幕上位置准确且性能优化。
|
|
74
|
+
|
|
75
|
+
## Configuration
|
|
76
|
+
|
|
77
|
+
### Line 配置参数
|
|
78
|
+
|
|
79
|
+
| Parameter | Type | Required | Default | Description |
|
|
80
|
+
| :--- | :--- | :--- | :--- | :--- |
|
|
81
|
+
| `id` | `string` | | 自动生成 UUID | 唯一标识符,用于 `setLine` 方法更新单条线。 |
|
|
82
|
+
| `points` | `THREE.Vector3[]` | ✓ | - | 世界坐标系路径点数组。至少 2 个点。 |
|
|
83
|
+
| `totalLength` | `number` | ✓ | - | 路径总长度(世界单位)。通常为所有相邻点间距离之和。 |
|
|
84
|
+
| `color` | `THREE.Color` | ✓ | - | 光带颜色(RGB)。 |
|
|
85
|
+
| `opacity` | `number` | | `1.0` | 光带不透明度(0-1)。控制与背景的混合强度。 |
|
|
86
|
+
| `duration` | `number` | | `1000` | 动画周期(毫秒)。光头完成一个循环所需时长。 |
|
|
87
|
+
| `delay` | `number` | | `0` | 动画延迟(毫秒)。延迟后才开始播放动画。 |
|
|
88
|
+
| `lineWidth` | `number` | | `3.0` | 线宽(像素)。控制光带在屏幕上的宽度。 |
|
|
89
|
+
| `tailLengthRatio` | `number` | | `0.2` | 尾巴长度比例(0-1)。控制流光尾巴相对于路径总长的比例。 |
|
|
90
|
+
|
|
91
|
+
> **注意**: `totalLength` 应为世界坐标单位。若不准确,流速会偏差。
|
|
92
|
+
|
|
93
|
+
## Instance Methods
|
|
94
|
+
|
|
95
|
+
### `constructor(camera: Camera)`
|
|
96
|
+
初始化 Pass,需传入相机以获取投影矩阵和视图矩阵。
|
|
97
|
+
|
|
98
|
+
### `setLines(lines: Line[])`
|
|
99
|
+
更新要渲染的路径列表。支持运行时动态更改。
|
|
100
|
+
|
|
101
|
+
**自动生成 ID**: 如果 line 没有提供 `id`,会自动生成 UUID。
|
|
102
|
+
|
|
103
|
+
**示例**:
|
|
104
|
+
```ts
|
|
105
|
+
const pathLine: Line = {
|
|
106
|
+
id: 'my-3d-line', // 可选,不传则自动生成
|
|
107
|
+
points: [
|
|
108
|
+
new THREE.Vector3(0, 0, 0),
|
|
109
|
+
new THREE.Vector3(5, 2, 3),
|
|
110
|
+
new THREE.Vector3(10, 1, 6),
|
|
111
|
+
],
|
|
112
|
+
totalLength: 12, // 世界坐标单位
|
|
113
|
+
color: new THREE.Color(0xff6600),
|
|
114
|
+
opacity: 0.85,
|
|
115
|
+
duration: 3000,
|
|
116
|
+
delay: 500,
|
|
117
|
+
lineWidth: 4.0,
|
|
118
|
+
};
|
|
119
|
+
pass.setLines([pathLine]);
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### `setLine(params: { id: string } & Partial<Omit<Line, 'id'>>)`
|
|
123
|
+
通过 `id` 修改单条线的参数。支持部分更新,只更新传入的字段。
|
|
124
|
+
|
|
125
|
+
**性能优化**:
|
|
126
|
+
- 如果 `points` 数量不变,只更新 GPU 的 instance attributes,性能极高
|
|
127
|
+
- 如果 `points` 数量改变,会重建整个 mesh,性能开销较大
|
|
128
|
+
|
|
129
|
+
**示例**:
|
|
130
|
+
```ts
|
|
131
|
+
// 只修改颜色 - 高性能
|
|
132
|
+
pass.setLine({
|
|
133
|
+
id: 'my-3d-line',
|
|
134
|
+
color: new THREE.Color(0xff0000),
|
|
135
|
+
});
|
|
136
|
+
|
|
137
|
+
// 修改多个属性 - 高性能
|
|
138
|
+
pass.setLine({
|
|
139
|
+
id: 'my-3d-line',
|
|
140
|
+
color: new THREE.Color(0x00ff00),
|
|
141
|
+
opacity: 0.5,
|
|
142
|
+
duration: 3000,
|
|
143
|
+
lineWidth: 5.0,
|
|
144
|
+
});
|
|
145
|
+
|
|
146
|
+
// 修改 points (相同数量) - 高性能
|
|
147
|
+
pass.setLine({
|
|
148
|
+
id: 'my-3d-line',
|
|
149
|
+
points: [
|
|
150
|
+
new THREE.Vector3(0, 0, 0),
|
|
151
|
+
new THREE.Vector3(6, 3, 4),
|
|
152
|
+
new THREE.Vector3(12, 2, 8),
|
|
153
|
+
], // 仍是 3 个点
|
|
154
|
+
totalLength: 15,
|
|
155
|
+
});
|
|
156
|
+
|
|
157
|
+
// 修改 points (不同数量) - 会重建 mesh
|
|
158
|
+
pass.setLine({
|
|
159
|
+
id: 'my-3d-line',
|
|
160
|
+
points: [
|
|
161
|
+
new THREE.Vector3(0, 0, 0),
|
|
162
|
+
new THREE.Vector3(10, 5, 5),
|
|
163
|
+
], // 从 3 个点变为 2 个点
|
|
164
|
+
totalLength: 12,
|
|
165
|
+
});
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
**注意事项**:
|
|
169
|
+
- 如果 `id` 不存在,会在控制台输出警告
|
|
170
|
+
- 动画时间(`uTime`)不会被重置,流光继续从当前位置播放
|
|
171
|
+
- 建议修改 `points` 时同时更新 `totalLength`
|
|
172
|
+
|
|
173
|
+
### `render(...)`
|
|
174
|
+
由 EffectComposer 自动调用,无需手动调用。自动同步相机矩阵和渲染目标尺寸。
|
|
175
|
+
|
|
176
|
+
### `dispose()`
|
|
177
|
+
释放 InstancedMesh、着色材质和渲染目标资源,销毁 Pass 时必须调用。
|
|
178
|
+
|
|
179
|
+
## Examples
|
|
180
|
+
|
|
181
|
+
### 快速上手 (Quick Example)
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
import { Five } from '@realsee/five';
|
|
185
|
+
import { FlowingLight3DPass } from '../../lib/five/renderer/postprocessing';
|
|
186
|
+
import * as THREE from 'three';
|
|
187
|
+
|
|
188
|
+
const five = new Five();
|
|
189
|
+
|
|
190
|
+
// 创建 3D 流光通道
|
|
191
|
+
const flowing3D = new FlowingLight3DPass(five.camera);
|
|
192
|
+
|
|
193
|
+
// 定义一条 3D 路径(世界坐标)
|
|
194
|
+
const path = [
|
|
195
|
+
new THREE.Vector3(-5, 0, 0),
|
|
196
|
+
new THREE.Vector3(-2, 3, 2),
|
|
197
|
+
new THREE.Vector3(2, 3, -2),
|
|
198
|
+
new THREE.Vector3(5, 0, 0),
|
|
199
|
+
];
|
|
200
|
+
const totalLen = 15; // 世界单位
|
|
201
|
+
|
|
202
|
+
flowing3D.setLines([{
|
|
203
|
+
points: path,
|
|
204
|
+
totalLength: totalLen,
|
|
205
|
+
color: new THREE.Color(0x00ff88),
|
|
206
|
+
opacity: 0.8,
|
|
207
|
+
duration: 4000,
|
|
208
|
+
lineWidth: 3.0,
|
|
209
|
+
}]);
|
|
210
|
+
|
|
211
|
+
five.addPass(flowing3D);
|
|
212
|
+
|
|
213
|
+
function animate() {
|
|
214
|
+
requestAnimationFrame(animate);
|
|
215
|
+
five.render();
|
|
216
|
+
}
|
|
217
|
+
animate();
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
### 多条 3D 路径
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
const pass = new FlowingLight3DPass(camera);
|
|
224
|
+
|
|
225
|
+
const paths = [
|
|
226
|
+
{
|
|
227
|
+
points: [
|
|
228
|
+
new THREE.Vector3(0, 0, 0),
|
|
229
|
+
new THREE.Vector3(10, 5, 0),
|
|
230
|
+
],
|
|
231
|
+
totalLength: 11,
|
|
232
|
+
color: new THREE.Color(0xff0000),
|
|
233
|
+
duration: 2000,
|
|
234
|
+
lineWidth: 3.0,
|
|
235
|
+
},
|
|
236
|
+
{
|
|
237
|
+
points: [
|
|
238
|
+
new THREE.Vector3(0, 0, 0),
|
|
239
|
+
new THREE.Vector3(0, 10, 5),
|
|
240
|
+
],
|
|
241
|
+
totalLength: 12,
|
|
242
|
+
color: new THREE.Color(0x00ff00),
|
|
243
|
+
duration: 2500,
|
|
244
|
+
delay: 500,
|
|
245
|
+
lineWidth: 4.0,
|
|
246
|
+
},
|
|
247
|
+
{
|
|
248
|
+
points: [
|
|
249
|
+
new THREE.Vector3(0, 0, 0),
|
|
250
|
+
new THREE.Vector3(5, 0, 10),
|
|
251
|
+
],
|
|
252
|
+
totalLength: 11,
|
|
253
|
+
color: new THREE.Color(0x0000ff),
|
|
254
|
+
duration: 2200,
|
|
255
|
+
delay: 1000,
|
|
256
|
+
lineWidth: 2.5,
|
|
257
|
+
},
|
|
258
|
+
];
|
|
259
|
+
|
|
260
|
+
pass.setLines(paths);
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
### 计算 3D 路径长度
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
function calculatePath3DLength(points: THREE.Vector3[]): number {
|
|
267
|
+
let length = 0;
|
|
268
|
+
for (let i = 1; i < points.length; i++) {
|
|
269
|
+
length += points[i].distanceTo(points[i - 1]);
|
|
270
|
+
}
|
|
271
|
+
return length;
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
const points = [
|
|
275
|
+
new THREE.Vector3(0, 0, 0),
|
|
276
|
+
new THREE.Vector3(5, 2, 3),
|
|
277
|
+
new THREE.Vector3(10, 1, 6),
|
|
278
|
+
];
|
|
279
|
+
|
|
280
|
+
const pathLine = {
|
|
281
|
+
points: points,
|
|
282
|
+
totalLength: calculatePath3DLength(points),
|
|
283
|
+
color: new THREE.Color(0x00ccff),
|
|
284
|
+
duration: 3000,
|
|
285
|
+
lineWidth: 3.0,
|
|
286
|
+
};
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
### 结合相机动画
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
// 光带路径随相机移动自动投影
|
|
293
|
+
const pass = new FlowingLight3DPass(camera);
|
|
294
|
+
|
|
295
|
+
pass.setLines([{
|
|
296
|
+
points: [
|
|
297
|
+
new THREE.Vector3(-10, 0, 0),
|
|
298
|
+
new THREE.Vector3(0, 5, 0),
|
|
299
|
+
new THREE.Vector3(10, 0, 0),
|
|
300
|
+
],
|
|
301
|
+
totalLength: 20,
|
|
302
|
+
color: new THREE.Color(0xffff00),
|
|
303
|
+
duration: 3000,
|
|
304
|
+
lineWidth: 4.0,
|
|
305
|
+
}]);
|
|
306
|
+
|
|
307
|
+
// 相机动画过程中光带自动跟随投影
|
|
308
|
+
five.setState({
|
|
309
|
+
mode: Five.Mode.Model,
|
|
310
|
+
// ... 其他参数
|
|
311
|
+
});
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
### 高 DPR 场景优化
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
// InstancedMesh 实现自动优化高 DPR 性能
|
|
318
|
+
// 在 DPR=2 的 Retina 屏幕上,性能显著优于全屏着色器方案
|
|
319
|
+
|
|
320
|
+
const pass = new FlowingLight3DPass(camera);
|
|
321
|
+
|
|
322
|
+
// 多条路径在高 DPR 下仍能保持流畅
|
|
323
|
+
const paths = Array.from({ length: 10 }, (_, i) => ({
|
|
324
|
+
points: [
|
|
325
|
+
new THREE.Vector3(i * 2, 0, 0),
|
|
326
|
+
new THREE.Vector3(i * 2, 5, 5),
|
|
327
|
+
],
|
|
328
|
+
totalLength: 7,
|
|
329
|
+
color: new THREE.Color(Math.random() * 0xffffff),
|
|
330
|
+
duration: 2000 + i * 100,
|
|
331
|
+
delay: i * 200,
|
|
332
|
+
lineWidth: 3.0,
|
|
333
|
+
}));
|
|
334
|
+
|
|
335
|
+
pass.setLines(paths);
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
## Debugging
|
|
339
|
+
|
|
340
|
+
- **光带不可见**: 检查路径点是否在相机视锥内;验证 `color` 和 `opacity` 非全透明。
|
|
341
|
+
- **光带抖动或消失**: 确认路径在相机背面时自动丢弃(3D 投影的预期行为)。
|
|
342
|
+
- **流速不对**: 检查 `totalLength` 计算是否为世界单位;调整 `duration` 以改变流速。
|
|
343
|
+
- **位置偏移**: 确认在高 DPR 场景下渲染目标尺寸正确,Pass 会自动同步 `readBuffer` 尺寸。
|
|
344
|
+
- **性能问题**: InstancedMesh 实现已优化,但过多路径点仍会影响性能。建议单条路径不超过 20 个点。
|
|
345
|
+
|
|
346
|
+
## Performance
|
|
347
|
+
|
|
348
|
+
### 与全屏着色器对比
|
|
349
|
+
- **全屏着色器**: 每帧检查所有像素,DPR=2 时像素数增加 4 倍,性能下降明显
|
|
350
|
+
- **InstancedMesh**: 仅渲染线段覆盖区域,DPR=2 时性能影响较小
|
|
351
|
+
- **实测**: 在 DPR=2 场景下,InstancedMesh 方案 FPS 提升约 3-5 倍
|
|
352
|
+
|
|
353
|
+
### setLine 性能优化
|
|
354
|
+
`setLine` 方法根据修改类型自动选择最优更新策略:
|
|
355
|
+
|
|
356
|
+
| 修改类型 | 性能 | 说明 |
|
|
357
|
+
|---------|------|------|
|
|
358
|
+
| 只修改颜色/透明度 | ⚡️ 极快 (~100x) | 只更新 instanceColor attribute |
|
|
359
|
+
| 只修改 duration/delay | ⚡️ 极快 (~100x) | 只更新 instanceMeta attribute |
|
|
360
|
+
| 只修改 lineWidth | ⚡️ 极快 (~100x) | 只更新 instanceData attribute |
|
|
361
|
+
| 修改 points (相同数量) | ⚡️ 快 (~50x) | 只更新 instanceStart/End attributes |
|
|
362
|
+
| 修改 points (不同数量) | ⚠️ 慢 | 重建整个 mesh |
|
|
363
|
+
|
|
364
|
+
**最佳实践**:
|
|
365
|
+
```ts
|
|
366
|
+
// ✅ 高性能 - 频繁修改颜色
|
|
367
|
+
requestAnimationFrame(() => {
|
|
368
|
+
pass.setLine({
|
|
369
|
+
id: lineId,
|
|
370
|
+
color: new THREE.Color(Math.random(), Math.random(), Math.random())
|
|
371
|
+
});
|
|
372
|
+
});
|
|
373
|
+
|
|
374
|
+
// ✅ 高性能 - 动画路径(保持点数)
|
|
375
|
+
function animatePath(t: number) {
|
|
376
|
+
pass.setLine({
|
|
377
|
+
id: lineId,
|
|
378
|
+
points: [
|
|
379
|
+
new THREE.Vector3(0, 0, 0),
|
|
380
|
+
new THREE.Vector3(5 + Math.sin(t) * 2, 2, 3),
|
|
381
|
+
new THREE.Vector3(10, 0, 0),
|
|
382
|
+
] // 始终 3 个点
|
|
383
|
+
});
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
// ⚠️ 低性能 - 避免频繁改变点数
|
|
387
|
+
setInterval(() => {
|
|
388
|
+
const pointCount = Math.floor(Math.random() * 5) + 2;
|
|
389
|
+
pass.setLine({
|
|
390
|
+
id: lineId,
|
|
391
|
+
points: generateRandomPoints(pointCount) // 点数不固定
|
|
392
|
+
});
|
|
393
|
+
}, 100);
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
### 优化建议
|
|
397
|
+
1. 减少路径点数量,使用更简化的路径
|
|
398
|
+
2. 降低 `lineWidth`,减少渲染区域
|
|
399
|
+
3. 控制同时渲染的路径数量
|
|
400
|
+
4. 使用 `setLine` 而非 `setLines` 来更新单条线
|
|
401
|
+
5. 保持 points 数量不变,只修改坐标
|
|
402
|
+
6. 在低端设备上可通过 `pass.enabled = false` 禁用
|
|
403
|
+
|
|
404
|
+
## Common Pitfalls
|
|
405
|
+
|
|
406
|
+
1. **totalLength 单位混淆**: 必须使用世界坐标单位,不能混用屏幕像素或其他单位。
|
|
407
|
+
2. **投影失败**: 确保相机矩阵有效,相机在构造时已初始化。
|
|
408
|
+
3. **路径在背面**: 相机背后的点自动投影到屏幕外,无需手动处理。
|
|
409
|
+
4. **未调用 dispose()**: 销毁 Pass 时必须调用 `dispose()`,避免 GPU 资源泄漏。
|
|
410
|
+
5. **DPR 不匹配**: 确保渲染目标尺寸与实际屏幕 DPR 匹配,Pass 会自动处理。
|
|
411
|
+
|
|
412
|
+
## Related
|
|
413
|
+
|
|
414
|
+
* [Postprocessing](./postprocessing.md): 后处理通用概念与 EffectComposer 使用指南。
|
|
415
|
+
* [Flowing Light 2D Pass](./flowing-light-2d-pass.md): 屏幕空间的流光效果。
|
|
416
|
+
|
|
417
|
+
---
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
tags: [postprocessing, effect, flowing, light, pass, rendering, worldspace, projection, instanced, performance]
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
# Gaussian Blur Pass (高斯模糊通道)
|
|
2
|
+
|
|
3
|
+
- **Summary**: GaussianBlurPass 是一个后处理通道,用于对渲染结果应用高斯模糊效果。
|
|
4
|
+
- **Schema**: GaussianBlurPass 类及其关键参数。
|
|
5
|
+
- **Concepts**: 后处理通道 (Pass)、高斯模糊、Shader、EffectComposer。
|
|
6
|
+
- **Configuration**: 模糊半径 (radius) 和标准差 (sigma) 参数。
|
|
7
|
+
- **Examples**: 基础使用、参数调整。
|
|
8
|
+
|
|
9
|
+
## Schema
|
|
10
|
+
|
|
11
|
+
> **Definition**: [GaussianBlurPass](../../five/renderer/postprocessing/passes/gaussian-blur-pass.d.ts)
|
|
12
|
+
|
|
13
|
+
`GaussianBlurPass` 是 `FivePass` 的子类,用于实现高斯模糊效果。其核心接口如下:
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import * as THREE from 'three';
|
|
17
|
+
import { FivePass } from './pass';
|
|
18
|
+
import { type Camera } from '../../../core/camera';
|
|
19
|
+
|
|
20
|
+
export class GaussianBlurPass extends FivePass {
|
|
21
|
+
// 构造函数,传入相机实例
|
|
22
|
+
constructor(camera: Camera);
|
|
23
|
+
|
|
24
|
+
// 设置模糊半径
|
|
25
|
+
public setRadius(radius: number): void;
|
|
26
|
+
|
|
27
|
+
// 渲染方法(由 EffectComposer 调用)
|
|
28
|
+
public render(
|
|
29
|
+
renderer: THREE.WebGLRenderer,
|
|
30
|
+
writeBuffer: THREE.WebGLRenderTarget,
|
|
31
|
+
readBuffer: THREE.WebGLRenderTarget,
|
|
32
|
+
deltaTime: number,
|
|
33
|
+
maskActive?: boolean,
|
|
34
|
+
): void;
|
|
35
|
+
|
|
36
|
+
// 释放资源
|
|
37
|
+
public dispose(): void;
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Shader Uniforms (内部 Shader 参数)
|
|
42
|
+
|
|
43
|
+
该通道使用 ShaderMaterial,包含以下 uniforms:
|
|
44
|
+
|
|
45
|
+
| Uniform | Type | Default | Description |
|
|
46
|
+
| :--- | :--- | :--- | :--- |
|
|
47
|
+
| `colorMap` | `THREE.Texture` | `null` | 输入纹理(来自 readBuffer) |
|
|
48
|
+
| `resolution` | `THREE.Vector2` | `相机分辨率` | 渲染目标的分辨率 |
|
|
49
|
+
| `radius` | `number` | `4.0` | 模糊采样半径(像素数) |
|
|
50
|
+
| `sigma` | `number` | `4.0` | 高斯核的标准差 |
|
|
51
|
+
|
|
52
|
+
## Concepts
|
|
53
|
+
|
|
54
|
+
### 后处理通道 (Post-Processing Pass)
|
|
55
|
+
GaussianBlurPass 是 Three.js EffectComposer 生态中的一个通道。它接收前一个通道的输出(readBuffer),进行高斯模糊处理后,输出到下一个通道或屏幕(writeBuffer 或 renderToScreen)。
|
|
56
|
+
|
|
57
|
+
### 高斯模糊原理
|
|
58
|
+
该通道采用离散高斯核进行模糊。在 fragment shader 中:
|
|
59
|
+
- 对采样范围内的像素(由 `radius` 定义)计算高斯权重
|
|
60
|
+
- 根据 `sigma` 值计算高斯分布的形状
|
|
61
|
+
- 对所有采样点的颜色值加权平均
|
|
62
|
+
|
|
63
|
+
### 相机依赖
|
|
64
|
+
构造函数需传入 `Camera` 实例,用于获取当前渲染分辨率。通过 `camera.resolution` 自动同步分辨率变化,确保模糊效果在窗口 resize 时保持正确。
|
|
65
|
+
|
|
66
|
+
## Configuration
|
|
67
|
+
|
|
68
|
+
### 常用参数
|
|
69
|
+
|
|
70
|
+
通过 `setRadius()` 方法调整模糊效果强度:
|
|
71
|
+
|
|
72
|
+
| Parameter | Type | Default | Range | Description |
|
|
73
|
+
| :--- | :--- | :--- | :--- | :--- |
|
|
74
|
+
| `radius` | `number` | `4.0` | `0 ~ 8` | 采样半径(像素),值越大模糊越明显 |
|
|
75
|
+
| `sigma` | `number` | `4.0` | `0.1 ~ 10` | 高斯核标准差,控制模糊的柔和度 |
|
|
76
|
+
|
|
77
|
+
> 注意:当前实现中 `sigma` 固定为 4.0,仅 `radius` 可动态调整。如需修改 `sigma`,需直接访问 `material.uniforms.sigma.value`。
|
|
78
|
+
|
|
79
|
+
## Instance Methods
|
|
80
|
+
|
|
81
|
+
### `constructor(camera: Camera)`
|
|
82
|
+
初始化高斯模糊通道,需传入相机实例以获取分辨率信息。
|
|
83
|
+
|
|
84
|
+
### `setRadius(radius: number)`
|
|
85
|
+
动态调整模糊半径。
|
|
86
|
+
- **参数**: `radius` - 采样半径,建议范围 1 ~ 8
|
|
87
|
+
- **默认值**: 4.0
|
|
88
|
+
- **影响**: 较大的 radius 会增加 GPU 计算成本
|
|
89
|
+
|
|
90
|
+
### `render(...)`
|
|
91
|
+
由 EffectComposer 在每一帧自动调用,用于执行模糊处理。通常不需要手动调用。
|
|
92
|
+
|
|
93
|
+
### `dispose()`
|
|
94
|
+
释放 Shader Material 和 FullScreenQuad 资源。在销毁 Pass 时必须调用,以防内存泄漏。
|
|
95
|
+
|
|
96
|
+
## Examples
|
|
97
|
+
|
|
98
|
+
### 快速上手 (Quick Example)
|
|
99
|
+
|
|
100
|
+
```ts
|
|
101
|
+
import { Five } from '@realsee/five';
|
|
102
|
+
import { GaussianBlurPass } from '../../lib/five/renderer/postprocessing';
|
|
103
|
+
|
|
104
|
+
const five = new Five();
|
|
105
|
+
|
|
106
|
+
// 使用 Five 的 addPass() 方法添加后处理通道
|
|
107
|
+
const blurPass = new GaussianBlurPass(five.camera);
|
|
108
|
+
five.addPass(blurPass);
|
|
109
|
+
|
|
110
|
+
// 动画循环由 Five 内部管理
|
|
111
|
+
function animate() {
|
|
112
|
+
requestAnimationFrame(animate);
|
|
113
|
+
five.render();
|
|
114
|
+
}
|
|
115
|
+
animate();
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### 进阶用法 (Advanced Usage)
|
|
119
|
+
|
|
120
|
+
#### 动态调整模糊强度
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
const blurPass = new GaussianBlurPass(five.camera);
|
|
124
|
+
five.addPass(blurPass);
|
|
125
|
+
|
|
126
|
+
// 响应用户输入调整模糊半径
|
|
127
|
+
document.addEventListener('keydown', (e) => {
|
|
128
|
+
if (e.key === '+') {
|
|
129
|
+
const current = blurPass['material'].uniforms.radius.value;
|
|
130
|
+
blurPass.setRadius(Math.min(8, current + 0.5));
|
|
131
|
+
}
|
|
132
|
+
if (e.key === '-') {
|
|
133
|
+
const current = blurPass['material'].uniforms.radius.value;
|
|
134
|
+
blurPass.setRadius(Math.max(0, current - 0.5));
|
|
135
|
+
}
|
|
136
|
+
});
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
#### 多通道组合(模糊 + 其他效果)
|
|
140
|
+
|
|
141
|
+
```ts
|
|
142
|
+
// Five 的 addPass() 会自动管理后处理链
|
|
143
|
+
const blurPass = new GaussianBlurPass(five.camera);
|
|
144
|
+
five.addPass(blurPass);
|
|
145
|
+
|
|
146
|
+
// 可添加其他后处理通道
|
|
147
|
+
// five.addPass(otherPass);
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
#### 修改高斯标准差 (Advanced)
|
|
151
|
+
|
|
152
|
+
```ts
|
|
153
|
+
const blurPass = new GaussianBlurPass(five.camera);
|
|
154
|
+
five.addPass(blurPass);
|
|
155
|
+
|
|
156
|
+
// 获取 Material 并直接修改 sigma
|
|
157
|
+
const sigmaMaterial = blurPass['material'] as THREE.ShaderMaterial;
|
|
158
|
+
sigmaMaterial.uniforms.sigma.value = 2.0; // 调整标准差(更强锐利)
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
## Debugging
|
|
162
|
+
|
|
163
|
+
### 检查模糊效果是否生效
|
|
164
|
+
- 确保 `renderToScreen` 为 `true`,或后续通道正确读取该通道的输出。
|
|
165
|
+
- 确保传入的 `camera` 对象有有效的 `resolution` 属性。
|
|
166
|
+
|
|
167
|
+
### 性能优化建议
|
|
168
|
+
- 大 `radius` 值会导致 GPU 开销增加。建议在性能受限的设备上限制最大 radius(如 ≤ 6)。
|
|
169
|
+
- 考虑在低端设备上禁用该通道(设置 `blurPass.enabled = false`)。
|
|
170
|
+
|
|
171
|
+
### 可视化调试
|
|
172
|
+
```ts
|
|
173
|
+
// 监控当前模糊参数
|
|
174
|
+
const blurPass = new GaussianBlurPass(five.camera);
|
|
175
|
+
console.log('Blur Radius:', blurPass['material'].uniforms.radius.value);
|
|
176
|
+
console.log('Blur Sigma:', blurPass['material'].uniforms.sigma.value);
|
|
177
|
+
console.log('Resolution:', blurPass['material'].uniforms.resolution.value);
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
## Common Pitfalls
|
|
181
|
+
|
|
182
|
+
1. **忘记调用 dispose()**
|
|
183
|
+
- 销毁 Pass 时,必须调用 `blurPass.dispose()` 释放 Shader 资源,否则会导致内存泄漏。
|
|
184
|
+
|
|
185
|
+
2. **分辨率变化未更新**
|
|
186
|
+
- GaussianBlurPass 会自动从 `camera.resolution` 同步分辨率,无需手动处理。但如果使用自定义相机,需确保其 `resolution` 属性始终有效。
|
|
187
|
+
|
|
188
|
+
3. **设置过大的 radius**
|
|
189
|
+
- 超过 8 的 radius 值虽然技术上可行,但会显著增加计算成本。建议不超过 8。
|
|
190
|
+
|
|
191
|
+
4. **与其他 Pass 的 needsSwap 冲突**
|
|
192
|
+
- 如果通道链中多个 Pass 设置了不同的 `needsSwap` 值,可能导致缓冲区错乱。确保通道顺序和 swap 设置一致。
|
|
193
|
+
|
|
194
|
+
## Related
|
|
195
|
+
|
|
196
|
+
* [Postprocessing](./postprocessing.md): 后处理通用概念与 EffectComposer 使用指南。
|
|
197
|
+
|
|
198
|
+
---
|
|
199
|
+
|
|
200
|
+
```yaml
|
|
201
|
+
tags: [postprocessing, shader, effect, blur, pass, rendering]
|
|
202
|
+
```
|
|
@@ -7,6 +7,8 @@
|
|
|
7
7
|
|
|
8
8
|
## Schema
|
|
9
9
|
|
|
10
|
+
> **Definition**: [GestureEvent](../../five/utils/event.d.ts)
|
|
11
|
+
|
|
10
12
|
所有手势事件的回调参数均为 `GestureEvent` 类型:
|
|
11
13
|
|
|
12
14
|
```typescript
|
|
@@ -42,6 +44,7 @@ interface GestureEvent {
|
|
|
42
44
|
|
|
43
45
|
Five 的手势系统基于 Hammer.js 封装,主要包含以下几种手势:
|
|
44
46
|
|
|
47
|
+
* **gesture.create**: 所有事件创建时。
|
|
45
48
|
* **gesture.pan**: 拖拽/平移。
|
|
46
49
|
* **gesture.pinch**: 双指缩放。
|
|
47
50
|
* **gesture.tap**: 点击。
|
|
@@ -8,6 +8,8 @@
|
|
|
8
8
|
|
|
9
9
|
## Schema
|
|
10
10
|
|
|
11
|
+
> **Definition**: [LoadResultType](../../five/model/loaders/shared.d.ts)
|
|
12
|
+
|
|
11
13
|
所有加载函数均返回 `Promise<LoadResultType>`。
|
|
12
14
|
|
|
13
15
|
```typescript
|
|
@@ -32,6 +34,7 @@ interface BaseLoaderOptions {
|
|
|
32
34
|
modelUpAxis?: 'Y' | 'Z'; // (部分加载器支持) 原始模型的上轴,用于自动旋转修正
|
|
33
35
|
fetcher?: Fetcher; // 自定义网络请求 Fetcher
|
|
34
36
|
light?: boolean; // 是否使用简化/无光照材质 (取决于加载器实现)
|
|
37
|
+
onDownloadProgress?: (progress: { loaded: number, total: number }) => void; // 下载进度回调
|
|
35
38
|
}
|
|
36
39
|
```
|
|
37
40
|
|
|
@@ -58,6 +61,24 @@ Five 使用 **Z-up** (Z 轴向上) 的右手坐标系。
|
|
|
58
61
|
|
|
59
62
|
### loadGltf
|
|
60
63
|
加载 `.gltf` 或 `.glb` 文件。支持 Draco 压缩。
|
|
64
|
+
支持扩展:
|
|
65
|
+
* `KHR_binary_glTF`
|
|
66
|
+
* `KHR_draco_mesh_compression`
|
|
67
|
+
* `KHR_texture_basisu`
|
|
68
|
+
* `KHR_texture_transform`
|
|
69
|
+
* `KHR_mesh_quantization`
|
|
70
|
+
* `KHR_materials_unlit`
|
|
71
|
+
* `KHR_node_visibility`
|
|
72
|
+
* `KHR_animation_pointer`
|
|
73
|
+
* `EXT_meshopt_compression`
|
|
74
|
+
* `KHR_materials_clearcoat`
|
|
75
|
+
* `KHR_materials_sheen`
|
|
76
|
+
* `KHR_materials_transmission`
|
|
77
|
+
* `KHR_materials_emissive_strength`
|
|
78
|
+
* `EXT_texture_webp`
|
|
79
|
+
* `CESIUM_RTC`
|
|
80
|
+
* `REALSEE_materials_lightmap`
|
|
81
|
+
* `KHR_gaussian_splatting_compression_spz`
|
|
61
82
|
|
|
62
83
|
| 参数 | 类型 | 默认值 | 说明 |
|
|
63
84
|
| --- | --- | --- | --- |
|