Skip to content
On this page

mxcad API 文档 / McDbEntity

Class: McDbEntity

具有一个图形表示的所有数据库对象的基类,包括了显示实体的通用属性操作,如线型,图层,文字样式,颜色,几何外包等

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new McDbEntity(imp?)

构造函数。

Parameters

NameTypeDescription
imp?any内部实现对象。

Overrides

McDbObject.constructor

Properties

imp

imp: any = 0

内部实现对象。

Inherited from

McDbObject.imp

Accessors

colorIndex

get colorIndex(): number

得到对象颜色索引

Example

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

Returns

number

set colorIndex(val): void

设置对象颜色索引

Parameters

NameTypeDescription
valnumber颜色索引(ColorIndexType)

Returns

void


drawOrder

get drawOrder(): number

对象的显示顺序

Returns

number

set drawOrder(order): void

对象的显示顺序

Parameters

NameTypeDescription
ordernumber顺序值

Returns

void


dxf0

get dxf0(): string

获取 DXF 代码 0 的值。

Returns

string

Inherited from

McDbObject.dxf0


layer

get layer(): string

得到对象图层名

Returns

string

set layer(val): void

设置对象图层名

Parameters

NameTypeDescription
valstring图层名

Returns

void


layerId

get layerId(): McObjectId

图层ID对象

Returns

McObjectId

set layerId(id): void

Parameters

NameType
idMcObjectId

Returns

void


linetype

get linetype(): string

得到对象线型名

Returns

string

set linetype(val): void

设置对象线型名

Parameters

NameTypeDescription
valstring线型名

Returns

void


linetypeId

get linetypeId(): McObjectId

线型ID对象

Returns

McObjectId

set linetypeId(id): void

Parameters

NameType
idMcObjectId

Returns

void


linetypeScale

get linetypeScale(): number

得到对象线型比例

Returns

number

set linetypeScale(val): void

设置对象线型比例

Parameters

NameTypeDescription
valnumber线型比例

Returns

void


lineweight

get lineweight(): number

得到对象线重

Returns

number

set lineweight(val): void

设置对象线重

Parameters

NameTypeDescription
valnumber线重

Returns

void


objectName

get objectName(): string

获取对象名称。

Returns

string

Inherited from

McDbObject.objectName


textStyle

get textStyle(): string

得到对象文字样式

Returns

string

set textStyle(val): void

设置对象文字样式

Example

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

Parameters

NameTypeDescription
valstring文字样式名

Returns

void


textStyleId

get textStyleId(): McObjectId

文字样式ID对象

Returns

McObjectId

set textStyleId(id): void

Parameters

NameType
idMcObjectId

Returns

void


trueColor

get trueColor(): McCmColor

得到对象颜色

Example

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

Returns

McCmColor

set trueColor(val): void

设置对象颜色

Parameters

NameType
valMcCmColor

Returns

void


visible

get visible(): boolean

对象是否可见

Returns

boolean

set visible(val): void

设置是否可见

Parameters

NameTypeDescription
valboolean布尔值

Returns

void

Methods

IntersectWith

IntersectWith(intersectObject, exOption): McGePoint3dArray

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

Example

ts
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

NameTypeDescription
intersectObjectMcDbEntity需要相交的是实体对象
exOptionIntersect相交的选项

Returns

McGePoint3dArray

得到所有交点


clone

clone(): null | McDbObject

克隆对象。

Returns

null | McDbObject

克隆出的对象。

Inherited from

McDbObject.clone


constructor_MxCADResbuf

Protected constructor_MxCADResbuf(imp): void

Parameters

NameType
impany

Returns

void

Inherited from

McDbObject.constructor_MxCADResbuf


createExtensionDictionary

createExtensionDictionary(): boolean

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

Returns

boolean

Inherited from

McDbObject.createExtensionDictionary


deleteXData

deleteXData(appName): boolean

删除实体的指定 XData 类型中的点(McGePoint3d)值

Parameters

NameTypeDescription
appNamestringXData 类型

Returns

boolean


disableDisplay

disableDisplay(isDisable): void

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

Example

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

Parameters

NameTypeDescription
isDisableboolean是否禁用对象自动更新显示

Returns

void


erase

erase(): boolean

删除对象。

Returns

boolean

是否删除成功。

Inherited from

McDbObject.erase


explode

explode(): MxCADResbuf

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

Returns

MxCADResbuf


freeTempRelationObject

freeTempRelationObject(): void

释放临时关系对象

Returns

void

Inherited from

McDbObject.freeTempRelationObject


getAllAppName

getAllAppName(): McGeStringArray

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

Returns

McGeStringArray


getArea

getArea(): Object

计算面积

Returns

Object

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

NameType
retboolean
valnumber

getBoundingBox

getBoundingBox(): Object

得到对象的最小外包

Example

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

Returns

Object

NameType
maxPtMcGePoint3d
minPtMcGePoint3d
retboolean

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


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


getObjectID

getObjectID(): McObjectId

获取对象 ID。

Returns

McObjectId

对象 ID。

Inherited from

McDbObject.getObjectID


getOwnerID

getOwnerID(): number

得到对象拥用者的id

Returns

number

Inherited from

McDbObject.getOwnerID


getxData

getxData(appName?): MxCADResbuf

得到对象的扩展数据

Parameters

NameTypeDefault valueDescription
appNamestring""XData 类型

Returns

MxCADResbuf


getxDataDouble

getxDataDouble(appName): Object

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

Parameters

NameTypeDescription
appNamestringXData 类型

Returns

Object

double 值

NameType
retboolean
valnumber

getxDataLong

getxDataLong(appName): Object

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

Parameters

NameTypeDescription
appNamestringXData 类型

Returns

Object

long 值

NameType
retboolean
valnumber

getxDataPoint

getxDataPoint(appName): Object

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

Parameters

NameTypeDescription
appNamestringXData 类型

Returns

Object

NameType
retboolean
valMcGePoint3d

getxDataString

getxDataString(appName): Object

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

Parameters

NameTypeDescription
appNamestringXData 类型

Returns

Object

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

NameType
retboolean
valstring

highlight

highlight(isHighlight): void

设置对象是否高亮

Example

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

Parameters

NameTypeDescription
isHighlightboolean是否高亮

Returns

void


initTempObject

initTempObject(imp): void

初始化临时对象。

Parameters

NameTypeDescription
impany内部实现对象。

Returns

void

Inherited from

McDbObject.initTempObject


isErased

isErased(): boolean

对象是否已经删除

Returns

boolean

Inherited from

McDbObject.isErased


isHaveExtensionDictionary

isHaveExtensionDictionary(): boolean

是否有扩展字典数据.

Returns

boolean

Inherited from

McDbObject.isHaveExtensionDictionary


isKindOf

isKindOf(sObjectName): boolean

Parameters

NameType
sObjectNamestring

Returns

boolean

Inherited from

McDbObject.isKindOf


isNull

isNull(): any

Returns

any

Inherited from

McDbObject.isNull


mirror

mirror(point1, point2): boolean

镜向对象

Parameters

NameTypeDescription
point1McGePoint3d镜像基点
point2McGePoint3d镜像点

Returns

boolean


move

move(fromPoint, toPoint): boolean

移动对象

Example

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

Parameters

NameTypeDescription
fromPointMcGePoint3d移动开始点
toPointMcGePoint3d移动结束点

Returns

boolean


moveGripPointsAt

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

移动对象的控制点

Parameters

NameTypeDescription
iIndexnumber索引
dXOffsetnumberX轴偏移量
dYOffsetnumberY轴偏移量
dZOffsetnumberZ轴偏移量

Returns

any

Inherited from

McDbObject.moveGripPointsAt


rotate

rotate(basePoint, dRotationAngle): boolean

旋转对象

Example

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

Parameters

NameTypeDescription
basePointMcGePoint3d旋转基点
dRotationAnglenumber旋转角度

Returns

boolean


scaleEntity

scaleEntity(basePoint, dScaleFactor): boolean

缩放对象

Example

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

Parameters

NameTypeDescription
basePointMcGePoint3d缩放基点
dScaleFactornumber缩放因子(<1 缩小; >1 放大)

Returns

boolean


setJson

setJson(str): boolean

设置 JSON 格式的字符串。

Parameters

NameTypeDescription
strstringJSON 格式的字符串。

Returns

boolean

是否设置成功。

Inherited from

McDbObject.setJson


setxData

setxData(xdata): boolean

设置对象的扩展数据

Parameters

NameTypeDescription
xdataMxCADResbufresbuf 数据

Returns

boolean


setxDataDouble

setxDataDouble(appName, val): boolean

Parameters

NameType
appNamestring
valnumber

Returns

boolean


setxDataLong

setxDataLong(appName, val): boolean

Parameters

NameType
appNamestring
valnumber

Returns

boolean


setxDataPoint

setxDataPoint(appName, val): boolean

Parameters

NameType
appNamestring
valMcGePoint3d

Returns

boolean


setxDataString

setxDataString(appName, val): boolean

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

Parameters

NameTypeDescription
appNamestringXData 类型
valstringXData信息

Returns

boolean

是否设置成功


syncData

syncData(_toCpp?): boolean

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

Parameters

NameTypeDefault valueDescription
_toCppbooleantrue是否同步数据

Returns

boolean


tempRelationObject

tempRelationObject(): number

与对象相关的临时关系数

Returns

number

Inherited from

McDbObject.tempRelationObject


transformBy

transformBy(transformationMatrix): boolean

变换对象

Example

ts
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

NameTypeDescription
transformationMatrixMcGeMatrix3d变换矩阵

Returns

boolean


unErase

unErase(): boolean

反删除对象。

Returns

boolean

Inherited from

McDbObject.unErase


updateDisplay

updateDisplay(): void

显示调用对象更新显示.

Returns

void