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
- getMcDbGroup
- 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
克隆对象
Returns
null | McDbObject
返回克隆后的数据库对象
Example
// 假设objectId为一个对象id
const obj_clone = objectId.clone();erase
▸ erase(isErase?): void
删除对象。
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
isErase | boolean | true | 是否删除 |
Returns
void
Example
// 假设objectId为一个模型对象id
objectId.erase();getMcDbBlockTableRecord
▸ getMcDbBlockTableRecord(): null | McDbBlockTableRecord
返回 MxCAD 块表记录对象。
Returns
null | McDbBlockTableRecord
Example
// 假设objectId为一个块对象id
const blkRecord = objectId.getMcDbBlockTableRecord();getMcDbCurve
▸ getMcDbCurve(): null | McDbCurve
返回MxCAD McDbCurve 对象。
Returns
null | McDbCurve
Example
// 假设objectId为一个曲线对象id
const curve = objectId.getMcDbCurve();getMcDbCustomEntity
▸ getMcDbCustomEntity(): null | McDbCustomEntity
获取自定义实体
Returns
null | McDbCustomEntity
Example
// 假设objectId为一个自定义实体id
const customEnt = objectId.getMcDbCustomEntity();getMcDbDictionary
▸ getMcDbDictionary(): null | McDbDictionary
获取数据库中的字典信息
Returns
null | McDbDictionary
Example
// 假设objectId为一个对象id
const dic = objectId.getMcDbDictionary();getMcDbDimStyleTableRecord
▸ getMcDbDimStyleTableRecord(): null | McDbDimStyleTableRecord
返回 MxCAD 标注样表记录对象。
Returns
null | McDbDimStyleTableRecord
Example
getMcDbDimension
▸ getMcDbDimension(): null | McDbDimension
返回MxCAD McDbDimension 对象。
Returns
null | McDbDimension
Example
// 假设objectId为一个标注id
const dim = objectId.getMcDbDimension();getMcDbEntity
▸ getMcDbEntity(): null | McDbEntity
返回MxCAD McDbEntity 对象。
Returns
null | McDbEntity
Example
// 假设objectId为一个图形对象id
const ent = objectId.getMcDbEntity();getMcDbGroup
▸ getMcDbGroup(): null | McDbGroup
返回MxCAD McDbGroup 对象。
Returns
null | McDbGroup
Example
// 假设objectId为一个Group id
const group = objectId.getMcDbGroup();getMcDbLayerTableRecord
▸ getMcDbLayerTableRecord(): null | McDbLayerTableRecord
返回 MxCAD 图层表记录对象。
Returns
null | McDbLayerTableRecord
Example
// 假设objectId为一个图层对象id
const layerRecord = objectId.getMcDbLayerTableRecord();getMcDbLinetypeTableRecord
▸ getMcDbLinetypeTableRecord(): null | McDbLinetypeTableRecord
返回 MxCAD 线型表记录对象。
Returns
null | McDbLinetypeTableRecord
Example
// 假设objectId为一个线型对象id
const lineTypeRecord = objectId.getMcDbLinetypeTableRecord();getMcDbObject
▸ getMcDbObject(): null | McDbObject
返回MxCAD McDbObject对象。
Returns
null | McDbObject
返回一个数据库对象
Example
// 假设objectId为一个模型对象id
const obj = objectId.getMcDbObject();getMcDbRasterImageDef
▸ getMcDbRasterImageDef(): null | McDbRasterImageDef
获取栅格图像信息
Returns
null | McDbRasterImageDef
Example
// 假设objectId为一个对象id
const def = objectId.getMcDbRasterImageDef();getMcDbTextStyleTableRecord
▸ getMcDbTextStyleTableRecord(): null | McDbTextStyleTableRecord
返回 MxCAD 文字样式表记录对象。
Returns
null | McDbTextStyleTableRecord
Example
// 假设objectId为一个文字样式id
const textStyleRecord = objectId.getMcDbTextStyleTableRecord();getMcDbXrecord
▸ getMcDbXrecord(): null | McDbXrecord
获取扩展记录信息
Returns
null | McDbXrecord
Example
// 假设objectId为一个对象id
const Xrecord = objectId.getMcDbXrecord();getMxDbEntity
▸ getMxDbEntity(): null | MxDbEntity
返回MxDraw对象。
Returns
null | MxDbEntity
Example
// 假设objectId为一个对象id
const mx_obj = objectId.getMxDbEntity();getObjectName
▸ getObjectName(): string
返回id指向的对象名称.
Returns
string
Example
// 假设objectId为一个对象id
const obj_name = objectId.getObjectName();isErase
▸ isErase(): boolean
id是指向的对像，是否是删除状态.
Returns
boolean
布尔值
Example
// 假设objectId为一个模型对象id
const res = objectId.isErase();
console.log(res)isKindOf
▸ isKindOf(className): boolean
判断一个对象的类型
Parameters
| Name | Type | Description |
|---|---|---|
className | string | 类型名 |
Returns
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'))isNull
▸ isNull(): boolean
id是否为NULL.
Returns
boolean
布尔值
Example
// 假设objectId为一个模型对象id
const res = objectId.isNull();
console.log(res)isValid
▸ isValid(): boolean
id是否有效.
Returns
boolean
布尔值
Example
// 假设objectId为一个模型对象id
const res = objectId.isValid();
console.log(res)