mxcad API 文档 / 2d / McDbPolyline

Class: McDbPolyline ​

2d.McDbPolyline

多段线类

Example

import { McDbPolyline, MxCpp } from 'mxcad'
//绘制线宽为10的矩形，pt1,pt2,pt3,pt4为矩形的4点个顶点
const pl = new McDbPolyline();
pl.constantWidth = 10;
pl.addVertexAt(pt1);
pl.addVertexAt(pt2);
pl.addVertexAt(pt3);
pl.addVertexAt(pt4);
pl.isClosed = true;
MxCpp.getCurrentMxCAD().drawEntity(pl);

Hierarchy ​

• McDbCurve

  ↳ McDbPolyline

Table of contents ​

Constructors ​

• constructor

Properties ​

• imp

Accessors ​

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

Methods ​

• IntersectWith
• addVertexAt
• clone
• constructor_MxCADResbuf
• createExtensionDictionary
• deleteXData
• disableDisplay
• erase
• explode
• freeTempRelationObject
• getAllAppName
• getArea
• getBoundingBox
• getBulgeAt
• getClosestPointTo
• getDatabase
• getDatabaseIndexId
• getDistAtParam
• getDistAtPoint
• getEndParam
• getEndPoint
• getExtensionDictionary
• getFirstDeriv
• getFirstDerivFromParam
• getGripPoints
• getHandle
• getImp
• getJson
• getLength
• getObjectID
• getOwnerID
• getParamAtDist
• getParamAtPoint
• getPointAt
• getPointAtDist
• getPointAtParam
• getSamplePoints
• getStartParam
• getStartPoint
• getType
• getWidthsAt
• getxData
• getxDataDouble
• getxDataLong
• getxDataPoint
• getxDataString
• highlight
• initTempObject
• isErased
• isHaveExtensionDictionary
• isKindOf
• isNull
• mirror
• move
• moveGripPointsAt
• numVerts
• offsetCurves
• removeVertexAt
• rotate
• scaleEntity
• setBulgeAt
• setJson
• setPointAt
• setType
• setWidthsAt
• setxData
• setxDataDouble
• setxDataLong
• setxDataPoint
• setxDataString
• splitCurves
• splitCurvesFromParam
• syncData
• tempRelationObject
• transformBy
• unErase
• updateDisplay

Constructors ​

constructor ​

• new McDbPolyline(imp?)

构造函数

Parameters ​

Overrides ​

McDbCurve.constructor

Properties ​

imp ​

• imp: any = 0

内部实现对象。

Inherited from ​

McDbCurve.imp

Accessors ​

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 ​

McDbCurve.colorIndex

• set colorIndex(val): void

设置对象颜色索引

Parameters ​

Returns ​

void

Inherited from ​

McDbCurve.colorIndex

constantWidth ​

• get constantWidth(): number

获取常量宽度

Returns ​

number

• set constantWidth(val): void

设置常量宽度

Parameters ​

Returns ​

void

drawOrder ​

• get drawOrder(): number

对象的显示顺序

Returns ​

number

Inherited from ​

McDbCurve.drawOrder

• set drawOrder(order): void

对象的显示顺序

Parameters ​

Returns ​

void

Inherited from ​

McDbCurve.drawOrder

dxf0 ​

• get dxf0(): string

获取 DXF 代码 0 的值。

Returns ​

string

Inherited from ​

McDbCurve.dxf0

isClosed ​

• get isClosed(): boolean

获取是否闭合

Returns ​

boolean

• set isClosed(val): void

设置是否闭合

Parameters ​

Returns ​

void

layer ​

• get layer(): string

得到对象图层名

Returns ​

string

Inherited from ​

McDbCurve.layer

• set layer(val): void

设置对象图层名

Parameters ​

Returns ​

void

Inherited from ​

McDbCurve.layer

layerId ​

• get layerId(): McObjectId

图层ID对象

Returns ​

McObjectId

Inherited from ​

McDbCurve.layerId

• set layerId(id): void

Parameters ​

Returns ​

void

Inherited from ​

McDbCurve.layerId

linetype ​

• get linetype(): string

得到对象线型名

Returns ​

string

Inherited from ​

McDbCurve.linetype

• set linetype(val): void

设置对象线型名

Parameters ​

Returns ​

void

Inherited from ​

McDbCurve.linetype

linetypeId ​

• get linetypeId(): McObjectId

线型ID对象

Returns ​

McObjectId

Inherited from ​

McDbCurve.linetypeId

• set linetypeId(id): void

Parameters ​

Returns ​

void

Inherited from ​

McDbCurve.linetypeId

linetypeScale ​

• get linetypeScale(): number

得到对象线型比例

Returns ​

number

Inherited from ​

McDbCurve.linetypeScale

• set linetypeScale(val): void

设置对象线型比例

Parameters ​

Returns ​

void

Inherited from ​

McDbCurve.linetypeScale

lineweight ​

• get lineweight(): number

得到对象线重

Returns ​

number

Inherited from ​

McDbCurve.lineweight

• set lineweight(val): void

设置对象线重

Parameters ​

Returns ​

void

Inherited from ​

McDbCurve.lineweight

objectName ​

• get objectName(): string

获取对象名称。

Returns ​

string

Inherited from ​

McDbCurve.objectName

textStyle ​

• get textStyle(): string

得到对象文字样式

Returns ​

string

Inherited from ​

McDbCurve.textStyle

• set textStyle(val): void

设置对象文字样式

Example

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

Parameters ​

Returns ​

void

Inherited from ​

McDbCurve.textStyle

textStyleId ​

• get textStyleId(): McObjectId

文字样式ID对象

Returns ​

McObjectId

Inherited from ​

McDbCurve.textStyleId

• set textStyleId(id): void

Parameters ​

Returns ​

void

Inherited from ​

McDbCurve.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 ​

McDbCurve.trueColor

• set trueColor(val): void

设置对象颜色

Parameters ​

Returns ​

void

Inherited from ​

McDbCurve.trueColor

visible ​

• get visible(): boolean

对象是否可见

Returns ​

boolean

Inherited from ​

McDbCurve.visible

• set visible(val): void

设置是否可见

Parameters ​

Returns ​

void

Inherited from ​

McDbCurve.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 ​

McDbCurve.IntersectWith

addVertexAt ​

▸ addVertexAt(pt, bulge?, startWidth?, endWidth?, index?): boolean

在指定位置添加顶点

Parameters ​

Returns ​

boolean

clone ​

▸ clone(): null | McDbObject

克隆对象。

Returns ​

null | McDbObject

克隆出的对象。

Inherited from ​

McDbCurve.clone

constructor_MxCADResbuf ​

▸ Protected constructor_MxCADResbuf(imp): void

Parameters ​

Returns ​

void

Inherited from ​

McDbCurve.constructor_MxCADResbuf

createExtensionDictionary ​

▸ createExtensionDictionary(): boolean

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

Returns ​

boolean

Inherited from ​

McDbCurve.createExtensionDictionary

deleteXData ​

▸ deleteXData(appName): boolean

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

Parameters ​

Returns ​

boolean

Inherited from ​

McDbCurve.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 ​

McDbCurve.disableDisplay

erase ​

▸ erase(): boolean

删除对象。

Returns ​

boolean

是否删除成功。

Inherited from ​

McDbCurve.erase

explode ​

▸ explode(): MxCADResbuf

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

Returns ​

MxCADResbuf

Inherited from ​

McDbCurve.explode

freeTempRelationObject ​

▸ freeTempRelationObject(): void

释放临时关系对象

Returns ​

void

Inherited from ​

McDbCurve.freeTempRelationObject

getAllAppName ​

▸ getAllAppName(): McGeStringArray

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

Returns ​

McGeStringArray

Inherited from ​

McDbCurve.getAllAppName

getArea ​

▸ getArea(): Object

计算面积

Returns ​

Object

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

Inherited from ​

McDbCurve.getArea

getBoundingBox ​

▸ getBoundingBox(): Object

得到对象的最小外包

Example

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

Inherited from ​

McDbCurve.getBoundingBox

getBulgeAt ​

▸ getBulgeAt(index): number

获取指定位置的凸度

Parameters ​

Returns ​

number

getClosestPointTo ​

▸ getClosestPointTo(givenPnt, isExtend): Object

得到一个点到曲线的最近点

Parameters ​

Returns ​

Object

点对象及执行结果。

Inherited from ​

McDbCurve.getClosestPointTo

getDatabase ​

▸ getDatabase(): McDbDatabase

得到对象所在的数据库

Returns ​

McDbDatabase

Inherited from ​

McDbCurve.getDatabase

getDatabaseIndexId ​

▸ getDatabaseIndexId(): number

获取对象的索引ID

Returns ​

number

Inherited from ​

McDbCurve.getDatabaseIndexId

getDistAtParam ​

▸ getDistAtParam(param): Object

获取参数位置上的距离。

Parameters ​

Returns ​

Object

距离及执行结果。

Inherited from ​

McDbCurve.getDistAtParam

getDistAtPoint ​

▸ getDistAtPoint(pt): Object

获取曲线上点的距离位置。

Parameters ​

Returns ​

Object

点及执行结果。

Inherited from ​

McDbCurve.getDistAtPoint

getEndParam ​

▸ getEndParam(): Object

获取结束参数。

Returns ​

Object

结束参数及执行结果。

Inherited from ​

McDbCurve.getEndParam

getEndPoint ​

▸ getEndPoint(): Object

得到曲线的结束点

Returns ​

Object

曲线的结束点及执行结果。

Inherited from ​

McDbCurve.getEndPoint

getExtensionDictionary ​

▸ getExtensionDictionary(): McDbDictionary

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

Returns ​

McDbDictionary

Inherited from ​

McDbCurve.getExtensionDictionary

getFirstDeriv ​

▸ getFirstDeriv(pt): Object

通过曲线上某点得到曲线的一阶导数

Parameters ​

Returns ​

Object

曲线一阶导数及执行结果。

Inherited from ​

McDbCurve.getFirstDeriv

getFirstDerivFromParam ​

▸ getFirstDerivFromParam(param): Object

通过曲线参数得到曲线的一阶导数

Parameters ​

Returns ​

Object

曲线一阶导数及执行结果。

Inherited from ​

McDbCurve.getFirstDerivFromParam

getGripPoints ​

▸ getGripPoints(): McGePoint3dArray

获取对象的控制点

Returns ​

McGePoint3dArray

Inherited from ​

McDbCurve.getGripPoints

getHandle ​

▸ getHandle(): string

得到对象句柄

Returns ​

string

Inherited from ​

McDbCurve.getHandle

getImp ​

▸ getImp(): any

获取内部实现对象。

Returns ​

any

内部实现对象。

Inherited from ​

McDbCurve.getImp

getJson ​

▸ getJson(): string

获取 JSON 格式的字符串。

Returns ​

string

JSON 格式的字符串。

Inherited from ​

McDbCurve.getJson

getLength ​

▸ getLength(): Object

得到曲线长度

Example

import { MxCpp, MxCADResbuf, MxCADUtility, MxCADUiPrPoint} from "mxcad"

 const mxcad = MxCpp.App.getCurrentMxCAD();
   let filter = new MxCADResbuf();
   filter.AddMcDbEntityTypes("CIRCLE,ARC,LINE,LWPOLYLINE,ELLIPSE");
   let aryId = await MxCADUtility.userSelect("选择目标曲线", filter);
   if (aryId.length == 0)  return;
   aryId.forEach(async (id) => {
       let event = id.getMcDbEntity() as McDbCurve;
       let length = event.getLength().val;
       console.log(length)
   });

Returns ​

Object

Inherited from ​

McDbCurve.getLength

getObjectID ​

▸ getObjectID(): McObjectId

获取对象 ID。

Returns ​

McObjectId

对象 ID。

Inherited from ​

McDbCurve.getObjectID

getOwnerID ​

▸ getOwnerID(): number

得到对象拥用者的id

Returns ​

number

Inherited from ​

McDbCurve.getOwnerID

getParamAtDist ​

▸ getParamAtDist(dist): Object

获取距离位置上的参数。

Parameters ​

Returns ​

Object

参数及执行结果。

Inherited from ​

McDbCurve.getParamAtDist

getParamAtPoint ​

▸ getParamAtPoint(pt): Object

得到曲线某点位置的曲线参数

Parameters ​

Returns ​

Object

曲线参数及执行结果。

Inherited from ​

McDbCurve.getParamAtPoint

getPointAt ​

▸ getPointAt(index): Object

获取指定位置的点

Parameters ​

Returns ​

Object

val: 点, ret: 返回值

getPointAtDist ​

▸ getPointAtDist(dist): Object

获取距离位置上的点。

Parameters ​

Returns ​

Object

点及执行结果。

Inherited from ​

McDbCurve.getPointAtDist

getPointAtParam ​

▸ getPointAtParam(param): Object

得到曲线参数所在的点坐标

Parameters ​

Returns ​

Object

点对象及执行结果。

Inherited from ​

McDbCurve.getPointAtParam

getSamplePoints ​

▸ getSamplePoints(dApproxEps): MxCADResbuf

把曲线离散成一堆点

Parameters ​

Returns ​

MxCADResbuf

resbuf 数据

Inherited from ​

McDbCurve.getSamplePoints

getStartParam ​

▸ getStartParam(): Object

获取起始参数。

Returns ​

Object

起始参数及执行结果。

Inherited from ​

McDbCurve.getStartParam

getStartPoint ​

▸ getStartPoint(): Object

得到曲线的开始点

Returns ​

Object

曲线的开始点及执行结果。

Inherited from ​

McDbCurve.getStartPoint

getType ​

▸ getType(): PolylineType

设置多线段类型

Returns ​

PolylineType

getWidthsAt ​

▸ getWidthsAt(index): Object

获取指定位置的起始和结束宽度

Parameters ​

Returns ​

Object

val1: 起始宽度, val2: 结束宽度, ret: 返回值

getxData ​

▸ getxData(appName?): MxCADResbuf

得到对象的扩展数据

Parameters ​

Returns ​

MxCADResbuf

Inherited from ​

McDbCurve.getxData

getxDataDouble ​

▸ getxDataDouble(appName): Object

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

Parameters ​

Returns ​

Object

double 值

Inherited from ​

McDbCurve.getxDataDouble

getxDataLong ​

▸ getxDataLong(appName): Object

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

Parameters ​

Returns ​

Object

long 值

Inherited from ​

McDbCurve.getxDataLong

getxDataPoint ​

▸ getxDataPoint(appName): Object

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

Parameters ​

Returns ​

Object

Inherited from ​

McDbCurve.getxDataPoint

getxDataString ​

▸ getxDataString(appName): Object

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

Parameters ​

Returns ​

Object

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

Inherited from ​

McDbCurve.getxDataString

highlight ​

▸ highlight(isHighlight): void

设置对象是否高亮

Example

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

Parameters ​

Returns ​

void

Inherited from ​

McDbCurve.highlight

initTempObject ​

▸ initTempObject(imp): void

初始化临时对象。

Parameters ​

Returns ​

void

Inherited from ​

McDbCurve.initTempObject

isErased ​

▸ isErased(): boolean

对象是否已经删除

Returns ​

boolean

Inherited from ​

McDbCurve.isErased

isHaveExtensionDictionary ​

▸ isHaveExtensionDictionary(): boolean

是否有扩展字典数据.

Returns ​

boolean

Inherited from ​

McDbCurve.isHaveExtensionDictionary

isKindOf ​

▸ isKindOf(sObjectName): boolean

Parameters ​

Returns ​

boolean

Inherited from ​

McDbCurve.isKindOf

isNull ​

▸ isNull(): any

Returns ​

any

Inherited from ​

McDbCurve.isNull

mirror ​

▸ mirror(point1, point2): boolean

镜向对象

Parameters ​

Returns ​

boolean

Inherited from ​

McDbCurve.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 ​

McDbCurve.move

moveGripPointsAt ​

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

移动对象的控制点

Parameters ​

Returns ​

any

Inherited from ​

McDbCurve.moveGripPointsAt

numVerts ​

▸ numVerts(): number

获取顶点数量

Returns ​

number

offsetCurves ​

▸ offsetCurves(dOffsetDist, ptOffsetRef): McDbObjectArray

得到偏移曲线

Example

import { MxCADUiPrPoint, MxCpp } from 'mxcad'
   let getFristPoint = new MxCADUiPrPoint();
   let offsetDist = 10 ;
   let getEvent = new MxCADUiPrEntity();
   getEvent.setMessage('指定偏移对象');
   let event_id = await getEvent.go();
   if (!event_id) return;
   let event = (await event_id.getMcDbEntity()) as McDbCurve;
   let getoOffPt = new MxCADUiPrPoint();
   getoOffPt.setMessage('指定偏移点');
   let offPt = await getoOffPt.go();
   if (!offPt) return;
   let objArr = event.offsetCurves(offsetDist, offPt);
   if (objArr.length() === 0) return;
   objArr.forEach((obj: McDbObject) => {
       MxCpp.getCurrentCAD().drawEntity(obj as McDbEntity);
   });

Parameters ​

Returns ​

McDbObjectArray

偏移后的对象数组。

Inherited from ​

McDbCurve.offsetCurves

removeVertexAt ​

▸ removeVertexAt(index): boolean

移除指定位置的顶点

Parameters ​

Returns ​

boolean

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 ​

McDbCurve.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 ​

McDbCurve.scaleEntity

setBulgeAt ​

▸ setBulgeAt(index, bulge): boolean

设置指定位置的凸度

Parameters ​

Returns ​

boolean

setJson ​

▸ setJson(str): boolean

设置 JSON 格式的字符串。

Parameters ​

Returns ​

boolean

是否设置成功。

Inherited from ​

McDbCurve.setJson

setPointAt ​

▸ setPointAt(index, pt): boolean

设置指定位置的点

Parameters ​

Returns ​

boolean

setType ​

▸ setType(type): boolean

返回多线段类型

Parameters ​

Returns ​

boolean

setWidthsAt ​

▸ setWidthsAt(index, dStartWdith, dEntWdith): boolean

修改线段的开始宽度，和结束宽度

Parameters ​

Returns ​

boolean

setxData ​

▸ setxData(xdata): boolean

设置对象的扩展数据

Parameters ​

Returns ​

boolean

Inherited from ​

McDbCurve.setxData

setxDataDouble ​

▸ setxDataDouble(appName, val): boolean

Parameters ​

Returns ​

boolean

Inherited from ​

McDbCurve.setxDataDouble

setxDataLong ​

▸ setxDataLong(appName, val): boolean

Parameters ​

Returns ​

boolean

Inherited from ​

McDbCurve.setxDataLong

setxDataPoint ​

▸ setxDataPoint(appName, val): boolean

Parameters ​

Returns ​

boolean

Inherited from ​

McDbCurve.setxDataPoint

setxDataString ​

▸ setxDataString(appName, val): boolean

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

Parameters ​

Returns ​

boolean

是否设置成功

Inherited from ​

McDbCurve.setxDataString

splitCurves ​

▸ splitCurves(pts): McDbObjectArray

打断曲线

Parameters ​

Returns ​

McDbObjectArray

打断后的曲线数组。

Inherited from ​

McDbCurve.splitCurves

splitCurvesFromParam ​

▸ splitCurvesFromParam(params): McDbObjectArray

根据曲线参数打断曲线

Parameters ​

Returns ​

McDbObjectArray

打断后的曲线数组。

Inherited from ​

McDbCurve.splitCurvesFromParam

syncData ​

▸ syncData(_toCpp?): boolean

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

Parameters ​

Returns ​

boolean

Inherited from ​

McDbCurve.syncData

tempRelationObject ​

▸ tempRelationObject(): number

与对象相关的临时关系数

Returns ​

number

Inherited from ​

McDbCurve.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 ​

McDbCurve.transformBy

unErase ​

▸ unErase(): boolean

反删除对象。

Returns ​

boolean

Inherited from ​

McDbCurve.unErase

updateDisplay ​

▸ updateDisplay(): void

显示调用对象更新显示.

Returns ​

void

Inherited from ​

McDbCurve.updateDisplay