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

Class: McDbLine

2d.McDbLine

Represents a straight line object.

Example

//Draw a straight line pt1 and pt2 as the two points of the line.
import { MxCpp, McDbLine } from "mxcad"'

const line = new McDbLine(); //Construct a straight line object
line.startPoint = pt1; //Set the starting point of the straight line
line.endPoint = pt2; //Set the endpoint of a straight line
MxCpp.getCurrentMxCAD().drawEntity(line); //Draw a straight line

//Interactive line drawing, click on the canvas to select the starting point of the line.
  import { MxCADUiPrPoint, MxCpp } from "mxcad";
  
  async function MxTest_DrawLine() {
//Take the starting point
   const getPoint = new MxCADUiPrPoint();
GetPoint.setMessage ("\ nSpecify the first point:");
   let prvPoint = await getPoint.go();
   if (!prvPoint) return;
GetPoint.setMessage ("\ nSpecify next point:");
//Loop sampling
   while (true) {
       getPoint.setBasePt(prvPoint as any);
       let pt = await getPoint.go();
       if (!pt) return;
       let line = new McDbLine(prvPoint, pt);
       MxCpp.getCurrentMxCAD().drawEntity(line);
       prvPoint = pt;
   }
   }

Hierarchy

• McDbCurve

  ↳ McDbLine

Table of contents

Constructors

• constructor

Properties

• imp

Accessors

• colorIndex
• drawOrder
• dxf0
• endPoint
• layer
• layerId
• linetype
• linetypeId
• linetypeScale
• lineweight
• normal
• objectName
• startPoint
• textStyle
• textStyleId
• trueColor
• visible

Methods

• IntersectWith
• assertObjectModification
• clone
• createExtensionDictionary
• deleteXData
• disableDisplay
• erase
• explode
• getAllAppName
• getArea
• getBoundingBox
• getClosestPointTo
• getDatabase
• getDatabaseIndexId
• getDistAtParam
• getDistAtPoint
• getEndParam
• getEndPoint
• getExtensionDictionary
• getFirstDeriv
• getFirstDerivFromParam
• getGripPoints
• getHandle
• getImp
• getJson
• getLength
• getObjectID
• getOwnerID
• getParamAtDist
• getParamAtPoint
• getPointAtDist
• getPointAtParam
• getSamplePoints
• getStartParam
• getStartPoint
• getxData
• getxDataDouble
• getxDataLong
• getxDataPoint
• getxDataString
• highlight
• initTempObject
• isErased
• isHaveExtensionDictionary
• isKindOf
• isNull
• mirror
• move
• moveGripPointsAt
• offsetCurves
• rotate
• scaleEntity
• setJson
• setxData
• setxDataDouble
• setxDataLong
• setxDataPoint
• setxDataString
• splitCurves
• splitCurvesFromParam
• syncData
• transformBy
• unErase
• updateDisplay

Constructors

constructor

• new McDbLine(x1?, y1?, z1?, x2?, y2?, z2?)

Constructor.

Parameters

Name	Type
x1?	number | object
y1?	number | object
z1?	number
x2?	number
y2?	number
z2?	number

Example

import { McDbLine, McGePoint3d } from 'mxcad';

//Create McGePoint3d objects to represent the starting and ending points
const startPoint = new McGePoint3d(0, 0, 0);
const endPoint = new McGePoint3d(10, 10, 0);
//Create McDbLine objects using McGePoint3d objects
const line1 = new McDbLine(startPoint, endPoint);
//Alternatively, you can directly input coordinate values to create a McDbLine object
const line2 = new McDbLine(0, 0, 0, 10, 10, 0);

Overrides

McDbCurve.constructor

Properties

imp

• imp: any = 0

Internal implementation object.

Inherited from

McDbCurve.imp

Accessors

colorIndex

• get colorIndex(): number

Obtain object color index

Returns

number

Example

 import { McDbEntity, ColorIndexType } from 'mxcad'
 const ent = new McDbEntity();
 ent.colorIndex = ColorIndexType.kByblock;
 console.log(ent.colorIndex)

Inherited from

McDbCurve.colorIndex

• set colorIndex(val): void

Set object color index

Parameters

Name	Type	Description
Val	number	ColorIndexType

Returns

void

Inherited from

McDbCurve.colorIndex

---

drawOrder

• get drawOrder(): number

Display order of objects

Returns

number

Example

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

Inherited from

McDbCurve.drawOrder

• set drawOrder(order): void

Display order of objects

Parameters

Name	Type	Description
Order	number	sequential value

Returns

void

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;
  }
})

Inherited from

McDbCurve.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 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

McDbCurve.dxf0

---

endPoint

• get endPoint(): McGePoint3d

Obtain the endpoint.

Returns

McGePoint3d

Example

import { McDbLine } from "mxcad";

const line = new McDbLine(0, 0, 0, 10, 10, 0);
const pt2 = line.endPoint;
console.log(pt2)// (10,10,0);

• set endPoint(pt): void

Set the endpoint.

Parameters

Name	Type	Description
Pt	[McGePoint3d] (2d. McGePoint3d. md)	New endpoint.

Returns

void

Example

import { McDbLine, McGePoint3d } from "mxcad";

const line = new McDbLine(0, 0, 0, 10, 10, 0);
line.endPoint = new McGePoint3d(20,0,0)

---

layer

• get layer(): string

Obtain the layer name of the object

Returns

string

Inherited from

McDbCurve.layer

• set layer(val): void

Set object layer name

Parameters

Name	Type	Description
Val	string	Layer Name

Returns

void

Example

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

Inherited from

McDbCurve.layer

---

layerId

• get layerId(): McObjectId

Get layer ID object

Returns

McObjectId

Example

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

Inherited from

McDbCurve.layerId

• set layerId(id): void

Set Layer Id Object

Parameters

Name	Type
id	McObjectId

Returns

void

Example

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

Inherited from

McDbCurve.layerId

---

linetype

• get linetype(): string

Obtain the object line type name

Returns

string

Inherited from

McDbCurve.linetype

• set linetype(val): void

Set object line type name

Parameters

Name	Type	Description
Val	string	Line type name

Returns

void

Example

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

Inherited from

McDbCurve.linetype

---

linetypeId

• get linetypeId(): McObjectId

Get entity object line type ID

Returns

McObjectId

Example

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

Inherited from

McDbCurve.linetypeId

• set linetypeId(id): void

Set entity object line type ID

Parameters

Name	Type
id	McObjectId

Returns

void

Example

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

Inherited from

McDbCurve.linetypeId

---

linetypeScale

• get linetypeScale(): number

Obtain the proportion of object line types

Returns

number

Inherited from

McDbCurve.linetypeScale

• set linetypeScale(val): void

Set object line type scale

Parameters

Name	Type	Description
Val	number	Line type ratio

Returns

void

Example

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

Inherited from

McDbCurve.linetypeScale

---

lineweight

• get lineweight(): number

Obtain object line weight

Returns

number

Inherited from

McDbCurve.lineweight

• set lineweight(val): void

Set object line weight

Parameters

Name	Type	Description
Val	number	line weight

Returns

void

Example

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

Inherited from

McDbCurve.lineweight

---

normal

• get normal(): McGeVector3d

Return the normal of the object

Returns

McGeVector3d

Example

Inherited from

McDbCurve.normal

• set normal(val): void

Set the normal of the object

Parameters

Name	Type
val	McGeVector3d

Returns

void

Example

Inherited from

McDbCurve.normal

---

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

McDbCurve.objectName

---

startPoint

• get startPoint(): McGePoint3d

Get the starting point.

Returns

McGePoint3d

Example

import { McDbLine } from "mxcad";

const line = new McDbLine(0, 0, 0, 10, 10, 0);
const pt1 = line.startPoint;
console.log(pt1)// (0,0,0)

• set startPoint(pt): void

Set the starting point.

Parameters

Name	Type	Description
Pt	[McGePoint3d] (2d. McGePoint3d. md)	New starting point.

Returns

void

Example

import { McDbLine, McGePoint3d } from "mxcad";

const line = new McDbLine(0, 0, 0, 10, 10, 0);
line.startPoint = new McGePoint3d(20,0,0)

---

textStyle

• get textStyle(): string

Obtain the text style of the object

Returns

string

Inherited from

McDbCurve.textStyle

• set textStyle(val): void

Set object text style

Parameters

Name	Type	Description
Val	string	Text style name

Returns

void

Example

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

Inherited from

McDbCurve.textStyle

---

textStyleId

• get textStyleId(): McObjectId

Get entity text style

Returns

McObjectId

Example

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

Inherited from

McDbCurve.textStyleId

• set textStyleId(id): void

Set the text style of the entity

Parameters

Name	Type
id	McObjectId

Returns

void

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;

Inherited from

McDbCurve.textStyleId

---

trueColor

• get trueColor(): McCmColor

Obtain the color of the object

Returns

McCmColor

Example

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

Inherited from

McDbCurve.trueColor

• set trueColor(val): void

Set object color

Parameters

Name	Type
val	McCmColor

Returns

void

Inherited from

McDbCurve.trueColor

---

visible

• get visible(): boolean

Is the object visible

Returns

boolean

Inherited from

McDbCurve.visible

• set visible(val): void

Set whether it is visible

Parameters

Name	Type	Description
Val	boolean	Boolean value

Returns

void

Example

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

Inherited from

McDbCurve.visible

Methods

IntersectWith

▸ IntersectWith(intersectObject, exOption): McGePoint3dArray

Intersection with other entities to obtain the intersection point

Parameters

Name	Type	Description
IntersectObject	[McDbEntity] (2d. McDbEntity. md)	The entity object that needs to intersect is the entity object
ExOption	Intersection (../enums/2d. McDb. Intersect. md)	Intersection options

Returns

McGePoint3dArray

Obtain all intersection points

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)

Inherited from

McDbCurve.IntersectWith

---

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()

Inherited from

McDbCurve.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();

Inherited from

McDbCurve.clone

---

createExtensionDictionary

▸ createExtensionDictionary(): boolean

Create extended dictionary data for objects

Returns

boolean

Example

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

Inherited from

McDbCurve.createExtensionDictionary

---

deleteXData

▸ deleteXData(appName): boolean

Delete data related to entity specified application name

Parameters

Name	Type	Description
AppName	string	Extended Data Name

Returns

boolean

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
}

Inherited from

McDbCurve.deleteXData

---

disableDisplay

▸ disableDisplay(isDisable): void

Disable automatic update display of objects

Parameters

Name	Type	Description
IsDisable	boolean	Do you want to disable automatic object update display

Returns

void

Example

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

Inherited from

McDbCurve.disableDisplay

---

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);

Inherited from

McDbCurve.erase

---

explode

▸ explode(): MxCADResbuf

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

Returns

MxCADResbuf

Rebuf data

Example

import { McDbEntity, MxCADResbuf } from "mxcad";
//Obtain the target object
let getEnt = new MxCADUiPrEntity();
GetEnt. setMessage ("Select object to smash:");
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);
          }
      }

Inherited from

McDbCurve.explode

---

getAllAppName

▸ getAllAppName(): McGeStringArray

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

Returns

McGeStringArray

Example

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

Inherited from

McDbCurve.getAllAppName

---

getArea

▸ getArea(): Object

Calculate area

Returns

Object

Is the val area value | ret successfully obtained

Name	Type
ret	boolean
val	number

Example

import { McGePoint3d, McDbCircle } from "mxcad"

const circle = new McDbCircle(0,0,0, 20);
const area = circle.getArea();
Console.log ("Circle Area:", area)

Inherited from

McDbCurve.getArea

---

getBoundingBox

▸ getBoundingBox(): Object

Obtain the minimum outsourcing of the object

Returns

Object

Name	Type
maxPt	McGePoint3d
minPt	McGePoint3d
ret	boolean

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()

Inherited from

McDbCurve.getBoundingBox

---

getClosestPointTo

▸ getClosestPointTo(givenPnt, isExtend): Object

Obtain the closest point from a point to the curve

Parameters

Name	Type	Description
GivenPnt	[McGePoint3d] (2d. McGePoint3d. md)	Reference Point
IsExtend	boolean	Whether to extend entity

Returns

Object

Point objects and execution results.

Name	Type
ret	boolean
val	McGePoint3d

Example

import { McGePoint3d, McDbCircle, MxCADUiPrPoint, MxCpp } from "mxcad"

const circle = new McDbCircle(0,0,0, 20);
const mxcad = MxCpp.getCurrentMxCAD();
mxcad.drawEntity(circle);

const getPoint = new MxCADUiPrPoint();
getPoint.setUserDraw((pt,pw)=>{
//Get pt to the nearest point on the circle
  const point = circle.getClosestPointTo(pt);
  console.log(point)
})
const point = await getPoint.go();

Inherited from

McDbCurve.getClosestPointTo

---

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();

Inherited from

McDbCurve.getDatabase

---

getDatabaseIndexId

▸ getDatabaseIndexId(): number

Get the index ID of the object

Returns

number

Example

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

Inherited from

McDbCurve.getDatabaseIndexId

---

getDistAtParam

▸ getDistAtParam(param): Object

Get the distance at the parameter location.

Parameters

Name	Type	Description
Parameter position:.

Returns

Object

Distance and execution results.

Name	Type
ret	boolean
val	number

Example

//Assuming curve is an effective curve instance object
const res = curve.getDistAtParam(2);
if(res.ret){
  console.log(res.val)
}

Inherited from

McDbCurve.getDistAtParam

---

getDistAtPoint

▸ getDistAtPoint(pt): Object

Obtain the distance and position of points on the curve.

Parameters

Name	Type	Description
Pt	[McGePoint3d] (2d. McGePoint3d. md)	Distance position.

Returns

Object

Points and execution results.

Name	Type
ret	boolean
val	number

Example

import { McGePoint3d, McDbLine } from "mxcad"

const pt1 = new McGePoint3d(0,0,0);
const pt2 = new McGePoint3d(20,0,0);
const line = new McDbLine(pt1, pt2)
const res = line.getDistAtPoint(pt2);
if(res.ret){
  const dist = res.val;
  console.log(dist);//20
}

Inherited from

McDbCurve.getDistAtPoint

---

getEndParam

▸ getEndParam(): Object

Get the end parameter.

Returns

Object

End parameters and execution results.

Name	Type
ret	boolean
val	number

Example

//Assuming curve is an effective curve instance object
const endPa = curve.getEndParam();
if(endPa.ret){
  console.log(endPa.val)
}

Inherited from

McDbCurve.getEndParam

---

getEndPoint

▸ getEndPoint(): Object

Obtain the endpoint of the curve

Returns

Object

The endpoint and execution result of the curve.

Name	Type
ret	boolean
val	McGePoint3d

Example

import { McGePoint3d, McDbLine } from "mxcad"

const pt1 = new McGePoint3d(0,0,0);
const pt2 = new McGePoint3d(20,0,0);
const line = new McDbLine(pt1, pt2)
const res = line.getEndPoint();
if(res.ret){
  const point = res.val;
  console.log(point);//(20, 0, 0)
}

Inherited from

McDbCurve.getEndPoint

---

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();

Inherited from

McDbCurve.getExtensionDictionary

---

getFirstDeriv

▸ getFirstDeriv(pt): Object

Obtain the first derivative of the curve through a certain point on the curve

Parameters

Name	Type	Description
Pt	[McGePoint3d] (2d. McGePoint3d. md)	Points on the curve

Returns

Object

The first derivative of the curve and its execution result.

Name	Type
ret	boolean
val	McGeVector3d

Example

import { McGePoint3d, McDbCircle } from "mxcad"

const circle = new McDbCircle(0,0,0, 20);
const vec = circle.getFirstDeriv(new McGePoint3d(20,0,0)); //Target point tangent vector
if(vec.ret){
 const val = vec.val;
}

Inherited from

McDbCurve.getFirstDeriv

---

getFirstDerivFromParam

▸ getFirstDerivFromParam(param): Object

Obtain the first derivative of the curve through curve parameters

Parameters

Name	Type	Description
Param	number	curve parameters

Returns

Object

The first derivative of the curve and its execution result.

Name	Type
ret	boolean
val	McGeVector3d

Example

//Assuming curve is an effective curve instance object
const res = curve.getFirstDerivFromParam(5);
if(res.ret){
  console.log(res.val)
}

Inherited from

McDbCurve.getFirstDerivFromParam

---

getGripPoints

▸ getGripPoints(): McGePoint3dArray

Get the control points of the object

Returns

McGePoint3dArray

Example

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

Inherited from

McDbCurve.getGripPoints

---

getHandle

▸ getHandle(): string

Obtain object handle

Returns

string

Return object handle

Example

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

Inherited from

McDbCurve.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

McDbCurve.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

McDbCurve.getJson

---

getLength

▸ getLength(): Object

Obtain the length of the curve

Returns

Object

Name	Type
ret	boolean
val	number

Example

import { MxCpp, MxCADResbuf, MxCADUtility, MxCADUiPrPoint} from "mxcad"

 const mxcad = MxCpp.App.getCurrentMxCAD();
   let filter = new MxCADResbuf();
   filter.AddMcDbEntityTypes("CIRCLE,ARC,LINE,LWPOLYLINE,ELLIPSE");
Let aryId=await MxCADUtility. userSelect ("Select target curve", filter);
   if (aryId.length == 0)  return;
   aryId.forEach(async (id) => {
       let event = id.getMcDbEntity() as McDbCurve;
       let length = event.getLength().val;
       console.log(length)
   });

Inherited from

McDbCurve.getLength

---

getObjectID

▸ getObjectID(): McObjectId

Get the object ID.

Returns

McObjectId

Object ID.

Example

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

Inherited from

McDbCurve.getObjectID

---

getOwnerID

▸ getOwnerID(): number

Obtain the ID of the object owner

Returns

number

Example

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

Inherited from

McDbCurve.getOwnerID

---

getParamAtDist

▸ getParamAtDist(dist): Object

Obtain parameters at the distance position.

Parameters

Name	Type	Description
Dist	Number	Distance Position.

Returns

Object

Parameters and execution results.

Name	Type
ret	boolean
val	number

Example

//Assuming curve is an effective curve instance object
const res = curve.getParamAtDist(0);
if(res.ret){
  console.log(res.val)
}

Inherited from

McDbCurve.getParamAtDist

---

getParamAtPoint

▸ getParamAtPoint(pt): Object

Obtain the curve parameters at a certain point on the curve

Parameters

Name	Type	Description
Pt	[McGePoint3d] (2d. McGePoint3d. md)	Points on the curve

Returns

Object

Curve parameters and execution results.

Name	Type
ret	boolean
val	number

Example

import { McGePoint3d, McDbLine } from "mxcad"

const pt1 = new McGePoint3d(0,0,0);
const pt2 = new McGePoint3d(20,0,0);
const line = new McDbLine(pt1, pt2)
const res = line.getParamAtPoint(pt1);
if(res.ret){
  const val = res.val;
  console.log(val);
}

Inherited from

McDbCurve.getParamAtPoint

---

getPointAtDist

▸ getPointAtDist(dist): Object

Obtain the point at the distance position.

Parameters

Name	Type	Description
Dist	Number	Distance Position.

Returns

Object

Points and execution results.

Name	Type
ret	boolean
val	McGePoint3d

Example

import { McGePoint3d, McDbLine } from "mxcad"

const pt1 = new McGePoint3d(0,0,0);
const pt2 = new McGePoint3d(20,0,0);
const line = new McDbLine(pt1, pt2)
const res = line.getPointAtDist(10);
if(res.ret){
  const point = res.val;
  console.log(point);//(10, 0, 0)
}

Inherited from

McDbCurve.getPointAtDist

---

getPointAtParam

▸ getPointAtParam(param): Object

Obtain the coordinates of the point where the curve parameters are located

Parameters

Name	Type	Description
Param	number	curve parameters

Returns

Object

Point objects and execution results.

Name	Type
ret	boolean
val	McGePoint3d

Example

//Assuming curve is an effective curve instance object
const res = curve.getPointAtParam(5);
if(res.ret){
  console.log(res.val)
}

Inherited from

McDbCurve.getPointAtParam

---

getSamplePoints

▸ getSamplePoints(dApproxEps?): MxCADResbuf

Discretize the curve into a pile of points

Parameters

Name	Type	Default value	Description
DApproxEps	number	0.0001	sampling interval

Returns

MxCADResbuf

Rebuf data

Example

import { McGePoint3d, McDbLine } from "mxcad"

const pt1 = new McGePoint3d(0,0,0);
const pt2 = new McGePoint3d(20,0,0);
const line = new McDbLine(pt1, pt2);
const resBuf = line.getSamplePoints(0.1);

Inherited from

McDbCurve.getSamplePoints

---

getStartParam

▸ getStartParam(): Object

Get the starting parameters.

Returns

Object

Initial parameters and execution results.

Name	Type
ret	boolean
val	number

Example

//Assuming curve is an effective curve instance object
const startPa = curve.getStartParam();
if(startPa.ret){
  console.log(startPa.val)
}

Inherited from

McDbCurve.getStartParam

---

getStartPoint

▸ getStartPoint(): Object

Obtain the starting point of the curve

Returns

Object

The starting point and execution result of the curve.

Name	Type
ret	boolean
val	McGePoint3d

Example

import { McGePoint3d, McDbLine } from "mxcad"

const pt1 = new McGePoint3d(0,0,0);
const pt2 = new McGePoint3d(20,0,0);
const line = new McDbLine(pt1, pt2)
const res = line.getStartPoint();
if(res.ret){
  const point = res.val;
  console.log(point);//(0, 0, 0)
}

Inherited from

McDbCurve.getStartPoint

---

getxData

▸ getxData(appName?): MxCADResbuf

Obtain the extended data of the object

Parameters

Name	Type	Default value	Description
AppName	string	""	Extended Data Name

Returns

MxCADResbuf

Example

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

Inherited from

McDbCurve.getxData

---

getxDataDouble

▸ getxDataDouble(appName): Object

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

Parameters

Name	Type	Description
AppName	string	Extended Data Name

Returns

Object

Double value

Name	Type
ret	boolean
val	number

Example

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

Inherited from

McDbCurve.getxDataDouble

---

getxDataLong

▸ getxDataLong(appName): Object

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

Parameters

Name	Type	Description
AppName	string	Extended Data Name

Returns

Object

Long value

Name	Type
ret	boolean
val	number

Example

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

Inherited from

McDbCurve.getxDataLong

---

getxDataPoint

▸ getxDataPoint(appName): Object

Retrieve point objects from the specified XData type of entity

Parameters

Name	Type	Description
AppName	string	Extended Data Name

Returns

Object

Obtain results and 3D point objects

Name	Type
ret	boolean
val	McGePoint3d

Inherited from

McDbCurve.getxDataPoint

---

getxDataString

▸ getxDataString(appName): Object

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

Parameters

Name	Type	Description
AppName	string	Extended Data Name

Returns

Object

Val XData information | whether ret returns success

Name	Type
ret	boolean
val	string

Example

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

Inherited from

McDbCurve.getxDataString

---

highlight

▸ highlight(isHighlight): void

Set whether the object is highlighted

Parameters

Name	Type	Description
IsHighlight	boolean	Is it highlighted

Returns

void

Example

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

Inherited from

McDbCurve.highlight

---

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

McDbCurve.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);

Inherited from

McDbCurve.isErased

---

isHaveExtensionDictionary

▸ isHaveExtensionDictionary(): boolean

Is there any extended dictionary data available

Returns

boolean

Example

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

Inherited from

McDbCurve.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

McDbCurve.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

McDbCurve.isNull

---

mirror

▸ mirror(point1, point2): boolean

Mirror oriented object

Parameters

Name	Type	Description
Point1	[McGePoint3d] (2d. McGePoint3d. md)	Mirror Base Point
point2	McGePoint3d	-

Returns

boolean

Example

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

Inherited from

McDbCurve.mirror

---

move

▸ move(fromPoint, toPoint): boolean

move objects

Parameters

Name	Type	Description
From Point	[McGePoint3d] (2d. McGePoint3d. md)	Move the starting point
ToPoint	[McGePoint3d] (2d. McGePoint3d. md)	Move End Point

Returns

boolean

Example

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

Inherited from

McDbCurve.move

---

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);

Inherited from

McDbCurve.moveGripPointsAt

---

offsetCurves

▸ offsetCurves(dOffsetDist, ptOffsetRef): McDbObjectArray

Obtain offset curve

Parameters

Name	Type	Description
DOffsetDist	number	offset distance
PtOffsetRef	[McGePoint3d] (2d. McGePoint3d. md)	Offset point

Returns

McDbObjectArray

Offset object array.

Example

import { MxCADUiPrPoint, MxCpp } from 'mxcad'
   let getFristPoint = new MxCADUiPrPoint();
   let offsetDist = 10 ;
   let getEvent = new MxCADUiPrEntity();
GetEvent.setMessage ('Specify offset object ');
   let event_id = await getEvent.go();
   if (!event_id) return;
   let event = (await event_id.getMcDbEntity()) as McDbCurve;
   let getoOffPt = new MxCADUiPrPoint();
GetoOffPt.setMessage ('specify offset point ');
   let offPt = await getoOffPt.go();
   if (!offPt) return;
   let objArr = event.offsetCurves(offsetDist, offPt);
   if (objArr.length() === 0) return;
   objArr.forEach((obj: McDbObject) => {
       MxCpp.getCurrentCAD().drawEntity(obj as McDbEntity);
   });

Inherited from

McDbCurve.offsetCurves

---

rotate

▸ rotate(basePoint, dRotationAngle): boolean

Rotate object

Parameters

Name	Type	Description
BasePoint	[McGePoint3d] (2d. McGePoint3d. md)	Rotate the base point
DRotationAngle	number	Rotation angle

Returns

boolean

Example

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

Inherited from

McDbCurve.rotate

---

scaleEntity

▸ scaleEntity(basePoint, dScaleFactor): boolean

Scaling objects

Parameters

Name	Type	Description
BasePoint	[McGePoint3d] (2d. McGePoint3d. md)	Scale Base Point
DScaleFactor	number	scaling factor (<1 zoom out;>1 zoom in)

Returns

boolean

Example

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

Inherited from

McDbCurve.scaleEntity

---

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

McDbCurve.setJson

---

setxData

▸ setxData(xdata): boolean

Set extended data for objects

Parameters

Name	Type	Description
Xdata	[MxCADResbuf] (2d. MxCADResbuf. md)	Extended data linked list

Returns

boolean

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"}]));

Inherited from

McDbCurve.setxData

---

setxDataDouble

▸ setxDataDouble(appName, val): boolean

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

Parameters

Name	Type	Description
AppName	string	Extended Data Name
Val	number	double value

Returns

boolean

Boolean value

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
}

Inherited from

McDbCurve.setxDataDouble

---

setxDataLong

▸ setxDataLong(appName, val): boolean

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

Parameters

Name	Type	Description
AppName	string	Extended Data Name
Val	number	long value

Returns

boolean

Long value

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
}

Inherited from

McDbCurve.setxDataLong

---

setxDataPoint

▸ setxDataPoint(appName, val): boolean

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

Parameters

Name	Type	Description
AppName	string	Extended Data Name
Val	[McGePoint3d] (2d. McGePoint3d. md)	Point Object

Returns

boolean

Obtain results and 3D point objects

Inherited from

McDbCurve.setxDataPoint

---

setxDataString

▸ setxDataString(appName, val): boolean

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

Parameters

Name	Type	Description
AppName	string	Extended Data Name
Val	string	string value

Returns

boolean

Is the setting successful

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
}

Inherited from

McDbCurve.setxDataString

---

splitCurves

▸ splitCurves(pts): McDbObjectArray

Detach Curves

Parameters

Name	Type	Description
Pts	McGePoint3d (2d. McGePoint3d. md)	breakpoint array

Returns

McDbObjectArray

Interrupted curve array.

Example

import { MxCpp } from "mxcad"
//PointsArr: breakpoint array event: McDbCurve
   event.splitCurves(PointsArr).forEach((e:McDbCurve, index:number) => {
       if(index % 2 === 0){
           MxCpp.getCurrentCAD().drawEntity(e as McDbEntity)
       }
   })

Inherited from

McDbCurve.splitCurves

---

splitCurvesFromParam

▸ splitCurvesFromParam(params): McDbObjectArray

Break the curve based on the curve parameters

Parameters

Name	Type	Description
Params	number []	curve parameter array

Returns

McDbObjectArray

Interrupted curve array.

Inherited from

McDbCurve.splitCurvesFromParam

---

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.

Parameters

Name	Type	Default value	Description
_toCpp	boolean	true	Whether to synchronize data

Returns

boolean

Example

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

Inherited from

McDbCurve.syncData

---

transformBy

▸ transformBy(transformationMatrix): boolean

Transform object

Parameters

Name	Type	Description
TransformationMatrix	[McGeMatrix3d] (2d. McGeMatrix3d. md)	Transformation Matrix

Returns

boolean

Example

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

Inherited from

McDbCurve.transformBy

---

unErase

▸ unErase(): boolean

Anti delete object.

Returns

boolean

Example

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

Inherited from

McDbCurve.unErase

---

updateDisplay

▸ updateDisplay(): void

Display the updated display of the calling object

Returns

void

Example

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

Inherited from

McDbCurve.updateDisplay