mxdraw 0.0.18 → 0.1.3

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

@@ -79,7 +79,7 @@ export default class McEdGetPointWorldDrawObject {
      * pWorldDraw.setColor(0xFFFFFF)
      * ```
      */
-    setColor(iColor: number): void;
+    setColor(iColor: ColorType): void;
     /**
      * 得到绘制对象颜色.
      * @returns 颜色

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

@@ -0,0 +1,17 @@
+/**
+ * McGeVector3d
+ * @example ```typescript
+ * ```
+ */
+export default interface McGeVector3d {
+    /**
+     *
+     * @returns
+     */
+    getVal(t: number): number;
+    /**
+     *
+     * @returns
+     */
+    setVal(v: number): void;
+}

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

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

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

@@ -1,18 +1,9 @@
 /** @module McGiWorldDraw*/
+import McGiWorldDrawType from '../McGiWorldDrawType';
 import MxDrawObject from '../MxDrawObject';
 /**
- * 动态绘制类型
- * @example ```typescript
- *
- * ```
- */
-export declare enum McGiWorldDrawType {
-    kWorldDraw = 1,
-    kDynDragDraw = 2,
-    kSelectDraw = 3
-}
-/**
- * McGiWorldDraw 用于构建一个动态绘制回调对象
+ * McGiWorldDraw 用于构建一个动态绘制回调对象的规范接口
+ * @abstract 是  {@link MxDbEntity.worldDraw }必须实现的抽象回调方法中的回调对象 通过回调对象完成一些动态绘制任务
  * @example ```typescript
  *
  * ```
@@ -29,7 +20,7 @@ export default interface McGiWorldDraw {
      */
     getType(): McGiWorldDrawType;
     /**
-     * 绘制一个Three.js对象明
+     * 绘制一个Three.js对象
      * @param ent Three.js对象
      * @returns void
      * @example
@@ -51,6 +42,7 @@ export default interface McGiWorldDraw {
     getMxObject(): MxDrawObject;
     /**
      * 设置绘制颜色
+     * @param iColor 颜色值
      * @returns
      * @example
      * ``` typescript
@@ -58,7 +50,7 @@ export default interface McGiWorldDraw {
      * ```
      *
      */
-    setColor(iColor: number): void;
+    setColor(iColor: ColorType): void;
     /**
      * 返回绘制颜色
      * @returns
@@ -91,6 +83,8 @@ export default interface McGiWorldDraw {
     getLineWidth(): number;
     /**
      * 绘制直线
+     * @param pt1 第一个点 THREE.Vector3
+     * @param pt2 第二个点
      * @returns
      * @example
      * ``` typescript
@@ -98,9 +92,10 @@ export default interface McGiWorldDraw {
      * ```
      *
      */
-    drawLine(pt1: THREE.Vector3, pt2: THREE.Vector3): void;
+    drawLine(pt1: THREE.Vector3 | number, pt2: THREE.Vector3 | number, x2?: number, y2?: number): void;
     /**
-     * 绘制直线
+     * 绘制连续的直线
+     * @param points 点数组
      * @returns
      * @example
      * ``` typescript
@@ -108,9 +103,11 @@ export default interface McGiWorldDraw {
      * ```
      *
      */
-    drawLine2(x1: number, y1: number, x2: number, y2: number): void;
+    drawLines(points: THREE.Vector3[]): void;
     /**
      * 绘制圆
+     * @param cen 圆的中心点 THREE.Vector3
+     * @param dRadius 圆的半径
      * @returns
      * @example
      * ``` typescript
@@ -121,6 +118,10 @@ export default interface McGiWorldDraw {
     drawCircle(cen: THREE.Vector3, dRadius: number): void;
     /**
      * 绘文本
+     * @param sText 文本信息
+     * @param iSize 文字大小
+     * @param dAngle  角度
+     * @param pt 位置
      * @returns
      * @example
      * ``` typescript
@@ -130,7 +131,7 @@ export default interface McGiWorldDraw {
      */
     drawText(sText: string, iSize: number, dAngle: number, pt: THREE.Vector3): void;
     /**
-     * 设置DrawOrder
+     * 设置DrawOrder,默认值为100.
      * @returns
      * @example
      * ``` typescript
@@ -149,4 +150,74 @@ export default interface McGiWorldDraw {
      *
      */
     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;
+    /**
+     *绘制选择线。
+     * @returns
+     * @example
+     * ``` typescript
+     *
+     * ```
+     *
+     */
+    drawSelectLine(pt1: THREE.Vector3 | number, pt2: THREE.Vector3 | number, x2?: number, y2?: number): void;
 }

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

@@ -1,3 +1,2 @@
-/** @module McEdGetPointWorldDrawObject*/
-import McGiWorldDraw from './McGiWorldDraw';
+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/MxDbAlignedDimension/MxDbAlignedDimension.d.ts

@@ -0,0 +1,21 @@
+/** @module MxDbAlignedDimension*/
+import * as THREE from 'three';
+import McGiWorldDraw from '../McGiWorldDraw';
+import MxDbEntity from '../MxDbEntity';
+/**
+ * MxDbAlignedDimension 尺寸对象.
+ */
+export default class MxDbAlignedDimension extends MxDbEntity {
+    private pt1;
+    private pt2;
+    getTypeName(): string;
+    private getDirection;
+    worldDraw(pWorldDraw: McGiWorldDraw): void;
+    setPoint1(pt1: THREE.Vector3): void;
+    setPoint2(pt2: THREE.Vector3): void;
+    getGripPoints(): Array<THREE.Vector3>;
+    moveGripPointsAt(index: number, offset: THREE.Vector3): boolean;
+    dwgIn(obj: any): boolean;
+    dwgOut(obj: any): object;
+    create(): MxDbEntity;
+}

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

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

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

@@ -1,16 +1,31 @@
 /** @module MxDbEntity*/
 import McGiWorldDraw from '../McGiWorldDraw';
 /**
- * MxDbEntity 用于构建一个动态绘制回调对象
+ * 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;
+    private iRenderOrder;
     /**
-     * 自定义对象的绘制函数。
-     * @param pWorldDraw 绘制对象
+     * 自定义对象的绘制函数。在方法中定义如何绘制图形
+     * @param  pWorldDraw 绘制对象{@link McGiWorldDraw }
      * @returns void
      * @example
      * ``` typescript
@@ -22,7 +37,7 @@ export default abstract class MxDbEntity {
     /**
      * 返回自定义对象的夹点.
      * @param
-     * @returns void
+     * @returns Array<THREE.Vector3>
      * @example
      * ``` typescript
      *
@@ -44,7 +59,7 @@ export default abstract class MxDbEntity {
     /**
      * 新创建一个自定义对象
      * @param
-     * @returns boolean
+     * @returns MxDbEntity
      * @example
      * ``` typescript
      *
@@ -57,20 +72,49 @@ export default abstract class MxDbEntity {
      * @returns boolean
      * @example
      * ``` typescript
-     *
+     *  class MxLine extends MxDbEntity {
+     *    dwgIn(obj) {
+     *        // 必须调用 同步自定义数据对象输入
+     *       this.onDwgIn(obj)
+     *    }
+     *  }
      * ```
      */
-    dwgIn(obj: any): boolean;
+    abstract dwgIn(obj: any): boolean;
     /**
      * 自定义对象数据输出，必须要实现该函数
      * @param
-     * @returns boolean
+     * @returns object
+     * @example
+     * ``` typescript
+     *  class MxLine extends MxDbEntity {
+     *    dwgOut(obj) {
+     *        // 必须调用 同步自定义数据对象输出
+     *       this.onDwgOut(obj)
+     *    }
+     *  }
+     * ```
+     */
+    abstract dwgOut(obj: any): object;
+    /**
+     * 得到对象类型名
+     * @param
+     * @returns string
      * @example
      * ``` typescript
      *
      * ```
      */
-    dwgOut(obj: any): object;
+    abstract getTypeName(): string;
+    /**
+     * 自定义实体的坐标变换.
+     * @param
+     * @returns void
+     * @example
+     *  }
+     * ```
+     */
+    transformBy(mat: THREE.Matrix4): void;
     private getImp;
     /**
      * 更新显示
@@ -81,7 +125,17 @@ export default abstract class MxDbEntity {
      *
      * ```
      */
-    upDisplay(): boolean;
+    setNeedUpdateDisplay(isImmediate?: boolean): boolean;
+    /**
+     * 得到对象的id.
+     * @param
+     * @returns number
+     * @example
+     * ``` typescript
+     *
+     * ```
+     */
+    objectId(): number;
     /**
      * 删除对象
      * @param
@@ -101,7 +155,7 @@ export default abstract class MxDbEntity {
      *
      * ```
      */
-    setColor(iColor: number): void;
+    setColor(iColor: ColorType): void;
     /**
      * 得到颜色
      * @param
@@ -111,15 +165,55 @@ export default abstract class MxDbEntity {
      *
      * ```
      */
-    getColor(): number;
+    getColor(): ColorType;
     /**
-     * 得到对象类型名
+     * 复制对象。
      * @param
-     * @returns string
+     * @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;
+    /**
+     * 设置显示顺序
+     * @param
+     * @returns boolean
+     * @example
+     * ``` typescript
+     *
+     * ```
+     */
+    setRenderOrder(iRenderOrder: number): void;
+    /**
+     * 得到显示顺序
+     * @param
+     * @returns boolean
      * @example
      * ``` typescript
      *
      * ```
      */
-    getTypeName(): string;
+    getRenderOrder(): number;
 }

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

@@ -0,0 +1,28 @@
+/** @module MxDbImage*/
+import * as THREE from 'three';
+import McGiWorldDraw from '../McGiWorldDraw';
+import MxDbEntity from '../MxDbEntity';
+/**
+ * MxDbImage 图片对象.
+ */
+export default class MxDbImage extends MxDbEntity {
+    private pt1;
+    private pt2;
+    private imagePath;
+    private isLoadMaterialFromPath;
+    private material;
+    getTypeName(): string;
+    worldDraw(pWorldDraw: McGiWorldDraw): void;
+    setImagePath(sPath: string): void;
+    getImagePath(): string;
+    setMaterial(material: THREE.MeshLambertMaterial): void;
+    setPoint1(pt1: THREE.Vector3): void;
+    getPoint1(): THREE.Vector3;
+    setPoint2(pt2: THREE.Vector3): void;
+    getPoint2(): THREE.Vector3;
+    getGripPoints(): Array<THREE.Vector3>;
+    moveGripPointsAt(index: number, offset: THREE.Vector3): boolean;
+    dwgIn(obj: any): boolean;
+    dwgOut(obj: any): object;
+    create(): MxDbEntity;
+}

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

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

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

@@ -0,0 +1,42 @@
+/** @module MxDbSVG*/
+import * as THREE from 'three';
+import McGiWorldDraw from '../McGiWorldDraw';
+import MxDbEntity from '../MxDbEntity';
+/**
+ * MxDbSVG SVG对象.
+ */
+export default class MxDbSVG extends MxDbEntity {
+    private svgPos;
+    private svg;
+    private svgPath;
+    private svgSize;
+    private svgAlignmentRatio;
+    private isSvgDirtyLocation;
+    private isLoadFromPath;
+    private txtPos;
+    private txt;
+    private txtHeight;
+    worldDraw(pWorldDraw: McGiWorldDraw): void;
+    setSvgPath(path: string): void;
+    getSvgPath(): string;
+    setSvgPostion(pos: THREE.Vector3): void;
+    getSvgPostion(): THREE.Vector3;
+    setSvgSize(size: THREE.Vector2): void;
+    getSvgSize(): THREE.Vector2;
+    setSvgAlignmentRatio(alignmentRatio: THREE.Vector2): void;
+    getSvgAlignmentRatio(): THREE.Vector2;
+    setTextHeight(height: number): void;
+    getTextHeight(): number;
+    setText(txt: string): void;
+    getText(): string;
+    setTextPostion(pos: THREE.Vector3): void;
+    getTextPostion(): THREE.Vector3;
+    getGripPoints(): Array<THREE.Vector3>;
+    moveGripPointsAt(index: number, offset: THREE.Vector3): boolean;
+    private calcSvgPosition;
+    dwgIn(obj: any): boolean;
+    dwgOut(obj: any): object;
+    create(): MxDbEntity;
+    transformBy(mat: THREE.Matrix4): void;
+    getTypeName(): string;
+}

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

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