mxcad_2d API 文档 / 2d / McDbMLine

Class: McDbMLine

2d.McDbMLine

多线自定义实体类 实现多线绘制功能，支持多线样式、端点样式、填充等特性

Hierarchy

• McDbCustomEntity

  ↳ McDbMLine

Table of contents

Constructors

• constructor

Properties

• imp

Accessors

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

Methods

• IntersectWith
• addVertex
• assertObjectModification
• clearSegmentRelation
• clearVertices
• clone
• create
• createExtensionDictionary
• deleteXData
• disableDisplay
• dwgInFields
• dwgOutFields
• erase
• explode
• getAllAppName
• getAllSegmentRelations
• getArea
• getBoundingBox
• getDatabase
• getDatabaseIndexId
• getExtensionDictionary
• getGripPoints
• getHandle
• getImp
• getIsClosed
• getJson
• getJustification
• getName
• getObjectID
• getOwnerID
• getScale
• getSegmentByIndex
• getSegmentByPoint
• getSegmentRelation
• getStyleName
• getTypeName
• getVertexAt
• getVertexCount
• getVertices
• getxData
• getxDataDouble
• getxDataLong
• getxDataPoint
• getxDataString
• highlight
• initTempObject
• insertVertexAt
• isErased
• isHaveExtensionDictionary
• isKindOf
• isNull
• mergeSegmentRelation
• mirror
• move
• moveGripPointsAt
• removeVertexAt
• rotate
• rxInit
• scaleEntity
• setAllSegmentRelations
• setIsClosed
• setJson
• setJustification
• setScale
• setSegmentRelation
• setStyleName
• setVertexAt
• setxData
• setxDataDouble
• setxDataLong
• setxDataPoint
• setxDataString
• syncData
• transformBy
• unErase
• updateDisplay
• worldDraw

Constructors

constructor

• new McDbMLine(imp?)

Parameters

Name	Type
imp?	any

Overrides

McDbCustomEntity.constructor

Properties

imp

• imp: any = 0

内部实现对象。

Inherited from

McDbCustomEntity.imp

Accessors

colorIndex

• get colorIndex(): number

得到对象颜色索引

Returns

number

Example

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

Inherited from

McDbCustomEntity.colorIndex

• set colorIndex(val): void

设置对象颜色索引

Parameters

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

Returns

void

Inherited from

McDbCustomEntity.colorIndex

---

drawOrder

• get drawOrder(): number

对象的显示顺序

Returns

number

Example

// 假设ent为有效实例对象
const order = ent.drawOrder();

Inherited from

McDbCustomEntity.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

McDbCustomEntity.drawOrder

---

dxf0

• get dxf0(): string

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

Returns

string

Inherited from

McDbCustomEntity.dxf0

---

layer

• get layer(): string

得到对象图层名

Returns

string

Inherited from

McDbCustomEntity.layer

• set layer(val): void

设置对象图层名

Parameters

Name	Type	Description
val	string	图层名

Returns

void

Example

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

Inherited from

McDbCustomEntity.layer

---

layerId

• get layerId(): McObjectId

获取图层ID对象

Returns

McObjectId

Example

// 假设ent为有效实例对象
const layerId = ent.layerId;

Inherited from

McDbCustomEntity.layerId

• set layerId(id): void

设置图层Id对象

Parameters

Name	Type
id	McObjectId

Returns

void

Example

// 假设ent为有效实例对象
const mxcad = MxCpp.getCurrentMxCAD();
const layerId = mxcad.addLayer("测试图层")
ent.layerId = layerId;

Inherited from

McDbCustomEntity.layerId

---

linetype

• get linetype(): string

得到对象线型名

Returns

string

Inherited from

McDbCustomEntity.linetype

• set linetype(val): void

设置对象线型名

Parameters

Name	Type	Description
val	string	线型名

Returns

void

Example

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

Inherited from

McDbCustomEntity.linetype

---

linetypeId

• get linetypeId(): McObjectId

获取实体对象线型ID

Returns

McObjectId

Example

// 假设ent为有效实例对象
const linetypeId = ent.linetypeId;

Inherited from

McDbCustomEntity.linetypeId

• set linetypeId(id): void

设置实体对象线型ID

Parameters

Name	Type
id	McObjectId

Returns

void

Example

// 假设ent为有效实例对象
const mxcad = MxCpp.getCurrentMxCAD();
const lineId = mxcad.addLinetypeEx("TestMyLine", '25,-5');
ent.linetypeId = lineId;

Inherited from

McDbCustomEntity.linetypeId

---

linetypeScale

• get linetypeScale(): number

得到对象线型比例

Returns

number

Inherited from

McDbCustomEntity.linetypeScale

• set linetypeScale(val): void

设置对象线型比例

Parameters

Name	Type	Description
val	number	线型比例

Returns

void

Example

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

Inherited from

McDbCustomEntity.linetypeScale

---

lineweight

• get lineweight(): number

得到对象线重

Returns

number

Inherited from

McDbCustomEntity.lineweight

• set lineweight(val): void

设置对象线重

Parameters

Name	Type	Description
val	number	线重

Returns

void

Example

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

Inherited from

McDbCustomEntity.lineweight

---

normal

• get normal(): McGeVector3d

返回对象的normal

Returns

McGeVector3d

Example

Inherited from

McDbCustomEntity.normal

• set normal(val): void

设置对象的normal

Parameters

Name	Type
val	McGeVector3d

Returns

void

Example

Inherited from

McDbCustomEntity.normal

---

objectName

• get objectName(): string

获取对象名称。

Returns

string

返回对象名

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
console.log(obj.objectName);

Inherited from

McDbCustomEntity.objectName

---

textStyle

• get textStyle(): string

得到对象文字样式

Returns

string

Inherited from

McDbCustomEntity.textStyle

• set textStyle(val): void

设置对象文字样式

Parameters

Name	Type	Description
val	string	文字样式名

Returns

void

Example

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

Inherited from

McDbCustomEntity.textStyle

---

textStyleId

• get textStyleId(): McObjectId

获取实体文字样式

Returns

McObjectId

Example

// 假设ent为有效实例对象
const textStyleId = ent.textStyleId;

Inherited from

McDbCustomEntity.textStyleId

• set textStyleId(id): void

设置实体的文字样式

Parameters

Name	Type
id	McObjectId

Returns

void

Example

// 假设ent为有效实例对象
const mxcad = MxCpp.getCurrentMxCAD();
const textStyleId = mxcad.addTextStyle("MyLineTypeTextStyle", "txt.shx", "hztxt.shx", 1);
ent.textStyleId = textStyleId;

Inherited from

McDbCustomEntity.textStyleId

---

trueColor

• get trueColor(): McCmColor

得到对象颜色

Returns

McCmColor

Example

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

Inherited from

McDbCustomEntity.trueColor

• set trueColor(val): void

设置对象颜色

Parameters

Name	Type
val	McCmColor

Returns

void

Inherited from

McDbCustomEntity.trueColor

---

visible

• get visible(): boolean

对象是否可见

Returns

boolean

Inherited from

McDbCustomEntity.visible

• set visible(val): void

设置是否可见

Parameters

Name	Type	Description
val	boolean	布尔值

Returns

void

Example

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

Inherited from

McDbCustomEntity.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

McDbCustomEntity.IntersectWith

---

addVertex

▸ addVertex(point): void

添加顶点

Parameters

Name	Type
point	McGePoint3d

Returns

void

---

assertObjectModification

▸ assertObjectModification(autoUndo?): number

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

Parameters

Name	Type	Default value
autoUndo	boolean	false

Returns

number

Example

//假设obj为一个数据库对象
obj.assertObjectModification()

Inherited from

McDbCustomEntity.assertObjectModification

---

clearSegmentRelation

▸ clearSegmentRelation(segmentIndex, relatedSegmentIndex?): void

清除指定线段的关联数据

Parameters

Name	Type	Description
segmentIndex	number	要清除的线段索引
relatedSegmentIndex?	number	要清除的关联线段索引（可选，如果不提供则清除整个segmentIndex的数据）

Returns

void

---

clearVertices

▸ clearVertices(): void

清除所有顶点

Returns

void

---

clone

▸ clone(): null | McDbObject

复制实体

Returns

null | McDbObject

Example

import { McDbCustomEntity } from "mxcad";

const customEnt = new McDbCustomEntity();// 构造新自定义实体对象
const cloneEnt = customEnt.clone();// 复制实体

Inherited from

McDbCustomEntity.clone

---

create

▸ create(imp): McDbMLine

创建实体的工厂方法

Parameters

Name	Type
imp	any

Returns

McDbMLine

Overrides

McDbCustomEntity.create

---

createExtensionDictionary

▸ createExtensionDictionary(): boolean

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

Returns

boolean

Example

//假设obj为一个数据库对象
const res = obj.createExtensionDictionary();

Inherited from

McDbCustomEntity.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

McDbCustomEntity.deleteXData

---

disableDisplay

▸ disableDisplay(isDisable): void

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

Parameters

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

Returns

void

Example

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

Inherited from

McDbCustomEntity.disableDisplay

---

dwgInFields

▸ dwgInFields(filter): boolean

从数据文件读取实体数据

Parameters

Name	Type
filter	IMcDbDwgFiler

Returns

boolean

Overrides

McDbCustomEntity.dwgInFields

---

dwgOutFields

▸ dwgOutFields(filter): boolean

将实体数据写入到数据文件

Parameters

Name	Type
filter	IMcDbDwgFiler

Returns

boolean

Overrides

McDbCustomEntity.dwgOutFields

---

erase

▸ erase(): boolean

删除对象。

Returns

boolean

是否删除成功。

Example

//假设obj为一个数据库对象
const res = obj.erase();
console.log(res);

Inherited from

McDbCustomEntity.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

McDbCustomEntity.explode

---

getAllAppName

▸ getAllAppName(): McGeStringArray

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

Returns

McGeStringArray

Example

// 假设ent为有效实例对象
const appNames = ent.getAllAppName();
console.log(appNames);

Inherited from

McDbCustomEntity.getAllAppName

---

getAllSegmentRelations

▸ getAllSegmentRelations(): SegmentRelationsData

获取所有线段关联数据

Returns

SegmentRelationsData

完整的线段关联数据结构

---

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

McDbCustomEntity.getArea

---

getBoundingBox

▸ getBoundingBox(): Object

得到对象的最小外包

Returns

Object

Name	Type
maxPt	McGePoint3d
minPt	McGePoint3d
ret	boolean

Inherited from

McDbCustomEntity.getBoundingBox

---

getDatabase

▸ getDatabase(): McDbDatabase

得到对象所在的数据库

Returns

McDbDatabase

返回数据库

Example

//假设obj为一个数据库对象
const data = obj.getDatabase();

Inherited from

McDbCustomEntity.getDatabase

---

getDatabaseIndexId

▸ getDatabaseIndexId(): number

获取对象的索引ID

Returns

number

Example

//假设obj为一个数据库对象
const id = obj.getDatabaseIndexId();

Inherited from

McDbCustomEntity.getDatabaseIndexId

---

getExtensionDictionary

▸ getExtensionDictionary(): McDbDictionary

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

Returns

McDbDictionary

扩展字典数据

Example

//假设obj为一个数据库对象
const id = obj.getOwnerID();

Inherited from

McDbCustomEntity.getExtensionDictionary

---

getGripPoints

▸ getGripPoints(): McGePoint3dArray

获取实体的控制点

Returns

McGePoint3dArray

Overrides

McDbCustomEntity.getGripPoints

---

getHandle

▸ getHandle(): string

得到对象句柄

Returns

string

返回对象句柄

Example

//假设obj为一个数据库对象
const handle = obj.getHandle();

Inherited from

McDbCustomEntity.getHandle

---

getImp

▸ getImp(): any

获取内部实现对象。

Returns

any

内部实现对象。

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
let imp = obj.getImp();

Inherited from

McDbCustomEntity.getImp

---

getIsClosed

▸ getIsClosed(): boolean

获取闭合状态

Returns

boolean

---

getJson

▸ getJson(): string

获取 JSON 格式的字符串。

Returns

string

JSON 格式的字符串。

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
const json = obj.getJson()

Inherited from

McDbCustomEntity.getJson

---

getJustification

▸ getJustification(): number

获取对齐方式

Returns

number

---

getName

▸ getName(): string

获取自定义对象名称

Returns

string

Inherited from

McDbCustomEntity.getName

---

getObjectID

▸ getObjectID(): McObjectId

获取对象 ID。

Returns

McObjectId

对象 ID。

Example

import { McDbObject } from "mxcad";
const id = obj.getObjectID();

Inherited from

McDbCustomEntity.getObjectID

---

getOwnerID

▸ getOwnerID(): number

得到对象拥用者的id

Returns

number

Example

//假设obj为一个数据库对象
const id = obj.getOwnerID();

Inherited from

McDbCustomEntity.getOwnerID

---

getScale

▸ getScale(): number

获取比例

Returns

number

---

getSegmentByIndex

▸ getSegmentByIndex(segmentIndex): null | PointSegmentRelation

根据索引获取线段数据

Parameters

Name	Type	Description
segmentIndex	number	线段索引

Returns

null | PointSegmentRelation

找到的线段信息，包括线段索引、偏移线段索引及相关数据

---

getSegmentByPoint

▸ getSegmentByPoint(point): null | PointSegmentRelation

根据点获取线段索引

Parameters

Name	Type	Description
point	McGePoint3d	选择点坐标

Returns

null | PointSegmentRelation

找到的线段信息，包括线段索引、偏移线段索引及点击位置

---

getSegmentRelation

▸ getSegmentRelation(segmentIndex, relatedSegmentIndex?): null | SegmentPointPair[] | { [relatedSegmentIndex: number]: SegmentPointPair[]; }

获取线段关联数据

Parameters

Name	Type	Description
segmentIndex	number	当前多线的线段索引
relatedSegmentIndex?	number	相关联多线的线段索引（可选）

Returns

null | SegmentPointPair[] | { [relatedSegmentIndex: number]: SegmentPointPair[]; }

如果提供了relatedSegmentIndex，返回对应的点对数组；否则返回所有关联数据

---

getStyleName

▸ getStyleName(): string

获取样式名称

Returns

string

---

getTypeName

▸ getTypeName(): string

获取实体类型名称

Returns

string

Overrides

McDbCustomEntity.getTypeName

---

getVertexAt

▸ getVertexAt(index): null | McGePoint3d

获取顶点

Parameters

Name	Type
index	number

Returns

null | McGePoint3d

---

getVertexCount

▸ getVertexCount(): number

获取顶点数量

Returns

number

---

getVertices

▸ getVertices(): McGePoint3d[]

Returns

McGePoint3d[]

---

getxData

▸ getxData(appName?): MxCADResbuf

得到对象的扩展数据

Parameters

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

Returns

MxCADResbuf

Example

// 假设ent为有效实例对象
const xData = ent.getXData();

Inherited from

McDbCustomEntity.getxData

---

getxDataDouble

▸ getxDataDouble(appName): Object

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

Parameters

Name	Type	Description
appName	string	扩展数据名称

Returns

Object

double 值

Name	Type
ret	boolean
val	number

Example

// 假设ent为有效实例对象
let data = ent.getxDataDouble("DataName");
if(data.ret){
  console.log(data.val)
}

Inherited from

McDbCustomEntity.getxDataDouble

---

getxDataLong

▸ getxDataLong(appName): Object

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

Parameters

Name	Type	Description
appName	string	扩展数据名称

Returns

Object

long 值

Name	Type
ret	boolean
val	number

Example

// 假设ent为有效实例对象
let data = ent.getxDataLong("DataName");
if(data.ret){
  console.log(data.val)
}

Inherited from

McDbCustomEntity.getxDataLong

---

getxDataPoint

▸ getxDataPoint(appName): Object

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

Parameters

Name	Type	Description
appName	string	扩展数据名称

Returns

Object

获取结果及三维点对象

Name	Type
ret	boolean
val	McGePoint3d

Inherited from

McDbCustomEntity.getxDataPoint

---

getxDataString

▸ getxDataString(appName): Object

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

Parameters

Name	Type	Description
appName	string	扩展数据名称

Returns

Object

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

Name	Type
ret	boolean
val	string

Example

// 假设ent为有效实例对象
let data = ent.getxDataString("DataName");
if(data.ret){
  console.log(data.val)
}

Inherited from

McDbCustomEntity.getxDataString

---

highlight

▸ highlight(isHighlight): void

设置对象是否高亮

Parameters

Name	Type	Description
isHighlight	boolean	是否高亮

Returns

void

Example

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

Inherited from

McDbCustomEntity.highlight

---

initTempObject

▸ initTempObject(imp): void

初始化临时对象。

Parameters

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

Returns

void

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
obj.initTempObject()

Inherited from

McDbCustomEntity.initTempObject

---

insertVertexAt

▸ insertVertexAt(index, point): boolean

在指定位置插入顶点

Parameters

Name	Type	Description
index	number	要插入的位置索引
point	McGePoint3d	要插入的点

Returns

boolean

是否插入成功

---

isErased

▸ isErased(): boolean

对象是否已经删除

Returns

boolean

Example

//假设obj为一个数据库对象
const res = obj.isErased();
console.log(res);

Inherited from

McDbCustomEntity.isErased

---

isHaveExtensionDictionary

▸ isHaveExtensionDictionary(): boolean

是否有扩展字典数据.

Returns

boolean

Example

//假设obj为一个数据库对象
const res = obj.isHaveExtensionDictionary();

Inherited from

McDbCustomEntity.isHaveExtensionDictionary

---

isKindOf

▸ isKindOf(sObjectName): boolean

判断对象类型

Parameters

Name	Type	Description
sObjectName	string	类型名

Returns

boolean

返回对象是否是目标类型

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
let isKind = obj.isKindOf('SomeObjectType');
console.log(isKind); // 输出: true 或 false

Inherited from

McDbCustomEntity.isKindOf

---

isNull

▸ isNull(): any

判断是否为空对象

Returns

any

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
console.log(obj.isNull()); // 输出: true 或 false

Inherited from

McDbCustomEntity.isNull

---

mergeSegmentRelation

▸ mergeSegmentRelation(segmentIndex, relatedSegmentIndex, startPt, endPt): void

合并指定区域（从startPt到endPt）的关联数据

Parameters

Name	Type
segmentIndex	number
relatedSegmentIndex	number
startPt	McGePoint3d
endPt	McGePoint3d

Returns

void

---

mirror

▸ mirror(point1, point2): boolean

镜向对象

Parameters

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

Returns

boolean

Example

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

Inherited from

McDbCustomEntity.mirror

---

move

▸ move(fromPoint, toPoint): boolean

移动对象

Parameters

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

Returns

boolean

Example

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

Inherited from

McDbCustomEntity.move

---

moveGripPointsAt

▸ moveGripPointsAt(index, deltaX, deltaY, deltaZ): void

移动指定索引的控制点

Parameters

Name	Type
index	number
deltaX	number
deltaY	number
deltaZ	number

Returns

void

Overrides

McDbCustomEntity.moveGripPointsAt

---

removeVertexAt

▸ removeVertexAt(index): void

移除顶点

Parameters

Name	Type
index	number

Returns

void

---

rotate

▸ rotate(basePoint, dRotationAngle): boolean

旋转对象

Parameters

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

Returns

boolean

Example

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

Inherited from

McDbCustomEntity.rotate

---

rxInit

▸ rxInit(): void

自定义实体注册

Returns

void

Example

import { MxFun } from 'mxdraw
// MxCAD创建成功
MxFun.on("mxcadApplicationCreatedMxCADObject", (param) => {
// McDbTestLineCustomEntity 自定义实体
  new McDbTestLineCustomEntity().rxInit();// 自定义实体注册
  MxFun.addCommand("MxTest_DrawCustomEntity");// 注册绘制实体命令
})

Inherited from

McDbCustomEntity.rxInit

---

scaleEntity

▸ scaleEntity(basePoint, dScaleFactor): boolean

缩放对象

Parameters

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

Returns

boolean

Example

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

Inherited from

McDbCustomEntity.scaleEntity

---

setAllSegmentRelations

▸ setAllSegmentRelations(data): void

设置所有线段关联数据

Parameters

Name	Type	Description
data	SegmentRelationsData	完整的线段关联数据结构

Returns

void

---

setIsClosed

▸ setIsClosed(isClosed): void

设置闭合状态

Parameters

Name	Type
isClosed	boolean

Returns

void

---

setJson

▸ setJson(str): boolean

设置 JSON 格式的字符串。

Parameters

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

Returns

boolean

是否设置成功。

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
const res = obj.setJson('{"key": "value"}');
console.log(res)

Inherited from

McDbCustomEntity.setJson

---

setJustification

▸ setJustification(justification): void

设置对齐方式

Parameters

Name	Type
justification	number

Returns

void

---

setScale

▸ setScale(scale): void

设置比例

Parameters

Name	Type
scale	number

Returns

void

---

setSegmentRelation

▸ setSegmentRelation(segmentIndex, relatedSegmentIndex, pointPairs): void

设置线段关联数据

Parameters

Name	Type	Description
segmentIndex	number	当前多线的线段索引
relatedSegmentIndex	number	相关联多线的线段索引
pointPairs	SegmentPointPair[]	点对数组 [McGePoint3d, McGePoint3d][]

Returns

void

---

setStyleName

▸ setStyleName(name): void

设置样式名称

Parameters

Name	Type
name	string

Returns

void

---

setVertexAt

▸ setVertexAt(index, point): void

设置顶点

Parameters

Name	Type
index	number
point	McGePoint3d

Returns

void

---

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

McDbCustomEntity.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

McDbCustomEntity.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

McDbCustomEntity.setxDataLong

---

setxDataPoint

▸ setxDataPoint(appName, val): boolean

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

Parameters

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

Returns

boolean

获取结果及三维点对象

Inherited from

McDbCustomEntity.setxDataPoint

---

setxDataString

▸ setxDataString(appName, val): boolean

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

Parameters

Name	Type	Description
appName	string	扩展数据名称
val	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.setxDataString("DataName", "xxxxx");
if(res){
  //设置成功
}else{
  //设置失败
}

Inherited from

McDbCustomEntity.setxDataString

---

syncData

▸ syncData(toCpp?): boolean

js 对像的数据与McDbCustomEntity::m_mapData的同步。

Parameters

Name	Type	Default value
toCpp	boolean	true

Returns

boolean

Inherited from

McDbCustomEntity.syncData

---

transformBy

▸ transformBy(_mat): boolean

获取自定义对象矩阵坐标变换

Parameters

Name	Type
_mat	McGeMatrix3d

Returns

boolean

Inherited from

McDbCustomEntity.transformBy

---

unErase

▸ unErase(): boolean

反删除对象。

Returns

boolean

Example

//假设obj为一个数据库对象
const res = obj.unErase();
console.log(res);

Inherited from

McDbCustomEntity.unErase

---

updateDisplay

▸ updateDisplay(): void

显示调用对象更新显示.

Returns

void

Example

// 假设ent为有效实例对象
ent.updateDisplay()

Inherited from

McDbCustomEntity.updateDisplay

---

worldDraw

▸ worldDraw(draw): void

绘制实体（统一调度，参数传递点集）

Parameters

Name	Type
draw	MxCADWorldDraw

Returns

void

Overrides

McDbCustomEntity.worldDraw