@realsee/five 6.7.0-alpha.19 → 6.7.0-alpha.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. package/docs/assets/hierarchy.js +1 -1
  2. package/docs/assets/navigation.js +1 -1
  3. package/docs/assets/search.js +1 -1
  4. package/docs/classes/five.AnimationFrameLoop.html +1 -1
  5. package/docs/classes/five.Five.html +48 -38
  6. package/docs/classes/five.FivePass.html +20 -0
  7. package/docs/classes/five.FullScreenQuad.html +7 -0
  8. package/docs/classes/five.Model.html +1 -1
  9. package/docs/classes/five.ModelScene.html +1 -1
  10. package/docs/classes/five.PBMContainer.html +1 -1
  11. package/docs/classes/five.PBMGroup.html +1 -1
  12. package/docs/classes/five.PBMMesh.html +1 -1
  13. package/docs/classes/five.PBMMeshMaterial.html +1 -1
  14. package/docs/classes/five.PBMPointCloud.html +1 -1
  15. package/docs/classes/five.PBMPointCloudMaterial.html +1 -1
  16. package/docs/classes/five.PBMSkinnedMesh.html +1 -1
  17. package/docs/classes/five.Parameter.html +1 -1
  18. package/docs/classes/five.Pass.html +11 -0
  19. package/docs/classes/five.Tile3D.html +1 -1
  20. package/docs/classes/five.TileNode.html +1 -1
  21. package/docs/classes/five.TrajectoryNode.html +1 -1
  22. package/docs/classes/five.WorkResolvedObserver.html +1 -1
  23. package/docs/classes/gltf-loader.DDSLoader.html +1 -1
  24. package/docs/classes/gltf-loader.DRACOLoader.html +1 -1
  25. package/docs/classes/gltf-loader.GLTFObject.html +1 -1
  26. package/docs/classes/gltf-loader.THREEGLTFLoader.html +1 -1
  27. package/docs/classes/line.LineGeometry.html +1 -1
  28. package/docs/classes/line.LineMaterial.html +1 -1
  29. package/docs/classes/line.LineSegmentsGeometry.html +1 -1
  30. package/docs/classes/line.THREE_Line2.html +1 -1
  31. package/docs/classes/line.THREE_LineSegments2.html +1 -1
  32. package/docs/classes/plugins.RoundedBoxGeometry.html +1 -1
  33. package/docs/classes/vfx.Airflow.html +1 -1
  34. package/docs/classes/vfx.Flame.html +1 -1
  35. package/docs/classes/vfx.Particle.html +1 -1
  36. package/docs/classes/vfx.ParticleGPU.html +1 -1
  37. package/docs/classes/vfx.SpotLight.html +1 -1
  38. package/docs/hierarchy.html +1 -1
  39. package/docs/interfaces/five.EventCallback.html +1 -1
  40. package/docs/interfaces/five.LooseWorkWithExtrinsics.html +1 -1
  41. package/docs/interfaces/five.ModelControllerCustomInitArgs.html +1 -1
  42. package/docs/interfaces/five.PBMMaterial.html +1 -1
  43. package/docs/interfaces/five.PBMMeshMaterialParameters.html +1 -1
  44. package/docs/interfaces/five.PBMPointCloudMaterialParameters.html +1 -1
  45. package/docs/interfaces/five.PanoramaControllerCustomInitArgs.html +1 -1
  46. package/docs/interfaces/five.PanoramaLikeControllerCustomInitArgs.html +1 -1
  47. package/docs/interfaces/five.ParameterMaterialValue.html +1 -1
  48. package/docs/interfaces/five.ParameterTilesetValue.html +1 -1
  49. package/docs/interfaces/five.ParameterValue.html +1 -1
  50. package/docs/interfaces/five.ResolvedParameterValue.html +1 -1
  51. package/docs/interfaces/five.TopviewControllerCustomInitArgs.html +1 -1
  52. package/docs/interfaces/five.VRPanoramaControllerCustomInitArgs.html +1 -1
  53. package/docs/interfaces/five.ViewLayer.html +1 -1
  54. package/docs/interfaces/five.WorkCubeImage.html +1 -1
  55. package/docs/interfaces/five.WorkImage.html +1 -1
  56. package/docs/interfaces/five.WorkObserver.html +1 -1
  57. package/docs/interfaces/five.WorkTile.html +1 -1
  58. package/docs/interfaces/five.XRPanoramaControllerCustomInitArgs.html +1 -1
  59. package/docs/interfaces/plugins.BackgroundPluginController.html +1 -1
  60. package/docs/interfaces/plugins.BackgroundPluginType.EventMap.html +1 -1
  61. package/docs/interfaces/plugins.DynamicPathLinePluginController.html +1 -1
  62. package/docs/interfaces/plugins.DynamicPathLinePluginType.EventMap.html +1 -1
  63. package/docs/interfaces/plugins.DynamicPathLinePluginType.State.html +1 -1
  64. package/docs/interfaces/plugins.ItemMaskController.html +1 -1
  65. package/docs/interfaces/plugins.ItemMaskPluginType.EventMap.html +1 -1
  66. package/docs/interfaces/plugins.ItemMaskPluginType.State.html +1 -1
  67. package/docs/interfaces/plugins.OrientationPluginController.html +1 -1
  68. package/docs/interfaces/plugins.OrientationPluginType.EventMap.html +1 -1
  69. package/docs/interfaces/plugins.OrientationPluginType.State.html +1 -1
  70. package/docs/interfaces/plugins.PanoAnimeController.html +1 -1
  71. package/docs/interfaces/plugins.PanoAnimePluginType.EventMap.html +1 -1
  72. package/docs/interfaces/plugins.PanoAnimePluginType.State.html +1 -1
  73. package/docs/interfaces/plugins.PluginTemplateType.EventMap.html +1 -1
  74. package/docs/interfaces/plugins.PluginTemplateType.State.html +1 -1
  75. package/docs/interfaces/plugins.TrajectoryController.html +1 -1
  76. package/docs/interfaces/react.FiveInjectionTypes.html +1 -1
  77. package/docs/modules/five.html +1 -1
  78. package/docs/types/five.ParseOptions.html +1 -1
  79. package/five/index.d.ts +71 -0
  80. package/five/index.js +63 -41
  81. package/five/index.mjs +983 -790
  82. package/gltf-loader/index.js +3 -3
  83. package/gltf-loader/index.mjs +3 -3
  84. package/line/index.js +3 -3
  85. package/line/index.mjs +3 -3
  86. package/package.json +1 -1
  87. package/plugins/index.js +2 -2
  88. package/plugins/index.mjs +2 -2
  89. package/react/index.js +2 -2
  90. package/react/index.mjs +2 -2
  91. package/shader-lib/index.js +9 -9
  92. package/shader-lib/index.mjs +203 -203
  93. package/sticker/index.js +3 -3
  94. package/sticker/index.mjs +3 -3
  95. package/umd/five-gltf-loader.js +3 -3
  96. package/umd/five-line.js +3 -3
  97. package/umd/five-plugins.js +2 -2
  98. package/umd/five-react.js +2 -2
  99. package/umd/five-shader-lib.js +7 -7
  100. package/umd/five-sticker.js +3 -3
  101. package/umd/five-vfx.js +2 -2
  102. package/umd/five-vue.js +2 -2
  103. package/umd/five.js +63 -41
  104. package/vfx/index.js +2 -2
  105. package/vfx/index.mjs +2 -2
  106. package/vue/index.js +2 -2
  107. package/vue/index.mjs +2 -2
  108. package/work-downloader/index.js +2 -2
  109. package/work-downloader/index.mjs +2 -2
package/docs/types/five.ParseOptions.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ParseOptions | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/five.html">five</a></li><li><a href="" aria-current="page">ParseOptions</a></li></ul><h1>Type Alias ParseOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">ParseOptions</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#baseurl">baseURL</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#jsonp">jsonp</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#shortpath">shortPath</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#transform">transform</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">THREE.Matrix4</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#workcode">workCode</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span>)<span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="5155"><h4>Hierarchy (<a href="../hierarchy.html#five.ParseOptions">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ParseOptions</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="../interfaces/five.LooseWorkWithExtrinsics.html" class="tsd-signature-type tsd-kind-interface">LooseWorkWithExtrinsics</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/five/work/work.ts:326</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#baseurl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>URL?</span></a>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ParseOptions | 如视 Five SDK</title><meta name="description" content="Documentation for 如视 Five SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">如视 Five SDK</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/five.html">five</a></li><li><a href="" aria-current="page">ParseOptions</a></li></ul><h1>Type Alias ParseOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">ParseOptions</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#baseurl">baseURL</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#jsonp">jsonp</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#shortpath">shortPath</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#transform">transform</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">THREE.Matrix4</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#workcode">workCode</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span>)<span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="5226"><h4>Hierarchy (<a href="../hierarchy.html#five.ParseOptions">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ParseOptions</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="../interfaces/five.LooseWorkWithExtrinsics.html" class="tsd-signature-type tsd-kind-interface">LooseWorkWithExtrinsics</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in lib/five/work/work.ts:326</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#baseurl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>URL?</span></a>
2
2
  <a href="#jsonp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jsonp?</span></a>
3
3
  <a href="#shortpath" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>short<wbr/>Path?</span></a>
4
4
  <a href="#transform" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transform?</span></a>
package/five/index.d.ts CHANGED
@@ -860,6 +860,22 @@ export declare class Five extends Subscribe<EventTypes> {
860
860
  phi: number;
861
861
  lookAtVector: THREE_2.Vector3;
862
862
  };
863
+ /**
864
+ * 增加后处理PASS
865
+ * @param pass - 要添加的Pass实例
866
+ */
867
+ addPass(pass: Pass): void;
868
+ /**
869
+ * 移除后处理Pass
870
+ * @param pass - 要移除的Pass实例
871
+ */
872
+ removePass(pass: Pass): void;
873
+ /**
874
+ * 在指定位置插入后处理Pass
875
+ * @param pass - 要插入的Pass实例
876
+ * @param index - 插入位置的索引
877
+ */
878
+ insertPass(pass: Pass, index: number): void;
863
879
  /**
864
880
  * @deprecated
865
881
  * use five.effect instead
@@ -1076,6 +1092,28 @@ export declare interface FiveLoadOptions {
1076
1092
  "3d-tiles"?: ModelOptions['3d-tiles'];
1077
1093
  }
1078
1094
 
1095
+ /**
1096
+ * FivePass
1097
+ *
1098
+ * Five引擎优化的Pass基类
1099
+ * 支持G-Buffer注入，避免重复渲染场景
1100
+ */
1101
+ export declare class FivePass extends Pass {
1102
+ dependencies: ('depth' | 'normal' | 'color')[];
1103
+ constructor(dependencies?: ['depth' | 'normal' | 'color']);
1104
+ /**
1105
+ * G-Buffer纹理集合
1106
+ * 包含depth、normal、color等纹理
1107
+ * 由EffectComposer在render时注入
1108
+ */
1109
+ gbuffer?: Map<'depth' | 'normal' | 'color', THREE_2.Texture>;
1110
+ /**
1111
+ * 设置G-Buffer
1112
+ * @param gbuffer - G-Buffer纹理集合
1113
+ */
1114
+ setGBuffer(gbuffer: Map<'depth' | 'normal' | 'color', THREE_2.Texture>): void;
1115
+ }
1116
+
1079
1117
  /**
1080
1118
  * Five 插件
1081
1119
  * @document ../../../guides/plugins.md
@@ -1122,6 +1160,23 @@ export declare interface FloorplanControllerCustomInitArgs {
1122
1160
  intersectMeshCreator?: () => IntersectMeshInterface;
1123
1161
  }
1124
1162
 
1163
+ /**
1164
+ * FullScreenQuad
1165
+ *
1166
+ * 用于全屏渲染的辅助类
1167
+ */
1168
+ export declare class FullScreenQuad {
1169
+ private _mesh;
1170
+ private static camera;
1171
+ private static geometry;
1172
+ private _scene;
1173
+ constructor(material?: THREE_2.Material);
1174
+ get material(): THREE_2.Material | THREE_2.Material[];
1175
+ set material(value: THREE_2.Material | THREE_2.Material[]);
1176
+ dispose(): void;
1177
+ render(renderer: THREE_2.WebGLRenderer): void;
1178
+ }
1179
+
1125
1180
  export declare interface GestureEvent extends StateEvent {
1126
1181
  target: EventTarget | null;
1127
1182
  pointerType: 'touch' | 'pen' | 'mouse' | 'kinect';
@@ -2889,6 +2944,22 @@ export declare type ParseOptions = {
2889
2944
  */
2890
2945
  export declare function parseWork(obj: Work | LoosePanoWork | LooseWork | string | any, options?: ParseOptions): Work;
2891
2946
 
2947
+ /**
2948
+ * Pass基类
2949
+ *
2950
+ * three.js的Pass接口，用于EffectComposer
2951
+ */
2952
+ export declare class Pass {
2953
+ enabled: boolean;
2954
+ needsSwap: boolean;
2955
+ clear: boolean;
2956
+ renderToScreen: boolean;
2957
+ constructor();
2958
+ setSize(width: number, height: number): void;
2959
+ render(renderer: THREE_2.WebGLRenderer, writeBuffer: THREE_2.WebGLRenderTarget, readBuffer: THREE_2.WebGLRenderTarget, deltaTime?: number, maskActive?: boolean): void;
2960
+ static FullScreenQuad: typeof FullScreenQuad;
2961
+ }
2962
+
2892
2963
  export declare type PBMAlphaMode = 'OPAQUE' | 'MASK' | 'BLEND';
2893
2964
 
2894
2965
  export declare interface PBMClipperParameter {