mxdraw 0.0.16 → 0.1.1

package/dist/types/MxModule/McEdGetPointWorldDrawObject/McEdGetPointWorldDrawObjectClass.d.ts

@@ -1,12 +1,13 @@
 /** @module McEdGetPointWorldDrawObject*/
 /**
  * McEdGetPointWorldDrawObject 用于构建一个动态绘制回调对象
- * ```typescript
+ * @example ```typescript
  *  Mx.McEdGetPointWorldDrawObject()
  * ```
  */
 export default class McEdGetPointWorldDrawObject {
     [x: string]: any;
+    private _McEdGetPointWorldDraw;
     constructor();
     /**
      * 绘制圆
@@ -68,7 +69,7 @@ export default class McEdGetPointWorldDrawObject {
      * })
      * ```
      */
-    setDraw(call: (currentPoint: THREE.Vector3, pWorldDraw: any) => void): void;
+    setDraw(call: (currentPoint: THREE.Vector3, pWorldDraw?: any) => void): void;
     /**
      * 设置绘制对象颜色.
      * @param iColor 颜色
@@ -78,7 +79,7 @@ export default class McEdGetPointWorldDrawObject {
      * pWorldDraw.setColor(0xFFFFFF)
      * ```
      */
-    setColor(iColor: number): void;
+    setColor(iColor: ColorType): void;
     /**
      * 得到绘制对象颜色.
      * @returns 颜色
@@ -88,4 +89,13 @@ export default class McEdGetPointWorldDrawObject {
      * ```
      */
     getColor(): void;
+    /**
+     * 动态绘制一个自定义实体
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+     */
+    drawCustomEntity(ent: any): void;
 }

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

@@ -0,0 +1,156 @@
+/** @module McGiWorldDraw*/
+import McGiWorldDrawType from "../McGiWorldDrawType";
+import MxDrawObject from "../MxDrawObject";
+/**
+ * McGiWorldDraw 用于构建一个动态绘制回调对象的规范接口
+ * @abstract 是  {@link MxDbEntity.worldDraw }必须实现的抽象回调方法中的回调对象 通过回调对象完成一些动态绘制任务
+ * @example ```typescript
+ *
+ * ```
+ */
+export default interface McGiWorldDraw {
+    /**
+     * 得到WorldDraw的绘制类型.
+     * @returns McGiWorldDrawType
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    getType(): McGiWorldDrawType;
+    /**
+     * 绘制一个Three.js对象
+     * @param ent Three.js对象
+     * @returns void
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    drawEntity(ent: THREE.Object3D): void;
+    /**
+     * 返回动态绘制的控件对像
+     * @returns MxDrawObject
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    getMxObject(): MxDrawObject;
+    /**
+     * 设置绘制颜色
+     * @param iColor 颜色值
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    setColor(iColor: ColorType): void;
+    /**
+     * 返回绘制颜色
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    getColor(): number;
+    /**
+     * 设置绘制的线宽
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    setLineWidth(iLineWidth: number): void;
+    /**
+     * 返回绘制的线宽
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    getLineWidth(): number;
+    /**
+     * 绘制直线
+     * @param pt1 第一个点 THREE.Vector3
+     * @param pt2 第二个点
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    drawLine(pt1: THREE.Vector3, pt2: THREE.Vector3): void;
+    /**
+     * 绘制直线
+     * @param x1 第一个点的X坐标
+     * @param y1 第一个点的Y坐标
+     * @param x2 第二个点的X坐标
+     * @param y2 第二个点的Y坐标
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    drawLine2(x1: number, y1: number, x2: number, y2: number): void;
+    /**
+     * 绘制圆
+     * @param cen 圆的中心点 THREE.Vector3
+     * @param dRadius 圆的半径
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    drawCircle(cen: THREE.Vector3, dRadius: number): void;
+    /**
+     * 绘文本
+     * @param sText 文本信息
+     * @param iSize 文字大小
+     * @param dAngle  角度
+     * @param pt 位置
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    drawText(sText: string, iSize: number, dAngle: number, pt: THREE.Vector3): void;
+    /**
+     * 设置DrawOrder
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    setRenderOrder(iRenderOrder: number): void;
+    /**
+     * 得到DrawOrder
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    getRenderOrder(): number;
+}

package/dist/types/MxModule/McGiWorldDraw/index.d.ts

@@ -0,0 +1,2 @@
+import McGiWorldDraw from "./McGiWorldDraw";
+export default McGiWorldDraw;

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

@@ -0,0 +1,16 @@
+/** @module McGiWorldDrawType*/
+/**
+ * 动态绘制类型
+ * @example ```typescript
+
+ * ```
+ */
+declare enum McGiWorldDrawType {
+    /** 正常绘制 */
+    kWorldDraw = 1,
+    /** 动态拖动的绘制 */
+    kDynDragDraw = 2,
+    /** 对选择高亮的绘制 */
+    kSelectDraw = 3
+}
+export default McGiWorldDrawType;

package/dist/types/MxModule/McGiWorldDrawType/index.d.ts

@@ -0,0 +1,2 @@
+import McGiWorldDrawType from "./McGiWorldDrawType";
+export default McGiWorldDrawType;

package/dist/types/MxModule/MrxDbgUiPrPoint/MrxDbgUiPrPointClass.d.ts

@@ -1,8 +1,8 @@
 /** @module MrxDbgUiPrPointClass */
-import { MrxDbgUiPrBaseReturn } from '@/types/MrxDbgUiPrPoint';
+import { MrxDbgUiPrBaseReturn } from '../../types/MrxDbgUiPrPoint';
 /**
  * MrxDbgUiPrPoint 用于构建一个取点对象
- * ```typescript
+ * @example ```typescript
  *  new Mx.MrxDbgUiPrPoint()
  * ```
  */

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

@@ -0,0 +1,159 @@
+/** @module MxDbEntity*/
+import McGiWorldDraw from '../McGiWorldDraw';
+/**
+ * MxDbEntity 用于构建一个自定义对象的抽象类(该类无法实例化 请通过继承的方式对其抽象方法进行实现)
+ * @description MxDbEntity 属于 abstract class(抽象类) 主要用途是通过继承这个类实现一个用于动态绘制的回调对象
+ * 继承实现这个类必须实现的抽象方法：（方法名称前有'Abstract'标签就是必须实现的方法）
+ * @example ```typescript
+ * import THREE from "three"
+ * import { McGiWorldDraw, MxDbEntity } from "mxdraw"
+ * class MxLineEntity extends MxDbEntity {
+ *    constructor() {
+ *       super(); // 在派生类的构造函数中必须调用 super()
+ *    }
+ *    private pt1: THREE.Vector3 = new THREE.Vector3();
+ *    private pt2: THREE.Vector3 = new THREE.Vector3();
+ *    worldDraw(pWorldDraw: McGiWorldDraw) {
+ *        pWorldDraw.drawLine(this.pt1,this.pt2);
+ *    }
+ *    ...
+ * }
+ * ```
+ */
+export default abstract class MxDbEntity {
+    private iColor;
+    /**
+     * 自定义对象的绘制函数。在方法中定义如何绘制图形
+     * @param  pWorldDraw 绘制对象{@link McGiWorldDraw }
+     * @returns void
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    abstract worldDraw(pWorldDraw: McGiWorldDraw): void;
+    /**
+     * 返回自定义对象的夹点.
+     * @param
+     * @returns Array<THREE.Vector3>
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    abstract getGripPoints(): Array<THREE.Vector3>;
+    /**
+     * 移动自定义对象的夹点.
+     * @param
+     * @returns boolean
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    abstract moveGripPointsAt(index: number, offset: THREE.Vector3): boolean;
+    /**
+     * 新创建一个自定义对象
+     * @param
+     * @returns MxDbEntity
+     * @example
+     * ``` typescript
+     *
+     * ```
+     */
+    abstract create(): MxDbEntity;
+    /**
+     * 自定义对象数据输入，必须要实现该函数
+     * @param
+     * @returns boolean
+     * @example
+     * ``` typescript
+     *  class MxLine extends MxDbEntity {
+     *    dwgIn(obj) {
+     *        // 必须调用 同步自定义数据对象输入
+     *       this.onDwgIn(obj)
+     *    }
+     *  }
+     * ```
+     */
+    abstract dwgIn(obj: any): boolean;
+    /**
+     * 自定义对象数据输出，必须要实现该函数
+     * @param
+     * @returns object
+     * @example
+     * ``` typescript
+     *  class MxLine extends MxDbEntity {
+     *    dwgOut(obj) {
+     *        // 必须调用 同步自定义数据对象输出
+     *       this.onDwgOut(obj)
+     *    }
+     *  }
+     * ```
+     */
+    abstract dwgOut(obj: any): object;
+    private getImp;
+    /**
+     * 更新显示
+     * @param
+     * @returns boolean
+     * @example
+     * ``` typescript
+     *
+     * ```
+     */
+    upDisplay(): boolean;
+    /**
+     * 删除对象
+     * @param
+     * @returns boolean
+     * @example
+     * ``` typescript
+     *
+     * ```
+     */
+    erase(): boolean;
+    /**
+     * 设置颜色
+     * @param
+     * @returns boolean
+     * @example
+     * ``` typescript
+     *
+     * ```
+     */
+    setColor(iColor: ColorType): void;
+    /**
+     * 得到颜色
+     * @param
+     * @returns boolean
+     * @example
+     * ``` typescript
+     *
+     * ```
+     */
+    getColor(): ColorType;
+    /**
+     * 得到对象类型名
+     * @param
+     * @returns string
+     * @example
+     * ``` typescript
+     *
+     * ```
+     */
+    getTypeName(): string;
+    /**
+     * 自定义对象内部数据输入同步（实现dwgIn抽象方法 必须在实现中调用 this.onDwgIn()）
+     * @param obj dwgIn抽象方法的回调数据
+     */
+    protected onDwgIn(obj: any): void;
+    /**
+     * 自定义对象内部数据输出同步（实现dwgIn抽象方法 必须在实现中调用 this.onDwgIn()
+     * @param obj dwgOut抽象方法的回调数据
+     */
+    protected onDwgOut(obj: any): void;
+}

package/dist/types/MxModule/MxDbEntity/index.d.ts

@@ -0,0 +1,3 @@
+/** @module McEdGetPointWorldDrawObject*/
+import MxDbEntity from './MxDbEntity';
+export default MxDbEntity;

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

@@ -1,5 +1,6 @@
 /** @module MxDrawObject */
-import { MxDrawObjectType } from '@/types/MxDrawObject';
+import { MxDrawObjectType } from '../../types/MxDrawObject';
+import MxDbEntity from '../MxDbEntity';
 /**
  * 引入mxdraw库不会挂载MxDrawObject 只能在以下特定函数中获取
  * @function
@@ -11,6 +12,7 @@ import { MxDrawObjectType } from '@/types/MxDrawObject';
  *
  */
 export default class MxDrawObject {
+    private _mxdrawObj;
     constructor(Mxdraw: MxDrawObjectType);
     /**
      * @instance
@@ -245,4 +247,252 @@ export default class MxDrawObject {
     setIniset(options: {
         EnableOsnapFunction: boolean;
     }): void;
+    /**
+     * 屏幕坐标到ThreeJS坐标
+     * @returns THREE.Vector3
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    screenCoord2World(x: number, y: number, z?: number): THREE.Vector3;
+    /**
+     * ThreeJS坐标到屏幕坐标
+     * @returns THREE.Vector3
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    worldCoord2Screen(x: number, y: number, z: number): THREE.Vector3;
+    /**
+     * 屏幕坐标到DWG文档坐标
+     * @returns THREE.Vector3
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    screenCoord2Doc(x: number, y: number, z: number): THREE.Vector3;
+    /**
+     * ThreeJS坐标长度到DWG文档坐标长度
+     * @returns number
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    worldCoordLong2Doc(l: number): number;
+    /**
+     * DWG文档坐标长度到ThreeJS坐标长度
+     * @returns number
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    docCoordLong2World(l: number): number;
+    /**
+     * DWG文档坐标到ThreeJS坐标
+     * @returns number
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    docCoord2World(x: number, y: number, z: number): THREE.Vector3;
+    /**
+     * DWG文档坐标到ThreeJS坐标
+     * @returns THREE.Vector3
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    docCoord2World2(pt: THREE.Vector3): THREE.Vector3;
+    /**
+     * ThreeJS坐标到DWG文档坐标
+     * @returns number
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    worldCoord2Doc(x: number, y: number, z: number): THREE.Vector3;
+    /**
+     * ThreeJS坐标到DWG文档坐标
+     * @returns THREE.Vector3
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    worldCoord2Doc2(pt: THREE.Vector3): THREE.Vector3;
+    /**
+     * DWG文档坐标到屏幕坐标
+     * @returns number
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    docCoord2Screen(x: number, y: number, z: number): THREE.Vector3;
+    /**
+     * 屏幕坐标长度到DWG文档坐标长度
+     * @returns number
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    screenCoordLong2Doc(l: number): number;
+    /**
+     * DWG文档坐标长度到屏幕坐标长度
+     * @returns number
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    docCoordLong2Screen(l: number): number;
+    /**
+     * 屏幕坐标长度到ThreeJS坐标长度
+     * @returns number
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    screenCoordLong2World(l: number): number;
+    /**
+     * ThreeJS坐标长度到屏幕坐标长度
+     * @returns number
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    worldCoordLong2Screen(l: number): number;
+    /**
+     * 初始WebGL Renderer的创建参数,该函数在MxFun.createMxObject函数调用时，调用。
+     * @param param
+     * @returns void
+     * @example
+     * ```typescript
+     * mxObj.initRendererParam({preserveDrawingBuffer: true})
+     *
+     * ```
+     */
+    initRendererParam(param: object): void;
+    /**
+     * 添加一个自定义实体到图上。
+     * @param ent 自定义实体对象
+     * @returns number 返回对象的id.
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    addMxEntity(ent: MxDbEntity): number;
+    /**
+     * 得到图上当前选择的对象.
+     * @returns Array<number> 返回对象的id数组.
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    getMxCurrentSelect(): Array<number>;
+    /**
+     *通过id获取绘制的对象.
+     * @param id 返回对象的id
+     * @returns MxDbEntity
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    getMxEntity(id: number): MxDbEntity;
+    /**
+     * 查找某点位置处的用户自绘对象.
+     * @param ptMouse 查找的点位 THREE.Vector3
+     * @param isWorldCoord 点是否是默认坐标 默认为 true
+     * @returns MxDbEntity[] 返回用户自绘对象数组
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    findMxEntityAtPoint(ptMouse: THREE.Vector3, isWorldCoord?: boolean): Array<MxDbEntity>;
+    /**
+     *得到所有用户自绘对象.
+     * @returns MxDbEntity[] 返回用户自绘对象数组
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    getAllMxEntity(): Array<MxDbEntity>;
+    /**
+     * 设置鼠标中键移动视区。
+     * @param isPan 设置是否可以鼠标中键移动视区
+     * @returns
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    setMouseMiddlePan(isPan: boolean): void;
+    /**
+     *重新设置ThreeJS Controls状态.
+     * @returns
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    resetThreeJSControls(): void;
+    /**
+     * 启用或禁用鼠标中键滚动缩放视区
+     * @param isEnable 是否启用
+     * @returns
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    enableZoom(isEnable: boolean): void;
+    /**
+     * 启用或禁用鼠标移动视区
+     * @param isEnable 是否启用
+     * @returns
+     * @example
+     * ```typescript
+     *
+     *
+     * ```
+     */
+    enablePan(isEnable: boolean): void;
 }