mxcad_2d API 文档 / 2d / McObjectId
Class: McObjectId
2d.McObjectId
McObjectId类表示一个模型对象的唯一标识符。
Table of contents
Constructors
Properties
Methods
- clone
- erase
- getMcDbBlockTableRecord
- getMcDbCurve
- getMcDbCustomEntity
- getMcDbDictionary
- getMcDbDimStyleTableRecord
- getMcDbDimension
- getMcDbEntity
- getMcDbLayerTableRecord
- getMcDbLinetypeTableRecord
- getMcDbObject
- getMcDbRasterImageDef
- getMcDbTextStyleTableRecord
- getMcDbXrecord
- getMxDbEntity
- getObjectName
- isErase
- isKindOf
- isNull
- isValid
Constructors
constructor
• new McObjectId(id?
, type?
)
创建一个McObjectId实例。
Parameters
Name | Type | Default value | Description |
---|---|---|---|
id | number | 0 | 对象的唯一标识符。 |
type | McObjectIdType | McObjectIdType.kInvalid | 对象的类型。 |
Properties
id
• id: number
对象ID
type
• type: McObjectIdType
对象类型
Methods
clone
▸ clone(): null
| McDbObject
克隆对象
Example
// 假设objectId为一个对象id
const obj_clone = objectId.clone();
Returns
null
| McDbObject
返回克隆后的数据库对象
erase
▸ erase(isErase?
): void
删除对象。
Example
// 假设objectId为一个模型对象id
objectId.erase();
Parameters
Name | Type | Default value | Description |
---|---|---|---|
isErase | boolean | true | 是否删除 |
Returns
void
getMcDbBlockTableRecord
▸ getMcDbBlockTableRecord(): null
| McDbBlockTableRecord
返回 MxCAD 块表记录对象。
Example
// 假设objectId为一个块对象id
const blkRecord = objectId.getMcDbBlockTableRecord();
Returns
null
| McDbBlockTableRecord
getMcDbCurve
▸ getMcDbCurve(): null
| McDbCurve
返回MxCAD McDbCurve 对象。
Example
// 假设objectId为一个曲线对象id
const curve = objectId.getMcDbCurve();
Returns
null
| McDbCurve
getMcDbCustomEntity
▸ getMcDbCustomEntity(): null
| McDbCustomEntity
获取自定义实体
Example
// 假设objectId为一个自定义实体id
const customEnt = objectId.getMcDbCustomEntity();
Returns
null
| McDbCustomEntity
getMcDbDictionary
▸ getMcDbDictionary(): null
| McDbDictionary
获取数据库中的字典信息
Example
// 假设objectId为一个对象id
const dic = objectId.getMcDbDictionary();
Returns
null
| McDbDictionary
getMcDbDimStyleTableRecord
▸ getMcDbDimStyleTableRecord(): null
| McDbDimStyleTableRecord
返回 MxCAD 标注样表记录对象。
Example
Returns
null
| McDbDimStyleTableRecord
getMcDbDimension
▸ getMcDbDimension(): null
| McDbDimension
返回MxCAD McDbDimension 对象。
Example
// 假设objectId为一个标注id
const dim = objectId.getMcDbDimension();
Returns
null
| McDbDimension
getMcDbEntity
▸ getMcDbEntity(): null
| McDbEntity
返回MxCAD McDbEntity 对象。
Example
// 假设objectId为一个图形对象id
const ent = objectId.getMcDbEntity();
Returns
null
| McDbEntity
getMcDbLayerTableRecord
▸ getMcDbLayerTableRecord(): null
| McDbLayerTableRecord
返回 MxCAD 图层表记录对象。
Example
// 假设objectId为一个图层对象id
const layerRecord = objectId.getMcDbLayerTableRecord();
Returns
null
| McDbLayerTableRecord
getMcDbLinetypeTableRecord
▸ getMcDbLinetypeTableRecord(): null
| McDbLinetypeTableRecord
返回 MxCAD 线型表记录对象。
Example
// 假设objectId为一个线型对象id
const lineTypeRecord = objectId.getMcDbLinetypeTableRecord();
Returns
null
| McDbLinetypeTableRecord
getMcDbObject
▸ getMcDbObject(): null
| McDbObject
返回MxCAD McDbObject对象。
Example
// 假设objectId为一个模型对象id
const obj = objectId.getMcDbObject();
Returns
null
| McDbObject
返回一个数据库对象
getMcDbRasterImageDef
▸ getMcDbRasterImageDef(): null
| McDbRasterImageDef
获取栅格图像信息
Example
// 假设objectId为一个对象id
const def = objectId.getMcDbRasterImageDef();
Returns
null
| McDbRasterImageDef
getMcDbTextStyleTableRecord
▸ getMcDbTextStyleTableRecord(): null
| McDbTextStyleTableRecord
返回 MxCAD 文字样式表记录对象。
Example
// 假设objectId为一个文字样式id
const textStyleRecord = objectId.getMcDbTextStyleTableRecord();
Returns
null
| McDbTextStyleTableRecord
getMcDbXrecord
▸ getMcDbXrecord(): null
| McDbXrecord
获取扩展记录信息
Example
// 假设objectId为一个对象id
const Xrecord = objectId.getMcDbXrecord();
Returns
null
| McDbXrecord
getMxDbEntity
▸ getMxDbEntity(): null
| MxDbEntity
返回MxDraw对象。
Example
// 假设objectId为一个对象id
const mx_obj = objectId.getMxDbEntity();
Returns
null
| MxDbEntity
getObjectName
▸ getObjectName(): string
返回id指向的对象名称.
Example
// 假设objectId为一个对象id
const obj_name = objectId.getObjectName();
Returns
string
isErase
▸ isErase(): boolean
id是指向的对像,是否是删除状态.
Example
// 假设objectId为一个模型对象id
const res = objectId.isErase();
console.log(res)
Returns
boolean
布尔值
isKindOf
▸ isKindOf(className
): boolean
判断一个对象的类型
Example
import { McDbLine, McGePoint3d, MxCpp } from 'mxcad';
const line = new McDbLine(new McGePoint3d(0,0,0),new McGePoint3d(20,20,0) );
const objectId = MxCpp.getCurrentCAD().drawEntity(line);
console.log(objectId.isKindOf('McDbLine'))
Parameters
Name | Type | Description |
---|---|---|
className | string | 类型名 |
Returns
boolean
isNull
▸ isNull(): boolean
id是否为NULL.
Example
// 假设objectId为一个模型对象id
const res = objectId.isNull();
console.log(res)
Returns
boolean
布尔值
isValid
▸ isValid(): boolean
id是否有效.
Example
// 假设objectId为一个模型对象id
const res = objectId.isValid();
console.log(res)
Returns
boolean
布尔值