mxdraw 0.1.28 → 0.1.31

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

@@ -3,9 +3,8 @@ import * as THREE from 'three';
 import McGiWorldDraw from '../McGiWorldDraw';
 import MxDbEntity from '../MxDbEntity';
 import MxDbSVGText from '../MxDbSVGText';
-import { ColorType } from '../MxType/MxType';
 /**
- * MxDbSVG SVG对象.
+ * MxDbSVG 绘制SVG图形.
  */
 export default class MxDbSVG extends MxDbEntity {
     private svgPos;
@@ -13,26 +12,59 @@ export default class MxDbSVG extends MxDbEntity {
     private svgPath;
     private svgSize;
     private svgAlignmentRatio;
+    /** 延z轴旋转的数值 */
     svgRotate: number;
+    /** 是否倒置SVG图形 */
     svgReverse: boolean;
     svgMargin: THREE.Vector2;
     private isSvgDirtyLocation;
     private isLoadFromPath;
     private aryText;
     private svgBoxSize;
+    /** 固定尺寸，图片和文字大小，取屏幕像素绘图单位。 */
     fixedSize: boolean;
+    /**使用svg的颜色 */
     useSvgColor: boolean;
     private calcVewSize;
     worldDraw(pWorldDraw: McGiWorldDraw): void;
+    /**
+     * 设置SVG的路径
+     * @param path 路径
+     * @param preload 是否提前加载SVG
+     * */
     setSvgPath(path: string, preload?: boolean): Promise<void>;
+    /**
+     * 获取SVG的路径
+     * */
     getSvgPath(): string;
+    /**
+     * 设置SVG显示位置
+     * @param pos  THREE.Vector3
+     * */
     setSvgPostion(pos: THREE.Vector3): void;
+    /**
+     * 获取SVG显示位置
+     * */
     getSvgPostion(): THREE.Vector3;
+    /**
+     * 设置SVG大小
+     * @param size THREE.Vector2 x表示宽度y表示高度
+     * */
     setSvgSize(size: THREE.Vector2): void;
     getSvgSize(): THREE.Vector2;
+    /** 设置SVG 的调整比例
+     * @param alignmentRatio THREE.Vector2
+     *  */
     setSvgAlignmentRatio(alignmentRatio: THREE.Vector2): void;
     getSvgAlignmentRatio(): THREE.Vector2;
+    /** 获取文字数组下标中的文字
+     * @param index 数组下标
+     * @return {@link MxDbSVGText}
+     *  */
     getText(index: number): MxDbSVGText | null;
+    /** 添加文字
+     * @param txt {@link MxDbSVGText}
+     *  */
     addText(txt: MxDbSVGText): void;
     getGripPoints(): Array<THREE.Vector3>;
     moveGripPointsAt(index: number, offset: THREE.Vector3): boolean;
@@ -42,6 +74,10 @@ export default class MxDbSVG extends MxDbEntity {
     create(): MxDbEntity;
     transformBy(mat: THREE.Matrix4): void;
     getTypeName(): string;
-    setColor(color: ColorType): void;
+    /**
+     * 设置颜色
+     * @param color 颜色值
+     * */
+    setColor(color: number | string | THREE.Color): void;
     protected onViewChange(): boolean;
 }

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

@@ -1,11 +1,19 @@
 /** @module MxDbSVG*/
 import * as THREE from 'three';
-import { ColorType } from '../MxType/MxType';
+/**
+ * MxDbSVGText 为SVG提供文字数据
+ * */
 export default class MxDbSVGText {
+    /** 文字的位置 */
     txtPos: THREE.Vector3;
+    /** 文字内容 */
     txt: string;
+    /** 文字高度 */
     txtHeight: number;
-    color: ColorType | undefined;
+    /** 文字颜色 */
+    color: number | string | THREE.Color | undefined;
+    /** THREE.Sprite */
     _txtObject: THREE.Sprite | null;
+    /** 比例 */
     _txtAspectRatio: number;
 }

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

@@ -3,12 +3,16 @@ import { Vector3 } from 'three';
 import McGiWorldDraw from '../McGiWorldDraw';
 import MxDbEntity from '../MxDbEntity';
 /**
- * MxDbText
+ * MxDbText 绘制文字
  */
 export default class MxDbText extends MxDbEntity {
+    /** 文字所在位置*/
     position: Vector3;
+    /** 文字内容*/
     text: string;
+    /** 文字高度*/
     height: number;
+    /** 角度*/
     angle: number;
     getTypeName(): string;
     worldDraw(pWorldDraw: McGiWorldDraw): void;

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

@@ -621,7 +621,7 @@ export default class MxDrawObject {
      */
     loadMxEntityFromJson(dataString: string, aryPreloadSVG?: string[] | null): Promise<boolean>;
     /**
-     * 删除所有对MxEntity
+     * 删除所有的MxEntity
      * @param
      * @returns
      * @example

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

@@ -3,7 +3,6 @@ import { MeshLambertMaterial } from 'three';
 import MxDbEntity from '../MxDbEntity';
 import mxUiData from '../loadCoreCode/mxUiData';
 import { MxDrawObjectType } from '../MxDrawObject/MxDrawObject';
-import { ColorType } from '../MxType/MxType';
 interface CanvasParent extends HTMLElement {
     tabindex?: number;
 }
@@ -86,7 +85,7 @@ export interface MxFunType {
     initDynamicCreate(dynCreate: any): void;
     openFile(sFile: string | string[], useWebsocket: boolean): boolean;
     getMxJigCmdManager(): CmdMangerType;
-    loadSVG(url: string, color?: ColorType, callResult?: any): void;
+    loadSVG(url: string, color?: number | string | THREE.Color, callResult?: any): void;
     getTHREE(): any;
 }
 /**

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

@@ -1,5 +1,4 @@
 import { Vector3, Line, Object3D, Points, Sprite, Mesh, MeshBasicMaterial } from 'three';
-declare type ColorType = number | string | THREE.Color;
 /**
  * MxThreeJS 模块
  * ##### 使用说明:
@@ -57,7 +56,7 @@ export default class MxThreeJS {
      * Mx.MxThreeJS.createLine(new Three.Vector3(1,10,0), new Three.Vector3(1,300,0), 0)
      * ```
      */
-    createLine(vPt1: Vector3, vPt2: Vector3, iColor: ColorType): Line;
+    createLine(vPt1: Vector3, vPt2: Vector3, iColor: number | string | THREE.Color): Line;
     /**
      * 创建Three.js圆对象。
      * @param mCenterPt 圆中心点
@@ -69,7 +68,7 @@ export default class MxThreeJS {
      * Mx.MxThreeJS.createCircle(new Three.Vector3(1,10,0), 10, 0)
      * ```
      */
-    createCircle(mCenterPt: Vector3, dRadius: number, iColor: ColorType): Object3D;
+    createCircle(mCenterPt: Vector3, dRadius: number, iColor: number | string | THREE.Color): Object3D;
     /**
      * 创建Three.js点对象。
      * @param mPt 点位置
@@ -80,7 +79,7 @@ export default class MxThreeJS {
      * Mx.MxThreeJS.createPoint(new Three.Vector3(1,10,0), 0)
      * ```
      */
-    createPoint(mPt: Vector3, iColor: ColorType): Points;
+    createPoint(mPt: Vector3, iColor: number | string | THREE.Color): Points;
     /**
      * 创建Three.js 文字
      * @param message 文字信息
@@ -110,7 +109,7 @@ export default class MxThreeJS {
      * )
      * ```
      */
-    createTriangle(points: Array<Vector3>, iColor: ColorType, opacity?: number): Mesh | null;
+    createTriangle(points: Array<Vector3>, iColor: number | string | THREE.Color, opacity?: number): Mesh | null;
     /**
      * 创建连续直线
      * @param points 由多个点组成的数组
@@ -121,7 +120,7 @@ export default class MxThreeJS {
      * Mx.MxThreeJS.createLines([new THREE.Vector3(1,2,2),new THREE.Vector3(1,65,4),new THREE.Vector3(12,2,2)], 0)
      * ```
      */
-    createLines(points: Array<Vector3>, iColor: ColorType): Line;
+    createLines(points: Array<Vector3>, iColor: number | string | THREE.Color): Line;
     /**
      * 创建虚线
      * @param points 由多个点组成的数组
@@ -134,7 +133,7 @@ export default class MxThreeJS {
      * Mx.MxThreeJS.createDashedLines([new THREE.Vector3(1,2,2),new THREE.Vector3(1,65,4),new THREE.Vector3(12,2,2)], 10, 20, 2)
      * ```
      */
-    createDashedLines(points: Array<Vector3>, iColor: ColorType, dashSize: number, gapSize: number): Line;
+    createDashedLines(points: Array<Vector3>, iColor: number | string | THREE.Color, dashSize: number, gapSize: number): Line;
     /**
      * 创建Image
      * @param pos 图片中心点位置,屏幕坐标，屏幕坐标的Y轴向上。坐标原点在左下角.
@@ -164,6 +163,5 @@ export default class MxThreeJS {
      * })
      * ```
      */
-    loadSVG(url: string, color?: ColorType, callResult?: (threeobj: Object3D, aryMeterial: Array<MeshBasicMaterial>) => void): Promise<THREE.Object3D | null>;
+    loadSVG(url: string, color?: number | string | THREE.Color, callResult?: (threeobj: Object3D, aryMeterial: Array<MeshBasicMaterial>) => void): Promise<THREE.Object3D | null>;
 }
-export {};

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

@@ -17,7 +17,6 @@ declare enum MxCloneType2 {
     /** 动态拖动Clone */
     kDragClone = 2
 }
-export declare type ColorType = number | string | THREE.Color;
 declare const _default: {
     MxCloneType: typeof MxCloneType;
     MxCloneType2: typeof MxCloneType2;

package/dist/types/doc.d.ts

@@ -1,22 +1,36 @@
-/**
- * Mx 模块集
- *
- * @module 模块
- */
-import loadCoreCode from './MxModule/loadCoreCode/loadCoreCode';
-import useCanvasResizeListener from './MxModule/useCanvasResizeListener/useCanvasResizeListener';
-import MxFun from './MxModule/MxFun/MxFun';
-import MxThreeJS from './MxModule/MxThreeJS/MxThreeJS';
-import MxDrawObject from './MxModule/MxDrawObject/MxDrawObject';
-import MrxDbgUiPrPoint from './MxModule/MrxDbgUiPrPoint/MrxDbgUiPrPointClass';
-import McEdGetPointWorldDrawObject from './MxModule/McEdGetPointWorldDrawObject/McEdGetPointWorldDrawObjectClass';
-import MrxDbgUiPrBaseReturn from './MxModule/MrxDbgUiPrBaseReturn/MrxDbgUiPrBaseReturn';
-import McGiWorldDraw from './MxModule/McGiWorldDraw/McGiWorldDraw';
-import McGiWorldDrawType from './MxModule/McGiWorldDrawType/McGiWorldDrawType';
-import MxDbEntity from './MxModule/MxDbEntity/MxDbEntity';
-import MxDbImage from './MxModule/MxDbImage/MxDbImage';
-import MxDbSVG from './MxModule/MxDbSVG/MxDbSVG';
-import MxDbLine from './MxModule/MxDbLine/MxDbLine';
-import MxDbRect from './MxModule/MxDbRect/MxDbRect';
-import MxFilters from './MxModule/MxFilters/MxFilters';
-export { MxFun, MxThreeJS, MxDrawObject, MrxDbgUiPrPoint, McEdGetPointWorldDrawObject, MrxDbgUiPrBaseReturn, loadCoreCode, useCanvasResizeListener, McGiWorldDraw, McGiWorldDrawType, MxDbEntity, MxFilters, MxDbImage, MxDbSVG, MxDbLine, MxDbRect };
+import loadCoreCode from './MxModule/loadCoreCode';
+import store from './MxModule/store';
+import MxFun from './MxModule/MxFun';
+import MxThreeJS from './MxModule/MxThreeJS';
+import MrxDbgUiPrPoint from './MxModule/MrxDbgUiPrPoint';
+import McEdGetPointWorldDrawObject from './MxModule/McEdGetPointWorldDrawObject';
+import useCanvasResizeListener from './MxModule/useCanvasResizeListener';
+import MrxDbgUiPrBaseReturn from './MxModule/MrxDbgUiPrBaseReturn';
+import MxDbEntity from './MxModule/MxDbEntity';
+import MxDbImage from './MxModule/MxDbImage';
+import MxDbSVG from './MxModule/MxDbSVG';
+import MxDbSVGText from './MxModule/MxDbSVGText';
+import MxDbPolyline from './MxModule/MxDbPolyline';
+import MxDb2LineAngularDimension from './MxModule/MxDb2LineAngularDimension';
+import Mx3PointArc from './MxModule/Mx3PointArc';
+import MxDbCoord from './MxModule/MxDbCoord';
+import MxDbLine from './MxModule/MxDbLine';
+import MxDbRect from './MxModule/MxDbRect';
+import MxDbAlignedDimension from './MxModule/MxDbAlignedDimension';
+import MxFilters from './MxModule/MxFilters';
+import McGiWorldDraw from './MxModule/McGiWorldDraw';
+import McGiWorldDrawType from './MxModule/McGiWorldDrawType';
+import MxType from './MxModule/MxType';
+import Mxassembly from './MxModule/Mxassembly';
+import MxDbArea from './MxModule/MxDbArea';
+import MxDbAnyLine from './MxModule/MxDbAnyLine';
+import MxDbCloudLine from './MxModule/MxDbCloudLine';
+import MxDbRegularPolygon from './MxModule/MxDbRegularPolygon';
+import McGePoint3d from './MxModule/McGePoint3d';
+import McGePoint3dArray from './MxModule/McGePoint3dArray';
+import McGeTool from './MxModule/McGeTool';
+import MxDbLeadComment from './MxModule/MxDbLeadComment';
+import MxDbRectBoxLeadComment from './MxModule/MxDbRectBoxLeadComment';
+import MxDbEllipse from './MxModule/MxDbEllipse';
+import MxDbText from './MxModule/MxDbText';
+export { MxFun, Mxassembly, MxThreeJS, McEdGetPointWorldDrawObject, MrxDbgUiPrPoint, McGePoint3d, McGePoint3dArray, McGeTool, MxDbEntity, MxFilters, MxDbImage, MxDbLine, MxDbSVG, MxDbSVGText, MxDbPolyline, Mx3PointArc, MxDbCoord, MxDb2LineAngularDimension, MxDbRect, MxDbAlignedDimension, useCanvasResizeListener, loadCoreCode, store, McGiWorldDraw, McGiWorldDrawType, MrxDbgUiPrBaseReturn, MxType, MxDbArea, MxDbAnyLine, MxDbCloudLine, MxDbLeadComment, MxDbRectBoxLeadComment, MxDbEllipse, MxDbText, MxDbRegularPolygon };

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

@@ -1,4 +1,3 @@
-import { ColorType } from '@/MxModule/MxType/MxType';
 import { Vector3, Color, Line, Geometry, LineLoop } from 'three';
 /**
  * 移动geometry坐标。
@@ -58,7 +57,7 @@ export declare function createThreePointArc(pt1: Vector3, pt2: Vector3, pt3: Vec
 export declare function createAnyLine(points: Vector3[]): Line;
 /**
  * 绘制椭圆 */
-export declare function createThreeEllipse(pt1: Vector3, pt3: Vector3, color: ColorType): Line;
+export declare function createThreeEllipse(pt1: Vector3, pt3: Vector3, color: number | string | THREE.Color): Line;
 export declare function computeRegularPolygonVertices(centerPt?: Vector3, pt?: Vector3, segments?: number): Vector3[];
 /**
  * 创建正多边形
@@ -66,4 +65,4 @@ export declare function computeRegularPolygonVertices(centerPt?: Vector3, pt?: V
  * @param pt 边角一点
  * @param segments 边数
  * */
-export declare function createThreeRegularPolygon(centerPt: Vector3, pt: Vector3, segments: number, color: ColorType): LineLoop;
+export declare function createThreeRegularPolygon(centerPt: Vector3, pt: Vector3, segments: number, color: number | string | THREE.Color): LineLoop;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mxdraw",
-  "version": "0.1.28",
+  "version": "0.1.31",
   "description": "",
   "keywords": [],
   "main": "dist/mxdraw.umd.js",