mxcad_2d API 文档 / 2d / McDbBlockReference

Class: McDbBlockReference ​

2d.McDbBlockReference

表示一个 CAD 图块引用实体，一个块参考用于放置、缩放和显示它参考的McDbBlockTableRecord中的一个实体集合的实例

Hierarchy ​

• McDbEntity

  ↳ McDbBlockReference

Table of contents ​

Constructors ​

• constructor

Properties ​

• imp

Accessors ​

• blockName
• blockTableRecordId
• blockTransform
• colorIndex
• drawOrder
• dxf0
• layer
• layerId
• linetype
• linetypeId
• linetypeScale
• lineweight
• objectName
• position
• rotation
• scaleFactors
• textStyle
• textStyleId
• trueColor
• visible

Methods ​

• IntersectWith
• appendAttribute
• clone
• constructor_MxCADResbuf
• createAttribute
• createExtensionDictionary
• deleteXData
• disableDisplay
• erase
• explode
• freeTempRelationObject
• getAllAppName
• getAllAttribute
• getArea
• getBoundingBox
• getDatabase
• getDatabaseIndexId
• getExtensionDictionary
• getGripPoints
• getHandle
• getImp
• getJson
• getObjectID
• getOwnerID
• getScale
• getxData
• getxDataDouble
• getxDataLong
• getxDataPoint
• getxDataString
• highlight
• initTempObject
• isErased
• isHaveExtensionDictionary
• isKindOf
• isNull
• mirror
• move
• moveGripPointsAt
• rotate
• scaleEntity
• setJson
• setScale
• setxData
• setxDataDouble
• setxDataLong
• setxDataPoint
• setxDataString
• syncData
• tempRelationObject
• transformBy
• unErase
• updateDisplay

Constructors ​

constructor ​

• new McDbBlockReference(imp?)

初始化一个新的 McDbBlockReference 实例。

Parameters ​

Overrides ​

McDbEntity.constructor

Properties ​

imp ​

• imp: any = 0

内部实现对象。

Inherited from ​

McDbEntity.imp

Accessors ​

blockName ​

• get blockName(): string

获取块名

Returns ​

string

块名

blockTableRecordId ​

• get blockTableRecordId(): McObjectId

获取或设置该实体所引用的图块的 ID。

Returns ​

McObjectId

• set blockTableRecordId(val): void

Parameters ​

Returns ​

void

blockTransform ​

• get blockTransform(): McGeMatrix3d

获取或设置该实体所引用的图块的变换矩阵。

Returns ​

McGeMatrix3d

• set blockTransform(val): void

Parameters ​

Returns ​

void

colorIndex ​

• get colorIndex(): number

得到对象颜色索引

Example

import { McDbEntity, ColorIndexType } from 'mxcad'
 const ent = new McDbEntity();
 ent.colorIndex = ColorIndexType.kByblock;
 console.log(ent.colorIndex)

Returns ​

number

Inherited from ​

McDbEntity.colorIndex

• set colorIndex(val): void

设置对象颜色索引

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.colorIndex

drawOrder ​

• get drawOrder(): number

对象的显示顺序

Returns ​

number

Inherited from ​

McDbEntity.drawOrder

• set drawOrder(order): void

对象的显示顺序

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.drawOrder

dxf0 ​

• get dxf0(): string

获取 DXF 代码 0 的值。

Returns ​

string

Inherited from ​

McDbEntity.dxf0

layer ​

• get layer(): string

得到对象图层名

Returns ​

string

Inherited from ​

McDbEntity.layer

• set layer(val): void

设置对象图层名

Example

import { McDbEntity } from 'mxcad'
 const ent = new McDbEntity();
 ent.layer = "newLayerName";
 console.log(ent.layer)

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.layer

layerId ​

• get layerId(): McObjectId

图层ID对象

Returns ​

McObjectId

Inherited from ​

McDbEntity.layerId

• set layerId(id): void

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.layerId

linetype ​

• get linetype(): string

得到对象线型名

Returns ​

string

Inherited from ​

McDbEntity.linetype

• set linetype(val): void

设置对象线型名

Example

import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.linetype = "MyLineType";
console.log(ent.linetype)

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.linetype

linetypeId ​

• get linetypeId(): McObjectId

线型ID对象

Returns ​

McObjectId

Inherited from ​

McDbEntity.linetypeId

• set linetypeId(id): void

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.linetypeId

linetypeScale ​

• get linetypeScale(): number

得到对象线型比例

Returns ​

number

Inherited from ​

McDbEntity.linetypeScale

• set linetypeScale(val): void

设置对象线型比例

Example

import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.linetypeScale = 0.8;
console.log(ent.linetypeScale)

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.linetypeScale

lineweight ​

• get lineweight(): number

得到对象线重

Returns ​

number

Inherited from ​

McDbEntity.lineweight

• set lineweight(val): void

设置对象线重

Example

import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.lineweight = 20;
console.log(ent.lineweight)

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.lineweight

objectName ​

• get objectName(): string

获取对象名称。

Returns ​

string

Inherited from ​

McDbEntity.objectName

position ​

• get position(): McGePoint3d

获取或设置该实体的位置。

Returns ​

McGePoint3d

• set position(pt): void

Parameters ​

Returns ​

void

rotation ​

• get rotation(): number

获取或设置该实体的旋转角度。

Returns ​

number

• set rotation(val): void

Parameters ​

Returns ​

void

scaleFactors ​

• get scaleFactors(): McGePoint3d

获取或设置该实体的缩放因子。

Returns ​

McGePoint3d

• set scaleFactors(val): void

Parameters ​

Returns ​

void

textStyle ​

• get textStyle(): string

得到对象文字样式

Returns ​

string

Inherited from ​

McDbEntity.textStyle

• set textStyle(val): void

设置对象文字样式

Example

import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.textStyle = "st_style";

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.textStyle

textStyleId ​

• get textStyleId(): McObjectId

文字样式ID对象

Returns ​

McObjectId

Inherited from ​

McDbEntity.textStyleId

• set textStyleId(id): void

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.textStyleId

trueColor ​

• get trueColor(): McCmColor

得到对象颜色

Example

import { McDbEntity, McCmColor} from 'mxcad'
 const ent = new McDbEntity();
 ent.trueColor = new McCmColor(255, 0, 0);
 console.log(ent.trueColor)

Returns ​

McCmColor

Inherited from ​

McDbEntity.trueColor

• set trueColor(val): void

设置对象颜色

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.trueColor

visible ​

• get visible(): boolean

对象是否可见

Returns ​

boolean

Inherited from ​

McDbEntity.visible

• set visible(val): void

设置是否可见

Example

import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.visible = true;
console.log(ent.visible)

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.visible

Methods ​

IntersectWith ​

▸ IntersectWith(intersectObject, exOption): 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)

Parameters ​

Returns ​

McGePoint3dArray

得到所有交点

Inherited from ​

McDbEntity.IntersectWith

appendAttribute ​

▸ appendAttribute(attrib): McObjectId

添加属性文字对象

Parameters ​

Returns ​

McObjectId

块名

clone ​

▸ clone(): null | McDbObject

克隆对象。

Returns ​

null | McDbObject

克隆出的对象。

Inherited from ​

McDbEntity.clone

constructor_MxCADResbuf ​

▸ Protected constructor_MxCADResbuf(imp): void

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.constructor_MxCADResbuf

createAttribute ​

▸ createAttribute(): boolean

通过块表记录中的属性定义创建属性文字对象

Returns ​

boolean

createExtensionDictionary ​

▸ createExtensionDictionary(): boolean

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

Returns ​

boolean

Inherited from ​

McDbEntity.createExtensionDictionary

deleteXData ​

▸ deleteXData(appName): boolean

删除实体的指定 XData 类型中的点（McGePoint3d）值

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.deleteXData

disableDisplay ​

▸ disableDisplay(isDisable): void

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

Example

import { McDbLine } from 'mxcad'
const line1 = new McDbLine(new McGePoint3d(0,0,0), new McGePoint3d(20,1,0));
line1.disableDisplay(true)

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.disableDisplay

erase ​

▸ erase(): boolean

删除对象。

Returns ​

boolean

是否删除成功。

Inherited from ​

McDbEntity.erase

explode ​

▸ explode(): MxCADResbuf

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

Returns ​

MxCADResbuf

Inherited from ​

McDbEntity.explode

freeTempRelationObject ​

▸ freeTempRelationObject(): void

释放临时关系对象

Returns ​

void

Inherited from ​

McDbEntity.freeTempRelationObject

getAllAppName ​

▸ getAllAppName(): McGeStringArray

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

Returns ​

McGeStringArray

Inherited from ​

McDbEntity.getAllAppName

getAllAttribute ​

▸ getAllAttribute(): McObjectId[]

得到块引用的所有属性文字对象id

Returns ​

McObjectId[]

块名

getArea ​

▸ getArea(): Object

计算面积

Returns ​

Object

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

Inherited from ​

McDbEntity.getArea

getBoundingBox ​

▸ getBoundingBox(): Object

得到对象的最小外包

Example

import { McDbText, McGePoint3d } from 'mxcad'
const text = new McDbText();
text.textString = "测试Test";
  text.height = 20;
  text.position = text.alignmentPoint = new McGePoint3d(0,0,0);
const { minPt, maxPt, ret } = text.getBoundingBox()

Returns ​

Object

Inherited from ​

McDbEntity.getBoundingBox

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

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

getScale ​

▸ getScale(): number

Returns ​

number

getxData ​

▸ getxData(appName?): MxCADResbuf

得到对象的扩展数据

Parameters ​

Returns ​

MxCADResbuf

Inherited from ​

McDbEntity.getxData

getxDataDouble ​

▸ getxDataDouble(appName): Object

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

Parameters ​

Returns ​

Object

double 值

Inherited from ​

McDbEntity.getxDataDouble

getxDataLong ​

▸ getxDataLong(appName): Object

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

Parameters ​

Returns ​

Object

long 值

Inherited from ​

McDbEntity.getxDataLong

getxDataPoint ​

▸ getxDataPoint(appName): Object

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

Parameters ​

Returns ​

Object

Inherited from ​

McDbEntity.getxDataPoint

getxDataString ​

▸ getxDataString(appName): Object

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

Parameters ​

Returns ​

Object

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

Inherited from ​

McDbEntity.getxDataString

highlight ​

▸ highlight(isHighlight): void

设置对象是否高亮

Example

import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.isHighlight(true);

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.highlight

initTempObject ​

▸ initTempObject(imp): void

初始化临时对象。

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.initTempObject

isErased ​

▸ isErased(): boolean

对象是否已经删除

Returns ​

boolean

Inherited from ​

McDbEntity.isErased

isHaveExtensionDictionary ​

▸ isHaveExtensionDictionary(): boolean

是否有扩展字典数据.

Returns ​

boolean

Inherited from ​

McDbEntity.isHaveExtensionDictionary

isKindOf ​

▸ isKindOf(sObjectName): boolean

判断对象类型

Parameters ​

Returns ​

boolean

返回对象是否是目标类型

Inherited from ​

McDbEntity.isKindOf

isNull ​

▸ isNull(): any

判断是否为空对象

Returns ​

any

Inherited from ​

McDbEntity.isNull

mirror ​

▸ mirror(point1, point2): boolean

镜向对象

Example

import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.mirror(new McGePoint3d(0,0,0), new McGePoint3d(20,10,0))

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.mirror

move ​

▸ move(fromPoint, toPoint): boolean

移动对象

Example

import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.move(new McGePoint3d(0,0,0), new McGePoint3d(20,0,0))

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.move

moveGripPointsAt ​

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

移动对象的控制点

Parameters ​

Returns ​

any

Inherited from ​

McDbEntity.moveGripPointsAt

rotate ​

▸ rotate(basePoint, dRotationAngle): boolean

旋转对象

Example

import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.rotate(new McGePoint3d(0,0,0), Math.PI)

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.rotate

scaleEntity ​

▸ scaleEntity(basePoint, dScaleFactor): boolean

缩放对象

Example

import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.scaleEntity(new McGePoint3d(0,0,0), 0.5)

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.scaleEntity

setJson ​

▸ setJson(str): boolean

设置 JSON 格式的字符串。

Parameters ​

Returns ​

boolean

是否设置成功。

Inherited from ​

McDbEntity.setJson

setScale ​

▸ setScale(val): void

Parameters ​

Returns ​

void

setxData ​

▸ setxData(xdata): boolean

设置对象的扩展数据

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.setxData

setxDataDouble ​

▸ setxDataDouble(appName, val): boolean

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.setxDataDouble

setxDataLong ​

▸ setxDataLong(appName, val): boolean

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.setxDataLong

setxDataPoint ​

▸ setxDataPoint(appName, val): boolean

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.setxDataPoint

setxDataString ​

▸ setxDataString(appName, val): boolean

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

Parameters ​

Returns ​

boolean

是否设置成功

Inherited from ​

McDbEntity.setxDataString

syncData ​

▸ syncData(_toCpp?): boolean

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

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.syncData

tempRelationObject ​

▸ tempRelationObject(): number

与对象相关的临时关系数

Returns ​

number

Inherited from ​

McDbEntity.tempRelationObject

transformBy ​

▸ transformBy(transformationMatrix): boolean

变换对象

Example

import { McGeMatrix3d, McDbEntity, McGeVector3d} from 'mxcad'
 const ent = new McDbEntity()
   let matrix = new McGeMatrix3d();
   matrix.setToTranslation(new McGeVector3d(20,0,0));//平移
   ent.transformBy(matrix);

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.transformBy

unErase ​

▸ unErase(): boolean

反删除对象。

Returns ​

boolean

Inherited from ​

McDbEntity.unErase

updateDisplay ​

▸ updateDisplay(): void

显示调用对象更新显示.

Returns ​

void

Inherited from ​

McDbEntity.updateDisplay