mxcad 1.0.162 → 1.0.164

package/dist/mxcad.d.ts

@@ -307,6 +307,7 @@ export declare class McGeVector3d {
 	 * @param dZ Z 坐标。
 	 */
 	constructor(dX?: number | object, dY?: number, dZ?: number);
+	/** 转换为THREE.Vector3  */
 	toVector3(): THREE.Vector3;
 	/**
 	 * 复制对象的值
@@ -317,18 +318,34 @@ export declare class McGeVector3d {
 	 */
 	clone(): McGeVector3d;
 	c(): McGeVector3d;
+	/** 旋转
+	 * @param ang 旋转角度。
+	 * @param axis 旋转轴向量
+	 *  */
 	rotateBy(ang: number, axis?: McGeVector3d): this;
+	/** 向量取反 */
 	negate(): this;
+	/** 垂直的向量 */
 	perpVector(): this;
+	/** 计算角度 */
 	angleTo1(vec: McGeVector3d): number;
+	/** 计算角度 */
 	angleTo2(vec: McGeVector3d, refVec: McGeVector3d): number;
+	/** 归一化操作 */
 	normalize(): this;
+	/** 向量长度 */
 	length(): number;
+	/** 是否为单位向量 */
 	isUnitLength(): boolean;
+	/** 是否为零向量 */
 	isZeroLength(): boolean;
+	/** 点积 */
 	dotProduct(vec: McGeVector3d): number;
+	/** 交叉积 */
 	crossProduct(vec: McGeVector3d): McGeVector3d;
+	/** 判断比较向量是否相等 */
 	isEqualTo(vec: McGeVector3d): boolean;
+	/** 向量与某个值相乘 */
 	mult(val: number): this;
 	/**
 	 * X 坐标。
@@ -2185,26 +2202,53 @@ export declare class McDbHatch extends McDbEntity {
 	 * @param imp 内部对象。
 	 */
 	constructor(x?: object);
+	/** 循环次数 */
 	get numLoops(): number;
+	/** 某次循环索引中的类型 */
 	loopTypeAt(loopIndex: number): number;
+	/** 获取索引的值
+	 * @param loopIndex  index 循环的索引
+	 * @returns { Object } ret 是否成功获取 | lootype 类型 | vertices 坐标集合 | bulges凸度集合
+	 * @example
+	 * ```ts
+	 * import { McDbHatch } from "mxcad"
+	 * const hatch = new McDbHatch()
+	 * const numLoops = hatch.numLoops;
+	 * for (let i = 0; i < numLoops; i++) {
+	 *    const loop = hatch.getLoopAt(i);
+	 *    console.log(loop)
+	 * };
+	 * ```
+	 *  */
 	getLoopAt(loopIndex: number): {
 		ret: boolean;
 		lootype: number;
 		vertices: McGePoint3d[];
 		bulges: number[];
 	};
+	/** 填充图案类型 */
 	patternType(): number;
+	/** 填充图案名称 */
 	patternName(): string;
+	/** 设置填充图案 */
 	setPattern(type: number, patName: string): void;
+	/** 填充图案角度 */
 	get patternAngle(): number;
 	set patternAngle(angle: number);
+	/** 填充图案缩放比例 */
 	get patternScale(): number;
 	set patternScale(scale: number);
+	/** 填充图案空间 */
 	get patternSpace(): number;
 	set patternSpace(space: number);
 	get patternDouble(): boolean;
 	set patternDouble(isDouble: boolean);
+	/** 图案定义的数量 */
 	get numPatternDefinitions(): number;
+	/** 获取对应图案定义的数据
+	 * @param index 索引
+	 * @returns { Object } ret 是否成功获取 | angle 角度 | baseX, baseY 基点位置 | offsetX, offsetY 偏移位置 | aryDashes 短划线数据
+	 *  */
 	getPatternDefinitionAt(index: number): {
 		ret: boolean;
 		angle: number;
@@ -2214,14 +2258,45 @@ export declare class McDbHatch extends McDbEntity {
 		offsetY: number;
 		aryDashes: number[];
 	};
+	/** 添加图案定义
+	 * @param angle 角度 如 45
+	 * @param baseX 基点x坐标
+	 * @param baseY 基点y坐标
+	 * @param offsetX 偏移x坐标
+	 * @param offsetY 偏移y坐标
+	 * @param dashes 短划线数据
+	 * @example
+	 * ```ts
+	 * import { McDbHatch } from "mxcad"
+	 * const hatch = new McDbHatch()
+	 * hatch.addPatternDefinition(45, 0, 0, 0, 0.25, [45, 0.17677695, 0, 0, 0.25, 0.125, -0.0625])
+	 * ```
+	 * @returns { Boolean } 是否成功添加图案定义
+	 *  */
 	addPatternDefinition(angle: number, baseX: number, baseY: number, offsetX: number, offsetY: number, dashes: number[]): boolean;
+	/** 清空图案定义 */
 	clearPatternDefinition(): boolean;
+	/** 填充样式 */
 	hatchStyle(): McDb.HatchStyle;
+	/** 设置填充样式 */
 	setHatchStyle(val: McDb.HatchStyle): void;
 	evaluateHatch(): boolean;
+	/** 追加循环
+	 * @param loopType 循环类型
+	 * @param vertices 坐标集合
+	 * @param bulges 凸度集合
+	 *  */
 	appendLoop(loopType: number, vertices: McGePoint3dArray, bulges: number[]): boolean;
+	/** 删除某个索引下的循环 */
 	removeLoopAt(loopIndex: number): boolean;
+	/** 删除所有循环 */
 	removeAllLoop(): boolean;
+	/** 设置某个索引下的循环数据
+	 * @param loopIndex 循环索引
+	 * @param loopType 循环类型
+	 * @param vertices 坐标集合
+	 * @param bulges 凸度集合
+	 *  */
 	setLoopAt(loopIndex: number, loopType: number, vertices: McGePoint3dArray, bulges: number[]): boolean;
 	isSolid(): boolean;
 }
@@ -2826,7 +2901,7 @@ export declare class McObject {
 	/** 监听对象选择事件
 	 * @example
 	 * ```ts
-	 * import { MxCpp } from mxdraw
+	 * import { MxCpp } from "mxcad"
 	 * MxCpp.getCurrentMxCAD().on("selectChange", (ids)=> {
 	 *      let ent = id.getMcDbEntity()
 	 *      if(!ent) return
@@ -2929,7 +3004,7 @@ export declare class McObject {
 	 * @param fetchAttributes 1：EMSCRIPTEN_FETCH_LOAD_TO_MEMORY,把图纸数据加载内存中，0:EMSCRIPTEN_FETCH_LOAD_TO_MEMORY | EMSCRIPTEN_FETCH_PERSIST_FILE | EMSCRIPTEN_FETCH_APPEND，把图纸数据加到IndexedDB。
 	 * @returns 是否成功打开文件
 	 */
-	openWebFile(sFileUrl: string, retCall?: (iRet: number) => void, isWorkThread?: boolean, initialParameter?: object, fetchAttributes?: number): boolean;
+	openWebFile(sFileUrl: string, retCall?: (iRet: number) => void, isWorkThread?: boolean, initialParameter?: object, fetchAttributes?: number, isFetchTzFile?: boolean): boolean;
 	/**
 	*清空当前图上内容，新建一个文件
 	*/
@@ -3909,12 +3984,17 @@ export declare class Color extends ObjectInheritance {
 }
 export interface Color extends McCmColor {
 }
-/** 绘制文字 */
-export declare function drawText(): Promise<void>;
-/** 绘制圆*/
-export declare function drawCircle(): void;
+/** 绘制文字
+ * @param height 文字高度
+ * @param text 文字内容
+ * @param position 文字位置
+ * @param angle 文件角度
+ * @param color 文字颜色
+ */
+export declare function drawText(): Promise<McObjectId | undefined>;
+export declare function drawCircle(): Promise<McObjectId | undefined>;
 export declare function drawLine(): Promise<void>;
-export declare function drawMText(): Promise<void>;
+export declare function drawMText(): Promise<McObjectId | undefined>;
 export declare function drawPolyLine(): Promise<void>;
 export declare function drawPolygon(): Promise<void>;
 export declare function drawArc(): Promise<void>;