mxcad_2d API 文档 / 2d / McDbLine
Class: McDbLine
2d.McDbLine
表示一个直线对象。
Example
//参数绘直线 pt1,pt2是直线的两个点。
import { MxCpp, McDbLine } from "mxcad"'
const line = new McDbLine(); // 构造直线对象
line.startPoint = pt1; // 设置直线起点
line.endPoint = pt2; // 设置直线终点
MxCpp.getCurrentMxCAD().drawEntity(line); // 绘制直线
//交互绘线,点击画布选择直线的起始点。
import { MxCADUiPrPoint, MxCpp } from "mxcad";
async function MxTest_DrawLine() {
// 取起始点
const getPoint = new MxCADUiPrPoint();
getPoint.setMessage("\n指定第一点:");
let prvPoint = await getPoint.go();
if (!prvPoint) return;
getPoint.setMessage("\n指定下一个点:");
// 循环取点
while (true) {
getPoint.setBasePt(prvPoint as any);
let pt = await getPoint.go();
if (!pt) return;
let line = new McDbLine(prvPoint, pt);
MxCpp.getCurrentMxCAD().drawEntity(line);
prvPoint = pt;
}
}
Hierarchy
↳
McDbLine
Table of contents
Constructors
Properties
Accessors
- colorIndex
- drawOrder
- dxf0
- endPoint
- layer
- layerId
- linetype
- linetypeId
- linetypeScale
- lineweight
- normal
- objectName
- startPoint
- textStyle
- textStyleId
- trueColor
- visible
Methods
- IntersectWith
- assertObjectModification
- clone
- createExtensionDictionary
- deleteXData
- disableDisplay
- erase
- explode
- 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
- transformBy
- unErase
- updateDisplay
Constructors
constructor
• new McDbLine(x1?
, y1?
, z1?
, x2?
, y2?
, z2?
)
构造函数。
Example
import { McDbLine, McGePoint3d } from 'mxcad';
// 创建 McGePoint3d 对象表示起点和终点
const startPoint = new McGePoint3d(0, 0, 0);
const endPoint = new McGePoint3d(10, 10, 0);
// 通过 McGePoint3d 对象创建 McDbLine 对象
const line1 = new McDbLine(startPoint, endPoint);
// 或者直接传入坐标值创建 McDbLine 对象
const line2 = new McDbLine(0, 0, 0, 10, 10, 0);
Parameters
Name | Type |
---|---|
x1? | number | object |
y1? | number | object |
z1? | number |
x2? | number |
y2? | number |
z2? | number |
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
McDbCurve.colorIndex
• set
colorIndex(val
): void
设置对象颜色索引
Parameters
Name | Type | Description |
---|---|---|
val | number | 颜色索引(ColorIndexType) |
Returns
void
Inherited from
McDbCurve.colorIndex
drawOrder
• get
drawOrder(): number
对象的显示顺序
Example
// 假设ent为有效实例对象
const order = ent.drawOrder();
Returns
number
Inherited from
McDbCurve.drawOrder
• set
drawOrder(order
): 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;
}
})
Parameters
Name | Type | Description |
---|---|---|
order | number | 顺序值 |
Returns
void
Inherited from
McDbCurve.drawOrder
dxf0
• get
dxf0(): string
得到对象的DXF组码的类型名,这个和AutoCAD中的DXF组码是一样。 比如直线的类型名为:McDbLine,DXF0组码值: LINE,DXF0组码值可以用来构造集时的类型过滤。
Returns
string
Inherited from
McDbCurve.dxf0
endPoint
• get
endPoint(): McGePoint3d
获取终点。
Example
import { McDbLine } from "mxcad";
const line = new McDbLine(0, 0, 0, 10, 10, 0);
const pt2 = line.endPoint;
console.log(pt2)// (10,10,0);
Returns
• set
endPoint(pt
): void
设置终点。
Example
import { McDbLine, McGePoint3d } from "mxcad";
const line = new McDbLine(0, 0, 0, 10, 10, 0);
line.endPoint = new McGePoint3d(20,0,0)
Parameters
Name | Type | Description |
---|---|---|
pt | McGePoint3d | 新的终点。 |
Returns
void
layer
• get
layer(): string
得到对象图层名
Returns
string
Inherited from
McDbCurve.layer
• set
layer(val
): void
设置对象图层名
Example
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity();
ent.layer = "newLayerName";
console.log(ent.layer)
Parameters
Name | Type | Description |
---|---|---|
val | string | 图层名 |
Returns
void
Inherited from
McDbCurve.layer
layerId
• get
layerId(): McObjectId
获取图层ID对象
Example
// 假设ent为有效实例对象
const layerId = ent.layerId;
Returns
Inherited from
McDbCurve.layerId
• set
layerId(id
): void
设置图层Id对象
Example
// 假设ent为有效实例对象
const mxcad = MxCpp.getCurrentMxCAD();
const layerId = mxcad.addLayer("测试图层")
ent.layerId = layerId;
Parameters
Name | Type |
---|---|
id | McObjectId |
Returns
void
Inherited from
McDbCurve.layerId
linetype
• get
linetype(): string
得到对象线型名
Returns
string
Inherited from
McDbCurve.linetype
• set
linetype(val
): void
设置对象线型名
Example
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.linetype = "MyLineType";
console.log(ent.linetype)
Parameters
Name | Type | Description |
---|---|---|
val | string | 线型名 |
Returns
void
Inherited from
McDbCurve.linetype
linetypeId
• get
linetypeId(): McObjectId
获取实体对象线型ID
Example
// 假设ent为有效实例对象
const linetypeId = ent.linetypeId;
Returns
Inherited from
McDbCurve.linetypeId
• set
linetypeId(id
): void
设置实体对象线型ID
Example
// 假设ent为有效实例对象
const mxcad = MxCpp.getCurrentMxCAD();
const lineId = mxcad.addLinetypeEx("TestMyLine", '25,-5');
ent.linetypeId = lineId;
Parameters
Name | Type |
---|---|
id | McObjectId |
Returns
void
Inherited from
McDbCurve.linetypeId
linetypeScale
• get
linetypeScale(): number
得到对象线型比例
Returns
number
Inherited from
McDbCurve.linetypeScale
• set
linetypeScale(val
): void
设置对象线型比例
Example
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.linetypeScale = 0.8;
console.log(ent.linetypeScale)
Parameters
Name | Type | Description |
---|---|---|
val | number | 线型比例 |
Returns
void
Inherited from
McDbCurve.linetypeScale
lineweight
• get
lineweight(): number
得到对象线重
Returns
number
Inherited from
McDbCurve.lineweight
• set
lineweight(val
): void
设置对象线重
Example
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.lineweight = 20;
console.log(ent.lineweight)
Parameters
Name | Type | Description |
---|---|---|
val | number | 线重 |
Returns
void
Inherited from
McDbCurve.lineweight
normal
• get
normal(): McGeVector3d
返回对象的normal
Example
Returns
Inherited from
McDbCurve.normal
• set
normal(val
): void
设置对象的normal
Example
Parameters
Name | Type |
---|---|
val | McGeVector3d |
Returns
void
Inherited from
McDbCurve.normal
objectName
• get
objectName(): string
获取对象名称。
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
console.log(obj.objectName);
Returns
string
返回对象名
Inherited from
McDbCurve.objectName
startPoint
• get
startPoint(): McGePoint3d
获取起点。
Example
import { McDbLine } from "mxcad";
const line = new McDbLine(0, 0, 0, 10, 10, 0);
const pt1 = line.startPoint;
console.log(pt1)// (0,0,0)
Returns
• set
startPoint(pt
): void
设置起点。
Example
import { McDbLine, McGePoint3d } from "mxcad";
const line = new McDbLine(0, 0, 0, 10, 10, 0);
line.startPoint = new McGePoint3d(20,0,0)
Parameters
Name | Type | Description |
---|---|---|
pt | McGePoint3d | 新的起点。 |
Returns
void
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
Name | Type | Description |
---|---|---|
val | string | 文字样式名 |
Returns
void
Inherited from
McDbCurve.textStyle
textStyleId
• get
textStyleId(): McObjectId
获取实体文字样式
Example
// 假设ent为有效实例对象
const textStyleId = ent.textStyleId;
Returns
Inherited from
McDbCurve.textStyleId
• set
textStyleId(id
): void
设置实体的文字样式
Example
// 假设ent为有效实例对象
const mxcad = MxCpp.getCurrentMxCAD();
const textStyleId = mxcad.addTextStyle("MyLineTypeTextStyle", "txt.shx", "hztxt.shx", 1);
ent.textStyleId = textStyleId;
Parameters
Name | Type |
---|---|
id | McObjectId |
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
Inherited from
McDbCurve.trueColor
• set
trueColor(val
): void
设置对象颜色
Parameters
Name | Type |
---|---|
val | McCmColor |
Returns
void
Inherited from
McDbCurve.trueColor
visible
• get
visible(): boolean
对象是否可见
Returns
boolean
Inherited from
McDbCurve.visible
• set
visible(val
): void
设置是否可见
Example
import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.visible = true;
console.log(ent.visible)
Parameters
Name | Type | Description |
---|---|---|
val | boolean | 布尔值 |
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
Name | Type | Description |
---|---|---|
intersectObject | McDbEntity | 需要相交的是实体对象 |
exOption | Intersect | 相交的选项 |
Returns
得到所有交点
Inherited from
assertObjectModification
▸ assertObjectModification(autoUndo?
): number
设置对象被改变的状态,可自动触发更新显示函数,更新显示。 比如块表记录更新了,需要通知块引用更新显示,可以调用该函数。
Example
//假设obj为一个数据库对象
obj.assertObjectModification()
Parameters
Name | Type | Default value |
---|---|---|
autoUndo | boolean | false |
Returns
number
Inherited from
McDbCurve.assertObjectModification
clone
▸ clone(): null
| McDbObject
克隆对象。
Example
//假设obj为一个数据库对象
const obj_clone = obj.clone();
Returns
null
| McDbObject
克隆出的对象。
Inherited from
createExtensionDictionary
▸ createExtensionDictionary(): boolean
创建对象的扩展字典数据.
Example
//假设obj为一个数据库对象
const res = obj.createExtensionDictionary();
Returns
boolean
Inherited from
McDbCurve.createExtensionDictionary
deleteXData
▸ deleteXData(appName
): 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
//删除失败
}
Parameters
Name | Type | Description |
---|---|---|
appName | string | 扩展数据名称 |
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
删除对象。
Example
//假设obj为一个数据库对象
const res = obj.erase();
console.log(res);
Returns
boolean
是否删除成功。
Inherited from
explode
▸ explode(): MxCADResbuf
打碎对象,返回打后对象数据链表
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();
Returns
resbuf 数据
Inherited from
getAllAppName
▸ getAllAppName(): McGeStringArray
获取实体中包含的所有 XData 记录的应用程序名(AppName)
Example
// 假设ent为有效实例对象
const appNames = ent.getAllAppName();
console.log(appNames);
Returns
Inherited from
getArea
▸ getArea(): Object
计算面积
Example
import { McGePoint3d, McDbCircle } from "mxcad"
const center = new McGePoint3d(0,0,0);
const circle = new McDbCircle(center, 20);
const area = circle.getArea();
console.log("圆面积:", area)
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;
text.position = text.alignmentPoint = 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
得到一个点到曲线的最近点
Example
import { McGePoint3d, McDbCircle, MxCADUiPrPoint, MxCpp } from "mxcad"
const center = new McGePoint3d(0,0,0);
const circle = new McDbCircle(center, 20);
const mxcad = MxCpp.getCurrentMxCAD();
mxcad.drawEntity(circle);
const getPoint = new MxCADUiPrPoint();
getPoint.setUserDraw((pt,pw)=>{
//获取pt到circle上最近的点
const point = circle.getClosestPointTo(pt);
console.log(point)
})
const point = await getPoint.go();
Parameters
Name | Type | Description |
---|---|---|
givenPnt | McGePoint3d | 参考点 |
isExtend | boolean | 是否延展实体 |
Returns
Object
点对象及执行结果。
Name | Type |
---|---|
ret | boolean |
val | McGePoint3d |
Inherited from
getDatabase
▸ getDatabase(): McDbDatabase
得到对象所在的数据库
Example
//假设obj为一个数据库对象
const data = obj.getDatabase();
Returns
返回数据库
Inherited from
getDatabaseIndexId
▸ getDatabaseIndexId(): number
获取对象的索引ID
Example
//假设obj为一个数据库对象
const id = obj.getDatabaseIndexId();
Returns
number
Inherited from
getDistAtParam
▸ getDistAtParam(param
): Object
获取参数位置上的距离。
Example
// 假设curve为有效曲线实例对象
const res = curve.getDistAtParam(2);
if(res.ret){
console.log(res.val)
}
Parameters
Name | Type | Description |
---|---|---|
param | number | 参数位置。 |
Returns
Object
距离及执行结果。
Name | Type |
---|---|
ret | boolean |
val | number |
Inherited from
getDistAtPoint
▸ getDistAtPoint(pt
): Object
获取曲线上点的距离位置。
Example
import { McGePoint3d, McDbLine } from "mxcad"
const pt1 = new McGePoint3d(0,0,0);
const pt2 = new McGePoint3d(20,0,0);
const line = new McDbLine(pt1, pt2)
const res = line.getDistAtPoint(pt2);
if(res.ret){
const dist = res.val;
console.log(dist);//20
}
Parameters
Name | Type | Description |
---|---|---|
pt | McGePoint3d | 距离位置。 |
Returns
Object
点及执行结果。
Name | Type |
---|---|
ret | boolean |
val | number |
Inherited from
getEndParam
▸ getEndParam(): Object
获取结束参数。
Example
// 假设curve为有效曲线实例对象
const endPa = curve.getEndParam();
if(endPa.ret){
console.log(endPa.val)
}
Returns
Object
结束参数及执行结果。
Name | Type |
---|---|
ret | boolean |
val | number |
Inherited from
getEndPoint
▸ getEndPoint(): Object
得到曲线的结束点
Example
import { McGePoint3d, McDbLine } from "mxcad"
const pt1 = new McGePoint3d(0,0,0);
const pt2 = new McGePoint3d(20,0,0);
const line = new McDbLine(pt1, pt2)
const res = line.getEndPoint();
if(res.ret){
const point = res.val;
console.log(point);//(20, 0, 0)
}
Returns
Object
曲线的结束点及执行结果。
Name | Type |
---|---|
ret | boolean |
val | McGePoint3d |
Inherited from
getExtensionDictionary
▸ getExtensionDictionary(): McDbDictionary
得到对象的扩展字典数据.
Example
//假设obj为一个数据库对象
const id = obj.getOwnerID();
Returns
扩展字典数据
Inherited from
McDbCurve.getExtensionDictionary
getFirstDeriv
▸ getFirstDeriv(pt
): Object
通过曲线上某点得到曲线的一阶导数
Example
import { McGePoint3d, McDbCircle } from "mxcad"
const center = new McGePoint3d(0,0,0);
const circle = new McDbCircle(center, 20);
const vec = circle.getFirstDeriv(new McGePoint3d(20,0,0));//目标点切向量
if(vec.ret){
const val = vec.val;
}
Parameters
Name | Type | Description |
---|---|---|
pt | McGePoint3d | 曲线上的点 |
Returns
Object
曲线一阶导数及执行结果。
Name | Type |
---|---|
ret | boolean |
val | McGeVector3d |
Inherited from
getFirstDerivFromParam
▸ getFirstDerivFromParam(param
): Object
通过曲线参数得到曲线的一阶导数
Example
// 假设curve为有效曲线实例对象
const res = curve.getFirstDerivFromParam(5);
if(res.ret){
console.log(res.val)
}
Parameters
Name | Type | Description |
---|---|---|
param | number | 曲线参数 |
Returns
Object
曲线一阶导数及执行结果。
Name | Type |
---|---|
ret | boolean |
val | McGeVector3d |
Inherited from
McDbCurve.getFirstDerivFromParam
getGripPoints
▸ getGripPoints(): McGePoint3dArray
获取对象的控制点
Example
//假设obj为一个数据库对象
const ptArr = obj.getGripPoints();
Returns
Inherited from
getHandle
▸ getHandle(): string
得到对象句柄
Example
//假设obj为一个数据库对象
const handle = obj.getHandle();
Returns
string
返回对象句柄
Inherited from
getImp
▸ getImp(): any
获取内部实现对象。
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
let imp = obj.getImp();
Returns
any
内部实现对象。
Inherited from
getJson
▸ getJson(): string
获取 JSON 格式的字符串。
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
const json = obj.getJson()
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 |
Inherited from
getObjectID
▸ getObjectID(): McObjectId
获取对象 ID。
Example
import { McDbObject } from "mxcad";
const id = obj.getObjectID();
Returns
对象 ID。
Inherited from
getOwnerID
▸ getOwnerID(): number
得到对象拥用者的id
Example
//假设obj为一个数据库对象
const id = obj.getOwnerID();
Returns
number
Inherited from
getParamAtDist
▸ getParamAtDist(dist
): Object
获取距离位置上的参数。
Example
// 假设curve为有效曲线实例对象
const res = curve.getParamAtDist(0);
if(res.ret){
console.log(res.val)
}
Parameters
Name | Type | Description |
---|---|---|
dist | number | 距离位置。 |
Returns
Object
参数及执行结果。
Name | Type |
---|---|
ret | boolean |
val | number |
Inherited from
getParamAtPoint
▸ getParamAtPoint(pt
): Object
得到曲线某点位置的曲线参数
Example
import { McGePoint3d, McDbLine } from "mxcad"
const pt1 = new McGePoint3d(0,0,0);
const pt2 = new McGePoint3d(20,0,0);
const line = new McDbLine(pt1, pt2)
const res = line.getParamAtPoint(pt1);
if(res.ret){
const val = res.val;
console.log(val);
}
Parameters
Name | Type | Description |
---|---|---|
pt | McGePoint3d | 曲线上的点 |
Returns
Object
曲线参数及执行结果。
Name | Type |
---|---|
ret | boolean |
val | number |
Inherited from
getPointAtDist
▸ getPointAtDist(dist
): Object
获取距离位置上的点。
Example
import { McGePoint3d, McDbLine } from "mxcad"
const pt1 = new McGePoint3d(0,0,0);
const pt2 = new McGePoint3d(20,0,0);
const line = new McDbLine(pt1, pt2)
const res = line.getPointAtDist(10);
if(res.ret){
const point = res.val;
console.log(point);//(10, 0, 0)
}
Parameters
Name | Type | Description |
---|---|---|
dist | number | 距离位置。 |
Returns
Object
点及执行结果。
Name | Type |
---|---|
ret | boolean |
val | McGePoint3d |
Inherited from
getPointAtParam
▸ getPointAtParam(param
): Object
得到曲线参数所在的点坐标
Example
// 假设curve为有效曲线实例对象
const res = curve.getPointAtParam(5);
if(res.ret){
console.log(res.val)
}
Parameters
Name | Type | Description |
---|---|---|
param | number | 曲线参数 |
Returns
Object
点对象及执行结果。
Name | Type |
---|---|
ret | boolean |
val | McGePoint3d |
Inherited from
getSamplePoints
▸ getSamplePoints(dApproxEps
): MxCADResbuf
把曲线离散成一堆点
Example
import { McGePoint3d, McDbLine } from "mxcad"
const pt1 = new McGePoint3d(0,0,0);
const pt2 = new McGePoint3d(20,0,0);
const line = new McDbLine(pt1, pt2);
const resBuf = line.getSamplePoints(0.1);
Parameters
Name | Type | Description |
---|---|---|
dApproxEps | number | 采样间隔 |
Returns
resbuf 数据
Inherited from
getStartParam
▸ getStartParam(): Object
获取起始参数。
Example
// 假设curve为有效曲线实例对象
const startPa = curve.getStartParam();
if(startPa.ret){
console.log(startPa.val)
}
Returns
Object
起始参数及执行结果。
Name | Type |
---|---|
ret | boolean |
val | number |
Inherited from
getStartPoint
▸ getStartPoint(): Object
得到曲线的开始点
Example
import { McGePoint3d, McDbLine } from "mxcad"
const pt1 = new McGePoint3d(0,0,0);
const pt2 = new McGePoint3d(20,0,0);
const line = new McDbLine(pt1, pt2)
const res = line.getStartPoint();
if(res.ret){
const point = res.val;
console.log(point);//(0, 0, 0)
}
Returns
Object
曲线的开始点及执行结果。
Name | Type |
---|---|
ret | boolean |
val | McGePoint3d |
Inherited from
getxData
▸ getxData(appName?
): MxCADResbuf
得到对象的扩展数据
Example
// 假设ent为有效实例对象
const xData = ent.getXData();
Parameters
Name | Type | Default value | Description |
---|---|---|---|
appName | string | "" | 扩展数据名 |
Returns
Inherited from
getxDataDouble
▸ getxDataDouble(appName
): Object
获取实体的指定 XData 类型中的 double 值
Example
// 假设ent为有效实例对象
let data = ent.getxDataDouble("DataName");
if(data.ret){
console.log(data.val)
}
Parameters
Name | Type | Description |
---|---|---|
appName | string | 扩展数据名称 |
Returns
Object
double 值
Name | Type |
---|---|
ret | boolean |
val | number |
Inherited from
getxDataLong
▸ getxDataLong(appName
): Object
获取实体的指定 XData 类型中的 long(整数)值
Example
// 假设ent为有效实例对象
let data = ent.getxDataLong("DataName");
if(data.ret){
console.log(data.val)
}
Parameters
Name | Type | Description |
---|---|---|
appName | string | 扩展数据名称 |
Returns
Object
long 值
Name | Type |
---|---|
ret | boolean |
val | number |
Inherited from
getxDataPoint
▸ getxDataPoint(appName
): Object
获取实体的指定 XData 类型中的点对象
Parameters
Name | Type | Description |
---|---|---|
appName | string | 扩展数据名称 |
Returns
Object
获取结果及三维点对象
Name | Type |
---|---|
ret | boolean |
val | McGePoint3d |
Inherited from
getxDataString
▸ getxDataString(appName
): Object
获取与特定实体关联的 XData 信息,并以字符串形式返回
Example
// 假设ent为有效实例对象
let data = ent.getxDataString("DataName");
if(data.ret){
console.log(data.val)
}
Parameters
Name | Type | Description |
---|---|---|
appName | string | 扩展数据名称 |
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.highlight(true);
Parameters
Name | Type | Description |
---|---|---|
isHighlight | boolean | 是否高亮 |
Returns
void
Inherited from
initTempObject
▸ initTempObject(imp
): void
初始化临时对象。
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
obj.initTempObject()
Parameters
Name | Type | Description |
---|---|---|
imp | any | 内部实现对象。 |
Returns
void
Inherited from
isErased
▸ isErased(): boolean
对象是否已经删除
Example
//假设obj为一个数据库对象
const res = obj.isErased();
console.log(res);
Returns
boolean
Inherited from
isHaveExtensionDictionary
▸ isHaveExtensionDictionary(): boolean
是否有扩展字典数据.
Example
//假设obj为一个数据库对象
const res = obj.isHaveExtensionDictionary();
Returns
boolean
Inherited from
McDbCurve.isHaveExtensionDictionary
isKindOf
▸ isKindOf(sObjectName
): boolean
判断对象类型
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
let isKind = obj.isKindOf('SomeObjectType');
console.log(isKind); // 输出: true 或 false
Parameters
Name | Type | Description |
---|---|---|
sObjectName | string | 类型名 |
Returns
boolean
返回对象是否是目标类型
Inherited from
isNull
▸ isNull(): any
判断是否为空对象
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
console.log(obj.isNull()); // 输出: true 或 false
Returns
any
Inherited from
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
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
移动对象的控制点
Example
//假设obj为一个数据库对象
obj.moveGripPointsAt(1,10,10,10);
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
偏移后的对象数组。
Inherited from
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 格式的字符串。
Example
import { McRxObject } from 'mxcad';
let obj = new McRxObject();
const res = obj.setJson('{"key": "value"}');
console.log(res)
Parameters
Name | Type | Description |
---|---|---|
str | string | JSON 格式的字符串。 |
Returns
boolean
是否设置成功。
Inherited from
setxData
▸ setxData(xdata
): 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"}]));
Parameters
Name | Type | Description |
---|---|---|
xdata | MxCADResbuf | 扩展数据链表 |
Returns
boolean
Inherited from
setxDataDouble
▸ setxDataDouble(appName
, val
): boolean
设置实体的指定 XData 类型中的 double 值
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{
//设置失败
}
Parameters
Name | Type | Description |
---|---|---|
appName | string | 扩展数据名称 |
val | number | double 值 |
Returns
boolean
布尔值
Inherited from
setxDataLong
▸ setxDataLong(appName
, val
): boolean
设置实体的指定 XData 类型中的 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{
//设置失败
}
Parameters
Name | Type | Description |
---|---|---|
appName | string | 扩展数据名称 |
val | number | long 值 |
Returns
boolean
long 值
Inherited from
setxDataPoint
▸ setxDataPoint(appName
, val
): boolean
设置实体的指定 XData 类型中的点对象
Parameters
Name | Type | Description |
---|---|---|
appName | string | 扩展数据名称 |
val | McGePoint3d | 点对象 |
Returns
boolean
获取结果及三维点对象
Inherited from
setxDataString
▸ setxDataString(appName
, val
): boolean
设置与特定实体关联的 XData 信息,并以字符串形式设置
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{
//设置失败
}
Parameters
Name | Type | Description |
---|---|---|
appName | string | 扩展数据名称 |
val | string | 字符串值 |
Returns
boolean
是否设置成功
Inherited from
splitCurves
▸ splitCurves(pts
): McDbObjectArray
打断曲线
Example
import { MxCpp } from "mxcad"
// PointsArr:断点数组 event:McDbCurve
event.splitCurves(PointsArr).forEach((e:McDbCurve, index:number) => {
if(index % 2 === 0){
MxCpp.getCurrentCAD().drawEntity(e as McDbEntity)
}
})
Parameters
Name | Type | Description |
---|---|---|
pts | McGePoint3d [] | 断点数组 |
Returns
打断后的曲线数组。
Inherited from
splitCurvesFromParam
▸ splitCurvesFromParam(params
): McDbObjectArray
根据曲线参数打断曲线
Parameters
Name | Type | Description |
---|---|---|
params | number [] | 曲线参数数组 |
Returns
打断后的曲线数组。
Inherited from
McDbCurve.splitCurvesFromParam
syncData
▸ syncData(_toCpp?
): boolean
同步实体的数据。这个方法可能是在修改了实体的属性或者附加了新的数据之后调用的,以确保所有的改变都被正确地保存到实体的数据库记录中。
Example
// 假设ent为有效实例对象
const res = ent.syncData(true);
if(res){
//同步成功
}else{
//同步失败
}
Parameters
Name | Type | Default value | Description |
---|---|---|---|
_toCpp | boolean | true | 是否同步数据 |
Returns
boolean
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
反删除对象。
Example
//假设obj为一个数据库对象
const res = obj.unErase();
console.log(res);
Returns
boolean
Inherited from
updateDisplay
▸ updateDisplay(): void
显示调用对象更新显示.
Example
// 假设ent为有效实例对象
ent.updateDisplay()
Returns
void