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

Class: McDbPolyline

2d.McDbPolyline

McDbPolyline is a polyline entity class used for creating and managing polyline objects.

Description

This class is used to draw complex shapes composed of multiple line segments, and supports setting vertices, closed states, widths, and display properties.

Summary of usage:

First, create an instance of McDbPolyline.
Then add vertices in sequence and set style parameters such as closed state, constant width, and convexity.
Finally, add it to the current space and display it.

Example

import { McDbPolyline, MxCpp } from 'mxcad'
//Draw a rectangle with a line width of 10, where pt1, pt2, pt3, and pt4 are the 4 vertices of the rectangle
const pl = new McDbPolyline();
pl.constantWidth = 10;//  Set the polyline width to 10
//Set polyline endpoints
pl.addVertexAt(pt1);
pl.addVertexAt(pt2);
pl.addVertexAt(pt3);
pl.addVertexAt(pt4);
pl.isClosed = true; //  Set whether the polyline is closed
MxCpp.getCurrentMxCAD().drawEntity(pl); //  Draw polylines

//Draw Center Rectangle: Specify the width, height, and center point of the rectangle to dynamically draw it
 import { McDbPolyline, MxCpp, MxCADUiPrDist, MxCADUiPrPoint } from 'mxcad';

 async function Mx_CenterRect() {
//Set rectangle width
   let width = 5;
   const getWidth = new MxCADUiPrDist();
GetWidth. setMessage ("\ n Please enter rectangle width<5>");
   const widthVal = await getWidth.go();
   if (widthVal) {
       width = getWidth.value()
   }
//Set the height of the rectangle
   let height = 10;
   const getHeight = new MxCADUiPrDist();
GetHeight. setMessage ("\ n Please enter rectangle height<10>");
   const heightVal = await getHeight.go();
   if (heightVal) {
       height = getHeight.value()
   }
//Set the center point of the rectangle
   const getCenterPt = new MxCADUiPrPoint();
GetCenterPt.setMessage ("Please click to confirm the center of the rectangle");
   const centerPt = await getCenterPt.go();
   if (!centerPt) return;
//Calculate the four vertices of the rectangle based on its center point and width/height
   let pt1 = new McGePoint3d(centerPt.x + width / 2, centerPt.y + height / 2, centerPt.z)
   let pt2 = new McGePoint3d(centerPt.x - width / 2, centerPt.y + height / 2, centerPt.z)
   let pt3 = new McGePoint3d(centerPt.x - width / 2, centerPt.y - height / 2, centerPt.z)
   let pt4 = new McGePoint3d(centerPt.x + width / 2, centerPt.y - height / 2, centerPt.z)
let pl = new McDbPolyline;//  Construct a polyline object
//Add rectangular vertices in sequence
   pl.addVertexAt(pt1)
   pl.addVertexAt(pt2)
   pl.addVertexAt(pt3)
   pl.addVertexAt(pt4)
   const mxcad = MxCpp.App.getCurrentMxCAD();
pl.isClosed = true; //  Set polyline closure
mxcad.drawEntity(pl); //  Draw polyline objects
 }

Hierarchy

McDbCurve
↳ McDbPolyline

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

• new McDbPolyline(imp?)

Constructor function

Parameters

Name	Type	Description
`imp?`	` Any	Implement object

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

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

constantWidth

• get constantWidth(): number

Get constant width

Returns

number

• set constantWidth(val): void

Set constant width

Parameters

Name	Type	Description
Val	number	Constant width

Returns

void

drawOrder

• get drawOrder(): number

Display order of objects

Returns

number

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

McDbCurve.dxf0

isClosed

• get isClosed(): boolean

Get whether it is closed or not

Returns

boolean

• set isClosed(val): void

Set whether to close or not

Parameters

Name	Type	Description
Val	boolean	Is it closed

Returns

void

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

Inherited from

McDbCurve.layer

layerId

• get layerId(): McObjectId

Get layer ID object

Returns

McObjectId

Inherited from

McDbCurve.layerId

• set layerId(id): void

Set Layer Id Object

Parameters

Name	Type
`id`	`McObjectId`

Returns

void

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

Inherited from

McDbCurve.linetype

linetypeId

• get linetypeId(): McObjectId

Get entity object line type ID

Returns

McObjectId

Inherited from

McDbCurve.linetypeId

• set linetypeId(id): void

Set entity object line type ID

Parameters

Name	Type
`id`	`McObjectId`

Returns

void

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

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

Inherited from

McDbCurve.lineweight

normal

• get normal(): McGeVector3d

Return the normal of the object

Returns

McGeVector3d

Inherited from

McDbCurve.normal

• set normal(val): void

Set the normal of the object

Parameters

Name	Type
`val`	`McGeVector3d`

Returns

void

Inherited from

McDbCurve.normal

objectName

• get objectName(): string

Get the object name.

Returns

string

Return object name

Inherited from

McDbCurve.objectName

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

Inherited from

McDbCurve.textStyle

textStyleId

• get textStyleId(): McObjectId

Get entity text style

Returns

McObjectId

Inherited from

McDbCurve.textStyleId

• set textStyleId(id): void

Set the text style of the entity

Parameters

Name	Type
`id`	`McObjectId`

Returns

void

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 mxcad = MxCpp.getCurrentMxCAD();
const textStyleId = mxcad.addTextStyle("MyLineTypeTextStyle", "txt.shx", "hztxt.shx", 1);
ent.textStyleId = textStyleId;

Inherited from

McDbCurve.textStyleId

thickness

• get thickness(): number

Obtain the thickness of the object

Returns

number

Inherited from

McDbCurve.thickness

• set thickness(val): void

Set object thickness

Parameters

Name	Type
`val`	`number`

Returns

void

Inherited from

McDbCurve.thickness

trueColor

• get trueColor(): McCmColor

Obtain the color of the object

Returns

McCmColor

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

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

addVertexAt

▸ addVertexAt(pt, bulge?, startWidth?, endWidth?, index?): boolean

Add vertices at the specified location

Parameters

Name	Type	Default value	Description
Pt	Vector3	[McGePoint3d] (2d. McGePoint3d. md)	undefined
Bulge	number	0	convexity
StartWidth	number	0	starting width
EndWidth	number	0	End width
Index	number	0	position

Returns

boolean

Example

import { McDbPolyline, MxCpp } from "mxcad";

const pl = new McDbPolyline();
pl.isClosed = true;
pl.addVertexAt(new McGePoint3d(800, 300, 0),0,10,10);
pl.addVertexAt(new McGePoint3d(900, 300, 0),0,10,10);
pl.addVertexAt(new McGePoint3d(900, 400, 0),0,10,10);
MxCpp.getCurrentMxCAD().drawEntity(pl);

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	Description
AutoUndo	boolean	false	Should this modification automatically support undo? Default is false

Returns

number

Inherited from

McDbCurve.assertObjectModification

clone

▸ clone(): null | McDbObject

Clone objects.

Returns

null | McDbObject

The cloned object.

Inherited from

McDbCurve.clone

createExtensionDictionary

▸ createExtensionDictionary(): boolean

Create extended dictionary data for objects

Returns

boolean

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

Inherited from

McDbCurve.disableDisplay

erase

▸ erase(): boolean

Delete object.

Returns

boolean

Whether the deletion was successful.

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

Inherited from

McDbCurve.explode

getAllAppName

▸ getAllAppName(): McGeStringArray

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

Returns

McGeStringArray

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`

Inherited from

McDbCurve.getBoundingBox

getBulgeAt

▸ getBulgeAt(index): number

Obtain the convexity of the specified position

Parameters

Name	Type	Description
Index	number	position

Returns

number

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

Inherited from

McDbCurve.getDatabase

getDatabaseIndexId

▸ getDatabaseIndexId(): number

Get the index ID of the object

Returns

number

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`

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`

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

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`

Inherited from

McDbCurve.getFirstDerivFromParam

getGripEditBasePointsIndex

▸ getGripEditBasePointsIndex(): number[]

Retrieve the edit base point index corresponding to the grip of the object.

Returns

number[]

Inherited from

McDbCurve.getGripEditBasePointsIndex

getGripPoints

▸ getGripPoints(): McGePoint3dArray

Get the grip array of the object

Returns

McGePoint3dArray

Inherited from

McDbCurve.getGripPoints

getHandle

▸ getHandle(): string

Obtain object handle

Returns

string

Return object handle

Inherited from

McDbCurve.getHandle

getImp

▸ getImp(): any

Retrieve internal implementation objects.

Returns

any

Internal implementation object.

Inherited from

McDbCurve.getImp

getJson

▸ getJson(): string

Retrieve a string in JSON format.

Returns

string

A string in JSON format.

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.

Inherited from

McDbCurve.getObjectID

getOwnerID

▸ getOwnerID(): number

Obtain the ID of the object owner

Returns

number

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`

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`

Inherited from

McDbCurve.getParamAtPoint

getPointAt

▸ getPointAt(index): Object

Get the point at the specified location

Parameters

Name	Type	Description
Index	number	position

Returns

Object

val: Point, ret: Return value

Name	Type
`ret`	`number`
`val`	`McGePoint3d`

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`

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

Inherited from

McDbCurve.getSamplePoints

getStartParam

▸ getStartParam(): Object

Get the starting parameters.

Returns

Object

Initial parameters and execution results.

Name	Type
`ret`	`boolean`
`val`	`number`

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

getType

▸ getType(): PolylineType

Set multiple line segment types

Returns

PolylineType

getWidthsAt

▸ getWidthsAt(index): Object

Get the starting and ending width of the specified location

Parameters

Name	Type	Description
Index	number	position

Returns

Object

val1: Starting width, val2: End width, ret: Return value

Name	Type
`ret`	`boolean`
`val1`	`number`
`val2`	`number`

getxData

▸ getxData(appName?): MxCADResbuf

Obtain the extended data of the object

Parameters

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

Returns

MxCADResbuf

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`

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`

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`

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

Inherited from

McDbCurve.highlight

initTempObject

▸ initTempObject(imp): void

Initialize temporary objects.

Parameters

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

Returns

void

Inherited from

McDbCurve.initTempObject

isErased

▸ isErased(): boolean

Has the object been deleted

Returns

boolean

Inherited from

McDbCurve.isErased

isHaveExtensionDictionary

▸ isHaveExtensionDictionary(): boolean

Is there any extended dictionary data available

Returns

boolean

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

Inherited from

McDbCurve.isKindOf

isNull

▸ isNull(): any

Determine if it is an empty object

Returns

any

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

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

Inherited from

McDbCurve.move

moveGripPointsAt

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

Grips 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

Inherited from

McDbCurve.moveGripPointsAt

numVerts

▸ numVerts(): number

Obtain the number of vertices

Returns

number

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

pointInPolygon

▸ pointInPolygon(x, y): boolean

Determine whether a point is within a closed area composed of multiple line segments

Parameters

Name	Type
`x`	`number`
`y`	`number`

Returns

boolean

removeVertexAt

▸ removeVertexAt(index): boolean

Remove vertices from the specified location

Parameters

Name	Type	Description
Index	number	position

Returns

boolean

reverse

▸ reverse(): boolean

Reverse coordinate points of multiple line segments

Returns

boolean

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

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

Inherited from

McDbCurve.scaleEntity

sclaeWidth

▸ sclaeWidth(scale): boolean

Scaling the width of multiple line segments

Parameters

Name	Type
`scale`	`number`

Returns

boolean

setBulgeAt

▸ setBulgeAt(index, bulge): boolean

Set the convexity of the specified position

Parameters

Name	Type	Description
Index	number	position
Bulge	number	convexity

Returns

boolean

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.

Inherited from

McDbCurve.setJson

setPointAt

▸ setPointAt(index, pt): boolean

Set the point at the specified location

Parameters

Name	Type	Description
Index	number	position
Pt	McGePoint3d (2d. McGePoint3d. md)	Point

Returns

boolean

setType

▸ setType(type): boolean

Return multiple line segment types

Parameters

Name	Type	Description
Type	PolylineType (../enums/2d. McDb. PolylineType. md)	Multi line segment type

Returns

boolean

setWidthsAt

▸ setWidthsAt(index, dStartWdith, dEntWdith): boolean

Modify the starting and ending width of the line segment

Parameters

Name	Type	Description
Index	number	position
`dStartWdith`	`number`	-
`dEntWdith`	`number`	-

Returns

boolean

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

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.

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

Inherited from

McDbCurve.syncData

transformBy

▸ transformBy(transformationMatrix): boolean

Transform object

Parameters

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

Returns

boolean

Inherited from

McDbCurve.transformBy

unErase

▸ unErase(): boolean

Anti delete object.

Returns

boolean

Inherited from

McDbCurve.unErase

updateDisplay

▸ updateDisplay(): void

Display the updated display of the calling object

Returns

void

Inherited from

McDbCurve.updateDisplay

Class: McDbPolyline ​

Hierarchy ​

Table of contents ​

Constructors ​

Properties ​

Accessors ​

Methods ​

Constructors ​

constructor ​

Parameters ​

Overrides ​

Properties ​

imp ​

Inherited from ​

Accessors ​

colorIndex ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

constantWidth ​

Returns ​

Parameters ​

Returns ​

drawOrder ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

dxf0 ​

Returns ​

Inherited from ​

isClosed ​

Returns ​

Parameters ​

Returns ​

layer ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

layerId ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

linetype ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

linetypeId ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

linetypeScale ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

lineweight ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

normal ​

Returns ​

Inherited from ​

Parameters ​

Returns ​

Inherited from ​

Class: McDbPolyline

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Overrides

Properties

imp

Inherited from

Accessors

colorIndex

Returns

Inherited from

Parameters

Returns

Inherited from

constantWidth

Returns

Parameters

Returns

drawOrder

Returns

Inherited from

Parameters

Returns

Inherited from

dxf0

Returns

Inherited from

isClosed

Returns

Parameters

Returns

layer

Returns

Inherited from

Parameters

Returns

Inherited from

layerId

Returns

Inherited from

Parameters

Returns

Inherited from

linetype

Returns

Inherited from

Parameters

Returns

Inherited from

linetypeId

Returns

Inherited from

Parameters

Returns

Inherited from

linetypeScale

Returns

Inherited from

Parameters

Returns

Inherited from

lineweight

Returns

Inherited from

Parameters

Returns

Inherited from

normal

Returns

Inherited from

Parameters

Returns

Inherited from