mxcad_2d API 文档 / 2d / McDbMxRegion

Class: McDbMxRegion

2d.McDbMxRegion

McDbMxRegion 是面域对象类，用于创建和操作二维面域几何。

Description

该类用于表示 CAD 中的面域对象，可通过边界轮廓进行创建，并支持布尔运算、偏移和三角化等操作。

使用方法总结：

1. 先创建 McDbMxRegion 实例。
2. 再添加轮廓边界并设置必要的几何参数。
3. 最后根据需要执行布尔运算、偏移或三角化处理。

Example

import { McDbMxRegion, McGePoint3dArray, MxCpp } from "mxcad";

const region = new McDbMxRegion();
const points = new McGePoint3dArray();
points.append(new McGePoint3d(0, 0, 0));
points.append(new McGePoint3d(10, 0, 0));
points.append(new McGePoint3d(10, 10, 0));
points.append(new McGePoint3d(0, 10, 0));
region.addContour(points);
MxCpp.getCurrentMxCAD().drawEntity(region);

Hierarchy

• McDbEntity

  ↳ McDbMxRegion

Table of contents

Constructors

• constructor

Properties

• imp

Accessors

• colorIndex
• drawOrder
• dxf0
• layer
• layerId
• linetype
• linetypeId
• linetypeScale
• lineweight
• normal
• objectName
• textStyle
• textStyleId
• thickness
• trueColor
• visible

Methods

• IntersectWith
• addContour
• addEntityContour
• assertObjectModification
• booleanOption
• clearData
• clone
• copyData
• createExtensionDictionary
• deleteXData
• disableDisplay
• erase
• explode
• getAllAppName
• getArea
• getBoundingBox
• getContour
• getContourCount
• getDatabase
• getDatabaseIndexId
• getExtensionDictionary
• getGripEditBasePointsIndex
• getGripPoints
• getHandle
• getImp
• getJson
• getObjectID
• getOwnerID
• getxData
• getxDataDouble
• getxDataLong
• getxDataPoint
• getxDataString
• highlight
• inflatePaths
• initTempObject
• isEmpty
• isErased
• isHaveExtensionDictionary
• isKindOf
• isNull
• mirror
• move
• moveGripPointsAt
• rotate
• scaleEntity
• setJson
• setxData
• setxDataDouble
• setxDataLong
• setxDataPoint
• setxDataString
• syncData
• transformBy
• triangulate
• unErase
• updateDisplay

Constructors

constructor

• new McDbMxRegion(imp?)

构造函数。

Parameters

Name	Type	Description
imp?	any	内部对象。

Overrides

McDbEntity.constructor

Properties

imp

• imp: any = 0

内部实现对象。

Inherited from

McDbEntity.imp

Accessors

colorIndex

• get colorIndex(): number

得到对象颜色索引

Returns

number

Inherited from

McDbEntity.colorIndex

• set colorIndex(val): void

设置对象颜色索引

Parameters

Name	Type	Description
val	number	颜色索引（ColorIndexType）

Returns

void

Inherited from

McDbEntity.colorIndex

---

drawOrder

• get drawOrder(): number

对象的显示顺序

Returns

number

Inherited from

McDbEntity.drawOrder

• set drawOrder(order): void

对象的显示顺序

Parameters

Name	Type	Description
order	number	顺序值

Returns

void

Example

import { MxCpp, MxCADSelectionSet } from "mxcad";

let ss = new MxCADSelectionSet();
if (!await ss.userSelect("\n选择对象")) return;
//得到当前图上对象的最大，小最显示顺序.
let minmaxOrder = MxCpp.getCurrentDatabase().currentSpace.getMinMaxDrawOrder();
// 把对象放到最上面。
let lOrder = minmaxOrder.maxDrawOrder + 1;
ss.forEach((id) => {
  let ent = id.getMcDbEntity();
  if (ent) {
    ent.drawOrder = lOrder;
  }
})

Inherited from

McDbEntity.drawOrder

---

dxf0

• get dxf0(): string

得到对象的DXF组码的类型名，这个和AutoCAD中的DXF组码是一样。 比如直线的类型名为：McDbLine，DXF0组码值: LINE,DXF0组码值可以用来构造集时的类型过滤。

Returns

string

Inherited from

McDbEntity.dxf0

---

layer

• get layer(): string

得到对象图层名

Returns

string

Inherited from

McDbEntity.layer

• set layer(val): void

设置对象图层名

Parameters

Name	Type	Description
val	string	图层名

Returns

void

Inherited from

McDbEntity.layer

---

layerId

• get layerId(): McObjectId

获取图层ID对象

Returns

McObjectId

Inherited from

McDbEntity.layerId

• set layerId(id): void

设置图层Id对象

Parameters

Name	Type
id	McObjectId

Returns

void

Inherited from

McDbEntity.layerId

---

linetype

• get linetype(): string

得到对象线型名

Returns

string

Inherited from

McDbEntity.linetype

• set linetype(val): void

设置对象线型名

Parameters

Name	Type	Description
val	string	线型名

Returns

void

Inherited from

McDbEntity.linetype

---

linetypeId

• get linetypeId(): McObjectId

获取实体对象线型ID

Returns

McObjectId

Inherited from

McDbEntity.linetypeId

• set linetypeId(id): void

设置实体对象线型ID

Parameters

Name	Type
id	McObjectId

Returns

void

Inherited from

McDbEntity.linetypeId

---

linetypeScale

• get linetypeScale(): number

得到对象线型比例

Returns

number

Inherited from

McDbEntity.linetypeScale

• set linetypeScale(val): void

设置对象线型比例

Parameters

Name	Type	Description
val	number	线型比例

Returns

void

Inherited from

McDbEntity.linetypeScale

---

lineweight

• get lineweight(): number

得到对象线重

Returns

number

Inherited from

McDbEntity.lineweight

• set lineweight(val): void

设置对象线重

Parameters

Name	Type	Description
val	number	线重

Returns

void

Inherited from

McDbEntity.lineweight

---

normal

• get normal(): McGeVector3d

返回对象的normal

Returns

McGeVector3d

Inherited from

McDbEntity.normal

• set normal(val): void

设置对象的normal

Parameters

Name	Type
val	McGeVector3d

Returns

void

Inherited from

McDbEntity.normal

---

objectName

• get objectName(): string

获取对象名称。

Returns

string

返回对象名

Inherited from

McDbEntity.objectName

---

textStyle

• get textStyle(): string

得到对象文字样式

Returns

string

Inherited from

McDbEntity.textStyle

• set textStyle(val): void

设置对象文字样式

Parameters

Name	Type	Description
val	string	文字样式名

Returns

void

Inherited from

McDbEntity.textStyle

---

textStyleId

• get textStyleId(): McObjectId

获取实体文字样式

Returns

McObjectId

Inherited from

McDbEntity.textStyleId

• set textStyleId(id): void

设置实体的文字样式

Parameters

Name	Type
id	McObjectId

Returns

void

Example

import { MxCADUiPrEntity, McDbEntity } from "mxcad";

let selEntity = new MxCADUiPrEntity();
selEntity.setMessage("选择对象");
let id = await selEntity.go();
if (!id.isValid()) return;
let ent:McDbEntity = id.getMcDbEntity();
if (ent === null) return;
const mxcad = MxCpp.getCurrentMxCAD();
const textStyleId = mxcad.addTextStyle("MyLineTypeTextStyle", "txt.shx", "hztxt.shx", 1);
ent.textStyleId = textStyleId;

Inherited from

McDbEntity.textStyleId

---

thickness

• get thickness(): number

得到对象厚度

Returns

number

Inherited from

McDbEntity.thickness

• set thickness(val): void

设置对象厚度

Parameters

Name	Type
val	number

Returns

void

Inherited from

McDbEntity.thickness

---

trueColor

• get trueColor(): McCmColor

得到对象颜色

Returns

McCmColor

Inherited from

McDbEntity.trueColor

• set trueColor(val): void

设置对象颜色

Parameters

Name	Type
val	McCmColor

Returns

void

Inherited from

McDbEntity.trueColor

---

visible

• get visible(): boolean

对象是否可见

Returns

boolean

Inherited from

McDbEntity.visible

• set visible(val): void

设置是否可见

Parameters

Name	Type	Description
val	boolean	布尔值

Returns

void

Inherited from

McDbEntity.visible

Methods

IntersectWith

▸ IntersectWith(intersectObject, exOption): McGePoint3dArray

与其他实体相交, 得到交点

Parameters

Name	Type	Description
intersectObject	McDbEntity	需要相交的是实体对象
exOption	Intersect	相交的选项

Returns

McGePoint3dArray

得到所有交点

Example

import { McDbLine, McDb } from 'mxcad'
const line1 = new McDbLine(new McGePoint3d(0,0,0), new McGePoint3d(20,1,0));
const line2 = new McDbLine(new McGePoint3d(10,10,0), new McGePoint3d(11,1,0));
const ptArr = line1.IntersectWith(line2, McDb.Intersect.kExtendBoth)

Inherited from

McDbEntity.IntersectWith

---

addContour

▸ addContour(points): boolean

给面域添加边界坐标

Parameters

Name	Type
points	McGePoint3dArray

Returns

boolean

---

addEntityContour

▸ addEntityContour(entity, approxEps?): boolean

从一个曲线对象数据给面域添加边界坐标

Parameters

Name	Type	Default value
entity	McDbEntity	undefined
approxEps	number	0.00001

Returns

boolean

---

assertObjectModification

▸ assertObjectModification(autoUndo?): number

设置对象被改变的状态，可自动触发更新显示函数，更新显示。 比如块表记录更新了，需要通知块引用更新显示，可以调用该函数。

Parameters

Name	Type	Default value	Description
autoUndo	boolean	false	这次修改是否要自动支持撤销,默认为false

Returns

number

Inherited from

McDbEntity.assertObjectModification

---

booleanOption

▸ booleanOption(type, other): McDbMxRegion[]

面域与面域之前进行bool运行

Parameters

Name	Type
type	BooleanOptionType
other	McDbMxRegion

Returns

McDbMxRegion[]

---

clearData

▸ clearData(): boolean

清除面域数据

Returns

boolean

---

clone

▸ clone(): null | McDbObject

克隆对象。

Returns

null | McDbObject

克隆出的对象。

Inherited from

McDbEntity.clone

---

copyData

▸ copyData(fromRegion): boolean

从另一个面域数据拷贝数据

Parameters

Name	Type
fromRegion	McDbMxRegion

Returns

boolean

---

createExtensionDictionary

▸ createExtensionDictionary(): boolean

创建对象的扩展字典数据.

Returns

boolean

Inherited from

McDbEntity.createExtensionDictionary

---

deleteXData

▸ deleteXData(appName): boolean

删除实体指定应用程序名称相关的数据

Parameters

Name	Type	Description
appName	string	扩展数据名称

Returns

boolean

Example

import { MxCADUiPrEntity, McDbEntity } from "mxcad";

let selEntity = new MxCADUiPrEntity();
selEntity.setMessage("选择对象");
let id = await selEntity.go();
if (!id.isValid()) return;
let ent:McDbEntity = id.getMcDbEntity();
if (ent === null) return;
const res = ent.deleteXData("DataName");
if(res){
  //删除成功
}else
  //删除失败
}

Inherited from

McDbEntity.deleteXData

---

disableDisplay

▸ disableDisplay(isDisable): void

禁用对象的自动更新显示.

Parameters

Name	Type	Description
isDisable	boolean	是否禁用对象自动更新显示

Returns

void

Inherited from

McDbEntity.disableDisplay

---

erase

▸ erase(): boolean

删除对象。

Returns

boolean

是否删除成功。

Inherited from

McDbEntity.erase

---

explode

▸ explode(): MxCADResbuf

打碎对象，返回打后对象数据链表

Returns

MxCADResbuf

resbuf 数据

Example

import { McDbEntity, MxCADResbuf } from "mxcad";
// 获取目标对象
let getEnt = new MxCADUiPrEntity();
getEnt.setMessage("选择打碎对象:");
let id = await getEnt.go();
let ent:McDbEntity = id.getMcDbEntity();
if (ent === null) return;
// 打碎对象
      let retExplode: MxCADResbuf = ent.explode();
      if (retExplode.GetCount() == 0) return;
      let iExplodeConut = retExplode.GetCount();
      for (let j = 0; j < iExplodeConut; j++) {
          let tmpobj = retExplode.AtObject(j).val;
          if(tmpobj instanceof McDbEntity ){
              mxcad.drawEntity(tmpobj);
          }
      }

Inherited from

McDbEntity.explode

---

getAllAppName

▸ getAllAppName(): McGeStringArray

获取实体中包含的所有 XData 记录的应用程序名（AppName）

Returns

McGeStringArray

Inherited from

McDbEntity.getAllAppName

---

getArea

▸ getArea(): Object

计算面积

Returns

Object

val 面积值 | ret 是否获取成功

Name	Type
ret	boolean
val	number

Example

import { McGePoint3d, McDbCircle } from "mxcad"

const circle = new McDbCircle(0,0,0, 20);
const area = circle.getArea();
console.log("圆面积：", area)

Inherited from

McDbEntity.getArea

---

getBoundingBox

▸ getBoundingBox(): Object

得到对象的最小外包

Returns

Object

Name	Type
maxPt	McGePoint3d
minPt	McGePoint3d
ret	boolean

Inherited from

McDbEntity.getBoundingBox

---

getContour

▸ getContour(index): McGePoint3dArray

得到面域的边界坐标

Parameters

Name	Type
index	number

Returns

McGePoint3dArray

---

getContourCount

▸ getContourCount(): number

得到面域的边界数目

Returns

number

---

getDatabase

▸ getDatabase(): McDbDatabase

得到对象所在的数据库

Returns

McDbDatabase

返回数据库

Inherited from

McDbEntity.getDatabase

---

getDatabaseIndexId

▸ getDatabaseIndexId(): number

获取对象的索引ID

Returns

number

Inherited from

McDbEntity.getDatabaseIndexId

---

getExtensionDictionary

▸ getExtensionDictionary(): McDbDictionary

得到对象的扩展字典数据.

Returns

McDbDictionary

扩展字典数据

Inherited from

McDbEntity.getExtensionDictionary

---

getGripEditBasePointsIndex

▸ getGripEditBasePointsIndex(): number[]

获取对象的夹点对应的编辑基点索引。

Returns

number[]

Inherited from

McDbEntity.getGripEditBasePointsIndex

---

getGripPoints

▸ getGripPoints(): McGePoint3dArray

获取对象的夹点数组

Returns

McGePoint3dArray

Inherited from

McDbEntity.getGripPoints

---

getHandle

▸ getHandle(): string

得到对象句柄

Returns

string

返回对象句柄

Inherited from

McDbEntity.getHandle

---

getImp

▸ getImp(): any

获取内部实现对象。

Returns

any

内部实现对象。

Inherited from

McDbEntity.getImp

---

getJson

▸ getJson(): string

获取 JSON 格式的字符串。

Returns

string

JSON 格式的字符串。

Inherited from

McDbEntity.getJson

---

getObjectID

▸ getObjectID(): McObjectId

获取对象 ID。

Returns

McObjectId

对象 ID。

Inherited from

McDbEntity.getObjectID

---

getOwnerID

▸ getOwnerID(): number

得到对象拥用者的id

Returns

number

Inherited from

McDbEntity.getOwnerID

---

getxData

▸ getxData(appName?): MxCADResbuf

得到对象的扩展数据

Parameters

Name	Type	Default value	Description
appName	string	""	扩展数据名

Returns

MxCADResbuf

Inherited from

McDbEntity.getxData

---

getxDataDouble

▸ getxDataDouble(appName): Object

获取实体的指定 XData 类型中的 double 值

Parameters

Name	Type	Description
appName	string	扩展数据名称

Returns

Object

double 值

Name	Type
ret	boolean
val	number

Inherited from

McDbEntity.getxDataDouble

---

getxDataLong

▸ getxDataLong(appName): Object

获取实体的指定 XData 类型中的 long（整数）值

Parameters

Name	Type	Description
appName	string	扩展数据名称

Returns

Object

long 值

Name	Type
ret	boolean
val	number

Inherited from

McDbEntity.getxDataLong

---

getxDataPoint

▸ getxDataPoint(appName): Object

获取实体的指定 XData 类型中的点对象

Parameters

Name	Type	Description
appName	string	扩展数据名称

Returns

Object

获取结果及三维点对象

Name	Type
ret	boolean
val	McGePoint3d

Inherited from

McDbEntity.getxDataPoint

---

getxDataString

▸ getxDataString(appName): Object

获取与特定实体关联的 XData 信息，并以字符串形式返回

Parameters

Name	Type	Description
appName	string	扩展数据名称

Returns

Object

val XData信息 | ret 是否返回成功

Name	Type
ret	boolean
val	string

Inherited from

McDbEntity.getxDataString

---

highlight

▸ highlight(isHighlight): void

设置对象是否高亮

Parameters

Name	Type	Description
isHighlight	boolean	是否高亮

Returns

void

Inherited from

McDbEntity.highlight

---

inflatePaths

▸ inflatePaths(delta, joinType?, endType?): McDbMxRegion

偏移面域边界

Parameters

Name	Type	Default value
delta	number	undefined
joinType	number	2
endType	number	0

Returns

McDbMxRegion

---

initTempObject

▸ initTempObject(imp): void

初始化临时对象。

Parameters

Name	Type	Description
imp	any	内部实现对象。

Returns

void

Inherited from

McDbEntity.initTempObject

---

isEmpty

▸ isEmpty(): boolean

面域数据是否为空

Returns

boolean

---

isErased

▸ isErased(): boolean

对象是否已经删除

Returns

boolean

Inherited from

McDbEntity.isErased

---

isHaveExtensionDictionary

▸ isHaveExtensionDictionary(): boolean

是否有扩展字典数据.

Returns

boolean

Inherited from

McDbEntity.isHaveExtensionDictionary

---

isKindOf

▸ isKindOf(sObjectName): boolean

判断对象类型

Parameters

Name	Type	Description
sObjectName	string	类型名

Returns

boolean

返回对象是否是目标类型

Inherited from

McDbEntity.isKindOf

---

isNull

▸ isNull(): any

判断是否为空对象

Returns

any

Inherited from

McDbEntity.isNull

---

mirror

▸ mirror(point1, point2): boolean

镜向对象

Parameters

Name	Type	Description
point1	McGePoint3d	镜像基点
point2	McGePoint3d	-

Returns

boolean

Inherited from

McDbEntity.mirror

---

move

▸ move(fromPoint, toPoint): boolean

移动对象

Parameters

Name	Type	Description
fromPoint	McGePoint3d	移动开始点
toPoint	McGePoint3d	移动结束点

Returns

boolean

Inherited from

McDbEntity.move

---

moveGripPointsAt

▸ moveGripPointsAt(iIndex, dXOffset, dYOffset, dZOffset): any

移动对象的夹点

Parameters

Name	Type	Description
iIndex	number	索引
dXOffset	number	X轴偏移量
dYOffset	number	Y轴偏移量
dZOffset	number	Z轴偏移量

Returns

any

Inherited from

McDbEntity.moveGripPointsAt

---

rotate

▸ rotate(basePoint, dRotationAngle): boolean

旋转对象

Parameters

Name	Type	Description
basePoint	McGePoint3d	旋转基点
dRotationAngle	number	旋转角度

Returns

boolean

Inherited from

McDbEntity.rotate

---

scaleEntity

▸ scaleEntity(basePoint, dScaleFactor): boolean

缩放对象

Parameters

Name	Type	Description
basePoint	McGePoint3d	缩放基点
dScaleFactor	number	缩放因子（<1 缩小； >1 放大）

Returns

boolean

Inherited from

McDbEntity.scaleEntity

---

setJson

▸ setJson(str): boolean

设置 JSON 格式的字符串。

Parameters

Name	Type	Description
str	string	JSON 格式的字符串。

Returns

boolean

是否设置成功。

Inherited from

McDbEntity.setJson

---

setxData

▸ setxData(xdata): boolean

设置对象的扩展数据

Parameters

Name	Type	Description
xdata	MxCADResbuf	扩展数据链表

Returns

boolean

Example

import { MxCADUiPrEntity, McDbEntity } from "mxcad";

//设置扩展数据
let selEntity = new MxCADUiPrEntity();
selEntity.setMessage("选择对象");
let id = await selEntity.go();
if (!id.isValid()) return;
let ent:McDbEntity = id.getMcDbEntity();
if (ent === null) return;
ent.setxData(new MxCADResbuf([{type:DxfCode.kExDataName,val:"DataName"},{type:DxfCode.kString,val:"yyyyy"}]));

Inherited from

McDbEntity.setxData

---

setxDataDouble

▸ setxDataDouble(appName, val): boolean

设置实体的指定 XData 类型中的 double 值

Parameters

Name	Type	Description
appName	string	扩展数据名称
val	number	double 值

Returns

boolean

布尔值

Example

import { MxCADUiPrEntity, McDbEntity } from "mxcad";
let selEntity = new MxCADUiPrEntity();
selEntity.setMessage("选择对象");
let id = await selEntity.go();
if (!id.isValid()) return;
let ent:McDbEntity = id.getMcDbEntity();
if (ent === null) return;
const res = ent.setxDataDouble("DataName", 0);
if(res){
  //设置成功
}else{
  //设置失败
}

Inherited from

McDbEntity.setxDataDouble

---

setxDataLong

▸ setxDataLong(appName, val): boolean

设置实体的指定 XData 类型中的 long（整数）值

Parameters

Name	Type	Description
appName	string	扩展数据名称
val	number	long 值

Returns

boolean

long 值

Example

import { MxCADUiPrEntity, McDbEntity } from "mxcad";

let selEntity = new MxCADUiPrEntity();
selEntity.setMessage("选择对象");
let id = await selEntity.go();
if (!id.isValid()) return;
let ent:McDbEntity = id.getMcDbEntity();
if (ent === null) return;
const res = ent.setxDataLong("DataName", 123456);
if(res){
  //设置成功
}else{
  //设置失败
}

Inherited from

McDbEntity.setxDataLong

---

setxDataPoint

▸ setxDataPoint(appName, val): boolean

设置实体的指定 XData 类型中的点对象

Parameters

Name	Type	Description
appName	string	扩展数据名称
val	McGePoint3d	点对象

Returns

boolean

获取结果及三维点对象

Inherited from

McDbEntity.setxDataPoint

---

setxDataString

▸ setxDataString(appName, val): boolean

设置与特定实体关联的 XData 信息，并以字符串形式设置

Parameters

Name	Type	Description
appName	string	扩展数据名称
val	string	字符串值

Returns

boolean

是否设置成功

Inherited from

McDbEntity.setxDataString

---

syncData

▸ syncData(_toCpp?): boolean

同步实体的数据。这个方法可能是在修改了实体的属性或者附加了新的数据之后调用的，以确保所有的改变都被正确地保存到实体的数据库记录中。

Parameters

Name	Type	Default value	Description
_toCpp	boolean	true	是否同步数据

Returns

boolean

Inherited from

McDbEntity.syncData

---

transformBy

▸ transformBy(transformationMatrix): boolean

变换对象

Parameters

Name	Type	Description
transformationMatrix	McGeMatrix3d	变换矩阵

Returns

boolean

Inherited from

McDbEntity.transformBy

---

triangulate

▸ triangulate(useDelaunay?): McDbMxRegion

三角化面域

Parameters

Name	Type	Default value
useDelaunay	boolean	true

Returns

McDbMxRegion

---

unErase

▸ unErase(): boolean

反删除对象。

Returns

boolean

Inherited from

McDbEntity.unErase

---

updateDisplay

▸ updateDisplay(): void

显示调用对象更新显示.

Returns

void

Inherited from

McDbEntity.updateDisplay