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

Class: MxCADResbuf ​

2d.MxCADResbuf

The MxCADResbuf class is used to manipulate respuf data in AutoCAD.

Example

//Filter all text objects in the drawing
  import { MxCADResbuf } from "mxcad"
//Define filtering
  const filter = new MxCADResbuf();
  filter.AddMcDbEntityTypes("TEXT,MTEXT");
//Set selection, filter text objects
  let ss = new MxCADSelectionSet();
  ss.allSelect(filter);
  ss.forEach((id) => {
    let ent: any = id.getMcDbEntity();
    if (!ent) return;
    ent = McDbEntityToJsonObject(ent);
    console.log(JSON.stringify(ent));
  })

Hierarchy ​

• McRxObject

  ↳ MxCADResbuf

Table of contents ​

Constructors ​

• constructor

Properties ​

• imp

Accessors ​

• dxf0
• objectName

Methods ​

• AddAppName
• AddDouble
• AddLong
• AddMcDbEntityTypes
• AddObject
• AddObjectId
• AddPoint
• AddString
• AtDouble
• AtLong
• AtObject
• AtObjectId
• AtPoint
• AtString
• Clear
• GetCount
• GetPoints
• ItemDataDxf
• ItemDataType
• PrintData
• Remove
• RemoveAll
• forEach
• getImp
• getJson
• initTempObject
• isKindOf
• isNull
• setJson

Constructors ​

constructor ​

• new MxCADResbuf(imp?)

Constructor.

Example

import { MxCADResbuf, DxfCode } from "mxcad"
//Define filters to filter entity types: line, arc, circle, polyline
const filter = new MxCADResbuf([DxfCode.kEntityType, "LINE,ARC,CIRCLE,LWPOLYLINE"]));

Parameters ​

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 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 ​

McRxObject.dxf0

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 ​

McRxObject.objectName

Methods ​

AddAppName ​

▸ AddAppName(str, decodeFromGb2312?): number

Add extension data name and filter using selection set

Parameters ​

Returns ​

number

AddDouble ​

▸ AddDouble(val, lDataType?): number

Add a double value to the respuff.

Example

import { MxCADResbuf } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
filter.AddDouble (3.14);

Parameters ​

Returns ​

number

Index of added data items.

AddLong ​

▸ AddLong(val, lDataType?): number

Add a long type value to the respuff.

Example

import { MxCADResbuf } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
filter.AddLong (42);

Parameters ​

Returns ​

number

Index of added data items.

AddMcDbEntityTypes ​

▸ AddMcDbEntityTypes(str): any

Add entity types for selection set filtering

Description

Type table of entities

Example

import { MxCADResbuf } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
filter.AddMcDbEntityTypes ("TEXT,LINE");

Parameters ​

Returns ​

any

AddObject ​

▸ AddObject(pObj): void

Add McRxObject object to respuff

Example

import { MxCADResbuf, McRxObject } from "mxcad"
//Define filters
const filter = new MxCADResbuf();
filter.AddObject( new McRxObject());

Parameters ​

Returns ​

void

AddObjectId ​

▸ AddObjectId(val, lDataType?): number

Add the Object ID to the respuff.

Example

import { MxCADResbuf, McDbObject } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
const objId = new McDbObject();
filter.AddObjectId (objId);

Parameters ​

Returns ​

number

Index of added data items.

AddPoint ​

▸ AddPoint(pt, lDataType?): number

Add point coordinates to the respuff.

Example

import { MxCADResbuf, McGePoint3d } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
filter.AddPoint (new McGePoint3d(10,20,0));

Parameters ​

Returns ​

number

Index of added data items.

AddString ​

▸ AddString(str, lDataType?, decodeFromGb2312?): number

Add a string to the respuff.

Example

import { MxCADResbuf } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
Filter. AddString ("test string");

Parameters ​

Returns ​

number

Index of added data items.

AtDouble ​

▸ AtDouble(lItem): Object

Retrieve the double type value from the respuff data item.

Example

import { MxCADResbuf } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
console.log(filter.AtDouble(0))

Parameters ​

Returns ​

Object

An object that contains a double type value and a return value.

AtLong ​

▸ AtLong(lItem): Object

Retrieve the long type value from the respuff data item.

Example

import { MxCADResbuf } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
console.log(filter.AtLong(0))

Parameters ​

Returns ​

Object

An object that contains a long type value and a return value.

AtObject ​

▸ AtObject(lItem): Object

Retrieve the McRxObject object from the respuff data item.

Example

import { MxCADResbuf } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
console.log(filter.AtObject(0))

Parameters ​

Returns ​

Object

An object that contains database objects and return values.

AtObjectId ​

▸ AtObjectId(lItem): Object

Retrieve the Object ID from the respuff data item.

Example

import { MxCADResbuf } from "mxcad

const filter = new MxCADResbuf();
console.log(filter.AtObjectId(0))

Parameters ​

Returns ​

Object

An object that contains an Object Id and a return value.

AtPoint ​

▸ AtPoint(lItem): Object

Retrieve the point coordinates from the respuff data item.

Example

import { MxCADResbuf } from "mxcad

const filter = new MxCADResbuf();
console.log(filter.AtPoint(0))

Parameters ​

Returns ​

Object

An object that contains point coordinates and return values.

AtString ​

▸ AtString(lItem, decodeFromGb2312?): Object

Retrieve the string from the respuff data item.

Example

import { MxCADResbuf } from "mxcad

const filter = new MxCADResbuf();
console.log(filter.AtString(0))

Parameters ​

Returns ​

Object

An object that contains a string and a return value.

Clear ​

▸ Clear(): void

Clear the respuff data.

Example

import { MxCADResbuf } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
filter.AddMcDbEntityTypes("TEXT,MTEXT");
filter.Clear();
Console. log (filter. FHIR ount())//Output 0

Returns ​

void

GetCount ​

▸ GetCount(): number

Retrieve the number of respuff data items.

Example

import { MxCADResbuf } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
Console. log (filter. FHIR ount())//Output 0

Returns ​

number

The number of respuff data items.

GetPoints ​

▸ GetPoints(): McGePoint3dArray

Retrieve all point data from the respuff.

Example

Returns ​

McGePoint3dArray

ItemDataDxf ​

▸ ItemDataDxf(index): number

Retrieve the DXF value of the data in the respuff data item

Example

import { MxCADResbuf } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
console.log(filter.ItemDataDxf(0))

Parameters ​

Returns ​

number

DXF value

ItemDataType ​

▸ ItemDataType(index): number

Retrieve the data type from the respuff data item.

Example

import { MxCADResbuf } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
console.log(filter.ItemDataType(0))

Parameters ​

Returns ​

number

Data type.

PrintData ​

▸ PrintData(): void

Debugging input information

Example

import { MxCADResbuf } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
Filter. PrintData ("Debug Information")

Returns ​

void

Remove ​

▸ Remove(lItem): void

Remove the respuff data item from the specified index.

Example

import { MxCADResbuf } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
filter.AtLong (42);
filter.Remove(0);

Parameters ​

Returns ​

void

RemoveAll ​

▸ RemoveAll(): void

Remove all respuff data items.

Example

import { MxCADResbuf } from "mxcad"
//Define filters
const filter = new MxCADResbuf()
filter.AtLong (42);
filter.RemoveAll();

Returns ​

void

forEach ​

▸ forEach(call): void

Traverse the data.

Example

import {MxCADResbuf} from "mxcad"

//Create MxCADResbuf instance
  const cadResbuf = new MxCADResbuf();
cadResbuf.AddPoint(new McGePoint3d(1,2,3));// Add a point element
cadResbuf.AddString(“Hello”);// Add a string element
cadResbuf.AddDouble (3.14);// Add double precision data
cadResbuf.AddLong (42);// Add an integer data

//Iterate elements in CAD Resuff instances
  cadResbuf.forEach((val, type, dxf)=>{
Console.log (Value: ",val);
Console.log (Type: ",type);
   console.log("DXF:",DXF);
   });
//Output:
//Value: {x: 1, y: 2, z: 3}
//Type: 5009
   // dxf: 10
//Value: Hello
//Type: 5005
   // dxf: 10
//Value: 3.14
//Type: 5001
   // dxf: 10
//Value: 42
//Type: 5010
   // dxf: 10

Parameters ​

Returns ​

void

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 ​

McRxObject.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 ​

McRxObject.getJson

initTempObject ​

▸ initTempObject(imp): void

Initialize temporary objects.

Example

import { McRxObject } from 'mxcad';

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

Parameters ​

Returns ​

void

Inherited from ​

McRxObject.initTempObject

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 ​

McRxObject.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 ​

McRxObject.isNull

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 ​

McRxObject.setJson