@yangyongtao/gaea

@yangyongtao/gaea

基于 Godot WASM 引擎的 Vue 3 三维可视化组件库。提供影像/地形/贴地线加载、相机视角控制、图层树、天气控制、沿线飞行、断面游览、室内游览等能力，并内置 Vite 插件自动注入引擎资源。

完整可运行示例参考消费者项目的 src/App.vue，本文所有片段均以其为参考。

1. 安装

npm install @yangyongtao/gaea

peerDependencies（按需安装）：vue ^3.4、element-plus ^2.6（可选）、pinia ^2.1（可选）。

⚠️ 引擎大资源文件（Gaea.pck / Gaea.wasm / 1111.res / gltf 等）不随 npm 包分发，需手动放置，详见第 8 节。

2. 引入方式

本库同时支持 ESM 和 CommonJS。

ESM（推荐，vue-cli / vite / webpack 默认）

import { GaeaApp, setConfig } from '@yangyongtao/gaea';
import { WeatherControl, FlyAlongRoute } from '@yangyongtao/gaea/components';
import { gaeaVitePlugin } from '@yangyongtao/gaea/plugin';

CommonJS

// 需要使用 await import() 或 .then()
const gaea = await import('@yangyongtao/gaea');
gaea.setConfig({ ... });

// vite 配置中使用 CJS 引用插件
const { gaeaVitePlugin } = await import('@yangyongtao/gaea/plugin');

CJS 环境下 不能 直接用 require()，因为内部实现是 ESM 模块。Node.js 对 CJS require ESM 有限制，因此 CJS 包装入口返回的是 Promise。

3. Vite 配置

引入并注册 gaeaVitePlugin，它会自动注入 Gaea.js、提供引擎静态资源、设置 SharedArrayBuffer 所需的跨域隔离响应头。

// vite.config.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'] },
});

4. 快速开始

页面里需要一个 id="canvas" 的画布。调用 setConfig(...) 后 new GaeaApp() 即可自动完成「引擎启动 → 环境初始化 → 图层加载 → 模型加载」。

<template>
  <div id="gaea-app">
    <div class="toolbar">
      <button @click="showWeather = !showWeather">天气控制</button>
      <button @click="showFly = !showFly">沿线飞行</button>
      <button @click="showLayerTree = !showLayerTree">图层控制</button>
      <WaterGateTour />
    </div>

    <div class="canvas-area" id="canvas-container">
      <canvas id="canvas"></canvas>
    </div>

    <WeatherControl v-if="showWeather" :appInstance="app" @close="showWeather = false" />
    <FlyAlongRoute v-if="showFly" :appInstance="app" @close="showFly = false" />
    <LayerTree v-if="showLayerTree" :appInstance="app" @close="showLayerTree = false" @node-click="onLayerNodeClick" />
    <HydrologicStationDialog />
    <SecTourView />
  </div>
</template>

<script setup>
import { ref } from 'vue';
import { GaeaApp, setConfig } from '@yangyongtao/gaea';
import { WeatherControl, FlyAlongRoute, HydrologicStationDialog, SecTourView, WaterGateTour } from '@yangyongtao/gaea/components';
import LayerTree from '@yangyongtao/gaea/components/LayerTree.vue';

setConfig({
  serveLocal: `${window.location.origin}/static`,
  serveUrl: 'http://192.168.3.151:8088/gaeaExplorerServer/',
  serviceMode: 'platform',
  defaultCameraPosition: '27.3680928977018,120.414139621887,0,109379.690132486,0,0',
});

const app = new GaeaApp();
window.APP = app;               // 组件内部通过 window.APP 兜底获取实例

const showWeather = ref(false);
const showFly = ref(false);
const showLayerTree = ref(false);

function onLayerNodeClick({ node }) {
  app.flyToNode(node);
}
</script>

5. setConfig 配置项

5.1 serviceMode —— 服务模式（区分「服务平台」与「在线」）

• 'platform'（服务平台）：影像走 serveUrl 的 WMTS，并加载 defaultTerrains 地形、defaultGroundLines 贴地线。
• 'online'（在线）：仅加载天地图影像，不加载地形和贴地线（在线模式目前只有天地图一种影像来源）。

setConfig({ serviceMode: 'platform' });  // 内网/服务平台
// 或
setConfig({ serviceMode: 'online', tiandituToken: '你的token' }); // 在线（天地图）

5.2 defaultLayers —— 影像图层（服务平台模式）

defaultLayers: [
  { layerName: 'earthland', forMat: 'image/png', min: 0, max: 18, transparency: 0.3 },
  { layerName: '苍南L19',   forMat: 'image/png', min: 5, max: 17 },
]

• layerName：WMTS 服务里的图层名（Title）
• forMat：影像格式，如 image/png、image/jpeg
• min / max：显示层级范围
• transparency：透明度（可选）

5.3 defaultTerrains —— 地形服务（服务平台模式）

defaultTerrains: [
  { name: '苍南县地形', url: 'htc/service/tms/1.0.0/苍南县地形@EPSG%3A4326@terrain/' },
]

• name：地形名称
• url：相对 serveUrl 的路径（也支持传完整 http(s):// 地址）
• 空数组 [] 则不加载地形

5.4 defaultGroundLines —— 贴地线（服务平台模式）

依赖 serveUrl 的 WMTS 矢量线服务（自动通过 getAllServe 获取服务列表后按名匹配）。

defaultGroundLines: [
  { name: '苍南县边界',        range: [0, 9],   color: [255, 255, 0],   index: 100 },
  { name: '苍南县镇边界',      range: [9, 15],  color: [0, 255, 0],     index: 80 },
  { name: '苍南县村边界',      range: [15, 19], color: [255, 255, 255], index: 60 },
  { name: '沿浦海塘工程范围线', range: [0, 21],  color: [0, 255, 255],   index: 120 },
]

• name：矢量线服务名（Title）
• range：显示层级范围 [min, max]
• color：线颜色 [r, g, b]（0-255）
• index：渲染优先级
• 每项可加 isInitLoad: false 跳过该条

6. 组件说明

组件从 @yangyongtao/gaea/components 导入；LayerTree 需按路径单独导入。多数交互组件接收 :appInstance="app"，未传时内部回退到 window.APP。

6. 常用实例方法（window.APP / app）

7. 注意事项

• 页面必须存在 id="canvas" 的 <canvas>，引擎会挂载到它上面。
• 需要跨域隔离（COOP/COEP）才能启用 SharedArrayBuffer，gaeaVitePlugin 已自动处理；首次进入若未隔离会自动刷新一次。
• 服务平台模式下地形/贴地线依赖 serveUrl 对应服务，若服务器无对应服务名，控制台会打印「未找到/加载失败」警告，不影响其它功能。
• 大体积引擎资源不随 npm 包分发，需手动放置，详见第 8 节。

9. 大资源文件的放置

引擎运行需要的大文件体积过大，不包含在 npm 包内，也不会自动下载（postinstall 仅做检测与提示）。请通过内网传输或手动拷贝的方式，将它们放到消费者项目里 gaea 包的 public 目录下。

9.1 需要放置的文件

放置目标目录：node_modules/@yangyongtao/gaea/public/

⚠️ 重要：1111.res 必须使用 完整版（约 34.6 MB）。早期存在一个残缺的 6.5MB 版本，会导致点图标纹理为空、加载台风路线时引擎崩溃（SimpleFeatureRenderer.CombineSymbolMeshs 空引用）。放置后可用文件大小快速校验。

9.2 校验是否就位

# Windows PowerShell
Get-Item node_modules/@yangyongtao/gaea/public/Gaea.pck | Select-Object Length
Get-Item node_modules/@yangyongtao/gaea/public/static/1111.res | Select-Object Length

Gaea.pck 约 450MB、1111.res 约 34.6MB 即为正确。

9.3 注意事项

• 更换 1111.res 后，若浏览器曾加载过旧的残缺资源，引擎会把资源按名缓存进持久化虚拟文件系统，需**强制刷新（Ctrl+Shift+R）**一次；本库已用版本化资源名规避该缓存问题。
• 若不放置这些文件，npm install 后控制台会打印提示，且页面无法正常渲染三维场景。
• CI 等无需下载/提示的环境，可设置环境变量 GAEA_SKIP_DOWNLOAD=1 跳过 postinstall 提示。

License

MIT