refactor: 重命名SDK为iflow-engine,使用npm包引入第三方引擎
- 将包名从 @fishdingding/bim-engine-sdk 改为 iflow-engine - 将构建输出文件从 bim-engine-sdk.*.js 改为 iflow-engine.*.js - 将全局变量从 LyzBimEngineSDK 改为 IflowEngine - 将第三方引擎SDK从本地引入改为npm包引入 (iflow-engine-base) - 移除本地 src/engine_base 目录,移至回收站 - 更新所有文档和demo中的引用
This commit is contained in:
36
README.md
36
README.md
@@ -1,4 +1,4 @@
|
||||
# BIM Engine SDK
|
||||
# iFlow Engine
|
||||
|
||||
> 一个功能强大的 BIM(建筑信息模型)引擎 SDK,提供 3D 可视化、构件管理、测量工具、剖切功能和漫游控制等完整功能。支持 Vue 2、Vue 3、React 和原生 HTML 等多种前端框架。
|
||||
|
||||
@@ -21,14 +21,14 @@
|
||||
## 📦 安装
|
||||
|
||||
```bash
|
||||
npm install bim-engine-sdk
|
||||
npm install iflow-engine
|
||||
```
|
||||
|
||||
或使用 yarn/pnpm:
|
||||
|
||||
```bash
|
||||
yarn add bim-engine-sdk
|
||||
pnpm add bim-engine-sdk
|
||||
yarn add iflow-engine
|
||||
pnpm add iflow-engine
|
||||
```
|
||||
|
||||
## 🚀 快速开始
|
||||
@@ -42,7 +42,7 @@ pnpm add bim-engine-sdk
|
||||
|
||||
<script setup lang="ts">
|
||||
import { ref, onMounted, onUnmounted } from 'vue';
|
||||
import { BimEngine } from 'bim-engine-sdk';
|
||||
import { BimEngine } from 'iflow-engine';
|
||||
|
||||
const containerRef = ref<HTMLElement>();
|
||||
let bimEngine: BimEngine | null = null;
|
||||
@@ -93,7 +93,7 @@ onUnmounted(() => {
|
||||
|
||||
```tsx
|
||||
import { useEffect, useRef } from 'react';
|
||||
import { BimEngine } from 'bim-engine-sdk';
|
||||
import { BimEngine } from 'iflow-engine';
|
||||
|
||||
function App() {
|
||||
const containerRef = useRef<HTMLDivElement>(null);
|
||||
@@ -150,10 +150,10 @@ export default App;
|
||||
<div id="container"></div>
|
||||
|
||||
<!-- 使用 UMD 版本 -->
|
||||
<script src="./node_modules/bim-engine-sdk/dist/bim-engine-sdk.umd.js"></script>
|
||||
<script src="./node_modules/iflow-engine/dist/iflow-engine.umd.js"></script>
|
||||
<script>
|
||||
const container = document.getElementById('container');
|
||||
const bimEngine = new BimEngineSdk.BimEngine(container, {
|
||||
const bimEngine = new IflowEngine.BimEngine(container, {
|
||||
locale: 'zh-CN',
|
||||
theme: 'dark'
|
||||
});
|
||||
@@ -229,7 +229,7 @@ BIM Engine SDK 采用 **管理器模式 (Manager Pattern)** 作为核心架构,
|
||||
## 📁 项目结构
|
||||
|
||||
```
|
||||
bim-engine-sdk/
|
||||
iflow-engine/
|
||||
├── src/ # 源代码
|
||||
│ ├── bim-engine.ts # 主引擎类
|
||||
│ ├── index.ts # 入口文件
|
||||
@@ -271,8 +271,8 @@ bim-engine-sdk/
|
||||
│ │ └── icon-manager.ts # 图标管理器
|
||||
│ └── assets/ # 静态资源
|
||||
├── dist/ # 构建产物
|
||||
│ ├── bim-engine-sdk.es.js # ESM 格式
|
||||
│ ├── bim-engine-sdk.umd.js # UMD 格式
|
||||
│ ├── iflow-engine.es.js # ESM 格式
|
||||
│ ├── iflow-engine.umd.js # UMD 格式
|
||||
│ └── index.d.ts # TypeScript 类型定义
|
||||
├── demo/ # HTML Demo
|
||||
├── demo-vue/ # Vue Demo
|
||||
@@ -437,8 +437,8 @@ npm run dev:demo-vue
|
||||
|
||||
运行 `npm run build` 后,会在 `dist/` 目录生成:
|
||||
|
||||
- `bim-engine-sdk.es.js` - ESM 格式 (用于现代打包工具)
|
||||
- `bim-engine-sdk.umd.js` - UMD 格式 (用于浏览器直接引入)
|
||||
- `iflow-engine.es.js` - ESM 格式 (用于现代打包工具)
|
||||
- `iflow-engine.umd.js` - UMD 格式 (用于浏览器直接引入)
|
||||
- `index.d.ts` - TypeScript 类型定义
|
||||
- `*.css` - 样式文件 (已内联注入到 JS 中)
|
||||
|
||||
@@ -446,14 +446,14 @@ npm run dev:demo-vue
|
||||
|
||||
```json
|
||||
{
|
||||
"main": "./dist/bim-engine-sdk.umd.js",
|
||||
"module": "./dist/bim-engine-sdk.es.js",
|
||||
"main": "./dist/iflow-engine.umd.js",
|
||||
"module": "./dist/iflow-engine.es.js",
|
||||
"types": "./dist/index.d.ts",
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist/index.d.ts",
|
||||
"import": "./dist/bim-engine-sdk.es.js",
|
||||
"require": "./dist/bim-engine-sdk.umd.js"
|
||||
"import": "./dist/iflow-engine.es.js",
|
||||
"require": "./dist/iflow-engine.umd.js"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -544,7 +544,7 @@ ISC License
|
||||
|
||||
如有问题或建议,请通过以下方式联系:
|
||||
|
||||
- 提交 [Issue](https://github.com/your-repo/bim-engine-sdk/issues)
|
||||
- 提交 [Issue](https://github.com/your-repo/iflow-engine/issues)
|
||||
- 发送邮件至 your-email@example.com
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user