[mxcad_2d API documentation] (../README. md)/[2d] (../modules/2d. md)/McDbObject

Class: McDbObject

2d.McDbObject

Represents a database object and provides some basic operation functions for objects in the database, such as memory allocation, object deletion, object ID, archiving, and other operations.

Hierarchy

• McRxObject

  ↳ McDbObject

  ↳↳ McDbLinetypeTableRecord

  ↳↳ McDbDimStyleTableRecord

  ↳↳ McDbTextStyleTableRecord

  ↳↳ McDbLayerTableRecord

  ↳↳ McDbLayerTable

  ↳↳ McDbLinetypeTable

  ↳↳ McDbDimStyleTable

  ↳↳ McDbTextStyleTable

  ↳↳ McDbBlockTableRecord

  ↳↳ McDbBlockTable

  ↳↳ McDbRasterImageDef

  ↳↳ McDbDictionary

  ↳↳ McDbXrecord

  ↳↳ McDbGroup

  ↳↳ McDbEntity

  ↳↳ McDbSpatialFilter

Table of contents

Constructors

• constructor

Properties

• imp

Accessors

• dxf0
• objectName

Methods

• assertObjectModification
• clone
• createExtensionDictionary
• erase
• getDatabase
• getDatabaseIndexId
• getExtensionDictionary
• getGripPoints
• getHandle
• getImp
• getJson
• getObjectID
• getOwnerID
• initTempObject
• isErased
• isHaveExtensionDictionary
• isKindOf
• isNull
• moveGripPointsAt
• setJson
• unErase

Constructors

constructor

• new McDbObject(imp?)

Constructor.

Parameters

Name	Type	Description
imp?	any	Internal implementation object.

Example

import { McDbObject } from "mxcad";

const obj = new McDbObject()

Overrides

McRxObject.constructor

Properties

imp

• imp: any = 0

Internal implementation object.

Inherited from

McRxObject.imp

Accessors

dxf0

• get dxf0(): string

Obtain the type name of the object's DXF group code, which is the same as the DXF group code in AutoCAD. For example, the type name of a line is McDbLine, and the DXF0 group code value is LINE. The DXF0 group code value can be used for type filtering when constructing sets.

Returns

string

Inherited from

McRxObject.dxf0

---

objectName

• get objectName(): string

Get the object name.

Returns

string

Return object name

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
console.log(obj.objectName);

Inherited from

McRxObject.objectName

Methods

assertObjectModification

▸ assertObjectModification(autoUndo?): number

Setting the state of the object to be changed can automatically trigger the update display function to update the display. For example, if the block table record is updated and the block reference needs to be notified to update the display, this function can be called.

Parameters

Name	Type	Default value
autoUndo	boolean	false

Returns

number

Example

//Assuming obj is a database object
obj.assertObjectModification()

---

clone

▸ clone(): null | McDbObject

Clone objects.

Returns

null | McDbObject

The cloned object.

Example

//Assuming obj is a database object
const obj_clone = obj.clone();

---

createExtensionDictionary

▸ createExtensionDictionary(): boolean

Create extended dictionary data for objects

Returns

boolean

Example

//Assuming obj is a database object
const res = obj.createExtensionDictionary();

---

erase

▸ erase(): boolean

Delete object.

Returns

boolean

Whether the deletion was successful.

Example

//Assuming obj is a database object
const res = obj.erase();
console.log(res);

---

getDatabase

▸ getDatabase(): McDbDatabase

Get the database where the object is located

Returns

McDbDatabase

Return to database

Example

//Assuming obj is a database object
const data = obj.getDatabase();

---

getDatabaseIndexId

▸ getDatabaseIndexId(): number

Get the index ID of the object

Returns

number

Example

//Assuming obj is a database object
const id = obj.getDatabaseIndexId();

---

getExtensionDictionary

▸ getExtensionDictionary(): McDbDictionary

Obtain the extended dictionary data of the object

Returns

McDbDictionary

Expand dictionary data

Example

//Assuming obj is a database object
const id = obj.getOwnerID();

---

getGripPoints

▸ getGripPoints(): McGePoint3dArray

Get the control points of the object

Returns

McGePoint3dArray

Example

//Assuming obj is a database object
const ptArr = obj.getGripPoints();

---

getHandle

▸ getHandle(): string

Obtain object handle

Returns

string

Return object handle

Example

//Assuming obj is a database object
const handle = obj.getHandle();

---

getImp

▸ getImp(): any

Retrieve internal implementation objects.

Returns

any

Internal implementation object.

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
let imp = obj.getImp();

Inherited from

McRxObject.getImp

---

getJson

▸ getJson(): string

Retrieve a string in JSON format.

Returns

string

A string in JSON format.

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
const json = obj.getJson()

Inherited from

McRxObject.getJson

---

getObjectID

▸ getObjectID(): McObjectId

Get the object ID.

Returns

McObjectId

Object ID.

Example

import { McDbObject } from "mxcad";
const id = obj.getObjectID();

---

getOwnerID

▸ getOwnerID(): number

Obtain the ID of the object owner

Returns

number

Example

//Assuming obj is a database object
const id = obj.getOwnerID();

---

initTempObject

▸ initTempObject(imp): void

Initialize temporary objects.

Parameters

Name	Type	Description
'imp'	'any'	Internal implementation object.

Returns

void

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
obj.initTempObject()

Inherited from

McRxObject.initTempObject

---

isErased

▸ isErased(): boolean

Has the object been deleted

Returns

boolean

Example

//Assuming obj is a database object
const res = obj.isErased();
console.log(res);

---

isHaveExtensionDictionary

▸ isHaveExtensionDictionary(): boolean

Is there any extended dictionary data available

Returns

boolean

Example

//Assuming obj is a database object
const res = obj.isHaveExtensionDictionary();

---

isKindOf

▸ isKindOf(sObjectName): boolean

Determine object type

Parameters

Name	Type	Description
SOrtName	string	Type Name

Returns

boolean

Return whether the object is of the target type

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
let isKind = obj.isKindOf('SomeObjectType');
console.log(isKind); //Output: true or false

Inherited from

McRxObject.isKindOf

---

isNull

▸ isNull(): any

Determine if it is an empty object

Returns

any

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
console.log(obj.isNull()); //Output: true or false

Inherited from

McRxObject.isNull

---

moveGripPointsAt

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

Control points for moving objects

Parameters

Name	Type	Description
IIndex	Number	Index
DXOffset	number	X-axis offset
DYOffset	number	Y-axis offset
DZOffset	number	Z-axis offset

Returns

any

Example

//Assuming obj is a database object
obj.moveGripPointsAt(1,10,10,10);

---

setJson

▸ setJson(str): boolean

Set a string in JSON format.

Parameters

Name	Type	Description
Str	string	JSON formatted string.

Returns

boolean

Is the setting successful.

Example

import { McRxObject } from 'mxcad';

let obj = new McRxObject();
const res = obj.setJson('{"key": "value"}');
console.log(res)

Inherited from

McRxObject.setJson

---

unErase

▸ unErase(): boolean

Anti delete object.

Returns

boolean

Example

//Assuming obj is a database object
const res = obj.unErase();
console.log(res);