mxcad_2d API 文档 / 2d / McDbBlockTableRecord

Class: McDbBlockTableRecord

2d.McDbBlockTableRecord

McDbBlockTableRecord 是块表记录对象，用于管理图块定义中的实体集合、基点和块属性。

Description

该类表示 CAD 中的一个块定义记录，主要用于维护块内部的实体内容、块基点和块名称。 通过它可以完成：

• 向块中添加实体对象；
• 获取块中所有实体的对象 ID；
• 设置块的基点、边界框和名称；
• 作为块参照的定义来源，后续可通过 McDbBlockReference 进行显示和插入。

使用方法总结：

1. 创建 McDbBlockTableRecord 实例；
2. 调用 appendAcDbEntity() 将实体加入块中；
3. 通过 origin、name 等属性设置块的基点和名称；
4. 将该块记录添加到块表中，再用 McDbBlockReference 创建块参照显示。

Example

   // 添加图块
   import { MxCpp, McDbBlockTableRecord, McDbBlockReference, McDbLine, McCmColor } from "mxcad"

   let mxcad = MxCpp.getCurrentMxCAD();
   let blkTable =  mxcad.getDatabase().getBlockTable();
   let blkRecId = blkTable.add(new McDbBlockTableRecord());

   // 根据ObjectId再次得到刚刚添加的图块记录
   let blkTableRecord:McDbBlockTableRecord = blkRecId.getMcDbBlockTableRecord()

   // 添加两条线段再图块记录中 这里每条线段的具体属性比如开始点和结束点自行赋值
   const line = new McDbLine(80, 80, 0, -80, -80, 0)
   line.trueColor = new McCmColor(255, 0, 0)
   const line1 = new McDbLine(-80, 80, 0, 80, -80, 0)
   blkTableRecord.appendAcDbEntity(line);
   blkTableRecord.appendAcDbEntity(line1);

   // 设置图块的基点 一般是包围盒内的点， 可以任意指定
   blkTableRecord.origin = new McGePoint3d(0,0,0);

   // 实例化块参照 这里需要设置我们刚刚添加图块记录得到的ObjectId
   let blkRef = new McDbBlockReference();
   blkRef.blockTableRecordId = blkRecId;
   // 最后设置位置 渲染图块
   blkRef.position = new McGePoint3d(0,0,0);

   mxcad.drawEntity(blkRef);

   // 改块颜色
   import { McDbBlockTableRecord, MxCADResbuf, MxCpp, McCmColor} from "mxcad";
   
   // 选择块对象并修改其颜色。
   async function Mx_BlkColor() {
       // 选择目标块
       let filter = new MxCADResbuf();
       filter.AddMcDbEntityTypes("INSERT");// 设置过滤器，选择块对象
       const getBlockEvent = new MxCADUiPrEntity()
       getBlockEvent.setMessage('选择需要修改基点的块');
       getBlockEvent.setFilter(filter);
       const block_id = await getBlockEvent.go();
       if (!block_id.id) return;
       // 块实体
       const blkRef = block_id.getMcDbEntity() as McDbBlockReference;
       let blkRec = blkRef.blockTableRecordId.getMcDbBlockTableRecord();
       Mx_ModyfBlockRecordEntityColor(blkRec);// 设置块颜色类型为随块

       // 设置块颜色
       const getColor = new MxCADUiPrInt();
       getColor.setMessage('输入颜色索引(0~256)');
       let colorNum = await getColor.go() || 0;
       let color = new McCmColor();
       color.setColorIndex(colorNum);
       blkRef.trueColor = color;
       const mxcad = MxCpp.getCurrentMxCAD();
       mxcad.updateDisplay()
   }
   // 设置块颜色类型
   function Mx_ModyfBlockRecordEntityColor(blkRec: McDbBlockTableRecord) {
       blkRec.getAllEntityId().forEach(id => {
           let ent = id.getMcDbEntity();
           ent.colorIndex = ColorIndexType.kByblock;
           if (ent instanceof McDbBlockReference) {
               let blkref = ent as McDbBlockReference;
               Mx_ModyfBlockRecordEntityColor(blkref.blockTableRecordId.getMcDbBlockTableRecord());
           }
       })
   }

Hierarchy

• McDbObject

  ↳ McDbBlockTableRecord

Table of contents

Constructors

• constructor

Properties

• imp

Accessors

• dxf0
• name
• objectName
• origin

Methods

• appendAcDbEntity
• assertObjectModification
• clone
• createExtensionDictionary
• erase
• getAllEntityId
• getBoundingBox
• getDatabase
• getDatabaseIndexId
• getExtensionDictionary
• getGripEditBasePointsIndex
• getGripPoints
• getHandle
• getImp
• getJson
• getMinMaxDrawOrder
• getObjectID
• getOwnerID
• initTempObject
• invalidBoundingBoxBuffer
• isErased
• isHaveExtensionDictionary
• isKindOf
• isNull
• moveGripPointsAt
• setJson
• unErase

Constructors

constructor

• new McDbBlockTableRecord(imp?)

构造函数。

Parameters

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

Overrides

McDbObject.constructor

Properties

imp

• imp: any = 0

内部实现对象。

Inherited from

McDbObject.imp

Accessors

dxf0

• get dxf0(): string

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

Returns

string

Inherited from

McDbObject.dxf0

---

name

• get name(): string

获取或设置名称。

Returns

string

• set name(val): void

Parameters

Name	Type
val	string

Returns

void

---

objectName

• get objectName(): string

获取对象名称。

Returns

string

返回对象名

Inherited from

McDbObject.objectName

---

origin

• get origin(): McGePoint3d

图块原点

Returns

McGePoint3d

三维点向量

• set origin(origin): void

Parameters

Name	Type
origin	McGePoint3d

Returns

void

Methods

appendAcDbEntity

▸ appendAcDbEntity(pEntity): McObjectId

给图块添加对应实体

Parameters

Name	Type	Description
pEntity	McDbEntity	实体

Returns

McObjectId

对象id

---

assertObjectModification

▸ assertObjectModification(autoUndo?): number

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

Parameters

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

Returns

number

Inherited from

McDbObject.assertObjectModification

---

clone

▸ clone(): null | McDbObject

克隆对象。

Returns

null | McDbObject

克隆出的对象。

Inherited from

McDbObject.clone

---

createExtensionDictionary

▸ createExtensionDictionary(): boolean

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

Returns

boolean

Inherited from

McDbObject.createExtensionDictionary

---

erase

▸ erase(): boolean

删除对象。

Returns

boolean

是否删除成功。

Inherited from

McDbObject.erase

---

getAllEntityId

▸ getAllEntityId(skipDeleted?): McObjectId[]

获取图块中所有实体的对象ID

Parameters

Name	Type	Default value
skipDeleted	boolean	true

Returns

McObjectId[]

---

getBoundingBox

▸ getBoundingBox(): Object

得到图块最小外包，获取图块的最大点和最小点

Returns

Object

minPt:最小点 | maxPt:最大点 | ret:是否获取成功

Name	Type
maxPt	McGePoint3d
minPt	McGePoint3d
ret	boolean

---

getDatabase

▸ getDatabase(): McDbDatabase

得到对象所在的数据库

Returns

McDbDatabase

返回数据库

Inherited from

McDbObject.getDatabase

---

getDatabaseIndexId

▸ getDatabaseIndexId(): number

获取对象的索引ID

Returns

number

Inherited from

McDbObject.getDatabaseIndexId

---

getExtensionDictionary

▸ getExtensionDictionary(): McDbDictionary

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

Returns

McDbDictionary

扩展字典数据

Inherited from

McDbObject.getExtensionDictionary

---

getGripEditBasePointsIndex

▸ getGripEditBasePointsIndex(): number[]

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

Returns

number[]

Inherited from

McDbObject.getGripEditBasePointsIndex

---

getGripPoints

▸ getGripPoints(): McGePoint3dArray

获取对象的夹点数组

Returns

McGePoint3dArray

Inherited from

McDbObject.getGripPoints

---

getHandle

▸ getHandle(): string

得到对象句柄

Returns

string

返回对象句柄

Inherited from

McDbObject.getHandle

---

getImp

▸ getImp(): any

获取内部实现对象。

Returns

any

内部实现对象。

Inherited from

McDbObject.getImp

---

getJson

▸ getJson(): string

获取 JSON 格式的字符串。

Returns

string

JSON 格式的字符串。

Inherited from

McDbObject.getJson

---

getMinMaxDrawOrder

▸ getMinMaxDrawOrder(): Object

返回块表记录中所有对象的最小，最大显示顺序.

Returns

Object

minDrawOrder: 最小显示顺序 | maxDrawOrder: 最大显示顺序

Name	Type
maxDrawOrder	number
minDrawOrder	number

---

getObjectID

▸ getObjectID(): McObjectId

获取对象 ID。

Returns

McObjectId

对象 ID。

Inherited from

McDbObject.getObjectID

---

getOwnerID

▸ getOwnerID(): number

得到对象拥用者的id

Returns

number

Inherited from

McDbObject.getOwnerID

---

initTempObject

▸ initTempObject(imp): void

初始化临时对象。

Parameters

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

Returns

void

Inherited from

McDbObject.initTempObject

---

invalidBoundingBoxBuffer

▸ invalidBoundingBoxBuffer(): void

使边界框缓冲区无效化，强制重新计算或更新边界框信息

Returns

void

---

isErased

▸ isErased(): boolean

对象是否已经删除

Returns

boolean

Inherited from

McDbObject.isErased

---

isHaveExtensionDictionary

▸ isHaveExtensionDictionary(): boolean

是否有扩展字典数据.

Returns

boolean

Inherited from

McDbObject.isHaveExtensionDictionary

---

isKindOf

▸ isKindOf(sObjectName): boolean

判断对象类型

Parameters

Name	Type	Description
sObjectName	string	类型名

Returns

boolean

返回对象是否是目标类型

Inherited from

McDbObject.isKindOf

---

isNull

▸ isNull(): any

判断是否为空对象

Returns

any

Inherited from

McDbObject.isNull

---

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

McDbObject.moveGripPointsAt

---

setJson

▸ setJson(str): boolean

设置 JSON 格式的字符串。

Parameters

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

Returns

boolean

是否设置成功。

Inherited from

McDbObject.setJson

---

unErase

▸ unErase(): boolean

反删除对象。

Returns

boolean

Inherited from

McDbObject.unErase