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

Class: McDbBlockReference ​

2d.McDbBlockReference

Represents a CAD block reference entity, a block reference used to place, scale, and display an instance of a set of entities in the McDbBlockTableRecord it references

Example

//Insert block
   import { McDbBlockReference } from "mxcad"
  
   let mxcad = MxCpp.App.getCurrentMxCAD();
//BlkFilePath: Block path, insert block
   let blkrecId = await mxcad.insertBlock(blkFilePath, "tree");
   if (!blkrecId.isValid()) {
//Insert block
       return;
   }
//Construct a new block to reference entity objects
   let blkRef = new McDbBlockReference();
//Set block record object ID
   blkRef.blockTableRecordId = blkrecId;
//Obtain the minimum outsourcing of the block
   let box = blkRef.getBoundingBox();
   if (box.ret) {
       let dLen = box.maxPt.distanceTo(box.minPt);
       if (dLen > 0.00001) {
       blkRef.setScale(mxcad.getMxDrawObject().screenCoordLong2Doc(100) / dLen);
       }
   }
//Set block insertion point
   let getPoint = new MxCADUiPrPoint();
GetPoint.setMessage ("\ Specify insertion base point");
//Dynamically drawing blocks
   getPoint.setUserDraw((v, worldDraw) => {
       blkRef.position = v;
       worldDraw.drawMcDbEntity(blkRef);
   });

   let pt = await getPoint.go();
   if (!pt) return;
blkRef.position = pt;//  Set block position
let newBlkRefId = mxcad.drawEntity(blkRef);//  Draw blocks
   if (!newBlkRefId.isValid) {
       console.log("insert error");
       return;
   }

Hierarchy ​

• McDbEntity

  ↳ McDbBlockReference

Table of contents ​

Constructors ​

• constructor

Properties ​

• imp

Accessors ​

• blockName
• blockTableRecordId
• blockTransform
• colorIndex
• drawOrder
• dxf0
• layer
• layerId
• linetype
• linetypeId
• linetypeScale
• lineweight
• normal
• objectName
• position
• rotation
• scaleFactors
• textStyle
• textStyleId
• trueColor
• visible

Methods ​

• IntersectWith
• appendAttribute
• assertObjectModification
• clearSpatialFilterCache
• clone
• createAttribute
• createExtensionDictionary
• createSpatialFilter
• deleteXData
• disableDisplay
• erase
• explode
• getAllAppName
• getAllAttribute
• getArea
• getBoundingBox
• getDatabase
• getDatabaseIndexId
• getExtensionDictionary
• getGripPoints
• getHandle
• getImp
• getJson
• getObjectID
• getOwnerID
• getScale
• getSpatialFilterId
• getxData
• getxDataDouble
• getxDataLong
• getxDataPoint
• getxDataString
• highlight
• initTempObject
• isErased
• isHaveExtensionDictionary
• isKindOf
• isNull
• mirror
• move
• moveGripPointsAt
• rotate
• scaleEntity
• setJson
• setScale
• setxData
• setxDataDouble
• setxDataLong
• setxDataPoint
• setxDataString
• syncData
• transformBy
• unErase
• updateDisplay

Constructors ​

constructor ​

• new McDbBlockReference(imp?)

Initialize a new McDbBlockReference instance.

Example

import { McDbBlockReference } from "mxcad";

const blkRef = new McDbBlockReference();

Parameters ​

Overrides ​

McDbEntity.constructor

Properties ​

imp ​

• imp: any = 0

Internal implementation object.

Inherited from ​

McDbEntity.imp

Accessors ​

blockName ​

• get blockName(): string

Get block name

Example

//BlkRef is a valid CAD block reference entity
let blkName = blkRef.blockName;

Returns ​

string

Block name

blockTableRecordId ​

• get blockTableRecordId(): McObjectId

Get or set the ID of the block referenced by the entity.

Example

import { McDbBlockReference, McDbBlockTableRecord } from "mxcad";
  
  let blkRef = new McDbBlockReference();
let blkRecId = blkTable.add(new McDbBlockTableRecord());// Block Record
  blkRef.blockTableRecordId = blkrecId;
  console.log(blkRef.blockTableRecordId)

Returns ​

McObjectId

• set blockTableRecordId(val): void

Parameters ​

Returns ​

void

blockTransform ​

• get blockTransform(): McGeMatrix3d

Retrieve or set the transformation matrix of the block referenced by the entity.

Example

//BlkRef is a valid CAD block reference entity
let mat = blkRef.blockTransform;

Returns ​

McGeMatrix3d

• set blockTransform(val): void

Parameters ​

Returns ​

void

colorIndex ​

• get colorIndex(): number

Obtain object color index

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

Set object color index

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.colorIndex

drawOrder ​

• get drawOrder(): number

Display order of objects

Example

//Assuming ent is a valid instance object
const order = ent.drawOrder();

Returns ​

number

Inherited from ​

McDbEntity.drawOrder

• set drawOrder(order): void

Display order of objects

Example

import { MxCpp, MxCADSelectionSet } from "mxcad";

let ss = new MxCADSelectionSet();
If (! Await ss.userSelect) return;
//Obtain the maximum and minimum display order of objects on the current graph
let minmaxOrder = MxCpp.getCurrentDatabase().currentSpace.getMinMaxDrawOrder();
//Place the object at the top.
let lOrder = minmaxOrder.maxDrawOrder + 1;
ss.forEach((id) => {
  let ent = id.getMcDbEntity();
  if (ent) {
    ent.drawOrder = lOrder;
  }
})

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.drawOrder

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 the line is McDbLine, and the group code value for DXF0 is: LINE and DXF0 group code values can be used for type filtering when constructing sets.

Returns ​

string

Inherited from ​

McDbEntity.dxf0

layer ​

• get layer(): string

Obtain the layer name of the object

Returns ​

string

Inherited from ​

McDbEntity.layer

• set layer(val): void

Set object layer name

Example

import { McDbEntity } from 'mxcad'
 const ent = new McDbEntity();
 ent.layer = "newLayerName";
 console.log(ent.layer)

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.layer

layerId ​

• get layerId(): McObjectId

Get layer ID object

Example

//Assuming ent is a valid instance object
const layerId = ent.layerId;

Returns ​

McObjectId

Inherited from ​

McDbEntity.layerId

• set layerId(id): void

Set Layer Id Object

Example

//Assuming ent is a valid instance object
const mxcad = MxCpp.getCurrentMxCAD();
Const layerId=mxcad. addLayer (Test Layer)
ent.layerId = layerId;

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.layerId

linetype ​

• get linetype(): string

Obtain the object line type name

Returns ​

string

Inherited from ​

McDbEntity.linetype

• set linetype(val): void

Set object line type name

Example

import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.linetype = "MyLineType";
console.log(ent.linetype)

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.linetype

linetypeId ​

• get linetypeId(): McObjectId

Get entity object line type ID

Example

//Assuming ent is a valid instance object
const linetypeId = ent.linetypeId;

Returns ​

McObjectId

Inherited from ​

McDbEntity.linetypeId

• set linetypeId(id): void

Set entity object line type ID

Example

//Assuming ent is a valid instance object
const mxcad = MxCpp.getCurrentMxCAD();
const lineId = mxcad.addLinetypeEx("TestMyLine", '25,-5');
ent.linetypeId = lineId;

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.linetypeId

linetypeScale ​

• get linetypeScale(): number

Obtain the proportion of object line types

Returns ​

number

Inherited from ​

McDbEntity.linetypeScale

• set linetypeScale(val): void

Set object line type scale

Example

import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.linetypeScale = 0.8;
console.log(ent.linetypeScale)

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.linetypeScale

lineweight ​

• get lineweight(): number

Obtain object line weight

Returns ​

number

Inherited from ​

McDbEntity.lineweight

• set lineweight(val): void

Set object line weight

Example

import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.lineweight = 20;
console.log(ent.lineweight)

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.lineweight

normal ​

• get normal(): McGeVector3d

Return the normal of the object

Example

Returns ​

McGeVector3d

Inherited from ​

McDbEntity.normal

• set normal(val): void

Set the normal of the object

Example

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.normal

objectName ​

• get objectName(): string

Get the object name.

Example

import { McRxObject } from 'mxcad';

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

Returns ​

string

Return object name

Inherited from ​

McDbEntity.objectName

position ​

• get position(): McGePoint3d

Retrieve or set the location of the entity.

Example

import { McDbBlockReference, McGePoint3d } from "mxcad";
  
  let blkRef = new McDbBlockReference();
  blkRef.position = new McGePoint3d(0, 0, 0);

Returns ​

McGePoint3d

• set position(pt): void

Parameters ​

Returns ​

void

rotation ​

• get rotation(): number

Get or set the rotation angle of the entity.

Example

import { McDbBlockReference } from 'mxcad'; //  Assuming this is your class and library

   const blkRef = new McDbBlockReference();
   blkRef.rotation = Math/4;
   const rotation = blkRef.rotation;
console.log('Current rotation:', rotation); //  Output the current rotation angle

Returns ​

number

• set rotation(val): void

Parameters ​

Returns ​

void

scaleFactors ​

• get scaleFactors(): McGePoint3d

Get or set the scaling factor of the entity.

Example

import { McGePoint3d, McDbBlockReference } from 'mxcad';

   const blkRef = new McDbBlockReference();
//Obtain the initial scaling factor
   const initialScaleFactors = blkRef.scaleFactors;
console.log('Initial Scale Factors:', initialScaleFactors); //  Output initial scaling factor
//Set a new scaling factor
const newScaleFactors = new McGePoint3d(2, 2, 2); //  Assuming the scaling factor is set to (2, 2, 2)
   blkRef.scaleFactors = newScaleFactors;
//Retrieve the scaling factor again
   const updatedScaleFactors = blkRef.scaleFactors;
console.log('Updated Scale Factors:', updatedScaleFactors); //  Output updated scaling factor

Returns ​

McGePoint3d

• set scaleFactors(val): void

Parameters ​

Returns ​

void

textStyle ​

• get textStyle(): string

Obtain the text style of the object

Returns ​

string

Inherited from ​

McDbEntity.textStyle

• set textStyle(val): void

Set object text style

Example

import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.textStyle = "st_style";

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.textStyle

textStyleId ​

• get textStyleId(): McObjectId

Get entity text style

Example

//Assuming ent is a valid instance object
const textStyleId = ent.textStyleId;

Returns ​

McObjectId

Inherited from ​

McDbEntity.textStyleId

• set textStyleId(id): void

Set the text style of the entity

Example

//Assuming ent is a valid instance object
const mxcad = MxCpp.getCurrentMxCAD();
const textStyleId = mxcad.addTextStyle("MyLineTypeTextStyle", "txt.shx", "hztxt.shx", 1);
ent.textStyleId = textStyleId;

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.textStyleId

trueColor ​

• get trueColor(): McCmColor

Obtain the color of the object

Example

import { McDbEntity, McCmColor} from 'mxcad'
 const ent = new McDbEntity();
 ent.trueColor = new McCmColor(255, 0, 0);
 console.log(ent.trueColor)

Returns ​

McCmColor

Inherited from ​

McDbEntity.trueColor

• set trueColor(val): void

Set object color

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.trueColor

visible ​

• get visible(): boolean

Is the object visible

Returns ​

boolean

Inherited from ​

McDbEntity.visible

• set visible(val): void

Set whether it is visible

Example

import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.visible = true;
console.log(ent.visible)

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.visible

Methods ​

IntersectWith ​

▸ IntersectWith(intersectObject, exOption): McGePoint3dArray

Intersection with other entities to obtain the intersection point

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 ​

Returns ​

McGePoint3dArray

Obtain all intersection points

Inherited from ​

McDbEntity.IntersectWith

appendAttribute ​

▸ appendAttribute(attrib): McObjectId

Add attribute text object

Example

//BlkRef is a valid CAD block reference entity
let attrib = new McDbAttribute();
attrib.textString = "test";
const objId = blkRef.appendAttribute(attrib);

Parameters ​

Returns ​

McObjectId

Object Id

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.

Example

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

Parameters ​

Returns ​

number

Inherited from ​

McDbEntity.assertObjectModification

clearSpatialFilterCache ​

▸ clearSpatialFilterCache(): boolean

Clear the current cutting boundary display cache. After the current boundary object is modified, use this function to clear the cache and update the display

Example

Returns ​

boolean

clone ​

▸ clone(): null | McDbObject

Clone objects.

Example

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

Returns ​

null | McDbObject

The cloned object.

Inherited from ​

McDbEntity.clone

createAttribute ​

▸ createAttribute(): boolean

Create attribute text objects by defining attributes in block table records

Example

//BlkRef is a valid CAD block reference entity
let res = blkRef.createAttribute();
if(res){
//Created successfully
}else{
//Creation failed
}

Returns ​

boolean

createExtensionDictionary ​

▸ createExtensionDictionary(): boolean

Create extended dictionary data for objects

Example

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

Returns ​

boolean

Inherited from ​

McDbEntity.createExtensionDictionary

createSpatialFilter ​

▸ createSpatialFilter(): boolean

Create a cutting boundary object, and if the cutting boundary already exists, return it directly

Example

Returns ​

boolean

deleteXData ​

▸ deleteXData(appName): boolean

Delete data related to entity specified application name

Example

import { MxCADUiPrEntity, McDbEntity } from "mxcad";

let selEntity = new MxCADUiPrEntity();
SelEntity. setMessage ("Select Object");
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){
//Delete successfully
}else
//Delete failed
}

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.deleteXData

disableDisplay ​

▸ disableDisplay(isDisable): void

Disable automatic update display of objects

Example

import { McDbLine } from 'mxcad'
const line1 = new McDbLine(new McGePoint3d(0,0,0), new McGePoint3d(20,1,0));
line1.disableDisplay(true)

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.disableDisplay

erase ​

▸ erase(): boolean

Delete object.

Example

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

Returns ​

boolean

Whether the deletion was successful.

Inherited from ​

McDbEntity.erase

explode ​

▸ explode(): MxCADResbuf

Break the object and return the linked list of the object's data after being broken

Example

import { McDbEntity, MxCADResbuf } from "mxcad";
//Obtain the target object
let getEnt = new MxCADUiPrEntity();
GetEnt.setMessage ("Select object to break: ");
let id = await getEnt.go();
let ent:McDbEntity = id.getMcDbEntity();
if (ent === null) return;
//Smash objects
      let retExplode: MxCADResbuf = ent.explode();
      if (retExplode.GetCount() == 0) return;
      let iExplodeConut = retExplode.GetCount();
      for (let j = 0; j < iExplodeConut; j++) {
          let tmpobj = retExplode.AtObject(j).val;
          if(tmpobj instanceof McDbEntity ){
              mxcad.drawEntity(tmpobj);
          }
      }

Returns ​

MxCADResbuf

Rebuf data

Inherited from ​

McDbEntity.explode

getAllAppName ​

▸ getAllAppName(): McGeStringArray

Get the application name (AppName) of all XData records contained in the entity

Example

//Assuming ent is a valid instance object
const appNames = ent.getAllAppName();
console.log(appNames);

Returns ​

McGeStringArray

Inherited from ​

McDbEntity.getAllAppName

getAllAttribute ​

▸ getAllAttribute(): McObjectId[]

Obtain all attribute text object IDs for block references

Example

//BlkRef is a valid CAD block reference entity
let aryId = blkRef.getAllAttribute();
aryId.forEach((id) => {
  let attribt: McDbAttribute = id.getMcDbEntity() as any;
})

Returns ​

McObjectId[]

Attribute Text Object ID Array

getArea ​

▸ getArea(): Object

Calculate Area

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 ("Circle area: ", area)

Returns ​

Object

Is the val area value | ret successfully obtained

Inherited from ​

McDbEntity.getArea

getBoundingBox ​

▸ getBoundingBox(): Object

Obtain the minimum outsourcing of the object

Example

import { McDbText, McGePoint3d } from 'mxcad'
const text = new McDbText();
Text.textString="Test Test";
text.height = 20;
text.position = text.alignmentPoint = new McGePoint3d(0,0,0);
const { minPt, maxPt, ret } = text.getBoundingBox()

Returns ​

Object

Inherited from ​

McDbEntity.getBoundingBox

getDatabase ​

▸ getDatabase(): McDbDatabase

Get the database where the object is located

Example

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

Returns ​

McDbDatabase

Return to database

Inherited from ​

McDbEntity.getDatabase

getDatabaseIndexId ​

▸ getDatabaseIndexId(): number

Get the index ID of the object

Example

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

Returns ​

number

Inherited from ​

McDbEntity.getDatabaseIndexId

getExtensionDictionary ​

▸ getExtensionDictionary(): McDbDictionary

Obtain the extended dictionary data of the object

Example

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

Returns ​

McDbDictionary

Expand dictionary data

Inherited from ​

McDbEntity.getExtensionDictionary

getGripPoints ​

▸ getGripPoints(): McGePoint3dArray

Get the control points of the object

Example

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

Returns ​

McGePoint3dArray

Inherited from ​

McDbEntity.getGripPoints

getHandle ​

▸ getHandle(): string

Obtain object handle

Example

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

Returns ​

string

Return object handle

Inherited from ​

McDbEntity.getHandle

getImp ​

▸ getImp(): any

Retrieve internal implementation objects.

Example

import { McRxObject } from 'mxcad';

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

Returns ​

any

Internal implementation object.

Inherited from ​

McDbEntity.getImp

getJson ​

▸ getJson(): string

Retrieve a string in JSON format.

Example

import { McRxObject } from 'mxcad';

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

Returns ​

string

A string in JSON format.

Inherited from ​

McDbEntity.getJson

getObjectID ​

▸ getObjectID(): McObjectId

Get the object ID.

Example

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

Returns ​

McObjectId

Object ID.

Inherited from ​

McDbEntity.getObjectID

getOwnerID ​

▸ getOwnerID(): number

Obtain the ID of the object owner

Example

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

Returns ​

number

Inherited from ​

McDbEntity.getOwnerID

getScale ​

▸ getScale(): number

Returns ​

number

getSpatialFilterId ​

▸ getSpatialFilterId(): McObjectId

Obtain the cutting boundary object

Example

Returns ​

McObjectId

getxData ​

▸ getxData(appName?): MxCADResbuf

Obtain the extended data of the object

Example

//Assuming ent is a valid instance object
const xData = ent.getXData();

Parameters ​

Returns ​

MxCADResbuf

Inherited from ​

McDbEntity.getxData

getxDataDouble ​

▸ getxDataDouble(appName): Object

Retrieve the double value from the specified XData type of the entity

Example

//Assuming ent is a valid instance object
let data = ent.getxDataDouble("DataName");
if(data.ret){
  console.log(data.val)
}

Parameters ​

Returns ​

Object

Double value

Inherited from ​

McDbEntity.getxDataDouble

getxDataLong ​

▸ getxDataLong(appName): Object

Retrieve the long (integer) value from the specified XData type of the entity

Example

//Assuming ent is a valid instance object
let data = ent.getxDataLong("DataName");
if(data.ret){
  console.log(data.val)
}

Parameters ​

Returns ​

Object

Long value

Inherited from ​

McDbEntity.getxDataLong

getxDataPoint ​

▸ getxDataPoint(appName): Object

Retrieve point objects from the specified XData type of entity

Parameters ​

Returns ​

Object

Obtain results and 3D point objects

Inherited from ​

McDbEntity.getxDataPoint

getxDataString ​

▸ getxDataString(appName): Object

Retrieve XData information associated with a specific entity and return it in string form

Example

//Assuming ent is a valid instance object
let data = ent.getxDataString("DataName");
if(data.ret){
  console.log(data.val)
}

Parameters ​

Returns ​

Object

Val XData information | whether ret returns success

Inherited from ​

McDbEntity.getxDataString

highlight ​

▸ highlight(isHighlight): void

Set whether the object is highlighted

Example

import { McDbEntity } from 'mxcad'
const ent = new McDbEntity()
ent.highlight(true);

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.highlight

initTempObject ​

▸ initTempObject(imp): void

Initialize temporary objects.

Example

import { McRxObject } from 'mxcad';

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

Parameters ​

Returns ​

void

Inherited from ​

McDbEntity.initTempObject

isErased ​

▸ isErased(): boolean

Has the object been deleted

Example

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

Returns ​

boolean

Inherited from ​

McDbEntity.isErased

isHaveExtensionDictionary ​

▸ isHaveExtensionDictionary(): boolean

Is there any extended dictionary data available

Example

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

Returns ​

boolean

Inherited from ​

McDbEntity.isHaveExtensionDictionary

isKindOf ​

▸ isKindOf(sObjectName): boolean

Determine object type

Example

import { McRxObject } from 'mxcad';

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

Parameters ​

Returns ​

boolean

Return whether the object is of the target type

Inherited from ​

McDbEntity.isKindOf

isNull ​

▸ isNull(): any

Determine if it is an empty object

Example

import { McRxObject } from 'mxcad';

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

Returns ​

any

Inherited from ​

McDbEntity.isNull

mirror ​

▸ mirror(point1, point2): boolean

Mirror oriented object

Example

import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.mirror(new McGePoint3d(0,0,0), new McGePoint3d(20,10,0))

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.mirror

move ​

▸ move(fromPoint, toPoint): boolean

move objects

Example

import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.move(new McGePoint3d(0,0,0), new McGePoint3d(20,0,0))

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.move

moveGripPointsAt ​

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

Control points for moving objects

Example

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

Parameters ​

Returns ​

any

Inherited from ​

McDbEntity.moveGripPointsAt

rotate ​

▸ rotate(basePoint, dRotationAngle): boolean

Rotate object

Example

import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.rotate(new McGePoint3d(0,0,0), Math.PI)

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.rotate

scaleEntity ​

▸ scaleEntity(basePoint, dScaleFactor): boolean

Scaling objects

Example

import { McDbEntity, McGePoint3d } from 'mxcad'
const ent = new McDbEntity()
ent.scaleEntity(new McGePoint3d(0,0,0), 0.5)

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.scaleEntity

setJson ​

▸ setJson(str): boolean

Set a string in JSON format.

Example

import { McRxObject } from 'mxcad';

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

Parameters ​

Returns ​

boolean

Is the setting successful.

Inherited from ​

McDbEntity.setJson

setScale ​

▸ setScale(val): void

Set and retrieve the scaling ratio of objects

Example

import { McDbBlockReference } from 'mxcad'; //  Assuming this is your class and library

   const blkRef = new McDbBlockReference();

//Set the zoom ratio to 2
   blkRef.setScale(2);

//Get zoom ratio
   const scale = blkRef.getScale();
console.log('Current Scale:', scale); //  Output the current scaling ratio

Parameters ​

Returns ​

void

setxData ​

▸ setxData(xdata): boolean

Set extended data for objects

Example

import { MxCADUiPrEntity, McDbEntity } from "mxcad";

//Set extended data
let selEntity = new MxCADUiPrEntity();
SelEntity. setMessage ("Select Object");
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 ​

Returns ​

boolean

Inherited from ​

McDbEntity.setxData

setxDataDouble ​

▸ setxDataDouble(appName, val): boolean

Set the double value in the specified XData type of the entity

Example

import { MxCADUiPrEntity, McDbEntity } from "mxcad";
let selEntity = new MxCADUiPrEntity();
SelEntity. setMessage ("Select Object");
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){
//Setting successful
}else{
//Setting failed
}

Parameters ​

Returns ​

boolean

Boolean value

Inherited from ​

McDbEntity.setxDataDouble

setxDataLong ​

▸ setxDataLong(appName, val): boolean

Set the long (integer) value in the specified XData type of the entity

Example

import { MxCADUiPrEntity, McDbEntity } from "mxcad";

let selEntity = new MxCADUiPrEntity();
SelEntity. setMessage ("Select Object");
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){
//Setting successful
}else{
//Setting failed
}

Parameters ​

Returns ​

boolean

Long value

Inherited from ​

McDbEntity.setxDataLong

setxDataPoint ​

▸ setxDataPoint(appName, val): boolean

Set the point object in the specified XData type of the entity

Parameters ​

Returns ​

boolean

Obtain results and 3D point objects

Inherited from ​

McDbEntity.setxDataPoint

setxDataString ​

▸ setxDataString(appName, val): boolean

Set XData information associated with a specific entity and set it in string form

Example

import { MxCADUiPrEntity, McDbEntity } from "mxcad";
let selEntity = new MxCADUiPrEntity();
SelEntity. setMessage ("Select Object");
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){
//Setting successful
}else{
//Setting failed
}

Parameters ​

Returns ​

boolean

Is the setting successful

Inherited from ​

McDbEntity.setxDataString

syncData ​

▸ syncData(_toCpp?): boolean

Synchronize entity data. This method may be called after modifying the entity's attributes or attaching new data to ensure that all changes are correctly saved to the entity's database records.

Example

//Assuming ent is a valid instance object
const res = ent.syncData(true);
if(res){
//Synchronization successful
}else{
//Synchronization failed
}

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.syncData

transformBy ​

▸ transformBy(transformationMatrix): boolean

Transform object

Example

import { McGeMatrix3d, McDbEntity, McGeVector3d} from 'mxcad'
 const ent = new McDbEntity()
   let matrix = new McGeMatrix3d();
matrix.setToTranslation(new McGeVector3d(20,0,0));// translation
   ent.transformBy(matrix);

Parameters ​

Returns ​

boolean

Inherited from ​

McDbEntity.transformBy

unErase ​

▸ unErase(): boolean

Anti delete object.

Example

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

Returns ​

boolean

Inherited from ​

McDbEntity.unErase

updateDisplay ​

▸ updateDisplay(): void

Display the updated display of the calling object

Example

//Assuming ent is a valid instance object
ent.updateDisplay()

Returns ​

void

Inherited from ​

McDbEntity.updateDisplay