mxdraw 0.1.28 → 0.1.31

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

@@ -1,5 +1,4 @@
 /** @module McEdGetPointWorldDrawObject*/
-import { ColorType } from '../MxType/MxType';
 export interface McEdGetPointWorldDrawObjectClass {
     [x: string]: any;
     drawCircle(cen: THREE.Vector3, dRadius: number): void;
@@ -89,7 +88,7 @@ export default class McEdGetPointWorldDrawObject {
      * pWorldDraw.setColor(0xFFFFFF)
      * ```
      */
-    setColor(iColor: ColorType): void;
+    setColor(iColor: number | string | THREE.Color): void;
     /**
      * 得到绘制对象颜色.
      * @returns 颜色

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

@@ -11,7 +11,7 @@ export default class McGeTool {
     private initImp;
     /**
      * 计算闭合的区域面积
-     * @param
+     * @param aryPoint 构成区域面积的顶点位置集合
      * @return number
      * @example
      * ```
@@ -19,7 +19,8 @@ export default class McGeTool {
     calcArea(aryPoint: McGePoint3dArray | THREE.Vector3[]): number;
     /**
      * 判断点是否在一个闭合的多边形区域。
-     * @param p
+     * @param pt 点的坐标位置
+     * @param aryPoint 闭合多边形区域的顶点坐标集合
      * @return any
      * @example
      * ``` typescript

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

@@ -1,7 +1,6 @@
 /** @module McGiWorldDraw*/
 import McGiWorldDrawType from '../McGiWorldDrawType';
 import MxDrawObject from '../MxDrawObject';
-import { ColorType } from '../MxType/MxType';
 /**
  * McGiWorldDraw 用于构建一个动态绘制回调对象的规范接口
  * @abstract 是  {@link MxDbEntity.worldDraw }必须实现的抽象回调方法中的回调对象 通过回调对象完成一些动态绘制任务
@@ -51,7 +50,7 @@ export default interface McGiWorldDraw {
      * ```
      *
      */
-    setColor(iColor: ColorType): void;
+    setColor(iColor: number | string | THREE.Color): void;
     /**
      * 返回绘制颜色
      * @returns

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

@@ -4,6 +4,7 @@ import McGiWorldDraw from '../McGiWorldDraw';
 import MxDbEntity from '../MxDbEntity';
 /**
  * Mx3PointArc 对象.
+ * 通过三个坐标点绘制一段圆弧
  */
 export default class Mx3PointArc extends MxDbEntity {
     point1: Vector3;

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

@@ -4,7 +4,8 @@ import { Vector3 } from 'three';
 import McGiWorldDraw from '../McGiWorldDraw';
 import MxDbEntity from '../MxDbEntity';
 /**
- * MxDb2LineAngularDimension 对象.
+ * MxDb2LineAngularDimension
+ * 显示角度测量的图形
  */
 export default class MxDb2LineAngularDimension extends MxDbEntity {
     point1: THREE.Vector3;

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

@@ -3,7 +3,7 @@ import * as THREE from 'three';
 import McGiWorldDraw from '../McGiWorldDraw';
 import MxDbEntity from '../MxDbEntity';
 /**
- * MxDbAlignedDimension 尺寸对象.
+ * MxDbAlignedDimension 尺寸标注
  */
 export default class MxDbAlignedDimension extends MxDbEntity {
     point1: THREE.Vector3;
@@ -12,7 +12,15 @@ export default class MxDbAlignedDimension extends MxDbEntity {
     private getDirection;
     getDimText(): string;
     worldDraw(pWorldDraw: McGiWorldDraw): void;
+    /**
+     * 设置测量的开始点
+     * @parma pt1 three.js坐标点位
+     * */
     setPoint1(pt1: THREE.Vector3): void;
+    /**
+     * 设置测量的结束点
+     * @parma pt1 three.js坐标点位
+     * */
     setPoint2(pt2: THREE.Vector3): void;
     getGripPoints(): Array<THREE.Vector3>;
     moveGripPointsAt(index: number, offset: THREE.Vector3): boolean;

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

@@ -3,13 +3,16 @@ import { Vector3 } from 'three';
 import McGiWorldDraw from '../McGiWorldDraw';
 import MxDbEntity from '../MxDbEntity';
 /**
- * MxDbAnyLine 对象.
+ * MxDbAnyLine
+ * 任意线段
  */
 export default class MxDbAnyLine extends MxDbEntity {
+    /** 构成线段的顶点坐标集合 */
     points: Vector3[];
     getTypeName(): string;
     create(): MxDbEntity;
     worldDraw(pWorldDraw: McGiWorldDraw): void;
+    /** 获取线段的包围盒的中心点坐标 */
     getCenter(): Vector3;
     getGripPoints(): Vector3[];
     moveGripPointsAt(index: number, offset: Vector3): boolean;

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

@@ -2,16 +2,34 @@
 import * as THREE from 'three';
 import McGiWorldDraw from '../McGiWorldDraw';
 import MxDbEntity from '../MxDbEntity';
+/**
+ * MxDbArea 任意不规则多边形
+ * */
 export default class MxDbArea extends MxDbEntity {
+    /** 构成多边形的顶点集合 */
     points: Array<THREE.Vector3>;
     getTypeName(): string;
     create(): MxDbEntity;
+    /** 在worldDraw动态绘制时会计算当前顶点坐标集合的面积,并显示渲染计算后的计算结果
+     * @returns 返回的计算后的面积结果
+     *  */
+    getDimText(): string;
     worldDraw(pWorldDraw: McGiWorldDraw): void;
     getGripPoints(): Array<THREE.Vector3>;
     moveGripPointsAt(index: number, offset: THREE.Vector3): boolean;
     dwgIn(obj: any): boolean;
     dwgOut(obj: any): object;
+    /**
+     * 添加构成多边形的点
+     * @param pt 位置坐标
+     *  */
     addPoint(pt: THREE.Vector3): void;
+    /**
+     * 获取构成多边形的顶点集合
+     *  */
     getPoints(): Array<THREE.Vector3>;
+    /**
+     * 清空构成多边形的顶点集合
+     *  */
     clearPoint(): void;
 }

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

@@ -3,7 +3,7 @@ import { Vector3 } from 'three';
 import McGiWorldDraw from '../McGiWorldDraw';
 import MxDbEntity from '../MxDbEntity';
 /**
- * MxDbCloudLine 对象.
+ * MxDbCloudLine 对象. 绘制任意的云线
  */
 export default class MxDbCloudLine extends MxDbEntity {
     private points;
@@ -11,14 +11,34 @@ export default class MxDbCloudLine extends MxDbEntity {
     private drawGeometry;
     getTypeName(): string;
     create(): MxDbEntity;
+    /** 设置构成云线的每个圆弧半径长度
+     * @parma radius 圆弧半径
+     *  */
     setRadius(radius: number): void;
+    /**
+     * 获取云线的圆弧半径
+     * */
     getRadius(): number;
     private clacNewArcDiameterPoint;
     private createCloudArcCurvePoints;
+    /**
+     * 添加云线的顶点坐标, 该顶点坐标会根据上一个构成云线的点计算出下一个云线的顶点位置
+     * @param pt 坐标位置
+     * @param isAddToDrawGeometry 如果为true 将立即添加顶点并绘制下一个圆弧
+     * */
     addPoint(pt: THREE.Vector3, isAddToDrawGeometry?: boolean): void;
-    addLine(pt1: THREE.Vector3, pt2: THREE.Vector3): void;
+    /**
+     * 绘制两点之间的云线(与addPoint不同的是它不是只绘制一个半圆弧,而是绘制两点之间相连接的所有半圆弧)
+     * @param pt1 云线开始点
+     * @param pt2 云线结束点
+     * */
+    addLine(pt1: THREE.Vector3, pt2: THREE.Vector3): Vector3;
+    /** 重新计算云线的的所有顶点坐标, 如绘制完云线后 重新设置了圆弧半径, 在worldDraw动态绘制时会调用该方法 */
     reCalculateDrawGeometry(): void;
     worldDraw(pWorldDraw: McGiWorldDraw): void;
+    /**
+     * 获取云线包围盒的中心点
+     * */
     getCenter(): Vector3;
     getGripPoints(): Vector3[];
     moveGripPointsAt(index: number, offset: Vector3): boolean;

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

@@ -3,10 +3,12 @@ import * as THREE from 'three';
 import McGiWorldDraw from '../McGiWorldDraw';
 import MxDbEntity from '../MxDbEntity';
 /**
- * MxDbCoord 对象.
+ * MxDbCoord 引线坐标测量
  */
 export default class MxDbCoord extends MxDbEntity {
+    /** 测量点位置 */
     point1: THREE.Vector3;
+    /** 测量结果显示位置 */
     point2: THREE.Vector3;
     worldDraw(pWorldDraw: McGiWorldDraw): void;
     getGripPoints(): Array<THREE.Vector3>;

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

@@ -3,10 +3,12 @@ import { Vector3 } from 'three';
 import McGiWorldDraw from '../McGiWorldDraw';
 import MxDbEntity from '../MxDbEntity';
 /**
- * MxDbEllipse
+ * MxDbEllipse 通过矩形绘制的椭圆
  */
 export default class MxDbEllipse extends MxDbEntity {
+    /** 矩形的开始点 */
     point1: Vector3;
+    /** 矩形的结束点 */
     point2: Vector3;
     getTypeName(): string;
     worldDraw(pWorldDraw: McGiWorldDraw): void;

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

@@ -1,10 +1,9 @@
 /** @module MxDbEntity*/
 import McGiWorldDraw from '../McGiWorldDraw';
 import MxDrawObject from '../MxDrawObject';
-import { ColorType } from '../MxType/MxType';
 /**
  * MxDbEntity 用于构建一个自定义对象的抽象类(该类无法实例化 请通过继承的方式对其抽象方法进行实现)
- * @description MxDbEntity 属于 abstract class(抽象类) 主要用途是通过继承这个类实现一个用于动态绘制的回调对象
+ * @description MxDbEntity 属于 abstract class(抽象类) 主要用途是通过继承这个类实现一个用于动态绘制的图形对象
  * 继承实现这个类必须实现的抽象方法：（方法名称前有'Abstract'标签就是必须实现的方法）
  * @example ```typescript
  * import THREE from "three"
@@ -23,18 +22,24 @@ import { ColorType } from '../MxType/MxType';
  * ```
  */
 export default abstract class MxDbEntity {
-    color: ColorType;
+    /**
+     * 颜色值
+     * */
+    color: number | string | THREE.Color;
+    /**
+     * 显示顺序
+     * */
     renderOrder: number;
     /**
-     * opacity 设置透明度 0 ~ 1,1表示完全不透明，0表示全透明.
+     * 设置透明度 0 ~ 1,1表示完全不透明，0表示全透明.
      * */
     opacity: number;
     /**
-     * visible 该矩形对象是否可见
+     * 该矩形对象是否可见
      * */
     visible: boolean;
     /**
-     * visible 用户自定义数据.
+     * 用户自定义数据.
      * */
     userData: {
         [key: string]: any;
@@ -43,45 +48,61 @@ export default abstract class MxDbEntity {
      * 自定义对象的绘制函数。在方法中定义如何绘制图形
      * @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
+     */
+    abstract moveGripPointsAt(index: number, offset: THREE.Vector3): boolean;
+    /**
+     * 自定义对象数据输入，辅助函数.
+     * @param
+     * @returns boolean
      * @example
      * ``` typescript
-     *
+     *  class MxLine extends MxDbEntity {
+     *    dwgIn(obj) {
+     *        // 必须调用 同步自定义数据对象输入
+     *       this.dwgInHelp(obj,["xxx"])
+     *    }
+     *  }
      * ```
-     *
      */
-    abstract moveGripPointsAt(index: number, offset: THREE.Vector3): boolean;
+    protected dwgInHelp(obj: any, aryProp: string[]): boolean;
     /**
-     * 新创建一个自定义对象
+     * 自定义对象数据输出 辅助函数.
      * @param
-     * @returns MxDbEntity
+     * @returns object
      * @example
      * ``` typescript
-     *
+     *  class MxLine extends MxDbEntity {
+     *    dwgOut(obj) {
+     *        // 必须调用 同步自定义数据对象输出
+     *       this.dwgOutHelp(obj,["xxx"])
+     *    }
+     *  }
      * ```
      */
-    abstract create(): MxDbEntity;
+    protected dwgOutHelp(obj: any, aryProp: string[]): any;
+    /**
+     * 得到对象类型名
+     * @returns string
+     */
+    getTypeName(): string;
+    /**
+     * 新创建一个自定义对象 (默认调用该对象的构造函数来创建新的对象)
+     * @param
+     * @returns MxDbEntity
+     */
+    create(): MxDbEntity;
     /**
      * 自定义对象数据输入，必须要实现该函数
      * @param
@@ -113,143 +134,79 @@ export default abstract class MxDbEntity {
      */
     abstract dwgOut(obj: any): object;
     /**
-     * 得到对象类型名
-     * @param
-     * @returns string
-     * @example
-     * ``` typescript
-     *
-     * ```
-     */
-    abstract getTypeName(): string;
-    /**
-     * 自定义实体的坐标变换.
-     * @param
+     * 自定义实体的矩阵 坐标变换 (需要重写该方法实现如果通过矩阵对自定义实体进行操作 默认不会进行任何操作)
+     * @param mat THREE.Matrix4 变化矩阵
      * @returns void
-     * @example
-     *  }
-     * ```
      */
     transformBy(mat: THREE.Matrix4): void;
     private getImp;
     /**
      * 更新显示
-     * @param
+     * @param 为true 重绘时立即更新显示
      * @returns boolean
-     * @example
-     * ``` typescript
-     *
-     * ```
+  
      */
     setNeedUpdateDisplay(isImmediate?: boolean): boolean;
     /**
      * 返回对象所在的控件对象。
-     * @param
-     * @returns boolean
-     * @example
-     * ``` typescript
-     *
-     * ```
+     * @returns {@link MxDrawObject}
      */
     getMxObject(): MxDrawObject | null;
     /**
      * 视区显示比较发生成变化，继承类可以向应该事件，更新显示大小。
-     * @param
      * @returns boolean
-     * @example
-     * ``` typescript
-     *
-     * ```
      */
     protected onViewChange(): boolean;
     /**
      * 得到对象的id.
-     * @param
      * @returns number
-     * @example
-     * ``` typescript
-     *
-     * ```
      */
     objectId(): number;
     /**
      * 删除对象
-     * @param
      * @returns boolean
-     * @example
-     * ``` typescript
-     *
-     * ```
      */
     erase(): boolean;
     /**
      * 设置颜色
-     * @param
+     * @param color 颜色值
      * @returns boolean
-     * @example
-     * ``` typescript
-     *
-     * ```
      */
-    setColor(color: ColorType): void;
+    setColor(color: number | string | THREE.Color): void;
     /**
      * 得到颜色
-     * @param
      * @returns boolean
-     * @example
-     * ``` typescript
-     *
-     * ```
      */
-    getColor(): ColorType;
+    getColor(): number | string | THREE.Color;
     /**
-     * 复制对象。
-     * @param
+     * 复制克隆对象。
+     * @param type {@link MxType.MxCloneType} 传入参数区分是正常拷贝还是动态拷贝
      * @returns MxDbEntity
-     * @example
-     * ``` typescript
-     *
-     * ```
      */
     clone(type?: number): MxDbEntity;
     /**
-     * 自定义对象内部数据输入同步（实现dwgIn抽象方法 必须在实现中调用 this.onDwgIn()）
+     * 自定义对象内部数据输入同步（重写实现dwgIn抽象方法时 必须在实现中调用 this.onDwgIn(obj)）
      * @param obj dwgIn抽象方法的回调数据
      */
     protected onDwgIn(obj: any): void;
     /**
-     * 自定义对象内部数据输出同步（实现dwgIn抽象方法 必须在实现中调用 this.onDwgIn()
+     * 自定义对象内部数据输出同步（重写实现dwgIn抽象方法 必须在实现中调用 this.onDwgIn(obj)
      * @param obj dwgOut抽象方法的回调数据
      */
     protected onDwgOut(obj: any): void;
     /**
-     * 初始自定义对象的类型信息.
-     * @param
+     * 初始自定义对象的类型信息.(如果需要实现该图形对象的保存数据和恢复数据的功能, 需要在项目中初始化一次该图形对象的类)
      * @returns
-     * @example
-     * ``` typescript
-     *
-     * ```
      */
     rxInit(): void;
     /**
-     * 设置显示顺序
-     * @param
-     * @returns boolean
-     * @example
-     * ``` typescript
-     *
-     * ```
+     * 设置显示顺序 (通过显示顺序控制图层)
+     * @param renderOrder 显示顺序
      */
     setRenderOrder(renderOrder: number): void;
     /**
      * 得到显示顺序
-     * @param
-     * @returns boolean
-     * @example
-     * ``` typescript
-     *
-     * ```
+     * @returns number
      */
     getRenderOrder(): number;
 }

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

@@ -13,12 +13,27 @@ export default class MxDbImage extends MxDbEntity {
     private material;
     getTypeName(): string;
     worldDraw(pWorldDraw: McGiWorldDraw): void;
+    /** 设置图片路径
+     * @param sPath 路径
+     * */
     setImagePath(sPath: string): void;
+    /** 获取图片路径 */
     getImagePath(): string;
+    /** 设置图片材质
+     * @param material  THREE.MeshLambertMaterial
+     * */
     setMaterial(material: THREE.MeshLambertMaterial): void;
+    /** 设置图片对角点1
+     * @param pt1 THREE.Vector3坐标点
+     * */
     setPoint1(pt1: THREE.Vector3): void;
+    /** 获得图片对角点1 */
     getPoint1(): THREE.Vector3;
+    /** 设置图片对角点2
+     * @param pt2 THREE.Vector3坐标点
+     *  */
     setPoint2(pt2: THREE.Vector3): void;
+    /** 获得图片对角点2 */
     getPoint2(): THREE.Vector3;
     getGripPoints(): Array<THREE.Vector3>;
     moveGripPointsAt(index: number, offset: THREE.Vector3): boolean;

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

@@ -2,10 +2,17 @@
 import * as THREE from 'three';
 import McGiWorldDraw from '../McGiWorldDraw';
 import MxDbEntity from '../MxDbEntity';
+/**
+ * MxDbLeadComment 引线文字标注
+ * */
 export default class MxDbLeadComment extends MxDbEntity {
+    /** 标注点 */
     point1: THREE.Vector3;
+    /** 文字显示位置 */
     point2: THREE.Vector3;
+    /** 文字内容 */
     text: string;
+    /** 文字高度 */
     textHeight: number;
     getTypeName(): string;
     create(): MxDbEntity;

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

@@ -6,12 +6,16 @@ import MxDbEntity from '../MxDbEntity';
  * MxDbLine 直线对象.
  */
 export default class MxDbLine extends MxDbEntity {
+    /** 直线的开始点 */
     pt1: THREE.Vector3;
+    /** 直线的结束点 */
     pt2: THREE.Vector3;
     getTypeName(): string;
     worldDraw(pWorldDraw: McGiWorldDraw): void;
+    /** 设置的开始点 */
     setPoint1(pt1: THREE.Vector3): void;
     getPoint1(): THREE.Vector3;
+    /** 设置的结束点 */
     setPoint2(pt2: THREE.Vector3): void;
     getPoint2(): THREE.Vector3;
     getGripPoints(): Array<THREE.Vector3>;

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

@@ -3,9 +3,10 @@ import * as THREE from 'three';
 import McGiWorldDraw from '../McGiWorldDraw';
 import MxDbEntity from '../MxDbEntity';
 /**
- * MxDbPolyline 多义线对象.
+ * MxDbPolyline 多义线对象(多个点构成的线段)
  */
 export default class MxDbPolyline extends MxDbEntity {
+    /** 顶点位置集合 */
     points: THREE.Vector3[];
     getTypeName(): string;
     worldDraw(pWorldDraw: McGiWorldDraw): void;
@@ -14,8 +15,14 @@ export default class MxDbPolyline extends MxDbEntity {
     create(): MxDbEntity;
     dwgIn(obj: any): boolean;
     dwgOut(obj: any): object;
+    /** 添加顶点位置 */
     addVertexAt(pt: THREE.Vector3): void;
+    /** 顶点数量 */
     numVerts(): number;
     getPointAt(index: number): THREE.Vector3 | null;
+    /**  设置顶点
+     * @param index 替换的顶点在当前points集合的下标位置
+     * @param pt 要替换设置的顶点
+     *  */
     setPointAt(index: number, pt: THREE.Vector3): boolean;
 }

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

@@ -46,8 +46,14 @@ export default class MxDbRect extends MxDbEntity {
      * */
     setRadius(radius: number | number[], isScreenCoord?: boolean): void;
     getTypeName(): string;
+    /** 获取当前滤镜对象 {@link MxFilters} */
     getFilter(): MxFilters | undefined | null;
+    /** 设置当前滤镜对象
+     * @param filter {@link MxFilters}
+     *  */
     setFilter(filter: MxFilters | undefined | null): void;
+    /** 设置填充的背景图片路径 */
     setFillImagePath(sPath: string | undefined): void;
+    /** 获取填充的背景图片路径 */
     getFillImagePath(): string | undefined;
 }

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

@@ -2,12 +2,21 @@
 import * as THREE from 'three';
 import McGiWorldDraw from '../McGiWorldDraw';
 import MxDbEntity from '../MxDbEntity';
+/**
+ * MxDbRectBoxLeadComment 引线审图标注
+ * */
 export default class MxDbRectBoxLeadComment extends MxDbEntity {
+    /** 云线矩形的对角点1 */
     point1: THREE.Vector3;
+    /** 云线矩形的对角点2 */
     point2: THREE.Vector3;
+    /** 要标注的内容位置 */
     point3: THREE.Vector3;
+    /** 要显示的文字内容*/
     text: string;
+    /**文字高度*/
     textHeight: number;
+    /** 云线的半圆弧半径 */
     radius: number;
     getTypeName(): string;
     create(): MxDbEntity;

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

@@ -2,11 +2,14 @@ import MxDbEntity from '../MxDbEntity';
 import { Vector3 } from 'three';
 import McGiWorldDraw from '../McGiWorldDraw';
 /**
- * MxDbRegularPolygon
+ * MxDbRegularPolygon 正多边形
  */
 export default class MxDbRegularPolygon extends MxDbEntity {
+    /** 正多边形的中心点位置 */
     centerPoint: Vector3;
+    /** 正多边形两条边之间的交点位置 */
     otherPoint: Vector3;
+    /** 正多边形边的数量 */
     sidesNumber: number;
     getTypeName(): string;
     worldDraw(pWorldDraw: McGiWorldDraw): void;