mxdraw 0.0.13 → 0.0.14

package/dist/types/MxModule/MxDrawObject/MxDrawObject.d.ts

@@ -115,7 +115,17 @@ export default class MxDrawObject {
      * Mx.MxFun.getCurrentDraw().addObject(new THREE.Object3D(), false)
      * ```
      */
-    addObject(obj: THREE.Object3D | null, isAddToSelect?: boolean): void;
+    addObject(obj: THREE.Object3D, isAddToSelect?: boolean): void;
+    /**
+     * 添加THREE.Object3D对象到视区场景，对象坐标系是窗口视区坐标系。0,0点在左下角.
+     * @param obj THREE.Object3D
+     * @returns void
+     * @example
+     * ```typescript
+     * Mx.MxFun.getCurrentDraw().addViewObject(new THREE.Object3D())
+     * ```
+     */
+    addViewObject(obj: THREE.Object3D): void;
     /**
      * 删除addObject函数添加的THREE.Object3D对象
      * @param obj THREE.Object3D
@@ -198,7 +208,7 @@ export default class MxDrawObject {
      * Mx.MxFun.getCurrentDraw().addEvent("addResizeEvent", ()=> {})
      * Mx.MxFun.getCurrentDraw().addEvent("viewchange", ()=> {})
      * 视区重绘事件.
-     * Mx.MxFun.getCurrentDraw().addEvent("render", ()=> {})
+     * Mx.MxFun.getCurrentDraw().addEvent("render", (renderer)=> {})
      * 视区大小被修改事件.,viewsize={viewWidth:viewWidth,viewHeight:viewHeight}
      * Mx.MxFun.getCurrentDraw().addEvent("viewsizechange", (viewsize)=> {})
      * ```

package/dist/types/MxModule/MxThreeJS/MxThreeJS.d.ts

@@ -1,26 +1,62 @@
-/** @module MxThreeJS */
 import { Vector3, Line, Object3D, Points, Sprite, Mesh, MeshBasicMaterial, Color } from 'three';
 /**
  * MxThreeJS 模块
+ * ##### 使用说明:
+ *
+ * > 基于three.js实现创建直线对象、加载图片、SVG等功能，以下是使用的流程:
+ * - 模块中大部分方法返回的{@link http://www.yanhuangxueyuan.com/threejs/docs/index.html#api/zh/core/Object3D | THREE.Object3D}类型继承创建的对象都可以通过取点对象{@link MrxDbgUiPrPointClass.value} 得到鼠标对应位置
+ * - {@link MrxDbgUiPrPointClass.go}和{@link MrxDbgUiPrPointClass.goWhile}方法监听鼠标点击事件回调中通过
+ * - {@link MxDrawObject.addObject} 方法添加到场景{@link MxDrawObject.getScene}中
+ * - 最后调用{@link MxFun.updateDisplay} 更新视图显示完成
+ *
+ * > 提示: 在实际开发中MxThreeJS是配合着{@link MxDrawObject} 和 {@link MrxDbgUiPrPointClass} 完成绘制线段、文字、图片等功能,当然你也可以使用{@link http://www.yanhuangxueyuan.com/threejs/docs/index.html | three.js}来完成MxThreeJS模块的这些工作
+ *
+ * > 该模块导出库时已实例化为对象，只需要调用实例方法 例如：
  *
- * 导出库时已实例化为对象，只需要调用实例方法 例如：
  * ```typescript
- *  Mx.MxThreeJS.createLine
+ * // html
+ * <button id="line">line</button>
+ *
+ * // js
+ * import Mx from "mxdraw"
+ * import Three from "three"
+ * Mx.useCoreCode().then(()=> {
+ *  Mx.MxFun.setMxServer()
+ *  Mx.MxFun.createMxObject({
+ *    callback(mxDraw, dom) {
+ *      document.getElementById("line").onclick = ()=> {
+ *       const getPoint = new Mx.MrxDbgUiPrPointClass()
+ *       let lastPt, isLine
+ *       getPoint.goWhile(()=> {
+ *         const pt1 = getPoint.value()
+ *         if(isLine) {
+ *              const line = Mx.MxThreeJS.createLine(pt1, lastPt, 0xffffff)
+ *              const currentDraw = Mx.MxFun.getCurrentDraw()
+ *              currentDraw.addObject(line)
+ *              Mx.MxFun.updateDisplay()
+ *          }
+ *          lastPt = pt1.clone()
+ *          isLine = !isLine
+ *       })
+ *      }
+ *    }
+ * })
+ * })
  * ```
  */
 export default class MxThreeJS {
     /**
      * 创建Three.js直线对象。
-     * @param vPt1 THREE.Vector3 点1
-     * @param vPt1 THREE.Vector3 点2
-     * @param iColor 颜色
-     * @returns THREE.Line
+     * @param vPt1  {@link http://www.yanhuangxueyuan.com/threejs/docs/index.html#api/zh/math/Vector3 | THREE.Vector3} 点1
+     * @param vPt2  {@link http://www.yanhuangxueyuan.com/threejs/docs/index.html#api/zh/math/Vector3 | THREE.Vector3} 点2
+     * @param iColor 颜色Color
+     * @returns  {@link http://www.yanhuangxueyuan.com/threejs/docs/index.html#api/zh/objects/Line |THREE.Line}
      * @example
      * ```typescript
      * Mx.MxThreeJS.createLine(new Three.Vector3(1,10,0), new Three.Vector3(1,300,0), 0)
      * ```
      */
-    createLine(vPt1: Vector3, vPt2: Vector3, iColor: number): Line;
+    createLine(vPt1: Vector3, vPt2: Vector3, iColor: Color | number | string): Line;
     /**
      * 创建Three.js圆对象。
      * @param mCenterPt 圆中心点
@@ -32,7 +68,7 @@ export default class MxThreeJS {
      * Mx.MxThreeJS.createCircle(new Three.Vector3(1,10,0), 10, 0)
      * ```
      */
-    createCircle(mCenterPt: Vector3, dRadius: number, iColor: number): Object3D;
+    createCircle(mCenterPt: Vector3, dRadius: number, iColor: Color | number | string): Object3D;
     /**
      * 创建Three.js点对象。
      * @param mPt 点位置
@@ -43,7 +79,7 @@ export default class MxThreeJS {
      * Mx.MxThreeJS.createPoint(new Three.Vector3(1,10,0), 0)
      * ```
      */
-    createPoint(mPt: Vector3, iColor: number): Points;
+    createPoint(mPt: Vector3, iColor: Color | number | string): Points;
     /**
      * 创建Three.js 文字
      * @param message 文字信息
@@ -57,7 +93,7 @@ export default class MxThreeJS {
      * Mx.MxThreeJS.creatTextSprite("hello",new Three.Vector3(1,10,0), 90, 60, 0)
      * ```
      */
-    creatTextSprite(message: string, pt: Vector3, iSize: number, fAngle: number, iColor: number): Sprite | null;
+    creatTextSprite(message: string, pt: Vector3, iSize: number, fAngle: number, iColor: Color | number | string): Sprite | null;
     /**
      * 根据三角形数组，创建Three.js Mesh
      * @param points 由三个点组成的数组
@@ -73,7 +109,7 @@ export default class MxThreeJS {
      * )
      * ```
      */
-    createTriangle(points: Array<Vector3>, iColor: number, opacity?: number): Mesh | null;
+    createTriangle(points: Array<Vector3>, iColor: Color | number | string, opacity?: number): Mesh | null;
     /**
      * 创建连续直线
      * @param points 由多个点组成的数组
@@ -84,7 +120,7 @@ export default class MxThreeJS {
      * Mx.MxThreeJS.createLines([new THREE.Vector3(1,2,2),new THREE.Vector3(1,65,4),new THREE.Vector3(12,2,2)], 0)
      * ```
      */
-    createLines(points: Array<Vector3>, iColor: number): Line;
+    createLines(points: Array<Vector3>, iColor: Color | number | string): Line;
     /**
      * 创建虚线
      * @param points 由多个点组成的数组
@@ -97,7 +133,7 @@ export default class MxThreeJS {
      * Mx.MxThreeJS.createDashedLines([new THREE.Vector3(1,2,2),new THREE.Vector3(1,65,4),new THREE.Vector3(12,2,2)], 10, 20, 2)
      * ```
      */
-    createDashedLines(points: Array<Vector3>, iColor: number, dashSize: number, gapSize: number): Line;
+    createDashedLines(points: Array<Vector3>, iColor: Color | number | string, dashSize: number, gapSize: number): Line;
     /**
      * 创建Image
      * @param pos 图片位置
@@ -113,7 +149,7 @@ export default class MxThreeJS {
      * })
      * ```
      */
-    createImage: (pos: Vector3, w: number, h: number, imageUrlPath: string, callResult: (mesh: Mesh | null) => void) => void;
+    createImage(pos: Vector3, w: number, h: number, imageUrlPath: string, callResult?: (mesh: Mesh | null) => void): void;
     /**
      * 加载SVG
      * @param url SVG路径地址
@@ -130,5 +166,5 @@ export default class MxThreeJS {
      * })
      * ```
      */
-    loadSVG: (url: string, x: number, y: number, scale: number, color: Color | undefined | null, callResult: (threeobj: Object3D, aryMeterial: Array<MeshBasicMaterial>) => void) => void;
+    loadSVG(url: string, x: number, y: number, scale: number, color?: Color | number | string, callResult?: (threeobj: Object3D, aryMeterial: Array<MeshBasicMaterial>) => void): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mxdraw",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "description": "",
   "keywords": [],
   "main": "dist/mxdraw.umd.js",
@@ -26,7 +26,7 @@
     "prebuild": "rimraf dist",
     "build": "tsc --module commonjs && rollup -c rollup.config.ts && typedoc --out docs",
     "oldDocs": "typedoc --out docs --target es6 --theme minimal --mode file src",
-    "docs": "npm run doctoc && typedoc --out docs",
+    "docs": "npm run patch && npm run doctoc && typedoc --out docs",
     "start": "rollup -c rollup.config.ts -w",
     "test": "jest --coverage",
     "test:watch": "jest --coverage --watch",
@@ -68,7 +68,7 @@
   },
   "devDependencies": {
     "@babel/core": "^7.16.0",
-    "@babel/preset-env": "^7.16.4",
+    "@babel/preset-react": "^7.16.5",
     "@commitlint/cli": "^7.1.2",
     "@commitlint/config-conventional": "^7.1.2",
     "@rollup/plugin-alias": "^3.1.8",