mxdraw 0.0.17 → 0.1.2

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

@@ -7,6 +7,7 @@
  */
 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,227 @@
+/** @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 points 点数组
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    drawLines(points: 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,默认值为100.
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    setRenderOrder(iRenderOrder: number): void;
+    /**
+     * 得到DrawOrder
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    getRenderOrder(): number;
+    /**
+    * 设置宽度单位是屏幕像素，默认是屏幕像素，设置false,单位是Threejs坐标。
+    * @returns
+    * @example
+    * ``` typescript
+    *
+    * ```
+    *
+    */
+    setLineWidthIsPixels(isPixels: boolean): void;
+    /**
+   * 得到宽度单位
+   * @returns
+   * @example
+   * ``` typescript
+   *
+   * ```
+   *
+   */
+    getLineWidthIsPixels(): boolean;
+    /**
+   * 设置虚线显示数据。
+   * @returns
+   * @example
+   * ``` typescript
+   *
+   * ```
+   *
+   */
+    setDash(dDashArray: number, dDashRatio: number): void;
+    /**
+   * 得到虚线显示数据。
+   * @returns
+   * @example
+   * ``` typescript
+   *
+   * ```
+   *
+   */
+    getDash(): any;
+    /**
+    * 设置虚线显示
+    * @returns
+    * @example
+    * ``` typescript
+    *
+    * ```
+    *
+    */
+    setDashLineDisplay(isDashLine: boolean): void;
+    /**
+   *是否虚线显示
+   * @returns
+   * @example
+   * ``` typescript
+   *
+   * ```
+   *
+   */
+    isDashLineDisplay(): boolean;
+}

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,5 +1,5 @@
 /** @module MrxDbgUiPrPointClass */
-import { MrxDbgUiPrBaseReturn } from '@/types/MrxDbgUiPrPoint';
+import { MrxDbgUiPrBaseReturn } from '../../types/MrxDbgUiPrPoint';
 /**
  * MrxDbgUiPrPoint 用于构建一个取点对象
  * @example ```typescript

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

@@ -0,0 +1,198 @@
+/** @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;
+    /**
+  * 得到对象类型名
+  * @param
+  * @returns string
+  * @example
+  * ``` typescript
+  *
+  * ```
+  */
+    abstract getTypeName(): string;
+    /**
+   * 自定义实体的坐标变换.
+   * @param
+   * @returns void
+   * @example
+   *  }
+   * ```
+   */
+    transformBy(mat: THREE.Matrix4): void;
+    private getImp;
+    /**
+     * 更新显示
+     * @param
+     * @returns boolean
+     * @example
+     * ``` typescript
+     *
+     * ```
+     */
+    setNeedUpdateDisplay(isImmediate?: boolean): boolean;
+    /**
+   * 得到对象的id.
+   * @param
+   * @returns number
+   * @example
+   * ``` typescript
+   *
+   * ```
+   */
+    objectId(): number;
+    /**
+     * 删除对象
+     * @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 MxDbEntity
+     * @example
+     * ``` typescript
+     *
+     * ```
+    */
+    clone(type?: number): any;
+    /**
+     * 自定义对象内部数据输入同步（实现dwgIn抽象方法 必须在实现中调用 this.onDwgIn()）
+     * @param obj dwgIn抽象方法的回调数据
+     */
+    protected onDwgIn(obj: any): void;
+    /**
+     * 自定义对象内部数据输出同步（实现dwgIn抽象方法 必须在实现中调用 this.onDwgIn()
+     * @param obj dwgOut抽象方法的回调数据
+     */
+    protected onDwgOut(obj: any): void;
+    /**
+     * 初始自定义对象的类型信息.
+     * @param
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+    */
+    rxInit(): void;
+}

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

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