mxdraw 0.0.1 → 0.0.2

package/dist/mxdraw.es5.js

@@ -10953,7 +10953,32 @@ function createCavansParent(canvas) {
     return canvasParent;
 }
 
+/**
+ * JS对象方法代理
+ * @param obj 代理对象
+ * @param proxyObj 需要代理的对象
+ * @param name 需要代理的方法属性名称
+ *
+ */
+function objectMethodProxy(obj, proxyObj, name) {
+    Object.defineProperty(obj, name, {
+        get: function () {
+            return proxyObj[name];
+        }
+    });
+}
+
 var _mxdrawObj;
+/**
+ * 引入mxdraw库不会挂载MxDrawObject 只能在以下特定函数中获取
+ * @function
+ * {@link MxFun.createMxObject}中callback回调参数`mxDraw`的构造类
+ * @function
+ * {@link MxFun.getCurrentDraw} 方法返回值的构造类
+ * @function
+ * {@link MxFun.getCurrentMxCAD} 方法返回值的构造类
+ *
+ */
 var MxDrawObject = /** @class */ (function () {
     function MxDrawObject(Mxdraw) {
         _mxdrawObj = Mxdraw;
@@ -10972,6 +10997,13 @@ var MxDrawObject = /** @class */ (function () {
     MxDrawObject.prototype.getCamera = function () {
         return _mxdrawObj.getCamera();
     };
+    /**
+     * 获取Three renderer渲染器
+     * @returns THREE.WebGLRenderer
+     */
+    MxDrawObject.prototype.getRenderer = function () {
+        return _mxdrawObj.renderer;
+    };
     /**
      * 设置鼠标按下是否旋视区
      * @param isRotate  是否旋视区
@@ -11194,14 +11226,18 @@ var MxDrawObject = /** @class */ (function () {
 
 var _MxFun;
 var _mxdrawObj$1;
+/**
+ * MxFun 模块
+ * 导入库时已实例化，只需要调用实例方法 例如：
+ * ```typescript
+ *  Mx.MxFun.createMxObject
+ * ```
+ */
 var MxFun = /** @class */ (function () {
     function MxFun(mxFun) {
         _MxFun = mxFun;
-        Object.defineProperty(this, 'acutPrintf', {
-            get: function () {
-                return _MxFun.acutPrintf;
-            }
-        });
+        // 对象方法代理
+        objectMethodProxy(this, _MxFun, 'acutPrintf');
     }
     /**
      * 创建图纸展示控件实例
@@ -60960,6 +60996,13 @@ function formatString(str) {
     return str;
 }
 
+/**
+ * MxThreeJS 模块
+ * 导入库时已实例化，只需要调用实例方法 例如：
+ * ```typescript
+ *  Mx.MxThreeJS.createLine
+ * ```
+ */
 var MxThreeJS = /** @class */ (function () {
     function MxThreeJS() {
     }
@@ -112679,12 +112722,21 @@ function MxThreeJSMixin (MxThreeJS) {
 }
 
 var _McEdGetPointWorldDraw;
-// 创建动态绘制回调对象
+/**
+ * McEdGetPointWorldDrawObjectClass 用于构建一个动态绘制回调对象
+ * ```typescript
+ *  new Mx.McEdGetPointWorldDrawObjectClass()
+ * ```
+ */
 var McEdGetPointWorldDrawObjectClass = /** @class */ (function () {
     function McEdGetPointWorldDrawObjectClass() {
         _McEdGetPointWorldDraw = new (_MxFun$1
             .getMxJigCmdManager()
             .McEdGetPointWorldDrawObjectClass())();
+        /** @internal */
+        this._get = function () {
+            return _McEdGetPointWorldDraw;
+        };
     }
     /**
      * 绘制圆
@@ -112745,9 +112797,7 @@ var McEdGetPointWorldDrawObjectClass = /** @class */ (function () {
     };
     /**
      * 设置动态绘制回调函数。
-     * @callback call 回调函数
-     * @param currentPoint 回调参数 当前位置
-     * @param pWorldDraw 回调参数 文档绘制对象 McEdGetPointWorldDrawObject
+     * @param call 回调函数 currentPoint 回调参数 当前位置 pWorldDraw 回调参数文档绘制对象
      * @returns void
      * @example
      * ``` typescript
@@ -112755,19 +112805,47 @@ var McEdGetPointWorldDrawObjectClass = /** @class */ (function () {
      *
      * })
      * ```
-     *
      */
     McEdGetPointWorldDrawObjectClass.prototype.setDraw = function (call) {
         return _McEdGetPointWorldDraw.setDraw(call);
     };
-    // 获取真正的实例
-    McEdGetPointWorldDrawObjectClass.prototype._get = function () {
-        return _McEdGetPointWorldDraw;
-    };
     return McEdGetPointWorldDrawObjectClass;
 }());
 
 var _MrxDbgUiPrPoint;
+/**
+ * MrxDbgUiPrBaseReturn枚举
+ * @description
+ * 用于适配{@link MrxDbgUiPrPointClass.go} 和 {@link MrxDbgUiPrPointClass.goWhile} 方法中的回调参数`status`
+ * @example
+ * ```
+ * const Point = new Mx.MrxDbgUiPrPointClass()
+ * Point.go((status)=> {
+ *  if(Mx.MrxDbgUiPrBaseReturn.kCancel === status) {
+ *    // 取消
+ *  }
+ * })
+ *
+ * ```
+ * @enum
+ * */
+var MrxDbgUiPrBaseReturn;
+(function (MrxDbgUiPrBaseReturn) {
+    /** 取消 */
+    MrxDbgUiPrBaseReturn[MrxDbgUiPrBaseReturn["kCancel"] = -2] = "kCancel";
+    /** 空输入，当输入关键字和实体时会返回此值 */
+    MrxDbgUiPrBaseReturn[MrxDbgUiPrBaseReturn["kNone"] = -1] = "kNone";
+    /** 获取用户输入成功 */
+    MrxDbgUiPrBaseReturn[MrxDbgUiPrBaseReturn["kOk"] = 0] = "kOk";
+    /** 用户输入了关键字*/
+    MrxDbgUiPrBaseReturn[MrxDbgUiPrBaseReturn["kKeyWord"] = 1] = "kKeyWord";
+})(MrxDbgUiPrBaseReturn || (MrxDbgUiPrBaseReturn = {}));
+/**
+ * MrxDbgUiPrPointClass 用于构建一个取点对象
+ * ```typescript
+ *  new Mx.MrxDbgUiPrPointClass()
+ * ```
+ */
 var MrxDbgUiPrPointClass = /** @class */ (function () {
     function MrxDbgUiPrPointClass() {
         _MrxDbgUiPrPoint = new (_MxFun$1.getMxJigCmdManager().getMrxDbgUiPrPointClass())();
@@ -112819,11 +112897,11 @@ var MrxDbgUiPrPointClass = /** @class */ (function () {
     };
     /**
      * 设置交互过程的动态绘制调用对象
-     * @param pDraw 动态绘制对象 McEdGetPointWorldDrawObject
-     * @returns true为真
+     * @param pDraw {@link McEdGetPointWorldDrawObjectC | 动态绘制调用对象}
+     * @returns void
      */
     MrxDbgUiPrPointClass.prototype.setUserDraw = function (pDraw) {
-        return _MrxDbgUiPrPoint.setUserDraw(pDraw._get());
+        return _MrxDbgUiPrPoint.setUserDraw((pDraw._get ? pDraw._get() : pDraw));
     };
     /**
      * 得以获取的点对象，Three.js坐标
@@ -112864,12 +112942,7 @@ var MrxDbgUiPrPointClass = /** @class */ (function () {
     };
     /**
      * 开始动态拖动
-     * @callback retcall
-     *  @param status 用户交互输入函数返回值
-     *  kCancel = -2,	//	取消
-     *  kNone = -1,		//	空输入，当输入关键字和实体时会返回此值
-     *  kOk = 0,		//	获取用户输入成功
-     *  kKeyWord = 1,	//	用户输入了关键字
+     * @param retcall  回调参数status {@link MrxDbgUiPrBaseReturn | 状态值}
      * @returns void
      */
     MrxDbgUiPrPointClass.prototype.go = function (retcall) {
@@ -112877,14 +112950,8 @@ var MrxDbgUiPrPointClass = /** @class */ (function () {
     };
     /**
      * 动态拖动，连续取点，直到ESC退出。
-     * @callback retcall
-     *  @param status 用户交互输入函数返回值
-     * @callback exitcall
-     *  @param status 用户交互输入函数返回值
-     *  kCancel = -2,	//	取消
-     *  kNone = -1,		//	空输入，当输入关键字和实体时会返回此值
-     *  kOk = 0,		//	获取用户输入成功
-     *  kKeyWord = 1,	//	用户输入了关键字
+     * @param retcall 回调参数status {@link MrxDbgUiPrBaseReturn | 状态值}
+     * @param exitcall 回调参数status {@link MrxDbgUiPrBaseReturn | 状态值}
      * @returns void
      */
     MrxDbgUiPrPointClass.prototype.goWhile = function (retcall, exitcall) {
@@ -112892,8 +112959,7 @@ var MrxDbgUiPrPointClass = /** @class */ (function () {
     };
     /**
      * 把动态绘制的对象，保留到图上。
-     * @callback callAddEntity
-     *  @param ent THREE.Object3D
+     * @param callAddEntity 回调参数ent 类型：THREE.Object3D
      * @returns 点对象 DWG图纸坐标
      */
     MrxDbgUiPrPointClass.prototype.drawReserve = function (callAddEntity) {
@@ -112911,12 +112977,14 @@ var MxDocumentReady$1 = function (requireFun) {
 })();
 var MxModule = /** @class */ (function () {
     function MxModule(Jquery) {
+        this.MrxDbgUiPrBaseReturn = MrxDbgUiPrBaseReturn;
         // 动态绘制回调对象
         this.McEdGetPointWorldDrawObjectClass = McEdGetPointWorldDrawObjectClass;
         // 取点对象
         this.MrxDbgUiPrPointClass = MrxDbgUiPrPointClass;
         // 加载模块
         this.MxFun = new MxFun(_MxFun$1);
+        this._MxFun = _MxFun$1;
         this.MxThreeJS = new MxThreeJS();
         // 混入
         MxThreeJSMixin(this.MxThreeJS);