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:
yuding
2026-01-22 11:29:51 +08:00
parent 70523e54e5
commit f2460fb981
103 changed files with 32120 additions and 31434 deletions

View File

@@ -1,6 +1,6 @@
# BIM Engine SDK 使用文档
# iFlow Engine 使用文档
BIM Engine SDK 是一个用于 3D BIM 模型展示的 JavaScript SDK支持原生 HTML、Vue 2/3 和 React 框架。
iFlow Engine 是一个用于 3D BIM 模型展示的 JavaScript SDK支持原生 HTML、Vue 2/3 和 React 框架。
## 目录
@@ -19,19 +19,19 @@ BIM Engine SDK 是一个用于 3D BIM 模型展示的 JavaScript SDK支持原
### NPM 安装(推荐)
```bash
npm install @fishdingding/bim-engine-sdk
npm install iflow-engine
```
### Yarn 安装
```bash
yarn add @fishdingding/bim-engine-sdk
yarn add iflow-engine
```
### PNPM 安装
```bash
pnpm add @fishdingding/bim-engine-sdk
pnpm add iflow-engine
```
### CDN / 本地文件引入
@@ -39,7 +39,7 @@ pnpm add @fishdingding/bim-engine-sdk
如果不使用包管理器,可以直接下载 JS 文件引入:
```html
<script src="./lib/bim-engine-sdk.umd.js"></script>
<script src="./lib/iflow-engine.umd.js"></script>
```
---
@@ -64,7 +64,7 @@ pnpm add @fishdingding/bim-engine-sdk
<div id="app"></div>
<script type="module">
import { BimEngine } from '@fishdingding/bim-engine-sdk';
import { BimEngine } from 'iflow-engine';
// 1. 创建引擎实例
const engine = new BimEngine('app', {
@@ -101,7 +101,7 @@ pnpm add @fishdingding/bim-engine-sdk
<meta charset="UTF-8">
<title>BIM Engine Demo</title>
<!-- 引入 UMD 版本 -->
<script src="https://unpkg.com/@fishdingding/bim-engine-sdk/dist/bim-engine-sdk.umd.js"></script>
<script src="https://unpkg.com/iflow-engine/dist/iflow-engine.umd.js"></script>
<style>
* { margin: 0; padding: 0; box-sizing: border-box; }
html, body { width: 100%; height: 100%; overflow: hidden; }
@@ -200,7 +200,7 @@ window.onload = init;
### 1. 安装
```bash
npm install @fishdingding/bim-engine-sdk
npm install iflow-engine
```
### 2. 组件封装
@@ -213,7 +213,7 @@ npm install @fishdingding/bim-engine-sdk
<script setup>
import { ref, onMounted, onBeforeUnmount } from 'vue';
import { BimEngine } from '@fishdingding/bim-engine-sdk';
import { BimEngine } from 'iflow-engine';
// Props
const props = defineProps({
@@ -352,7 +352,7 @@ const stopMeasure = () => viewerRef.value?.deactivateMeasure();
### 1. 安装
```bash
npm install @fishdingding/bim-engine-sdk
npm install iflow-engine
```
### 2. 组件封装
@@ -364,7 +364,7 @@ npm install @fishdingding/bim-engine-sdk
</template>
<script>
import { BimEngine } from '@fishdingding/bim-engine-sdk';
import { BimEngine } from 'iflow-engine';
export default {
name: 'BimViewer',
@@ -500,7 +500,7 @@ export default {
### 1. 安装
```bash
npm install @fishdingding/bim-engine-sdk
npm install iflow-engine
```
### 2. Hook 封装
@@ -508,7 +508,7 @@ npm install @fishdingding/bim-engine-sdk
```jsx
// hooks/useBimEngine.js
import { useEffect, useRef, useState, useCallback } from 'react';
import { BimEngine } from '@fishdingding/bim-engine-sdk';
import { BimEngine } from 'iflow-engine';
export function useBimEngine(options = {}) {
const containerRef = useRef(null);
@@ -697,7 +697,7 @@ export default App;
#### 构造函数
```javascript
import { BimEngine } from '@fishdingding/bim-engine-sdk';
import { BimEngine } from 'iflow-engine';
new BimEngine(container, options)
```
@@ -818,5 +818,5 @@ engine.on('modelLoaded', (data) => {
## 技术支持
- NPM 包地址https://www.npmjs.com/package/@fishdingding/bim-engine-sdk
- NPM 包地址https://www.npmjs.com/package/iflow-engine
- 如有问题,请联系技术支持

View File

@@ -20,7 +20,7 @@
- 采用延迟初始化模式,需要用户主动调用 `init()` 方法
### 1.3 第三方 SDK 依赖
- 依赖 `src/bim-engine-sdk.es.js` 中的 `createEngine` 函数
- 依赖 `iflow-engine-base` npm 包中的 `createEngine` 函数
- 通过依赖注入方式使用,不直接导入
---
@@ -396,7 +396,7 @@ public setTheme(theme: ThemeConfig): void {
### 9.1 基本使用(通过 EngineManager
```typescript
import { BimEngine } from 'bim-engine-sdk';
import { BimEngine } from 'iflow-engine';
const engine = new BimEngine('container');
@@ -539,9 +539,9 @@ function updateEngineBackground(engine: any, color: number): void {
- 不抛出未捕获的异常
7. **第三方 SDK 依赖**:
- 依赖 `bim-engine-sdk.es.js` 文件
- 通过动态导入或全局变量访问
- 需要确保 SDK 文件已加载
- 依赖 `iflow-engine-base` npm 包
- 通过 npm 包导入
- 需要确保依赖已安装
---
@@ -579,7 +579,7 @@ interface ModelLoadOptions {
- `src/components/engine/index.ts` - 主组件类
- `src/components/engine/types.ts` - 类型定义
- `src/managers/engine-manager.ts` - 管理器类
- `src/bim-engine-sdk.es.js` - 第三方 SDK依赖
- `iflow-engine-base` - 第三方 SDKnpm 依赖)
### 12.2 依赖文件

View File

@@ -640,7 +640,7 @@ public setTheme(theme: ThemeConfig) {
### 9.1 基本使用(通过 Manager
```typescript
import { BimEngine } from 'bim-engine-sdk';
import { BimEngine } from 'iflow-engine';
const engine = new BimEngine('container');

View File

@@ -921,7 +921,7 @@ label.textContent = t(button.label);
### 9.1 基本使用(通过 ButtonGroupManager
```typescript
import { BimEngine } from 'bim-engine-sdk';
import { BimEngine } from 'iflow-engine';
const engine = new BimEngine('container');

View File

@@ -116,7 +116,7 @@ new BimDescription({
**组件内部不进行翻译**。调用者应在传入 `label` 之前使用 `t()` 函数进行翻译。
```typescript
import { t } from 'bim-engine-sdk/services/locale';
import { t } from 'iflow-engine/services/locale';
new BimDescription({
// ...