npm - @yangyongtao/gaea - Versions diffs - 1.0.3 → 1.1.0 - Mend

@yangyongtao/gaea 1.0.3 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (137) hide show

package/README.md CHANGED Viewed

@@ -1,114 +1,205 @@
-# gaea-3dview
+# @yangyongtao/gaea
-Gaea 3D 可视化组件库，包含天气控制、沿线飞行、台风标注、点标注等功能。
-## 前置条件
-使用前需在 HTML 中加载 Gaea 运行库：
-```html
-<script src="path/to/Gaea.js"></script>
-```
+Gaea 3D 可视化组件库 — 基于 Godot WASM 引擎的 Vue 3 组件包。
 ## 安装
 ```bash
-npm install @your-scope/gaea-3dview
+npm install @yangyongtao/gaea
 ```
-## 快速开始
+## 项目配置
-```js
-import { GaeaApp, setConfig } from '@your-scope/gaea-3dview';
+### 1. `vite.config.js`
-// 1. 配置全局参数（初始化前调用）
-setConfig({
-  serveLocal: 'http://localhost:9012',  // 静态资源地址
-  serveUrl: 'http://192.168.1.1:8088/gaeaExplorerServer/',
+```js
+import { defineConfig } from 'vite';
+import vue from '@vitejs/plugin-vue';
+import { gaeaVitePlugin } from '@yangyongtao/gaea/plugin';
+export default defineConfig({
+  plugins: [vue(), gaeaVitePlugin()],
+  resolve: {
+    preserveSymlinks: true,
+  },
+  optimizeDeps: {
+    exclude: ['@yangyongtao/gaea'],
+  },
 });
+```
-// 2. 创建实例
-const app = new GaeaApp();
+| 配置 | 说明 |
+|------|------|
+| `gaeaVitePlugin()` | 自动注入 `<script src="/Gaea.js">`、提供 public/ 静态文件、设置 COEP/COOP 头 |
+| `preserveSymlinks: true` | npm link 本地调试时必需 |
+| `exclude` | 跳过 Vite 预构建，避免 `import('../public/index.js')` 在 Node 端解析失败 |
-// 3. 初始化基础环境
-app.initDefaultEnvironment();
+### 2. `index.html`
-// 4. 在指定坐标放置图标
-await app.drawPointIcon({ lat: 27.3809, lng: 120.4499 });
+无需手动添加任何 script — 插件会自动注入：
-// 5. 沿线飞行
-await app.flyAlongPath([
-  { x: 27.22, y: 120.45 },
-  { x: 27.35, y: 120.55 },
-]);
+```html
+<!DOCTYPE html>
+<html><head><meta charset="UTF-8" /></head>
+<body>
+  <div id="app"></div>
+  <script type="module" src="/src/main.js"></script>
+</body></html>
 ```
-## API 文档
+### 3. `src/main.js`（Vue 入口）
-### GaeaApp 类
+```js
+import { createApp } from 'vue';
+import App from './App.vue';
+createApp(App).mount('#app');
+```
-#### `setConfig(config)`
-初始化前设置全局配置，必传 `serveLocal`。
+### 4. `src/App.vue`（完整初始化示例）
-#### `drawPointIcon(opts)` / `drawPointIcons(list)`
-在指定经纬度放置图标标记。
+```vue
+<template>
+  <canvas id="canvas" style="width:100vw;height:100vh"></canvas>
+</template>
-```js
-await app.drawPointIcon({ lat: 27.22, lng: 120.45, iconSize: 150 });
+<script setup>
+import { onMounted } from 'vue';
+import { GaeaApp, setConfig } from '@yangyongtao/gaea';
+const app = new GaeaApp();
+window.APP = app; // 控制台调试
+onMounted(async () => {
+  // ① 配置
+  setConfig({
+    serveLocal: `${window.location.origin}/static/`,
+    serveUrl: 'http://192.168.3.151:8088/gaeaExplorerServer/',
+  });
+  // ② 启动 Godot WASM 引擎
+  new window.Engine({
+    args: [],
+    canvasResizePolicy: 2,
+    executable: '/Gaea',
+    experimentalVK: false,
+    fileSizes: {
+      'Gaea.pck': 450751936,
+      'Gaea.wasm': 16580215,
+    },
+    focusCanvas: true,
+    gdnativeLibs: [],
+  }).startGame({
+    onProgress: (current, total) => console.log(`加载: ${current}/${total}`),
+  });
+  // ③ 初始化环境（雾、光照、AssetHost 等）
+  await app.initDefaultEnvironment();
+  // ④ 加载 WMTS 影像图层
+  app.getAllServe().then(() => {
+    app.addLayer({ layerName: 'earthland', forMat: 'image/png', min: 0, max: 18, transparency: 0.3 });
+    app.addLayer({ layerName: '苍南L19',  forMat: 'image/png', min: 5, max: 17 });
+  });
+});
+</script>
 ```
-#### `clearPointIcons()`
-清除所有点标注。
+> **注意**：`fileSizes` 中的数值需与实际 `public/Gaea.pck` 和 `public/Gaea.wasm` 文件大小一致。
+## API
+### 配置
+| 方法 | 说明 |
+|------|------|
+| `setConfig({ serveUrl, serveLocal })` | 全局配置，必须在 `new GaeaApp()` 前调用 |
+| `getConfig()` | 读取当前配置 |
-#### `flyAlongPath(lineData, opts)`
-沿路径飞行。
+### 环境初始化
+| 方法 | 说明 |
+|------|------|
+| `await app.initDefaultEnvironment()` | 关闭雾、设置 AssetHost、环境光、日照 |
+### 影像图层
+| 方法 | 说明 |
+|------|------|
+| `await app.getAllServe()` | 获取 WMTS 服务图层列表，存到 `app.layers` |
+| `app.addLayer({ layerName, max, min, transparency, forMat, inserIndex })` | 添加单张影像图层到 3D 地球 |
 ```js
-await app.flyAlongPath(
-  [{ x: 27.22, y: 120.45 }, { x: 27.35, y: 120.55 }],
-  { height: 150, duration: 20 }
-);
+app.addLayer({
+  layerName: 'earthland',   // 图层名称（与 WMTS Capabilities 中的 Title 一致）
+  forMat: 'image/png',      // 图像格式
+  min: 0, max: 18,          // 显示层级范围
+  transparency: 0.3,        // 透明度 0~1
+});
 ```
-#### `stopFlyAlongPath()`
-停止飞行。
+### 相机控制
-#### `enableRain(params)` / `restoreNormalWeather()`
-天气控制。
+| 方法 | 说明 |
+|------|------|
+| `app.SetPosition("lat,lng,alt,dist,pitch,heading")` | 定位到指定视角 |
+| `app.favorite()` | 记录当前视角，返回 URI 字符串 |
+| `app.favoritePosition(uri)` | 定位到已保存的视角 URI |
 ```js
-app.enableRain({ direction: 0, speed: 5, count: 30 });
-app.restoreNormalWeather();
-```
+// 定位到 27.38°N, 120.45°E, 高度 0, 距离 3000, 俯仰 0, 朝向 0
+app.SetPosition('27.3809, 120.4499, 0, 3000, 0, 0');
-#### `cameraReset()`
-重置相机到默认视角。
+// 保存视角
+const uri = app.favorite();
-#### `screenToLatLng(event)`
-屏幕坐标 → 经纬度。
+// 恢复视角
+app.favoritePosition(uri);
+```
-## Vue 组件
+### Vue 组件
 ```vue
 <script setup>
-import { GaeaApp } from '@your-scope/gaea-3dview';
-import { WeatherControl, FlyAlongRoute } from '@your-scope/gaea-3dview/components';
-const app = new GaeaApp();
+import { WeatherControl, FlyAlongRoute } from '@yangyongtao/gaea/components';
+const app = window.APP;
 </script>
 <template>
-  <WeatherControl :appInstance="app" @close="..." />
-  <FlyAlongRoute :appInstance="app" @close="..." @fly="..." />
+  <WeatherControl :appInstance="app" @close="show = false" />
+  <FlyAlongRoute :appInstance="app" @close="show = false" />
 </template>
 ```
+### 其他导出
+| 导出 | 路径 |
+|------|------|
+| `GaeaPlugin` (v-drag 指令) | `@yangyongtao/gaea/plugin` |
+| `gaeaVitePlugin` | `@yangyongtao/gaea/plugin` |
+| `loadResource`, `screenToLatLng` | `@yangyongtao/gaea` |
 ## 静态资源
-发布时需要随包分发以下文件：
-- `public/static/1111.res` — 点标注图标
-- `public/static/SkyDay.png` — 天空纹理（可选）
-- `public/static/gltf/*.gltf` — 3D 模型文件
+npm 包 `public/` 目录包含以下文件，由 `gaeaVitePlugin` 自动提供：
+```
+public/
+├── Gaea.js              # Godot HTML5 引擎
+├── Gaea.wasm            # WebAssembly 模块
+├── Gaea.pck             # 引擎资源包
+├── Gaea.worker.js       # Worker 线程
+├── Gaea.audio.worklet.js
+├── index.js             # Godot 类绑定（≈185K 行）
+├── config.js / constants.js
+├── math/                # 数学工具
+├── static/
+│   ├── 1111.res         # 点标注资源
+│   ├── Global2.jpg      # 全球底图
+│   ├── Cloud.png / SkyDay.png
+│   ├── gltf/            # 3D 模型
+│   └── js/              # 业务脚本
+└── image/               # 图标资源
+```
 ## License

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@yangyongtao/gaea",
-  "version": "1.0.3",
-  "description": "Gaea 3D 可视化组件库，包含天气控制、沿线飞行、台风标注、模型加载等功能",
+  "version": "1.1.0",
+  "description": "Gaea 3D visualization component library - Vue 3 components based on Godot WASM engine. Includes WMTS layer loading, camera view control, Vite plugin auto-injection, etc.",
   "type": "module",
   "main": "src/index.js",
   "module": "src/index.js",
@@ -17,23 +17,44 @@
     "./methods": {
       "import": "./src/GaeaMethods.js",
       "default": "./src/GaeaMethods.js"
+    },
+    "./plugin": {
+      "import": "./src/plugin.js",
+      "default": "./src/plugin.js"
     }
   },
   "files": [
     "src/",
-    "public/",
-    "README.md"
+    "scripts/",
+    "README.md",
+    "public/*.js",
+    "public/*.html",
+    "public/*.png",
+    "public/*.ico",
+    "public/*.import",
+    "public/config.js",
+    "public/constants.js",
+    "public/math/",
+    "public/image/",
+    "public/static/css/",
+    "public/static/geojson/",
+    "public/static/img/",
+    "public/static/js/",
+    "public/static/*.png",
+    "public/static/*.jpg"
   ],
   "scripts": {
+    "postinstall": "node scripts/postinstall.mjs",
     "test": "echo \"No tests yet\""
   },
   "keywords": [
     "gaea",
     "3d",
     "viewer",
-    "weather",
-    "typhoon",
-    "flight",
+    "godot",
+    "wasm",
+    "gis",
+    "wmts",
     "vue",
     "component"
   ],

package/public/Gaea.apple-touch-icon.png ADDED Viewed

Binary file

package/public/Gaea.apple-touch-icon.png.import ADDED Viewed

@@ -0,0 +1,35 @@
+[remap]
+importer="texture"
+type="StreamTexture"
+path="res://.import/Gaea.apple-touch-icon.png-3d2e13d9913bdd8e3563afb6c9370785.stex"
+metadata={
+"vram_texture": false
+}
+[deps]
+source_file="res://exports/html5/release/Gaea.apple-touch-icon.png"
+dest_files=[ "res://.import/Gaea.apple-touch-icon.png-3d2e13d9913bdd8e3563afb6c9370785.stex" ]
+[params]
+compress/mode=0
+compress/lossy_quality=0.7
+compress/hdr_mode=0
+compress/bptc_ldr=0
+compress/normal_map=0
+flags/repeat=0
+flags/filter=true
+flags/mipmaps=false
+flags/anisotropic=false
+flags/srgb=2
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/HDR_as_SRGB=false
+process/invert_color=false
+process/normal_map_invert_y=false
+stream=false
+size_limit=0
+detect_3d=true
+svg/scale=1.0

package/public/Gaea.audio.worklet.js ADDED Viewed

@@ -0,0 +1,211 @@
+/*************************************************************************/
+/*  audio.worklet.js                                                     */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md).   */
+/*                                                                       */
+/* Permission is hereby granted, free of charge, to any person obtaining */
+/* a copy of this software and associated documentation files (the       */
+/* "Software"), to deal in the Software without restriction, including   */
+/* without limitation the rights to use, copy, modify, merge, publish,   */
+/* distribute, sublicense, and/or sell copies of the Software, and to    */
+/* permit persons to whom the Software is furnished to do so, subject to */
+/* the following conditions:                                             */
+/*                                                                       */
+/* The above copyright notice and this permission notice shall be        */
+/* included in all copies or substantial portions of the Software.       */
+/*                                                                       */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
+/*************************************************************************/
+class RingBuffer {
+	constructor(p_buffer, p_state, p_threads) {
+		this.buffer = p_buffer;
+		this.avail = p_state;
+		this.threads = p_threads;
+		this.rpos = 0;
+		this.wpos = 0;
+	}
+	data_left() {
+		return this.threads ? Atomics.load(this.avail, 0) : this.avail;
+	}
+	space_left() {
+		return this.buffer.length - this.data_left();
+	}
+	read(output) {
+		const size = this.buffer.length;
+		let from = 0;
+		let to_write = output.length;
+		if (this.rpos + to_write > size) {
+			const high = size - this.rpos;
+			output.set(this.buffer.subarray(this.rpos, size));
+			from = high;
+			to_write -= high;
+			this.rpos = 0;
+		}
+		if (to_write) {
+			output.set(this.buffer.subarray(this.rpos, this.rpos + to_write), from);
+		}
+		this.rpos += to_write;
+		if (this.threads) {
+			Atomics.add(this.avail, 0, -output.length);
+			Atomics.notify(this.avail, 0);
+		} else {
+			this.avail -= output.length;
+		}
+	}
+	write(p_buffer) {
+		const to_write = p_buffer.length;
+		const mw = this.buffer.length - this.wpos;
+		if (mw >= to_write) {
+			this.buffer.set(p_buffer, this.wpos);
+			this.wpos += to_write;
+			if (mw === to_write) {
+				this.wpos = 0;
+			}
+		} else {
+			const high = p_buffer.subarray(0, mw);
+			const low = p_buffer.subarray(mw);
+			this.buffer.set(high, this.wpos);
+			this.buffer.set(low);
+			this.wpos = low.length;
+		}
+		if (this.threads) {
+			Atomics.add(this.avail, 0, to_write);
+			Atomics.notify(this.avail, 0);
+		} else {
+			this.avail += to_write;
+		}
+	}
+}
+class GodotProcessor extends AudioWorkletProcessor {
+	constructor() {
+		super();
+		this.threads = false;
+		this.running = true;
+		this.lock = null;
+		this.notifier = null;
+		this.output = null;
+		this.output_buffer = new Float32Array();
+		this.input = null;
+		this.input_buffer = new Float32Array();
+		this.port.onmessage = (event) => {
+			const cmd = event.data['cmd'];
+			const data = event.data['data'];
+			this.parse_message(cmd, data);
+		};
+	}
+	process_notify() {
+		if (this.notifier) {
+			Atomics.add(this.notifier, 0, 1);
+			Atomics.notify(this.notifier, 0);
+		}
+	}
+	parse_message(p_cmd, p_data) {
+		if (p_cmd === 'start' && p_data) {
+			const state = p_data[0];
+			let idx = 0;
+			this.threads = true;
+			this.lock = state.subarray(idx, ++idx);
+			this.notifier = state.subarray(idx, ++idx);
+			const avail_in = state.subarray(idx, ++idx);
+			const avail_out = state.subarray(idx, ++idx);
+			this.input = new RingBuffer(p_data[1], avail_in, true);
+			this.output = new RingBuffer(p_data[2], avail_out, true);
+		} else if (p_cmd === 'stop') {
+			this.running = false;
+			this.output = null;
+			this.input = null;
+		} else if (p_cmd === 'start_nothreads') {
+			this.output = new RingBuffer(p_data[0], p_data[0].length, false);
+		} else if (p_cmd === 'chunk') {
+			this.output.write(p_data);
+		}
+	}
+	static array_has_data(arr) {
+		return arr.length && arr[0].length && arr[0][0].length;
+	}
+	process(inputs, outputs, parameters) {
+		if (!this.running) {
+			return false; // Stop processing.
+		}
+		if (this.output === null) {
+			return true; // Not ready yet, keep processing.
+		}
+		const process_input = GodotProcessor.array_has_data(inputs);
+		if (process_input) {
+			const input = inputs[0];
+			const chunk = input[0].length * input.length;
+			if (this.input_buffer.length !== chunk) {
+				this.input_buffer = new Float32Array(chunk);
+			}
+			if (!this.threads) {
+				GodotProcessor.write_input(this.input_buffer, input);
+				this.port.postMessage({ 'cmd': 'input', 'data': this.input_buffer });
+			} else if (this.input.space_left() >= chunk) {
+				GodotProcessor.write_input(this.input_buffer, input);
+				this.input.write(this.input_buffer);
+			} else {
+				this.port.postMessage('Input buffer is full! Skipping input frame.');
+			}
+		}
+		const process_output = GodotProcessor.array_has_data(outputs);
+		if (process_output) {
+			const output = outputs[0];
+			const chunk = output[0].length * output.length;
+			if (this.output_buffer.length !== chunk) {
+				this.output_buffer = new Float32Array(chunk);
+			}
+			if (this.output.data_left() >= chunk) {
+				this.output.read(this.output_buffer);
+				GodotProcessor.write_output(output, this.output_buffer);
+				if (!this.threads) {
+					this.port.postMessage({ 'cmd': 'read', 'data': chunk });
+				}
+			} else {
+				this.port.postMessage('Output buffer has not enough frames! Skipping output frame.');
+			}
+		}
+		this.process_notify();
+		return true;
+	}
+	static write_output(dest, source) {
+		const channels = dest.length;
+		for (let ch = 0; ch < channels; ch++) {
+			for (let sample = 0; sample < dest[ch].length; sample++) {
+				dest[ch][sample] = source[sample * channels + ch];
+			}
+		}
+	}
+	static write_input(dest, source) {
+		const channels = source.length;
+		for (let ch = 0; ch < channels; ch++) {
+			for (let sample = 0; sample < source[ch].length; sample++) {
+				dest[sample * channels + ch] = source[ch][sample];
+			}
+		}
+	}
+}
+registerProcessor('godot-processor', GodotProcessor);