基于 React 的 Mars3D🌎功能示例项目
这是一个基于 React 开发的 Mars3D 功能示例 演示项目。
建议先看一遍视频讲解,再实际操作,您可以新页面查看高清视频
git clone git@github.com:marsgis/mars3d-react-example.git
git clone git@gitee.com:marsgis/mars3d-react-example.git
{
"eslint.format.enable": true,
"[json]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[typescript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[html]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[typescriptreact]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
}
public/lib/
目录下,更新 mars3d 为最新版本。请将机器Node版本升级到v16及以上版本
npm install
//或使用代理
npm i --registry=http://registry.taobao.org
注意:尽量使用 npm 安装依赖
npm run serve
npm run build //编译后生成在dist目录,拷贝出去发布即可
npm run serve:dist //测试dist运行状态
// 或者将dist文件夹发布在自己的服务数据上
提交方式:
TypeScript
基本语法mars3d-react-example
└───src 主要项目代码
│ └───components react组件代码【重要】
│ └───example 示例代码【重要】
│ └───misc 主要存放ts相关的模块定义
│ └───pages 页面入口
│ └───styles 样式文件
│ └───utils 工具方法
└───public 无需编译构建的静态资源【重要】
│ └───config 项目和功能的配置文件
│ └───img 图片资源
│ └───lib 示例依赖资源
│ └───temp 示例的公共基础代码
│───.eslintrc.js eslint配置文件
│─── package.json 项目配置信息
└─── vite.config.ts vite 配置文件
└─── index.html 列表页入口
└─── editor-react.html 编辑器页面入口
与示例相关的 3 个主要目录是:src\example
、public
、src\components
(部分功能依赖)。
配置的依赖会在 html 中按配置顺序加载,注意配置时依赖之间的先后顺序。
public/lib/
目录下,并由 includeLibs.js 统一配置。 libs 中通常会是一些开源的 js 库,如果示例只依赖 mars3d 相关资源,可省略 libs 字段。{
"name": "天地图地形",
"main": "terrain/terrainTDT",
"reactPanel": true,
"libs": ["mars3d", "mars3d-tdt"],
"thumbnail": "b10_terrain_tdt.jpg"
}
通过 includeLibs.js 中的 isLocal 变量,手动控制使用本地资源,还是 CDN 资源
{
"name": "POI兴趣点搜索(Cesium原生)",
"main": "control/cesium/geocoder",
"resources": ["cesiumControl.css"],
"thumbnail": "d10_geocoder.jpg"
}
同级目录下只需要配置文件名,不在同级目录的 需配置打包后文件位置的绝对路径如 /example/graphic/apply/typhoon/Typhoon.js
每个示例都是一个单独的文件夹,均放在src\example
示例目录下的子目录,因为示例众多,建议多级目录来管理。
示例目录下,一般有 2 个文件(地图业务与 UI 解耦):
map.js 文件:涉及地图业务的操作均写在 map.js 中;
index.tsx 文件:是一个 React 组件面板,涉及 UI 层面、和地图无关的操作均写在 index.tsx 中;
示例的内部构造处理流程图:
下面我们以src\example\map\sample\
为示例说明。
在 public/config/example.json
中加上对应的配置项,这样就能在示例列表页面看到对应的示例卡片。
{
"name": "示例名称",
"main": "map/sample", //示例的相对路径
"hasPannel": true, // 可选参数,表示是否存在ui面板,默认false
"libs": [], // 通用依赖项,可选参数 默认 ["mars3d"]
"resources": ["cesiumControl.css"], // 个性化依赖项, 可选参数,默认 []
"thumbnail": "thumbnail.jpg" // 缩略图可选, 默认为 thumbnail.jpg
}
注:上述配置
main
为src\example
下的相对路径
一个示例所有的配置文件的类型定义如下
interface ConfigSubChildren {
name: string // 示例名称
thumbnail?: string // 缩略图
main: string // 入口,example下的相对路径
hasPannel?: boolean // 该示例是否存在ui面板
pannelFiles?: any[] // ui面板的依赖文件数组
libs?: string[] // 外部依赖
resources?: string[] // 内部依赖
params?: string // 此示例的url后面的额外参数
hidden?: boolean // 列表中隐藏此示例
}
在src\example
示例目录下新建对应示例的子目录,因为示例众多,建议多级目录来管理,当前我们新建了src\example\map\sample\
目录。
在目录下新建map.js
(文件名固定不可修改)主入口文件 map.js 主要用于处理地图相关业务。
在文件中必须加上 initMap 方法来初始化地球和相关业务,比如:
最简结构如下
var map
// 事件对象,用于抛出事件给react
var eventTarget = new mars3d.BaseClass()
// 构造地图主方法【必须】
function initMap(options) {
// 创建三维地球场景
map = new mars3d.Map("mars3dContainer", options)
}
在 map.js 中 存在以下全局方法, 并且已经预先加载了 mar3d 相关依赖
globalMsg(msg, type, ...args) // message
globalAlert(msg, title, ...args) // alert
globalNotify(msg, disc, ...args) // notify
showLoading(type) // 显示loading
hideLoading(type) // 关闭loading
完成后我们即可访问 http://localhost:8080/editor.html?id=map/sample来查看示例的效果。
按示例本身需要来配置 libs 和 resources 依赖。
index.tsx
业务窗口面板在目录下新增index.tsx
文件,该文件主要是用于 UI 面板相关的业务代码。
创建控件 React 面板,可以参考已有示例加上相关业务面板。此文件必须默认导出一个 react 组件
同时在 example.json 中的对应示例增加配置hasPannel:true
import {MarsGUI} from "@mars/components/MarsUI"
导入后即可使用index.tsx
面板操作map.js
内地图相关对象时。需要在 react 中加上下面代码进行访问
index.tsx 文件中:
// mapWork是map.js内定义的所有对象,目前在示例框架中做好了封装传递过来的。
import * as mapWork from "./map.js"
// 滑动条修改事件
mapWork.updateBrightness(formState.brightness)
map.js 文件中:
// map.js中
export function updateBrightness(val) {
bloomEffect.brightness = val
}
map.js
地图业务中需要操作index.tsx
面板时。map.js 文件中:
// 抛出事件
export const eventTarget = new mars3d.BaseClass()
//完成操作或取到相关数据后
eventTarget.fire("loadOk", { 需要传递到react中使用的对象 })
index.tsx 文件中:
// 取到js中的数据
mapWork.eventTarget.on("loadOk", function (event: any) {})
map.js
和index.tsx
各自代码业务分离的原则原则:
如何区分?
示例的目的是演示平台的每个功能点,可以按需求或兴趣去学习每一个示例,
平台所有代码层面来说支持离线运行和使用的,但需要注意的是离线时的地图服务的相关处理。
如果局域网内有相关地形、卫星底图服务可以按内网服务类型和 URL 地址替换下config.json
或构造Map的代码中
的默认地形和底图。
如果局域网内没有相关服务,可以按下面处理:
terrain
配置中,将已有的"show": true
配置,改为"show": false
basemaps
数组配置中,将已有的"show": true
的图层,将该值改为"show": false
,并将单张图片或离线地图加上"show": true
,并修改相关 URL 地址。因为新增静态资源涉及拷贝,需要重启服务 npm run serve
Mars3D平台
是火星科技研发的一款基于 WebGL 技术实现的三维客户端开发平台,基于Cesium优化提升与 B/S 架构设计,支持多行业扩展的轻量级高效能 GIS 开发平台,能够免安装、无插件地在浏览器中高效运行,并可快速接入与使用多种 GIS 数据和三维模型,呈现三维空间的可视化,完成平台在不同行业的灵活应用。
Mars3D 平台可用于构建无插件、跨操作系统、 跨浏览器的三维 GIS 应用程序。平台使用 WebGL 来进行硬件加速图形化,跨平台、跨浏览器来实现真正的动态大数据三维可视化。通过 Mars3D 产品可快速实现浏览器和移动端上美观、流畅的三维地图呈现与空间分析。
Mars3D 官网:http://mars3d.cn
Mars3D 开源项目列表:https://github.com/marsgis/mars3d
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。