# OpenZIAPI

**Repository Path**: openziproject/OpenZIAPI

## Basic Information

- **Project Name**: OpenZIAPI
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: 5.0
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 7
- **Forks**: 2
- **Created**: 2024-03-11
- **Last Updated**: 2025-10-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OpenZIAPI

**语言: [English](README.en.md), [中文](README.md)**

### 项目介绍

<img src="Documents/Images/logo.png" alt="OpenZI" style="zoom: 33%;" />

​    **“OPENZI数化软件”系列产品，包含构建数字孪生所需要的各个功能平台框架，也是在数字孪生、可视化应用的经验和项目中打造出来的最佳实施验证方案。提供数字孪生的业务应用的通用接口功能、数字孪生编辑、项目配置发布功能、自研稳定云渲染相关技术的综合性行业解决方案，助力客户构建自己的数字孪生应用平台。**

​    **OpenZIEditor是“OpenZI数化软件”中的业务编辑产品，结合OpenZIAPI完成业务引擎自动生成，完全分离业务功能与平台化技术。**

​    **OpenZIEditor主要功能包括资产库构建工具，构建次世代渲染的业务相关的资产；数字孪生对象构建工具，根据业务构建数字孪生业务对象；场景构建工具，添加业务资源和构建业务场景；接口接入与导出工具，根据业务需要业务的功能性接口；二三维数据可视化工具，根据需要通过报表或三维可视化接口展示工具；BIM数据应用展示：直接将BIM数据相关内容进行接入展示。项目配置与发布工具，通过业务引擎进行工程创建和工程发布。**

<img src="Documents/Images/OpenZIProducts.png" alt="OpenZIProducts" style="zoom: 40%;" />

### 系统支持

- C/S架构：Windows、Linux
- 全产品支持信创x86系列银河麒麟、统信UOS系统运行

### 安装

* 拉取主仓库，`5.0`代表虚幻引擎版本分支，可以从分支列表选择自己需要的分支拉取

```
git clone -b 5.0 https://gitee.com/openziproject/OpenZIAPI.git
```

* 然后再初始化和更新依赖的子模块  
  在资源管理器空白处右键  
  ![img_3.png](Documents/Images/img_3.png)
  输入`./gitupdate.bat`，然后按回车  
  ![img_2.png](Documents/Images/img_2.png)

* 在当前项目目录下，安装node依赖包，在终端命令行窗口执行以下命令

```
npm install typescript -g
npm install
```

### 运行

* 右键`.uproject`执行`Generate Visual Studio project files`生成`.sln`项目工程，编译C++代码（`建议使用VS2019`）
* 点击该按钮生成项目的`.d.ts`申明文件

<img src="Documents/Images/img.png" alt="img.png" style="zoom: 67%;" />

* 在项目工程的地址栏输入cmd，然后回车
![img.png](Documents/Images/img4.png)
在弹出的命令行窗口输入tsc，点击回车键，即开始将TypeScript代码编译成JavaScript
![img_1.png](Documents/Images/img5.png)

* 双击执行`ProjectLab/DefaultProject/Script/Web/WebServer.cmd`启动WebServer服务（`Linux`系统下运行`WebServer.sh`）
* 完成之后回到虚幻引擎编辑器，点击`Play`按钮，即可运行

### 云渲染运行

详情请查看`Plugins/OpenZIAPI/Documents/CloudRender/README.md`

### 打包

详情请查看`Build/BatchFiles/README.md`

### 系统功能

**OpenZIAPI功能列表**

- 地形加载
- 影像加载
- 3DTileset加载
- 自定义网页
- 修改场景坐标系
- 管理UE场景关卡
- 控制器（自定义，编辑器，观察者）
- 轴管理（平移，旋转，缩放等）
- 天气调节（气候，时间，云，雾等）
- 标绘系统（点，线，面）
- 打点（自定义样式）
- 报警/预警点位
- 种植（单个，沿线，笔刷）
- 地理围栏
- 三维叠加
- 箭头线
- 光流线
- OD线
- 测量系统（点，线，面）
- 控制台指令
- 镜头漫游
- 可视域分析
- 天际线
- 热力图
- 数值柱状图
- 单值柱状图
- 热力线

**OpenZI插件功能列表**

- OpenZIWebSocket
- OpenZISKY
- OpenZIModelTool
- OpenZIPackAssetLibrary
- OpenZIMaterialSystem
- OpenZIAPIExtend
- OpenZIWebBroswer

### 技术栈

相关技术：UnrealEngine，Puerts，CesiumForUnreal（请遵循相关产品相关协议规则）

开发工具：WebStorm，Visual Studio Code，VisualStudio

### 项目目录

```shell
├─Binaries\
├─Build\
│ ├─BatchFiles [BatchFiles](Build/BatchFiles/README.md)\
├─Content\
│ ├─JavaScript\
│ │ ├─Scripts`Output directory of JS scripts compiled by TS `\
├─DerivedDataCache\
├─Documents\
│ └─ApiDoc `automatic output directory for documents`\
├─Intermediate\
├─node_modules`node dependency module `\
├─Packages`home directory for all packaged files`\
│ ├─Linux `Linux Platform packaging Output Directory`\
│ ├─Windows`Windows Platform Packaging Output Directory `\
├─Plugins`Unreal Project Project Plugin Folder `\
├─ProjectLab \
│ └─DefaultProject [DefaultProject](ProjectLab/README.md)\
├─TSProject\[README.en.md](README.en.md)
│ ├─APITsBase [APITsBase](TSProject/APITsBase/README.md)\
```



### 商用授权
**本说明与您使用（包括成都曾自科技有限公司下产品系列：OpenZIAPI、OpenZIEditor源代码、程序、插件以及文档手册）有关的权利和义务。**

**1、本产品使用了Epic相关技术，请访问 https://www.epicgames.com/privacypolicy ，查阅Epic的《隐私政策》（该政策亦适用于您使用软件的情况），以了解具体做法。您使用软件的情形也受Epic的服务条款的约束，这些条款位于 https://www.epicgames.com/tos 。下载或使用软件，表明您也同意Epic的服务条款，并承认您已阅读了Epic的隐私政策。**

**2、OpenZIAPI和OpenZIEditor开源版本是基于采用Apache2.0协议进行开源。下载或使用软件，或以其他方式表明您接受本协议，即表示您同意接受本公司（成都曾自科技有限公司）相关（源代码、程序、插件以及文档手册）的开源版本Apache2.0协议条款的约束。如果您不或不能同意本协议的条款，请不要下载或使用软件。**

### 贡献代码

**JJCoder、xLin、goderyu、behiever**

### 其他

**1、知识产权：OpenZIAPI、OpenZIEditor采用Apache2.0开源，在商用中需标识“采用”OpenZI数化软件相关技术”。**

**2、欢迎商务合作和项目合作、联合推广以及投资洽谈联系方式参见官网[OpenZI数化软件](http://www.cengzi.com)**