mxdraw 0.0.1 → 0.0.2

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

@@ -1,5 +1,19 @@
-export default class MxDrawObject implements MxDrawObjectType {
+/**
+ * 引入mxdraw库不会挂载MxDrawObject 只能在以下特定函数中获取
+ * @function
+ * {@link MxFun.createMxObject}中callback回调参数`mxDraw`的构造类
+ * @function
+ * {@link MxFun.getCurrentDraw} 方法返回值的构造类
+ * @function
+ * {@link MxFun.getCurrentMxCAD} 方法返回值的构造类
+ *
+ */
+export default class MxDrawObject {
     constructor(Mxdraw: MxDrawObjectType);
+    /**
+     * @instance
+     */
+    renderer: THREE.WebGLRenderer;
     /**
      * 获取Three.js绘图场景
      * @returns THREE.Scene
@@ -10,6 +24,11 @@ export default class MxDrawObject implements MxDrawObjectType {
      * @returns THREE.Camera
      */
     getCamera(): THREE.Camera;
+    /**
+     * 获取Three renderer渲染器
+     * @returns THREE.WebGLRenderer
+     */
+    getRenderer(): THREE.WebGLRenderer;
     /**
      * 设置鼠标按下是否旋视区
      * @param isRotate  是否旋视区

package/dist/types/MxCore/MxFun/MxFun.d.ts

@@ -1,3 +1,11 @@
+import MxDrawObject from '../MxDrawObject/MxDrawObject';
+/**
+ * MxFun 模块
+ * 导入库时已实例化，只需要调用实例方法 例如：
+ * ```typescript
+ *  Mx.MxFun.createMxObject
+ * ```
+ */
 declare class MxFun {
     constructor(mxFun: MxFunType);
     /**
@@ -92,7 +100,7 @@ declare class MxFun {
      * mxDraw.getScene()
      * ```
      */
-    getCurrentDraw(): MxDrawObjectType;
+    getCurrentDraw(): MxDrawObject;
     /**
      * 屏幕坐标长度转THREE.JS坐标长度
      * @param len 屏幕坐标长度

package/dist/types/MxCore/MxJigCmdManager/McEdGetPointWorldDrawObjectClass/McEdGetPointWorldDrawObjectClass.d.ts

@@ -1,5 +1,12 @@
 import { Vector3, Object3D } from 'three';
+/**
+ * McEdGetPointWorldDrawObjectClass 用于构建一个动态绘制回调对象
+ * ```typescript
+ *  new Mx.McEdGetPointWorldDrawObjectClass()
+ * ```
+ */
 export default class McEdGetPointWorldDrawObjectClass implements McEdGetPointWorldDrawObject {
+    [x: string]: any;
     constructor();
     /**
      * 绘制圆
@@ -52,9 +59,7 @@ export default class McEdGetPointWorldDrawObjectClass implements McEdGetPointWor
     drawText(sText: string, iSize: number, dAngle: number, pt: Vector3): void;
     /**
      * 设置动态绘制回调函数。
-     * @callback call 回调函数
-     * @param currentPoint 回调参数 当前位置
-     * @param pWorldDraw 回调参数 文档绘制对象 McEdGetPointWorldDrawObject
+     * @param call 回调函数 currentPoint 回调参数 当前位置 pWorldDraw 回调参数文档绘制对象
      * @returns void
      * @example
      * ``` typescript
@@ -62,8 +67,6 @@ export default class McEdGetPointWorldDrawObjectClass implements McEdGetPointWor
      *
      * })
      * ```
-     *
      */
-    setDraw(call: (currentPoint: Vector3, pWorldDraw: McEdGetPointWorldDrawObject) => void): void;
-    _get(): McEdGetPointWorldDrawObject;
+    setDraw(call: (currentPoint: Vector3, pWorldDraw: McEdGetPointWorldDrawObjectClass) => void): void;
 }

package/dist/types/MxCore/MxJigCmdManager/MrxDbgUiPrPointClass/MrxDbgUiPrPointClass.d.ts

@@ -1,4 +1,36 @@
 import { Vector3, Object3D } from 'three';
+/**
+ * MrxDbgUiPrBaseReturn枚举
+ * @description
+ * 用于适配{@link MrxDbgUiPrPointClass.go} 和 {@link MrxDbgUiPrPointClass.goWhile} 方法中的回调参数`status`
+ * @example
+ * ```
+ * const Point = new Mx.MrxDbgUiPrPointClass()
+ * Point.go((status)=> {
+ *  if(Mx.MrxDbgUiPrBaseReturn.kCancel === status) {
+ *    // 取消
+ *  }
+ * })
+ *
+ * ```
+ * @enum
+ * */
+export declare enum MrxDbgUiPrBaseReturn {
+    /** 取消 */
+    kCancel = -2,
+    /** 空输入，当输入关键字和实体时会返回此值 */
+    kNone = -1,
+    /** 获取用户输入成功 */
+    kOk = 0,
+    /** 用户输入了关键字*/
+    kKeyWord = 1
+}
+/**
+ * MrxDbgUiPrPointClass 用于构建一个取点对象
+ * ```typescript
+ *  new Mx.MrxDbgUiPrPointClass()
+ * ```
+ */
 export default class MrxDbgUiPrPointClass implements MrxDbgUiPrPoint {
     constructor();
     /**
@@ -36,8 +68,8 @@ export default class MrxDbgUiPrPointClass implements MrxDbgUiPrPoint {
     isKeyWordPicked(matchKeyWord: string): boolean;
     /**
      * 设置交互过程的动态绘制调用对象
-     * @param pDraw 动态绘制对象 McEdGetPointWorldDrawObject
-     * @returns true为真
+     * @param pDraw {@link McEdGetPointWorldDrawObjectC | 动态绘制调用对象}
+     * @returns void
      */
     setUserDraw(pDraw: McEdGetPointWorldDrawObject): void;
     /**
@@ -69,32 +101,20 @@ export default class MrxDbgUiPrPointClass implements MrxDbgUiPrPoint {
     setUseBasePt(useIt: boolean): void;
     /**
      * 开始动态拖动
-     * @callback retcall
-     *  @param status 用户交互输入函数返回值
-     *  kCancel = -2,	//	取消
-     *  kNone = -1,		//	空输入，当输入关键字和实体时会返回此值
-     *  kOk = 0,		//	获取用户输入成功
-     *  kKeyWord = 1,	//	用户输入了关键字
+     * @param retcall  回调参数status {@link MrxDbgUiPrBaseReturn | 状态值}
      * @returns void
      */
     go(retcall: (status: MrxDbgUiPrBaseReturn) => void): void;
     /**
      * 动态拖动，连续取点，直到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
      */
     goWhile(retcall: (status: MrxDbgUiPrBaseReturn) => any, exitcall?: (status: MrxDbgUiPrBaseReturn) => any): void;
     /**
      * 把动态绘制的对象，保留到图上。
-     * @callback callAddEntity
-     *  @param ent THREE.Object3D
+     * @param callAddEntity 回调参数ent 类型：THREE.Object3D
      * @returns 点对象 DWG图纸坐标
      */
     drawReserve(callAddEntity?: (ent: Object3D) => void): void;

package/dist/types/MxCore/MxJigCmdManager/index.d.ts

@@ -1,3 +1,3 @@
 import McEdGetPointWorldDrawObjectClass from './McEdGetPointWorldDrawObjectClass/McEdGetPointWorldDrawObjectClass';
-import MrxDbgUiPrPointClass from './MrxDbgUiPrPointClass/MrxDbgUiPrPointClass';
-export { McEdGetPointWorldDrawObjectClass, MrxDbgUiPrPointClass };
+import MrxDbgUiPrPointClass, { MrxDbgUiPrBaseReturn } from './MrxDbgUiPrPointClass/MrxDbgUiPrPointClass';
+export { McEdGetPointWorldDrawObjectClass, MrxDbgUiPrPointClass, MrxDbgUiPrBaseReturn };

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

@@ -1,4 +1,11 @@
 import { Vector3, Line, Object3D, Points, Sprite, Mesh, MeshBasicMaterial, Color } from 'three';
+/**
+ * MxThreeJS 模块
+ * 导入库时已实例化，只需要调用实例方法 例如：
+ * ```typescript
+ *  Mx.MxThreeJS.createLine
+ * ```
+ */
 declare class MxThreeJS {
     /**
      * 创建Three.js直线对象。
@@ -104,7 +111,7 @@ declare class MxThreeJS {
      * })
      * ```
      */
-    createImage: ((pos: Vector3, w: number, h: number, imageUrlPath: string, callResult: (mesh: Mesh | null) => void) => void) | undefined;
+    createImage: (pos: Vector3, w: number, h: number, imageUrlPath: string, callResult: (mesh: Mesh | null) => void) => void;
     /**
      * 加载SVG
      * @param url SVG路径地址
@@ -121,6 +128,6 @@ declare class MxThreeJS {
      * })
      * ```
      */
-    loadSVG: ((url: string, x: number, y: number, scale: number, color: Color, callResult: (threeobj: Object3D, aryMeterial: Array<MeshBasicMaterial>) => void) => void) | undefined;
+    loadSVG: (url: string, x: number, y: number, scale: number, color: Color, callResult: (threeobj: Object3D, aryMeterial: Array<MeshBasicMaterial>) => void) => void;
 }
 export default MxThreeJS;

package/dist/types/MxModule.d.ts

@@ -1,11 +1,13 @@
 /// <reference types="jquery" />
 import MxFunModule from './MxCore/MxFun/MxFun';
 import MxThreeJSModule from './MxModule/MxThreeJS/MxThreeJS';
-import { McEdGetPointWorldDrawObjectClass, MrxDbgUiPrPointClass } from './MxCore/MxJigCmdManager';
+import { McEdGetPointWorldDrawObjectClass, MrxDbgUiPrPointClass, MrxDbgUiPrBaseReturn } from './MxCore/MxJigCmdManager';
 export declare let _MxFun: MxFunType;
 declare class MxModule {
+    [x: string]: any;
     MxFun: MxFunModule;
     MxThreeJS: MxThreeJSModule;
+    MrxDbgUiPrBaseReturn: typeof MrxDbgUiPrBaseReturn;
     McEdGetPointWorldDrawObjectClass: typeof McEdGetPointWorldDrawObjectClass;
     MrxDbgUiPrPointClass: typeof MrxDbgUiPrPointClass;
     constructor(Jquery: JQueryStatic);

package/dist/types/doc.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Mx 模块集
+ *
+ * @module 模块
+ */
+import MxFun from './MxCore/MxFun/MxFun';
+import MxThreeJS from './MxModule/MxThreeJS/MxThreeJS';
+import MxDrawObject from './MxCore/MxDrawObject/MxDrawObject';
+import { MrxDbgUiPrPointClass, McEdGetPointWorldDrawObjectClass, MrxDbgUiPrBaseReturn } from './MxCore/MxJigCmdManager';
+export { MxFun, MxThreeJS, MxDrawObject, MrxDbgUiPrPointClass, McEdGetPointWorldDrawObjectClass, MrxDbgUiPrBaseReturn };

package/dist/types/tools/proxy/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * JS对象方法代理
+ * @param obj 代理对象
+ * @param proxyObj 需要代理的对象
+ * @param name 需要代理的方法属性名称
+ *
+ */
+export declare function objectMethodProxy(obj: object, proxyObj: {
+    [x: string]: any;
+}, name: string): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mxdraw",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "",
   "keywords": [],
   "main": "dist/mxdraw.umd.js",
@@ -37,7 +37,7 @@
     "semantic-release": "semantic-release",
     "semantic-release-prepare": "ts-node tools/semantic-release-prepare",
     "precommit": "lint-staged",
-    "postinstall": "ts-node tools/init",
+    "postinstall": "",
     "travis-deploy-once": "travis-deploy-once"
   },
   "lint-staged": {
@@ -110,6 +110,7 @@
     "tslint-config-standard": "^8.0.1",
     "tslint-loader": "^3.5.4",
     "typedoc": "^0.22.10",
+    "typedoc-plugin-rename-defaults": "^0.4.0",
     "typescript": "^4.5.2",
     "vue": "^2.6.14",
     "vue-loader": "^15.9.8",