mxcad API 文档 / McDbCurve
Class: McDbCurve
表示数据库曲线。实现了曲线的相关操作,如求曲线的长度,最近点,面积,曲线上任一点在曲线上的长度 切向方向,曲线交点,坐标变换,打断,偏移,离散等功能。
Hierarchy
↳
McDbCurve
↳↳
McDbLine
↳↳
McDbCircle
↳↳
McDbPolyline
↳↳
McDbArc
↳↳
McDbEllipse
Table of contents
Constructors
Properties
Accessors
- colorIndex
- drawOrder
- dxf0
- layer
- layerId
- linetype
- linetypeId
- linetypeScale
- lineweight
- objectName
- textStyle
- textStyleId
- trueColor
- visible
Methods
- IntersectWith
- clone
- constructor_MxCADResbuf
- createExtensionDictionary
- deleteXData
- disableDisplay
- erase
- explode
- freeTempRelationObject
- getAllAppName
- getArea
- getBoundingBox
- getClosestPointTo
- getDatabase
- getDatabaseIndexId
- getDistAtParam
- getDistAtPoint
- getEndParam
- getEndPoint
- getExtensionDictionary
- getFirstDeriv
- getFirstDerivFromParam
- getGripPoints
- getHandle
- getImp
- getJson
- getLength
- getObjectID
- getOwnerID
- getParamAtDist
- getParamAtPoint
- getPointAtDist
- getPointAtParam
- getSamplePoints
- getStartParam
- getStartPoint
- getxData
- getxDataDouble
- getxDataLong
- getxDataPoint
- getxDataString
- highlight
- initTempObject
- isErased
- isHaveExtensionDictionary
- isKindOf
- isNull
- mirror
- move
- moveGripPointsAt
- offsetCurves
- rotate
- scaleEntity
- setJson
- setxData
- setxDataDouble
- setxDataLong
- setxDataPoint
- setxDataString
- splitCurves
- splitCurvesFromParam
- syncData
- tempRelationObject
- transformBy
- unErase
- updateDisplay
Constructors
constructor
• new McDbCurve(imp?
)
构造函数。
Parameters
Name | Type | Description |
---|---|---|
imp? | any | 内部实现对象。 |
Overrides
Properties
imp
• imp: any
= 0
内部实现对象。
Inherited from
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
McDbEntity.colorIndex
• set
colorIndex(val
): void
设置对象颜色索引
Parameters
Name | Type | Description |
---|---|---|
val | number | 颜色索引(ColorIndexType) |
Returns
void
Inherited from
McDbEntity.colorIndex
drawOrder
• get
drawOrder(): number
对象的显示顺序
Returns
number
Inherited from
McDbEntity.drawOrder
• set
drawOrder(order
): void
对象的显示顺序
Parameters
Name | Type | Description |
---|---|---|
order | number | 顺序值 |
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
设置对象图层名
Parameters
Name | Type | Description |
---|---|---|
val | string | 图层名 |
Returns
void
Inherited from
McDbEntity.layer
layerId
• get
layerId(): McObjectId
图层ID对象
Returns
Inherited from
McDbEntity.layerId
• set
layerId(id
): void
Parameters
Name | Type |
---|---|
id | McObjectId |
Returns
void
Inherited from
McDbEntity.layerId
linetype
• get
linetype(): string
得到对象线型名
Returns
string
Inherited from
McDbEntity.linetype
• set
linetype(val
): void
设置对象线型名
Parameters
Name | Type | Description |
---|---|---|
val | string | 线型名 |
Returns
void
Inherited from
McDbEntity.linetype
linetypeId
• get
linetypeId(): McObjectId
线型ID对象
Returns
Inherited from
McDbEntity.linetypeId
• set
linetypeId(id
): void
Parameters
Name | Type |
---|---|
id | McObjectId |
Returns
void
Inherited from
McDbEntity.linetypeId
linetypeScale
• get
linetypeScale(): number
得到对象线型比例
Returns
number
Inherited from
McDbEntity.linetypeScale
• set
linetypeScale(val
): void
设置对象线型比例
Parameters
Name | Type | Description |
---|---|---|
val | number | 线型比例 |
Returns
void
Inherited from
McDbEntity.linetypeScale
lineweight
• get
lineweight(): number
得到对象线重
Returns
number
Inherited from
McDbEntity.lineweight
• set
lineweight(val
): void
设置对象线重
Parameters
Name | Type | Description |
---|---|---|
val | number | 线重 |
Returns
void
Inherited from
McDbEntity.lineweight
objectName
• get
objectName(): string
获取对象名称。
Returns
string
Inherited from
McDbEntity.objectName
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
Name | Type | Description |
---|---|---|
val | string | 文字样式名 |
Returns
void
Inherited from
McDbEntity.textStyle
textStyleId
• get
textStyleId(): McObjectId
文字样式ID对象
Returns
Inherited from
McDbEntity.textStyleId
• set
textStyleId(id
): void
Parameters
Name | Type |
---|---|
id | McObjectId |
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
Inherited from
McDbEntity.trueColor
• set
trueColor(val
): void
设置对象颜色
Parameters
Name | Type |
---|---|
val | McCmColor |
Returns
void
Inherited from
McDbEntity.trueColor
visible
• get
visible(): boolean
对象是否可见
Returns
boolean
Inherited from
McDbEntity.visible
• set
visible(val
): void
设置是否可见
Parameters
Name | Type | Description |
---|---|---|
val | boolean | 布尔值 |
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
Name | Type | Description |
---|---|---|
intersectObject | McDbEntity | 需要相交的是实体对象 |
exOption | Intersect | 相交的选项 |
Returns
得到所有交点
Inherited from
clone
▸ clone(): null
| McDbObject
克隆对象。
Returns
null
| McDbObject
克隆出的对象。
Inherited from
constructor_MxCADResbuf
▸ Protected
constructor_MxCADResbuf(imp
): void
Parameters
Name | Type |
---|---|
imp | any |
Returns
void
Inherited from
McDbEntity.constructor_MxCADResbuf
createExtensionDictionary
▸ createExtensionDictionary(): boolean
创建对象的扩展字典数据.
Returns
boolean
Inherited from
McDbEntity.createExtensionDictionary
deleteXData
▸ deleteXData(appName
): boolean
删除实体的指定 XData 类型中的点(McGePoint3d)值
Parameters
Name | Type | Description |
---|---|---|
appName | string | XData 类型 |
Returns
boolean
Inherited from
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
Name | Type | Description |
---|---|---|
isDisable | boolean | 是否禁用对象自动更新显示 |
Returns
void
Inherited from
erase
▸ erase(): boolean
删除对象。
Returns
boolean
是否删除成功。
Inherited from
explode
▸ explode(): MxCADResbuf
打碎对象,返回打后对象数据链表
Returns
Inherited from
freeTempRelationObject
▸ freeTempRelationObject(): void
释放临时关系对象
Returns
void
Inherited from
McDbEntity.freeTempRelationObject
getAllAppName
▸ getAllAppName(): McGeStringArray
获取实体中包含的所有 XData 记录的应用程序名(AppName)
Returns
Inherited from
getArea
▸ getArea(): Object
计算面积
Returns
Object
val 面积值 | ret 是否获取成功
Name | Type |
---|---|
ret | boolean |
val | number |
Inherited from
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
Name | Type |
---|---|
maxPt | McGePoint3d |
minPt | McGePoint3d |
ret | boolean |
Inherited from
getClosestPointTo
▸ getClosestPointTo(givenPnt
, isExtend
): Object
得到一个点到曲线的最近点
Parameters
Name | Type | Description |
---|---|---|
givenPnt | McGePoint3d | 参考点 |
isExtend | boolean | 是否延展实体 |
Returns
Object
点对象及执行结果。
Name | Type |
---|---|
ret | boolean |
val | McGePoint3d |
getDatabase
▸ getDatabase(): McDbDatabase
得到对象所在的数据库
Returns
Inherited from
getDatabaseIndexId
▸ getDatabaseIndexId(): number
获取对象的索引ID
Returns
number
Inherited from
getDistAtParam
▸ getDistAtParam(param
): Object
获取参数位置上的距离。
Parameters
Name | Type | Description |
---|---|---|
param | number | 参数位置。 |
Returns
Object
距离及执行结果。
Name | Type |
---|---|
ret | boolean |
val | number |
getDistAtPoint
▸ getDistAtPoint(pt
): Object
获取曲线上点的距离位置。
Parameters
Name | Type | Description |
---|---|---|
pt | McGePoint3d | 距离位置。 |
Returns
Object
点及执行结果。
Name | Type |
---|---|
ret | boolean |
val | number |
getEndParam
▸ getEndParam(): Object
获取结束参数。
Returns
Object
结束参数及执行结果。
Name | Type |
---|---|
ret | boolean |
val | number |
getEndPoint
▸ getEndPoint(): Object
得到曲线的结束点
Returns
Object
曲线的结束点及执行结果。
Name | Type |
---|---|
ret | boolean |
val | McGePoint3d |
getExtensionDictionary
▸ getExtensionDictionary(): McDbDictionary
得到对象的扩展字典数据.
Returns
Inherited from
McDbEntity.getExtensionDictionary
getFirstDeriv
▸ getFirstDeriv(pt
): Object
通过曲线上某点得到曲线的一阶导数
Parameters
Name | Type | Description |
---|---|---|
pt | McGePoint3d | 曲线上的点 |
Returns
Object
曲线一阶导数及执行结果。
Name | Type |
---|---|
ret | boolean |
val | McGeVector3d |
getFirstDerivFromParam
▸ getFirstDerivFromParam(param
): Object
通过曲线参数得到曲线的一阶导数
Parameters
Name | Type | Description |
---|---|---|
param | number | 曲线参数 |
Returns
Object
曲线一阶导数及执行结果。
Name | Type |
---|---|
ret | boolean |
val | McGeVector3d |
getGripPoints
▸ getGripPoints(): McGePoint3dArray
获取对象的控制点
Returns
Inherited from
getHandle
▸ getHandle(): string
得到对象句柄
Returns
string
Inherited from
getImp
▸ getImp(): any
获取内部实现对象。
Returns
any
内部实现对象。
Inherited from
getJson
▸ getJson(): string
获取 JSON 格式的字符串。
Returns
string
JSON 格式的字符串。
Inherited from
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
Name | Type |
---|---|
ret | boolean |
val | number |
getObjectID
▸ getObjectID(): McObjectId
获取对象 ID。
Returns
对象 ID。
Inherited from
getOwnerID
▸ getOwnerID(): number
得到对象拥用者的id
Returns
number
Inherited from
getParamAtDist
▸ getParamAtDist(dist
): Object
获取距离位置上的参数。
Parameters
Name | Type | Description |
---|---|---|
dist | number | 距离位置。 |
Returns
Object
参数及执行结果。
Name | Type |
---|---|
ret | boolean |
val | number |
getParamAtPoint
▸ getParamAtPoint(pt
): Object
得到曲线某点位置的曲线参数
Parameters
Name | Type | Description |
---|---|---|
pt | McGePoint3d | 曲线上的点 |
Returns
Object
曲线参数及执行结果。
Name | Type |
---|---|
ret | boolean |
val | number |
getPointAtDist
▸ getPointAtDist(dist
): Object
获取距离位置上的点。
Parameters
Name | Type | Description |
---|---|---|
dist | number | 距离位置。 |
Returns
Object
点及执行结果。
Name | Type |
---|---|
ret | boolean |
val | McGePoint3d |
getPointAtParam
▸ getPointAtParam(param
): Object
得到曲线参数所在的点坐标
Parameters
Name | Type | Description |
---|---|---|
param | number | 曲线参数 |
Returns
Object
点对象及执行结果。
Name | Type |
---|---|
ret | boolean |
val | McGePoint3d |
getSamplePoints
▸ getSamplePoints(dApproxEps
): MxCADResbuf
把曲线离散成一堆点
Parameters
Name | Type | Description |
---|---|---|
dApproxEps | number | 采样间隔 |
Returns
resbuf 数据
getStartParam
▸ getStartParam(): Object
获取起始参数。
Returns
Object
起始参数及执行结果。
Name | Type |
---|---|
ret | boolean |
val | number |
getStartPoint
▸ getStartPoint(): Object
得到曲线的开始点
Returns
Object
曲线的开始点及执行结果。
Name | Type |
---|---|
ret | boolean |
val | McGePoint3d |
getxData
▸ getxData(appName?
): MxCADResbuf
得到对象的扩展数据
Parameters
Name | Type | Default value | Description |
---|---|---|---|
appName | string | "" | XData 类型 |
Returns
Inherited from
getxDataDouble
▸ getxDataDouble(appName
): Object
获取或设置实体的指定 XData 类型中的 double 值
Parameters
Name | Type | Description |
---|---|---|
appName | string | XData 类型 |
Returns
Object
double 值
Name | Type |
---|---|
ret | boolean |
val | number |
Inherited from
getxDataLong
▸ getxDataLong(appName
): Object
获取或设置实体的指定 XData 类型中的 long(整数)值
Parameters
Name | Type | Description |
---|---|---|
appName | string | XData 类型 |
Returns
Object
long 值
Name | Type |
---|---|
ret | boolean |
val | number |
Inherited from
getxDataPoint
▸ getxDataPoint(appName
): Object
获取或设置实体的指定 XData 类型中的点对象
Parameters
Name | Type | Description |
---|---|---|
appName | string | XData 类型 |
Returns
Object
Name | Type |
---|---|
ret | boolean |
val | McGePoint3d |
Inherited from
getxDataString
▸ getxDataString(appName
): Object
获取与特定实体关联的 XData 信息,并以字符串形式返回
Parameters
Name | Type | Description |
---|---|---|
appName | string | XData 类型 |
Returns
Object
val XData信息 | ret 是否返回成功
Name | Type |
---|---|
ret | boolean |
val | string |
Inherited from
highlight
▸ highlight(isHighlight
): void
设置对象是否高亮
Example
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.isHighlight(true);
Parameters
Name | Type | Description |
---|---|---|
isHighlight | boolean | 是否高亮 |
Returns
void
Inherited from
initTempObject
▸ initTempObject(imp
): void
初始化临时对象。
Parameters
Name | Type | Description |
---|---|---|
imp | any | 内部实现对象。 |
Returns
void
Inherited from
isErased
▸ isErased(): boolean
对象是否已经删除
Returns
boolean
Inherited from
isHaveExtensionDictionary
▸ isHaveExtensionDictionary(): boolean
是否有扩展字典数据.
Returns
boolean
Inherited from
McDbEntity.isHaveExtensionDictionary
isKindOf
▸ isKindOf(sObjectName
): boolean
Parameters
Name | Type |
---|---|
sObjectName | string |
Returns
boolean
Inherited from
isNull
▸ isNull(): any
Returns
any
Inherited from
mirror
▸ mirror(point1
, point2
): boolean
镜向对象
Parameters
Name | Type | Description |
---|---|---|
point1 | McGePoint3d | 镜像基点 |
point2 | McGePoint3d | 镜像点 |
Returns
boolean
Inherited from
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
Name | Type | Description |
---|---|---|
fromPoint | McGePoint3d | 移动开始点 |
toPoint | McGePoint3d | 移动结束点 |
Returns
boolean
Inherited from
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
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
Name | Type | Description |
---|---|---|
dOffsetDist | number | 偏移距离 |
ptOffsetRef | McGePoint3d | 偏移点 |
Returns
偏移后的对象数组。
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
Name | Type | Description |
---|---|---|
basePoint | McGePoint3d | 旋转基点 |
dRotationAngle | number | 旋转角度 |
Returns
boolean
Inherited from
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
Name | Type | Description |
---|---|---|
basePoint | McGePoint3d | 缩放基点 |
dScaleFactor | number | 缩放因子(<1 缩小; >1 放大) |
Returns
boolean
Inherited from
setJson
▸ setJson(str
): boolean
设置 JSON 格式的字符串。
Parameters
Name | Type | Description |
---|---|---|
str | string | JSON 格式的字符串。 |
Returns
boolean
是否设置成功。
Inherited from
setxData
▸ setxData(xdata
): boolean
设置对象的扩展数据
Parameters
Name | Type | Description |
---|---|---|
xdata | MxCADResbuf | resbuf 数据 |
Returns
boolean
Inherited from
setxDataDouble
▸ setxDataDouble(appName
, val
): boolean
Parameters
Name | Type |
---|---|
appName | string |
val | number |
Returns
boolean
Inherited from
setxDataLong
▸ setxDataLong(appName
, val
): boolean
Parameters
Name | Type |
---|---|
appName | string |
val | number |
Returns
boolean
Inherited from
setxDataPoint
▸ setxDataPoint(appName
, val
): boolean
Parameters
Name | Type |
---|---|
appName | string |
val | McGePoint3d |
Returns
boolean
Inherited from
setxDataString
▸ setxDataString(appName
, val
): boolean
设置与特定实体关联的 XData 信息,并以字符串形式设置
Parameters
Name | Type | Description |
---|---|---|
appName | string | XData 类型 |
val | string | XData信息 |
Returns
boolean
是否设置成功
Inherited from
splitCurves
▸ splitCurves(pts
): McDbObjectArray
打断曲线
Parameters
Name | Type | Description |
---|---|---|
pts | McGePoint3d [] | 断点数组 |
Returns
打断后的曲线数组。
splitCurvesFromParam
▸ splitCurvesFromParam(params
): McDbObjectArray
根据曲线参数打断曲线
Parameters
Name | Type | Description |
---|---|---|
params | number [] | 曲线参数数组 |
Returns
打断后的曲线数组。
syncData
▸ syncData(_toCpp?
): boolean
同步实体的数据。这个方法可能是在修改了实体的属性或者附加了新的数据之后调用的,以确保所有的改变都被正确地保存到实体的数据库记录中。
Parameters
Name | Type | Default value | Description |
---|---|---|---|
_toCpp | boolean | true | 是否同步数据 |
Returns
boolean
Inherited from
tempRelationObject
▸ tempRelationObject(): number
与对象相关的临时关系数
Returns
number
Inherited from
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
Name | Type | Description |
---|---|---|
transformationMatrix | McGeMatrix3d | 变换矩阵 |
Returns
boolean
Inherited from
unErase
▸ unErase(): boolean
反删除对象。
Returns
boolean
Inherited from
updateDisplay
▸ updateDisplay(): void
显示调用对象更新显示.
Returns
void