mx3d 2024.1.22 → 2024.6.2-8.1

package/docs/project/projectmgr.md

@@ -0,0 +1,64 @@
+## 场景加载
+
+初始化 mx3d
+
+```javascript
+//设置开发者Token
+MX3D.accessToken = '开发者Token'
+var container = document.getElementById('container') //场景挂载节点
+var sl = 'https://www.wodashijie.com/' //SDK服务地址；可为空，默认为："https://www.wodashijie.com/"。离线部署SDK时才需要改
+var sl = 'https://models.wodashijie.com/' //模型库服务地址；可为空，默认为："https://models.wodashijie.com/"。离线部署SDK时才需要改
+//初始化引擎
+app = new MX3D.App({ container: container, sl: sl, rl: rl })
+```
+
+加载指定场景
+
+```javascript
+app.load({
+  pk: '场景编号', //场景编号;离线开发环境不用设置
+  isDefaultLevel: true, //是否显示默认层级
+  isDefaultMutual: true, //是否启用默认交互模式
+  progress: (_x) => {
+    //加载进度
+    console.log(_x)
+  },
+  complete: () => {
+    ///加载完成
+    console.log('加载完成')
+    console.log(parseInt(new Date().getTime() - _t) / 1000)
+  },
+  onError: (e) => {
+    //加载错误回调
+    console.log(e)
+  },
+})
+```
+
+等待场景加载完之后、即可通过 app 对象操作场景内对象，如设置场景背景颜色
+
+```javascript
+//rgba(0-1);
+app.environment.color = { r: 1, g: 0.0588, b: 0.1176, a: 1 }
+```
+
+## 清除场景
+
+用于清除当前场景、使用销毁后可再次执行 load 方法以加载其它场景、而无需重新初始化引擎
+
+```javascript
+app.project.clear()
+```
+
+## 销毁场景
+
+```javascript
+app.dispose()
+```
+
+## 获取指定层级下的对象类型
+
+```javascript
+//_parentId父级编号，可为空，为空则获取整个场景类型
+var types = app.project.getCustomTypes(((_parentId: string) = null))
+```

package/docs/releases.md

@@ -0,0 +1,128 @@
+### 更新说明
+
+除版本记录中备注外，迭代版本皆可直接升级，不影响旧版本 API 及功能
+
+#### 2024.06.27
+
+**重要更新**
+
+- 修复获取场景树不全问题
+- 修复切换楼层原楼层不消失问题
+
+---
+
+#### 2024.06.04
+
+**重要更新**
+
+- 支持多个版本的场景解析
+
+---
+
+#### 2024.05.28
+
+**重要更新**
+
+- 我搭世界升级，在线开发必须更新此版本
+
+---
+
+#### 2024.01.22
+
+---
+
+#### 2023.8.28
+
+**主要更新**
+
+- 修复添加鼠标经过事件不生效问题
+
+---
+**主要更新**
+
+- 修复网格图标文字设置不生效问题。去除构造函数createIconFromMesh指定背景图片路径参数
+- 网格图标添加设置背景图片方法：[setBackground(_url: string)](/gui/3D?id=设置背景)
+- 修改app.cameraController相机操作类名称为：app.camera
+- 新增相机自动旋转API：[自动旋转](/gui/3D?id=设置背景)
+- 新增机柜内设备颜色参数：[设置设备颜色](/cabinet/cabinet?id=生成机柜内设备)
+- 修复容量统计柱位置错位问题、修复容量统计数值错位问题
+- 修复双击事件不生效问题
+
+---
+
+#### 2023.7.7
+
+**主要更新**
+
+- 添加加载错误回调方法
+
+---
+
+#### 2023.7.4
+
+**主要更新**
+
+- 修复柜内设备从告警闪烁设置正常时模型消失问题
+- 修改版本号规则，以发版更新日期为当前版本号
+
+---
+
+#### 0.6.6
+
+**主要更新**
+
+- 修复加载机柜设备的一些问题
+
+---
+
+#### 0.6.5
+
+**主要更新**
+
+- 修复某些对象闪烁不起效果问题
+
+---
+
+#### 0.6.1
+
+**主要更新**
+
+- 一些优化
+
+---
+
+#### 0.6.0
+
+**主要更新**
+
+- 增加加载[机柜内设备](/cabinet/cabinet?id=生成机柜内设备)功能
+
+---
+
+#### 0.5.2
+
+**主要更新**
+
+- 光照贴图功能
+
+---
+
+#### 0.5.1
+
+**主要更新**
+
+- 新增相机[飞向物体](/camera?id=飞向物体)方法
+- 新增相机[看向物体正面](/camera?id=看向物体正面)方法方法
+
+---
+
+#### 0.5.0
+
+**主要更新**
+
+- 优化 sdk 代码，减少 sdk 库文件大小
+- 删除库文件：mx3d.loaders.min.js
+
+备注：旧版本可直接升级，删除 mx3d.loaders.min.js 引用，并使用最新的库文件即可。不影响其他功能。
+
+---

package/docs/started/environment.md

@@ -0,0 +1,103 @@
+## 灯光强度
+
+```javascript
+app.environment.setLightIntensity(0.8)
+```
+
+## 背景颜色
+
+```javascript
+//rgba(0-1);
+app.environment.color = { r: 1, g: 0.0588, b: 0.1176, a: 1 }
+```
+
+## 背景图片
+
+```javascript
+//图表url
+app.environment.setBackground('./res/bg.png')
+```
+
+## 背景透明度设置
+
+```javascript
+//0-1
+app.environment.setTransparent(0)
+```
+
+## 场景反射
+
+```javascript
+app.environment.reflex('./res/environment.env', 0.5)
+```
+
+## 显示 fps（帧率）
+
+```javascript
+//css样式、可设置帧率图标样式；可为空；
+app.environment.showFps('font-size: 10px;')
+```
+
+## 隐藏 fps（帧率）
+
+```javascript
+app.environment.hideFps()
+```
+
+### 示例
+
+<div id="container" style="width: 100%;height: 500px;position: relative;">
+<div style="position: absolute;top: 20px;left: 20px;width: 180px;z-index: 5;" class="btn-group-vertical" role="group">
+<div class="input-group">
+  <input type="text" class="form-control" value="1" id="lightIntensity" aria-describedby="basic-addon2">
+  <span class="input-group-addon" id="but_setLightIntensity" id="basic-addon2">灯光强度</span>
+</div>
+  <button type="button" id="but_back" class="btn btn-default">背景图片</button>
+  <button type="button" id="but_setTransparent" class="btn btn-default">背景透明</button>
+  <button type="button" id="but_showFps" class="btn btn-default">显示帧率</button>
+  <button type="button" id="but_hideFps" class="btn btn-default">关闭帧率</button>
+</div>
+</div>
+
+<script>
+   MX3D.accessToken = "0498A36E67B5ED17E7A7B23D0AC4ACB2E1D6DE1209A0C0894BA0B6973C606201DDCEF2EACFE268AB31FBE04616680A3F453EA85544AE248BA2B115141E029B13C3C90718BA0F15AE6A78BA9F3D70C41650FA4EDDC64D1DEFE5CBA2767EC3A52B347393871ACAC3FF01DF62EAF2F0AEB93578E90EB1F3B7B0793949E88BB4AF1EBB9AA0B0635B93738EC96287638F8716DD6FAC6087C8C8BE4F674F3853042BC60E391D9F5D54";
+   app = new MX3D.App({
+     container: document.getElementById("container")
+    });
+   app.load({
+        pk: "9a0b0f36-f283-49b5-b964-9a3bc630abda",
+        // isDefaultLevel:false,
+        progress: (_x) => { //加载进度
+          console.log(_x)
+        },
+        complete:()=>{ ///加载完成
+          console.log("加载完成");
+         //  console.log(parseInt(new Date().getTime() - _t) / 1000);
+        }
+  });
+
+  $("#but_setLightIntensity").click(function(){
+     //图表url
+     var Intensity=  $("#lightIntensity").val();
+     app.environment.setLightIntensity(Intensity);
+  });
+
+  $("#but_back").click(function(){
+     //图表url
+     app.environment.setBackground('https://models.wodashijie.com/texture/0120eb873ef243318186d36cfae0506e.png');
+  });
+
+  $("#but_showFps").click(function(){
+     //图表url
+     app.environment.showFps();
+  });
+
+  $("#but_hideFps").click(function(){
+     //图表url
+     app.environment.hideFps();
+  });
+  $("#but_setTransparent").click(function(){
+     //图表url
+     app.environment.setTransparent(0);
+  });
+</script>

package/docs/started/quickstart.md

@@ -0,0 +1,112 @@
+# npm 安装
+
+推荐使用 npm 的方式安装，它能更好地和 webpack 打包工具配合使用。
+
+```js
+  npm i mx3d
+```
+
+采用 nodejs 开发时，需配置 webpack 排除 mx3d 打包进工程代码
+
+# CDN
+
+目前可以通过 [unpkg.com/mx3d](https://unpkg.com/mx3d/) 获取到最新版本的资源，在页面上引入 js 文件即可开始使用。
+
+```js
+<!-- 引入组件库 -->
+    <script src="https://www.unpkg.com/mx3d/mx3d.seat.min.js"></script>
+    <script src="https://www.unpkg.com/mx3d/mx3d.min.js"></script>
+```
+
+我们建议使用 CDN 引入 mx3d 的用户在链接地址上锁定版本，以免将来 mx3d 升级时受到非兼容性更新的影响。锁定版本的方法请查看 [unpkg.com](https://unpkg.com/)。
+
+# Hello mx3djs
+
+通过 CDN 的方式我们可以很容易地使用 mx3d 写出一个 Hello mx3djs 页面。
+<!-- [在线演示](http://docs.wodashijie.com/script?scrId=5939cb6568424d7d8821ece31420966b) -->
+
+```html
+<!DOCTYPE html>
+<html lang="zh-CN" data-theme="dark">
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="renderer" content="webkit" />
+    <meta
+      name="viewport"
+      content="width=1920,user-scalable=no, viewport-fit=cover"
+    />
+    <style>
+      * {
+        margin: 0;
+        padding: 0;
+      }
+
+      html,
+      body {
+        width: 100%;
+        height: 100%;
+        margin: 0;
+        padding: 0;
+        overflow: hidden;
+      }
+
+      #container {
+        width: 100%;
+        height: 100%;
+      }
+    </style>
+    <script src="https://www.unpkg.com/mx3d/mx3d.seat.min.js"></script>
+    <script src="https://www.unpkg.com/mx3d/mx3d.min.js"></script>
+    <title>Hello world</title>
+  </head>
+  <body>
+    <div id="container"></div>
+    <!-- built files will be auto injected -->
+  </body>
+  <script>
+    //设置开发者Token
+    MX3D.accessToken = '开发者Token'
+    var container = document.getElementById('container')
+    //初始化引擎
+    app = new MX3D.App({ container: container })
+    //加载场景
+    app.load({
+      pk: '场景编号', //场景编号
+      progress: (_x) => {
+        //加载进度
+        console.log(_x)
+      },
+      complete: () => {
+        ///加载完成
+        console.log('加载完成')
+        console.log(parseInt(new Date().getTime() - _t) / 1000)
+      },
+    })
+  </script>
+</html>
+```
+
+### 示例
+
+<div id="container" style="width: 100%;height: 500px;position: relative;"></div>
+
+<script>
+   MX3D.accessToken = "0498A36E67B5ED17E7A7B23D0AC4ACB2E1D6DE1209A0C0894BA0B6973C606201DDCEF2EACFE268AB31FBE04616680A3F453EA85544AE248BA2B115141E029B13C3C90718BA0F15AE6A78BA9F3D70C41650FA4EDDC64D1DEFE5CBA2767EC3A52B347393871ACAC3FF01DF62EAF2F0AEB93578E90EB1F3B7B0793949E88BB4AF1EBB9AA0B0635B93738EC96287638F8716DD6FAC6087C8C8BE4F674F3853042BC60E391D9F5D54";
+   app = new MX3D.App({
+     container: document.getElementById("container")
+    });
+   app.load({
+        pk: "9a0b0f36-f283-49b5-b964-9a3bc630abda",
+        // isDefaultLevel:false,
+        // isDefaultMutual:true,
+        progress: (_x) => { //加载进度
+          console.log(_x)
+        },
+        complete:()=>{ ///加载完成
+          console.log("加载完成");
+          // console.log(app.Project.getSceneTree());
+          // console.log(parseInt(new Date().getTime() - _t) / 1000);
+        }
+  });
+</script>